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 such that if:
547 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
548 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
549 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
550 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
551 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
552 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
553 /// constructing the route.
554 pub cltv_expiry_delta: u16,
555 /// The minimum HTLC size incoming to sender, in milli-satoshi
556 pub htlc_minimum_msat: u64,
557 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
558 pub htlc_maximum_msat: OptionalField<u64>,
559 /// The base HTLC fee charged by sender, in milli-satoshi
560 pub fee_base_msat: u32,
561 /// The amount to fee multiplier, in micro-satoshi
562 pub fee_proportional_millionths: u32,
563 pub(crate) excess_data: Vec<u8>,
565 /// A channel_update message to be sent or received from a peer
566 #[derive(Clone, Debug, PartialEq)]
567 pub struct ChannelUpdate {
568 /// A signature of the channel update
569 pub signature: Signature,
570 /// The actual channel update
571 pub contents: UnsignedChannelUpdate,
574 /// A query_channel_range message is used to query a peer for channel
575 /// UTXOs in a range of blocks. The recipient of a query makes a best
576 /// effort to reply to the query using one or more reply_channel_range
578 #[derive(Clone, Debug, PartialEq)]
579 pub struct QueryChannelRange {
580 /// The genesis hash of the blockchain being queried
581 pub chain_hash: BlockHash,
582 /// The height of the first block for the channel UTXOs being queried
583 pub first_blocknum: u32,
584 /// The number of blocks to include in the query results
585 pub number_of_blocks: u32,
588 /// A reply_channel_range message is a reply to a query_channel_range
589 /// message. Multiple reply_channel_range messages can be sent in reply
590 /// to a single query_channel_range message. The query recipient makes a
591 /// best effort to respond based on their local network view which may
592 /// not be a perfect view of the network. The short_channel_ids in the
593 /// reply are encoded. We only support encoding_type=0 uncompressed
594 /// serialization and do not support encoding_type=1 zlib serialization.
595 #[derive(Clone, Debug, PartialEq)]
596 pub struct ReplyChannelRange {
597 /// The genesis hash of the blockchain being queried
598 pub chain_hash: BlockHash,
599 /// The height of the first block in the range of the reply
600 pub first_blocknum: u32,
601 /// The number of blocks included in the range of the reply
602 pub number_of_blocks: u32,
603 /// True when this is the final reply for a query
604 pub sync_complete: bool,
605 /// The short_channel_ids in the channel range
606 pub short_channel_ids: Vec<u64>,
609 /// A query_short_channel_ids message is used to query a peer for
610 /// routing gossip messages related to one or more short_channel_ids.
611 /// The query recipient will reply with the latest, if available,
612 /// channel_announcement, channel_update and node_announcement messages
613 /// it maintains for the requested short_channel_ids followed by a
614 /// reply_short_channel_ids_end message. The short_channel_ids sent in
615 /// this query are encoded. We only support encoding_type=0 uncompressed
616 /// serialization and do not support encoding_type=1 zlib serialization.
617 #[derive(Clone, Debug, PartialEq)]
618 pub struct QueryShortChannelIds {
619 /// The genesis hash of the blockchain being queried
620 pub chain_hash: BlockHash,
621 /// The short_channel_ids that are being queried
622 pub short_channel_ids: Vec<u64>,
625 /// A reply_short_channel_ids_end message is sent as a reply to a
626 /// query_short_channel_ids message. The query recipient makes a best
627 /// effort to respond based on their local network view which may not be
628 /// a perfect view of the network.
629 #[derive(Clone, Debug, PartialEq)]
630 pub struct ReplyShortChannelIdsEnd {
631 /// The genesis hash of the blockchain that was queried
632 pub chain_hash: BlockHash,
633 /// Indicates if the query recipient maintains up-to-date channel
634 /// information for the chain_hash
635 pub full_information: bool,
638 /// A gossip_timestamp_filter message is used by a node to request
639 /// gossip relay for messages in the requested time range when the
640 /// gossip_queries feature has been negotiated.
641 #[derive(Clone, Debug, PartialEq)]
642 pub struct GossipTimestampFilter {
643 /// The genesis hash of the blockchain for channel and node information
644 pub chain_hash: BlockHash,
645 /// The starting unix timestamp
646 pub first_timestamp: u32,
647 /// The range of information in seconds
648 pub timestamp_range: u32,
651 /// Encoding type for data compression of collections in gossip queries.
652 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
657 /// Used to put an error message in a LightningError
658 #[derive(Clone, Debug)]
659 pub enum ErrorAction {
660 /// The peer took some action which made us think they were useless. Disconnect them.
662 /// An error message which we should make an effort to send before we disconnect.
663 msg: Option<ErrorMessage>
665 /// The peer did something harmless that we weren't able to process, just log and ignore
667 /// The peer did something incorrect. Tell them.
669 /// The message to send.
674 /// An Err type for failure to process messages.
675 #[derive(Clone, Debug)]
676 pub struct LightningError {
677 /// A human-readable message describing the error
679 /// The action which should be taken against the offending peer.
680 pub action: ErrorAction,
683 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
684 /// transaction updates if they were pending.
685 #[derive(Clone, Debug, PartialEq)]
686 pub struct CommitmentUpdate {
687 /// update_add_htlc messages which should be sent
688 pub update_add_htlcs: Vec<UpdateAddHTLC>,
689 /// update_fulfill_htlc messages which should be sent
690 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
691 /// update_fail_htlc messages which should be sent
692 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
693 /// update_fail_malformed_htlc messages which should be sent
694 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
695 /// An update_fee message which should be sent
696 pub update_fee: Option<UpdateFee>,
697 /// Finally, the commitment_signed message which should be sent
698 pub commitment_signed: CommitmentSigned,
701 /// The information we received from a peer along the route of a payment we originated. This is
702 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
703 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
704 #[derive(Clone, Debug, PartialEq)]
705 pub enum HTLCFailChannelUpdate {
706 /// We received an error which included a full ChannelUpdate message.
707 ChannelUpdateMessage {
708 /// The unwrapped message we received
711 /// We received an error which indicated only that a channel has been closed
713 /// The short_channel_id which has now closed.
714 short_channel_id: u64,
715 /// when this true, this channel should be permanently removed from the
716 /// consideration. Otherwise, this channel can be restored as new channel_update is received
719 /// We received an error which indicated only that a node has failed
721 /// The node_id that has failed.
723 /// when this true, node should be permanently removed from the
724 /// consideration. Otherwise, the channels connected to this node can be
725 /// restored as new channel_update is received
730 /// Messages could have optional fields to use with extended features
731 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
732 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
733 /// separate enum type for them.
734 /// (C-not exported) due to a free generic in T
735 #[derive(Clone, Debug, PartialEq)]
736 pub enum OptionalField<T> {
737 /// Optional field is included in message
739 /// Optional field is absent in message
743 /// A trait to describe an object which can receive channel messages.
745 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
746 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
747 pub trait ChannelMessageHandler : MessageSendEventsProvider + Send + Sync {
749 /// Handle an incoming open_channel message from the given peer.
750 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
751 /// Handle an incoming accept_channel message from the given peer.
752 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
753 /// Handle an incoming funding_created message from the given peer.
754 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
755 /// Handle an incoming funding_signed message from the given peer.
756 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
757 /// Handle an incoming funding_locked message from the given peer.
758 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
761 /// Handle an incoming shutdown message from the given peer.
762 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
763 /// Handle an incoming closing_signed message from the given peer.
764 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
767 /// Handle an incoming update_add_htlc message from the given peer.
768 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
769 /// Handle an incoming update_fulfill_htlc message from the given peer.
770 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
771 /// Handle an incoming update_fail_htlc message from the given peer.
772 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
773 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
774 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
775 /// Handle an incoming commitment_signed message from the given peer.
776 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
777 /// Handle an incoming revoke_and_ack message from the given peer.
778 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
780 /// Handle an incoming update_fee message from the given peer.
781 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
783 // Channel-to-announce:
784 /// Handle an incoming announcement_signatures message from the given peer.
785 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
787 // Connection loss/reestablish:
788 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
789 /// is believed to be possible in the future (eg they're sending us messages we don't
790 /// understand or indicate they require unknown feature bits), no_connection_possible is set
791 /// and any outstanding channels should be failed.
792 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
794 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
795 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
796 /// Handle an incoming channel_reestablish message from the given peer.
797 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
799 /// Handle an incoming channel update from the given peer.
800 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
803 /// Handle an incoming error message from the given peer.
804 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
807 /// A trait to describe an object which can receive routing messages.
809 /// # Implementor DoS Warnings
811 /// For `gossip_queries` messages there are potential DoS vectors when handling
812 /// inbound queries. Implementors using an on-disk network graph should be aware of
813 /// repeated disk I/O for queries accessing different parts of the network graph.
814 pub trait RoutingMessageHandler : Send + Sync + MessageSendEventsProvider {
815 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
816 /// false or returning an Err otherwise.
817 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
818 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
819 /// or returning an Err otherwise.
820 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
821 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
822 /// false or returning an Err otherwise.
823 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
824 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
825 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
826 /// Gets a subset of the channel announcements and updates required to dump our routing table
827 /// to a remote node, starting at the short_channel_id indicated by starting_point and
828 /// including the batch_amount entries immediately higher in numerical value than starting_point.
829 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
830 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
831 /// starting at the node *after* the provided publickey and including batch_amount entries
832 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
833 /// If None is provided for starting_point, we start at the first node.
834 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
835 /// Called when a connection is established with a peer. This can be used to
836 /// perform routing table synchronization using a strategy defined by the
838 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
839 /// Handles the reply of a query we initiated to learn about channels
840 /// for a given range of blocks. We can expect to receive one or more
841 /// replies to a single query.
842 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
843 /// Handles the reply of a query we initiated asking for routing gossip
844 /// messages for a list of channels. We should receive this message when
845 /// a node has completed its best effort to send us the pertaining routing
847 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
848 /// Handles when a peer asks us to send a list of short_channel_ids
849 /// for the requested range of blocks.
850 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
851 /// Handles when a peer asks us to send routing gossip messages for a
852 /// list of short_channel_ids.
853 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
856 mod fuzzy_internal_msgs {
857 use ln::channelmanager::PaymentSecret;
859 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
860 // them from untrusted input):
862 pub(crate) struct FinalOnionHopData {
863 pub(crate) payment_secret: PaymentSecret,
864 /// The total value, in msat, of the payment as received by the ultimate recipient.
865 /// Message serialization may panic if this value is more than 21 million Bitcoin.
866 pub(crate) total_msat: u64,
869 pub(crate) enum OnionHopDataFormat {
870 Legacy { // aka Realm-0
871 short_channel_id: u64,
874 short_channel_id: u64,
877 payment_data: Option<FinalOnionHopData>,
881 pub struct OnionHopData {
882 pub(crate) format: OnionHopDataFormat,
883 /// The value, in msat, of the payment after this hop's fee is deducted.
884 /// Message serialization may panic if this value is more than 21 million Bitcoin.
885 pub(crate) amt_to_forward: u64,
886 pub(crate) outgoing_cltv_value: u32,
887 // 12 bytes of 0-padding for Legacy format
890 pub struct DecodedOnionErrorPacket {
891 pub(crate) hmac: [u8; 32],
892 pub(crate) failuremsg: Vec<u8>,
893 pub(crate) pad: Vec<u8>,
896 #[cfg(feature = "fuzztarget")]
897 pub use self::fuzzy_internal_msgs::*;
898 #[cfg(not(feature = "fuzztarget"))]
899 pub(crate) use self::fuzzy_internal_msgs::*;
902 pub(crate) struct OnionPacket {
903 pub(crate) version: u8,
904 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
905 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
906 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
907 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
908 pub(crate) hop_data: [u8; 20*65],
909 pub(crate) hmac: [u8; 32],
912 impl PartialEq for OnionPacket {
913 fn eq(&self, other: &OnionPacket) -> bool {
914 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
915 if i != j { return false; }
917 self.version == other.version &&
918 self.public_key == other.public_key &&
919 self.hmac == other.hmac
923 impl fmt::Debug for OnionPacket {
924 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
925 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
929 #[derive(Clone, Debug, PartialEq)]
930 pub(crate) struct OnionErrorPacket {
931 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
932 // (TODO) We limit it in decode to much lower...
933 pub(crate) data: Vec<u8>,
936 impl fmt::Display for DecodeError {
937 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
939 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
940 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
941 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
942 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
943 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
944 DecodeError::Io(ref e) => e.fmt(f),
949 impl From<::std::io::Error> for DecodeError {
950 fn from(e: ::std::io::Error) -> Self {
951 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
952 DecodeError::ShortRead
954 DecodeError::Io(e.kind())
959 impl Writeable for OptionalField<Script> {
960 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
962 OptionalField::Present(ref script) => {
963 // Note that Writeable for script includes the 16-bit length tag for us
966 OptionalField::Absent => {}
972 impl Readable for OptionalField<Script> {
973 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
974 match <u16 as Readable>::read(r) {
976 let mut buf = vec![0; len as usize];
977 r.read_exact(&mut buf)?;
978 Ok(OptionalField::Present(Script::from(buf)))
980 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
986 impl Writeable for OptionalField<u64> {
987 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
989 OptionalField::Present(ref value) => {
992 OptionalField::Absent => {}
998 impl Readable for OptionalField<u64> {
999 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1000 let value: u64 = Readable::read(r)?;
1001 Ok(OptionalField::Present(value))
1006 impl_writeable_len_match!(AcceptChannel, {
1007 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1010 temporary_channel_id,
1011 dust_limit_satoshis,
1012 max_htlc_value_in_flight_msat,
1013 channel_reserve_satoshis,
1019 revocation_basepoint,
1021 delayed_payment_basepoint,
1023 first_per_commitment_point,
1024 shutdown_scriptpubkey
1027 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1034 impl Writeable for ChannelReestablish {
1035 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1036 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1037 self.channel_id.write(w)?;
1038 self.next_local_commitment_number.write(w)?;
1039 self.next_remote_commitment_number.write(w)?;
1040 match self.data_loss_protect {
1041 OptionalField::Present(ref data_loss_protect) => {
1042 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1043 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1045 OptionalField::Absent => {}
1051 impl Readable for ChannelReestablish{
1052 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1054 channel_id: Readable::read(r)?,
1055 next_local_commitment_number: Readable::read(r)?,
1056 next_remote_commitment_number: Readable::read(r)?,
1057 data_loss_protect: {
1058 match <[u8; 32] as Readable>::read(r) {
1059 Ok(your_last_per_commitment_secret) =>
1060 OptionalField::Present(DataLossProtect {
1061 your_last_per_commitment_secret,
1062 my_current_per_commitment_point: Readable::read(r)?,
1064 Err(DecodeError::ShortRead) => OptionalField::Absent,
1065 Err(e) => return Err(e)
1072 impl_writeable!(ClosingSigned, 32+8+64, {
1078 impl_writeable_len_match!(CommitmentSigned, {
1079 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1086 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1087 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1094 impl_writeable!(FundingCreated, 32+32+2+64, {
1095 temporary_channel_id,
1097 funding_output_index,
1101 impl_writeable!(FundingSigned, 32+64, {
1106 impl_writeable!(FundingLocked, 32+33, {
1108 next_per_commitment_point
1111 impl Writeable for Init {
1112 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1113 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1114 // our relevant feature bits. This keeps us compatible with old nodes.
1115 self.features.write_up_to_13(w)?;
1116 self.features.write(w)
1120 impl Readable for Init {
1121 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1122 let global_features: InitFeatures = Readable::read(r)?;
1123 let features: InitFeatures = Readable::read(r)?;
1125 features: features.or(global_features),
1130 impl_writeable_len_match!(OpenChannel, {
1131 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1135 temporary_channel_id,
1138 dust_limit_satoshis,
1139 max_htlc_value_in_flight_msat,
1140 channel_reserve_satoshis,
1146 revocation_basepoint,
1148 delayed_payment_basepoint,
1150 first_per_commitment_point,
1152 shutdown_scriptpubkey
1155 impl_writeable!(RevokeAndACK, 32+32+33, {
1157 per_commitment_secret,
1158 next_per_commitment_point
1161 impl_writeable_len_match!(Shutdown, {
1162 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1168 impl_writeable_len_match!(UpdateFailHTLC, {
1169 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1176 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1183 impl_writeable!(UpdateFee, 32+4, {
1188 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1194 impl_writeable_len_match!(OnionErrorPacket, {
1195 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1200 impl Writeable for OnionPacket {
1201 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1202 w.size_hint(1 + 33 + 20*65 + 32);
1203 self.version.write(w)?;
1204 match self.public_key {
1205 Ok(pubkey) => pubkey.write(w)?,
1206 Err(_) => [0u8;33].write(w)?,
1208 w.write_all(&self.hop_data)?;
1209 self.hmac.write(w)?;
1214 impl Readable for OnionPacket {
1215 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1217 version: Readable::read(r)?,
1219 let mut buf = [0u8;33];
1220 r.read_exact(&mut buf)?;
1221 PublicKey::from_slice(&buf)
1223 hop_data: Readable::read(r)?,
1224 hmac: Readable::read(r)?,
1229 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1235 onion_routing_packet
1238 impl Writeable for FinalOnionHopData {
1239 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1240 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1241 self.payment_secret.0.write(w)?;
1242 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1246 impl Readable for FinalOnionHopData {
1247 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1248 let secret: [u8; 32] = Readable::read(r)?;
1249 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1250 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1254 impl Writeable for OnionHopData {
1255 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1257 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1258 // check values are sane long before we get here, though its possible in the future
1259 // user-generated messages may hit this.
1260 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1262 OnionHopDataFormat::Legacy { short_channel_id } => {
1264 short_channel_id.write(w)?;
1265 self.amt_to_forward.write(w)?;
1266 self.outgoing_cltv_value.write(w)?;
1267 w.write_all(&[0;12])?;
1269 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1270 encode_varint_length_prefixed_tlv!(w, {
1271 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1272 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1273 (6, short_channel_id)
1276 OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1277 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1278 encode_varint_length_prefixed_tlv!(w, {
1279 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1280 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1284 OnionHopDataFormat::FinalNode { payment_data: None } => {
1285 encode_varint_length_prefixed_tlv!(w, {
1286 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1287 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1295 impl Readable for OnionHopData {
1296 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1297 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1298 let v: VarInt = Decodable::consensus_decode(&mut r)
1299 .map_err(|e| match e {
1300 Error::Io(ioe) => DecodeError::from(ioe),
1301 _ => DecodeError::InvalidValue
1303 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1304 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1305 let mut rd = FixedLengthReader::new(r, v.0);
1306 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1307 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1308 let mut short_id: Option<u64> = None;
1309 let mut payment_data: Option<FinalOnionHopData> = None;
1310 decode_tlv!(&mut rd, {
1317 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1318 let format = if let Some(short_channel_id) = short_id {
1319 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1320 OnionHopDataFormat::NonFinalNode {
1324 if let &Some(ref data) = &payment_data {
1325 if data.total_msat > MAX_VALUE_MSAT {
1326 return Err(DecodeError::InvalidValue);
1329 OnionHopDataFormat::FinalNode {
1333 (format, amt.0, cltv_value.0)
1335 let format = OnionHopDataFormat::Legacy {
1336 short_channel_id: Readable::read(r)?,
1338 let amt: u64 = Readable::read(r)?;
1339 let cltv_value: u32 = Readable::read(r)?;
1340 r.read_exact(&mut [0; 12])?;
1341 (format, amt, cltv_value)
1344 if amt > MAX_VALUE_MSAT {
1345 return Err(DecodeError::InvalidValue);
1349 amt_to_forward: amt,
1350 outgoing_cltv_value: cltv_value,
1355 impl Writeable for Ping {
1356 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1357 w.size_hint(self.byteslen as usize + 4);
1358 self.ponglen.write(w)?;
1359 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1364 impl Readable for Ping {
1365 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1367 ponglen: Readable::read(r)?,
1369 let byteslen = Readable::read(r)?;
1370 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1377 impl Writeable for Pong {
1378 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1379 w.size_hint(self.byteslen as usize + 2);
1380 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1385 impl Readable for Pong {
1386 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1389 let byteslen = Readable::read(r)?;
1390 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1397 impl Writeable for UnsignedChannelAnnouncement {
1398 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1399 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1400 self.features.write(w)?;
1401 self.chain_hash.write(w)?;
1402 self.short_channel_id.write(w)?;
1403 self.node_id_1.write(w)?;
1404 self.node_id_2.write(w)?;
1405 self.bitcoin_key_1.write(w)?;
1406 self.bitcoin_key_2.write(w)?;
1407 w.write_all(&self.excess_data[..])?;
1412 impl Readable for UnsignedChannelAnnouncement {
1413 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1415 features: Readable::read(r)?,
1416 chain_hash: Readable::read(r)?,
1417 short_channel_id: Readable::read(r)?,
1418 node_id_1: Readable::read(r)?,
1419 node_id_2: Readable::read(r)?,
1420 bitcoin_key_1: Readable::read(r)?,
1421 bitcoin_key_2: Readable::read(r)?,
1423 let mut excess_data = vec![];
1424 r.read_to_end(&mut excess_data)?;
1431 impl_writeable_len_match!(ChannelAnnouncement, {
1432 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1433 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1437 bitcoin_signature_1,
1438 bitcoin_signature_2,
1442 impl Writeable for UnsignedChannelUpdate {
1443 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1444 let mut size = 64 + self.excess_data.len();
1445 let mut message_flags: u8 = 0;
1446 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1451 self.chain_hash.write(w)?;
1452 self.short_channel_id.write(w)?;
1453 self.timestamp.write(w)?;
1454 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1455 all_flags.write(w)?;
1456 self.cltv_expiry_delta.write(w)?;
1457 self.htlc_minimum_msat.write(w)?;
1458 self.fee_base_msat.write(w)?;
1459 self.fee_proportional_millionths.write(w)?;
1460 self.htlc_maximum_msat.write(w)?;
1461 w.write_all(&self.excess_data[..])?;
1466 impl Readable for UnsignedChannelUpdate {
1467 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1468 let has_htlc_maximum_msat;
1470 chain_hash: Readable::read(r)?,
1471 short_channel_id: Readable::read(r)?,
1472 timestamp: Readable::read(r)?,
1474 let flags: u16 = Readable::read(r)?;
1475 let message_flags = flags >> 8;
1476 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1479 cltv_expiry_delta: Readable::read(r)?,
1480 htlc_minimum_msat: Readable::read(r)?,
1481 fee_base_msat: Readable::read(r)?,
1482 fee_proportional_millionths: Readable::read(r)?,
1483 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1485 let mut excess_data = vec![];
1486 r.read_to_end(&mut excess_data)?;
1493 impl_writeable_len_match!(ChannelUpdate, {
1494 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1495 64 + excess_data.len() + 64 }
1501 impl Writeable for ErrorMessage {
1502 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1503 w.size_hint(32 + 2 + self.data.len());
1504 self.channel_id.write(w)?;
1505 (self.data.len() as u16).write(w)?;
1506 w.write_all(self.data.as_bytes())?;
1511 impl Readable for ErrorMessage {
1512 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1514 channel_id: Readable::read(r)?,
1516 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1517 let mut data = vec![];
1518 let data_len = r.read_to_end(&mut data)?;
1519 sz = cmp::min(data_len, sz);
1520 match String::from_utf8(data[..sz as usize].to_vec()) {
1522 Err(_) => return Err(DecodeError::InvalidValue),
1529 impl Writeable for UnsignedNodeAnnouncement {
1530 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1531 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1532 self.features.write(w)?;
1533 self.timestamp.write(w)?;
1534 self.node_id.write(w)?;
1535 w.write_all(&self.rgb)?;
1536 self.alias.write(w)?;
1538 let mut addr_len = 0;
1539 for addr in self.addresses.iter() {
1540 addr_len += 1 + addr.len();
1542 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1543 for addr in self.addresses.iter() {
1546 w.write_all(&self.excess_address_data[..])?;
1547 w.write_all(&self.excess_data[..])?;
1552 impl Readable for UnsignedNodeAnnouncement {
1553 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1554 let features: NodeFeatures = Readable::read(r)?;
1555 let timestamp: u32 = Readable::read(r)?;
1556 let node_id: PublicKey = Readable::read(r)?;
1557 let mut rgb = [0; 3];
1558 r.read_exact(&mut rgb)?;
1559 let alias: [u8; 32] = Readable::read(r)?;
1561 let addr_len: u16 = Readable::read(r)?;
1562 let mut addresses: Vec<NetAddress> = Vec::new();
1563 let mut addr_readpos = 0;
1564 let mut excess = false;
1565 let mut excess_byte = 0;
1567 if addr_len <= addr_readpos { break; }
1568 match Readable::read(r) {
1570 if addr_len < addr_readpos + 1 + addr.len() {
1571 return Err(DecodeError::BadLengthDescriptor);
1573 addr_readpos += (1 + addr.len()) as u16;
1574 addresses.push(addr);
1576 Ok(Err(unknown_descriptor)) => {
1578 excess_byte = unknown_descriptor;
1581 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1582 Err(e) => return Err(e),
1586 let mut excess_data = vec![];
1587 let excess_address_data = if addr_readpos < addr_len {
1588 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1589 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1591 excess_address_data[0] = excess_byte;
1596 excess_data.push(excess_byte);
1600 r.read_to_end(&mut excess_data)?;
1601 Ok(UnsignedNodeAnnouncement {
1608 excess_address_data,
1614 impl_writeable_len_match!(NodeAnnouncement, {
1615 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1616 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1622 impl Readable for QueryShortChannelIds {
1623 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1624 let chain_hash: BlockHash = Readable::read(r)?;
1626 // We expect the encoding_len to always includes the 1-byte
1627 // encoding_type and that short_channel_ids are 8-bytes each
1628 let encoding_len: u16 = Readable::read(r)?;
1629 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1630 return Err(DecodeError::InvalidValue);
1633 // Must be encoding_type=0 uncompressed serialization. We do not
1634 // support encoding_type=1 zlib serialization.
1635 let encoding_type: u8 = Readable::read(r)?;
1636 if encoding_type != EncodingType::Uncompressed as u8 {
1637 return Err(DecodeError::InvalidValue);
1640 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1641 // less the 1-byte encoding_type
1642 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1643 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1644 for _ in 0..short_channel_id_count {
1645 short_channel_ids.push(Readable::read(r)?);
1648 Ok(QueryShortChannelIds {
1655 impl Writeable for QueryShortChannelIds {
1656 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1657 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1658 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1660 w.size_hint(32 + 2 + encoding_len as usize);
1661 self.chain_hash.write(w)?;
1662 encoding_len.write(w)?;
1664 // We only support type=0 uncompressed serialization
1665 (EncodingType::Uncompressed as u8).write(w)?;
1667 for scid in self.short_channel_ids.iter() {
1675 impl Readable for ReplyShortChannelIdsEnd {
1676 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1677 let chain_hash: BlockHash = Readable::read(r)?;
1678 let full_information: bool = Readable::read(r)?;
1679 Ok(ReplyShortChannelIdsEnd {
1686 impl Writeable for ReplyShortChannelIdsEnd {
1687 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1688 w.size_hint(32 + 1);
1689 self.chain_hash.write(w)?;
1690 self.full_information.write(w)?;
1695 impl QueryChannelRange {
1697 * Calculates the overflow safe ending block height for the query.
1698 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1700 pub fn end_blocknum(&self) -> u32 {
1701 match self.first_blocknum.checked_add(self.number_of_blocks) {
1702 Some(block) => block,
1703 None => u32::max_value(),
1708 impl Readable for QueryChannelRange {
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 Ok(QueryChannelRange {
1721 impl Writeable for QueryChannelRange {
1722 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1723 w.size_hint(32 + 4 + 4);
1724 self.chain_hash.write(w)?;
1725 self.first_blocknum.write(w)?;
1726 self.number_of_blocks.write(w)?;
1731 impl Readable for ReplyChannelRange {
1732 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1733 let chain_hash: BlockHash = Readable::read(r)?;
1734 let first_blocknum: u32 = Readable::read(r)?;
1735 let number_of_blocks: u32 = Readable::read(r)?;
1736 let sync_complete: bool = Readable::read(r)?;
1738 // We expect the encoding_len to always includes the 1-byte
1739 // encoding_type and that short_channel_ids are 8-bytes each
1740 let encoding_len: u16 = Readable::read(r)?;
1741 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1742 return Err(DecodeError::InvalidValue);
1745 // Must be encoding_type=0 uncompressed serialization. We do not
1746 // support encoding_type=1 zlib serialization.
1747 let encoding_type: u8 = Readable::read(r)?;
1748 if encoding_type != EncodingType::Uncompressed as u8 {
1749 return Err(DecodeError::InvalidValue);
1752 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1753 // less the 1-byte encoding_type
1754 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1755 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1756 for _ in 0..short_channel_id_count {
1757 short_channel_ids.push(Readable::read(r)?);
1760 Ok(ReplyChannelRange {
1770 impl Writeable for ReplyChannelRange {
1771 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1772 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1773 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1774 self.chain_hash.write(w)?;
1775 self.first_blocknum.write(w)?;
1776 self.number_of_blocks.write(w)?;
1777 self.sync_complete.write(w)?;
1779 encoding_len.write(w)?;
1780 (EncodingType::Uncompressed as u8).write(w)?;
1781 for scid in self.short_channel_ids.iter() {
1789 impl Readable for GossipTimestampFilter {
1790 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1791 let chain_hash: BlockHash = Readable::read(r)?;
1792 let first_timestamp: u32 = Readable::read(r)?;
1793 let timestamp_range: u32 = Readable::read(r)?;
1794 Ok(GossipTimestampFilter {
1802 impl Writeable for GossipTimestampFilter {
1803 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1804 w.size_hint(32 + 4 + 4);
1805 self.chain_hash.write(w)?;
1806 self.first_timestamp.write(w)?;
1807 self.timestamp_range.write(w)?;
1817 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1818 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
1819 use util::ser::{Writeable, Readable};
1821 use bitcoin::hashes::hex::FromHex;
1822 use bitcoin::util::address::Address;
1823 use bitcoin::network::constants::Network;
1824 use bitcoin::blockdata::script::Builder;
1825 use bitcoin::blockdata::opcodes;
1826 use bitcoin::hash_types::{Txid, BlockHash};
1828 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1829 use bitcoin::secp256k1::{Secp256k1, Message};
1831 use std::io::Cursor;
1834 fn encoding_channel_reestablish_no_secret() {
1835 let cr = msgs::ChannelReestablish {
1836 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],
1837 next_local_commitment_number: 3,
1838 next_remote_commitment_number: 4,
1839 data_loss_protect: OptionalField::Absent,
1842 let encoded_value = cr.encode();
1845 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]
1850 fn encoding_channel_reestablish_with_secret() {
1852 let secp_ctx = Secp256k1::new();
1853 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1856 let cr = msgs::ChannelReestablish {
1857 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],
1858 next_local_commitment_number: 3,
1859 next_remote_commitment_number: 4,
1860 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1863 let encoded_value = cr.encode();
1866 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]
1870 macro_rules! get_keys_from {
1871 ($slice: expr, $secp_ctx: expr) => {
1873 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1874 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1880 macro_rules! get_sig_on {
1881 ($privkey: expr, $ctx: expr, $string: expr) => {
1883 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1884 $ctx.sign(&sighash, &$privkey)
1890 fn encoding_announcement_signatures() {
1891 let secp_ctx = Secp256k1::new();
1892 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1893 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1894 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1895 let announcement_signatures = msgs::AnnouncementSignatures {
1896 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],
1897 short_channel_id: 2316138423780173,
1898 node_signature: sig_1,
1899 bitcoin_signature: sig_2,
1902 let encoded_value = announcement_signatures.encode();
1903 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1906 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1907 let secp_ctx = Secp256k1::new();
1908 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1909 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1910 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1911 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1912 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1913 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1914 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1915 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1916 let mut features = ChannelFeatures::known();
1917 if unknown_features_bits {
1918 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1920 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1922 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1923 short_channel_id: 2316138423780173,
1924 node_id_1: pubkey_1,
1925 node_id_2: pubkey_2,
1926 bitcoin_key_1: pubkey_3,
1927 bitcoin_key_2: pubkey_4,
1928 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1930 let channel_announcement = msgs::ChannelAnnouncement {
1931 node_signature_1: sig_1,
1932 node_signature_2: sig_2,
1933 bitcoin_signature_1: sig_3,
1934 bitcoin_signature_2: sig_4,
1935 contents: unsigned_channel_announcement,
1937 let encoded_value = channel_announcement.encode();
1938 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1939 if unknown_features_bits {
1940 target_value.append(&mut hex::decode("0002ffff").unwrap());
1942 target_value.append(&mut hex::decode("0000").unwrap());
1944 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1945 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1947 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1949 assert_eq!(encoded_value, target_value);
1953 fn encoding_channel_announcement() {
1954 do_encoding_channel_announcement(true, false);
1955 do_encoding_channel_announcement(false, true);
1956 do_encoding_channel_announcement(false, false);
1957 do_encoding_channel_announcement(true, true);
1960 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1961 let secp_ctx = Secp256k1::new();
1962 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1963 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1964 let features = if unknown_features_bits {
1965 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1967 // Set to some features we may support
1968 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1970 let mut addresses = Vec::new();
1972 addresses.push(msgs::NetAddress::IPv4 {
1973 addr: [255, 254, 253, 252],
1978 addresses.push(msgs::NetAddress::IPv6 {
1979 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1984 addresses.push(msgs::NetAddress::OnionV2 {
1985 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1990 addresses.push(msgs::NetAddress::OnionV3 {
1991 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],
1997 let mut addr_len = 0;
1998 for addr in &addresses {
1999 addr_len += addr.len() + 1;
2001 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2003 timestamp: 20190119,
2008 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() },
2009 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() },
2011 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2012 let node_announcement = msgs::NodeAnnouncement {
2014 contents: unsigned_node_announcement,
2016 let encoded_value = node_announcement.encode();
2017 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2018 if unknown_features_bits {
2019 target_value.append(&mut hex::decode("0002ffff").unwrap());
2021 target_value.append(&mut hex::decode("000122").unwrap());
2023 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2024 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2026 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2029 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2032 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2035 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2037 if excess_address_data {
2038 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2041 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2043 assert_eq!(encoded_value, target_value);
2047 fn encoding_node_announcement() {
2048 do_encoding_node_announcement(true, true, true, true, true, true, true);
2049 do_encoding_node_announcement(false, false, false, false, false, false, false);
2050 do_encoding_node_announcement(false, true, false, false, false, false, false);
2051 do_encoding_node_announcement(false, false, true, false, false, false, false);
2052 do_encoding_node_announcement(false, false, false, true, false, false, false);
2053 do_encoding_node_announcement(false, false, false, false, true, false, false);
2054 do_encoding_node_announcement(false, false, false, false, false, true, false);
2055 do_encoding_node_announcement(false, true, false, true, false, true, false);
2056 do_encoding_node_announcement(false, false, true, false, true, false, false);
2059 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2060 let secp_ctx = Secp256k1::new();
2061 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2062 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2063 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2064 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2065 short_channel_id: 2316138423780173,
2066 timestamp: 20190119,
2067 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2068 cltv_expiry_delta: 144,
2069 htlc_minimum_msat: 1000000,
2070 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2071 fee_base_msat: 10000,
2072 fee_proportional_millionths: 20,
2073 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2075 let channel_update = msgs::ChannelUpdate {
2077 contents: unsigned_channel_update
2079 let encoded_value = channel_update.encode();
2080 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2081 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2082 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2083 if htlc_maximum_msat {
2084 target_value.append(&mut hex::decode("01").unwrap());
2086 target_value.append(&mut hex::decode("00").unwrap());
2088 target_value.append(&mut hex::decode("00").unwrap());
2090 let flag = target_value.last_mut().unwrap();
2094 let flag = target_value.last_mut().unwrap();
2095 *flag = *flag | 1 << 1;
2097 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2098 if htlc_maximum_msat {
2099 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2102 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2104 assert_eq!(encoded_value, target_value);
2108 fn encoding_channel_update() {
2109 do_encoding_channel_update(false, false, false, false);
2110 do_encoding_channel_update(false, false, false, true);
2111 do_encoding_channel_update(true, false, false, false);
2112 do_encoding_channel_update(true, false, false, true);
2113 do_encoding_channel_update(false, true, false, false);
2114 do_encoding_channel_update(false, true, false, true);
2115 do_encoding_channel_update(false, false, true, false);
2116 do_encoding_channel_update(false, false, true, true);
2117 do_encoding_channel_update(true, true, true, false);
2118 do_encoding_channel_update(true, true, true, true);
2121 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2122 let secp_ctx = Secp256k1::new();
2123 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2124 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2125 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2126 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2127 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2128 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2129 let open_channel = msgs::OpenChannel {
2130 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2131 temporary_channel_id: [2; 32],
2132 funding_satoshis: 1311768467284833366,
2133 push_msat: 2536655962884945560,
2134 dust_limit_satoshis: 3608586615801332854,
2135 max_htlc_value_in_flight_msat: 8517154655701053848,
2136 channel_reserve_satoshis: 8665828695742877976,
2137 htlc_minimum_msat: 2316138423780173,
2138 feerate_per_kw: 821716,
2139 to_self_delay: 49340,
2140 max_accepted_htlcs: 49340,
2141 funding_pubkey: pubkey_1,
2142 revocation_basepoint: pubkey_2,
2143 payment_point: pubkey_3,
2144 delayed_payment_basepoint: pubkey_4,
2145 htlc_basepoint: pubkey_5,
2146 first_per_commitment_point: pubkey_6,
2147 channel_flags: if random_bit { 1 << 5 } else { 0 },
2148 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2150 let encoded_value = open_channel.encode();
2151 let mut target_value = Vec::new();
2152 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2153 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2155 target_value.append(&mut hex::decode("20").unwrap());
2157 target_value.append(&mut hex::decode("00").unwrap());
2160 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2162 assert_eq!(encoded_value, target_value);
2166 fn encoding_open_channel() {
2167 do_encoding_open_channel(false, false);
2168 do_encoding_open_channel(true, false);
2169 do_encoding_open_channel(false, true);
2170 do_encoding_open_channel(true, true);
2173 fn do_encoding_accept_channel(shutdown: bool) {
2174 let secp_ctx = Secp256k1::new();
2175 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2176 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2177 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2178 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2179 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2180 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2181 let accept_channel = msgs::AcceptChannel {
2182 temporary_channel_id: [2; 32],
2183 dust_limit_satoshis: 1311768467284833366,
2184 max_htlc_value_in_flight_msat: 2536655962884945560,
2185 channel_reserve_satoshis: 3608586615801332854,
2186 htlc_minimum_msat: 2316138423780173,
2187 minimum_depth: 821716,
2188 to_self_delay: 49340,
2189 max_accepted_htlcs: 49340,
2190 funding_pubkey: pubkey_1,
2191 revocation_basepoint: pubkey_2,
2192 payment_point: pubkey_3,
2193 delayed_payment_basepoint: pubkey_4,
2194 htlc_basepoint: pubkey_5,
2195 first_per_commitment_point: pubkey_6,
2196 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2198 let encoded_value = accept_channel.encode();
2199 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2201 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2203 assert_eq!(encoded_value, target_value);
2207 fn encoding_accept_channel() {
2208 do_encoding_accept_channel(false);
2209 do_encoding_accept_channel(true);
2213 fn encoding_funding_created() {
2214 let secp_ctx = Secp256k1::new();
2215 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2216 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2217 let funding_created = msgs::FundingCreated {
2218 temporary_channel_id: [2; 32],
2219 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2220 funding_output_index: 255,
2223 let encoded_value = funding_created.encode();
2224 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2225 assert_eq!(encoded_value, target_value);
2229 fn encoding_funding_signed() {
2230 let secp_ctx = Secp256k1::new();
2231 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2232 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2233 let funding_signed = msgs::FundingSigned {
2234 channel_id: [2; 32],
2237 let encoded_value = funding_signed.encode();
2238 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2239 assert_eq!(encoded_value, target_value);
2243 fn encoding_funding_locked() {
2244 let secp_ctx = Secp256k1::new();
2245 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2246 let funding_locked = msgs::FundingLocked {
2247 channel_id: [2; 32],
2248 next_per_commitment_point: pubkey_1,
2250 let encoded_value = funding_locked.encode();
2251 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2252 assert_eq!(encoded_value, target_value);
2255 fn do_encoding_shutdown(script_type: u8) {
2256 let secp_ctx = Secp256k1::new();
2257 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2258 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2259 let shutdown = msgs::Shutdown {
2260 channel_id: [2; 32],
2262 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2263 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2264 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2265 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2267 let encoded_value = shutdown.encode();
2268 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2269 if script_type == 1 {
2270 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2271 } else if script_type == 2 {
2272 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2273 } else if script_type == 3 {
2274 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2275 } else if script_type == 4 {
2276 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2278 assert_eq!(encoded_value, target_value);
2282 fn encoding_shutdown() {
2283 do_encoding_shutdown(1);
2284 do_encoding_shutdown(2);
2285 do_encoding_shutdown(3);
2286 do_encoding_shutdown(4);
2290 fn encoding_closing_signed() {
2291 let secp_ctx = Secp256k1::new();
2292 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2293 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2294 let closing_signed = msgs::ClosingSigned {
2295 channel_id: [2; 32],
2296 fee_satoshis: 2316138423780173,
2299 let encoded_value = closing_signed.encode();
2300 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2301 assert_eq!(encoded_value, target_value);
2305 fn encoding_update_add_htlc() {
2306 let secp_ctx = Secp256k1::new();
2307 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2308 let onion_routing_packet = msgs::OnionPacket {
2310 public_key: Ok(pubkey_1),
2311 hop_data: [1; 20*65],
2314 let update_add_htlc = msgs::UpdateAddHTLC {
2315 channel_id: [2; 32],
2316 htlc_id: 2316138423780173,
2317 amount_msat: 3608586615801332854,
2318 payment_hash: PaymentHash([1; 32]),
2319 cltv_expiry: 821716,
2320 onion_routing_packet
2322 let encoded_value = update_add_htlc.encode();
2323 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2324 assert_eq!(encoded_value, target_value);
2328 fn encoding_update_fulfill_htlc() {
2329 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2330 channel_id: [2; 32],
2331 htlc_id: 2316138423780173,
2332 payment_preimage: PaymentPreimage([1; 32]),
2334 let encoded_value = update_fulfill_htlc.encode();
2335 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2336 assert_eq!(encoded_value, target_value);
2340 fn encoding_update_fail_htlc() {
2341 let reason = OnionErrorPacket {
2342 data: [1; 32].to_vec(),
2344 let update_fail_htlc = msgs::UpdateFailHTLC {
2345 channel_id: [2; 32],
2346 htlc_id: 2316138423780173,
2349 let encoded_value = update_fail_htlc.encode();
2350 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2351 assert_eq!(encoded_value, target_value);
2355 fn encoding_update_fail_malformed_htlc() {
2356 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2357 channel_id: [2; 32],
2358 htlc_id: 2316138423780173,
2359 sha256_of_onion: [1; 32],
2362 let encoded_value = update_fail_malformed_htlc.encode();
2363 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2364 assert_eq!(encoded_value, target_value);
2367 fn do_encoding_commitment_signed(htlcs: bool) {
2368 let secp_ctx = Secp256k1::new();
2369 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2370 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2371 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2372 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2373 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2374 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2375 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2376 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2377 let commitment_signed = msgs::CommitmentSigned {
2378 channel_id: [2; 32],
2380 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2382 let encoded_value = commitment_signed.encode();
2383 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2385 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2387 target_value.append(&mut hex::decode("0000").unwrap());
2389 assert_eq!(encoded_value, target_value);
2393 fn encoding_commitment_signed() {
2394 do_encoding_commitment_signed(true);
2395 do_encoding_commitment_signed(false);
2399 fn encoding_revoke_and_ack() {
2400 let secp_ctx = Secp256k1::new();
2401 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2402 let raa = msgs::RevokeAndACK {
2403 channel_id: [2; 32],
2404 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],
2405 next_per_commitment_point: pubkey_1,
2407 let encoded_value = raa.encode();
2408 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2409 assert_eq!(encoded_value, target_value);
2413 fn encoding_update_fee() {
2414 let update_fee = msgs::UpdateFee {
2415 channel_id: [2; 32],
2416 feerate_per_kw: 20190119,
2418 let encoded_value = update_fee.encode();
2419 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2420 assert_eq!(encoded_value, target_value);
2424 fn encoding_init() {
2425 assert_eq!(msgs::Init {
2426 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2427 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2428 assert_eq!(msgs::Init {
2429 features: InitFeatures::from_le_bytes(vec![0xFF]),
2430 }.encode(), hex::decode("0001ff0001ff").unwrap());
2431 assert_eq!(msgs::Init {
2432 features: InitFeatures::from_le_bytes(vec![]),
2433 }.encode(), hex::decode("00000000").unwrap());
2437 fn encoding_error() {
2438 let error = msgs::ErrorMessage {
2439 channel_id: [2; 32],
2440 data: String::from("rust-lightning"),
2442 let encoded_value = error.encode();
2443 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2444 assert_eq!(encoded_value, target_value);
2448 fn encoding_ping() {
2449 let ping = msgs::Ping {
2453 let encoded_value = ping.encode();
2454 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2455 assert_eq!(encoded_value, target_value);
2459 fn encoding_pong() {
2460 let pong = msgs::Pong {
2463 let encoded_value = pong.encode();
2464 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2465 assert_eq!(encoded_value, target_value);
2469 fn encoding_legacy_onion_hop_data() {
2470 let msg = msgs::OnionHopData {
2471 format: OnionHopDataFormat::Legacy {
2472 short_channel_id: 0xdeadbeef1bad1dea,
2474 amt_to_forward: 0x0badf00d01020304,
2475 outgoing_cltv_value: 0xffffffff,
2477 let encoded_value = msg.encode();
2478 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2479 assert_eq!(encoded_value, target_value);
2483 fn encoding_nonfinal_onion_hop_data() {
2484 let mut msg = msgs::OnionHopData {
2485 format: OnionHopDataFormat::NonFinalNode {
2486 short_channel_id: 0xdeadbeef1bad1dea,
2488 amt_to_forward: 0x0badf00d01020304,
2489 outgoing_cltv_value: 0xffffffff,
2491 let encoded_value = msg.encode();
2492 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2493 assert_eq!(encoded_value, target_value);
2494 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2495 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2496 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2497 } else { panic!(); }
2498 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2499 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2503 fn encoding_final_onion_hop_data() {
2504 let mut msg = msgs::OnionHopData {
2505 format: OnionHopDataFormat::FinalNode {
2508 amt_to_forward: 0x0badf00d01020304,
2509 outgoing_cltv_value: 0xffffffff,
2511 let encoded_value = msg.encode();
2512 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2513 assert_eq!(encoded_value, target_value);
2514 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2515 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2516 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2517 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2521 fn encoding_final_onion_hop_data_with_secret() {
2522 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2523 let mut msg = msgs::OnionHopData {
2524 format: OnionHopDataFormat::FinalNode {
2525 payment_data: Some(FinalOnionHopData {
2526 payment_secret: expected_payment_secret,
2527 total_msat: 0x1badca1f
2530 amt_to_forward: 0x0badf00d01020304,
2531 outgoing_cltv_value: 0xffffffff,
2533 let encoded_value = msg.encode();
2534 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2535 assert_eq!(encoded_value, target_value);
2536 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2537 if let OnionHopDataFormat::FinalNode {
2538 payment_data: Some(FinalOnionHopData {
2540 total_msat: 0x1badca1f
2543 assert_eq!(payment_secret, expected_payment_secret);
2544 } else { panic!(); }
2545 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2546 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2550 fn query_channel_range_end_blocknum() {
2551 let tests: Vec<(u32, u32, u32)> = vec![
2552 (10000, 1500, 11500),
2553 (0, 0xffffffff, 0xffffffff),
2554 (1, 0xffffffff, 0xffffffff),
2557 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2558 let sut = msgs::QueryChannelRange {
2559 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2563 assert_eq!(sut.end_blocknum(), expected);
2568 fn encoding_query_channel_range() {
2569 let mut query_channel_range = msgs::QueryChannelRange {
2570 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2571 first_blocknum: 100000,
2572 number_of_blocks: 1500,
2574 let encoded_value = query_channel_range.encode();
2575 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2576 assert_eq!(encoded_value, target_value);
2578 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2579 assert_eq!(query_channel_range.first_blocknum, 100000);
2580 assert_eq!(query_channel_range.number_of_blocks, 1500);
2584 fn encoding_reply_channel_range() {
2585 do_encoding_reply_channel_range(0);
2586 do_encoding_reply_channel_range(1);
2589 fn do_encoding_reply_channel_range(encoding_type: u8) {
2590 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2591 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2592 let mut reply_channel_range = msgs::ReplyChannelRange {
2593 chain_hash: expected_chain_hash,
2594 first_blocknum: 756230,
2595 number_of_blocks: 1500,
2596 sync_complete: true,
2597 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2600 if encoding_type == 0 {
2601 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2602 let encoded_value = reply_channel_range.encode();
2603 assert_eq!(encoded_value, target_value);
2605 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2606 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2607 assert_eq!(reply_channel_range.first_blocknum, 756230);
2608 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2609 assert_eq!(reply_channel_range.sync_complete, true);
2610 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2611 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2612 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2614 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2615 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2616 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2621 fn encoding_query_short_channel_ids() {
2622 do_encoding_query_short_channel_ids(0);
2623 do_encoding_query_short_channel_ids(1);
2626 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2627 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2628 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2629 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2630 chain_hash: expected_chain_hash,
2631 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2634 if encoding_type == 0 {
2635 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2636 let encoded_value = query_short_channel_ids.encode();
2637 assert_eq!(encoded_value, target_value);
2639 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2640 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2641 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2642 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2643 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2645 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2646 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2647 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2652 fn encoding_reply_short_channel_ids_end() {
2653 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2654 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2655 chain_hash: expected_chain_hash,
2656 full_information: true,
2658 let encoded_value = reply_short_channel_ids_end.encode();
2659 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2660 assert_eq!(encoded_value, target_value);
2662 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2663 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2664 assert_eq!(reply_short_channel_ids_end.full_information, true);
2668 fn encoding_gossip_timestamp_filter(){
2669 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2670 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2671 chain_hash: expected_chain_hash,
2672 first_timestamp: 1590000000,
2673 timestamp_range: 0xffff_ffff,
2675 let encoded_value = gossip_timestamp_filter.encode();
2676 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2677 assert_eq!(encoded_value, target_value);
2679 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2680 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2681 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2682 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);