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, FixedLengthReader, HighZeroBytesDroppedVarInt};
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 (eg TLV with an even, unknown type)
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, TLV was
46 /// syntactically incorrect, etc
50 /// A length descriptor in the packet didn't describe the later data correctly
52 /// Error from std::io
56 /// An init message to be sent or received from a peer
58 #[cfg(not(feature = "fuzztarget"))]
59 pub(crate) features: InitFeatures,
60 #[cfg(feature = "fuzztarget")]
61 pub features: InitFeatures,
64 /// An error message to be sent or received from a peer
66 pub struct ErrorMessage {
67 pub(crate) channel_id: [u8; 32],
68 pub(crate) data: String,
71 /// A ping message to be sent or received from a peer
73 pub(crate) ponglen: u16,
74 pub(crate) byteslen: u16,
77 /// A pong message to be sent or received from a peer
79 pub(crate) byteslen: u16,
82 /// An open_channel message to be sent or received from a peer
84 pub struct OpenChannel {
85 pub(crate) chain_hash: Sha256dHash,
86 pub(crate) temporary_channel_id: [u8; 32],
87 pub(crate) funding_satoshis: u64,
88 pub(crate) push_msat: u64,
89 pub(crate) dust_limit_satoshis: u64,
90 pub(crate) max_htlc_value_in_flight_msat: u64,
91 pub(crate) channel_reserve_satoshis: u64,
92 pub(crate) htlc_minimum_msat: u64,
93 pub(crate) feerate_per_kw: u32,
94 pub(crate) to_self_delay: u16,
95 pub(crate) max_accepted_htlcs: u16,
96 pub(crate) funding_pubkey: PublicKey,
97 pub(crate) revocation_basepoint: PublicKey,
98 pub(crate) payment_basepoint: PublicKey,
99 pub(crate) delayed_payment_basepoint: PublicKey,
100 pub(crate) htlc_basepoint: PublicKey,
101 pub(crate) first_per_commitment_point: PublicKey,
102 pub(crate) channel_flags: u8,
103 pub(crate) shutdown_scriptpubkey: OptionalField<Script>,
106 /// An accept_channel message to be sent or received from a peer
108 pub struct AcceptChannel {
109 pub(crate) temporary_channel_id: [u8; 32],
110 pub(crate) dust_limit_satoshis: u64,
111 pub(crate) max_htlc_value_in_flight_msat: u64,
112 pub(crate) channel_reserve_satoshis: u64,
113 pub(crate) htlc_minimum_msat: u64,
114 pub(crate) minimum_depth: u32,
115 pub(crate) to_self_delay: u16,
116 pub(crate) max_accepted_htlcs: u16,
117 pub(crate) funding_pubkey: PublicKey,
118 pub(crate) revocation_basepoint: PublicKey,
119 pub(crate) payment_basepoint: PublicKey,
120 pub(crate) delayed_payment_basepoint: PublicKey,
121 pub(crate) htlc_basepoint: PublicKey,
122 pub(crate) first_per_commitment_point: PublicKey,
123 pub(crate) shutdown_scriptpubkey: OptionalField<Script>
126 /// A funding_created message to be sent or received from a peer
128 pub struct FundingCreated {
129 pub(crate) temporary_channel_id: [u8; 32],
130 pub(crate) funding_txid: Sha256dHash,
131 pub(crate) funding_output_index: u16,
132 pub(crate) signature: Signature,
135 /// A funding_signed message to be sent or received from a peer
137 pub struct FundingSigned {
138 pub(crate) channel_id: [u8; 32],
139 pub(crate) signature: Signature,
142 /// A funding_locked message to be sent or received from a peer
143 #[derive(Clone, PartialEq)]
144 #[allow(missing_docs)]
145 pub struct FundingLocked {
146 pub channel_id: [u8; 32],
147 pub next_per_commitment_point: PublicKey,
150 /// A shutdown message to be sent or received from a peer
151 #[derive(Clone, PartialEq)]
152 pub struct Shutdown {
153 pub(crate) channel_id: [u8; 32],
154 pub(crate) scriptpubkey: Script,
157 /// A closing_signed message to be sent or received from a peer
158 #[derive(Clone, PartialEq)]
159 pub struct ClosingSigned {
160 pub(crate) channel_id: [u8; 32],
161 pub(crate) fee_satoshis: u64,
162 pub(crate) signature: Signature,
165 /// An update_add_htlc message to be sent or received from a peer
166 #[derive(Clone, PartialEq)]
167 pub struct UpdateAddHTLC {
168 pub(crate) channel_id: [u8; 32],
169 pub(crate) htlc_id: u64,
170 pub(crate) amount_msat: u64,
171 pub(crate) payment_hash: PaymentHash,
172 pub(crate) cltv_expiry: u32,
173 pub(crate) onion_routing_packet: OnionPacket,
176 /// An update_fulfill_htlc message to be sent or received from a peer
177 #[derive(Clone, PartialEq)]
178 pub struct UpdateFulfillHTLC {
179 pub(crate) channel_id: [u8; 32],
180 pub(crate) htlc_id: u64,
181 pub(crate) payment_preimage: PaymentPreimage,
184 /// An update_fail_htlc message to be sent or received from a peer
185 #[derive(Clone, PartialEq)]
186 pub struct UpdateFailHTLC {
187 pub(crate) channel_id: [u8; 32],
188 pub(crate) htlc_id: u64,
189 pub(crate) reason: OnionErrorPacket,
192 /// An update_fail_malformed_htlc message to be sent or received from a peer
193 #[derive(Clone, PartialEq)]
194 pub struct UpdateFailMalformedHTLC {
195 pub(crate) channel_id: [u8; 32],
196 pub(crate) htlc_id: u64,
197 pub(crate) sha256_of_onion: [u8; 32],
198 pub(crate) failure_code: u16,
201 /// A commitment_signed message to be sent or received from a peer
202 #[derive(Clone, PartialEq)]
203 pub struct CommitmentSigned {
204 pub(crate) channel_id: [u8; 32],
205 pub(crate) signature: Signature,
206 pub(crate) htlc_signatures: Vec<Signature>,
209 /// A revoke_and_ack message to be sent or received from a peer
210 #[derive(Clone, PartialEq)]
211 pub struct RevokeAndACK {
212 pub(crate) channel_id: [u8; 32],
213 pub(crate) per_commitment_secret: [u8; 32],
214 pub(crate) next_per_commitment_point: PublicKey,
217 /// An update_fee message to be sent or received from a peer
218 #[derive(PartialEq, Clone)]
219 pub struct UpdateFee {
220 pub(crate) channel_id: [u8; 32],
221 pub(crate) feerate_per_kw: u32,
224 #[derive(PartialEq, Clone)]
225 pub(crate) struct DataLossProtect {
226 pub(crate) your_last_per_commitment_secret: [u8; 32],
227 pub(crate) my_current_per_commitment_point: PublicKey,
230 /// A channel_reestablish message to be sent or received from a peer
231 #[derive(PartialEq, Clone)]
232 pub struct ChannelReestablish {
233 pub(crate) channel_id: [u8; 32],
234 pub(crate) next_local_commitment_number: u64,
235 pub(crate) next_remote_commitment_number: u64,
236 pub(crate) data_loss_protect: OptionalField<DataLossProtect>,
239 /// An announcement_signatures message to be sent or received from a peer
240 #[derive(PartialEq, Clone, Debug)]
241 pub struct AnnouncementSignatures {
242 pub(crate) channel_id: [u8; 32],
243 pub(crate) short_channel_id: u64,
244 pub(crate) node_signature: Signature,
245 pub(crate) bitcoin_signature: Signature,
248 /// An address which can be used to connect to a remote peer
249 #[derive(Clone, PartialEq, Debug)]
250 pub enum NetAddress {
251 /// An IPv4 address/port on which the peer is listening.
253 /// The 4-byte IPv4 address
255 /// The port on which the node is listening
258 /// An IPv6 address/port on which the peer is listening.
260 /// The 16-byte IPv6 address
262 /// The port on which the node is listening
265 /// An old-style Tor onion address/port on which the peer is listening.
267 /// The bytes (usually encoded in base32 with ".onion" appended)
269 /// The port on which the node is listening
272 /// A new-style Tor onion address/port on which the peer is listening.
273 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
274 /// wrap as base32 and append ".onion".
276 /// The ed25519 long-term public key of the peer
277 ed25519_pubkey: [u8; 32],
278 /// The checksum of the pubkey and version, as included in the onion address
280 /// The version byte, as defined by the Tor Onion v3 spec.
282 /// The port on which the node is listening
287 fn get_id(&self) -> u8 {
289 &NetAddress::IPv4 {..} => { 1 },
290 &NetAddress::IPv6 {..} => { 2 },
291 &NetAddress::OnionV2 {..} => { 3 },
292 &NetAddress::OnionV3 {..} => { 4 },
296 /// Strict byte-length of address descriptor, 1-byte type not recorded
297 fn len(&self) -> u16 {
299 &NetAddress::IPv4 { .. } => { 6 },
300 &NetAddress::IPv6 { .. } => { 18 },
301 &NetAddress::OnionV2 { .. } => { 12 },
302 &NetAddress::OnionV3 { .. } => { 37 },
306 /// The maximum length of any address descriptor, not including the 1-byte type
307 pub(crate) const MAX_LEN: u16 = 37;
310 impl Writeable for NetAddress {
311 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
313 &NetAddress::IPv4 { ref addr, ref port } => {
318 &NetAddress::IPv6 { ref addr, ref port } => {
323 &NetAddress::OnionV2 { ref addr, ref port } => {
328 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
330 ed25519_pubkey.write(writer)?;
331 checksum.write(writer)?;
332 version.write(writer)?;
340 impl Readable for Result<NetAddress, u8> {
341 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
342 let byte = <u8 as Readable>::read(reader)?;
345 Ok(Ok(NetAddress::IPv4 {
346 addr: Readable::read(reader)?,
347 port: Readable::read(reader)?,
351 Ok(Ok(NetAddress::IPv6 {
352 addr: Readable::read(reader)?,
353 port: Readable::read(reader)?,
357 Ok(Ok(NetAddress::OnionV2 {
358 addr: Readable::read(reader)?,
359 port: Readable::read(reader)?,
363 Ok(Ok(NetAddress::OnionV3 {
364 ed25519_pubkey: Readable::read(reader)?,
365 checksum: Readable::read(reader)?,
366 version: Readable::read(reader)?,
367 port: Readable::read(reader)?,
370 _ => return Ok(Err(byte)),
375 // Only exposed as broadcast of node_announcement should be filtered by node_id
376 /// The unsigned part of a node_announcement
377 #[derive(PartialEq, Clone, Debug)]
378 pub struct UnsignedNodeAnnouncement {
379 pub(crate) features: NodeFeatures,
380 pub(crate) timestamp: u32,
381 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
383 pub node_id: PublicKey,
384 pub(crate) rgb: [u8; 3],
385 pub(crate) alias: [u8; 32],
386 /// List of addresses on which this node is reachable. Note that you may only have up to one
387 /// address of each type, if you have more, they may be silently discarded or we may panic!
388 pub(crate) addresses: Vec<NetAddress>,
389 pub(crate) excess_address_data: Vec<u8>,
390 pub(crate) excess_data: Vec<u8>,
392 #[derive(PartialEq, Clone)]
393 /// A node_announcement message to be sent or received from a peer
394 pub struct NodeAnnouncement {
395 pub(crate) signature: Signature,
396 pub(crate) contents: UnsignedNodeAnnouncement,
399 // Only exposed as broadcast of channel_announcement should be filtered by node_id
400 /// The unsigned part of a channel_announcement
401 #[derive(PartialEq, Clone, Debug)]
402 pub struct UnsignedChannelAnnouncement {
403 pub(crate) features: ChannelFeatures,
404 pub(crate) chain_hash: Sha256dHash,
405 pub(crate) short_channel_id: u64,
406 /// One of the two node_ids which are endpoints of this channel
407 pub node_id_1: PublicKey,
408 /// The other of the two node_ids which are endpoints of this channel
409 pub node_id_2: PublicKey,
410 pub(crate) bitcoin_key_1: PublicKey,
411 pub(crate) bitcoin_key_2: PublicKey,
412 pub(crate) excess_data: Vec<u8>,
414 /// A channel_announcement message to be sent or received from a peer
415 #[derive(PartialEq, Clone, Debug)]
416 pub struct ChannelAnnouncement {
417 pub(crate) node_signature_1: Signature,
418 pub(crate) node_signature_2: Signature,
419 pub(crate) bitcoin_signature_1: Signature,
420 pub(crate) bitcoin_signature_2: Signature,
421 pub(crate) contents: UnsignedChannelAnnouncement,
424 #[derive(PartialEq, Clone, Debug)]
425 pub(crate) struct UnsignedChannelUpdate {
426 pub(crate) chain_hash: Sha256dHash,
427 pub(crate) short_channel_id: u64,
428 pub(crate) timestamp: u32,
429 pub(crate) flags: u16,
430 pub(crate) cltv_expiry_delta: u16,
431 pub(crate) htlc_minimum_msat: u64,
432 pub(crate) fee_base_msat: u32,
433 pub(crate) fee_proportional_millionths: u32,
434 pub(crate) excess_data: Vec<u8>,
436 /// A channel_update message to be sent or received from a peer
437 #[derive(PartialEq, Clone, Debug)]
438 pub struct ChannelUpdate {
439 pub(crate) signature: Signature,
440 pub(crate) contents: UnsignedChannelUpdate,
443 /// Used to put an error message in a LightningError
445 pub enum ErrorAction {
446 /// The peer took some action which made us think they were useless. Disconnect them.
448 /// An error message which we should make an effort to send before we disconnect.
449 msg: Option<ErrorMessage>
451 /// The peer did something harmless that we weren't able to process, just log and ignore
453 /// The peer did something incorrect. Tell them.
455 /// The message to send.
460 /// An Err type for failure to process messages.
461 pub struct LightningError {
462 /// A human-readable message describing the error
463 pub err: &'static str,
464 /// The action which should be taken against the offending peer.
465 pub action: ErrorAction,
468 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
469 /// transaction updates if they were pending.
470 #[derive(PartialEq, Clone)]
471 pub struct CommitmentUpdate {
472 /// update_add_htlc messages which should be sent
473 pub update_add_htlcs: Vec<UpdateAddHTLC>,
474 /// update_fulfill_htlc messages which should be sent
475 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
476 /// update_fail_htlc messages which should be sent
477 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
478 /// update_fail_malformed_htlc messages which should be sent
479 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
480 /// An update_fee message which should be sent
481 pub update_fee: Option<UpdateFee>,
482 /// Finally, the commitment_signed message which should be sent
483 pub commitment_signed: CommitmentSigned,
486 /// The information we received from a peer along the route of a payment we originated. This is
487 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
488 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
490 pub enum HTLCFailChannelUpdate {
491 /// We received an error which included a full ChannelUpdate message.
492 ChannelUpdateMessage {
493 /// The unwrapped message we received
496 /// We received an error which indicated only that a channel has been closed
498 /// The short_channel_id which has now closed.
499 short_channel_id: u64,
500 /// when this true, this channel should be permanently removed from the
501 /// consideration. Otherwise, this channel can be restored as new channel_update is received
504 /// We received an error which indicated only that a node has failed
506 /// The node_id that has failed.
508 /// when this true, node should be permanently removed from the
509 /// consideration. Otherwise, the channels connected to this node can be
510 /// restored as new channel_update is received
515 /// Messages could have optional fields to use with extended features
516 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
517 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
518 /// separate enum type for them.
519 #[derive(Clone, PartialEq)]
520 pub enum OptionalField<T> {
521 /// Optional field is included in message
523 /// Optional field is absent in message
527 /// A trait to describe an object which can receive channel messages.
529 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
530 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
531 pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
533 /// Handle an incoming open_channel message from the given peer.
534 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
535 /// Handle an incoming accept_channel message from the given peer.
536 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
537 /// Handle an incoming funding_created message from the given peer.
538 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
539 /// Handle an incoming funding_signed message from the given peer.
540 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
541 /// Handle an incoming funding_locked message from the given peer.
542 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
545 /// Handle an incoming shutdown message from the given peer.
546 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
547 /// Handle an incoming closing_signed message from the given peer.
548 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
551 /// Handle an incoming update_add_htlc message from the given peer.
552 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
553 /// Handle an incoming update_fulfill_htlc message from the given peer.
554 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
555 /// Handle an incoming update_fail_htlc message from the given peer.
556 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
557 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
558 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
559 /// Handle an incoming commitment_signed message from the given peer.
560 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
561 /// Handle an incoming revoke_and_ack message from the given peer.
562 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
564 /// Handle an incoming update_fee message from the given peer.
565 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
567 // Channel-to-announce:
568 /// Handle an incoming announcement_signatures message from the given peer.
569 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
571 // Connection loss/reestablish:
572 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
573 /// is believed to be possible in the future (eg they're sending us messages we don't
574 /// understand or indicate they require unknown feature bits), no_connection_possible is set
575 /// and any outstanding channels should be failed.
576 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
578 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
579 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
580 /// Handle an incoming channel_reestablish message from the given peer.
581 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
584 /// Handle an incoming error message from the given peer.
585 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
588 /// A trait to describe an object which can receive routing messages.
589 pub trait RoutingMessageHandler : Send + Sync {
590 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
591 /// false or returning an Err otherwise.
592 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
593 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
594 /// or returning an Err otherwise.
595 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
596 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
597 /// false or returning an Err otherwise.
598 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
599 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
600 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
601 /// Gets a subset of the channel announcements and updates required to dump our routing table
602 /// to a remote node, starting at the short_channel_id indicated by starting_point and
603 /// including batch_amount entries.
604 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
605 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
606 /// starting at the node *after* the provided publickey and including batch_amount entries.
607 /// If None is provided for starting_point, we start at the first node.
608 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
609 /// Returns whether a full sync should be requested from a peer.
610 fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
613 mod fuzzy_internal_msgs {
614 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
615 // them from untrusted input):
617 pub(crate) enum OnionHopDataFormat {
618 Legacy { // aka Realm-0
619 short_channel_id: u64,
622 short_channel_id: u64,
627 pub struct OnionHopData {
628 pub(crate) format: OnionHopDataFormat,
629 pub(crate) amt_to_forward: u64,
630 pub(crate) outgoing_cltv_value: u32,
631 // 12 bytes of 0-padding for Legacy format
634 pub struct DecodedOnionErrorPacket {
635 pub(crate) hmac: [u8; 32],
636 pub(crate) failuremsg: Vec<u8>,
637 pub(crate) pad: Vec<u8>,
640 #[cfg(feature = "fuzztarget")]
641 pub use self::fuzzy_internal_msgs::*;
642 #[cfg(not(feature = "fuzztarget"))]
643 pub(crate) use self::fuzzy_internal_msgs::*;
646 pub(crate) struct OnionPacket {
647 pub(crate) version: u8,
648 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
649 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
650 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
651 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
652 pub(crate) hop_data: [u8; 20*65],
653 pub(crate) hmac: [u8; 32],
656 impl PartialEq for OnionPacket {
657 fn eq(&self, other: &OnionPacket) -> bool {
658 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
659 if i != j { return false; }
661 self.version == other.version &&
662 self.public_key == other.public_key &&
663 self.hmac == other.hmac
667 #[derive(Clone, PartialEq)]
668 pub(crate) struct OnionErrorPacket {
669 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
670 // (TODO) We limit it in decode to much lower...
671 pub(crate) data: Vec<u8>,
674 impl Error for DecodeError {
675 fn description(&self) -> &str {
677 DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
678 DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
679 DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
680 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
681 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
682 DecodeError::Io(ref e) => e.description(),
686 impl fmt::Display for DecodeError {
687 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
688 f.write_str(self.description())
692 impl fmt::Debug for LightningError {
693 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
694 f.write_str(self.err)
698 impl From<::std::io::Error> for DecodeError {
699 fn from(e: ::std::io::Error) -> Self {
700 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
701 DecodeError::ShortRead
708 impl Writeable for OptionalField<Script> {
709 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
711 OptionalField::Present(ref script) => {
712 // Note that Writeable for script includes the 16-bit length tag for us
715 OptionalField::Absent => {}
721 impl Readable for OptionalField<Script> {
722 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
723 match <u16 as Readable>::read(r) {
725 let mut buf = vec![0; len as usize];
726 r.read_exact(&mut buf)?;
727 Ok(OptionalField::Present(Script::from(buf)))
729 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
735 impl_writeable_len_match!(AcceptChannel, {
736 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
739 temporary_channel_id,
741 max_htlc_value_in_flight_msat,
742 channel_reserve_satoshis,
748 revocation_basepoint,
750 delayed_payment_basepoint,
752 first_per_commitment_point,
753 shutdown_scriptpubkey
756 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
763 impl Writeable for ChannelReestablish {
764 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
765 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
766 self.channel_id.write(w)?;
767 self.next_local_commitment_number.write(w)?;
768 self.next_remote_commitment_number.write(w)?;
769 match self.data_loss_protect {
770 OptionalField::Present(ref data_loss_protect) => {
771 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
772 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
774 OptionalField::Absent => {}
780 impl Readable for ChannelReestablish{
781 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
783 channel_id: Readable::read(r)?,
784 next_local_commitment_number: Readable::read(r)?,
785 next_remote_commitment_number: Readable::read(r)?,
787 match <[u8; 32] as Readable>::read(r) {
788 Ok(your_last_per_commitment_secret) =>
789 OptionalField::Present(DataLossProtect {
790 your_last_per_commitment_secret,
791 my_current_per_commitment_point: Readable::read(r)?,
793 Err(DecodeError::ShortRead) => OptionalField::Absent,
794 Err(e) => return Err(e)
801 impl_writeable!(ClosingSigned, 32+8+64, {
807 impl_writeable_len_match!(CommitmentSigned, {
808 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
815 impl_writeable_len_match!(DecodedOnionErrorPacket, {
816 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
823 impl_writeable!(FundingCreated, 32+32+2+64, {
824 temporary_channel_id,
826 funding_output_index,
830 impl_writeable!(FundingSigned, 32+64, {
835 impl_writeable!(FundingLocked, 32+33, {
837 next_per_commitment_point
840 impl Writeable for Init {
841 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
842 // global_features gets the bottom 13 bits of our features, and local_features gets all of
843 // our relevant feature bits. This keeps us compatible with old nodes.
844 self.features.write_up_to_13(w)?;
845 self.features.write(w)
849 impl Readable for Init {
850 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
851 let global_features: InitFeatures = Readable::read(r)?;
852 let features: InitFeatures = Readable::read(r)?;
854 features: features.or(global_features),
859 impl_writeable_len_match!(OpenChannel, {
860 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
864 temporary_channel_id,
868 max_htlc_value_in_flight_msat,
869 channel_reserve_satoshis,
875 revocation_basepoint,
877 delayed_payment_basepoint,
879 first_per_commitment_point,
881 shutdown_scriptpubkey
884 impl_writeable!(RevokeAndACK, 32+32+33, {
886 per_commitment_secret,
887 next_per_commitment_point
890 impl_writeable_len_match!(Shutdown, {
891 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
897 impl_writeable_len_match!(UpdateFailHTLC, {
898 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
905 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
912 impl_writeable!(UpdateFee, 32+4, {
917 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
923 impl_writeable_len_match!(OnionErrorPacket, {
924 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
929 impl Writeable for OnionPacket {
930 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
931 w.size_hint(1 + 33 + 20*65 + 32);
932 self.version.write(w)?;
933 match self.public_key {
934 Ok(pubkey) => pubkey.write(w)?,
935 Err(_) => [0u8;33].write(w)?,
937 w.write_all(&self.hop_data)?;
943 impl Readable for OnionPacket {
944 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
946 version: Readable::read(r)?,
948 let mut buf = [0u8;33];
949 r.read_exact(&mut buf)?;
950 PublicKey::from_slice(&buf)
952 hop_data: Readable::read(r)?,
953 hmac: Readable::read(r)?,
958 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
967 impl Writeable for OnionHopData {
968 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
971 OnionHopDataFormat::Legacy { short_channel_id } => {
973 short_channel_id.write(w)?;
974 self.amt_to_forward.write(w)?;
975 self.outgoing_cltv_value.write(w)?;
976 w.write_all(&[0;12])?;
978 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
979 encode_varint_length_prefixed_tlv!(w, {
980 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
981 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
982 (6, short_channel_id)
985 OnionHopDataFormat::FinalNode => {
986 encode_varint_length_prefixed_tlv!(w, {
987 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
988 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
996 impl Readable for OnionHopData {
997 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
998 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
999 let v: VarInt = Decodable::consensus_decode(&mut r)
1000 .map_err(|e| match e {
1001 Error::Io(ioe) => DecodeError::from(ioe),
1002 _ => DecodeError::InvalidValue
1004 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1005 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1006 let mut rd = FixedLengthReader::new(r, v.0);
1007 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1008 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1009 let mut short_id: Option<u64> = None;
1010 decode_tlv!(&mut rd, {
1016 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1017 let format = if let Some(short_channel_id) = short_id {
1018 OnionHopDataFormat::NonFinalNode {
1022 OnionHopDataFormat::FinalNode
1024 (format, amt.0, cltv_value.0)
1026 let format = OnionHopDataFormat::Legacy {
1027 short_channel_id: Readable::read(r)?,
1029 let amt: u64 = Readable::read(r)?;
1030 let cltv_value: u32 = Readable::read(r)?;
1031 r.read_exact(&mut [0; 12])?;
1032 (format, amt, cltv_value)
1037 amt_to_forward: amt,
1038 outgoing_cltv_value: cltv_value,
1043 impl Writeable for Ping {
1044 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1045 w.size_hint(self.byteslen as usize + 4);
1046 self.ponglen.write(w)?;
1047 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1052 impl Readable for Ping {
1053 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1055 ponglen: Readable::read(r)?,
1057 let byteslen = Readable::read(r)?;
1058 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1065 impl Writeable for Pong {
1066 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1067 w.size_hint(self.byteslen as usize + 2);
1068 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1073 impl Readable for Pong {
1074 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1077 let byteslen = Readable::read(r)?;
1078 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1085 impl Writeable for UnsignedChannelAnnouncement {
1086 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1087 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1088 self.features.write(w)?;
1089 self.chain_hash.write(w)?;
1090 self.short_channel_id.write(w)?;
1091 self.node_id_1.write(w)?;
1092 self.node_id_2.write(w)?;
1093 self.bitcoin_key_1.write(w)?;
1094 self.bitcoin_key_2.write(w)?;
1095 w.write_all(&self.excess_data[..])?;
1100 impl Readable for UnsignedChannelAnnouncement {
1101 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1103 features: Readable::read(r)?,
1104 chain_hash: Readable::read(r)?,
1105 short_channel_id: Readable::read(r)?,
1106 node_id_1: Readable::read(r)?,
1107 node_id_2: Readable::read(r)?,
1108 bitcoin_key_1: Readable::read(r)?,
1109 bitcoin_key_2: Readable::read(r)?,
1111 let mut excess_data = vec![];
1112 r.read_to_end(&mut excess_data)?;
1119 impl_writeable_len_match!(ChannelAnnouncement, {
1120 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1121 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1125 bitcoin_signature_1,
1126 bitcoin_signature_2,
1130 impl Writeable for UnsignedChannelUpdate {
1131 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1132 w.size_hint(64 + self.excess_data.len());
1133 self.chain_hash.write(w)?;
1134 self.short_channel_id.write(w)?;
1135 self.timestamp.write(w)?;
1136 self.flags.write(w)?;
1137 self.cltv_expiry_delta.write(w)?;
1138 self.htlc_minimum_msat.write(w)?;
1139 self.fee_base_msat.write(w)?;
1140 self.fee_proportional_millionths.write(w)?;
1141 w.write_all(&self.excess_data[..])?;
1146 impl Readable for UnsignedChannelUpdate {
1147 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1149 chain_hash: Readable::read(r)?,
1150 short_channel_id: Readable::read(r)?,
1151 timestamp: Readable::read(r)?,
1152 flags: Readable::read(r)?,
1153 cltv_expiry_delta: Readable::read(r)?,
1154 htlc_minimum_msat: Readable::read(r)?,
1155 fee_base_msat: Readable::read(r)?,
1156 fee_proportional_millionths: Readable::read(r)?,
1158 let mut excess_data = vec![];
1159 r.read_to_end(&mut excess_data)?;
1166 impl_writeable_len_match!(ChannelUpdate, {
1167 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1168 64 + excess_data.len() + 64 }
1174 impl Writeable for ErrorMessage {
1175 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1176 w.size_hint(32 + 2 + self.data.len());
1177 self.channel_id.write(w)?;
1178 (self.data.len() as u16).write(w)?;
1179 w.write_all(self.data.as_bytes())?;
1184 impl Readable for ErrorMessage {
1185 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1187 channel_id: Readable::read(r)?,
1189 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1190 let mut data = vec![];
1191 let data_len = r.read_to_end(&mut data)?;
1192 sz = cmp::min(data_len, sz);
1193 match String::from_utf8(data[..sz as usize].to_vec()) {
1195 Err(_) => return Err(DecodeError::InvalidValue),
1202 impl Writeable for UnsignedNodeAnnouncement {
1203 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1204 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1205 self.features.write(w)?;
1206 self.timestamp.write(w)?;
1207 self.node_id.write(w)?;
1208 w.write_all(&self.rgb)?;
1209 self.alias.write(w)?;
1211 let mut addrs_to_encode = self.addresses.clone();
1212 addrs_to_encode.sort_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1213 let mut addr_len = 0;
1214 for addr in &addrs_to_encode {
1215 addr_len += 1 + addr.len();
1217 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1218 for addr in addrs_to_encode {
1221 w.write_all(&self.excess_address_data[..])?;
1222 w.write_all(&self.excess_data[..])?;
1227 impl Readable for UnsignedNodeAnnouncement {
1228 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1229 let features: NodeFeatures = Readable::read(r)?;
1230 let timestamp: u32 = Readable::read(r)?;
1231 let node_id: PublicKey = Readable::read(r)?;
1232 let mut rgb = [0; 3];
1233 r.read_exact(&mut rgb)?;
1234 let alias: [u8; 32] = Readable::read(r)?;
1236 let addr_len: u16 = Readable::read(r)?;
1237 let mut addresses: Vec<NetAddress> = Vec::new();
1238 let mut highest_addr_type = 0;
1239 let mut addr_readpos = 0;
1240 let mut excess = false;
1241 let mut excess_byte = 0;
1243 if addr_len <= addr_readpos { break; }
1244 match Readable::read(r) {
1246 if addr.get_id() < highest_addr_type {
1247 // Addresses must be sorted in increasing order
1248 return Err(DecodeError::InvalidValue);
1250 highest_addr_type = addr.get_id();
1251 if addr_len < addr_readpos + 1 + addr.len() {
1252 return Err(DecodeError::BadLengthDescriptor);
1254 addr_readpos += (1 + addr.len()) as u16;
1255 addresses.push(addr);
1257 Ok(Err(unknown_descriptor)) => {
1259 excess_byte = unknown_descriptor;
1262 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1263 Err(e) => return Err(e),
1267 let mut excess_data = vec![];
1268 let excess_address_data = if addr_readpos < addr_len {
1269 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1270 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1272 excess_address_data[0] = excess_byte;
1277 excess_data.push(excess_byte);
1281 r.read_to_end(&mut excess_data)?;
1282 Ok(UnsignedNodeAnnouncement {
1289 excess_address_data,
1295 impl_writeable_len_match!(NodeAnnouncement, {
1296 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1297 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1307 use ln::msgs::{ChannelFeatures, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1308 use ln::channelmanager::{PaymentPreimage, PaymentHash};
1309 use util::ser::{Writeable, Readable};
1311 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
1312 use bitcoin_hashes::hex::FromHex;
1313 use bitcoin::util::address::Address;
1314 use bitcoin::network::constants::Network;
1315 use bitcoin::blockdata::script::Builder;
1316 use bitcoin::blockdata::opcodes;
1318 use secp256k1::key::{PublicKey,SecretKey};
1319 use secp256k1::{Secp256k1, Message};
1321 use std::io::Cursor;
1324 fn encoding_channel_reestablish_no_secret() {
1325 let cr = msgs::ChannelReestablish {
1326 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],
1327 next_local_commitment_number: 3,
1328 next_remote_commitment_number: 4,
1329 data_loss_protect: OptionalField::Absent,
1332 let encoded_value = cr.encode();
1335 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]
1340 fn encoding_channel_reestablish_with_secret() {
1342 let secp_ctx = Secp256k1::new();
1343 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1346 let cr = msgs::ChannelReestablish {
1347 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],
1348 next_local_commitment_number: 3,
1349 next_remote_commitment_number: 4,
1350 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1353 let encoded_value = cr.encode();
1356 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]
1360 macro_rules! get_keys_from {
1361 ($slice: expr, $secp_ctx: expr) => {
1363 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1364 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1370 macro_rules! get_sig_on {
1371 ($privkey: expr, $ctx: expr, $string: expr) => {
1373 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1374 $ctx.sign(&sighash, &$privkey)
1380 fn encoding_announcement_signatures() {
1381 let secp_ctx = Secp256k1::new();
1382 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1383 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1384 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1385 let announcement_signatures = msgs::AnnouncementSignatures {
1386 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],
1387 short_channel_id: 2316138423780173,
1388 node_signature: sig_1,
1389 bitcoin_signature: sig_2,
1392 let encoded_value = announcement_signatures.encode();
1393 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1396 fn do_encoding_channel_announcement(unknown_features_bits: bool, non_bitcoin_chain_hash: bool, excess_data: bool) {
1397 let secp_ctx = Secp256k1::new();
1398 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1399 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1400 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1401 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1402 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1403 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1404 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1405 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1406 let mut features = ChannelFeatures::supported();
1407 if unknown_features_bits {
1408 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1410 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1412 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1413 short_channel_id: 2316138423780173,
1414 node_id_1: pubkey_1,
1415 node_id_2: pubkey_2,
1416 bitcoin_key_1: pubkey_3,
1417 bitcoin_key_2: pubkey_4,
1418 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1420 let channel_announcement = msgs::ChannelAnnouncement {
1421 node_signature_1: sig_1,
1422 node_signature_2: sig_2,
1423 bitcoin_signature_1: sig_3,
1424 bitcoin_signature_2: sig_4,
1425 contents: unsigned_channel_announcement,
1427 let encoded_value = channel_announcement.encode();
1428 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1429 if unknown_features_bits {
1430 target_value.append(&mut hex::decode("0002ffff").unwrap());
1432 target_value.append(&mut hex::decode("0000").unwrap());
1434 if non_bitcoin_chain_hash {
1435 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1437 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1439 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1441 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1443 assert_eq!(encoded_value, target_value);
1447 fn encoding_channel_announcement() {
1448 do_encoding_channel_announcement(false, false, false);
1449 do_encoding_channel_announcement(true, false, false);
1450 do_encoding_channel_announcement(true, true, false);
1451 do_encoding_channel_announcement(true, true, true);
1452 do_encoding_channel_announcement(false, true, true);
1453 do_encoding_channel_announcement(false, false, true);
1454 do_encoding_channel_announcement(false, true, false);
1455 do_encoding_channel_announcement(true, false, true);
1458 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1459 let secp_ctx = Secp256k1::new();
1460 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1461 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1462 let features = if unknown_features_bits {
1463 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1465 // Set to some features we may support
1466 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1468 let mut addresses = Vec::new();
1470 addresses.push(msgs::NetAddress::IPv4 {
1471 addr: [255, 254, 253, 252],
1476 addresses.push(msgs::NetAddress::IPv6 {
1477 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1482 addresses.push(msgs::NetAddress::OnionV2 {
1483 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1488 addresses.push(msgs::NetAddress::OnionV3 {
1489 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],
1495 let mut addr_len = 0;
1496 for addr in &addresses {
1497 addr_len += addr.len() + 1;
1499 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1501 timestamp: 20190119,
1506 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() },
1507 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() },
1509 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1510 let node_announcement = msgs::NodeAnnouncement {
1512 contents: unsigned_node_announcement,
1514 let encoded_value = node_announcement.encode();
1515 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1516 if unknown_features_bits {
1517 target_value.append(&mut hex::decode("0002ffff").unwrap());
1519 target_value.append(&mut hex::decode("000122").unwrap());
1521 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1522 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1524 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1527 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1530 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1533 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1535 if excess_address_data {
1536 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1539 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1541 assert_eq!(encoded_value, target_value);
1545 fn encoding_node_announcement() {
1546 do_encoding_node_announcement(true, true, true, true, true, true, true);
1547 do_encoding_node_announcement(false, false, false, false, false, false, false);
1548 do_encoding_node_announcement(false, true, false, false, false, false, false);
1549 do_encoding_node_announcement(false, false, true, false, false, false, false);
1550 do_encoding_node_announcement(false, false, false, true, false, false, false);
1551 do_encoding_node_announcement(false, false, false, false, true, false, false);
1552 do_encoding_node_announcement(false, false, false, false, false, true, false);
1553 do_encoding_node_announcement(false, true, false, true, false, true, false);
1554 do_encoding_node_announcement(false, false, true, false, true, false, false);
1557 fn do_encoding_channel_update(non_bitcoin_chain_hash: bool, direction: bool, disable: bool, htlc_maximum_msat: bool) {
1558 let secp_ctx = Secp256k1::new();
1559 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1560 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1561 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
1562 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1563 short_channel_id: 2316138423780173,
1564 timestamp: 20190119,
1565 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 } | if htlc_maximum_msat { 1 << 8 } else { 0 },
1566 cltv_expiry_delta: 144,
1567 htlc_minimum_msat: 1000000,
1568 fee_base_msat: 10000,
1569 fee_proportional_millionths: 20,
1570 excess_data: if htlc_maximum_msat { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
1572 let channel_update = msgs::ChannelUpdate {
1574 contents: unsigned_channel_update
1576 let encoded_value = channel_update.encode();
1577 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1578 if non_bitcoin_chain_hash {
1579 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1581 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1583 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
1584 if htlc_maximum_msat {
1585 target_value.append(&mut hex::decode("01").unwrap());
1587 target_value.append(&mut hex::decode("00").unwrap());
1589 target_value.append(&mut hex::decode("00").unwrap());
1591 let flag = target_value.last_mut().unwrap();
1595 let flag = target_value.last_mut().unwrap();
1596 *flag = *flag | 1 << 1;
1598 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
1599 if htlc_maximum_msat {
1600 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
1602 assert_eq!(encoded_value, target_value);
1606 fn encoding_channel_update() {
1607 do_encoding_channel_update(false, false, false, false);
1608 do_encoding_channel_update(true, false, false, false);
1609 do_encoding_channel_update(false, true, false, false);
1610 do_encoding_channel_update(false, false, true, false);
1611 do_encoding_channel_update(false, false, false, true);
1612 do_encoding_channel_update(true, true, true, true);
1615 fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
1616 let secp_ctx = Secp256k1::new();
1617 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1618 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1619 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1620 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1621 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1622 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1623 let open_channel = msgs::OpenChannel {
1624 chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
1625 temporary_channel_id: [2; 32],
1626 funding_satoshis: 1311768467284833366,
1627 push_msat: 2536655962884945560,
1628 dust_limit_satoshis: 3608586615801332854,
1629 max_htlc_value_in_flight_msat: 8517154655701053848,
1630 channel_reserve_satoshis: 8665828695742877976,
1631 htlc_minimum_msat: 2316138423780173,
1632 feerate_per_kw: 821716,
1633 to_self_delay: 49340,
1634 max_accepted_htlcs: 49340,
1635 funding_pubkey: pubkey_1,
1636 revocation_basepoint: pubkey_2,
1637 payment_basepoint: pubkey_3,
1638 delayed_payment_basepoint: pubkey_4,
1639 htlc_basepoint: pubkey_5,
1640 first_per_commitment_point: pubkey_6,
1641 channel_flags: if random_bit { 1 << 5 } else { 0 },
1642 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1644 let encoded_value = open_channel.encode();
1645 let mut target_value = Vec::new();
1646 if non_bitcoin_chain_hash {
1647 target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
1649 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1651 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1653 target_value.append(&mut hex::decode("20").unwrap());
1655 target_value.append(&mut hex::decode("00").unwrap());
1658 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1660 assert_eq!(encoded_value, target_value);
1664 fn encoding_open_channel() {
1665 do_encoding_open_channel(false, false, false);
1666 do_encoding_open_channel(true, false, false);
1667 do_encoding_open_channel(false, true, false);
1668 do_encoding_open_channel(false, false, true);
1669 do_encoding_open_channel(true, true, true);
1672 fn do_encoding_accept_channel(shutdown: bool) {
1673 let secp_ctx = Secp256k1::new();
1674 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1675 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1676 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1677 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1678 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1679 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1680 let accept_channel = msgs::AcceptChannel {
1681 temporary_channel_id: [2; 32],
1682 dust_limit_satoshis: 1311768467284833366,
1683 max_htlc_value_in_flight_msat: 2536655962884945560,
1684 channel_reserve_satoshis: 3608586615801332854,
1685 htlc_minimum_msat: 2316138423780173,
1686 minimum_depth: 821716,
1687 to_self_delay: 49340,
1688 max_accepted_htlcs: 49340,
1689 funding_pubkey: pubkey_1,
1690 revocation_basepoint: pubkey_2,
1691 payment_basepoint: pubkey_3,
1692 delayed_payment_basepoint: pubkey_4,
1693 htlc_basepoint: pubkey_5,
1694 first_per_commitment_point: pubkey_6,
1695 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1697 let encoded_value = accept_channel.encode();
1698 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1700 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1702 assert_eq!(encoded_value, target_value);
1706 fn encoding_accept_channel() {
1707 do_encoding_accept_channel(false);
1708 do_encoding_accept_channel(true);
1712 fn encoding_funding_created() {
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_created = msgs::FundingCreated {
1717 temporary_channel_id: [2; 32],
1718 funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1719 funding_output_index: 255,
1722 let encoded_value = funding_created.encode();
1723 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1724 assert_eq!(encoded_value, target_value);
1728 fn encoding_funding_signed() {
1729 let secp_ctx = Secp256k1::new();
1730 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1731 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1732 let funding_signed = msgs::FundingSigned {
1733 channel_id: [2; 32],
1736 let encoded_value = funding_signed.encode();
1737 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1738 assert_eq!(encoded_value, target_value);
1742 fn encoding_funding_locked() {
1743 let secp_ctx = Secp256k1::new();
1744 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1745 let funding_locked = msgs::FundingLocked {
1746 channel_id: [2; 32],
1747 next_per_commitment_point: pubkey_1,
1749 let encoded_value = funding_locked.encode();
1750 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1751 assert_eq!(encoded_value, target_value);
1754 fn do_encoding_shutdown(script_type: u8) {
1755 let secp_ctx = Secp256k1::new();
1756 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1757 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1758 let shutdown = msgs::Shutdown {
1759 channel_id: [2; 32],
1760 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() },
1762 let encoded_value = shutdown.encode();
1763 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1764 if script_type == 1 {
1765 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1766 } else if script_type == 2 {
1767 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1768 } else if script_type == 3 {
1769 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1770 } else if script_type == 4 {
1771 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1773 assert_eq!(encoded_value, target_value);
1777 fn encoding_shutdown() {
1778 do_encoding_shutdown(1);
1779 do_encoding_shutdown(2);
1780 do_encoding_shutdown(3);
1781 do_encoding_shutdown(4);
1785 fn encoding_closing_signed() {
1786 let secp_ctx = Secp256k1::new();
1787 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1788 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1789 let closing_signed = msgs::ClosingSigned {
1790 channel_id: [2; 32],
1791 fee_satoshis: 2316138423780173,
1794 let encoded_value = closing_signed.encode();
1795 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1796 assert_eq!(encoded_value, target_value);
1800 fn encoding_update_add_htlc() {
1801 let secp_ctx = Secp256k1::new();
1802 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1803 let onion_routing_packet = msgs::OnionPacket {
1805 public_key: Ok(pubkey_1),
1806 hop_data: [1; 20*65],
1809 let update_add_htlc = msgs::UpdateAddHTLC {
1810 channel_id: [2; 32],
1811 htlc_id: 2316138423780173,
1812 amount_msat: 3608586615801332854,
1813 payment_hash: PaymentHash([1; 32]),
1814 cltv_expiry: 821716,
1815 onion_routing_packet
1817 let encoded_value = update_add_htlc.encode();
1818 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
1819 assert_eq!(encoded_value, target_value);
1823 fn encoding_update_fulfill_htlc() {
1824 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
1825 channel_id: [2; 32],
1826 htlc_id: 2316138423780173,
1827 payment_preimage: PaymentPreimage([1; 32]),
1829 let encoded_value = update_fulfill_htlc.encode();
1830 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
1831 assert_eq!(encoded_value, target_value);
1835 fn encoding_update_fail_htlc() {
1836 let reason = OnionErrorPacket {
1837 data: [1; 32].to_vec(),
1839 let update_fail_htlc = msgs::UpdateFailHTLC {
1840 channel_id: [2; 32],
1841 htlc_id: 2316138423780173,
1844 let encoded_value = update_fail_htlc.encode();
1845 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
1846 assert_eq!(encoded_value, target_value);
1850 fn encoding_update_fail_malformed_htlc() {
1851 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
1852 channel_id: [2; 32],
1853 htlc_id: 2316138423780173,
1854 sha256_of_onion: [1; 32],
1857 let encoded_value = update_fail_malformed_htlc.encode();
1858 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
1859 assert_eq!(encoded_value, target_value);
1862 fn do_encoding_commitment_signed(htlcs: bool) {
1863 let secp_ctx = Secp256k1::new();
1864 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1865 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1866 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1867 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1868 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1869 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1870 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1871 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1872 let commitment_signed = msgs::CommitmentSigned {
1873 channel_id: [2; 32],
1875 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
1877 let encoded_value = commitment_signed.encode();
1878 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1880 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1882 target_value.append(&mut hex::decode("0000").unwrap());
1884 assert_eq!(encoded_value, target_value);
1888 fn encoding_commitment_signed() {
1889 do_encoding_commitment_signed(true);
1890 do_encoding_commitment_signed(false);
1894 fn encoding_revoke_and_ack() {
1895 let secp_ctx = Secp256k1::new();
1896 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1897 let raa = msgs::RevokeAndACK {
1898 channel_id: [2; 32],
1899 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],
1900 next_per_commitment_point: pubkey_1,
1902 let encoded_value = raa.encode();
1903 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1904 assert_eq!(encoded_value, target_value);
1908 fn encoding_update_fee() {
1909 let update_fee = msgs::UpdateFee {
1910 channel_id: [2; 32],
1911 feerate_per_kw: 20190119,
1913 let encoded_value = update_fee.encode();
1914 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
1915 assert_eq!(encoded_value, target_value);
1919 fn encoding_init() {
1920 assert_eq!(msgs::Init {
1921 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
1922 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
1923 assert_eq!(msgs::Init {
1924 features: InitFeatures::from_le_bytes(vec![0xFF]),
1925 }.encode(), hex::decode("0001ff0001ff").unwrap());
1926 assert_eq!(msgs::Init {
1927 features: InitFeatures::from_le_bytes(vec![]),
1928 }.encode(), hex::decode("00000000").unwrap());
1932 fn encoding_error() {
1933 let error = msgs::ErrorMessage {
1934 channel_id: [2; 32],
1935 data: String::from("rust-lightning"),
1937 let encoded_value = error.encode();
1938 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
1939 assert_eq!(encoded_value, target_value);
1943 fn encoding_ping() {
1944 let ping = msgs::Ping {
1948 let encoded_value = ping.encode();
1949 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1950 assert_eq!(encoded_value, target_value);
1954 fn encoding_pong() {
1955 let pong = msgs::Pong {
1958 let encoded_value = pong.encode();
1959 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
1960 assert_eq!(encoded_value, target_value);
1964 fn encoding_legacy_onion_hop_data() {
1965 let msg = msgs::OnionHopData {
1966 format: OnionHopDataFormat::Legacy {
1967 short_channel_id: 0xdeadbeef1bad1dea,
1969 amt_to_forward: 0x0badf00d01020304,
1970 outgoing_cltv_value: 0xffffffff,
1972 let encoded_value = msg.encode();
1973 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
1974 assert_eq!(encoded_value, target_value);
1978 fn encoding_nonfinal_onion_hop_data() {
1979 let mut msg = msgs::OnionHopData {
1980 format: OnionHopDataFormat::NonFinalNode {
1981 short_channel_id: 0xdeadbeef1bad1dea,
1983 amt_to_forward: 0x0badf00d01020304,
1984 outgoing_cltv_value: 0xffffffff,
1986 let encoded_value = msg.encode();
1987 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
1988 assert_eq!(encoded_value, target_value);
1989 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
1990 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
1991 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
1992 } else { panic!(); }
1993 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
1994 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
1998 fn encoding_final_onion_hop_data() {
1999 let mut msg = msgs::OnionHopData {
2000 format: OnionHopDataFormat::FinalNode,
2001 amt_to_forward: 0x0badf00d01020304,
2002 outgoing_cltv_value: 0xffffffff,
2004 let encoded_value = msg.encode();
2005 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2006 assert_eq!(encoded_value, target_value);
2007 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2008 if let OnionHopDataFormat::FinalNode = msg.format { } else { panic!(); }
2009 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2010 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);