1 //! Wire messages, traits representing wire message handlers, and a few error types live here.
3 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
4 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
5 //! server entirely) which handles only channel-related messages you may wish to implement
6 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
9 //! Note that if you go with such an architecture (instead of passing raw socket events to a
10 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
11 //! source node_id of the message, however this does allow you to significantly reduce bandwidth
12 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
13 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
14 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
15 //! raw socket events into your non-internet-facing system and then send routing events back to
16 //! track the network on the less-secure system.
18 use secp256k1::key::PublicKey;
19 use secp256k1::Signature;
21 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
22 use bitcoin::blockdata::script::Script;
24 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
26 use std::error::Error;
29 use std::result::Result;
32 use util::ser::{Readable, Writeable, Writer};
34 use ln::channelmanager::{PaymentPreimage, PaymentHash};
36 /// An error in decoding a message or struct.
38 pub enum DecodeError {
39 /// A version byte specified something we don't know how to handle.
40 /// Includes unknown realm byte in an OnionHopData packet
42 /// Unknown feature mandating we fail to parse message
43 UnknownRequiredFeature,
44 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
45 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc
49 /// node_announcement included more than one address of a given type!
50 ExtraAddressesPerType,
51 /// A length descriptor in the packet didn't describe the later data correctly
53 /// Error from std::io
57 /// An init message to be sent or received from a peer
59 #[cfg(not(feature = "fuzztarget"))]
60 pub(crate) features: InitFeatures,
61 #[cfg(feature = "fuzztarget")]
62 pub features: InitFeatures,
65 /// An error message to be sent or received from a peer
67 pub struct ErrorMessage {
68 pub(crate) channel_id: [u8; 32],
69 pub(crate) data: String,
72 /// A ping message to be sent or received from a peer
74 pub(crate) ponglen: u16,
75 pub(crate) byteslen: u16,
78 /// A pong message to be sent or received from a peer
80 pub(crate) byteslen: u16,
83 /// An open_channel message to be sent or received from a peer
85 pub struct OpenChannel {
86 pub(crate) chain_hash: Sha256dHash,
87 pub(crate) temporary_channel_id: [u8; 32],
88 pub(crate) funding_satoshis: u64,
89 pub(crate) push_msat: u64,
90 pub(crate) dust_limit_satoshis: u64,
91 pub(crate) max_htlc_value_in_flight_msat: u64,
92 pub(crate) channel_reserve_satoshis: u64,
93 pub(crate) htlc_minimum_msat: u64,
94 pub(crate) feerate_per_kw: u32,
95 pub(crate) to_self_delay: u16,
96 pub(crate) max_accepted_htlcs: u16,
97 pub(crate) funding_pubkey: PublicKey,
98 pub(crate) revocation_basepoint: PublicKey,
99 pub(crate) payment_basepoint: PublicKey,
100 pub(crate) delayed_payment_basepoint: PublicKey,
101 pub(crate) htlc_basepoint: PublicKey,
102 pub(crate) first_per_commitment_point: PublicKey,
103 pub(crate) channel_flags: u8,
104 pub(crate) shutdown_scriptpubkey: OptionalField<Script>,
107 /// An accept_channel message to be sent or received from a peer
109 pub struct AcceptChannel {
110 pub(crate) temporary_channel_id: [u8; 32],
111 pub(crate) dust_limit_satoshis: u64,
112 pub(crate) max_htlc_value_in_flight_msat: u64,
113 pub(crate) channel_reserve_satoshis: u64,
114 pub(crate) htlc_minimum_msat: u64,
115 pub(crate) minimum_depth: u32,
116 pub(crate) to_self_delay: u16,
117 pub(crate) max_accepted_htlcs: u16,
118 pub(crate) funding_pubkey: PublicKey,
119 pub(crate) revocation_basepoint: PublicKey,
120 pub(crate) payment_basepoint: PublicKey,
121 pub(crate) delayed_payment_basepoint: PublicKey,
122 pub(crate) htlc_basepoint: PublicKey,
123 pub(crate) first_per_commitment_point: PublicKey,
124 pub(crate) shutdown_scriptpubkey: OptionalField<Script>
127 /// A funding_created message to be sent or received from a peer
129 pub struct FundingCreated {
130 pub(crate) temporary_channel_id: [u8; 32],
131 pub(crate) funding_txid: Sha256dHash,
132 pub(crate) funding_output_index: u16,
133 pub(crate) signature: Signature,
136 /// A funding_signed message to be sent or received from a peer
138 pub struct FundingSigned {
139 pub(crate) channel_id: [u8; 32],
140 pub(crate) signature: Signature,
143 /// A funding_locked message to be sent or received from a peer
144 #[derive(Clone, PartialEq)]
145 #[allow(missing_docs)]
146 pub struct FundingLocked {
147 pub channel_id: [u8; 32],
148 pub next_per_commitment_point: PublicKey,
151 /// A shutdown message to be sent or received from a peer
152 #[derive(Clone, PartialEq)]
153 pub struct Shutdown {
154 pub(crate) channel_id: [u8; 32],
155 pub(crate) scriptpubkey: Script,
158 /// A closing_signed message to be sent or received from a peer
159 #[derive(Clone, PartialEq)]
160 pub struct ClosingSigned {
161 pub(crate) channel_id: [u8; 32],
162 pub(crate) fee_satoshis: u64,
163 pub(crate) signature: Signature,
166 /// An update_add_htlc message to be sent or received from a peer
167 #[derive(Clone, PartialEq)]
168 pub struct UpdateAddHTLC {
169 pub(crate) channel_id: [u8; 32],
170 pub(crate) htlc_id: u64,
171 pub(crate) amount_msat: u64,
172 pub(crate) payment_hash: PaymentHash,
173 pub(crate) cltv_expiry: u32,
174 pub(crate) onion_routing_packet: OnionPacket,
177 /// An update_fulfill_htlc message to be sent or received from a peer
178 #[derive(Clone, PartialEq)]
179 pub struct UpdateFulfillHTLC {
180 pub(crate) channel_id: [u8; 32],
181 pub(crate) htlc_id: u64,
182 pub(crate) payment_preimage: PaymentPreimage,
185 /// An update_fail_htlc message to be sent or received from a peer
186 #[derive(Clone, PartialEq)]
187 pub struct UpdateFailHTLC {
188 pub(crate) channel_id: [u8; 32],
189 pub(crate) htlc_id: u64,
190 pub(crate) reason: OnionErrorPacket,
193 /// An update_fail_malformed_htlc message to be sent or received from a peer
194 #[derive(Clone, PartialEq)]
195 pub struct UpdateFailMalformedHTLC {
196 pub(crate) channel_id: [u8; 32],
197 pub(crate) htlc_id: u64,
198 pub(crate) sha256_of_onion: [u8; 32],
199 pub(crate) failure_code: u16,
202 /// A commitment_signed message to be sent or received from a peer
203 #[derive(Clone, PartialEq)]
204 pub struct CommitmentSigned {
205 pub(crate) channel_id: [u8; 32],
206 pub(crate) signature: Signature,
207 pub(crate) htlc_signatures: Vec<Signature>,
210 /// A revoke_and_ack message to be sent or received from a peer
211 #[derive(Clone, PartialEq)]
212 pub struct RevokeAndACK {
213 pub(crate) channel_id: [u8; 32],
214 pub(crate) per_commitment_secret: [u8; 32],
215 pub(crate) next_per_commitment_point: PublicKey,
218 /// An update_fee message to be sent or received from a peer
219 #[derive(PartialEq, Clone)]
220 pub struct UpdateFee {
221 pub(crate) channel_id: [u8; 32],
222 pub(crate) feerate_per_kw: u32,
225 #[derive(PartialEq, Clone)]
226 pub(crate) struct DataLossProtect {
227 pub(crate) your_last_per_commitment_secret: [u8; 32],
228 pub(crate) my_current_per_commitment_point: PublicKey,
231 /// A channel_reestablish message to be sent or received from a peer
232 #[derive(PartialEq, Clone)]
233 pub struct ChannelReestablish {
234 pub(crate) channel_id: [u8; 32],
235 pub(crate) next_local_commitment_number: u64,
236 pub(crate) next_remote_commitment_number: u64,
237 pub(crate) data_loss_protect: OptionalField<DataLossProtect>,
240 /// An announcement_signatures message to be sent or received from a peer
241 #[derive(PartialEq, Clone, Debug)]
242 pub struct AnnouncementSignatures {
243 pub(crate) channel_id: [u8; 32],
244 pub(crate) short_channel_id: u64,
245 pub(crate) node_signature: Signature,
246 pub(crate) bitcoin_signature: Signature,
249 /// An address which can be used to connect to a remote peer
250 #[derive(Clone, PartialEq, Debug)]
251 pub enum NetAddress {
252 /// An IPv4 address/port on which the peer is listening.
254 /// The 4-byte IPv4 address
256 /// The port on which the node is listening
259 /// An IPv6 address/port on which the peer is listening.
261 /// The 16-byte IPv6 address
263 /// The port on which the node is listening
266 /// An old-style Tor onion address/port on which the peer is listening.
268 /// The bytes (usually encoded in base32 with ".onion" appended)
270 /// The port on which the node is listening
273 /// A new-style Tor onion address/port on which the peer is listening.
274 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
275 /// wrap as base32 and append ".onion".
277 /// The ed25519 long-term public key of the peer
278 ed25519_pubkey: [u8; 32],
279 /// The checksum of the pubkey and version, as included in the onion address
281 /// The version byte, as defined by the Tor Onion v3 spec.
283 /// The port on which the node is listening
288 fn get_id(&self) -> u8 {
290 &NetAddress::IPv4 {..} => { 1 },
291 &NetAddress::IPv6 {..} => { 2 },
292 &NetAddress::OnionV2 {..} => { 3 },
293 &NetAddress::OnionV3 {..} => { 4 },
297 /// Strict byte-length of address descriptor, 1-byte type not recorded
298 fn len(&self) -> u16 {
300 &NetAddress::IPv4 { .. } => { 6 },
301 &NetAddress::IPv6 { .. } => { 18 },
302 &NetAddress::OnionV2 { .. } => { 12 },
303 &NetAddress::OnionV3 { .. } => { 37 },
308 impl Writeable for NetAddress {
309 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
311 &NetAddress::IPv4 { ref addr, ref port } => {
316 &NetAddress::IPv6 { ref addr, ref port } => {
321 &NetAddress::OnionV2 { ref addr, ref port } => {
326 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
328 ed25519_pubkey.write(writer)?;
329 checksum.write(writer)?;
330 version.write(writer)?;
338 impl<R: ::std::io::Read> Readable<R> for Result<NetAddress, u8> {
339 fn read(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
340 let byte = <u8 as Readable<R>>::read(reader)?;
343 Ok(Ok(NetAddress::IPv4 {
344 addr: Readable::read(reader)?,
345 port: Readable::read(reader)?,
349 Ok(Ok(NetAddress::IPv6 {
350 addr: Readable::read(reader)?,
351 port: Readable::read(reader)?,
355 Ok(Ok(NetAddress::OnionV2 {
356 addr: Readable::read(reader)?,
357 port: Readable::read(reader)?,
361 Ok(Ok(NetAddress::OnionV3 {
362 ed25519_pubkey: Readable::read(reader)?,
363 checksum: Readable::read(reader)?,
364 version: Readable::read(reader)?,
365 port: Readable::read(reader)?,
368 _ => return Ok(Err(byte)),
373 // Only exposed as broadcast of node_announcement should be filtered by node_id
374 /// The unsigned part of a node_announcement
375 #[derive(PartialEq, Clone, Debug)]
376 pub struct UnsignedNodeAnnouncement {
377 pub(crate) features: NodeFeatures,
378 pub(crate) timestamp: u32,
379 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
381 pub node_id: PublicKey,
382 pub(crate) rgb: [u8; 3],
383 pub(crate) alias: [u8; 32],
384 /// List of addresses on which this node is reachable. Note that you may only have up to one
385 /// address of each type, if you have more, they may be silently discarded or we may panic!
386 pub(crate) addresses: Vec<NetAddress>,
387 pub(crate) excess_address_data: Vec<u8>,
388 pub(crate) excess_data: Vec<u8>,
390 #[derive(PartialEq, Clone)]
391 /// A node_announcement message to be sent or received from a peer
392 pub struct NodeAnnouncement {
393 pub(crate) signature: Signature,
394 pub(crate) contents: UnsignedNodeAnnouncement,
397 // Only exposed as broadcast of channel_announcement should be filtered by node_id
398 /// The unsigned part of a channel_announcement
399 #[derive(PartialEq, Clone, Debug)]
400 pub struct UnsignedChannelAnnouncement {
401 pub(crate) features: ChannelFeatures,
402 pub(crate) chain_hash: Sha256dHash,
403 pub(crate) short_channel_id: u64,
404 /// One of the two node_ids which are endpoints of this channel
405 pub node_id_1: PublicKey,
406 /// The other of the two node_ids which are endpoints of this channel
407 pub node_id_2: PublicKey,
408 pub(crate) bitcoin_key_1: PublicKey,
409 pub(crate) bitcoin_key_2: PublicKey,
410 pub(crate) excess_data: Vec<u8>,
412 /// A channel_announcement message to be sent or received from a peer
413 #[derive(PartialEq, Clone, Debug)]
414 pub struct ChannelAnnouncement {
415 pub(crate) node_signature_1: Signature,
416 pub(crate) node_signature_2: Signature,
417 pub(crate) bitcoin_signature_1: Signature,
418 pub(crate) bitcoin_signature_2: Signature,
419 pub(crate) contents: UnsignedChannelAnnouncement,
422 #[derive(PartialEq, Clone, Debug)]
423 pub(crate) struct UnsignedChannelUpdate {
424 pub(crate) chain_hash: Sha256dHash,
425 pub(crate) short_channel_id: u64,
426 pub(crate) timestamp: u32,
427 pub(crate) flags: u16,
428 pub(crate) cltv_expiry_delta: u16,
429 pub(crate) htlc_minimum_msat: u64,
430 pub(crate) fee_base_msat: u32,
431 pub(crate) fee_proportional_millionths: u32,
432 pub(crate) excess_data: Vec<u8>,
434 /// A channel_update message to be sent or received from a peer
435 #[derive(PartialEq, Clone, Debug)]
436 pub struct ChannelUpdate {
437 pub(crate) signature: Signature,
438 pub(crate) contents: UnsignedChannelUpdate,
441 /// Used to put an error message in a LightningError
443 pub enum ErrorAction {
444 /// The peer took some action which made us think they were useless. Disconnect them.
446 /// An error message which we should make an effort to send before we disconnect.
447 msg: Option<ErrorMessage>
449 /// The peer did something harmless that we weren't able to process, just log and ignore
451 /// The peer did something incorrect. Tell them.
453 /// The message to send.
458 /// An Err type for failure to process messages.
459 pub struct LightningError {
460 /// A human-readable message describing the error
461 pub err: &'static str,
462 /// The action which should be taken against the offending peer.
463 pub action: ErrorAction,
466 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
467 /// transaction updates if they were pending.
468 #[derive(PartialEq, Clone)]
469 pub struct CommitmentUpdate {
470 /// update_add_htlc messages which should be sent
471 pub update_add_htlcs: Vec<UpdateAddHTLC>,
472 /// update_fulfill_htlc messages which should be sent
473 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
474 /// update_fail_htlc messages which should be sent
475 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
476 /// update_fail_malformed_htlc messages which should be sent
477 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
478 /// An update_fee message which should be sent
479 pub update_fee: Option<UpdateFee>,
480 /// Finally, the commitment_signed message which should be sent
481 pub commitment_signed: CommitmentSigned,
484 /// The information we received from a peer along the route of a payment we originated. This is
485 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
486 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
488 pub enum HTLCFailChannelUpdate {
489 /// We received an error which included a full ChannelUpdate message.
490 ChannelUpdateMessage {
491 /// The unwrapped message we received
494 /// We received an error which indicated only that a channel has been closed
496 /// The short_channel_id which has now closed.
497 short_channel_id: u64,
498 /// when this true, this channel should be permanently removed from the
499 /// consideration. Otherwise, this channel can be restored as new channel_update is received
502 /// We received an error which indicated only that a node has failed
504 /// The node_id that has failed.
506 /// when this true, node should be permanently removed from the
507 /// consideration. Otherwise, the channels connected to this node can be
508 /// restored as new channel_update is received
513 /// Messages could have optional fields to use with extended features
514 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
515 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
516 /// separate enum type for them.
517 #[derive(Clone, PartialEq)]
518 pub enum OptionalField<T> {
519 /// Optional field is included in message
521 /// Optional field is absent in message
525 /// A trait to describe an object which can receive channel messages.
527 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
528 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
529 pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
531 /// Handle an incoming open_channel message from the given peer.
532 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
533 /// Handle an incoming accept_channel message from the given peer.
534 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
535 /// Handle an incoming funding_created message from the given peer.
536 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
537 /// Handle an incoming funding_signed message from the given peer.
538 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
539 /// Handle an incoming funding_locked message from the given peer.
540 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
543 /// Handle an incoming shutdown message from the given peer.
544 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
545 /// Handle an incoming closing_signed message from the given peer.
546 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
549 /// Handle an incoming update_add_htlc message from the given peer.
550 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
551 /// Handle an incoming update_fulfill_htlc message from the given peer.
552 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
553 /// Handle an incoming update_fail_htlc message from the given peer.
554 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
555 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
556 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
557 /// Handle an incoming commitment_signed message from the given peer.
558 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
559 /// Handle an incoming revoke_and_ack message from the given peer.
560 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
562 /// Handle an incoming update_fee message from the given peer.
563 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
565 // Channel-to-announce:
566 /// Handle an incoming announcement_signatures message from the given peer.
567 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
569 // Connection loss/reestablish:
570 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
571 /// is believed to be possible in the future (eg they're sending us messages we don't
572 /// understand or indicate they require unknown feature bits), no_connection_possible is set
573 /// and any outstanding channels should be failed.
574 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
576 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
577 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
578 /// Handle an incoming channel_reestablish message from the given peer.
579 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
582 /// Handle an incoming error message from the given peer.
583 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
586 /// A trait to describe an object which can receive routing messages.
587 pub trait RoutingMessageHandler : Send + Sync {
588 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
589 /// false or returning an Err otherwise.
590 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
591 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
592 /// or returning an Err otherwise.
593 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
594 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
595 /// false or returning an Err otherwise.
596 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
597 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
598 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
599 /// Gets a subset of the channel announcements and updates required to dump our routing table
600 /// to a remote node, starting at the short_channel_id indicated by starting_point and
601 /// including batch_amount entries.
602 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
603 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
604 /// starting at the node *after* the provided publickey and including batch_amount entries.
605 /// If None is provided for starting_point, we start at the first node.
606 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
607 /// Returns whether a full sync should be requested from a peer.
608 fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
611 pub(crate) struct OnionRealm0HopData {
612 pub(crate) short_channel_id: u64,
613 pub(crate) amt_to_forward: u64,
614 pub(crate) outgoing_cltv_value: u32,
615 // 12 bytes of 0-padding
618 mod fuzzy_internal_msgs {
619 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
620 // them from untrusted input):
622 use super::OnionRealm0HopData;
623 pub struct OnionHopData {
624 pub(crate) realm: u8,
625 pub(crate) data: OnionRealm0HopData,
626 pub(crate) hmac: [u8; 32],
629 pub struct DecodedOnionErrorPacket {
630 pub(crate) hmac: [u8; 32],
631 pub(crate) failuremsg: Vec<u8>,
632 pub(crate) pad: Vec<u8>,
635 #[cfg(feature = "fuzztarget")]
636 pub use self::fuzzy_internal_msgs::*;
637 #[cfg(not(feature = "fuzztarget"))]
638 pub(crate) use self::fuzzy_internal_msgs::*;
641 pub(crate) struct OnionPacket {
642 pub(crate) version: u8,
643 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
644 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
645 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
646 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
647 pub(crate) hop_data: [u8; 20*65],
648 pub(crate) hmac: [u8; 32],
651 impl PartialEq for OnionPacket {
652 fn eq(&self, other: &OnionPacket) -> bool {
653 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
654 if i != j { return false; }
656 self.version == other.version &&
657 self.public_key == other.public_key &&
658 self.hmac == other.hmac
662 #[derive(Clone, PartialEq)]
663 pub(crate) struct OnionErrorPacket {
664 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
665 // (TODO) We limit it in decode to much lower...
666 pub(crate) data: Vec<u8>,
669 impl Error for DecodeError {
670 fn description(&self) -> &str {
672 DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
673 DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
674 DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
675 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
676 DecodeError::ExtraAddressesPerType => "More than one address of a single type",
677 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
678 DecodeError::Io(ref e) => e.description(),
682 impl fmt::Display for DecodeError {
683 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
684 f.write_str(self.description())
688 impl fmt::Debug for LightningError {
689 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
690 f.write_str(self.err)
694 impl From<::std::io::Error> for DecodeError {
695 fn from(e: ::std::io::Error) -> Self {
696 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
697 DecodeError::ShortRead
704 impl Writeable for OptionalField<Script> {
705 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
707 OptionalField::Present(ref script) => {
708 // Note that Writeable for script includes the 16-bit length tag for us
711 OptionalField::Absent => {}
717 impl<R: Read> Readable<R> for OptionalField<Script> {
718 fn read(r: &mut R) -> Result<Self, DecodeError> {
719 match <u16 as Readable<R>>::read(r) {
721 let mut buf = vec![0; len as usize];
722 r.read_exact(&mut buf)?;
723 Ok(OptionalField::Present(Script::from(buf)))
725 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
731 impl_writeable_len_match!(AcceptChannel, {
732 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
735 temporary_channel_id,
737 max_htlc_value_in_flight_msat,
738 channel_reserve_satoshis,
744 revocation_basepoint,
746 delayed_payment_basepoint,
748 first_per_commitment_point,
749 shutdown_scriptpubkey
752 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
759 impl Writeable for ChannelReestablish {
760 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
761 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
762 self.channel_id.write(w)?;
763 self.next_local_commitment_number.write(w)?;
764 self.next_remote_commitment_number.write(w)?;
765 match self.data_loss_protect {
766 OptionalField::Present(ref data_loss_protect) => {
767 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
768 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
770 OptionalField::Absent => {}
776 impl<R: Read> Readable<R> for ChannelReestablish{
777 fn read(r: &mut R) -> Result<Self, DecodeError> {
779 channel_id: Readable::read(r)?,
780 next_local_commitment_number: Readable::read(r)?,
781 next_remote_commitment_number: Readable::read(r)?,
783 match <[u8; 32] as Readable<R>>::read(r) {
784 Ok(your_last_per_commitment_secret) =>
785 OptionalField::Present(DataLossProtect {
786 your_last_per_commitment_secret,
787 my_current_per_commitment_point: Readable::read(r)?,
789 Err(DecodeError::ShortRead) => OptionalField::Absent,
790 Err(e) => return Err(e)
797 impl_writeable!(ClosingSigned, 32+8+64, {
803 impl_writeable_len_match!(CommitmentSigned, {
804 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
811 impl_writeable_len_match!(DecodedOnionErrorPacket, {
812 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
819 impl_writeable!(FundingCreated, 32+32+2+64, {
820 temporary_channel_id,
822 funding_output_index,
826 impl_writeable!(FundingSigned, 32+64, {
831 impl_writeable!(FundingLocked, 32+33, {
833 next_per_commitment_point
836 impl Writeable for Init {
837 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
838 // global_features gets the bottom 13 bits of our features, and local_features gets all of
839 // our relevant feature bits. This keeps us compatible with old nodes.
840 self.features.write_up_to_13(w)?;
841 self.features.write(w)
845 impl<R: Read> Readable<R> for Init {
846 fn read(r: &mut R) -> Result<Self, DecodeError> {
847 let global_features: InitFeatures = Readable::read(r)?;
848 let features: InitFeatures = Readable::read(r)?;
850 features: features.or(global_features),
855 impl_writeable_len_match!(OpenChannel, {
856 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
860 temporary_channel_id,
864 max_htlc_value_in_flight_msat,
865 channel_reserve_satoshis,
871 revocation_basepoint,
873 delayed_payment_basepoint,
875 first_per_commitment_point,
877 shutdown_scriptpubkey
880 impl_writeable!(RevokeAndACK, 32+32+33, {
882 per_commitment_secret,
883 next_per_commitment_point
886 impl_writeable_len_match!(Shutdown, {
887 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
893 impl_writeable_len_match!(UpdateFailHTLC, {
894 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
901 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
908 impl_writeable!(UpdateFee, 32+4, {
913 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
919 impl_writeable_len_match!(OnionErrorPacket, {
920 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
925 impl Writeable for OnionPacket {
926 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
927 w.size_hint(1 + 33 + 20*65 + 32);
928 self.version.write(w)?;
929 match self.public_key {
930 Ok(pubkey) => pubkey.write(w)?,
931 Err(_) => [0u8;33].write(w)?,
933 w.write_all(&self.hop_data)?;
939 impl<R: Read> Readable<R> for OnionPacket {
940 fn read(r: &mut R) -> Result<Self, DecodeError> {
942 version: Readable::read(r)?,
944 let mut buf = [0u8;33];
945 r.read_exact(&mut buf)?;
946 PublicKey::from_slice(&buf)
948 hop_data: Readable::read(r)?,
949 hmac: Readable::read(r)?,
954 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
963 impl Writeable for OnionRealm0HopData {
964 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
966 self.short_channel_id.write(w)?;
967 self.amt_to_forward.write(w)?;
968 self.outgoing_cltv_value.write(w)?;
969 w.write_all(&[0;12])?;
974 impl<R: Read> Readable<R> for OnionRealm0HopData {
975 fn read(r: &mut R) -> Result<Self, DecodeError> {
976 Ok(OnionRealm0HopData {
977 short_channel_id: Readable::read(r)?,
978 amt_to_forward: Readable::read(r)?,
979 outgoing_cltv_value: {
980 let v: u32 = Readable::read(r)?;
981 r.read_exact(&mut [0; 12])?;
988 impl Writeable for OnionHopData {
989 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
991 self.realm.write(w)?;
998 impl<R: Read> Readable<R> for OnionHopData {
999 fn read(r: &mut R) -> Result<Self, DecodeError> {
1002 let r: u8 = Readable::read(r)?;
1004 return Err(DecodeError::UnknownVersion);
1008 data: Readable::read(r)?,
1009 hmac: Readable::read(r)?,
1014 impl Writeable for Ping {
1015 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1016 w.size_hint(self.byteslen as usize + 4);
1017 self.ponglen.write(w)?;
1018 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1023 impl<R: Read> Readable<R> for Ping {
1024 fn read(r: &mut R) -> Result<Self, DecodeError> {
1026 ponglen: Readable::read(r)?,
1028 let byteslen = Readable::read(r)?;
1029 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1036 impl Writeable for Pong {
1037 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1038 w.size_hint(self.byteslen as usize + 2);
1039 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1044 impl<R: Read> Readable<R> for Pong {
1045 fn read(r: &mut R) -> Result<Self, DecodeError> {
1048 let byteslen = Readable::read(r)?;
1049 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1056 impl Writeable for UnsignedChannelAnnouncement {
1057 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1058 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1059 self.features.write(w)?;
1060 self.chain_hash.write(w)?;
1061 self.short_channel_id.write(w)?;
1062 self.node_id_1.write(w)?;
1063 self.node_id_2.write(w)?;
1064 self.bitcoin_key_1.write(w)?;
1065 self.bitcoin_key_2.write(w)?;
1066 w.write_all(&self.excess_data[..])?;
1071 impl<R: Read> Readable<R> for UnsignedChannelAnnouncement {
1072 fn read(r: &mut R) -> Result<Self, DecodeError> {
1074 features: Readable::read(r)?,
1075 chain_hash: Readable::read(r)?,
1076 short_channel_id: Readable::read(r)?,
1077 node_id_1: Readable::read(r)?,
1078 node_id_2: Readable::read(r)?,
1079 bitcoin_key_1: Readable::read(r)?,
1080 bitcoin_key_2: Readable::read(r)?,
1082 let mut excess_data = vec![];
1083 r.read_to_end(&mut excess_data)?;
1090 impl_writeable_len_match!(ChannelAnnouncement, {
1091 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1092 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1096 bitcoin_signature_1,
1097 bitcoin_signature_2,
1101 impl Writeable for UnsignedChannelUpdate {
1102 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1103 w.size_hint(64 + self.excess_data.len());
1104 self.chain_hash.write(w)?;
1105 self.short_channel_id.write(w)?;
1106 self.timestamp.write(w)?;
1107 self.flags.write(w)?;
1108 self.cltv_expiry_delta.write(w)?;
1109 self.htlc_minimum_msat.write(w)?;
1110 self.fee_base_msat.write(w)?;
1111 self.fee_proportional_millionths.write(w)?;
1112 w.write_all(&self.excess_data[..])?;
1117 impl<R: Read> Readable<R> for UnsignedChannelUpdate {
1118 fn read(r: &mut R) -> Result<Self, DecodeError> {
1120 chain_hash: Readable::read(r)?,
1121 short_channel_id: Readable::read(r)?,
1122 timestamp: Readable::read(r)?,
1123 flags: Readable::read(r)?,
1124 cltv_expiry_delta: Readable::read(r)?,
1125 htlc_minimum_msat: Readable::read(r)?,
1126 fee_base_msat: Readable::read(r)?,
1127 fee_proportional_millionths: Readable::read(r)?,
1129 let mut excess_data = vec![];
1130 r.read_to_end(&mut excess_data)?;
1137 impl_writeable_len_match!(ChannelUpdate, {
1138 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1139 64 + excess_data.len() + 64 }
1145 impl Writeable for ErrorMessage {
1146 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1147 w.size_hint(32 + 2 + self.data.len());
1148 self.channel_id.write(w)?;
1149 (self.data.len() as u16).write(w)?;
1150 w.write_all(self.data.as_bytes())?;
1155 impl<R: Read> Readable<R> for ErrorMessage {
1156 fn read(r: &mut R) -> Result<Self, DecodeError> {
1158 channel_id: Readable::read(r)?,
1160 let mut sz: usize = <u16 as Readable<R>>::read(r)? as usize;
1161 let mut data = vec![];
1162 let data_len = r.read_to_end(&mut data)?;
1163 sz = cmp::min(data_len, sz);
1164 match String::from_utf8(data[..sz as usize].to_vec()) {
1166 Err(_) => return Err(DecodeError::InvalidValue),
1173 impl Writeable for UnsignedNodeAnnouncement {
1174 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1175 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1176 self.features.write(w)?;
1177 self.timestamp.write(w)?;
1178 self.node_id.write(w)?;
1179 w.write_all(&self.rgb)?;
1180 self.alias.write(w)?;
1182 let mut addrs_to_encode = self.addresses.clone();
1183 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1184 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1185 let mut addr_len = 0;
1186 for addr in &addrs_to_encode {
1187 addr_len += 1 + addr.len();
1189 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1190 for addr in addrs_to_encode {
1193 w.write_all(&self.excess_address_data[..])?;
1194 w.write_all(&self.excess_data[..])?;
1199 impl<R: Read> Readable<R> for UnsignedNodeAnnouncement {
1200 fn read(r: &mut R) -> Result<Self, DecodeError> {
1201 let features: NodeFeatures = Readable::read(r)?;
1202 let timestamp: u32 = Readable::read(r)?;
1203 let node_id: PublicKey = Readable::read(r)?;
1204 let mut rgb = [0; 3];
1205 r.read_exact(&mut rgb)?;
1206 let alias: [u8; 32] = Readable::read(r)?;
1208 let addr_len: u16 = Readable::read(r)?;
1209 let mut addresses: Vec<NetAddress> = Vec::with_capacity(4);
1210 let mut addr_readpos = 0;
1211 let mut excess = false;
1212 let mut excess_byte = 0;
1214 if addr_len <= addr_readpos { break; }
1215 match Readable::read(r) {
1218 NetAddress::IPv4 { .. } => {
1219 if addresses.len() > 0 {
1220 return Err(DecodeError::ExtraAddressesPerType);
1223 NetAddress::IPv6 { .. } => {
1224 if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1225 return Err(DecodeError::ExtraAddressesPerType);
1228 NetAddress::OnionV2 { .. } => {
1229 if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1230 return Err(DecodeError::ExtraAddressesPerType);
1233 NetAddress::OnionV3 { .. } => {
1234 if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1235 return Err(DecodeError::ExtraAddressesPerType);
1239 if addr_len < addr_readpos + 1 + addr.len() {
1240 return Err(DecodeError::BadLengthDescriptor);
1242 addr_readpos += (1 + addr.len()) as u16;
1243 addresses.push(addr);
1245 Ok(Err(unknown_descriptor)) => {
1247 excess_byte = unknown_descriptor;
1250 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1251 Err(e) => return Err(e),
1255 let mut excess_data = vec![];
1256 let excess_address_data = if addr_readpos < addr_len {
1257 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1258 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1260 excess_address_data[0] = excess_byte;
1265 excess_data.push(excess_byte);
1269 r.read_to_end(&mut excess_data)?;
1270 Ok(UnsignedNodeAnnouncement {
1277 excess_address_data,
1283 impl_writeable_len_match!(NodeAnnouncement, {
1284 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1285 64 + 76 + features.byte_count() + addresses.len()*38 + excess_address_data.len() + excess_data.len() }
1295 use ln::msgs::{ChannelFeatures, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket};
1296 use ln::channelmanager::{PaymentPreimage, PaymentHash};
1297 use util::ser::Writeable;
1299 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
1300 use bitcoin_hashes::hex::FromHex;
1301 use bitcoin::util::address::Address;
1302 use bitcoin::network::constants::Network;
1303 use bitcoin::blockdata::script::Builder;
1304 use bitcoin::blockdata::opcodes;
1306 use secp256k1::key::{PublicKey,SecretKey};
1307 use secp256k1::{Secp256k1, Message};
1310 fn encoding_channel_reestablish_no_secret() {
1311 let cr = msgs::ChannelReestablish {
1312 channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1313 next_local_commitment_number: 3,
1314 next_remote_commitment_number: 4,
1315 data_loss_protect: OptionalField::Absent,
1318 let encoded_value = cr.encode();
1321 vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4]
1326 fn encoding_channel_reestablish_with_secret() {
1328 let secp_ctx = Secp256k1::new();
1329 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1332 let cr = msgs::ChannelReestablish {
1333 channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1334 next_local_commitment_number: 3,
1335 next_remote_commitment_number: 4,
1336 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1339 let encoded_value = cr.encode();
1342 vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 3, 27, 132, 197, 86, 123, 18, 100, 64, 153, 93, 62, 213, 170, 186, 5, 101, 215, 30, 24, 52, 96, 72, 25, 255, 156, 23, 245, 233, 213, 221, 7, 143]
1346 macro_rules! get_keys_from {
1347 ($slice: expr, $secp_ctx: expr) => {
1349 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1350 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1356 macro_rules! get_sig_on {
1357 ($privkey: expr, $ctx: expr, $string: expr) => {
1359 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1360 $ctx.sign(&sighash, &$privkey)
1366 fn encoding_announcement_signatures() {
1367 let secp_ctx = Secp256k1::new();
1368 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1369 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1370 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1371 let announcement_signatures = msgs::AnnouncementSignatures {
1372 channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1373 short_channel_id: 2316138423780173,
1374 node_signature: sig_1,
1375 bitcoin_signature: sig_2,
1378 let encoded_value = announcement_signatures.encode();
1379 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1382 fn do_encoding_channel_announcement(unknown_features_bits: bool, non_bitcoin_chain_hash: bool, excess_data: bool) {
1383 let secp_ctx = Secp256k1::new();
1384 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1385 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1386 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1387 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1388 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1389 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1390 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1391 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1392 let mut features = ChannelFeatures::supported();
1393 if unknown_features_bits {
1394 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1396 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1398 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1399 short_channel_id: 2316138423780173,
1400 node_id_1: pubkey_1,
1401 node_id_2: pubkey_2,
1402 bitcoin_key_1: pubkey_3,
1403 bitcoin_key_2: pubkey_4,
1404 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1406 let channel_announcement = msgs::ChannelAnnouncement {
1407 node_signature_1: sig_1,
1408 node_signature_2: sig_2,
1409 bitcoin_signature_1: sig_3,
1410 bitcoin_signature_2: sig_4,
1411 contents: unsigned_channel_announcement,
1413 let encoded_value = channel_announcement.encode();
1414 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1415 if unknown_features_bits {
1416 target_value.append(&mut hex::decode("0002ffff").unwrap());
1418 target_value.append(&mut hex::decode("0000").unwrap());
1420 if non_bitcoin_chain_hash {
1421 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1423 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1425 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1427 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1429 assert_eq!(encoded_value, target_value);
1433 fn encoding_channel_announcement() {
1434 do_encoding_channel_announcement(false, false, false);
1435 do_encoding_channel_announcement(true, false, false);
1436 do_encoding_channel_announcement(true, true, false);
1437 do_encoding_channel_announcement(true, true, true);
1438 do_encoding_channel_announcement(false, true, true);
1439 do_encoding_channel_announcement(false, false, true);
1440 do_encoding_channel_announcement(false, true, false);
1441 do_encoding_channel_announcement(true, false, true);
1444 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1445 let secp_ctx = Secp256k1::new();
1446 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1447 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1448 let features = if unknown_features_bits {
1449 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1451 // Set to some features we may support
1452 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1454 let mut addresses = Vec::new();
1456 addresses.push(msgs::NetAddress::IPv4 {
1457 addr: [255, 254, 253, 252],
1462 addresses.push(msgs::NetAddress::IPv6 {
1463 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1468 addresses.push(msgs::NetAddress::OnionV2 {
1469 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1474 addresses.push(msgs::NetAddress::OnionV3 {
1475 ed25519_pubkey: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240, 239, 238, 237, 236, 235, 234, 233, 232, 231, 230, 229, 228, 227, 226, 225, 224],
1481 let mut addr_len = 0;
1482 for addr in &addresses {
1483 addr_len += addr.len() + 1;
1485 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1487 timestamp: 20190119,
1492 excess_address_data: if excess_address_data { vec![33, 108, 40, 11, 83, 149, 162, 84, 110, 126, 75, 38, 99, 224, 79, 129, 22, 34, 241, 90, 79, 146, 232, 58, 162, 233, 43, 162, 165, 115, 193, 57, 20, 44, 84, 174, 99, 7, 42, 30, 193, 238, 125, 192, 192, 75, 222, 92, 132, 120, 6, 23, 42, 160, 92, 146, 194, 42, 232, 227, 8, 209, 210, 105] } else { Vec::new() },
1493 excess_data: if excess_data { vec![59, 18, 204, 25, 92, 224, 162, 209, 189, 166, 168, 139, 239, 161, 159, 160, 127, 81, 202, 167, 92, 232, 56, 55, 242, 137, 101, 96, 11, 138, 172, 171, 8, 85, 255, 176, 231, 65, 236, 95, 124, 65, 66, 30, 152, 41, 169, 212, 134, 17, 200, 200, 49, 247, 27, 229, 234, 115, 230, 101, 148, 151, 127, 253] } else { Vec::new() },
1495 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1496 let node_announcement = msgs::NodeAnnouncement {
1498 contents: unsigned_node_announcement,
1500 let encoded_value = node_announcement.encode();
1501 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1502 if unknown_features_bits {
1503 target_value.append(&mut hex::decode("0002ffff").unwrap());
1505 target_value.append(&mut hex::decode("000122").unwrap());
1507 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1508 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1510 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1513 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1516 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1519 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1521 if excess_address_data {
1522 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1525 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1527 assert_eq!(encoded_value, target_value);
1531 fn encoding_node_announcement() {
1532 do_encoding_node_announcement(true, true, true, true, true, true, true);
1533 do_encoding_node_announcement(false, false, false, false, false, false, false);
1534 do_encoding_node_announcement(false, true, false, false, false, false, false);
1535 do_encoding_node_announcement(false, false, true, false, false, false, false);
1536 do_encoding_node_announcement(false, false, false, true, false, false, false);
1537 do_encoding_node_announcement(false, false, false, false, true, false, false);
1538 do_encoding_node_announcement(false, false, false, false, false, true, false);
1539 do_encoding_node_announcement(false, true, false, true, false, true, false);
1540 do_encoding_node_announcement(false, false, true, false, true, false, false);
1543 fn do_encoding_channel_update(non_bitcoin_chain_hash: bool, direction: bool, disable: bool, htlc_maximum_msat: bool) {
1544 let secp_ctx = Secp256k1::new();
1545 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1546 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1547 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
1548 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1549 short_channel_id: 2316138423780173,
1550 timestamp: 20190119,
1551 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 } | if htlc_maximum_msat { 1 << 8 } else { 0 },
1552 cltv_expiry_delta: 144,
1553 htlc_minimum_msat: 1000000,
1554 fee_base_msat: 10000,
1555 fee_proportional_millionths: 20,
1556 excess_data: if htlc_maximum_msat { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
1558 let channel_update = msgs::ChannelUpdate {
1560 contents: unsigned_channel_update
1562 let encoded_value = channel_update.encode();
1563 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1564 if non_bitcoin_chain_hash {
1565 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1567 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1569 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
1570 if htlc_maximum_msat {
1571 target_value.append(&mut hex::decode("01").unwrap());
1573 target_value.append(&mut hex::decode("00").unwrap());
1575 target_value.append(&mut hex::decode("00").unwrap());
1577 let flag = target_value.last_mut().unwrap();
1581 let flag = target_value.last_mut().unwrap();
1582 *flag = *flag | 1 << 1;
1584 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
1585 if htlc_maximum_msat {
1586 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
1588 assert_eq!(encoded_value, target_value);
1592 fn encoding_channel_update() {
1593 do_encoding_channel_update(false, false, false, false);
1594 do_encoding_channel_update(true, false, false, false);
1595 do_encoding_channel_update(false, true, false, false);
1596 do_encoding_channel_update(false, false, true, false);
1597 do_encoding_channel_update(false, false, false, true);
1598 do_encoding_channel_update(true, true, true, true);
1601 fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
1602 let secp_ctx = Secp256k1::new();
1603 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1604 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1605 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1606 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1607 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1608 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1609 let open_channel = msgs::OpenChannel {
1610 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1611 temporary_channel_id: [2; 32],
1612 funding_satoshis: 1311768467284833366,
1613 push_msat: 2536655962884945560,
1614 dust_limit_satoshis: 3608586615801332854,
1615 max_htlc_value_in_flight_msat: 8517154655701053848,
1616 channel_reserve_satoshis: 8665828695742877976,
1617 htlc_minimum_msat: 2316138423780173,
1618 feerate_per_kw: 821716,
1619 to_self_delay: 49340,
1620 max_accepted_htlcs: 49340,
1621 funding_pubkey: pubkey_1,
1622 revocation_basepoint: pubkey_2,
1623 payment_basepoint: pubkey_3,
1624 delayed_payment_basepoint: pubkey_4,
1625 htlc_basepoint: pubkey_5,
1626 first_per_commitment_point: pubkey_6,
1627 channel_flags: if random_bit { 1 << 5 } else { 0 },
1628 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1630 let encoded_value = open_channel.encode();
1631 let mut target_value = Vec::new();
1632 if non_bitcoin_chain_hash {
1633 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1635 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1637 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1639 target_value.append(&mut hex::decode("20").unwrap());
1641 target_value.append(&mut hex::decode("00").unwrap());
1644 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1646 assert_eq!(encoded_value, target_value);
1650 fn encoding_open_channel() {
1651 do_encoding_open_channel(false, false, false);
1652 do_encoding_open_channel(true, false, false);
1653 do_encoding_open_channel(false, true, false);
1654 do_encoding_open_channel(false, false, true);
1655 do_encoding_open_channel(true, true, true);
1658 fn do_encoding_accept_channel(shutdown: bool) {
1659 let secp_ctx = Secp256k1::new();
1660 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1661 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1662 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1663 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1664 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1665 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1666 let accept_channel = msgs::AcceptChannel {
1667 temporary_channel_id: [2; 32],
1668 dust_limit_satoshis: 1311768467284833366,
1669 max_htlc_value_in_flight_msat: 2536655962884945560,
1670 channel_reserve_satoshis: 3608586615801332854,
1671 htlc_minimum_msat: 2316138423780173,
1672 minimum_depth: 821716,
1673 to_self_delay: 49340,
1674 max_accepted_htlcs: 49340,
1675 funding_pubkey: pubkey_1,
1676 revocation_basepoint: pubkey_2,
1677 payment_basepoint: pubkey_3,
1678 delayed_payment_basepoint: pubkey_4,
1679 htlc_basepoint: pubkey_5,
1680 first_per_commitment_point: pubkey_6,
1681 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1683 let encoded_value = accept_channel.encode();
1684 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1686 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1688 assert_eq!(encoded_value, target_value);
1692 fn encoding_accept_channel() {
1693 do_encoding_accept_channel(false);
1694 do_encoding_accept_channel(true);
1698 fn encoding_funding_created() {
1699 let secp_ctx = Secp256k1::new();
1700 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1701 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1702 let funding_created = msgs::FundingCreated {
1703 temporary_channel_id: [2; 32],
1704 funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1705 funding_output_index: 255,
1708 let encoded_value = funding_created.encode();
1709 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1710 assert_eq!(encoded_value, target_value);
1714 fn encoding_funding_signed() {
1715 let secp_ctx = Secp256k1::new();
1716 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1717 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1718 let funding_signed = msgs::FundingSigned {
1719 channel_id: [2; 32],
1722 let encoded_value = funding_signed.encode();
1723 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1724 assert_eq!(encoded_value, target_value);
1728 fn encoding_funding_locked() {
1729 let secp_ctx = Secp256k1::new();
1730 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1731 let funding_locked = msgs::FundingLocked {
1732 channel_id: [2; 32],
1733 next_per_commitment_point: pubkey_1,
1735 let encoded_value = funding_locked.encode();
1736 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1737 assert_eq!(encoded_value, target_value);
1740 fn do_encoding_shutdown(script_type: u8) {
1741 let secp_ctx = Secp256k1::new();
1742 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1743 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1744 let shutdown = msgs::Shutdown {
1745 channel_id: [2; 32],
1746 scriptpubkey: if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() } else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() } else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() } else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
1748 let encoded_value = shutdown.encode();
1749 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1750 if script_type == 1 {
1751 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1752 } else if script_type == 2 {
1753 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1754 } else if script_type == 3 {
1755 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1756 } else if script_type == 4 {
1757 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1759 assert_eq!(encoded_value, target_value);
1763 fn encoding_shutdown() {
1764 do_encoding_shutdown(1);
1765 do_encoding_shutdown(2);
1766 do_encoding_shutdown(3);
1767 do_encoding_shutdown(4);
1771 fn encoding_closing_signed() {
1772 let secp_ctx = Secp256k1::new();
1773 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1774 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1775 let closing_signed = msgs::ClosingSigned {
1776 channel_id: [2; 32],
1777 fee_satoshis: 2316138423780173,
1780 let encoded_value = closing_signed.encode();
1781 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1782 assert_eq!(encoded_value, target_value);
1786 fn encoding_update_add_htlc() {
1787 let secp_ctx = Secp256k1::new();
1788 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1789 let onion_routing_packet = msgs::OnionPacket {
1791 public_key: Ok(pubkey_1),
1792 hop_data: [1; 20*65],
1795 let update_add_htlc = msgs::UpdateAddHTLC {
1796 channel_id: [2; 32],
1797 htlc_id: 2316138423780173,
1798 amount_msat: 3608586615801332854,
1799 payment_hash: PaymentHash([1; 32]),
1800 cltv_expiry: 821716,
1801 onion_routing_packet
1803 let encoded_value = update_add_htlc.encode();
1804 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
1805 assert_eq!(encoded_value, target_value);
1809 fn encoding_update_fulfill_htlc() {
1810 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
1811 channel_id: [2; 32],
1812 htlc_id: 2316138423780173,
1813 payment_preimage: PaymentPreimage([1; 32]),
1815 let encoded_value = update_fulfill_htlc.encode();
1816 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
1817 assert_eq!(encoded_value, target_value);
1821 fn encoding_update_fail_htlc() {
1822 let reason = OnionErrorPacket {
1823 data: [1; 32].to_vec(),
1825 let update_fail_htlc = msgs::UpdateFailHTLC {
1826 channel_id: [2; 32],
1827 htlc_id: 2316138423780173,
1830 let encoded_value = update_fail_htlc.encode();
1831 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
1832 assert_eq!(encoded_value, target_value);
1836 fn encoding_update_fail_malformed_htlc() {
1837 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
1838 channel_id: [2; 32],
1839 htlc_id: 2316138423780173,
1840 sha256_of_onion: [1; 32],
1843 let encoded_value = update_fail_malformed_htlc.encode();
1844 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
1845 assert_eq!(encoded_value, target_value);
1848 fn do_encoding_commitment_signed(htlcs: bool) {
1849 let secp_ctx = Secp256k1::new();
1850 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1851 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1852 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1853 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1854 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1855 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1856 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1857 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1858 let commitment_signed = msgs::CommitmentSigned {
1859 channel_id: [2; 32],
1861 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
1863 let encoded_value = commitment_signed.encode();
1864 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1866 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1868 target_value.append(&mut hex::decode("0000").unwrap());
1870 assert_eq!(encoded_value, target_value);
1874 fn encoding_commitment_signed() {
1875 do_encoding_commitment_signed(true);
1876 do_encoding_commitment_signed(false);
1880 fn encoding_revoke_and_ack() {
1881 let secp_ctx = Secp256k1::new();
1882 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1883 let raa = msgs::RevokeAndACK {
1884 channel_id: [2; 32],
1885 per_commitment_secret: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
1886 next_per_commitment_point: pubkey_1,
1888 let encoded_value = raa.encode();
1889 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1890 assert_eq!(encoded_value, target_value);
1894 fn encoding_update_fee() {
1895 let update_fee = msgs::UpdateFee {
1896 channel_id: [2; 32],
1897 feerate_per_kw: 20190119,
1899 let encoded_value = update_fee.encode();
1900 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
1901 assert_eq!(encoded_value, target_value);
1905 fn encoding_init() {
1906 assert_eq!(msgs::Init {
1907 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
1908 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
1909 assert_eq!(msgs::Init {
1910 features: InitFeatures::from_le_bytes(vec![0xFF]),
1911 }.encode(), hex::decode("0001ff0001ff").unwrap());
1912 assert_eq!(msgs::Init {
1913 features: InitFeatures::from_le_bytes(vec![]),
1914 }.encode(), hex::decode("00000000").unwrap());
1918 fn encoding_error() {
1919 let error = msgs::ErrorMessage {
1920 channel_id: [2; 32],
1921 data: String::from("rust-lightning"),
1923 let encoded_value = error.encode();
1924 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
1925 assert_eq!(encoded_value, target_value);
1929 fn encoding_ping() {
1930 let ping = msgs::Ping {
1934 let encoded_value = ping.encode();
1935 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1936 assert_eq!(encoded_value, target_value);
1940 fn encoding_pong() {
1941 let pong = msgs::Pong {
1944 let encoded_value = pong.encode();
1945 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1946 assert_eq!(encoded_value, target_value);