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 std::error::Error;
27 use std::result::Result;
30 use util::ser::{Readable, Writeable, Writer};
32 use ln::channelmanager::{PaymentPreimage, PaymentHash};
34 /// An error in decoding a message or struct.
36 pub enum DecodeError {
37 /// A version byte specified something we don't know how to handle.
38 /// Includes unknown realm byte in an OnionHopData packet
40 /// Unknown feature mandating we fail to parse message
41 UnknownRequiredFeature,
42 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
43 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc
47 /// node_announcement included more than one address of a given type!
48 ExtraAddressesPerType,
49 /// A length descriptor in the packet didn't describe the later data correctly
51 /// Error from std::io
55 /// Tracks localfeatures which are only in init messages
56 #[derive(Clone, PartialEq)]
57 pub struct LocalFeatures {
62 pub(crate) fn new() -> LocalFeatures {
68 pub(crate) fn supports_data_loss_protect(&self) -> bool {
69 self.flags.len() > 0 && (self.flags[0] & 3) != 0
71 pub(crate) fn requires_data_loss_protect(&self) -> bool {
72 self.flags.len() > 0 && (self.flags[0] & 1) != 0
75 pub(crate) fn initial_routing_sync(&self) -> bool {
76 self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0
78 pub(crate) fn set_initial_routing_sync(&mut self) {
79 if self.flags.len() == 0 {
80 self.flags.resize(1, 1 << 3);
82 self.flags[0] |= 1 << 3;
86 pub(crate) fn supports_upfront_shutdown_script(&self) -> bool {
87 self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0
89 pub(crate) fn requires_upfront_shutdown_script(&self) -> bool {
90 self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0
93 pub(crate) fn requires_unknown_bits(&self) -> bool {
94 self.flags.iter().enumerate().any(|(idx, &byte)| {
95 ( idx != 0 && (byte & 0x55) != 0 ) || ( idx == 0 && (byte & 0x14) != 0 )
99 pub(crate) fn supports_unknown_bits(&self) -> bool {
100 self.flags.iter().enumerate().any(|(idx, &byte)| {
101 ( idx != 0 && byte != 0 ) || ( idx == 0 && (byte & 0xc4) != 0 )
106 /// Tracks globalfeatures which are in init messages and routing announcements
107 #[derive(Clone, PartialEq, Debug)]
108 pub struct GlobalFeatures {
111 // Used to test encoding of diverse msgs
116 impl GlobalFeatures {
117 pub(crate) fn new() -> GlobalFeatures {
123 pub(crate) fn requires_unknown_bits(&self) -> bool {
124 for &byte in self.flags.iter() {
125 if (byte & 0x55) != 0 {
132 pub(crate) fn supports_unknown_bits(&self) -> bool {
133 for &byte in self.flags.iter() {
142 /// An init message to be sent or received from a peer
144 pub(crate) global_features: GlobalFeatures,
145 pub(crate) local_features: LocalFeatures,
148 /// An error message to be sent or received from a peer
150 pub struct ErrorMessage {
151 pub(crate) channel_id: [u8; 32],
152 pub(crate) data: String,
155 /// A ping message to be sent or received from a peer
157 pub(crate) ponglen: u16,
158 pub(crate) byteslen: u16,
161 /// A pong message to be sent or received from a peer
163 pub(crate) byteslen: u16,
166 /// An open_channel message to be sent or received from a peer
168 pub struct OpenChannel {
169 pub(crate) chain_hash: Sha256dHash,
170 pub(crate) temporary_channel_id: [u8; 32],
171 pub(crate) funding_satoshis: u64,
172 pub(crate) push_msat: u64,
173 pub(crate) dust_limit_satoshis: u64,
174 pub(crate) max_htlc_value_in_flight_msat: u64,
175 pub(crate) channel_reserve_satoshis: u64,
176 pub(crate) htlc_minimum_msat: u64,
177 pub(crate) feerate_per_kw: u32,
178 pub(crate) to_self_delay: u16,
179 pub(crate) max_accepted_htlcs: u16,
180 pub(crate) funding_pubkey: PublicKey,
181 pub(crate) revocation_basepoint: PublicKey,
182 pub(crate) payment_basepoint: PublicKey,
183 pub(crate) delayed_payment_basepoint: PublicKey,
184 pub(crate) htlc_basepoint: PublicKey,
185 pub(crate) first_per_commitment_point: PublicKey,
186 pub(crate) channel_flags: u8,
187 pub(crate) shutdown_scriptpubkey: OptionalField<Script>,
190 /// An accept_channel message to be sent or received from a peer
192 pub struct AcceptChannel {
193 pub(crate) temporary_channel_id: [u8; 32],
194 pub(crate) dust_limit_satoshis: u64,
195 pub(crate) max_htlc_value_in_flight_msat: u64,
196 pub(crate) channel_reserve_satoshis: u64,
197 pub(crate) htlc_minimum_msat: u64,
198 pub(crate) minimum_depth: u32,
199 pub(crate) to_self_delay: u16,
200 pub(crate) max_accepted_htlcs: u16,
201 pub(crate) funding_pubkey: PublicKey,
202 pub(crate) revocation_basepoint: PublicKey,
203 pub(crate) payment_basepoint: PublicKey,
204 pub(crate) delayed_payment_basepoint: PublicKey,
205 pub(crate) htlc_basepoint: PublicKey,
206 pub(crate) first_per_commitment_point: PublicKey,
207 pub(crate) shutdown_scriptpubkey: OptionalField<Script>
210 /// A funding_created message to be sent or received from a peer
212 pub struct FundingCreated {
213 pub(crate) temporary_channel_id: [u8; 32],
214 pub(crate) funding_txid: Sha256dHash,
215 pub(crate) funding_output_index: u16,
216 pub(crate) signature: Signature,
219 /// A funding_signed message to be sent or received from a peer
221 pub struct FundingSigned {
222 pub(crate) channel_id: [u8; 32],
223 pub(crate) signature: Signature,
226 /// A funding_locked message to be sent or received from a peer
227 #[derive(Clone, PartialEq)]
228 pub struct FundingLocked {
229 pub(crate) channel_id: [u8; 32],
230 pub(crate) next_per_commitment_point: PublicKey,
233 /// A shutdown message to be sent or received from a peer
234 #[derive(Clone, PartialEq)]
235 pub struct Shutdown {
236 pub(crate) channel_id: [u8; 32],
237 pub(crate) scriptpubkey: Script,
240 /// A closing_signed message to be sent or received from a peer
241 #[derive(Clone, PartialEq)]
242 pub struct ClosingSigned {
243 pub(crate) channel_id: [u8; 32],
244 pub(crate) fee_satoshis: u64,
245 pub(crate) signature: Signature,
248 /// An update_add_htlc message to be sent or received from a peer
249 #[derive(Clone, PartialEq)]
250 pub struct UpdateAddHTLC {
251 pub(crate) channel_id: [u8; 32],
252 pub(crate) htlc_id: u64,
253 pub(crate) amount_msat: u64,
254 pub(crate) payment_hash: PaymentHash,
255 pub(crate) cltv_expiry: u32,
256 pub(crate) onion_routing_packet: OnionPacket,
259 /// An update_fulfill_htlc message to be sent or received from a peer
260 #[derive(Clone, PartialEq)]
261 pub struct UpdateFulfillHTLC {
262 pub(crate) channel_id: [u8; 32],
263 pub(crate) htlc_id: u64,
264 pub(crate) payment_preimage: PaymentPreimage,
267 /// An update_fail_htlc message to be sent or received from a peer
268 #[derive(Clone, PartialEq)]
269 pub struct UpdateFailHTLC {
270 pub(crate) channel_id: [u8; 32],
271 pub(crate) htlc_id: u64,
272 pub(crate) reason: OnionErrorPacket,
275 /// An update_fail_malformed_htlc message to be sent or received from a peer
276 #[derive(Clone, PartialEq)]
277 pub struct UpdateFailMalformedHTLC {
278 pub(crate) channel_id: [u8; 32],
279 pub(crate) htlc_id: u64,
280 pub(crate) sha256_of_onion: [u8; 32],
281 pub(crate) failure_code: u16,
284 /// A commitment_signed message to be sent or received from a peer
285 #[derive(Clone, PartialEq)]
286 pub struct CommitmentSigned {
287 pub(crate) channel_id: [u8; 32],
288 pub(crate) signature: Signature,
289 pub(crate) htlc_signatures: Vec<Signature>,
292 /// A revoke_and_ack message to be sent or received from a peer
293 #[derive(Clone, PartialEq)]
294 pub struct RevokeAndACK {
295 pub(crate) channel_id: [u8; 32],
296 pub(crate) per_commitment_secret: [u8; 32],
297 pub(crate) next_per_commitment_point: PublicKey,
300 /// An update_fee message to be sent or received from a peer
301 #[derive(PartialEq, Clone)]
302 pub struct UpdateFee {
303 pub(crate) channel_id: [u8; 32],
304 pub(crate) feerate_per_kw: u32,
307 #[derive(PartialEq, Clone)]
308 pub(crate) struct DataLossProtect {
309 pub(crate) your_last_per_commitment_secret: [u8; 32],
310 pub(crate) my_current_per_commitment_point: PublicKey,
313 /// A channel_reestablish message to be sent or received from a peer
314 #[derive(PartialEq, Clone)]
315 pub struct ChannelReestablish {
316 pub(crate) channel_id: [u8; 32],
317 pub(crate) next_local_commitment_number: u64,
318 pub(crate) next_remote_commitment_number: u64,
319 pub(crate) data_loss_protect: OptionalField<DataLossProtect>,
322 /// An announcement_signatures message to be sent or received from a peer
323 #[derive(PartialEq, Clone, Debug)]
324 pub struct AnnouncementSignatures {
325 pub(crate) channel_id: [u8; 32],
326 pub(crate) short_channel_id: u64,
327 pub(crate) node_signature: Signature,
328 pub(crate) bitcoin_signature: Signature,
331 /// An address which can be used to connect to a remote peer
332 #[derive(Clone, PartialEq, Debug)]
333 pub enum NetAddress {
334 /// An IPv4 address/port on which the peer is listening.
336 /// The 4-byte IPv4 address
338 /// The port on which the node is listening
341 /// An IPv6 address/port on which the peer is listening.
343 /// The 16-byte IPv6 address
345 /// The port on which the node is listening
348 /// An old-style Tor onion address/port on which the peer is listening.
350 /// The bytes (usually encoded in base32 with ".onion" appended)
352 /// The port on which the node is listening
355 /// A new-style Tor onion address/port on which the peer is listening.
356 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
357 /// wrap as base32 and append ".onion".
359 /// The ed25519 long-term public key of the peer
360 ed25519_pubkey: [u8; 32],
361 /// The checksum of the pubkey and version, as included in the onion address
363 /// The version byte, as defined by the Tor Onion v3 spec.
365 /// The port on which the node is listening
370 fn get_id(&self) -> u8 {
372 &NetAddress::IPv4 {..} => { 1 },
373 &NetAddress::IPv6 {..} => { 2 },
374 &NetAddress::OnionV2 {..} => { 3 },
375 &NetAddress::OnionV3 {..} => { 4 },
379 /// Strict byte-length of address descriptor, 1-byte type not recorded
380 fn len(&self) -> u16 {
382 &NetAddress::IPv4 { .. } => { 6 },
383 &NetAddress::IPv6 { .. } => { 18 },
384 &NetAddress::OnionV2 { .. } => { 12 },
385 &NetAddress::OnionV3 { .. } => { 37 },
390 impl Writeable for NetAddress {
391 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
393 &NetAddress::IPv4 { ref addr, ref port } => {
398 &NetAddress::IPv6 { ref addr, ref port } => {
403 &NetAddress::OnionV2 { ref addr, ref port } => {
408 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
410 ed25519_pubkey.write(writer)?;
411 checksum.write(writer)?;
412 version.write(writer)?;
420 impl<R: ::std::io::Read> Readable<R> for Result<NetAddress, u8> {
421 fn read(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
422 let byte = <u8 as Readable<R>>::read(reader)?;
425 Ok(Ok(NetAddress::IPv4 {
426 addr: Readable::read(reader)?,
427 port: Readable::read(reader)?,
431 Ok(Ok(NetAddress::IPv6 {
432 addr: Readable::read(reader)?,
433 port: Readable::read(reader)?,
437 Ok(Ok(NetAddress::OnionV2 {
438 addr: Readable::read(reader)?,
439 port: Readable::read(reader)?,
443 Ok(Ok(NetAddress::OnionV3 {
444 ed25519_pubkey: Readable::read(reader)?,
445 checksum: Readable::read(reader)?,
446 version: Readable::read(reader)?,
447 port: Readable::read(reader)?,
450 _ => return Ok(Err(byte)),
455 // Only exposed as broadcast of node_announcement should be filtered by node_id
456 /// The unsigned part of a node_announcement
457 #[derive(PartialEq, Clone, Debug)]
458 pub struct UnsignedNodeAnnouncement {
459 pub(crate) features: GlobalFeatures,
460 pub(crate) timestamp: u32,
461 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
463 pub node_id: PublicKey,
464 pub(crate) rgb: [u8; 3],
465 pub(crate) alias: [u8; 32],
466 /// List of addresses on which this node is reachable. Note that you may only have up to one
467 /// address of each type, if you have more, they may be silently discarded or we may panic!
468 pub(crate) addresses: Vec<NetAddress>,
469 pub(crate) excess_address_data: Vec<u8>,
470 pub(crate) excess_data: Vec<u8>,
472 #[derive(PartialEq, Clone)]
473 /// A node_announcement message to be sent or received from a peer
474 pub struct NodeAnnouncement {
475 pub(crate) signature: Signature,
476 pub(crate) contents: UnsignedNodeAnnouncement,
479 // Only exposed as broadcast of channel_announcement should be filtered by node_id
480 /// The unsigned part of a channel_announcement
481 #[derive(PartialEq, Clone, Debug)]
482 pub struct UnsignedChannelAnnouncement {
483 pub(crate) features: GlobalFeatures,
484 pub(crate) chain_hash: Sha256dHash,
485 pub(crate) short_channel_id: u64,
486 /// One of the two node_ids which are endpoints of this channel
487 pub node_id_1: PublicKey,
488 /// The other of the two node_ids which are endpoints of this channel
489 pub node_id_2: PublicKey,
490 pub(crate) bitcoin_key_1: PublicKey,
491 pub(crate) bitcoin_key_2: PublicKey,
492 pub(crate) excess_data: Vec<u8>,
494 /// A channel_announcement message to be sent or received from a peer
495 #[derive(PartialEq, Clone, Debug)]
496 pub struct ChannelAnnouncement {
497 pub(crate) node_signature_1: Signature,
498 pub(crate) node_signature_2: Signature,
499 pub(crate) bitcoin_signature_1: Signature,
500 pub(crate) bitcoin_signature_2: Signature,
501 pub(crate) contents: UnsignedChannelAnnouncement,
504 #[derive(PartialEq, Clone, Debug)]
505 pub(crate) struct UnsignedChannelUpdate {
506 pub(crate) chain_hash: Sha256dHash,
507 pub(crate) short_channel_id: u64,
508 pub(crate) timestamp: u32,
509 pub(crate) flags: u16,
510 pub(crate) cltv_expiry_delta: u16,
511 pub(crate) htlc_minimum_msat: u64,
512 pub(crate) fee_base_msat: u32,
513 pub(crate) fee_proportional_millionths: u32,
514 pub(crate) excess_data: Vec<u8>,
516 /// A channel_update message to be sent or received from a peer
517 #[derive(PartialEq, Clone, Debug)]
518 pub struct ChannelUpdate {
519 pub(crate) signature: Signature,
520 pub(crate) contents: UnsignedChannelUpdate,
523 /// Used to put an error message in a HandleError
525 pub enum ErrorAction {
526 /// The peer took some action which made us think they were useless. Disconnect them.
528 /// An error message which we should make an effort to send before we disconnect.
529 msg: Option<ErrorMessage>
531 /// The peer did something harmless that we weren't able to process, just log and ignore
533 /// The peer did something incorrect. Tell them.
535 /// The message to send.
540 /// An Err type for failure to process messages.
541 pub struct HandleError { //TODO: rename me
542 /// A human-readable message describing the error
543 pub err: &'static str,
544 /// The action which should be taken against the offending peer.
545 pub action: Option<ErrorAction>, //TODO: Make this required
548 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
549 /// transaction updates if they were pending.
550 #[derive(PartialEq, Clone)]
551 pub struct CommitmentUpdate {
552 /// update_add_htlc messages which should be sent
553 pub update_add_htlcs: Vec<UpdateAddHTLC>,
554 /// update_fulfill_htlc messages which should be sent
555 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
556 /// update_fail_htlc messages which should be sent
557 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
558 /// update_fail_malformed_htlc messages which should be sent
559 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
560 /// An update_fee message which should be sent
561 pub update_fee: Option<UpdateFee>,
562 /// Finally, the commitment_signed message which should be sent
563 pub commitment_signed: CommitmentSigned,
566 /// The information we received from a peer along the route of a payment we originated. This is
567 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
568 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
570 pub enum HTLCFailChannelUpdate {
571 /// We received an error which included a full ChannelUpdate message.
572 ChannelUpdateMessage {
573 /// The unwrapped message we received
576 /// We received an error which indicated only that a channel has been closed
578 /// The short_channel_id which has now closed.
579 short_channel_id: u64,
580 /// when this true, this channel should be permanently removed from the
581 /// consideration. Otherwise, this channel can be restored as new channel_update is received
584 /// We received an error which indicated only that a node has failed
586 /// The node_id that has failed.
588 /// when this true, node should be permanently removed from the
589 /// consideration. Otherwise, the channels connected to this node can be
590 /// restored as new channel_update is received
595 /// Messages could have optional fields to use with extended features
596 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
597 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
598 /// separate enum type for them.
599 #[derive(Clone, PartialEq)]
600 pub enum OptionalField<T> {
601 /// Optional field is included in message
603 /// Optional field is absent in message
607 /// A trait to describe an object which can receive channel messages.
609 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
610 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
611 pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
613 /// Handle an incoming open_channel message from the given peer.
614 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<(), HandleError>;
615 /// Handle an incoming accept_channel message from the given peer.
616 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
617 /// Handle an incoming funding_created message from the given peer.
618 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<(), HandleError>;
619 /// Handle an incoming funding_signed message from the given peer.
620 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned) -> Result<(), HandleError>;
621 /// Handle an incoming funding_locked message from the given peer.
622 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<(), HandleError>;
625 /// Handle an incoming shutdown message from the given peer.
626 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(), HandleError>;
627 /// Handle an incoming closing_signed message from the given peer.
628 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<(), HandleError>;
631 /// Handle an incoming update_add_htlc message from the given peer.
632 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
633 /// Handle an incoming update_fulfill_htlc message from the given peer.
634 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
635 /// Handle an incoming update_fail_htlc message from the given peer.
636 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<(), HandleError>;
637 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
638 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
639 /// Handle an incoming commitment_signed message from the given peer.
640 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(), HandleError>;
641 /// Handle an incoming revoke_and_ack message from the given peer.
642 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<(), HandleError>;
644 /// Handle an incoming update_fee message from the given peer.
645 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
647 // Channel-to-announce:
648 /// Handle an incoming announcement_signatures message from the given peer.
649 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>;
651 // Connection loss/reestablish:
652 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
653 /// is believed to be possible in the future (eg they're sending us messages we don't
654 /// understand or indicate they require unknown feature bits), no_connection_possible is set
655 /// and any outstanding channels should be failed.
656 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
658 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
659 fn peer_connected(&self, their_node_id: &PublicKey);
660 /// Handle an incoming channel_reestablish message from the given peer.
661 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish) -> Result<(), HandleError>;
664 /// Handle an incoming error message from the given peer.
665 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
668 /// A trait to describe an object which can receive routing messages.
669 pub trait RoutingMessageHandler : Send + Sync {
670 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
671 /// false or returning an Err otherwise.
672 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, HandleError>;
673 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
674 /// or returning an Err otherwise.
675 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
676 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
677 /// false or returning an Err otherwise.
678 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, HandleError>;
679 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
680 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
681 /// Gets a subset of the channel announcements and updates required to dump our routing table
682 /// to a remote node, starting at the short_channel_id indicated by starting_point and
683 /// including batch_amount entries.
684 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
685 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
686 /// starting at the node *after* the provided publickey and including batch_amount entries.
687 /// If None is provided for starting_point, we start at the first node.
688 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
691 pub(crate) struct OnionRealm0HopData {
692 pub(crate) short_channel_id: u64,
693 pub(crate) amt_to_forward: u64,
694 pub(crate) outgoing_cltv_value: u32,
695 // 12 bytes of 0-padding
698 mod fuzzy_internal_msgs {
699 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
700 // them from untrusted input):
702 use super::OnionRealm0HopData;
703 pub struct OnionHopData {
704 pub(crate) realm: u8,
705 pub(crate) data: OnionRealm0HopData,
706 pub(crate) hmac: [u8; 32],
708 unsafe impl ::util::internal_traits::NoDealloc for OnionHopData{}
710 pub struct DecodedOnionErrorPacket {
711 pub(crate) hmac: [u8; 32],
712 pub(crate) failuremsg: Vec<u8>,
713 pub(crate) pad: Vec<u8>,
716 #[cfg(feature = "fuzztarget")]
717 pub use self::fuzzy_internal_msgs::*;
718 #[cfg(not(feature = "fuzztarget"))]
719 pub(crate) use self::fuzzy_internal_msgs::*;
722 pub(crate) struct OnionPacket {
723 pub(crate) version: u8,
724 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
725 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
726 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
727 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
728 pub(crate) hop_data: [u8; 20*65],
729 pub(crate) hmac: [u8; 32],
732 impl PartialEq for OnionPacket {
733 fn eq(&self, other: &OnionPacket) -> bool {
734 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
735 if i != j { return false; }
737 self.version == other.version &&
738 self.public_key == other.public_key &&
739 self.hmac == other.hmac
743 #[derive(Clone, PartialEq)]
744 pub(crate) struct OnionErrorPacket {
745 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
746 // (TODO) We limit it in decode to much lower...
747 pub(crate) data: Vec<u8>,
750 impl Error for DecodeError {
751 fn description(&self) -> &str {
753 DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
754 DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
755 DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
756 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
757 DecodeError::ExtraAddressesPerType => "More than one address of a single type",
758 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
759 DecodeError::Io(ref e) => e.description(),
763 impl fmt::Display for DecodeError {
764 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
765 f.write_str(self.description())
769 impl fmt::Debug for HandleError {
770 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
771 f.write_str(self.err)
775 impl From<::std::io::Error> for DecodeError {
776 fn from(e: ::std::io::Error) -> Self {
777 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
778 DecodeError::ShortRead
785 impl Writeable for OptionalField<Script> {
786 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
788 OptionalField::Present(ref script) => {
789 // Note that Writeable for script includes the 16-bit length tag for us
792 OptionalField::Absent => {}
798 impl<R: Read> Readable<R> for OptionalField<Script> {
799 fn read(r: &mut R) -> Result<Self, DecodeError> {
800 match <u16 as Readable<R>>::read(r) {
802 let mut buf = vec![0; len as usize];
803 r.read_exact(&mut buf)?;
804 Ok(OptionalField::Present(Script::from(buf)))
806 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
812 impl_writeable_len_match!(AcceptChannel, {
813 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
816 temporary_channel_id,
818 max_htlc_value_in_flight_msat,
819 channel_reserve_satoshis,
825 revocation_basepoint,
827 delayed_payment_basepoint,
829 first_per_commitment_point,
830 shutdown_scriptpubkey
833 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
840 impl Writeable for ChannelReestablish {
841 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
842 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
843 self.channel_id.write(w)?;
844 self.next_local_commitment_number.write(w)?;
845 self.next_remote_commitment_number.write(w)?;
846 match self.data_loss_protect {
847 OptionalField::Present(ref data_loss_protect) => {
848 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
849 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
851 OptionalField::Absent => {}
857 impl<R: Read> Readable<R> for ChannelReestablish{
858 fn read(r: &mut R) -> Result<Self, DecodeError> {
860 channel_id: Readable::read(r)?,
861 next_local_commitment_number: Readable::read(r)?,
862 next_remote_commitment_number: Readable::read(r)?,
864 match <[u8; 32] as Readable<R>>::read(r) {
865 Ok(your_last_per_commitment_secret) =>
866 OptionalField::Present(DataLossProtect {
867 your_last_per_commitment_secret,
868 my_current_per_commitment_point: Readable::read(r)?,
870 Err(DecodeError::ShortRead) => OptionalField::Absent,
871 Err(e) => return Err(e)
878 impl_writeable!(ClosingSigned, 32+8+64, {
884 impl_writeable_len_match!(CommitmentSigned, {
885 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
892 impl_writeable_len_match!(DecodedOnionErrorPacket, {
893 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
900 impl_writeable!(FundingCreated, 32+32+2+64, {
901 temporary_channel_id,
903 funding_output_index,
907 impl_writeable!(FundingSigned, 32+64, {
912 impl_writeable!(FundingLocked, 32+33, {
914 next_per_commitment_point
917 impl_writeable_len_match!(GlobalFeatures, {
918 { GlobalFeatures { ref flags }, flags.len() + 2 }
923 impl_writeable_len_match!(LocalFeatures, {
924 { LocalFeatures { ref flags }, flags.len() + 2 }
929 impl_writeable_len_match!(Init, {
930 { Init { ref global_features, ref local_features }, global_features.flags.len() + local_features.flags.len() + 4 }
936 impl_writeable_len_match!(OpenChannel, {
937 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
941 temporary_channel_id,
945 max_htlc_value_in_flight_msat,
946 channel_reserve_satoshis,
952 revocation_basepoint,
954 delayed_payment_basepoint,
956 first_per_commitment_point,
958 shutdown_scriptpubkey
961 impl_writeable!(RevokeAndACK, 32+32+33, {
963 per_commitment_secret,
964 next_per_commitment_point
967 impl_writeable_len_match!(Shutdown, {
968 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
974 impl_writeable_len_match!(UpdateFailHTLC, {
975 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
982 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
989 impl_writeable!(UpdateFee, 32+4, {
994 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1000 impl_writeable_len_match!(OnionErrorPacket, {
1001 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1006 impl Writeable for OnionPacket {
1007 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1008 w.size_hint(1 + 33 + 20*65 + 32);
1009 self.version.write(w)?;
1010 match self.public_key {
1011 Ok(pubkey) => pubkey.write(w)?,
1012 Err(_) => [0u8;33].write(w)?,
1014 w.write_all(&self.hop_data)?;
1015 self.hmac.write(w)?;
1020 impl<R: Read> Readable<R> for OnionPacket {
1021 fn read(r: &mut R) -> Result<Self, DecodeError> {
1023 version: Readable::read(r)?,
1025 let mut buf = [0u8;33];
1026 r.read_exact(&mut buf)?;
1027 PublicKey::from_slice(&buf)
1029 hop_data: Readable::read(r)?,
1030 hmac: Readable::read(r)?,
1035 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1041 onion_routing_packet
1044 impl Writeable for OnionRealm0HopData {
1045 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1047 self.short_channel_id.write(w)?;
1048 self.amt_to_forward.write(w)?;
1049 self.outgoing_cltv_value.write(w)?;
1050 w.write_all(&[0;12])?;
1055 impl<R: Read> Readable<R> for OnionRealm0HopData {
1056 fn read(r: &mut R) -> Result<Self, DecodeError> {
1057 Ok(OnionRealm0HopData {
1058 short_channel_id: Readable::read(r)?,
1059 amt_to_forward: Readable::read(r)?,
1060 outgoing_cltv_value: {
1061 let v: u32 = Readable::read(r)?;
1062 r.read_exact(&mut [0; 12])?;
1069 impl Writeable for OnionHopData {
1070 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1072 self.realm.write(w)?;
1073 self.data.write(w)?;
1074 self.hmac.write(w)?;
1079 impl<R: Read> Readable<R> for OnionHopData {
1080 fn read(r: &mut R) -> Result<Self, DecodeError> {
1083 let r: u8 = Readable::read(r)?;
1085 return Err(DecodeError::UnknownVersion);
1089 data: Readable::read(r)?,
1090 hmac: Readable::read(r)?,
1095 impl Writeable for Ping {
1096 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1097 w.size_hint(self.byteslen as usize + 4);
1098 self.ponglen.write(w)?;
1099 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1104 impl<R: Read> Readable<R> for Ping {
1105 fn read(r: &mut R) -> Result<Self, DecodeError> {
1107 ponglen: Readable::read(r)?,
1109 let byteslen = Readable::read(r)?;
1110 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1117 impl Writeable for Pong {
1118 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1119 w.size_hint(self.byteslen as usize + 2);
1120 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1125 impl<R: Read> Readable<R> for Pong {
1126 fn read(r: &mut R) -> Result<Self, DecodeError> {
1129 let byteslen = Readable::read(r)?;
1130 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1137 impl Writeable for UnsignedChannelAnnouncement {
1138 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1139 w.size_hint(2 + 2*32 + 4*33 + self.features.flags.len() + self.excess_data.len());
1140 self.features.write(w)?;
1141 self.chain_hash.write(w)?;
1142 self.short_channel_id.write(w)?;
1143 self.node_id_1.write(w)?;
1144 self.node_id_2.write(w)?;
1145 self.bitcoin_key_1.write(w)?;
1146 self.bitcoin_key_2.write(w)?;
1147 w.write_all(&self.excess_data[..])?;
1152 impl<R: Read> Readable<R> for UnsignedChannelAnnouncement {
1153 fn read(r: &mut R) -> Result<Self, DecodeError> {
1156 let f: GlobalFeatures = Readable::read(r)?;
1157 if f.requires_unknown_bits() {
1158 return Err(DecodeError::UnknownRequiredFeature);
1162 chain_hash: Readable::read(r)?,
1163 short_channel_id: Readable::read(r)?,
1164 node_id_1: Readable::read(r)?,
1165 node_id_2: Readable::read(r)?,
1166 bitcoin_key_1: Readable::read(r)?,
1167 bitcoin_key_2: Readable::read(r)?,
1169 let mut excess_data = vec![];
1170 r.read_to_end(&mut excess_data)?;
1177 impl_writeable_len_match!(ChannelAnnouncement, {
1178 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1179 2 + 2*32 + 4*33 + features.flags.len() + excess_data.len() + 4*64 }
1183 bitcoin_signature_1,
1184 bitcoin_signature_2,
1188 impl Writeable for UnsignedChannelUpdate {
1189 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1190 w.size_hint(64 + self.excess_data.len());
1191 self.chain_hash.write(w)?;
1192 self.short_channel_id.write(w)?;
1193 self.timestamp.write(w)?;
1194 self.flags.write(w)?;
1195 self.cltv_expiry_delta.write(w)?;
1196 self.htlc_minimum_msat.write(w)?;
1197 self.fee_base_msat.write(w)?;
1198 self.fee_proportional_millionths.write(w)?;
1199 w.write_all(&self.excess_data[..])?;
1204 impl<R: Read> Readable<R> for UnsignedChannelUpdate {
1205 fn read(r: &mut R) -> Result<Self, DecodeError> {
1207 chain_hash: Readable::read(r)?,
1208 short_channel_id: Readable::read(r)?,
1209 timestamp: Readable::read(r)?,
1210 flags: Readable::read(r)?,
1211 cltv_expiry_delta: Readable::read(r)?,
1212 htlc_minimum_msat: Readable::read(r)?,
1213 fee_base_msat: Readable::read(r)?,
1214 fee_proportional_millionths: Readable::read(r)?,
1216 let mut excess_data = vec![];
1217 r.read_to_end(&mut excess_data)?;
1224 impl_writeable_len_match!(ChannelUpdate, {
1225 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1226 64 + excess_data.len() + 64 }
1232 impl Writeable for ErrorMessage {
1233 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1234 w.size_hint(32 + 2 + self.data.len());
1235 self.channel_id.write(w)?;
1236 (self.data.len() as u16).write(w)?;
1237 w.write_all(self.data.as_bytes())?;
1242 impl<R: Read> Readable<R> for ErrorMessage {
1243 fn read(r: &mut R) -> Result<Self, DecodeError> {
1245 channel_id: Readable::read(r)?,
1247 let mut sz: usize = <u16 as Readable<R>>::read(r)? as usize;
1248 let mut data = vec![];
1249 let data_len = r.read_to_end(&mut data)?;
1250 sz = cmp::min(data_len, sz);
1251 match String::from_utf8(data[..sz as usize].to_vec()) {
1253 Err(_) => return Err(DecodeError::InvalidValue),
1260 impl Writeable for UnsignedNodeAnnouncement {
1261 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1262 w.size_hint(64 + 76 + self.features.flags.len() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1263 self.features.write(w)?;
1264 self.timestamp.write(w)?;
1265 self.node_id.write(w)?;
1266 w.write_all(&self.rgb)?;
1267 self.alias.write(w)?;
1269 let mut addrs_to_encode = self.addresses.clone();
1270 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1271 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1272 let mut addr_len = 0;
1273 for addr in &addrs_to_encode {
1274 addr_len += 1 + addr.len();
1276 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1277 for addr in addrs_to_encode {
1280 w.write_all(&self.excess_address_data[..])?;
1281 w.write_all(&self.excess_data[..])?;
1286 impl<R: Read> Readable<R> for UnsignedNodeAnnouncement {
1287 fn read(r: &mut R) -> Result<Self, DecodeError> {
1288 let features: GlobalFeatures = Readable::read(r)?;
1289 if features.requires_unknown_bits() {
1290 return Err(DecodeError::UnknownRequiredFeature);
1292 let timestamp: u32 = Readable::read(r)?;
1293 let node_id: PublicKey = Readable::read(r)?;
1294 let mut rgb = [0; 3];
1295 r.read_exact(&mut rgb)?;
1296 let alias: [u8; 32] = Readable::read(r)?;
1298 let addr_len: u16 = Readable::read(r)?;
1299 let mut addresses: Vec<NetAddress> = Vec::with_capacity(4);
1300 let mut addr_readpos = 0;
1301 let mut excess = false;
1302 let mut excess_byte = 0;
1304 if addr_len <= addr_readpos { break; }
1305 match Readable::read(r) {
1308 NetAddress::IPv4 { .. } => {
1309 if addresses.len() > 0 {
1310 return Err(DecodeError::ExtraAddressesPerType);
1313 NetAddress::IPv6 { .. } => {
1314 if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1315 return Err(DecodeError::ExtraAddressesPerType);
1318 NetAddress::OnionV2 { .. } => {
1319 if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1320 return Err(DecodeError::ExtraAddressesPerType);
1323 NetAddress::OnionV3 { .. } => {
1324 if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1325 return Err(DecodeError::ExtraAddressesPerType);
1329 if addr_len < addr_readpos + 1 + addr.len() {
1330 return Err(DecodeError::BadLengthDescriptor);
1332 addr_readpos += (1 + addr.len()) as u16;
1333 addresses.push(addr);
1335 Ok(Err(unknown_descriptor)) => {
1337 excess_byte = unknown_descriptor;
1340 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1341 Err(e) => return Err(e),
1345 let mut excess_data = vec![];
1346 let excess_address_data = if addr_readpos < addr_len {
1347 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1348 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1350 excess_address_data[0] = excess_byte;
1355 excess_data.push(excess_byte);
1359 r.read_to_end(&mut excess_data)?;
1360 Ok(UnsignedNodeAnnouncement {
1367 excess_address_data,
1373 impl_writeable_len_match!(NodeAnnouncement, {
1374 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1375 64 + 76 + features.flags.len() + addresses.len()*38 + excess_address_data.len() + excess_data.len() }
1385 use ln::msgs::{GlobalFeatures, LocalFeatures, OptionalField, OnionErrorPacket};
1386 use ln::channelmanager::{PaymentPreimage, PaymentHash};
1387 use util::ser::Writeable;
1389 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
1390 use bitcoin_hashes::hex::FromHex;
1391 use bitcoin::util::address::Address;
1392 use bitcoin::network::constants::Network;
1393 use bitcoin::blockdata::script::Builder;
1394 use bitcoin::blockdata::opcodes;
1396 use secp256k1::key::{PublicKey,SecretKey};
1397 use secp256k1::{Secp256k1, Message};
1400 fn encoding_channel_reestablish_no_secret() {
1401 let cr = msgs::ChannelReestablish {
1402 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],
1403 next_local_commitment_number: 3,
1404 next_remote_commitment_number: 4,
1405 data_loss_protect: OptionalField::Absent,
1408 let encoded_value = cr.encode();
1411 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]
1416 fn encoding_channel_reestablish_with_secret() {
1418 let secp_ctx = Secp256k1::new();
1419 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1422 let cr = msgs::ChannelReestablish {
1423 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],
1424 next_local_commitment_number: 3,
1425 next_remote_commitment_number: 4,
1426 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1429 let encoded_value = cr.encode();
1432 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]
1436 macro_rules! get_keys_from {
1437 ($slice: expr, $secp_ctx: expr) => {
1439 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1440 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1446 macro_rules! get_sig_on {
1447 ($privkey: expr, $ctx: expr, $string: expr) => {
1449 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1450 $ctx.sign(&sighash, &$privkey)
1456 fn encoding_announcement_signatures() {
1457 let secp_ctx = Secp256k1::new();
1458 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1459 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1460 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1461 let announcement_signatures = msgs::AnnouncementSignatures {
1462 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],
1463 short_channel_id: 2316138423780173,
1464 node_signature: sig_1,
1465 bitcoin_signature: sig_2,
1468 let encoded_value = announcement_signatures.encode();
1469 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1472 fn do_encoding_channel_announcement(unknown_features_bits: bool, non_bitcoin_chain_hash: bool, excess_data: bool) {
1473 let secp_ctx = Secp256k1::new();
1474 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1475 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1476 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1477 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1478 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1479 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1480 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1481 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1482 let mut features = GlobalFeatures::new();
1483 if unknown_features_bits {
1484 features.flags = vec![0xFF, 0xFF];
1486 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1488 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1489 short_channel_id: 2316138423780173,
1490 node_id_1: pubkey_1,
1491 node_id_2: pubkey_2,
1492 bitcoin_key_1: pubkey_3,
1493 bitcoin_key_2: pubkey_4,
1494 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1496 let channel_announcement = msgs::ChannelAnnouncement {
1497 node_signature_1: sig_1,
1498 node_signature_2: sig_2,
1499 bitcoin_signature_1: sig_3,
1500 bitcoin_signature_2: sig_4,
1501 contents: unsigned_channel_announcement,
1503 let encoded_value = channel_announcement.encode();
1504 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1505 if unknown_features_bits {
1506 target_value.append(&mut hex::decode("0002ffff").unwrap());
1508 target_value.append(&mut hex::decode("0000").unwrap());
1510 if non_bitcoin_chain_hash {
1511 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1513 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1515 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1517 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1519 assert_eq!(encoded_value, target_value);
1523 fn encoding_channel_announcement() {
1524 do_encoding_channel_announcement(false, false, false);
1525 do_encoding_channel_announcement(true, false, false);
1526 do_encoding_channel_announcement(true, true, false);
1527 do_encoding_channel_announcement(true, true, true);
1528 do_encoding_channel_announcement(false, true, true);
1529 do_encoding_channel_announcement(false, false, true);
1530 do_encoding_channel_announcement(false, true, false);
1531 do_encoding_channel_announcement(true, false, true);
1534 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1535 let secp_ctx = Secp256k1::new();
1536 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1537 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1538 let mut features = GlobalFeatures::new();
1539 if unknown_features_bits {
1540 features.flags = vec![0xFF, 0xFF];
1542 let mut addresses = Vec::new();
1544 addresses.push(msgs::NetAddress::IPv4 {
1545 addr: [255, 254, 253, 252],
1550 addresses.push(msgs::NetAddress::IPv6 {
1551 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1556 addresses.push(msgs::NetAddress::OnionV2 {
1557 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1562 addresses.push(msgs::NetAddress::OnionV3 {
1563 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],
1569 let mut addr_len = 0;
1570 for addr in &addresses {
1571 addr_len += addr.len() + 1;
1573 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1575 timestamp: 20190119,
1580 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() },
1581 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() },
1583 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1584 let node_announcement = msgs::NodeAnnouncement {
1586 contents: unsigned_node_announcement,
1588 let encoded_value = node_announcement.encode();
1589 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1590 if unknown_features_bits {
1591 target_value.append(&mut hex::decode("0002ffff").unwrap());
1593 target_value.append(&mut hex::decode("0000").unwrap());
1595 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1596 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1598 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1601 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1604 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1607 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1609 if excess_address_data {
1610 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1613 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1615 assert_eq!(encoded_value, target_value);
1619 fn encoding_node_announcement() {
1620 do_encoding_node_announcement(true, true, true, true, true, true, true);
1621 do_encoding_node_announcement(false, false, false, false, false, false, false);
1622 do_encoding_node_announcement(false, true, false, false, false, false, false);
1623 do_encoding_node_announcement(false, false, true, false, false, false, false);
1624 do_encoding_node_announcement(false, false, false, true, false, false, false);
1625 do_encoding_node_announcement(false, false, false, false, true, false, false);
1626 do_encoding_node_announcement(false, false, false, false, false, true, false);
1627 do_encoding_node_announcement(false, true, false, true, false, true, false);
1628 do_encoding_node_announcement(false, false, true, false, true, false, false);
1631 fn do_encoding_channel_update(non_bitcoin_chain_hash: bool, direction: bool, disable: bool, htlc_maximum_msat: bool) {
1632 let secp_ctx = Secp256k1::new();
1633 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1634 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1635 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
1636 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1637 short_channel_id: 2316138423780173,
1638 timestamp: 20190119,
1639 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 } | if htlc_maximum_msat { 1 << 8 } else { 0 },
1640 cltv_expiry_delta: 144,
1641 htlc_minimum_msat: 1000000,
1642 fee_base_msat: 10000,
1643 fee_proportional_millionths: 20,
1644 excess_data: if htlc_maximum_msat { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
1646 let channel_update = msgs::ChannelUpdate {
1648 contents: unsigned_channel_update
1650 let encoded_value = channel_update.encode();
1651 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1652 if non_bitcoin_chain_hash {
1653 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1655 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1657 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
1658 if htlc_maximum_msat {
1659 target_value.append(&mut hex::decode("01").unwrap());
1661 target_value.append(&mut hex::decode("00").unwrap());
1663 target_value.append(&mut hex::decode("00").unwrap());
1665 let flag = target_value.last_mut().unwrap();
1669 let flag = target_value.last_mut().unwrap();
1670 *flag = *flag | 1 << 1;
1672 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
1673 if htlc_maximum_msat {
1674 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
1676 assert_eq!(encoded_value, target_value);
1680 fn encoding_channel_update() {
1681 do_encoding_channel_update(false, false, false, false);
1682 do_encoding_channel_update(true, false, false, false);
1683 do_encoding_channel_update(false, true, false, false);
1684 do_encoding_channel_update(false, false, true, false);
1685 do_encoding_channel_update(false, false, false, true);
1686 do_encoding_channel_update(true, true, true, true);
1689 fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
1690 let secp_ctx = Secp256k1::new();
1691 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1692 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1693 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1694 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1695 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1696 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1697 let open_channel = msgs::OpenChannel {
1698 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1699 temporary_channel_id: [2; 32],
1700 funding_satoshis: 1311768467284833366,
1701 push_msat: 2536655962884945560,
1702 dust_limit_satoshis: 3608586615801332854,
1703 max_htlc_value_in_flight_msat: 8517154655701053848,
1704 channel_reserve_satoshis: 8665828695742877976,
1705 htlc_minimum_msat: 2316138423780173,
1706 feerate_per_kw: 821716,
1707 to_self_delay: 49340,
1708 max_accepted_htlcs: 49340,
1709 funding_pubkey: pubkey_1,
1710 revocation_basepoint: pubkey_2,
1711 payment_basepoint: pubkey_3,
1712 delayed_payment_basepoint: pubkey_4,
1713 htlc_basepoint: pubkey_5,
1714 first_per_commitment_point: pubkey_6,
1715 channel_flags: if random_bit { 1 << 5 } else { 0 },
1716 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1718 let encoded_value = open_channel.encode();
1719 let mut target_value = Vec::new();
1720 if non_bitcoin_chain_hash {
1721 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1723 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1725 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1727 target_value.append(&mut hex::decode("20").unwrap());
1729 target_value.append(&mut hex::decode("00").unwrap());
1732 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1734 assert_eq!(encoded_value, target_value);
1738 fn encoding_open_channel() {
1739 do_encoding_open_channel(false, false, false);
1740 do_encoding_open_channel(true, false, false);
1741 do_encoding_open_channel(false, true, false);
1742 do_encoding_open_channel(false, false, true);
1743 do_encoding_open_channel(true, true, true);
1746 fn do_encoding_accept_channel(shutdown: bool) {
1747 let secp_ctx = Secp256k1::new();
1748 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1749 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1750 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1751 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1752 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1753 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1754 let accept_channel = msgs::AcceptChannel {
1755 temporary_channel_id: [2; 32],
1756 dust_limit_satoshis: 1311768467284833366,
1757 max_htlc_value_in_flight_msat: 2536655962884945560,
1758 channel_reserve_satoshis: 3608586615801332854,
1759 htlc_minimum_msat: 2316138423780173,
1760 minimum_depth: 821716,
1761 to_self_delay: 49340,
1762 max_accepted_htlcs: 49340,
1763 funding_pubkey: pubkey_1,
1764 revocation_basepoint: pubkey_2,
1765 payment_basepoint: pubkey_3,
1766 delayed_payment_basepoint: pubkey_4,
1767 htlc_basepoint: pubkey_5,
1768 first_per_commitment_point: pubkey_6,
1769 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1771 let encoded_value = accept_channel.encode();
1772 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1774 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1776 assert_eq!(encoded_value, target_value);
1780 fn encoding_accept_channel() {
1781 do_encoding_accept_channel(false);
1782 do_encoding_accept_channel(true);
1786 fn encoding_funding_created() {
1787 let secp_ctx = Secp256k1::new();
1788 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1789 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1790 let funding_created = msgs::FundingCreated {
1791 temporary_channel_id: [2; 32],
1792 funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1793 funding_output_index: 255,
1796 let encoded_value = funding_created.encode();
1797 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1798 assert_eq!(encoded_value, target_value);
1802 fn encoding_funding_signed() {
1803 let secp_ctx = Secp256k1::new();
1804 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1805 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1806 let funding_signed = msgs::FundingSigned {
1807 channel_id: [2; 32],
1810 let encoded_value = funding_signed.encode();
1811 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1812 assert_eq!(encoded_value, target_value);
1816 fn encoding_funding_locked() {
1817 let secp_ctx = Secp256k1::new();
1818 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1819 let funding_locked = msgs::FundingLocked {
1820 channel_id: [2; 32],
1821 next_per_commitment_point: pubkey_1,
1823 let encoded_value = funding_locked.encode();
1824 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1825 assert_eq!(encoded_value, target_value);
1828 fn do_encoding_shutdown(script_type: u8) {
1829 let secp_ctx = Secp256k1::new();
1830 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1831 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1832 let shutdown = msgs::Shutdown {
1833 channel_id: [2; 32],
1834 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() },
1836 let encoded_value = shutdown.encode();
1837 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1838 if script_type == 1 {
1839 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1840 } else if script_type == 2 {
1841 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1842 } else if script_type == 3 {
1843 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1844 } else if script_type == 4 {
1845 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1847 assert_eq!(encoded_value, target_value);
1851 fn encoding_shutdown() {
1852 do_encoding_shutdown(1);
1853 do_encoding_shutdown(2);
1854 do_encoding_shutdown(3);
1855 do_encoding_shutdown(4);
1859 fn encoding_closing_signed() {
1860 let secp_ctx = Secp256k1::new();
1861 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1862 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1863 let closing_signed = msgs::ClosingSigned {
1864 channel_id: [2; 32],
1865 fee_satoshis: 2316138423780173,
1868 let encoded_value = closing_signed.encode();
1869 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1870 assert_eq!(encoded_value, target_value);
1874 fn encoding_update_add_htlc() {
1875 let secp_ctx = Secp256k1::new();
1876 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1877 let onion_routing_packet = msgs::OnionPacket {
1879 public_key: Ok(pubkey_1),
1880 hop_data: [1; 20*65],
1883 let update_add_htlc = msgs::UpdateAddHTLC {
1884 channel_id: [2; 32],
1885 htlc_id: 2316138423780173,
1886 amount_msat: 3608586615801332854,
1887 payment_hash: PaymentHash([1; 32]),
1888 cltv_expiry: 821716,
1889 onion_routing_packet
1891 let encoded_value = update_add_htlc.encode();
1892 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
1893 assert_eq!(encoded_value, target_value);
1897 fn encoding_update_fulfill_htlc() {
1898 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
1899 channel_id: [2; 32],
1900 htlc_id: 2316138423780173,
1901 payment_preimage: PaymentPreimage([1; 32]),
1903 let encoded_value = update_fulfill_htlc.encode();
1904 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
1905 assert_eq!(encoded_value, target_value);
1909 fn encoding_update_fail_htlc() {
1910 let reason = OnionErrorPacket {
1911 data: [1; 32].to_vec(),
1913 let update_fail_htlc = msgs::UpdateFailHTLC {
1914 channel_id: [2; 32],
1915 htlc_id: 2316138423780173,
1918 let encoded_value = update_fail_htlc.encode();
1919 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
1920 assert_eq!(encoded_value, target_value);
1924 fn encoding_update_fail_malformed_htlc() {
1925 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
1926 channel_id: [2; 32],
1927 htlc_id: 2316138423780173,
1928 sha256_of_onion: [1; 32],
1931 let encoded_value = update_fail_malformed_htlc.encode();
1932 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
1933 assert_eq!(encoded_value, target_value);
1936 fn do_encoding_commitment_signed(htlcs: bool) {
1937 let secp_ctx = Secp256k1::new();
1938 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1939 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1940 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1941 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1942 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1943 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1944 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1945 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1946 let commitment_signed = msgs::CommitmentSigned {
1947 channel_id: [2; 32],
1949 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
1951 let encoded_value = commitment_signed.encode();
1952 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1954 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1956 target_value.append(&mut hex::decode("0000").unwrap());
1958 assert_eq!(encoded_value, target_value);
1962 fn encoding_commitment_signed() {
1963 do_encoding_commitment_signed(true);
1964 do_encoding_commitment_signed(false);
1968 fn encoding_revoke_and_ack() {
1969 let secp_ctx = Secp256k1::new();
1970 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1971 let raa = msgs::RevokeAndACK {
1972 channel_id: [2; 32],
1973 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],
1974 next_per_commitment_point: pubkey_1,
1976 let encoded_value = raa.encode();
1977 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1978 assert_eq!(encoded_value, target_value);
1982 fn encoding_update_fee() {
1983 let update_fee = msgs::UpdateFee {
1984 channel_id: [2; 32],
1985 feerate_per_kw: 20190119,
1987 let encoded_value = update_fee.encode();
1988 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
1989 assert_eq!(encoded_value, target_value);
1992 fn do_encoding_init(unknown_global_bits: bool, initial_routing_sync: bool) {
1993 let mut global = GlobalFeatures::new();
1994 if unknown_global_bits {
1995 global.flags = vec![0xFF, 0xFF];
1997 let mut local = LocalFeatures::new();
1998 if initial_routing_sync {
1999 local.set_initial_routing_sync();
2001 let init = msgs::Init {
2002 global_features: global,
2003 local_features: local,
2005 let encoded_value = init.encode();
2006 let mut target_value = Vec::new();
2007 if unknown_global_bits {
2008 target_value.append(&mut hex::decode("0002ffff").unwrap());
2010 target_value.append(&mut hex::decode("0000").unwrap());
2012 if initial_routing_sync {
2013 target_value.append(&mut hex::decode("000108").unwrap());
2015 target_value.append(&mut hex::decode("0000").unwrap());
2017 assert_eq!(encoded_value, target_value);
2021 fn encoding_init() {
2022 do_encoding_init(false, false);
2023 do_encoding_init(true, false);
2024 do_encoding_init(false, true);
2025 do_encoding_init(true, true);
2029 fn encoding_error() {
2030 let error = msgs::ErrorMessage {
2031 channel_id: [2; 32],
2032 data: String::from("rust-lightning"),
2034 let encoded_value = error.encode();
2035 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2036 assert_eq!(encoded_value, target_value);
2040 fn encoding_ping() {
2041 let ping = msgs::Ping {
2045 let encoded_value = ping.encode();
2046 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2047 assert_eq!(encoded_value, target_value);
2051 fn encoding_pong() {
2052 let pong = msgs::Pong {
2055 let encoded_value = pong.encode();
2056 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2057 assert_eq!(encoded_value, target_value);