1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
12 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
13 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
14 //! server entirely) which handles only channel-related messages you may wish to implement
15 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
18 //! Note that if you go with such an architecture (instead of passing raw socket events to a
19 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
20 //! source node_id of the message, however this does allow you to significantly reduce bandwidth
21 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
22 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
23 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
24 //! raw socket events into your non-internet-facing system and then send routing events back to
25 //! track the network on the less-secure system.
27 use bitcoin::secp256k1::key::PublicKey;
28 use bitcoin::secp256k1::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
39 use util::events::MessageSendEventsProvider;
40 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
42 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
44 /// 21 million * 10^8 * 1000
45 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
47 /// An error in decoding a message or struct.
48 #[derive(Clone, Debug)]
49 pub enum DecodeError {
50 /// A version byte specified something we don't know how to handle.
51 /// Includes unknown realm byte in an OnionHopData packet
53 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
54 UnknownRequiredFeature,
55 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
56 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
57 /// syntactically incorrect, etc
61 /// A length descriptor in the packet didn't describe the later data correctly
63 /// Error from std::io
64 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
65 ::std::io::ErrorKind),
68 /// An init message to be sent or received from a peer
69 #[derive(Clone, Debug, PartialEq)]
71 /// The relevant features which the sender supports
72 pub features: InitFeatures,
75 /// An error message to be sent or received from a peer
76 #[derive(Clone, Debug, PartialEq)]
77 pub struct ErrorMessage {
78 /// The channel ID involved in the error
79 pub channel_id: [u8; 32],
80 /// A possibly human-readable error description.
81 /// The string should be sanitized before it is used (e.g. emitted to logs
82 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
83 /// vulnerability in the terminal emulator or the logging subsystem.
87 /// A ping message to be sent or received from a peer
88 #[derive(Clone, Debug, PartialEq)]
90 /// The desired response length
92 /// The ping packet size.
93 /// This field is not sent on the wire. byteslen zeros are sent.
97 /// A pong message to be sent or received from a peer
98 #[derive(Clone, Debug, PartialEq)]
100 /// The pong packet size.
101 /// This field is not sent on the wire. byteslen zeros are sent.
105 /// An open_channel message to be sent or received from a peer
106 #[derive(Clone, Debug, PartialEq)]
107 pub struct OpenChannel {
108 /// The genesis hash of the blockchain where the channel is to be opened
109 pub chain_hash: BlockHash,
110 /// A temporary channel ID, until the funding outpoint is announced
111 pub temporary_channel_id: [u8; 32],
112 /// The channel value
113 pub funding_satoshis: u64,
114 /// The amount to push to the counterparty as part of the open, in milli-satoshi
116 /// The threshold below which outputs on transactions broadcast by sender will be omitted
117 pub dust_limit_satoshis: u64,
118 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
119 pub max_htlc_value_in_flight_msat: u64,
120 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
121 pub channel_reserve_satoshis: u64,
122 /// The minimum HTLC size incoming to sender, in milli-satoshi
123 pub htlc_minimum_msat: u64,
124 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
125 pub feerate_per_kw: u32,
126 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
127 pub to_self_delay: u16,
128 /// The maximum number of inbound HTLCs towards sender
129 pub max_accepted_htlcs: u16,
130 /// The sender's key controlling the funding transaction
131 pub funding_pubkey: PublicKey,
132 /// Used to derive a revocation key for transactions broadcast by counterparty
133 pub revocation_basepoint: PublicKey,
134 /// A payment key to sender for transactions broadcast by counterparty
135 pub payment_point: PublicKey,
136 /// Used to derive a payment key to sender for transactions broadcast by sender
137 pub delayed_payment_basepoint: PublicKey,
138 /// Used to derive an HTLC payment key to sender
139 pub htlc_basepoint: PublicKey,
140 /// The first to-be-broadcast-by-sender transaction's per commitment point
141 pub first_per_commitment_point: PublicKey,
143 pub channel_flags: u8,
144 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
145 pub shutdown_scriptpubkey: OptionalField<Script>,
148 /// An accept_channel message to be sent or received from a peer
149 #[derive(Clone, Debug, PartialEq)]
150 pub struct AcceptChannel {
151 /// A temporary channel ID, until the funding outpoint is announced
152 pub temporary_channel_id: [u8; 32],
153 /// The threshold below which outputs on transactions broadcast by sender will be omitted
154 pub dust_limit_satoshis: u64,
155 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
156 pub max_htlc_value_in_flight_msat: u64,
157 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
158 pub channel_reserve_satoshis: u64,
159 /// The minimum HTLC size incoming to sender, in milli-satoshi
160 pub htlc_minimum_msat: u64,
161 /// Minimum depth of the funding transaction before the channel is considered open
162 pub minimum_depth: u32,
163 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
164 pub to_self_delay: u16,
165 /// The maximum number of inbound HTLCs towards sender
166 pub max_accepted_htlcs: u16,
167 /// The sender's key controlling the funding transaction
168 pub funding_pubkey: PublicKey,
169 /// Used to derive a revocation key for transactions broadcast by counterparty
170 pub revocation_basepoint: PublicKey,
171 /// A payment key to sender for transactions broadcast by counterparty
172 pub payment_point: PublicKey,
173 /// Used to derive a payment key to sender for transactions broadcast by sender
174 pub delayed_payment_basepoint: PublicKey,
175 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
176 pub htlc_basepoint: PublicKey,
177 /// The first to-be-broadcast-by-sender transaction's per commitment point
178 pub first_per_commitment_point: PublicKey,
179 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
180 pub shutdown_scriptpubkey: OptionalField<Script>,
183 /// A funding_created message to be sent or received from a peer
184 #[derive(Clone, Debug, PartialEq)]
185 pub struct FundingCreated {
186 /// A temporary channel ID, until the funding is established
187 pub temporary_channel_id: [u8; 32],
188 /// The funding transaction ID
189 pub funding_txid: Txid,
190 /// The specific output index funding this channel
191 pub funding_output_index: u16,
192 /// The signature of the channel initiator (funder) on the funding transaction
193 pub signature: Signature,
196 /// A funding_signed message to be sent or received from a peer
197 #[derive(Clone, Debug, PartialEq)]
198 pub struct FundingSigned {
200 pub channel_id: [u8; 32],
201 /// The signature of the channel acceptor (fundee) on the funding transaction
202 pub signature: Signature,
205 /// A funding_locked message to be sent or received from a peer
206 #[derive(Clone, Debug, PartialEq)]
207 pub struct FundingLocked {
209 pub channel_id: [u8; 32],
210 /// The per-commitment point of the second commitment transaction
211 pub next_per_commitment_point: PublicKey,
214 /// A shutdown message to be sent or received from a peer
215 #[derive(Clone, Debug, PartialEq)]
216 pub struct Shutdown {
218 pub channel_id: [u8; 32],
219 /// The destination of this peer's funds on closing.
220 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
221 pub scriptpubkey: Script,
224 /// A closing_signed message to be sent or received from a peer
225 #[derive(Clone, Debug, PartialEq)]
226 pub struct ClosingSigned {
228 pub channel_id: [u8; 32],
229 /// The proposed total fee for the closing transaction
230 pub fee_satoshis: u64,
231 /// A signature on the closing transaction
232 pub signature: Signature,
235 /// An update_add_htlc message to be sent or received from a peer
236 #[derive(Clone, Debug, PartialEq)]
237 pub struct UpdateAddHTLC {
239 pub channel_id: [u8; 32],
242 /// The HTLC value in milli-satoshi
243 pub amount_msat: u64,
244 /// The payment hash, the pre-image of which controls HTLC redemption
245 pub payment_hash: PaymentHash,
246 /// The expiry height of the HTLC
247 pub cltv_expiry: u32,
248 pub(crate) onion_routing_packet: OnionPacket,
251 /// An update_fulfill_htlc message to be sent or received from a peer
252 #[derive(Clone, Debug, PartialEq)]
253 pub struct UpdateFulfillHTLC {
255 pub channel_id: [u8; 32],
258 /// The pre-image of the payment hash, allowing HTLC redemption
259 pub payment_preimage: PaymentPreimage,
262 /// An update_fail_htlc message to be sent or received from a peer
263 #[derive(Clone, Debug, PartialEq)]
264 pub struct UpdateFailHTLC {
266 pub channel_id: [u8; 32],
269 pub(crate) reason: OnionErrorPacket,
272 /// An update_fail_malformed_htlc message to be sent or received from a peer
273 #[derive(Clone, Debug, PartialEq)]
274 pub struct UpdateFailMalformedHTLC {
276 pub channel_id: [u8; 32],
279 pub(crate) sha256_of_onion: [u8; 32],
281 pub failure_code: u16,
284 /// A commitment_signed message to be sent or received from a peer
285 #[derive(Clone, Debug, PartialEq)]
286 pub struct CommitmentSigned {
288 pub channel_id: [u8; 32],
289 /// A signature on the commitment transaction
290 pub signature: Signature,
291 /// Signatures on the HTLC transactions
292 pub htlc_signatures: Vec<Signature>,
295 /// A revoke_and_ack message to be sent or received from a peer
296 #[derive(Clone, Debug, PartialEq)]
297 pub struct RevokeAndACK {
299 pub channel_id: [u8; 32],
300 /// The secret corresponding to the per-commitment point
301 pub per_commitment_secret: [u8; 32],
302 /// The next sender-broadcast commitment transaction's per-commitment point
303 pub next_per_commitment_point: PublicKey,
306 /// An update_fee message to be sent or received from a peer
307 #[derive(Clone, Debug, PartialEq)]
308 pub struct UpdateFee {
310 pub channel_id: [u8; 32],
311 /// Fee rate per 1000-weight of the transaction
312 pub feerate_per_kw: u32,
315 #[derive(Clone, Debug, PartialEq)]
316 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
317 /// This is used to convince the recipient that the channel is at a certain commitment
318 /// number even if they lost that data due to a local failure. Of course, the peer may lie
319 /// and even later commitments may have been revoked.
320 pub struct DataLossProtect {
321 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
322 /// belonging to the recipient
323 pub your_last_per_commitment_secret: [u8; 32],
324 /// The sender's per-commitment point for their current commitment transaction
325 pub my_current_per_commitment_point: PublicKey,
328 /// A channel_reestablish message to be sent or received from a peer
329 #[derive(Clone, Debug, PartialEq)]
330 pub struct ChannelReestablish {
332 pub channel_id: [u8; 32],
333 /// The next commitment number for the sender
334 pub next_local_commitment_number: u64,
335 /// The next commitment number for the recipient
336 pub next_remote_commitment_number: u64,
337 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
338 pub data_loss_protect: OptionalField<DataLossProtect>,
341 /// An announcement_signatures message to be sent or received from a peer
342 #[derive(Clone, Debug, PartialEq)]
343 pub struct AnnouncementSignatures {
345 pub channel_id: [u8; 32],
346 /// The short channel ID
347 pub short_channel_id: u64,
348 /// A signature by the node key
349 pub node_signature: Signature,
350 /// A signature by the funding key
351 pub bitcoin_signature: Signature,
354 /// An address which can be used to connect to a remote peer
355 #[derive(Clone, Debug, PartialEq)]
356 pub enum NetAddress {
357 /// An IPv4 address/port on which the peer is listening.
359 /// The 4-byte IPv4 address
361 /// The port on which the node is listening
364 /// An IPv6 address/port on which the peer is listening.
366 /// The 16-byte IPv6 address
368 /// The port on which the node is listening
371 /// An old-style Tor onion address/port on which the peer is listening.
373 /// The bytes (usually encoded in base32 with ".onion" appended)
375 /// The port on which the node is listening
378 /// A new-style Tor onion address/port on which the peer is listening.
379 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
380 /// wrap as base32 and append ".onion".
382 /// The ed25519 long-term public key of the peer
383 ed25519_pubkey: [u8; 32],
384 /// The checksum of the pubkey and version, as included in the onion address
386 /// The version byte, as defined by the Tor Onion v3 spec.
388 /// The port on which the node is listening
393 /// Strict byte-length of address descriptor, 1-byte type not recorded
394 fn len(&self) -> u16 {
396 &NetAddress::IPv4 { .. } => { 6 },
397 &NetAddress::IPv6 { .. } => { 18 },
398 &NetAddress::OnionV2 { .. } => { 12 },
399 &NetAddress::OnionV3 { .. } => { 37 },
403 /// The maximum length of any address descriptor, not including the 1-byte type
404 pub(crate) const MAX_LEN: u16 = 37;
407 impl Writeable for NetAddress {
408 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
410 &NetAddress::IPv4 { ref addr, ref port } => {
415 &NetAddress::IPv6 { ref addr, ref port } => {
420 &NetAddress::OnionV2 { ref addr, ref port } => {
425 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
427 ed25519_pubkey.write(writer)?;
428 checksum.write(writer)?;
429 version.write(writer)?;
437 impl Readable for Result<NetAddress, u8> {
438 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
439 let byte = <u8 as Readable>::read(reader)?;
442 Ok(Ok(NetAddress::IPv4 {
443 addr: Readable::read(reader)?,
444 port: Readable::read(reader)?,
448 Ok(Ok(NetAddress::IPv6 {
449 addr: Readable::read(reader)?,
450 port: Readable::read(reader)?,
454 Ok(Ok(NetAddress::OnionV2 {
455 addr: Readable::read(reader)?,
456 port: Readable::read(reader)?,
460 Ok(Ok(NetAddress::OnionV3 {
461 ed25519_pubkey: Readable::read(reader)?,
462 checksum: Readable::read(reader)?,
463 version: Readable::read(reader)?,
464 port: Readable::read(reader)?,
467 _ => return Ok(Err(byte)),
472 /// The unsigned part of a node_announcement
473 #[derive(Clone, Debug, PartialEq)]
474 pub struct UnsignedNodeAnnouncement {
475 /// The advertised features
476 pub features: NodeFeatures,
477 /// A strictly monotonic announcement counter, with gaps allowed
479 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
481 pub node_id: PublicKey,
482 /// An RGB color for UI purposes
484 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
487 /// List of addresses on which this node is reachable
488 pub addresses: Vec<NetAddress>,
489 pub(crate) excess_address_data: Vec<u8>,
490 pub(crate) excess_data: Vec<u8>,
492 #[derive(Clone, Debug, PartialEq)]
493 /// A node_announcement message to be sent or received from a peer
494 pub struct NodeAnnouncement {
495 /// The signature by the node key
496 pub signature: Signature,
497 /// The actual content of the announcement
498 pub contents: UnsignedNodeAnnouncement,
501 /// The unsigned part of a channel_announcement
502 #[derive(Clone, Debug, PartialEq)]
503 pub struct UnsignedChannelAnnouncement {
504 /// The advertised channel features
505 pub features: ChannelFeatures,
506 /// The genesis hash of the blockchain where the channel is to be opened
507 pub chain_hash: BlockHash,
508 /// The short channel ID
509 pub short_channel_id: u64,
510 /// One of the two node_ids which are endpoints of this channel
511 pub node_id_1: PublicKey,
512 /// The other of the two node_ids which are endpoints of this channel
513 pub node_id_2: PublicKey,
514 /// The funding key for the first node
515 pub bitcoin_key_1: PublicKey,
516 /// The funding key for the second node
517 pub bitcoin_key_2: PublicKey,
518 pub(crate) excess_data: Vec<u8>,
520 /// A channel_announcement message to be sent or received from a peer
521 #[derive(Clone, Debug, PartialEq)]
522 pub struct ChannelAnnouncement {
523 /// Authentication of the announcement by the first public node
524 pub node_signature_1: Signature,
525 /// Authentication of the announcement by the second public node
526 pub node_signature_2: Signature,
527 /// Proof of funding UTXO ownership by the first public node
528 pub bitcoin_signature_1: Signature,
529 /// Proof of funding UTXO ownership by the second public node
530 pub bitcoin_signature_2: Signature,
531 /// The actual announcement
532 pub contents: UnsignedChannelAnnouncement,
535 /// The unsigned part of a channel_update
536 #[derive(Clone, Debug, PartialEq)]
537 pub struct UnsignedChannelUpdate {
538 /// The genesis hash of the blockchain where the channel is to be opened
539 pub chain_hash: BlockHash,
540 /// The short channel ID
541 pub short_channel_id: u64,
542 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
546 /// The number of blocks to subtract from incoming HTLC cltv_expiry values
547 pub cltv_expiry_delta: u16,
548 /// The minimum HTLC size incoming to sender, in milli-satoshi
549 pub htlc_minimum_msat: u64,
550 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
551 pub htlc_maximum_msat: OptionalField<u64>,
552 /// The base HTLC fee charged by sender, in milli-satoshi
553 pub fee_base_msat: u32,
554 /// The amount to fee multiplier, in micro-satoshi
555 pub fee_proportional_millionths: u32,
556 pub(crate) excess_data: Vec<u8>,
558 /// A channel_update message to be sent or received from a peer
559 #[derive(Clone, Debug, PartialEq)]
560 pub struct ChannelUpdate {
561 /// A signature of the channel update
562 pub signature: Signature,
563 /// The actual channel update
564 pub contents: UnsignedChannelUpdate,
567 /// A query_channel_range message is used to query a peer for channel
568 /// UTXOs in a range of blocks. The recipient of a query makes a best
569 /// effort to reply to the query using one or more reply_channel_range
571 #[derive(Clone, Debug, PartialEq)]
572 pub struct QueryChannelRange {
573 /// The genesis hash of the blockchain being queried
574 pub chain_hash: BlockHash,
575 /// The height of the first block for the channel UTXOs being queried
576 pub first_blocknum: u32,
577 /// The number of blocks to include in the query results
578 pub number_of_blocks: u32,
581 /// A reply_channel_range message is a reply to a query_channel_range
582 /// message. Multiple reply_channel_range messages can be sent in reply
583 /// to a single query_channel_range message. The query recipient makes a
584 /// best effort to respond based on their local network view which may
585 /// not be a perfect view of the network. The short_channel_ids in the
586 /// reply are encoded. We only support encoding_type=0 uncompressed
587 /// serialization and do not support encoding_type=1 zlib serialization.
588 #[derive(Clone, Debug, PartialEq)]
589 pub struct ReplyChannelRange {
590 /// The genesis hash of the blockchain being queried
591 pub chain_hash: BlockHash,
592 /// The height of the first block in the range of the reply
593 pub first_blocknum: u32,
594 /// The number of blocks included in the range of the reply
595 pub number_of_blocks: u32,
596 /// True when this is the final reply for a query
597 pub sync_complete: bool,
598 /// The short_channel_ids in the channel range
599 pub short_channel_ids: Vec<u64>,
602 /// A query_short_channel_ids message is used to query a peer for
603 /// routing gossip messages related to one or more short_channel_ids.
604 /// The query recipient will reply with the latest, if available,
605 /// channel_announcement, channel_update and node_announcement messages
606 /// it maintains for the requested short_channel_ids followed by a
607 /// reply_short_channel_ids_end message. The short_channel_ids sent in
608 /// this query are encoded. We only support encoding_type=0 uncompressed
609 /// serialization and do not support encoding_type=1 zlib serialization.
610 #[derive(Clone, Debug, PartialEq)]
611 pub struct QueryShortChannelIds {
612 /// The genesis hash of the blockchain being queried
613 pub chain_hash: BlockHash,
614 /// The short_channel_ids that are being queried
615 pub short_channel_ids: Vec<u64>,
618 /// A reply_short_channel_ids_end message is sent as a reply to a
619 /// query_short_channel_ids message. The query recipient makes a best
620 /// effort to respond based on their local network view which may not be
621 /// a perfect view of the network.
622 #[derive(Clone, Debug, PartialEq)]
623 pub struct ReplyShortChannelIdsEnd {
624 /// The genesis hash of the blockchain that was queried
625 pub chain_hash: BlockHash,
626 /// Indicates if the query recipient maintains up-to-date channel
627 /// information for the chain_hash
628 pub full_information: bool,
631 /// A gossip_timestamp_filter message is used by a node to request
632 /// gossip relay for messages in the requested time range when the
633 /// gossip_queries feature has been negotiated.
634 #[derive(Clone, Debug, PartialEq)]
635 pub struct GossipTimestampFilter {
636 /// The genesis hash of the blockchain for channel and node information
637 pub chain_hash: BlockHash,
638 /// The starting unix timestamp
639 pub first_timestamp: u32,
640 /// The range of information in seconds
641 pub timestamp_range: u32,
644 /// Encoding type for data compression of collections in gossip queries.
645 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
650 /// Used to put an error message in a LightningError
651 #[derive(Clone, Debug)]
652 pub enum ErrorAction {
653 /// The peer took some action which made us think they were useless. Disconnect them.
655 /// An error message which we should make an effort to send before we disconnect.
656 msg: Option<ErrorMessage>
658 /// The peer did something harmless that we weren't able to process, just log and ignore
660 /// The peer did something incorrect. Tell them.
662 /// The message to send.
667 /// An Err type for failure to process messages.
668 #[derive(Clone, Debug)]
669 pub struct LightningError {
670 /// A human-readable message describing the error
672 /// The action which should be taken against the offending peer.
673 pub action: ErrorAction,
676 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
677 /// transaction updates if they were pending.
678 #[derive(Clone, Debug, PartialEq)]
679 pub struct CommitmentUpdate {
680 /// update_add_htlc messages which should be sent
681 pub update_add_htlcs: Vec<UpdateAddHTLC>,
682 /// update_fulfill_htlc messages which should be sent
683 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
684 /// update_fail_htlc messages which should be sent
685 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
686 /// update_fail_malformed_htlc messages which should be sent
687 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
688 /// An update_fee message which should be sent
689 pub update_fee: Option<UpdateFee>,
690 /// Finally, the commitment_signed message which should be sent
691 pub commitment_signed: CommitmentSigned,
694 /// The information we received from a peer along the route of a payment we originated. This is
695 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
696 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
697 #[derive(Clone, Debug, PartialEq)]
698 pub enum HTLCFailChannelUpdate {
699 /// We received an error which included a full ChannelUpdate message.
700 ChannelUpdateMessage {
701 /// The unwrapped message we received
704 /// We received an error which indicated only that a channel has been closed
706 /// The short_channel_id which has now closed.
707 short_channel_id: u64,
708 /// when this true, this channel should be permanently removed from the
709 /// consideration. Otherwise, this channel can be restored as new channel_update is received
712 /// We received an error which indicated only that a node has failed
714 /// The node_id that has failed.
716 /// when this true, node should be permanently removed from the
717 /// consideration. Otherwise, the channels connected to this node can be
718 /// restored as new channel_update is received
723 /// Messages could have optional fields to use with extended features
724 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
725 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
726 /// separate enum type for them.
727 /// (C-not exported) due to a free generic in T
728 #[derive(Clone, Debug, PartialEq)]
729 pub enum OptionalField<T> {
730 /// Optional field is included in message
732 /// Optional field is absent in message
736 /// A trait to describe an object which can receive channel messages.
738 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
739 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
740 pub trait ChannelMessageHandler : MessageSendEventsProvider + Send + Sync {
742 /// Handle an incoming open_channel message from the given peer.
743 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
744 /// Handle an incoming accept_channel message from the given peer.
745 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
746 /// Handle an incoming funding_created message from the given peer.
747 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
748 /// Handle an incoming funding_signed message from the given peer.
749 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
750 /// Handle an incoming funding_locked message from the given peer.
751 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
754 /// Handle an incoming shutdown message from the given peer.
755 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
756 /// Handle an incoming closing_signed message from the given peer.
757 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
760 /// Handle an incoming update_add_htlc message from the given peer.
761 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
762 /// Handle an incoming update_fulfill_htlc message from the given peer.
763 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
764 /// Handle an incoming update_fail_htlc message from the given peer.
765 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
766 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
767 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
768 /// Handle an incoming commitment_signed message from the given peer.
769 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
770 /// Handle an incoming revoke_and_ack message from the given peer.
771 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
773 /// Handle an incoming update_fee message from the given peer.
774 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
776 // Channel-to-announce:
777 /// Handle an incoming announcement_signatures message from the given peer.
778 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
780 // Connection loss/reestablish:
781 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
782 /// is believed to be possible in the future (eg they're sending us messages we don't
783 /// understand or indicate they require unknown feature bits), no_connection_possible is set
784 /// and any outstanding channels should be failed.
785 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
787 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
788 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
789 /// Handle an incoming channel_reestablish message from the given peer.
790 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
793 /// Handle an incoming error message from the given peer.
794 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
797 /// A trait to describe an object which can receive routing messages.
799 /// # Implementor DoS Warnings
801 /// For `gossip_queries` messages there are potential DoS vectors when handling
802 /// inbound queries. Implementors using an on-disk network graph should be aware of
803 /// repeated disk I/O for queries accessing different parts of the network graph.
804 pub trait RoutingMessageHandler : Send + Sync + MessageSendEventsProvider {
805 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
806 /// false or returning an Err otherwise.
807 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
808 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
809 /// or returning an Err otherwise.
810 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
811 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
812 /// false or returning an Err otherwise.
813 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
814 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
815 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
816 /// Gets a subset of the channel announcements and updates required to dump our routing table
817 /// to a remote node, starting at the short_channel_id indicated by starting_point and
818 /// including the batch_amount entries immediately higher in numerical value than starting_point.
819 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
820 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
821 /// starting at the node *after* the provided publickey and including batch_amount entries
822 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
823 /// If None is provided for starting_point, we start at the first node.
824 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
825 /// Called when a connection is established with a peer. This can be used to
826 /// perform routing table synchronization using a strategy defined by the
828 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
829 /// Handles the reply of a query we initiated to learn about channels
830 /// for a given range of blocks. We can expect to receive one or more
831 /// replies to a single query.
832 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
833 /// Handles the reply of a query we initiated asking for routing gossip
834 /// messages for a list of channels. We should receive this message when
835 /// a node has completed its best effort to send us the pertaining routing
837 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
838 /// Handles when a peer asks us to send a list of short_channel_ids
839 /// for the requested range of blocks.
840 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
841 /// Handles when a peer asks us to send routing gossip messages for a
842 /// list of short_channel_ids.
843 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
846 mod fuzzy_internal_msgs {
847 use ln::channelmanager::PaymentSecret;
849 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
850 // them from untrusted input):
852 pub(crate) struct FinalOnionHopData {
853 pub(crate) payment_secret: PaymentSecret,
854 /// The total value, in msat, of the payment as received by the ultimate recipient.
855 /// Message serialization may panic if this value is more than 21 million Bitcoin.
856 pub(crate) total_msat: u64,
859 pub(crate) enum OnionHopDataFormat {
860 Legacy { // aka Realm-0
861 short_channel_id: u64,
864 short_channel_id: u64,
867 payment_data: Option<FinalOnionHopData>,
871 pub struct OnionHopData {
872 pub(crate) format: OnionHopDataFormat,
873 /// The value, in msat, of the payment after this hop's fee is deducted.
874 /// Message serialization may panic if this value is more than 21 million Bitcoin.
875 pub(crate) amt_to_forward: u64,
876 pub(crate) outgoing_cltv_value: u32,
877 // 12 bytes of 0-padding for Legacy format
880 pub struct DecodedOnionErrorPacket {
881 pub(crate) hmac: [u8; 32],
882 pub(crate) failuremsg: Vec<u8>,
883 pub(crate) pad: Vec<u8>,
886 #[cfg(feature = "fuzztarget")]
887 pub use self::fuzzy_internal_msgs::*;
888 #[cfg(not(feature = "fuzztarget"))]
889 pub(crate) use self::fuzzy_internal_msgs::*;
892 pub(crate) struct OnionPacket {
893 pub(crate) version: u8,
894 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
895 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
896 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
897 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
898 pub(crate) hop_data: [u8; 20*65],
899 pub(crate) hmac: [u8; 32],
902 impl PartialEq for OnionPacket {
903 fn eq(&self, other: &OnionPacket) -> bool {
904 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
905 if i != j { return false; }
907 self.version == other.version &&
908 self.public_key == other.public_key &&
909 self.hmac == other.hmac
913 impl fmt::Debug for OnionPacket {
914 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
915 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
919 #[derive(Clone, Debug, PartialEq)]
920 pub(crate) struct OnionErrorPacket {
921 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
922 // (TODO) We limit it in decode to much lower...
923 pub(crate) data: Vec<u8>,
926 impl fmt::Display for DecodeError {
927 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
929 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
930 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
931 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
932 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
933 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
934 DecodeError::Io(ref e) => e.fmt(f),
939 impl From<::std::io::Error> for DecodeError {
940 fn from(e: ::std::io::Error) -> Self {
941 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
942 DecodeError::ShortRead
944 DecodeError::Io(e.kind())
949 impl Writeable for OptionalField<Script> {
950 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
952 OptionalField::Present(ref script) => {
953 // Note that Writeable for script includes the 16-bit length tag for us
956 OptionalField::Absent => {}
962 impl Readable for OptionalField<Script> {
963 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
964 match <u16 as Readable>::read(r) {
966 let mut buf = vec![0; len as usize];
967 r.read_exact(&mut buf)?;
968 Ok(OptionalField::Present(Script::from(buf)))
970 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
976 impl Writeable for OptionalField<u64> {
977 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
979 OptionalField::Present(ref value) => {
982 OptionalField::Absent => {}
988 impl Readable for OptionalField<u64> {
989 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
990 let value: u64 = Readable::read(r)?;
991 Ok(OptionalField::Present(value))
996 impl_writeable_len_match!(AcceptChannel, {
997 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1000 temporary_channel_id,
1001 dust_limit_satoshis,
1002 max_htlc_value_in_flight_msat,
1003 channel_reserve_satoshis,
1009 revocation_basepoint,
1011 delayed_payment_basepoint,
1013 first_per_commitment_point,
1014 shutdown_scriptpubkey
1017 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1024 impl Writeable for ChannelReestablish {
1025 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1026 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1027 self.channel_id.write(w)?;
1028 self.next_local_commitment_number.write(w)?;
1029 self.next_remote_commitment_number.write(w)?;
1030 match self.data_loss_protect {
1031 OptionalField::Present(ref data_loss_protect) => {
1032 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1033 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1035 OptionalField::Absent => {}
1041 impl Readable for ChannelReestablish{
1042 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1044 channel_id: Readable::read(r)?,
1045 next_local_commitment_number: Readable::read(r)?,
1046 next_remote_commitment_number: Readable::read(r)?,
1047 data_loss_protect: {
1048 match <[u8; 32] as Readable>::read(r) {
1049 Ok(your_last_per_commitment_secret) =>
1050 OptionalField::Present(DataLossProtect {
1051 your_last_per_commitment_secret,
1052 my_current_per_commitment_point: Readable::read(r)?,
1054 Err(DecodeError::ShortRead) => OptionalField::Absent,
1055 Err(e) => return Err(e)
1062 impl_writeable!(ClosingSigned, 32+8+64, {
1068 impl_writeable_len_match!(CommitmentSigned, {
1069 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1076 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1077 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1084 impl_writeable!(FundingCreated, 32+32+2+64, {
1085 temporary_channel_id,
1087 funding_output_index,
1091 impl_writeable!(FundingSigned, 32+64, {
1096 impl_writeable!(FundingLocked, 32+33, {
1098 next_per_commitment_point
1101 impl Writeable for Init {
1102 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1103 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1104 // our relevant feature bits. This keeps us compatible with old nodes.
1105 self.features.write_up_to_13(w)?;
1106 self.features.write(w)
1110 impl Readable for Init {
1111 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1112 let global_features: InitFeatures = Readable::read(r)?;
1113 let features: InitFeatures = Readable::read(r)?;
1115 features: features.or(global_features),
1120 impl_writeable_len_match!(OpenChannel, {
1121 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1125 temporary_channel_id,
1128 dust_limit_satoshis,
1129 max_htlc_value_in_flight_msat,
1130 channel_reserve_satoshis,
1136 revocation_basepoint,
1138 delayed_payment_basepoint,
1140 first_per_commitment_point,
1142 shutdown_scriptpubkey
1145 impl_writeable!(RevokeAndACK, 32+32+33, {
1147 per_commitment_secret,
1148 next_per_commitment_point
1151 impl_writeable_len_match!(Shutdown, {
1152 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1158 impl_writeable_len_match!(UpdateFailHTLC, {
1159 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1166 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1173 impl_writeable!(UpdateFee, 32+4, {
1178 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1184 impl_writeable_len_match!(OnionErrorPacket, {
1185 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1190 impl Writeable for OnionPacket {
1191 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1192 w.size_hint(1 + 33 + 20*65 + 32);
1193 self.version.write(w)?;
1194 match self.public_key {
1195 Ok(pubkey) => pubkey.write(w)?,
1196 Err(_) => [0u8;33].write(w)?,
1198 w.write_all(&self.hop_data)?;
1199 self.hmac.write(w)?;
1204 impl Readable for OnionPacket {
1205 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1207 version: Readable::read(r)?,
1209 let mut buf = [0u8;33];
1210 r.read_exact(&mut buf)?;
1211 PublicKey::from_slice(&buf)
1213 hop_data: Readable::read(r)?,
1214 hmac: Readable::read(r)?,
1219 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1225 onion_routing_packet
1228 impl Writeable for FinalOnionHopData {
1229 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1230 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1231 self.payment_secret.0.write(w)?;
1232 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1236 impl Readable for FinalOnionHopData {
1237 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1238 let secret: [u8; 32] = Readable::read(r)?;
1239 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1240 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1244 impl Writeable for OnionHopData {
1245 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1247 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1248 // check values are sane long before we get here, though its possible in the future
1249 // user-generated messages may hit this.
1250 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1252 OnionHopDataFormat::Legacy { short_channel_id } => {
1254 short_channel_id.write(w)?;
1255 self.amt_to_forward.write(w)?;
1256 self.outgoing_cltv_value.write(w)?;
1257 w.write_all(&[0;12])?;
1259 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1260 encode_varint_length_prefixed_tlv!(w, {
1261 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1262 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1263 (6, short_channel_id)
1266 OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1267 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1268 encode_varint_length_prefixed_tlv!(w, {
1269 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1270 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1274 OnionHopDataFormat::FinalNode { payment_data: None } => {
1275 encode_varint_length_prefixed_tlv!(w, {
1276 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1277 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1285 impl Readable for OnionHopData {
1286 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1287 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1288 let v: VarInt = Decodable::consensus_decode(&mut r)
1289 .map_err(|e| match e {
1290 Error::Io(ioe) => DecodeError::from(ioe),
1291 _ => DecodeError::InvalidValue
1293 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1294 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1295 let mut rd = FixedLengthReader::new(r, v.0);
1296 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1297 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1298 let mut short_id: Option<u64> = None;
1299 let mut payment_data: Option<FinalOnionHopData> = None;
1300 decode_tlv!(&mut rd, {
1307 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1308 let format = if let Some(short_channel_id) = short_id {
1309 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1310 OnionHopDataFormat::NonFinalNode {
1314 if let &Some(ref data) = &payment_data {
1315 if data.total_msat > MAX_VALUE_MSAT {
1316 return Err(DecodeError::InvalidValue);
1319 OnionHopDataFormat::FinalNode {
1323 (format, amt.0, cltv_value.0)
1325 let format = OnionHopDataFormat::Legacy {
1326 short_channel_id: Readable::read(r)?,
1328 let amt: u64 = Readable::read(r)?;
1329 let cltv_value: u32 = Readable::read(r)?;
1330 r.read_exact(&mut [0; 12])?;
1331 (format, amt, cltv_value)
1334 if amt > MAX_VALUE_MSAT {
1335 return Err(DecodeError::InvalidValue);
1339 amt_to_forward: amt,
1340 outgoing_cltv_value: cltv_value,
1345 impl Writeable for Ping {
1346 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1347 w.size_hint(self.byteslen as usize + 4);
1348 self.ponglen.write(w)?;
1349 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1354 impl Readable for Ping {
1355 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1357 ponglen: Readable::read(r)?,
1359 let byteslen = Readable::read(r)?;
1360 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1367 impl Writeable for Pong {
1368 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1369 w.size_hint(self.byteslen as usize + 2);
1370 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1375 impl Readable for Pong {
1376 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1379 let byteslen = Readable::read(r)?;
1380 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1387 impl Writeable for UnsignedChannelAnnouncement {
1388 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1389 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1390 self.features.write(w)?;
1391 self.chain_hash.write(w)?;
1392 self.short_channel_id.write(w)?;
1393 self.node_id_1.write(w)?;
1394 self.node_id_2.write(w)?;
1395 self.bitcoin_key_1.write(w)?;
1396 self.bitcoin_key_2.write(w)?;
1397 w.write_all(&self.excess_data[..])?;
1402 impl Readable for UnsignedChannelAnnouncement {
1403 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1405 features: Readable::read(r)?,
1406 chain_hash: Readable::read(r)?,
1407 short_channel_id: Readable::read(r)?,
1408 node_id_1: Readable::read(r)?,
1409 node_id_2: Readable::read(r)?,
1410 bitcoin_key_1: Readable::read(r)?,
1411 bitcoin_key_2: Readable::read(r)?,
1413 let mut excess_data = vec![];
1414 r.read_to_end(&mut excess_data)?;
1421 impl_writeable_len_match!(ChannelAnnouncement, {
1422 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1423 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1427 bitcoin_signature_1,
1428 bitcoin_signature_2,
1432 impl Writeable for UnsignedChannelUpdate {
1433 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1434 let mut size = 64 + self.excess_data.len();
1435 let mut message_flags: u8 = 0;
1436 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1441 self.chain_hash.write(w)?;
1442 self.short_channel_id.write(w)?;
1443 self.timestamp.write(w)?;
1444 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1445 all_flags.write(w)?;
1446 self.cltv_expiry_delta.write(w)?;
1447 self.htlc_minimum_msat.write(w)?;
1448 self.fee_base_msat.write(w)?;
1449 self.fee_proportional_millionths.write(w)?;
1450 self.htlc_maximum_msat.write(w)?;
1451 w.write_all(&self.excess_data[..])?;
1456 impl Readable for UnsignedChannelUpdate {
1457 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1458 let has_htlc_maximum_msat;
1460 chain_hash: Readable::read(r)?,
1461 short_channel_id: Readable::read(r)?,
1462 timestamp: Readable::read(r)?,
1464 let flags: u16 = Readable::read(r)?;
1465 let message_flags = flags >> 8;
1466 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1469 cltv_expiry_delta: Readable::read(r)?,
1470 htlc_minimum_msat: Readable::read(r)?,
1471 fee_base_msat: Readable::read(r)?,
1472 fee_proportional_millionths: Readable::read(r)?,
1473 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1475 let mut excess_data = vec![];
1476 r.read_to_end(&mut excess_data)?;
1483 impl_writeable_len_match!(ChannelUpdate, {
1484 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1485 64 + excess_data.len() + 64 }
1491 impl Writeable for ErrorMessage {
1492 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1493 w.size_hint(32 + 2 + self.data.len());
1494 self.channel_id.write(w)?;
1495 (self.data.len() as u16).write(w)?;
1496 w.write_all(self.data.as_bytes())?;
1501 impl Readable for ErrorMessage {
1502 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1504 channel_id: Readable::read(r)?,
1506 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1507 let mut data = vec![];
1508 let data_len = r.read_to_end(&mut data)?;
1509 sz = cmp::min(data_len, sz);
1510 match String::from_utf8(data[..sz as usize].to_vec()) {
1512 Err(_) => return Err(DecodeError::InvalidValue),
1519 impl Writeable for UnsignedNodeAnnouncement {
1520 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1521 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1522 self.features.write(w)?;
1523 self.timestamp.write(w)?;
1524 self.node_id.write(w)?;
1525 w.write_all(&self.rgb)?;
1526 self.alias.write(w)?;
1528 let mut addr_len = 0;
1529 for addr in self.addresses.iter() {
1530 addr_len += 1 + addr.len();
1532 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1533 for addr in self.addresses.iter() {
1536 w.write_all(&self.excess_address_data[..])?;
1537 w.write_all(&self.excess_data[..])?;
1542 impl Readable for UnsignedNodeAnnouncement {
1543 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1544 let features: NodeFeatures = Readable::read(r)?;
1545 let timestamp: u32 = Readable::read(r)?;
1546 let node_id: PublicKey = Readable::read(r)?;
1547 let mut rgb = [0; 3];
1548 r.read_exact(&mut rgb)?;
1549 let alias: [u8; 32] = Readable::read(r)?;
1551 let addr_len: u16 = Readable::read(r)?;
1552 let mut addresses: Vec<NetAddress> = Vec::new();
1553 let mut addr_readpos = 0;
1554 let mut excess = false;
1555 let mut excess_byte = 0;
1557 if addr_len <= addr_readpos { break; }
1558 match Readable::read(r) {
1560 if addr_len < addr_readpos + 1 + addr.len() {
1561 return Err(DecodeError::BadLengthDescriptor);
1563 addr_readpos += (1 + addr.len()) as u16;
1564 addresses.push(addr);
1566 Ok(Err(unknown_descriptor)) => {
1568 excess_byte = unknown_descriptor;
1571 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1572 Err(e) => return Err(e),
1576 let mut excess_data = vec![];
1577 let excess_address_data = if addr_readpos < addr_len {
1578 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1579 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1581 excess_address_data[0] = excess_byte;
1586 excess_data.push(excess_byte);
1590 r.read_to_end(&mut excess_data)?;
1591 Ok(UnsignedNodeAnnouncement {
1598 excess_address_data,
1604 impl_writeable_len_match!(NodeAnnouncement, {
1605 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1606 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1612 impl Readable for QueryShortChannelIds {
1613 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1614 let chain_hash: BlockHash = Readable::read(r)?;
1616 // We expect the encoding_len to always includes the 1-byte
1617 // encoding_type and that short_channel_ids are 8-bytes each
1618 let encoding_len: u16 = Readable::read(r)?;
1619 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1620 return Err(DecodeError::InvalidValue);
1623 // Must be encoding_type=0 uncompressed serialization. We do not
1624 // support encoding_type=1 zlib serialization.
1625 let encoding_type: u8 = Readable::read(r)?;
1626 if encoding_type != EncodingType::Uncompressed as u8 {
1627 return Err(DecodeError::InvalidValue);
1630 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1631 // less the 1-byte encoding_type
1632 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1633 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1634 for _ in 0..short_channel_id_count {
1635 short_channel_ids.push(Readable::read(r)?);
1638 Ok(QueryShortChannelIds {
1645 impl Writeable for QueryShortChannelIds {
1646 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1647 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1648 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1650 w.size_hint(32 + 2 + encoding_len as usize);
1651 self.chain_hash.write(w)?;
1652 encoding_len.write(w)?;
1654 // We only support type=0 uncompressed serialization
1655 (EncodingType::Uncompressed as u8).write(w)?;
1657 for scid in self.short_channel_ids.iter() {
1665 impl Readable for ReplyShortChannelIdsEnd {
1666 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1667 let chain_hash: BlockHash = Readable::read(r)?;
1668 let full_information: bool = Readable::read(r)?;
1669 Ok(ReplyShortChannelIdsEnd {
1676 impl Writeable for ReplyShortChannelIdsEnd {
1677 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1678 w.size_hint(32 + 1);
1679 self.chain_hash.write(w)?;
1680 self.full_information.write(w)?;
1685 impl Readable for QueryChannelRange {
1686 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1687 let chain_hash: BlockHash = Readable::read(r)?;
1688 let first_blocknum: u32 = Readable::read(r)?;
1689 let number_of_blocks: u32 = Readable::read(r)?;
1690 Ok(QueryChannelRange {
1698 impl Writeable for QueryChannelRange {
1699 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1700 w.size_hint(32 + 4 + 4);
1701 self.chain_hash.write(w)?;
1702 self.first_blocknum.write(w)?;
1703 self.number_of_blocks.write(w)?;
1708 impl Readable for ReplyChannelRange {
1709 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1710 let chain_hash: BlockHash = Readable::read(r)?;
1711 let first_blocknum: u32 = Readable::read(r)?;
1712 let number_of_blocks: u32 = Readable::read(r)?;
1713 let sync_complete: bool = Readable::read(r)?;
1715 // We expect the encoding_len to always includes the 1-byte
1716 // encoding_type and that short_channel_ids are 8-bytes each
1717 let encoding_len: u16 = Readable::read(r)?;
1718 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1719 return Err(DecodeError::InvalidValue);
1722 // Must be encoding_type=0 uncompressed serialization. We do not
1723 // support encoding_type=1 zlib serialization.
1724 let encoding_type: u8 = Readable::read(r)?;
1725 if encoding_type != EncodingType::Uncompressed as u8 {
1726 return Err(DecodeError::InvalidValue);
1729 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1730 // less the 1-byte encoding_type
1731 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1732 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1733 for _ in 0..short_channel_id_count {
1734 short_channel_ids.push(Readable::read(r)?);
1737 Ok(ReplyChannelRange {
1747 impl Writeable for ReplyChannelRange {
1748 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1749 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1750 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1751 self.chain_hash.write(w)?;
1752 self.first_blocknum.write(w)?;
1753 self.number_of_blocks.write(w)?;
1754 self.sync_complete.write(w)?;
1756 encoding_len.write(w)?;
1757 (EncodingType::Uncompressed as u8).write(w)?;
1758 for scid in self.short_channel_ids.iter() {
1766 impl Readable for GossipTimestampFilter {
1767 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1768 let chain_hash: BlockHash = Readable::read(r)?;
1769 let first_timestamp: u32 = Readable::read(r)?;
1770 let timestamp_range: u32 = Readable::read(r)?;
1771 Ok(GossipTimestampFilter {
1779 impl Writeable for GossipTimestampFilter {
1780 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1781 w.size_hint(32 + 4 + 4);
1782 self.chain_hash.write(w)?;
1783 self.first_timestamp.write(w)?;
1784 self.timestamp_range.write(w)?;
1794 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1795 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
1796 use util::ser::{Writeable, Readable};
1798 use bitcoin::hashes::hex::FromHex;
1799 use bitcoin::util::address::Address;
1800 use bitcoin::network::constants::Network;
1801 use bitcoin::blockdata::script::Builder;
1802 use bitcoin::blockdata::opcodes;
1803 use bitcoin::hash_types::{Txid, BlockHash};
1805 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1806 use bitcoin::secp256k1::{Secp256k1, Message};
1808 use std::io::Cursor;
1811 fn encoding_channel_reestablish_no_secret() {
1812 let cr = msgs::ChannelReestablish {
1813 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],
1814 next_local_commitment_number: 3,
1815 next_remote_commitment_number: 4,
1816 data_loss_protect: OptionalField::Absent,
1819 let encoded_value = cr.encode();
1822 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]
1827 fn encoding_channel_reestablish_with_secret() {
1829 let secp_ctx = Secp256k1::new();
1830 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1833 let cr = msgs::ChannelReestablish {
1834 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],
1835 next_local_commitment_number: 3,
1836 next_remote_commitment_number: 4,
1837 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1840 let encoded_value = cr.encode();
1843 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]
1847 macro_rules! get_keys_from {
1848 ($slice: expr, $secp_ctx: expr) => {
1850 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1851 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1857 macro_rules! get_sig_on {
1858 ($privkey: expr, $ctx: expr, $string: expr) => {
1860 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1861 $ctx.sign(&sighash, &$privkey)
1867 fn encoding_announcement_signatures() {
1868 let secp_ctx = Secp256k1::new();
1869 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1870 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1871 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1872 let announcement_signatures = msgs::AnnouncementSignatures {
1873 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],
1874 short_channel_id: 2316138423780173,
1875 node_signature: sig_1,
1876 bitcoin_signature: sig_2,
1879 let encoded_value = announcement_signatures.encode();
1880 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1883 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1884 let secp_ctx = Secp256k1::new();
1885 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1886 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1887 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1888 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1889 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1890 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1891 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1892 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1893 let mut features = ChannelFeatures::known();
1894 if unknown_features_bits {
1895 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1897 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1899 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1900 short_channel_id: 2316138423780173,
1901 node_id_1: pubkey_1,
1902 node_id_2: pubkey_2,
1903 bitcoin_key_1: pubkey_3,
1904 bitcoin_key_2: pubkey_4,
1905 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1907 let channel_announcement = msgs::ChannelAnnouncement {
1908 node_signature_1: sig_1,
1909 node_signature_2: sig_2,
1910 bitcoin_signature_1: sig_3,
1911 bitcoin_signature_2: sig_4,
1912 contents: unsigned_channel_announcement,
1914 let encoded_value = channel_announcement.encode();
1915 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1916 if unknown_features_bits {
1917 target_value.append(&mut hex::decode("0002ffff").unwrap());
1919 target_value.append(&mut hex::decode("0000").unwrap());
1921 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1922 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1924 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1926 assert_eq!(encoded_value, target_value);
1930 fn encoding_channel_announcement() {
1931 do_encoding_channel_announcement(true, false);
1932 do_encoding_channel_announcement(false, true);
1933 do_encoding_channel_announcement(false, false);
1934 do_encoding_channel_announcement(true, true);
1937 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1938 let secp_ctx = Secp256k1::new();
1939 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1940 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1941 let features = if unknown_features_bits {
1942 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1944 // Set to some features we may support
1945 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1947 let mut addresses = Vec::new();
1949 addresses.push(msgs::NetAddress::IPv4 {
1950 addr: [255, 254, 253, 252],
1955 addresses.push(msgs::NetAddress::IPv6 {
1956 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1961 addresses.push(msgs::NetAddress::OnionV2 {
1962 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1967 addresses.push(msgs::NetAddress::OnionV3 {
1968 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],
1974 let mut addr_len = 0;
1975 for addr in &addresses {
1976 addr_len += addr.len() + 1;
1978 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1980 timestamp: 20190119,
1985 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() },
1986 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() },
1988 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1989 let node_announcement = msgs::NodeAnnouncement {
1991 contents: unsigned_node_announcement,
1993 let encoded_value = node_announcement.encode();
1994 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1995 if unknown_features_bits {
1996 target_value.append(&mut hex::decode("0002ffff").unwrap());
1998 target_value.append(&mut hex::decode("000122").unwrap());
2000 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2001 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2003 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2006 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2009 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2012 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2014 if excess_address_data {
2015 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2018 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2020 assert_eq!(encoded_value, target_value);
2024 fn encoding_node_announcement() {
2025 do_encoding_node_announcement(true, true, true, true, true, true, true);
2026 do_encoding_node_announcement(false, false, false, false, false, false, false);
2027 do_encoding_node_announcement(false, true, false, false, false, false, false);
2028 do_encoding_node_announcement(false, false, true, false, false, false, false);
2029 do_encoding_node_announcement(false, false, false, true, false, false, false);
2030 do_encoding_node_announcement(false, false, false, false, true, false, false);
2031 do_encoding_node_announcement(false, false, false, false, false, true, false);
2032 do_encoding_node_announcement(false, true, false, true, false, true, false);
2033 do_encoding_node_announcement(false, false, true, false, true, false, false);
2036 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2037 let secp_ctx = Secp256k1::new();
2038 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2039 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2040 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2041 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2042 short_channel_id: 2316138423780173,
2043 timestamp: 20190119,
2044 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2045 cltv_expiry_delta: 144,
2046 htlc_minimum_msat: 1000000,
2047 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2048 fee_base_msat: 10000,
2049 fee_proportional_millionths: 20,
2050 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2052 let channel_update = msgs::ChannelUpdate {
2054 contents: unsigned_channel_update
2056 let encoded_value = channel_update.encode();
2057 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2058 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2059 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2060 if htlc_maximum_msat {
2061 target_value.append(&mut hex::decode("01").unwrap());
2063 target_value.append(&mut hex::decode("00").unwrap());
2065 target_value.append(&mut hex::decode("00").unwrap());
2067 let flag = target_value.last_mut().unwrap();
2071 let flag = target_value.last_mut().unwrap();
2072 *flag = *flag | 1 << 1;
2074 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2075 if htlc_maximum_msat {
2076 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2079 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2081 assert_eq!(encoded_value, target_value);
2085 fn encoding_channel_update() {
2086 do_encoding_channel_update(false, false, false, false);
2087 do_encoding_channel_update(false, false, false, true);
2088 do_encoding_channel_update(true, false, false, false);
2089 do_encoding_channel_update(true, false, false, true);
2090 do_encoding_channel_update(false, true, false, false);
2091 do_encoding_channel_update(false, true, false, true);
2092 do_encoding_channel_update(false, false, true, false);
2093 do_encoding_channel_update(false, false, true, true);
2094 do_encoding_channel_update(true, true, true, false);
2095 do_encoding_channel_update(true, true, true, true);
2098 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2099 let secp_ctx = Secp256k1::new();
2100 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2101 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2102 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2103 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2104 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2105 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2106 let open_channel = msgs::OpenChannel {
2107 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2108 temporary_channel_id: [2; 32],
2109 funding_satoshis: 1311768467284833366,
2110 push_msat: 2536655962884945560,
2111 dust_limit_satoshis: 3608586615801332854,
2112 max_htlc_value_in_flight_msat: 8517154655701053848,
2113 channel_reserve_satoshis: 8665828695742877976,
2114 htlc_minimum_msat: 2316138423780173,
2115 feerate_per_kw: 821716,
2116 to_self_delay: 49340,
2117 max_accepted_htlcs: 49340,
2118 funding_pubkey: pubkey_1,
2119 revocation_basepoint: pubkey_2,
2120 payment_point: pubkey_3,
2121 delayed_payment_basepoint: pubkey_4,
2122 htlc_basepoint: pubkey_5,
2123 first_per_commitment_point: pubkey_6,
2124 channel_flags: if random_bit { 1 << 5 } else { 0 },
2125 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2127 let encoded_value = open_channel.encode();
2128 let mut target_value = Vec::new();
2129 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2130 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2132 target_value.append(&mut hex::decode("20").unwrap());
2134 target_value.append(&mut hex::decode("00").unwrap());
2137 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2139 assert_eq!(encoded_value, target_value);
2143 fn encoding_open_channel() {
2144 do_encoding_open_channel(false, false);
2145 do_encoding_open_channel(true, false);
2146 do_encoding_open_channel(false, true);
2147 do_encoding_open_channel(true, true);
2150 fn do_encoding_accept_channel(shutdown: bool) {
2151 let secp_ctx = Secp256k1::new();
2152 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2153 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2154 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2155 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2156 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2157 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2158 let accept_channel = msgs::AcceptChannel {
2159 temporary_channel_id: [2; 32],
2160 dust_limit_satoshis: 1311768467284833366,
2161 max_htlc_value_in_flight_msat: 2536655962884945560,
2162 channel_reserve_satoshis: 3608586615801332854,
2163 htlc_minimum_msat: 2316138423780173,
2164 minimum_depth: 821716,
2165 to_self_delay: 49340,
2166 max_accepted_htlcs: 49340,
2167 funding_pubkey: pubkey_1,
2168 revocation_basepoint: pubkey_2,
2169 payment_point: pubkey_3,
2170 delayed_payment_basepoint: pubkey_4,
2171 htlc_basepoint: pubkey_5,
2172 first_per_commitment_point: pubkey_6,
2173 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2175 let encoded_value = accept_channel.encode();
2176 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2178 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2180 assert_eq!(encoded_value, target_value);
2184 fn encoding_accept_channel() {
2185 do_encoding_accept_channel(false);
2186 do_encoding_accept_channel(true);
2190 fn encoding_funding_created() {
2191 let secp_ctx = Secp256k1::new();
2192 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2193 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2194 let funding_created = msgs::FundingCreated {
2195 temporary_channel_id: [2; 32],
2196 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2197 funding_output_index: 255,
2200 let encoded_value = funding_created.encode();
2201 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2202 assert_eq!(encoded_value, target_value);
2206 fn encoding_funding_signed() {
2207 let secp_ctx = Secp256k1::new();
2208 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2209 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2210 let funding_signed = msgs::FundingSigned {
2211 channel_id: [2; 32],
2214 let encoded_value = funding_signed.encode();
2215 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2216 assert_eq!(encoded_value, target_value);
2220 fn encoding_funding_locked() {
2221 let secp_ctx = Secp256k1::new();
2222 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2223 let funding_locked = msgs::FundingLocked {
2224 channel_id: [2; 32],
2225 next_per_commitment_point: pubkey_1,
2227 let encoded_value = funding_locked.encode();
2228 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2229 assert_eq!(encoded_value, target_value);
2232 fn do_encoding_shutdown(script_type: u8) {
2233 let secp_ctx = Secp256k1::new();
2234 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2235 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2236 let shutdown = msgs::Shutdown {
2237 channel_id: [2; 32],
2239 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2240 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2241 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2242 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2244 let encoded_value = shutdown.encode();
2245 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2246 if script_type == 1 {
2247 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2248 } else if script_type == 2 {
2249 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2250 } else if script_type == 3 {
2251 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2252 } else if script_type == 4 {
2253 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2255 assert_eq!(encoded_value, target_value);
2259 fn encoding_shutdown() {
2260 do_encoding_shutdown(1);
2261 do_encoding_shutdown(2);
2262 do_encoding_shutdown(3);
2263 do_encoding_shutdown(4);
2267 fn encoding_closing_signed() {
2268 let secp_ctx = Secp256k1::new();
2269 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2270 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2271 let closing_signed = msgs::ClosingSigned {
2272 channel_id: [2; 32],
2273 fee_satoshis: 2316138423780173,
2276 let encoded_value = closing_signed.encode();
2277 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2278 assert_eq!(encoded_value, target_value);
2282 fn encoding_update_add_htlc() {
2283 let secp_ctx = Secp256k1::new();
2284 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2285 let onion_routing_packet = msgs::OnionPacket {
2287 public_key: Ok(pubkey_1),
2288 hop_data: [1; 20*65],
2291 let update_add_htlc = msgs::UpdateAddHTLC {
2292 channel_id: [2; 32],
2293 htlc_id: 2316138423780173,
2294 amount_msat: 3608586615801332854,
2295 payment_hash: PaymentHash([1; 32]),
2296 cltv_expiry: 821716,
2297 onion_routing_packet
2299 let encoded_value = update_add_htlc.encode();
2300 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2301 assert_eq!(encoded_value, target_value);
2305 fn encoding_update_fulfill_htlc() {
2306 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2307 channel_id: [2; 32],
2308 htlc_id: 2316138423780173,
2309 payment_preimage: PaymentPreimage([1; 32]),
2311 let encoded_value = update_fulfill_htlc.encode();
2312 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2313 assert_eq!(encoded_value, target_value);
2317 fn encoding_update_fail_htlc() {
2318 let reason = OnionErrorPacket {
2319 data: [1; 32].to_vec(),
2321 let update_fail_htlc = msgs::UpdateFailHTLC {
2322 channel_id: [2; 32],
2323 htlc_id: 2316138423780173,
2326 let encoded_value = update_fail_htlc.encode();
2327 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2328 assert_eq!(encoded_value, target_value);
2332 fn encoding_update_fail_malformed_htlc() {
2333 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2334 channel_id: [2; 32],
2335 htlc_id: 2316138423780173,
2336 sha256_of_onion: [1; 32],
2339 let encoded_value = update_fail_malformed_htlc.encode();
2340 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2341 assert_eq!(encoded_value, target_value);
2344 fn do_encoding_commitment_signed(htlcs: bool) {
2345 let secp_ctx = Secp256k1::new();
2346 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2347 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2348 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2349 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2350 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2351 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2352 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2353 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2354 let commitment_signed = msgs::CommitmentSigned {
2355 channel_id: [2; 32],
2357 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2359 let encoded_value = commitment_signed.encode();
2360 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2362 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2364 target_value.append(&mut hex::decode("0000").unwrap());
2366 assert_eq!(encoded_value, target_value);
2370 fn encoding_commitment_signed() {
2371 do_encoding_commitment_signed(true);
2372 do_encoding_commitment_signed(false);
2376 fn encoding_revoke_and_ack() {
2377 let secp_ctx = Secp256k1::new();
2378 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2379 let raa = msgs::RevokeAndACK {
2380 channel_id: [2; 32],
2381 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],
2382 next_per_commitment_point: pubkey_1,
2384 let encoded_value = raa.encode();
2385 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2386 assert_eq!(encoded_value, target_value);
2390 fn encoding_update_fee() {
2391 let update_fee = msgs::UpdateFee {
2392 channel_id: [2; 32],
2393 feerate_per_kw: 20190119,
2395 let encoded_value = update_fee.encode();
2396 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2397 assert_eq!(encoded_value, target_value);
2401 fn encoding_init() {
2402 assert_eq!(msgs::Init {
2403 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2404 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2405 assert_eq!(msgs::Init {
2406 features: InitFeatures::from_le_bytes(vec![0xFF]),
2407 }.encode(), hex::decode("0001ff0001ff").unwrap());
2408 assert_eq!(msgs::Init {
2409 features: InitFeatures::from_le_bytes(vec![]),
2410 }.encode(), hex::decode("00000000").unwrap());
2414 fn encoding_error() {
2415 let error = msgs::ErrorMessage {
2416 channel_id: [2; 32],
2417 data: String::from("rust-lightning"),
2419 let encoded_value = error.encode();
2420 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2421 assert_eq!(encoded_value, target_value);
2425 fn encoding_ping() {
2426 let ping = msgs::Ping {
2430 let encoded_value = ping.encode();
2431 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2432 assert_eq!(encoded_value, target_value);
2436 fn encoding_pong() {
2437 let pong = msgs::Pong {
2440 let encoded_value = pong.encode();
2441 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2442 assert_eq!(encoded_value, target_value);
2446 fn encoding_legacy_onion_hop_data() {
2447 let msg = msgs::OnionHopData {
2448 format: OnionHopDataFormat::Legacy {
2449 short_channel_id: 0xdeadbeef1bad1dea,
2451 amt_to_forward: 0x0badf00d01020304,
2452 outgoing_cltv_value: 0xffffffff,
2454 let encoded_value = msg.encode();
2455 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2456 assert_eq!(encoded_value, target_value);
2460 fn encoding_nonfinal_onion_hop_data() {
2461 let mut msg = msgs::OnionHopData {
2462 format: OnionHopDataFormat::NonFinalNode {
2463 short_channel_id: 0xdeadbeef1bad1dea,
2465 amt_to_forward: 0x0badf00d01020304,
2466 outgoing_cltv_value: 0xffffffff,
2468 let encoded_value = msg.encode();
2469 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2470 assert_eq!(encoded_value, target_value);
2471 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2472 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2473 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2474 } else { panic!(); }
2475 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2476 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2480 fn encoding_final_onion_hop_data() {
2481 let mut msg = msgs::OnionHopData {
2482 format: OnionHopDataFormat::FinalNode {
2485 amt_to_forward: 0x0badf00d01020304,
2486 outgoing_cltv_value: 0xffffffff,
2488 let encoded_value = msg.encode();
2489 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2490 assert_eq!(encoded_value, target_value);
2491 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2492 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2493 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2494 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2498 fn encoding_final_onion_hop_data_with_secret() {
2499 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2500 let mut msg = msgs::OnionHopData {
2501 format: OnionHopDataFormat::FinalNode {
2502 payment_data: Some(FinalOnionHopData {
2503 payment_secret: expected_payment_secret,
2504 total_msat: 0x1badca1f
2507 amt_to_forward: 0x0badf00d01020304,
2508 outgoing_cltv_value: 0xffffffff,
2510 let encoded_value = msg.encode();
2511 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2512 assert_eq!(encoded_value, target_value);
2513 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2514 if let OnionHopDataFormat::FinalNode {
2515 payment_data: Some(FinalOnionHopData {
2517 total_msat: 0x1badca1f
2520 assert_eq!(payment_secret, expected_payment_secret);
2521 } else { panic!(); }
2522 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2523 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2527 fn encoding_query_channel_range() {
2528 let mut query_channel_range = msgs::QueryChannelRange {
2529 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2530 first_blocknum: 100000,
2531 number_of_blocks: 1500,
2533 let encoded_value = query_channel_range.encode();
2534 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2535 assert_eq!(encoded_value, target_value);
2537 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2538 assert_eq!(query_channel_range.first_blocknum, 100000);
2539 assert_eq!(query_channel_range.number_of_blocks, 1500);
2543 fn encoding_reply_channel_range() {
2544 do_encoding_reply_channel_range(0);
2545 do_encoding_reply_channel_range(1);
2548 fn do_encoding_reply_channel_range(encoding_type: u8) {
2549 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2550 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2551 let mut reply_channel_range = msgs::ReplyChannelRange {
2552 chain_hash: expected_chain_hash,
2553 first_blocknum: 756230,
2554 number_of_blocks: 1500,
2555 sync_complete: true,
2556 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2559 if encoding_type == 0 {
2560 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2561 let encoded_value = reply_channel_range.encode();
2562 assert_eq!(encoded_value, target_value);
2564 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2565 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2566 assert_eq!(reply_channel_range.first_blocknum, 756230);
2567 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2568 assert_eq!(reply_channel_range.sync_complete, true);
2569 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2570 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2571 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2573 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2574 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2575 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2580 fn encoding_query_short_channel_ids() {
2581 do_encoding_query_short_channel_ids(0);
2582 do_encoding_query_short_channel_ids(1);
2585 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2586 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2587 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2588 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2589 chain_hash: expected_chain_hash,
2590 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2593 if encoding_type == 0 {
2594 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2595 let encoded_value = query_short_channel_ids.encode();
2596 assert_eq!(encoded_value, target_value);
2598 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2599 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2600 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2601 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2602 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2604 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2605 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2606 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2611 fn encoding_reply_short_channel_ids_end() {
2612 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2613 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2614 chain_hash: expected_chain_hash,
2615 full_information: true,
2617 let encoded_value = reply_short_channel_ids_end.encode();
2618 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2619 assert_eq!(encoded_value, target_value);
2621 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2622 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2623 assert_eq!(reply_short_channel_ids_end.full_information, true);
2627 fn encoding_gossip_timestamp_filter(){
2628 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2629 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2630 chain_hash: expected_chain_hash,
2631 first_timestamp: 1590000000,
2632 timestamp_range: 0xffff_ffff,
2634 let encoded_value = gossip_timestamp_filter.encode();
2635 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2636 assert_eq!(encoded_value, target_value);
2638 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2639 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2640 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2641 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);