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>;
609 pub(crate) struct OnionRealm0HopData {
610 pub(crate) short_channel_id: u64,
611 pub(crate) amt_to_forward: u64,
612 pub(crate) outgoing_cltv_value: u32,
613 // 12 bytes of 0-padding
616 mod fuzzy_internal_msgs {
617 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
618 // them from untrusted input):
620 use super::OnionRealm0HopData;
621 pub struct OnionHopData {
622 pub(crate) realm: u8,
623 pub(crate) data: OnionRealm0HopData,
624 pub(crate) hmac: [u8; 32],
627 pub struct DecodedOnionErrorPacket {
628 pub(crate) hmac: [u8; 32],
629 pub(crate) failuremsg: Vec<u8>,
630 pub(crate) pad: Vec<u8>,
633 #[cfg(feature = "fuzztarget")]
634 pub use self::fuzzy_internal_msgs::*;
635 #[cfg(not(feature = "fuzztarget"))]
636 pub(crate) use self::fuzzy_internal_msgs::*;
639 pub(crate) struct OnionPacket {
640 pub(crate) version: u8,
641 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
642 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
643 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
644 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
645 pub(crate) hop_data: [u8; 20*65],
646 pub(crate) hmac: [u8; 32],
649 impl PartialEq for OnionPacket {
650 fn eq(&self, other: &OnionPacket) -> bool {
651 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
652 if i != j { return false; }
654 self.version == other.version &&
655 self.public_key == other.public_key &&
656 self.hmac == other.hmac
660 #[derive(Clone, PartialEq)]
661 pub(crate) struct OnionErrorPacket {
662 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
663 // (TODO) We limit it in decode to much lower...
664 pub(crate) data: Vec<u8>,
667 impl Error for DecodeError {
668 fn description(&self) -> &str {
670 DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
671 DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
672 DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
673 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
674 DecodeError::ExtraAddressesPerType => "More than one address of a single type",
675 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
676 DecodeError::Io(ref e) => e.description(),
680 impl fmt::Display for DecodeError {
681 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
682 f.write_str(self.description())
686 impl fmt::Debug for LightningError {
687 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
688 f.write_str(self.err)
692 impl From<::std::io::Error> for DecodeError {
693 fn from(e: ::std::io::Error) -> Self {
694 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
695 DecodeError::ShortRead
702 impl Writeable for OptionalField<Script> {
703 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
705 OptionalField::Present(ref script) => {
706 // Note that Writeable for script includes the 16-bit length tag for us
709 OptionalField::Absent => {}
715 impl<R: Read> Readable<R> for OptionalField<Script> {
716 fn read(r: &mut R) -> Result<Self, DecodeError> {
717 match <u16 as Readable<R>>::read(r) {
719 let mut buf = vec![0; len as usize];
720 r.read_exact(&mut buf)?;
721 Ok(OptionalField::Present(Script::from(buf)))
723 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
729 impl_writeable_len_match!(AcceptChannel, {
730 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
733 temporary_channel_id,
735 max_htlc_value_in_flight_msat,
736 channel_reserve_satoshis,
742 revocation_basepoint,
744 delayed_payment_basepoint,
746 first_per_commitment_point,
747 shutdown_scriptpubkey
750 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
757 impl Writeable for ChannelReestablish {
758 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
759 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
760 self.channel_id.write(w)?;
761 self.next_local_commitment_number.write(w)?;
762 self.next_remote_commitment_number.write(w)?;
763 match self.data_loss_protect {
764 OptionalField::Present(ref data_loss_protect) => {
765 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
766 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
768 OptionalField::Absent => {}
774 impl<R: Read> Readable<R> for ChannelReestablish{
775 fn read(r: &mut R) -> Result<Self, DecodeError> {
777 channel_id: Readable::read(r)?,
778 next_local_commitment_number: Readable::read(r)?,
779 next_remote_commitment_number: Readable::read(r)?,
781 match <[u8; 32] as Readable<R>>::read(r) {
782 Ok(your_last_per_commitment_secret) =>
783 OptionalField::Present(DataLossProtect {
784 your_last_per_commitment_secret,
785 my_current_per_commitment_point: Readable::read(r)?,
787 Err(DecodeError::ShortRead) => OptionalField::Absent,
788 Err(e) => return Err(e)
795 impl_writeable!(ClosingSigned, 32+8+64, {
801 impl_writeable_len_match!(CommitmentSigned, {
802 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
809 impl_writeable_len_match!(DecodedOnionErrorPacket, {
810 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
817 impl_writeable!(FundingCreated, 32+32+2+64, {
818 temporary_channel_id,
820 funding_output_index,
824 impl_writeable!(FundingSigned, 32+64, {
829 impl_writeable!(FundingLocked, 32+33, {
831 next_per_commitment_point
834 impl Writeable for Init {
835 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
836 // global_features gets the bottom 13 bits of our features, and local_features gets all of
837 // our relevant feature bits. This keeps us compatible with old nodes.
838 self.features.write_up_to_13(w)?;
839 self.features.write(w)
843 impl<R: Read> Readable<R> for Init {
844 fn read(r: &mut R) -> Result<Self, DecodeError> {
845 let global_features: InitFeatures = Readable::read(r)?;
846 let features: InitFeatures = Readable::read(r)?;
848 features: features.or(global_features),
853 impl_writeable_len_match!(OpenChannel, {
854 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
858 temporary_channel_id,
862 max_htlc_value_in_flight_msat,
863 channel_reserve_satoshis,
869 revocation_basepoint,
871 delayed_payment_basepoint,
873 first_per_commitment_point,
875 shutdown_scriptpubkey
878 impl_writeable!(RevokeAndACK, 32+32+33, {
880 per_commitment_secret,
881 next_per_commitment_point
884 impl_writeable_len_match!(Shutdown, {
885 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
891 impl_writeable_len_match!(UpdateFailHTLC, {
892 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
899 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
906 impl_writeable!(UpdateFee, 32+4, {
911 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
917 impl_writeable_len_match!(OnionErrorPacket, {
918 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
923 impl Writeable for OnionPacket {
924 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
925 w.size_hint(1 + 33 + 20*65 + 32);
926 self.version.write(w)?;
927 match self.public_key {
928 Ok(pubkey) => pubkey.write(w)?,
929 Err(_) => [0u8;33].write(w)?,
931 w.write_all(&self.hop_data)?;
937 impl<R: Read> Readable<R> for OnionPacket {
938 fn read(r: &mut R) -> Result<Self, DecodeError> {
940 version: Readable::read(r)?,
942 let mut buf = [0u8;33];
943 r.read_exact(&mut buf)?;
944 PublicKey::from_slice(&buf)
946 hop_data: Readable::read(r)?,
947 hmac: Readable::read(r)?,
952 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
961 impl Writeable for OnionRealm0HopData {
962 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
964 self.short_channel_id.write(w)?;
965 self.amt_to_forward.write(w)?;
966 self.outgoing_cltv_value.write(w)?;
967 w.write_all(&[0;12])?;
972 impl<R: Read> Readable<R> for OnionRealm0HopData {
973 fn read(r: &mut R) -> Result<Self, DecodeError> {
974 Ok(OnionRealm0HopData {
975 short_channel_id: Readable::read(r)?,
976 amt_to_forward: Readable::read(r)?,
977 outgoing_cltv_value: {
978 let v: u32 = Readable::read(r)?;
979 r.read_exact(&mut [0; 12])?;
986 impl Writeable for OnionHopData {
987 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
989 self.realm.write(w)?;
996 impl<R: Read> Readable<R> for OnionHopData {
997 fn read(r: &mut R) -> Result<Self, DecodeError> {
1000 let r: u8 = Readable::read(r)?;
1002 return Err(DecodeError::UnknownVersion);
1006 data: Readable::read(r)?,
1007 hmac: Readable::read(r)?,
1012 impl Writeable for Ping {
1013 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1014 w.size_hint(self.byteslen as usize + 4);
1015 self.ponglen.write(w)?;
1016 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1021 impl<R: Read> Readable<R> for Ping {
1022 fn read(r: &mut R) -> Result<Self, DecodeError> {
1024 ponglen: Readable::read(r)?,
1026 let byteslen = Readable::read(r)?;
1027 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1034 impl Writeable for Pong {
1035 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1036 w.size_hint(self.byteslen as usize + 2);
1037 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1042 impl<R: Read> Readable<R> for Pong {
1043 fn read(r: &mut R) -> Result<Self, DecodeError> {
1046 let byteslen = Readable::read(r)?;
1047 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1054 impl Writeable for UnsignedChannelAnnouncement {
1055 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1056 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1057 self.features.write(w)?;
1058 self.chain_hash.write(w)?;
1059 self.short_channel_id.write(w)?;
1060 self.node_id_1.write(w)?;
1061 self.node_id_2.write(w)?;
1062 self.bitcoin_key_1.write(w)?;
1063 self.bitcoin_key_2.write(w)?;
1064 w.write_all(&self.excess_data[..])?;
1069 impl<R: Read> Readable<R> for UnsignedChannelAnnouncement {
1070 fn read(r: &mut R) -> Result<Self, DecodeError> {
1072 features: Readable::read(r)?,
1073 chain_hash: Readable::read(r)?,
1074 short_channel_id: Readable::read(r)?,
1075 node_id_1: Readable::read(r)?,
1076 node_id_2: Readable::read(r)?,
1077 bitcoin_key_1: Readable::read(r)?,
1078 bitcoin_key_2: Readable::read(r)?,
1080 let mut excess_data = vec![];
1081 r.read_to_end(&mut excess_data)?;
1088 impl_writeable_len_match!(ChannelAnnouncement, {
1089 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1090 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1094 bitcoin_signature_1,
1095 bitcoin_signature_2,
1099 impl Writeable for UnsignedChannelUpdate {
1100 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1101 w.size_hint(64 + self.excess_data.len());
1102 self.chain_hash.write(w)?;
1103 self.short_channel_id.write(w)?;
1104 self.timestamp.write(w)?;
1105 self.flags.write(w)?;
1106 self.cltv_expiry_delta.write(w)?;
1107 self.htlc_minimum_msat.write(w)?;
1108 self.fee_base_msat.write(w)?;
1109 self.fee_proportional_millionths.write(w)?;
1110 w.write_all(&self.excess_data[..])?;
1115 impl<R: Read> Readable<R> for UnsignedChannelUpdate {
1116 fn read(r: &mut R) -> Result<Self, DecodeError> {
1118 chain_hash: Readable::read(r)?,
1119 short_channel_id: Readable::read(r)?,
1120 timestamp: Readable::read(r)?,
1121 flags: Readable::read(r)?,
1122 cltv_expiry_delta: Readable::read(r)?,
1123 htlc_minimum_msat: Readable::read(r)?,
1124 fee_base_msat: Readable::read(r)?,
1125 fee_proportional_millionths: Readable::read(r)?,
1127 let mut excess_data = vec![];
1128 r.read_to_end(&mut excess_data)?;
1135 impl_writeable_len_match!(ChannelUpdate, {
1136 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1137 64 + excess_data.len() + 64 }
1143 impl Writeable for ErrorMessage {
1144 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1145 w.size_hint(32 + 2 + self.data.len());
1146 self.channel_id.write(w)?;
1147 (self.data.len() as u16).write(w)?;
1148 w.write_all(self.data.as_bytes())?;
1153 impl<R: Read> Readable<R> for ErrorMessage {
1154 fn read(r: &mut R) -> Result<Self, DecodeError> {
1156 channel_id: Readable::read(r)?,
1158 let mut sz: usize = <u16 as Readable<R>>::read(r)? as usize;
1159 let mut data = vec![];
1160 let data_len = r.read_to_end(&mut data)?;
1161 sz = cmp::min(data_len, sz);
1162 match String::from_utf8(data[..sz as usize].to_vec()) {
1164 Err(_) => return Err(DecodeError::InvalidValue),
1171 impl Writeable for UnsignedNodeAnnouncement {
1172 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1173 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1174 self.features.write(w)?;
1175 self.timestamp.write(w)?;
1176 self.node_id.write(w)?;
1177 w.write_all(&self.rgb)?;
1178 self.alias.write(w)?;
1180 let mut addrs_to_encode = self.addresses.clone();
1181 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1182 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1183 let mut addr_len = 0;
1184 for addr in &addrs_to_encode {
1185 addr_len += 1 + addr.len();
1187 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1188 for addr in addrs_to_encode {
1191 w.write_all(&self.excess_address_data[..])?;
1192 w.write_all(&self.excess_data[..])?;
1197 impl<R: Read> Readable<R> for UnsignedNodeAnnouncement {
1198 fn read(r: &mut R) -> Result<Self, DecodeError> {
1199 let features: NodeFeatures = Readable::read(r)?;
1200 let timestamp: u32 = Readable::read(r)?;
1201 let node_id: PublicKey = Readable::read(r)?;
1202 let mut rgb = [0; 3];
1203 r.read_exact(&mut rgb)?;
1204 let alias: [u8; 32] = Readable::read(r)?;
1206 let addr_len: u16 = Readable::read(r)?;
1207 let mut addresses: Vec<NetAddress> = Vec::with_capacity(4);
1208 let mut addr_readpos = 0;
1209 let mut excess = false;
1210 let mut excess_byte = 0;
1212 if addr_len <= addr_readpos { break; }
1213 match Readable::read(r) {
1216 NetAddress::IPv4 { .. } => {
1217 if addresses.len() > 0 {
1218 return Err(DecodeError::ExtraAddressesPerType);
1221 NetAddress::IPv6 { .. } => {
1222 if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1223 return Err(DecodeError::ExtraAddressesPerType);
1226 NetAddress::OnionV2 { .. } => {
1227 if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1228 return Err(DecodeError::ExtraAddressesPerType);
1231 NetAddress::OnionV3 { .. } => {
1232 if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1233 return Err(DecodeError::ExtraAddressesPerType);
1237 if addr_len < addr_readpos + 1 + addr.len() {
1238 return Err(DecodeError::BadLengthDescriptor);
1240 addr_readpos += (1 + addr.len()) as u16;
1241 addresses.push(addr);
1243 Ok(Err(unknown_descriptor)) => {
1245 excess_byte = unknown_descriptor;
1248 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1249 Err(e) => return Err(e),
1253 let mut excess_data = vec![];
1254 let excess_address_data = if addr_readpos < addr_len {
1255 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1256 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1258 excess_address_data[0] = excess_byte;
1263 excess_data.push(excess_byte);
1267 r.read_to_end(&mut excess_data)?;
1268 Ok(UnsignedNodeAnnouncement {
1275 excess_address_data,
1281 impl_writeable_len_match!(NodeAnnouncement, {
1282 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1283 64 + 76 + features.byte_count() + addresses.len()*38 + excess_address_data.len() + excess_data.len() }
1293 use ln::msgs::{ChannelFeatures, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket};
1294 use ln::channelmanager::{PaymentPreimage, PaymentHash};
1295 use util::ser::Writeable;
1297 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
1298 use bitcoin_hashes::hex::FromHex;
1299 use bitcoin::util::address::Address;
1300 use bitcoin::network::constants::Network;
1301 use bitcoin::blockdata::script::Builder;
1302 use bitcoin::blockdata::opcodes;
1304 use secp256k1::key::{PublicKey,SecretKey};
1305 use secp256k1::{Secp256k1, Message};
1308 fn encoding_channel_reestablish_no_secret() {
1309 let cr = msgs::ChannelReestablish {
1310 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],
1311 next_local_commitment_number: 3,
1312 next_remote_commitment_number: 4,
1313 data_loss_protect: OptionalField::Absent,
1316 let encoded_value = cr.encode();
1319 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]
1324 fn encoding_channel_reestablish_with_secret() {
1326 let secp_ctx = Secp256k1::new();
1327 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1330 let cr = msgs::ChannelReestablish {
1331 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],
1332 next_local_commitment_number: 3,
1333 next_remote_commitment_number: 4,
1334 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1337 let encoded_value = cr.encode();
1340 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]
1344 macro_rules! get_keys_from {
1345 ($slice: expr, $secp_ctx: expr) => {
1347 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1348 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1354 macro_rules! get_sig_on {
1355 ($privkey: expr, $ctx: expr, $string: expr) => {
1357 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1358 $ctx.sign(&sighash, &$privkey)
1364 fn encoding_announcement_signatures() {
1365 let secp_ctx = Secp256k1::new();
1366 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1367 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1368 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1369 let announcement_signatures = msgs::AnnouncementSignatures {
1370 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],
1371 short_channel_id: 2316138423780173,
1372 node_signature: sig_1,
1373 bitcoin_signature: sig_2,
1376 let encoded_value = announcement_signatures.encode();
1377 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1380 fn do_encoding_channel_announcement(unknown_features_bits: bool, non_bitcoin_chain_hash: bool, excess_data: bool) {
1381 let secp_ctx = Secp256k1::new();
1382 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1383 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1384 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1385 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1386 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1387 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1388 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1389 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1390 let mut features = ChannelFeatures::supported();
1391 if unknown_features_bits {
1392 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1394 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1396 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1397 short_channel_id: 2316138423780173,
1398 node_id_1: pubkey_1,
1399 node_id_2: pubkey_2,
1400 bitcoin_key_1: pubkey_3,
1401 bitcoin_key_2: pubkey_4,
1402 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1404 let channel_announcement = msgs::ChannelAnnouncement {
1405 node_signature_1: sig_1,
1406 node_signature_2: sig_2,
1407 bitcoin_signature_1: sig_3,
1408 bitcoin_signature_2: sig_4,
1409 contents: unsigned_channel_announcement,
1411 let encoded_value = channel_announcement.encode();
1412 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1413 if unknown_features_bits {
1414 target_value.append(&mut hex::decode("0002ffff").unwrap());
1416 target_value.append(&mut hex::decode("0000").unwrap());
1418 if non_bitcoin_chain_hash {
1419 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1421 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1423 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1425 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1427 assert_eq!(encoded_value, target_value);
1431 fn encoding_channel_announcement() {
1432 do_encoding_channel_announcement(false, false, false);
1433 do_encoding_channel_announcement(true, false, false);
1434 do_encoding_channel_announcement(true, true, false);
1435 do_encoding_channel_announcement(true, true, true);
1436 do_encoding_channel_announcement(false, true, true);
1437 do_encoding_channel_announcement(false, false, true);
1438 do_encoding_channel_announcement(false, true, false);
1439 do_encoding_channel_announcement(true, false, true);
1442 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1443 let secp_ctx = Secp256k1::new();
1444 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1445 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1446 let features = if unknown_features_bits {
1447 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1449 // Set to some features we may support
1450 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1452 let mut addresses = Vec::new();
1454 addresses.push(msgs::NetAddress::IPv4 {
1455 addr: [255, 254, 253, 252],
1460 addresses.push(msgs::NetAddress::IPv6 {
1461 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1466 addresses.push(msgs::NetAddress::OnionV2 {
1467 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1472 addresses.push(msgs::NetAddress::OnionV3 {
1473 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],
1479 let mut addr_len = 0;
1480 for addr in &addresses {
1481 addr_len += addr.len() + 1;
1483 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1485 timestamp: 20190119,
1490 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() },
1491 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() },
1493 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1494 let node_announcement = msgs::NodeAnnouncement {
1496 contents: unsigned_node_announcement,
1498 let encoded_value = node_announcement.encode();
1499 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1500 if unknown_features_bits {
1501 target_value.append(&mut hex::decode("0002ffff").unwrap());
1503 target_value.append(&mut hex::decode("000122").unwrap());
1505 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1506 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1508 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1511 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1514 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1517 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1519 if excess_address_data {
1520 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1523 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1525 assert_eq!(encoded_value, target_value);
1529 fn encoding_node_announcement() {
1530 do_encoding_node_announcement(true, true, true, true, true, true, true);
1531 do_encoding_node_announcement(false, false, false, false, false, false, false);
1532 do_encoding_node_announcement(false, true, false, false, false, false, false);
1533 do_encoding_node_announcement(false, false, true, false, false, false, false);
1534 do_encoding_node_announcement(false, false, false, true, false, false, false);
1535 do_encoding_node_announcement(false, false, false, false, true, false, false);
1536 do_encoding_node_announcement(false, false, false, false, false, true, false);
1537 do_encoding_node_announcement(false, true, false, true, false, true, false);
1538 do_encoding_node_announcement(false, false, true, false, true, false, false);
1541 fn do_encoding_channel_update(non_bitcoin_chain_hash: bool, direction: bool, disable: bool, htlc_maximum_msat: bool) {
1542 let secp_ctx = Secp256k1::new();
1543 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1544 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1545 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
1546 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1547 short_channel_id: 2316138423780173,
1548 timestamp: 20190119,
1549 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 } | if htlc_maximum_msat { 1 << 8 } else { 0 },
1550 cltv_expiry_delta: 144,
1551 htlc_minimum_msat: 1000000,
1552 fee_base_msat: 10000,
1553 fee_proportional_millionths: 20,
1554 excess_data: if htlc_maximum_msat { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
1556 let channel_update = msgs::ChannelUpdate {
1558 contents: unsigned_channel_update
1560 let encoded_value = channel_update.encode();
1561 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1562 if non_bitcoin_chain_hash {
1563 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1565 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1567 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
1568 if htlc_maximum_msat {
1569 target_value.append(&mut hex::decode("01").unwrap());
1571 target_value.append(&mut hex::decode("00").unwrap());
1573 target_value.append(&mut hex::decode("00").unwrap());
1575 let flag = target_value.last_mut().unwrap();
1579 let flag = target_value.last_mut().unwrap();
1580 *flag = *flag | 1 << 1;
1582 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
1583 if htlc_maximum_msat {
1584 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
1586 assert_eq!(encoded_value, target_value);
1590 fn encoding_channel_update() {
1591 do_encoding_channel_update(false, false, false, false);
1592 do_encoding_channel_update(true, false, false, false);
1593 do_encoding_channel_update(false, true, false, false);
1594 do_encoding_channel_update(false, false, true, false);
1595 do_encoding_channel_update(false, false, false, true);
1596 do_encoding_channel_update(true, true, true, true);
1599 fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
1600 let secp_ctx = Secp256k1::new();
1601 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1602 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1603 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1604 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1605 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1606 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1607 let open_channel = msgs::OpenChannel {
1608 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1609 temporary_channel_id: [2; 32],
1610 funding_satoshis: 1311768467284833366,
1611 push_msat: 2536655962884945560,
1612 dust_limit_satoshis: 3608586615801332854,
1613 max_htlc_value_in_flight_msat: 8517154655701053848,
1614 channel_reserve_satoshis: 8665828695742877976,
1615 htlc_minimum_msat: 2316138423780173,
1616 feerate_per_kw: 821716,
1617 to_self_delay: 49340,
1618 max_accepted_htlcs: 49340,
1619 funding_pubkey: pubkey_1,
1620 revocation_basepoint: pubkey_2,
1621 payment_basepoint: pubkey_3,
1622 delayed_payment_basepoint: pubkey_4,
1623 htlc_basepoint: pubkey_5,
1624 first_per_commitment_point: pubkey_6,
1625 channel_flags: if random_bit { 1 << 5 } else { 0 },
1626 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1628 let encoded_value = open_channel.encode();
1629 let mut target_value = Vec::new();
1630 if non_bitcoin_chain_hash {
1631 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1633 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1635 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1637 target_value.append(&mut hex::decode("20").unwrap());
1639 target_value.append(&mut hex::decode("00").unwrap());
1642 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1644 assert_eq!(encoded_value, target_value);
1648 fn encoding_open_channel() {
1649 do_encoding_open_channel(false, false, false);
1650 do_encoding_open_channel(true, false, false);
1651 do_encoding_open_channel(false, true, false);
1652 do_encoding_open_channel(false, false, true);
1653 do_encoding_open_channel(true, true, true);
1656 fn do_encoding_accept_channel(shutdown: bool) {
1657 let secp_ctx = Secp256k1::new();
1658 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1659 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1660 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1661 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1662 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1663 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1664 let accept_channel = msgs::AcceptChannel {
1665 temporary_channel_id: [2; 32],
1666 dust_limit_satoshis: 1311768467284833366,
1667 max_htlc_value_in_flight_msat: 2536655962884945560,
1668 channel_reserve_satoshis: 3608586615801332854,
1669 htlc_minimum_msat: 2316138423780173,
1670 minimum_depth: 821716,
1671 to_self_delay: 49340,
1672 max_accepted_htlcs: 49340,
1673 funding_pubkey: pubkey_1,
1674 revocation_basepoint: pubkey_2,
1675 payment_basepoint: pubkey_3,
1676 delayed_payment_basepoint: pubkey_4,
1677 htlc_basepoint: pubkey_5,
1678 first_per_commitment_point: pubkey_6,
1679 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1681 let encoded_value = accept_channel.encode();
1682 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1684 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1686 assert_eq!(encoded_value, target_value);
1690 fn encoding_accept_channel() {
1691 do_encoding_accept_channel(false);
1692 do_encoding_accept_channel(true);
1696 fn encoding_funding_created() {
1697 let secp_ctx = Secp256k1::new();
1698 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1699 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1700 let funding_created = msgs::FundingCreated {
1701 temporary_channel_id: [2; 32],
1702 funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1703 funding_output_index: 255,
1706 let encoded_value = funding_created.encode();
1707 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1708 assert_eq!(encoded_value, target_value);
1712 fn encoding_funding_signed() {
1713 let secp_ctx = Secp256k1::new();
1714 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1715 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1716 let funding_signed = msgs::FundingSigned {
1717 channel_id: [2; 32],
1720 let encoded_value = funding_signed.encode();
1721 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1722 assert_eq!(encoded_value, target_value);
1726 fn encoding_funding_locked() {
1727 let secp_ctx = Secp256k1::new();
1728 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1729 let funding_locked = msgs::FundingLocked {
1730 channel_id: [2; 32],
1731 next_per_commitment_point: pubkey_1,
1733 let encoded_value = funding_locked.encode();
1734 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1735 assert_eq!(encoded_value, target_value);
1738 fn do_encoding_shutdown(script_type: u8) {
1739 let secp_ctx = Secp256k1::new();
1740 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1741 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1742 let shutdown = msgs::Shutdown {
1743 channel_id: [2; 32],
1744 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() },
1746 let encoded_value = shutdown.encode();
1747 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1748 if script_type == 1 {
1749 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1750 } else if script_type == 2 {
1751 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1752 } else if script_type == 3 {
1753 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1754 } else if script_type == 4 {
1755 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1757 assert_eq!(encoded_value, target_value);
1761 fn encoding_shutdown() {
1762 do_encoding_shutdown(1);
1763 do_encoding_shutdown(2);
1764 do_encoding_shutdown(3);
1765 do_encoding_shutdown(4);
1769 fn encoding_closing_signed() {
1770 let secp_ctx = Secp256k1::new();
1771 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1772 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1773 let closing_signed = msgs::ClosingSigned {
1774 channel_id: [2; 32],
1775 fee_satoshis: 2316138423780173,
1778 let encoded_value = closing_signed.encode();
1779 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1780 assert_eq!(encoded_value, target_value);
1784 fn encoding_update_add_htlc() {
1785 let secp_ctx = Secp256k1::new();
1786 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1787 let onion_routing_packet = msgs::OnionPacket {
1789 public_key: Ok(pubkey_1),
1790 hop_data: [1; 20*65],
1793 let update_add_htlc = msgs::UpdateAddHTLC {
1794 channel_id: [2; 32],
1795 htlc_id: 2316138423780173,
1796 amount_msat: 3608586615801332854,
1797 payment_hash: PaymentHash([1; 32]),
1798 cltv_expiry: 821716,
1799 onion_routing_packet
1801 let encoded_value = update_add_htlc.encode();
1802 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
1803 assert_eq!(encoded_value, target_value);
1807 fn encoding_update_fulfill_htlc() {
1808 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
1809 channel_id: [2; 32],
1810 htlc_id: 2316138423780173,
1811 payment_preimage: PaymentPreimage([1; 32]),
1813 let encoded_value = update_fulfill_htlc.encode();
1814 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
1815 assert_eq!(encoded_value, target_value);
1819 fn encoding_update_fail_htlc() {
1820 let reason = OnionErrorPacket {
1821 data: [1; 32].to_vec(),
1823 let update_fail_htlc = msgs::UpdateFailHTLC {
1824 channel_id: [2; 32],
1825 htlc_id: 2316138423780173,
1828 let encoded_value = update_fail_htlc.encode();
1829 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
1830 assert_eq!(encoded_value, target_value);
1834 fn encoding_update_fail_malformed_htlc() {
1835 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
1836 channel_id: [2; 32],
1837 htlc_id: 2316138423780173,
1838 sha256_of_onion: [1; 32],
1841 let encoded_value = update_fail_malformed_htlc.encode();
1842 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
1843 assert_eq!(encoded_value, target_value);
1846 fn do_encoding_commitment_signed(htlcs: bool) {
1847 let secp_ctx = Secp256k1::new();
1848 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1849 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1850 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1851 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1852 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1853 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1854 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1855 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1856 let commitment_signed = msgs::CommitmentSigned {
1857 channel_id: [2; 32],
1859 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
1861 let encoded_value = commitment_signed.encode();
1862 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1864 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1866 target_value.append(&mut hex::decode("0000").unwrap());
1868 assert_eq!(encoded_value, target_value);
1872 fn encoding_commitment_signed() {
1873 do_encoding_commitment_signed(true);
1874 do_encoding_commitment_signed(false);
1878 fn encoding_revoke_and_ack() {
1879 let secp_ctx = Secp256k1::new();
1880 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1881 let raa = msgs::RevokeAndACK {
1882 channel_id: [2; 32],
1883 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],
1884 next_per_commitment_point: pubkey_1,
1886 let encoded_value = raa.encode();
1887 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1888 assert_eq!(encoded_value, target_value);
1892 fn encoding_update_fee() {
1893 let update_fee = msgs::UpdateFee {
1894 channel_id: [2; 32],
1895 feerate_per_kw: 20190119,
1897 let encoded_value = update_fee.encode();
1898 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
1899 assert_eq!(encoded_value, target_value);
1903 fn encoding_init() {
1904 assert_eq!(msgs::Init {
1905 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
1906 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
1907 assert_eq!(msgs::Init {
1908 features: InitFeatures::from_le_bytes(vec![0xFF]),
1909 }.encode(), hex::decode("0001ff0001ff").unwrap());
1910 assert_eq!(msgs::Init {
1911 features: InitFeatures::from_le_bytes(vec![]),
1912 }.encode(), hex::decode("00000000").unwrap());
1916 fn encoding_error() {
1917 let error = msgs::ErrorMessage {
1918 channel_id: [2; 32],
1919 data: String::from("rust-lightning"),
1921 let encoded_value = error.encode();
1922 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
1923 assert_eq!(encoded_value, target_value);
1927 fn encoding_ping() {
1928 let ping = msgs::Ping {
1932 let encoded_value = ping.encode();
1933 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1934 assert_eq!(encoded_value, target_value);
1938 fn encoding_pong() {
1939 let pong = msgs::Pong {
1942 let encoded_value = pong.encode();
1943 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1944 assert_eq!(encoded_value, target_value);