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 io_extras::read_to_end;
41 use util::events::MessageSendEventsProvider;
43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
47 /// 21 million * 10^8 * 1000
48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
50 /// An error in decoding a message or struct.
51 #[derive(Clone, Debug, PartialEq)]
52 pub enum DecodeError {
53 /// A version byte specified something we don't know how to handle.
54 /// Includes unknown realm byte in an OnionHopData packet
56 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
57 UnknownRequiredFeature,
58 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
59 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
60 /// syntactically incorrect, etc
64 /// A length descriptor in the packet didn't describe the later data correctly
66 /// Error from std::io
67 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
69 /// The message included zlib-compressed values, which we don't support.
70 UnsupportedCompression,
73 /// An init message to be sent or received from a peer
74 #[derive(Clone, Debug, PartialEq)]
76 /// The relevant features which the sender supports
77 pub features: InitFeatures,
80 /// An error message to be sent or received from a peer
81 #[derive(Clone, Debug, PartialEq)]
82 pub struct ErrorMessage {
83 /// The channel ID involved in the error
84 pub channel_id: [u8; 32],
85 /// A possibly human-readable error description.
86 /// The string should be sanitized before it is used (e.g. emitted to logs
87 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
88 /// vulnerability in the terminal emulator or the logging subsystem.
92 /// A ping message to be sent or received from a peer
93 #[derive(Clone, Debug, PartialEq)]
95 /// The desired response length
97 /// The ping packet size.
98 /// This field is not sent on the wire. byteslen zeros are sent.
102 /// A pong message to be sent or received from a peer
103 #[derive(Clone, Debug, PartialEq)]
105 /// The pong packet size.
106 /// This field is not sent on the wire. byteslen zeros are sent.
110 /// An open_channel message to be sent or received from a peer
111 #[derive(Clone, Debug, PartialEq)]
112 pub struct OpenChannel {
113 /// The genesis hash of the blockchain where the channel is to be opened
114 pub chain_hash: BlockHash,
115 /// A temporary channel ID, until the funding outpoint is announced
116 pub temporary_channel_id: [u8; 32],
117 /// The channel value
118 pub funding_satoshis: u64,
119 /// The amount to push to the counterparty as part of the open, in milli-satoshi
121 /// The threshold below which outputs on transactions broadcast by sender will be omitted
122 pub dust_limit_satoshis: u64,
123 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
124 pub max_htlc_value_in_flight_msat: u64,
125 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
126 pub channel_reserve_satoshis: u64,
127 /// The minimum HTLC size incoming to sender, in milli-satoshi
128 pub htlc_minimum_msat: u64,
129 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
130 pub feerate_per_kw: u32,
131 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
132 pub to_self_delay: u16,
133 /// The maximum number of inbound HTLCs towards sender
134 pub max_accepted_htlcs: u16,
135 /// The sender's key controlling the funding transaction
136 pub funding_pubkey: PublicKey,
137 /// Used to derive a revocation key for transactions broadcast by counterparty
138 pub revocation_basepoint: PublicKey,
139 /// A payment key to sender for transactions broadcast by counterparty
140 pub payment_point: PublicKey,
141 /// Used to derive a payment key to sender for transactions broadcast by sender
142 pub delayed_payment_basepoint: PublicKey,
143 /// Used to derive an HTLC payment key to sender
144 pub htlc_basepoint: PublicKey,
145 /// The first to-be-broadcast-by-sender transaction's per commitment point
146 pub first_per_commitment_point: PublicKey,
148 pub channel_flags: u8,
149 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
150 pub shutdown_scriptpubkey: OptionalField<Script>,
153 /// An accept_channel message to be sent or received from a peer
154 #[derive(Clone, Debug, PartialEq)]
155 pub struct AcceptChannel {
156 /// A temporary channel ID, until the funding outpoint is announced
157 pub temporary_channel_id: [u8; 32],
158 /// The threshold below which outputs on transactions broadcast by sender will be omitted
159 pub dust_limit_satoshis: u64,
160 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
161 pub max_htlc_value_in_flight_msat: u64,
162 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
163 pub channel_reserve_satoshis: u64,
164 /// The minimum HTLC size incoming to sender, in milli-satoshi
165 pub htlc_minimum_msat: u64,
166 /// Minimum depth of the funding transaction before the channel is considered open
167 pub minimum_depth: u32,
168 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
169 pub to_self_delay: u16,
170 /// The maximum number of inbound HTLCs towards sender
171 pub max_accepted_htlcs: u16,
172 /// The sender's key controlling the funding transaction
173 pub funding_pubkey: PublicKey,
174 /// Used to derive a revocation key for transactions broadcast by counterparty
175 pub revocation_basepoint: PublicKey,
176 /// A payment key to sender for transactions broadcast by counterparty
177 pub payment_point: PublicKey,
178 /// Used to derive a payment key to sender for transactions broadcast by sender
179 pub delayed_payment_basepoint: PublicKey,
180 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
181 pub htlc_basepoint: PublicKey,
182 /// The first to-be-broadcast-by-sender transaction's per commitment point
183 pub first_per_commitment_point: PublicKey,
184 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
185 pub shutdown_scriptpubkey: OptionalField<Script>,
188 /// A funding_created message to be sent or received from a peer
189 #[derive(Clone, Debug, PartialEq)]
190 pub struct FundingCreated {
191 /// A temporary channel ID, until the funding is established
192 pub temporary_channel_id: [u8; 32],
193 /// The funding transaction ID
194 pub funding_txid: Txid,
195 /// The specific output index funding this channel
196 pub funding_output_index: u16,
197 /// The signature of the channel initiator (funder) on the initial commitment transaction
198 pub signature: Signature,
201 /// A funding_signed message to be sent or received from a peer
202 #[derive(Clone, Debug, PartialEq)]
203 pub struct FundingSigned {
205 pub channel_id: [u8; 32],
206 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
207 pub signature: Signature,
210 /// A funding_locked message to be sent or received from a peer
211 #[derive(Clone, Debug, PartialEq)]
212 pub struct FundingLocked {
214 pub channel_id: [u8; 32],
215 /// The per-commitment point of the second commitment transaction
216 pub next_per_commitment_point: PublicKey,
219 /// A shutdown message to be sent or received from a peer
220 #[derive(Clone, Debug, PartialEq)]
221 pub struct Shutdown {
223 pub channel_id: [u8; 32],
224 /// The destination of this peer's funds on closing.
225 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
226 pub scriptpubkey: Script,
229 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
230 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
232 #[derive(Clone, Debug, PartialEq)]
233 pub struct ClosingSignedFeeRange {
234 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
236 pub min_fee_satoshis: u64,
237 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
239 pub max_fee_satoshis: u64,
242 /// A closing_signed message to be sent or received from a peer
243 #[derive(Clone, Debug, PartialEq)]
244 pub struct ClosingSigned {
246 pub channel_id: [u8; 32],
247 /// The proposed total fee for the closing transaction
248 pub fee_satoshis: u64,
249 /// A signature on the closing transaction
250 pub signature: Signature,
251 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
253 pub fee_range: Option<ClosingSignedFeeRange>,
256 /// An update_add_htlc message to be sent or received from a peer
257 #[derive(Clone, Debug, PartialEq)]
258 pub struct UpdateAddHTLC {
260 pub channel_id: [u8; 32],
263 /// The HTLC value in milli-satoshi
264 pub amount_msat: u64,
265 /// The payment hash, the pre-image of which controls HTLC redemption
266 pub payment_hash: PaymentHash,
267 /// The expiry height of the HTLC
268 pub cltv_expiry: u32,
269 pub(crate) onion_routing_packet: OnionPacket,
272 /// An update_fulfill_htlc message to be sent or received from a peer
273 #[derive(Clone, Debug, PartialEq)]
274 pub struct UpdateFulfillHTLC {
276 pub channel_id: [u8; 32],
279 /// The pre-image of the payment hash, allowing HTLC redemption
280 pub payment_preimage: PaymentPreimage,
283 /// An update_fail_htlc message to be sent or received from a peer
284 #[derive(Clone, Debug, PartialEq)]
285 pub struct UpdateFailHTLC {
287 pub channel_id: [u8; 32],
290 pub(crate) reason: OnionErrorPacket,
293 /// An update_fail_malformed_htlc message to be sent or received from a peer
294 #[derive(Clone, Debug, PartialEq)]
295 pub struct UpdateFailMalformedHTLC {
297 pub channel_id: [u8; 32],
300 pub(crate) sha256_of_onion: [u8; 32],
302 pub failure_code: u16,
305 /// A commitment_signed message to be sent or received from a peer
306 #[derive(Clone, Debug, PartialEq)]
307 pub struct CommitmentSigned {
309 pub channel_id: [u8; 32],
310 /// A signature on the commitment transaction
311 pub signature: Signature,
312 /// Signatures on the HTLC transactions
313 pub htlc_signatures: Vec<Signature>,
316 /// A revoke_and_ack message to be sent or received from a peer
317 #[derive(Clone, Debug, PartialEq)]
318 pub struct RevokeAndACK {
320 pub channel_id: [u8; 32],
321 /// The secret corresponding to the per-commitment point
322 pub per_commitment_secret: [u8; 32],
323 /// The next sender-broadcast commitment transaction's per-commitment point
324 pub next_per_commitment_point: PublicKey,
327 /// An update_fee message to be sent or received from a peer
328 #[derive(Clone, Debug, PartialEq)]
329 pub struct UpdateFee {
331 pub channel_id: [u8; 32],
332 /// Fee rate per 1000-weight of the transaction
333 pub feerate_per_kw: u32,
336 #[derive(Clone, Debug, PartialEq)]
337 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
338 /// This is used to convince the recipient that the channel is at a certain commitment
339 /// number even if they lost that data due to a local failure. Of course, the peer may lie
340 /// and even later commitments may have been revoked.
341 pub struct DataLossProtect {
342 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
343 /// belonging to the recipient
344 pub your_last_per_commitment_secret: [u8; 32],
345 /// The sender's per-commitment point for their current commitment transaction
346 pub my_current_per_commitment_point: PublicKey,
349 /// A channel_reestablish message to be sent or received from a peer
350 #[derive(Clone, Debug, PartialEq)]
351 pub struct ChannelReestablish {
353 pub channel_id: [u8; 32],
354 /// The next commitment number for the sender
355 pub next_local_commitment_number: u64,
356 /// The next commitment number for the recipient
357 pub next_remote_commitment_number: u64,
358 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
359 pub data_loss_protect: OptionalField<DataLossProtect>,
362 /// An announcement_signatures message to be sent or received from a peer
363 #[derive(Clone, Debug, PartialEq)]
364 pub struct AnnouncementSignatures {
366 pub channel_id: [u8; 32],
367 /// The short channel ID
368 pub short_channel_id: u64,
369 /// A signature by the node key
370 pub node_signature: Signature,
371 /// A signature by the funding key
372 pub bitcoin_signature: Signature,
375 /// An address which can be used to connect to a remote peer
376 #[derive(Clone, Debug, PartialEq)]
377 pub enum NetAddress {
378 /// An IPv4 address/port on which the peer is listening.
380 /// The 4-byte IPv4 address
382 /// The port on which the node is listening
385 /// An IPv6 address/port on which the peer is listening.
387 /// The 16-byte IPv6 address
389 /// The port on which the node is listening
392 /// An old-style Tor onion address/port on which the peer is listening.
394 /// The bytes (usually encoded in base32 with ".onion" appended)
396 /// The port on which the node is listening
399 /// A new-style Tor onion address/port on which the peer is listening.
400 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
401 /// wrap as base32 and append ".onion".
403 /// The ed25519 long-term public key of the peer
404 ed25519_pubkey: [u8; 32],
405 /// The checksum of the pubkey and version, as included in the onion address
407 /// The version byte, as defined by the Tor Onion v3 spec.
409 /// The port on which the node is listening
414 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
416 pub(crate) fn get_id(&self) -> u8 {
418 &NetAddress::IPv4 {..} => { 1 },
419 &NetAddress::IPv6 {..} => { 2 },
420 &NetAddress::OnionV2 {..} => { 3 },
421 &NetAddress::OnionV3 {..} => { 4 },
425 /// Strict byte-length of address descriptor, 1-byte type not recorded
426 fn len(&self) -> u16 {
428 &NetAddress::IPv4 { .. } => { 6 },
429 &NetAddress::IPv6 { .. } => { 18 },
430 &NetAddress::OnionV2 { .. } => { 12 },
431 &NetAddress::OnionV3 { .. } => { 37 },
435 /// The maximum length of any address descriptor, not including the 1-byte type
436 pub(crate) const MAX_LEN: u16 = 37;
439 impl Writeable for NetAddress {
440 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
442 &NetAddress::IPv4 { ref addr, ref port } => {
447 &NetAddress::IPv6 { ref addr, ref port } => {
452 &NetAddress::OnionV2 { ref addr, ref port } => {
457 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
459 ed25519_pubkey.write(writer)?;
460 checksum.write(writer)?;
461 version.write(writer)?;
469 impl Readable for Result<NetAddress, u8> {
470 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
471 let byte = <u8 as Readable>::read(reader)?;
474 Ok(Ok(NetAddress::IPv4 {
475 addr: Readable::read(reader)?,
476 port: Readable::read(reader)?,
480 Ok(Ok(NetAddress::IPv6 {
481 addr: Readable::read(reader)?,
482 port: Readable::read(reader)?,
486 Ok(Ok(NetAddress::OnionV2 {
487 addr: Readable::read(reader)?,
488 port: Readable::read(reader)?,
492 Ok(Ok(NetAddress::OnionV3 {
493 ed25519_pubkey: Readable::read(reader)?,
494 checksum: Readable::read(reader)?,
495 version: Readable::read(reader)?,
496 port: Readable::read(reader)?,
499 _ => return Ok(Err(byte)),
504 impl Readable for NetAddress {
505 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
506 match Readable::read(reader) {
507 Ok(Ok(res)) => Ok(res),
508 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
515 /// The unsigned part of a node_announcement
516 #[derive(Clone, Debug, PartialEq)]
517 pub struct UnsignedNodeAnnouncement {
518 /// The advertised features
519 pub features: NodeFeatures,
520 /// A strictly monotonic announcement counter, with gaps allowed
522 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
524 pub node_id: PublicKey,
525 /// An RGB color for UI purposes
527 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
530 /// List of addresses on which this node is reachable
531 pub addresses: Vec<NetAddress>,
532 pub(crate) excess_address_data: Vec<u8>,
533 pub(crate) excess_data: Vec<u8>,
535 #[derive(Clone, Debug, PartialEq)]
536 /// A node_announcement message to be sent or received from a peer
537 pub struct NodeAnnouncement {
538 /// The signature by the node key
539 pub signature: Signature,
540 /// The actual content of the announcement
541 pub contents: UnsignedNodeAnnouncement,
544 /// The unsigned part of a channel_announcement
545 #[derive(Clone, Debug, PartialEq)]
546 pub struct UnsignedChannelAnnouncement {
547 /// The advertised channel features
548 pub features: ChannelFeatures,
549 /// The genesis hash of the blockchain where the channel is to be opened
550 pub chain_hash: BlockHash,
551 /// The short channel ID
552 pub short_channel_id: u64,
553 /// One of the two node_ids which are endpoints of this channel
554 pub node_id_1: PublicKey,
555 /// The other of the two node_ids which are endpoints of this channel
556 pub node_id_2: PublicKey,
557 /// The funding key for the first node
558 pub bitcoin_key_1: PublicKey,
559 /// The funding key for the second node
560 pub bitcoin_key_2: PublicKey,
561 pub(crate) excess_data: Vec<u8>,
563 /// A channel_announcement message to be sent or received from a peer
564 #[derive(Clone, Debug, PartialEq)]
565 pub struct ChannelAnnouncement {
566 /// Authentication of the announcement by the first public node
567 pub node_signature_1: Signature,
568 /// Authentication of the announcement by the second public node
569 pub node_signature_2: Signature,
570 /// Proof of funding UTXO ownership by the first public node
571 pub bitcoin_signature_1: Signature,
572 /// Proof of funding UTXO ownership by the second public node
573 pub bitcoin_signature_2: Signature,
574 /// The actual announcement
575 pub contents: UnsignedChannelAnnouncement,
578 /// The unsigned part of a channel_update
579 #[derive(Clone, Debug, PartialEq)]
580 pub struct UnsignedChannelUpdate {
581 /// The genesis hash of the blockchain where the channel is to be opened
582 pub chain_hash: BlockHash,
583 /// The short channel ID
584 pub short_channel_id: u64,
585 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
589 /// The number of blocks such that if:
590 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
591 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
592 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
593 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
594 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
595 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
596 /// constructing the route.
597 pub cltv_expiry_delta: u16,
598 /// The minimum HTLC size incoming to sender, in milli-satoshi
599 pub htlc_minimum_msat: u64,
600 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
601 pub htlc_maximum_msat: OptionalField<u64>,
602 /// The base HTLC fee charged by sender, in milli-satoshi
603 pub fee_base_msat: u32,
604 /// The amount to fee multiplier, in micro-satoshi
605 pub fee_proportional_millionths: u32,
606 pub(crate) excess_data: Vec<u8>,
608 /// A channel_update message to be sent or received from a peer
609 #[derive(Clone, Debug, PartialEq)]
610 pub struct ChannelUpdate {
611 /// A signature of the channel update
612 pub signature: Signature,
613 /// The actual channel update
614 pub contents: UnsignedChannelUpdate,
617 /// A query_channel_range message is used to query a peer for channel
618 /// UTXOs in a range of blocks. The recipient of a query makes a best
619 /// effort to reply to the query using one or more reply_channel_range
621 #[derive(Clone, Debug, PartialEq)]
622 pub struct QueryChannelRange {
623 /// The genesis hash of the blockchain being queried
624 pub chain_hash: BlockHash,
625 /// The height of the first block for the channel UTXOs being queried
626 pub first_blocknum: u32,
627 /// The number of blocks to include in the query results
628 pub number_of_blocks: u32,
631 /// A reply_channel_range message is a reply to a query_channel_range
632 /// message. Multiple reply_channel_range messages can be sent in reply
633 /// to a single query_channel_range message. The query recipient makes a
634 /// best effort to respond based on their local network view which may
635 /// not be a perfect view of the network. The short_channel_ids in the
636 /// reply are encoded. We only support encoding_type=0 uncompressed
637 /// serialization and do not support encoding_type=1 zlib serialization.
638 #[derive(Clone, Debug, PartialEq)]
639 pub struct ReplyChannelRange {
640 /// The genesis hash of the blockchain being queried
641 pub chain_hash: BlockHash,
642 /// The height of the first block in the range of the reply
643 pub first_blocknum: u32,
644 /// The number of blocks included in the range of the reply
645 pub number_of_blocks: u32,
646 /// True when this is the final reply for a query
647 pub sync_complete: bool,
648 /// The short_channel_ids in the channel range
649 pub short_channel_ids: Vec<u64>,
652 /// A query_short_channel_ids message is used to query a peer for
653 /// routing gossip messages related to one or more short_channel_ids.
654 /// The query recipient will reply with the latest, if available,
655 /// channel_announcement, channel_update and node_announcement messages
656 /// it maintains for the requested short_channel_ids followed by a
657 /// reply_short_channel_ids_end message. The short_channel_ids sent in
658 /// this query are encoded. We only support encoding_type=0 uncompressed
659 /// serialization and do not support encoding_type=1 zlib serialization.
660 #[derive(Clone, Debug, PartialEq)]
661 pub struct QueryShortChannelIds {
662 /// The genesis hash of the blockchain being queried
663 pub chain_hash: BlockHash,
664 /// The short_channel_ids that are being queried
665 pub short_channel_ids: Vec<u64>,
668 /// A reply_short_channel_ids_end message is sent as a reply to a
669 /// query_short_channel_ids message. The query recipient makes a best
670 /// effort to respond based on their local network view which may not be
671 /// a perfect view of the network.
672 #[derive(Clone, Debug, PartialEq)]
673 pub struct ReplyShortChannelIdsEnd {
674 /// The genesis hash of the blockchain that was queried
675 pub chain_hash: BlockHash,
676 /// Indicates if the query recipient maintains up-to-date channel
677 /// information for the chain_hash
678 pub full_information: bool,
681 /// A gossip_timestamp_filter message is used by a node to request
682 /// gossip relay for messages in the requested time range when the
683 /// gossip_queries feature has been negotiated.
684 #[derive(Clone, Debug, PartialEq)]
685 pub struct GossipTimestampFilter {
686 /// The genesis hash of the blockchain for channel and node information
687 pub chain_hash: BlockHash,
688 /// The starting unix timestamp
689 pub first_timestamp: u32,
690 /// The range of information in seconds
691 pub timestamp_range: u32,
694 /// Encoding type for data compression of collections in gossip queries.
695 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
700 /// Used to put an error message in a LightningError
701 #[derive(Clone, Debug)]
702 pub enum ErrorAction {
703 /// The peer took some action which made us think they were useless. Disconnect them.
705 /// An error message which we should make an effort to send before we disconnect.
706 msg: Option<ErrorMessage>
708 /// The peer did something harmless that we weren't able to process, just log and ignore
709 // New code should *not* use this. New code must use IgnoreAndLog, below!
711 /// The peer did something harmless that we weren't able to meaningfully process.
712 /// If the error is logged, log it at the given level.
713 IgnoreAndLog(logger::Level),
714 /// The peer did something incorrect. Tell them.
716 /// The message to send.
721 /// An Err type for failure to process messages.
722 #[derive(Clone, Debug)]
723 pub struct LightningError {
724 /// A human-readable message describing the error
726 /// The action which should be taken against the offending peer.
727 pub action: ErrorAction,
730 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
731 /// transaction updates if they were pending.
732 #[derive(Clone, Debug, PartialEq)]
733 pub struct CommitmentUpdate {
734 /// update_add_htlc messages which should be sent
735 pub update_add_htlcs: Vec<UpdateAddHTLC>,
736 /// update_fulfill_htlc messages which should be sent
737 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
738 /// update_fail_htlc messages which should be sent
739 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
740 /// update_fail_malformed_htlc messages which should be sent
741 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
742 /// An update_fee message which should be sent
743 pub update_fee: Option<UpdateFee>,
744 /// Finally, the commitment_signed message which should be sent
745 pub commitment_signed: CommitmentSigned,
748 /// The information we received from a peer along the route of a payment we originated. This is
749 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
750 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
751 #[derive(Clone, Debug, PartialEq)]
752 pub enum HTLCFailChannelUpdate {
753 /// We received an error which included a full ChannelUpdate message.
754 ChannelUpdateMessage {
755 /// The unwrapped message we received
758 /// We received an error which indicated only that a channel has been closed
760 /// The short_channel_id which has now closed.
761 short_channel_id: u64,
762 /// when this true, this channel should be permanently removed from the
763 /// consideration. Otherwise, this channel can be restored as new channel_update is received
766 /// We received an error which indicated only that a node has failed
768 /// The node_id that has failed.
770 /// when this true, node should be permanently removed from the
771 /// consideration. Otherwise, the channels connected to this node can be
772 /// restored as new channel_update is received
777 /// Messages could have optional fields to use with extended features
778 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
779 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
780 /// separate enum type for them.
781 /// (C-not exported) due to a free generic in T
782 #[derive(Clone, Debug, PartialEq)]
783 pub enum OptionalField<T> {
784 /// Optional field is included in message
786 /// Optional field is absent in message
790 /// A trait to describe an object which can receive channel messages.
792 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
793 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
794 pub trait ChannelMessageHandler : MessageSendEventsProvider {
796 /// Handle an incoming open_channel message from the given peer.
797 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
798 /// Handle an incoming accept_channel message from the given peer.
799 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
800 /// Handle an incoming funding_created message from the given peer.
801 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
802 /// Handle an incoming funding_signed message from the given peer.
803 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
804 /// Handle an incoming funding_locked message from the given peer.
805 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
808 /// Handle an incoming shutdown message from the given peer.
809 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
810 /// Handle an incoming closing_signed message from the given peer.
811 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
814 /// Handle an incoming update_add_htlc message from the given peer.
815 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
816 /// Handle an incoming update_fulfill_htlc message from the given peer.
817 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
818 /// Handle an incoming update_fail_htlc message from the given peer.
819 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
820 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
821 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
822 /// Handle an incoming commitment_signed message from the given peer.
823 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
824 /// Handle an incoming revoke_and_ack message from the given peer.
825 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
827 /// Handle an incoming update_fee message from the given peer.
828 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
830 // Channel-to-announce:
831 /// Handle an incoming announcement_signatures message from the given peer.
832 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
834 // Connection loss/reestablish:
835 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
836 /// is believed to be possible in the future (eg they're sending us messages we don't
837 /// understand or indicate they require unknown feature bits), no_connection_possible is set
838 /// and any outstanding channels should be failed.
839 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
841 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
842 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
843 /// Handle an incoming channel_reestablish message from the given peer.
844 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
846 /// Handle an incoming channel update from the given peer.
847 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
850 /// Handle an incoming error message from the given peer.
851 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
854 /// A trait to describe an object which can receive routing messages.
856 /// # Implementor DoS Warnings
858 /// For `gossip_queries` messages there are potential DoS vectors when handling
859 /// inbound queries. Implementors using an on-disk network graph should be aware of
860 /// repeated disk I/O for queries accessing different parts of the network graph.
861 pub trait RoutingMessageHandler : MessageSendEventsProvider {
862 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
863 /// false or returning an Err otherwise.
864 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
865 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
866 /// or returning an Err otherwise.
867 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
868 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
869 /// false or returning an Err otherwise.
870 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
871 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
872 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
873 /// Gets a subset of the channel announcements and updates required to dump our routing table
874 /// to a remote node, starting at the short_channel_id indicated by starting_point and
875 /// including the batch_amount entries immediately higher in numerical value than starting_point.
876 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
877 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
878 /// starting at the node *after* the provided publickey and including batch_amount entries
879 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
880 /// If None is provided for starting_point, we start at the first node.
881 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
882 /// Called when a connection is established with a peer. This can be used to
883 /// perform routing table synchronization using a strategy defined by the
885 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
886 /// Handles the reply of a query we initiated to learn about channels
887 /// for a given range of blocks. We can expect to receive one or more
888 /// replies to a single query.
889 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
890 /// Handles the reply of a query we initiated asking for routing gossip
891 /// messages for a list of channels. We should receive this message when
892 /// a node has completed its best effort to send us the pertaining routing
894 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
895 /// Handles when a peer asks us to send a list of short_channel_ids
896 /// for the requested range of blocks.
897 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
898 /// Handles when a peer asks us to send routing gossip messages for a
899 /// list of short_channel_ids.
900 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
903 mod fuzzy_internal_msgs {
905 use ln::{PaymentPreimage, PaymentSecret};
907 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
908 // them from untrusted input):
910 pub(crate) struct FinalOnionHopData {
911 pub(crate) payment_secret: PaymentSecret,
912 /// The total value, in msat, of the payment as received by the ultimate recipient.
913 /// Message serialization may panic if this value is more than 21 million Bitcoin.
914 pub(crate) total_msat: u64,
917 pub(crate) enum OnionHopDataFormat {
918 Legacy { // aka Realm-0
919 short_channel_id: u64,
922 short_channel_id: u64,
925 payment_data: Option<FinalOnionHopData>,
926 keysend_preimage: Option<PaymentPreimage>,
930 pub struct OnionHopData {
931 pub(crate) format: OnionHopDataFormat,
932 /// The value, in msat, of the payment after this hop's fee is deducted.
933 /// Message serialization may panic if this value is more than 21 million Bitcoin.
934 pub(crate) amt_to_forward: u64,
935 pub(crate) outgoing_cltv_value: u32,
936 // 12 bytes of 0-padding for Legacy format
939 pub struct DecodedOnionErrorPacket {
940 pub(crate) hmac: [u8; 32],
941 pub(crate) failuremsg: Vec<u8>,
942 pub(crate) pad: Vec<u8>,
945 #[cfg(feature = "fuzztarget")]
946 pub use self::fuzzy_internal_msgs::*;
947 #[cfg(not(feature = "fuzztarget"))]
948 pub(crate) use self::fuzzy_internal_msgs::*;
951 pub(crate) struct OnionPacket {
952 pub(crate) version: u8,
953 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
954 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
955 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
956 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
957 pub(crate) hop_data: [u8; 20*65],
958 pub(crate) hmac: [u8; 32],
961 impl PartialEq for OnionPacket {
962 fn eq(&self, other: &OnionPacket) -> bool {
963 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
964 if i != j { return false; }
966 self.version == other.version &&
967 self.public_key == other.public_key &&
968 self.hmac == other.hmac
972 impl fmt::Debug for OnionPacket {
973 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
974 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
978 #[derive(Clone, Debug, PartialEq)]
979 pub(crate) struct OnionErrorPacket {
980 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
981 // (TODO) We limit it in decode to much lower...
982 pub(crate) data: Vec<u8>,
985 impl fmt::Display for DecodeError {
986 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
988 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
989 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
990 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
991 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
992 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
993 DecodeError::Io(ref e) => e.fmt(f),
994 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
999 impl From<io::Error> for DecodeError {
1000 fn from(e: io::Error) -> Self {
1001 if e.kind() == io::ErrorKind::UnexpectedEof {
1002 DecodeError::ShortRead
1004 DecodeError::Io(e.kind())
1009 impl Writeable for OptionalField<Script> {
1010 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1012 OptionalField::Present(ref script) => {
1013 // Note that Writeable for script includes the 16-bit length tag for us
1016 OptionalField::Absent => {}
1022 impl Readable for OptionalField<Script> {
1023 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1024 match <u16 as Readable>::read(r) {
1026 let mut buf = vec![0; len as usize];
1027 r.read_exact(&mut buf)?;
1028 Ok(OptionalField::Present(Script::from(buf)))
1030 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1036 impl Writeable for OptionalField<u64> {
1037 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1039 OptionalField::Present(ref value) => {
1042 OptionalField::Absent => {}
1048 impl Readable for OptionalField<u64> {
1049 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1050 let value: u64 = Readable::read(r)?;
1051 Ok(OptionalField::Present(value))
1056 impl_writeable!(AcceptChannel, {
1057 temporary_channel_id,
1058 dust_limit_satoshis,
1059 max_htlc_value_in_flight_msat,
1060 channel_reserve_satoshis,
1066 revocation_basepoint,
1068 delayed_payment_basepoint,
1070 first_per_commitment_point,
1071 shutdown_scriptpubkey
1074 impl_writeable!(AnnouncementSignatures, {
1081 impl Writeable for ChannelReestablish {
1082 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1083 self.channel_id.write(w)?;
1084 self.next_local_commitment_number.write(w)?;
1085 self.next_remote_commitment_number.write(w)?;
1086 match self.data_loss_protect {
1087 OptionalField::Present(ref data_loss_protect) => {
1088 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1089 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1091 OptionalField::Absent => {}
1097 impl Readable for ChannelReestablish{
1098 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1100 channel_id: Readable::read(r)?,
1101 next_local_commitment_number: Readable::read(r)?,
1102 next_remote_commitment_number: Readable::read(r)?,
1103 data_loss_protect: {
1104 match <[u8; 32] as Readable>::read(r) {
1105 Ok(your_last_per_commitment_secret) =>
1106 OptionalField::Present(DataLossProtect {
1107 your_last_per_commitment_secret,
1108 my_current_per_commitment_point: Readable::read(r)?,
1110 Err(DecodeError::ShortRead) => OptionalField::Absent,
1111 Err(e) => return Err(e)
1118 impl Writeable for ClosingSigned {
1119 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1120 self.channel_id.write(w)?;
1121 self.fee_satoshis.write(w)?;
1122 self.signature.write(w)?;
1123 encode_tlv_stream!(w, {
1124 (1, self.fee_range, option),
1130 impl Readable for ClosingSigned {
1131 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1132 let channel_id = Readable::read(r)?;
1133 let fee_satoshis = Readable::read(r)?;
1134 let signature = Readable::read(r)?;
1135 let mut fee_range = None;
1136 decode_tlv_stream!(r, {
1137 (1, fee_range, option),
1139 Ok(Self { channel_id, fee_satoshis, signature, fee_range })
1143 impl_writeable!(ClosingSignedFeeRange, {
1148 impl_writeable!(CommitmentSigned, {
1154 impl_writeable!(DecodedOnionErrorPacket, {
1160 impl_writeable!(FundingCreated, {
1161 temporary_channel_id,
1163 funding_output_index,
1167 impl_writeable!(FundingSigned, {
1172 impl_writeable!(FundingLocked, {
1174 next_per_commitment_point
1177 impl Writeable for Init {
1178 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1179 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1180 // our relevant feature bits. This keeps us compatible with old nodes.
1181 self.features.write_up_to_13(w)?;
1182 self.features.write(w)
1186 impl Readable for Init {
1187 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1188 let global_features: InitFeatures = Readable::read(r)?;
1189 let features: InitFeatures = Readable::read(r)?;
1191 features: features.or(global_features),
1196 impl_writeable!(OpenChannel, {
1198 temporary_channel_id,
1201 dust_limit_satoshis,
1202 max_htlc_value_in_flight_msat,
1203 channel_reserve_satoshis,
1209 revocation_basepoint,
1211 delayed_payment_basepoint,
1213 first_per_commitment_point,
1215 shutdown_scriptpubkey
1218 impl_writeable!(RevokeAndACK, {
1220 per_commitment_secret,
1221 next_per_commitment_point
1224 impl_writeable!(Shutdown, {
1229 impl_writeable!(UpdateFailHTLC, {
1235 impl_writeable!(UpdateFailMalformedHTLC, {
1242 impl_writeable!(UpdateFee, {
1247 impl_writeable!(UpdateFulfillHTLC, {
1253 impl_writeable!(OnionErrorPacket, {
1257 impl Writeable for OnionPacket {
1258 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1259 self.version.write(w)?;
1260 match self.public_key {
1261 Ok(pubkey) => pubkey.write(w)?,
1262 Err(_) => [0u8;33].write(w)?,
1264 w.write_all(&self.hop_data)?;
1265 self.hmac.write(w)?;
1270 impl Readable for OnionPacket {
1271 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1273 version: Readable::read(r)?,
1275 let mut buf = [0u8;33];
1276 r.read_exact(&mut buf)?;
1277 PublicKey::from_slice(&buf)
1279 hop_data: Readable::read(r)?,
1280 hmac: Readable::read(r)?,
1285 impl_writeable!(UpdateAddHTLC, {
1291 onion_routing_packet
1294 impl Writeable for FinalOnionHopData {
1295 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1296 self.payment_secret.0.write(w)?;
1297 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1301 impl Readable for FinalOnionHopData {
1302 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1303 let secret: [u8; 32] = Readable::read(r)?;
1304 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1305 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1309 impl Writeable for OnionHopData {
1310 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1311 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1312 // check values are sane long before we get here, though its possible in the future
1313 // user-generated messages may hit this.
1314 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1316 OnionHopDataFormat::Legacy { short_channel_id } => {
1318 short_channel_id.write(w)?;
1319 self.amt_to_forward.write(w)?;
1320 self.outgoing_cltv_value.write(w)?;
1321 w.write_all(&[0;12])?;
1323 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1324 encode_varint_length_prefixed_tlv!(w, {
1325 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1326 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1327 (6, short_channel_id, required)
1330 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1331 if let Some(final_data) = payment_data {
1332 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1334 encode_varint_length_prefixed_tlv!(w, {
1335 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1336 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1337 (8, payment_data, option),
1338 (5482373484, keysend_preimage, option)
1346 impl Readable for OnionHopData {
1347 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1348 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1349 let v: VarInt = Decodable::consensus_decode(&mut r)
1350 .map_err(|e| match e {
1351 Error::Io(ioe) => DecodeError::from(ioe),
1352 _ => DecodeError::InvalidValue
1354 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1355 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1356 let mut rd = FixedLengthReader::new(r, v.0);
1357 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1358 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1359 let mut short_id: Option<u64> = None;
1360 let mut payment_data: Option<FinalOnionHopData> = None;
1361 let mut keysend_preimage: Option<PaymentPreimage> = None;
1362 // The TLV type is chosen to be compatible with lnd and c-lightning.
1363 decode_tlv_stream!(&mut rd, {
1365 (4, cltv_value, required),
1366 (6, short_id, option),
1367 (8, payment_data, option),
1368 (5482373484, keysend_preimage, option)
1370 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1371 let format = if let Some(short_channel_id) = short_id {
1372 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1373 OnionHopDataFormat::NonFinalNode {
1377 if let &Some(ref data) = &payment_data {
1378 if data.total_msat > MAX_VALUE_MSAT {
1379 return Err(DecodeError::InvalidValue);
1382 OnionHopDataFormat::FinalNode {
1387 (format, amt.0, cltv_value.0)
1389 let format = OnionHopDataFormat::Legacy {
1390 short_channel_id: Readable::read(r)?,
1392 let amt: u64 = Readable::read(r)?;
1393 let cltv_value: u32 = Readable::read(r)?;
1394 r.read_exact(&mut [0; 12])?;
1395 (format, amt, cltv_value)
1398 if amt > MAX_VALUE_MSAT {
1399 return Err(DecodeError::InvalidValue);
1403 amt_to_forward: amt,
1404 outgoing_cltv_value: cltv_value,
1409 impl Writeable for Ping {
1410 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1411 self.ponglen.write(w)?;
1412 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1417 impl Readable for Ping {
1418 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1420 ponglen: Readable::read(r)?,
1422 let byteslen = Readable::read(r)?;
1423 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1430 impl Writeable for Pong {
1431 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1432 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1437 impl Readable for Pong {
1438 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1441 let byteslen = Readable::read(r)?;
1442 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1449 impl Writeable for UnsignedChannelAnnouncement {
1450 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1451 self.features.write(w)?;
1452 self.chain_hash.write(w)?;
1453 self.short_channel_id.write(w)?;
1454 self.node_id_1.write(w)?;
1455 self.node_id_2.write(w)?;
1456 self.bitcoin_key_1.write(w)?;
1457 self.bitcoin_key_2.write(w)?;
1458 w.write_all(&self.excess_data[..])?;
1463 impl Readable for UnsignedChannelAnnouncement {
1464 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1466 features: Readable::read(r)?,
1467 chain_hash: Readable::read(r)?,
1468 short_channel_id: Readable::read(r)?,
1469 node_id_1: Readable::read(r)?,
1470 node_id_2: Readable::read(r)?,
1471 bitcoin_key_1: Readable::read(r)?,
1472 bitcoin_key_2: Readable::read(r)?,
1473 excess_data: read_to_end(r)?,
1478 impl_writeable!(ChannelAnnouncement, {
1481 bitcoin_signature_1,
1482 bitcoin_signature_2,
1486 impl Writeable for UnsignedChannelUpdate {
1487 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1488 let mut message_flags: u8 = 0;
1489 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1492 self.chain_hash.write(w)?;
1493 self.short_channel_id.write(w)?;
1494 self.timestamp.write(w)?;
1495 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1496 all_flags.write(w)?;
1497 self.cltv_expiry_delta.write(w)?;
1498 self.htlc_minimum_msat.write(w)?;
1499 self.fee_base_msat.write(w)?;
1500 self.fee_proportional_millionths.write(w)?;
1501 self.htlc_maximum_msat.write(w)?;
1502 w.write_all(&self.excess_data[..])?;
1507 impl Readable for UnsignedChannelUpdate {
1508 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1509 let has_htlc_maximum_msat;
1511 chain_hash: Readable::read(r)?,
1512 short_channel_id: Readable::read(r)?,
1513 timestamp: Readable::read(r)?,
1515 let flags: u16 = Readable::read(r)?;
1516 let message_flags = flags >> 8;
1517 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1520 cltv_expiry_delta: Readable::read(r)?,
1521 htlc_minimum_msat: Readable::read(r)?,
1522 fee_base_msat: Readable::read(r)?,
1523 fee_proportional_millionths: Readable::read(r)?,
1524 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1525 excess_data: read_to_end(r)?,
1530 impl_writeable!(ChannelUpdate, {
1535 impl Writeable for ErrorMessage {
1536 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1537 self.channel_id.write(w)?;
1538 (self.data.len() as u16).write(w)?;
1539 w.write_all(self.data.as_bytes())?;
1544 impl Readable for ErrorMessage {
1545 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1547 channel_id: Readable::read(r)?,
1549 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1550 let data = read_to_end(r)?;
1551 sz = cmp::min(data.len(), sz);
1552 match String::from_utf8(data[..sz as usize].to_vec()) {
1554 Err(_) => return Err(DecodeError::InvalidValue),
1561 impl Writeable for UnsignedNodeAnnouncement {
1562 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1563 self.features.write(w)?;
1564 self.timestamp.write(w)?;
1565 self.node_id.write(w)?;
1566 w.write_all(&self.rgb)?;
1567 self.alias.write(w)?;
1569 let mut addr_len = 0;
1570 for addr in self.addresses.iter() {
1571 addr_len += 1 + addr.len();
1573 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1574 for addr in self.addresses.iter() {
1577 w.write_all(&self.excess_address_data[..])?;
1578 w.write_all(&self.excess_data[..])?;
1583 impl Readable for UnsignedNodeAnnouncement {
1584 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1585 let features: NodeFeatures = Readable::read(r)?;
1586 let timestamp: u32 = Readable::read(r)?;
1587 let node_id: PublicKey = Readable::read(r)?;
1588 let mut rgb = [0; 3];
1589 r.read_exact(&mut rgb)?;
1590 let alias: [u8; 32] = Readable::read(r)?;
1592 let addr_len: u16 = Readable::read(r)?;
1593 let mut addresses: Vec<NetAddress> = Vec::new();
1594 let mut addr_readpos = 0;
1595 let mut excess = false;
1596 let mut excess_byte = 0;
1598 if addr_len <= addr_readpos { break; }
1599 match Readable::read(r) {
1601 if addr_len < addr_readpos + 1 + addr.len() {
1602 return Err(DecodeError::BadLengthDescriptor);
1604 addr_readpos += (1 + addr.len()) as u16;
1605 addresses.push(addr);
1607 Ok(Err(unknown_descriptor)) => {
1609 excess_byte = unknown_descriptor;
1612 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1613 Err(e) => return Err(e),
1617 let mut excess_data = vec![];
1618 let excess_address_data = if addr_readpos < addr_len {
1619 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1620 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1622 excess_address_data[0] = excess_byte;
1627 excess_data.push(excess_byte);
1631 excess_data.extend(read_to_end(r)?.iter());
1632 Ok(UnsignedNodeAnnouncement {
1639 excess_address_data,
1645 impl_writeable!(NodeAnnouncement, {
1650 impl Readable for QueryShortChannelIds {
1651 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1652 let chain_hash: BlockHash = Readable::read(r)?;
1654 let encoding_len: u16 = Readable::read(r)?;
1655 let encoding_type: u8 = Readable::read(r)?;
1657 // Must be encoding_type=0 uncompressed serialization. We do not
1658 // support encoding_type=1 zlib serialization.
1659 if encoding_type != EncodingType::Uncompressed as u8 {
1660 return Err(DecodeError::UnsupportedCompression);
1663 // We expect the encoding_len to always includes the 1-byte
1664 // encoding_type and that short_channel_ids are 8-bytes each
1665 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1666 return Err(DecodeError::InvalidValue);
1669 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1670 // less the 1-byte encoding_type
1671 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1672 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1673 for _ in 0..short_channel_id_count {
1674 short_channel_ids.push(Readable::read(r)?);
1677 Ok(QueryShortChannelIds {
1684 impl Writeable for QueryShortChannelIds {
1685 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1686 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1687 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1689 self.chain_hash.write(w)?;
1690 encoding_len.write(w)?;
1692 // We only support type=0 uncompressed serialization
1693 (EncodingType::Uncompressed as u8).write(w)?;
1695 for scid in self.short_channel_ids.iter() {
1703 impl Readable for ReplyShortChannelIdsEnd {
1704 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1705 let chain_hash: BlockHash = Readable::read(r)?;
1706 let full_information: bool = Readable::read(r)?;
1707 Ok(ReplyShortChannelIdsEnd {
1714 impl Writeable for ReplyShortChannelIdsEnd {
1715 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1716 self.chain_hash.write(w)?;
1717 self.full_information.write(w)?;
1722 impl QueryChannelRange {
1724 * Calculates the overflow safe ending block height for the query.
1725 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1727 pub fn end_blocknum(&self) -> u32 {
1728 match self.first_blocknum.checked_add(self.number_of_blocks) {
1729 Some(block) => block,
1730 None => u32::max_value(),
1735 impl Readable for QueryChannelRange {
1736 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1737 let chain_hash: BlockHash = Readable::read(r)?;
1738 let first_blocknum: u32 = Readable::read(r)?;
1739 let number_of_blocks: u32 = Readable::read(r)?;
1740 Ok(QueryChannelRange {
1748 impl Writeable for QueryChannelRange {
1749 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1750 self.chain_hash.write(w)?;
1751 self.first_blocknum.write(w)?;
1752 self.number_of_blocks.write(w)?;
1757 impl Readable for ReplyChannelRange {
1758 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1759 let chain_hash: BlockHash = Readable::read(r)?;
1760 let first_blocknum: u32 = Readable::read(r)?;
1761 let number_of_blocks: u32 = Readable::read(r)?;
1762 let sync_complete: bool = Readable::read(r)?;
1764 let encoding_len: u16 = Readable::read(r)?;
1765 let encoding_type: u8 = Readable::read(r)?;
1767 // Must be encoding_type=0 uncompressed serialization. We do not
1768 // support encoding_type=1 zlib serialization.
1769 if encoding_type != EncodingType::Uncompressed as u8 {
1770 return Err(DecodeError::UnsupportedCompression);
1773 // We expect the encoding_len to always includes the 1-byte
1774 // encoding_type and that short_channel_ids are 8-bytes each
1775 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1776 return Err(DecodeError::InvalidValue);
1779 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1780 // less the 1-byte encoding_type
1781 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1782 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1783 for _ in 0..short_channel_id_count {
1784 short_channel_ids.push(Readable::read(r)?);
1787 Ok(ReplyChannelRange {
1797 impl Writeable for ReplyChannelRange {
1798 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1799 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1800 self.chain_hash.write(w)?;
1801 self.first_blocknum.write(w)?;
1802 self.number_of_blocks.write(w)?;
1803 self.sync_complete.write(w)?;
1805 encoding_len.write(w)?;
1806 (EncodingType::Uncompressed as u8).write(w)?;
1807 for scid in self.short_channel_ids.iter() {
1815 impl Readable for GossipTimestampFilter {
1816 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1817 let chain_hash: BlockHash = Readable::read(r)?;
1818 let first_timestamp: u32 = Readable::read(r)?;
1819 let timestamp_range: u32 = Readable::read(r)?;
1820 Ok(GossipTimestampFilter {
1828 impl Writeable for GossipTimestampFilter {
1829 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1830 self.chain_hash.write(w)?;
1831 self.first_timestamp.write(w)?;
1832 self.timestamp_range.write(w)?;
1841 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1843 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1844 use util::ser::{Writeable, Readable};
1846 use bitcoin::hashes::hex::FromHex;
1847 use bitcoin::util::address::Address;
1848 use bitcoin::network::constants::Network;
1849 use bitcoin::blockdata::script::Builder;
1850 use bitcoin::blockdata::opcodes;
1851 use bitcoin::hash_types::{Txid, BlockHash};
1853 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1854 use bitcoin::secp256k1::{Secp256k1, Message};
1860 fn encoding_channel_reestablish_no_secret() {
1861 let cr = msgs::ChannelReestablish {
1862 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],
1863 next_local_commitment_number: 3,
1864 next_remote_commitment_number: 4,
1865 data_loss_protect: OptionalField::Absent,
1868 let encoded_value = cr.encode();
1871 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]
1876 fn encoding_channel_reestablish_with_secret() {
1878 let secp_ctx = Secp256k1::new();
1879 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1882 let cr = msgs::ChannelReestablish {
1883 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],
1884 next_local_commitment_number: 3,
1885 next_remote_commitment_number: 4,
1886 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1889 let encoded_value = cr.encode();
1892 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]
1896 macro_rules! get_keys_from {
1897 ($slice: expr, $secp_ctx: expr) => {
1899 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1900 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1906 macro_rules! get_sig_on {
1907 ($privkey: expr, $ctx: expr, $string: expr) => {
1909 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1910 $ctx.sign(&sighash, &$privkey)
1916 fn encoding_announcement_signatures() {
1917 let secp_ctx = Secp256k1::new();
1918 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1919 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1920 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1921 let announcement_signatures = msgs::AnnouncementSignatures {
1922 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],
1923 short_channel_id: 2316138423780173,
1924 node_signature: sig_1,
1925 bitcoin_signature: sig_2,
1928 let encoded_value = announcement_signatures.encode();
1929 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1932 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1933 let secp_ctx = Secp256k1::new();
1934 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1935 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1936 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1937 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1938 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1939 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1940 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1941 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1942 let mut features = ChannelFeatures::known();
1943 if unknown_features_bits {
1944 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1946 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1948 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1949 short_channel_id: 2316138423780173,
1950 node_id_1: pubkey_1,
1951 node_id_2: pubkey_2,
1952 bitcoin_key_1: pubkey_3,
1953 bitcoin_key_2: pubkey_4,
1954 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1956 let channel_announcement = msgs::ChannelAnnouncement {
1957 node_signature_1: sig_1,
1958 node_signature_2: sig_2,
1959 bitcoin_signature_1: sig_3,
1960 bitcoin_signature_2: sig_4,
1961 contents: unsigned_channel_announcement,
1963 let encoded_value = channel_announcement.encode();
1964 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1965 if unknown_features_bits {
1966 target_value.append(&mut hex::decode("0002ffff").unwrap());
1968 target_value.append(&mut hex::decode("0000").unwrap());
1970 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1971 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1973 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1975 assert_eq!(encoded_value, target_value);
1979 fn encoding_channel_announcement() {
1980 do_encoding_channel_announcement(true, false);
1981 do_encoding_channel_announcement(false, true);
1982 do_encoding_channel_announcement(false, false);
1983 do_encoding_channel_announcement(true, true);
1986 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1987 let secp_ctx = Secp256k1::new();
1988 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1989 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1990 let features = if unknown_features_bits {
1991 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1993 // Set to some features we may support
1994 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1996 let mut addresses = Vec::new();
1998 addresses.push(msgs::NetAddress::IPv4 {
1999 addr: [255, 254, 253, 252],
2004 addresses.push(msgs::NetAddress::IPv6 {
2005 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2010 addresses.push(msgs::NetAddress::OnionV2 {
2011 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
2016 addresses.push(msgs::NetAddress::OnionV3 {
2017 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],
2023 let mut addr_len = 0;
2024 for addr in &addresses {
2025 addr_len += addr.len() + 1;
2027 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2029 timestamp: 20190119,
2034 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() },
2035 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() },
2037 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2038 let node_announcement = msgs::NodeAnnouncement {
2040 contents: unsigned_node_announcement,
2042 let encoded_value = node_announcement.encode();
2043 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2044 if unknown_features_bits {
2045 target_value.append(&mut hex::decode("0002ffff").unwrap());
2047 target_value.append(&mut hex::decode("000122").unwrap());
2049 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2050 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2052 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2055 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2058 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2061 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2063 if excess_address_data {
2064 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2067 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2069 assert_eq!(encoded_value, target_value);
2073 fn encoding_node_announcement() {
2074 do_encoding_node_announcement(true, true, true, true, true, true, true);
2075 do_encoding_node_announcement(false, false, false, false, false, false, false);
2076 do_encoding_node_announcement(false, true, false, false, false, false, false);
2077 do_encoding_node_announcement(false, false, true, false, false, false, false);
2078 do_encoding_node_announcement(false, false, false, true, false, false, false);
2079 do_encoding_node_announcement(false, false, false, false, true, false, false);
2080 do_encoding_node_announcement(false, false, false, false, false, true, false);
2081 do_encoding_node_announcement(false, true, false, true, false, true, false);
2082 do_encoding_node_announcement(false, false, true, false, true, false, false);
2085 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2086 let secp_ctx = Secp256k1::new();
2087 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2088 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2089 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2090 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2091 short_channel_id: 2316138423780173,
2092 timestamp: 20190119,
2093 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2094 cltv_expiry_delta: 144,
2095 htlc_minimum_msat: 1000000,
2096 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2097 fee_base_msat: 10000,
2098 fee_proportional_millionths: 20,
2099 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2101 let channel_update = msgs::ChannelUpdate {
2103 contents: unsigned_channel_update
2105 let encoded_value = channel_update.encode();
2106 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2107 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2108 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2109 if htlc_maximum_msat {
2110 target_value.append(&mut hex::decode("01").unwrap());
2112 target_value.append(&mut hex::decode("00").unwrap());
2114 target_value.append(&mut hex::decode("00").unwrap());
2116 let flag = target_value.last_mut().unwrap();
2120 let flag = target_value.last_mut().unwrap();
2121 *flag = *flag | 1 << 1;
2123 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2124 if htlc_maximum_msat {
2125 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2128 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2130 assert_eq!(encoded_value, target_value);
2134 fn encoding_channel_update() {
2135 do_encoding_channel_update(false, false, false, false);
2136 do_encoding_channel_update(false, false, false, true);
2137 do_encoding_channel_update(true, false, false, false);
2138 do_encoding_channel_update(true, false, false, true);
2139 do_encoding_channel_update(false, true, false, false);
2140 do_encoding_channel_update(false, true, false, true);
2141 do_encoding_channel_update(false, false, true, false);
2142 do_encoding_channel_update(false, false, true, true);
2143 do_encoding_channel_update(true, true, true, false);
2144 do_encoding_channel_update(true, true, true, true);
2147 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2148 let secp_ctx = Secp256k1::new();
2149 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2150 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2151 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2152 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2153 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2154 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2155 let open_channel = msgs::OpenChannel {
2156 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2157 temporary_channel_id: [2; 32],
2158 funding_satoshis: 1311768467284833366,
2159 push_msat: 2536655962884945560,
2160 dust_limit_satoshis: 3608586615801332854,
2161 max_htlc_value_in_flight_msat: 8517154655701053848,
2162 channel_reserve_satoshis: 8665828695742877976,
2163 htlc_minimum_msat: 2316138423780173,
2164 feerate_per_kw: 821716,
2165 to_self_delay: 49340,
2166 max_accepted_htlcs: 49340,
2167 funding_pubkey: pubkey_1,
2168 revocation_basepoint: pubkey_2,
2169 payment_point: pubkey_3,
2170 delayed_payment_basepoint: pubkey_4,
2171 htlc_basepoint: pubkey_5,
2172 first_per_commitment_point: pubkey_6,
2173 channel_flags: if random_bit { 1 << 5 } else { 0 },
2174 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2176 let encoded_value = open_channel.encode();
2177 let mut target_value = Vec::new();
2178 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2179 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2181 target_value.append(&mut hex::decode("20").unwrap());
2183 target_value.append(&mut hex::decode("00").unwrap());
2186 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2188 assert_eq!(encoded_value, target_value);
2192 fn encoding_open_channel() {
2193 do_encoding_open_channel(false, false);
2194 do_encoding_open_channel(true, false);
2195 do_encoding_open_channel(false, true);
2196 do_encoding_open_channel(true, true);
2199 fn do_encoding_accept_channel(shutdown: bool) {
2200 let secp_ctx = Secp256k1::new();
2201 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2202 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2203 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2204 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2205 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2206 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2207 let accept_channel = msgs::AcceptChannel {
2208 temporary_channel_id: [2; 32],
2209 dust_limit_satoshis: 1311768467284833366,
2210 max_htlc_value_in_flight_msat: 2536655962884945560,
2211 channel_reserve_satoshis: 3608586615801332854,
2212 htlc_minimum_msat: 2316138423780173,
2213 minimum_depth: 821716,
2214 to_self_delay: 49340,
2215 max_accepted_htlcs: 49340,
2216 funding_pubkey: pubkey_1,
2217 revocation_basepoint: pubkey_2,
2218 payment_point: pubkey_3,
2219 delayed_payment_basepoint: pubkey_4,
2220 htlc_basepoint: pubkey_5,
2221 first_per_commitment_point: pubkey_6,
2222 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2224 let encoded_value = accept_channel.encode();
2225 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2227 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2229 assert_eq!(encoded_value, target_value);
2233 fn encoding_accept_channel() {
2234 do_encoding_accept_channel(false);
2235 do_encoding_accept_channel(true);
2239 fn encoding_funding_created() {
2240 let secp_ctx = Secp256k1::new();
2241 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2242 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2243 let funding_created = msgs::FundingCreated {
2244 temporary_channel_id: [2; 32],
2245 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2246 funding_output_index: 255,
2249 let encoded_value = funding_created.encode();
2250 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2251 assert_eq!(encoded_value, target_value);
2255 fn encoding_funding_signed() {
2256 let secp_ctx = Secp256k1::new();
2257 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2258 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2259 let funding_signed = msgs::FundingSigned {
2260 channel_id: [2; 32],
2263 let encoded_value = funding_signed.encode();
2264 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2265 assert_eq!(encoded_value, target_value);
2269 fn encoding_funding_locked() {
2270 let secp_ctx = Secp256k1::new();
2271 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2272 let funding_locked = msgs::FundingLocked {
2273 channel_id: [2; 32],
2274 next_per_commitment_point: pubkey_1,
2276 let encoded_value = funding_locked.encode();
2277 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2278 assert_eq!(encoded_value, target_value);
2281 fn do_encoding_shutdown(script_type: u8) {
2282 let secp_ctx = Secp256k1::new();
2283 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2284 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2285 let shutdown = msgs::Shutdown {
2286 channel_id: [2; 32],
2288 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2289 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2290 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2291 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2293 let encoded_value = shutdown.encode();
2294 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2295 if script_type == 1 {
2296 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2297 } else if script_type == 2 {
2298 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2299 } else if script_type == 3 {
2300 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2301 } else if script_type == 4 {
2302 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2304 assert_eq!(encoded_value, target_value);
2308 fn encoding_shutdown() {
2309 do_encoding_shutdown(1);
2310 do_encoding_shutdown(2);
2311 do_encoding_shutdown(3);
2312 do_encoding_shutdown(4);
2316 fn encoding_closing_signed() {
2317 let secp_ctx = Secp256k1::new();
2318 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2319 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2320 let closing_signed = msgs::ClosingSigned {
2321 channel_id: [2; 32],
2322 fee_satoshis: 2316138423780173,
2326 let encoded_value = closing_signed.encode();
2327 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2328 assert_eq!(encoded_value, target_value);
2329 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2331 let closing_signed_with_range = msgs::ClosingSigned {
2332 channel_id: [2; 32],
2333 fee_satoshis: 2316138423780173,
2335 fee_range: Some(msgs::ClosingSignedFeeRange {
2336 min_fee_satoshis: 0xdeadbeef,
2337 max_fee_satoshis: 0x1badcafe01234567,
2340 let encoded_value_with_range = closing_signed_with_range.encode();
2341 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2342 assert_eq!(encoded_value_with_range, target_value_with_range);
2343 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2344 closing_signed_with_range);
2348 fn encoding_update_add_htlc() {
2349 let secp_ctx = Secp256k1::new();
2350 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2351 let onion_routing_packet = msgs::OnionPacket {
2353 public_key: Ok(pubkey_1),
2354 hop_data: [1; 20*65],
2357 let update_add_htlc = msgs::UpdateAddHTLC {
2358 channel_id: [2; 32],
2359 htlc_id: 2316138423780173,
2360 amount_msat: 3608586615801332854,
2361 payment_hash: PaymentHash([1; 32]),
2362 cltv_expiry: 821716,
2363 onion_routing_packet
2365 let encoded_value = update_add_htlc.encode();
2366 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2367 assert_eq!(encoded_value, target_value);
2371 fn encoding_update_fulfill_htlc() {
2372 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2373 channel_id: [2; 32],
2374 htlc_id: 2316138423780173,
2375 payment_preimage: PaymentPreimage([1; 32]),
2377 let encoded_value = update_fulfill_htlc.encode();
2378 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2379 assert_eq!(encoded_value, target_value);
2383 fn encoding_update_fail_htlc() {
2384 let reason = OnionErrorPacket {
2385 data: [1; 32].to_vec(),
2387 let update_fail_htlc = msgs::UpdateFailHTLC {
2388 channel_id: [2; 32],
2389 htlc_id: 2316138423780173,
2392 let encoded_value = update_fail_htlc.encode();
2393 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2394 assert_eq!(encoded_value, target_value);
2398 fn encoding_update_fail_malformed_htlc() {
2399 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2400 channel_id: [2; 32],
2401 htlc_id: 2316138423780173,
2402 sha256_of_onion: [1; 32],
2405 let encoded_value = update_fail_malformed_htlc.encode();
2406 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2407 assert_eq!(encoded_value, target_value);
2410 fn do_encoding_commitment_signed(htlcs: bool) {
2411 let secp_ctx = Secp256k1::new();
2412 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2413 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2414 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2415 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2416 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2417 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2418 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2419 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2420 let commitment_signed = msgs::CommitmentSigned {
2421 channel_id: [2; 32],
2423 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2425 let encoded_value = commitment_signed.encode();
2426 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2428 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2430 target_value.append(&mut hex::decode("0000").unwrap());
2432 assert_eq!(encoded_value, target_value);
2436 fn encoding_commitment_signed() {
2437 do_encoding_commitment_signed(true);
2438 do_encoding_commitment_signed(false);
2442 fn encoding_revoke_and_ack() {
2443 let secp_ctx = Secp256k1::new();
2444 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2445 let raa = msgs::RevokeAndACK {
2446 channel_id: [2; 32],
2447 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],
2448 next_per_commitment_point: pubkey_1,
2450 let encoded_value = raa.encode();
2451 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2452 assert_eq!(encoded_value, target_value);
2456 fn encoding_update_fee() {
2457 let update_fee = msgs::UpdateFee {
2458 channel_id: [2; 32],
2459 feerate_per_kw: 20190119,
2461 let encoded_value = update_fee.encode();
2462 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2463 assert_eq!(encoded_value, target_value);
2467 fn encoding_init() {
2468 assert_eq!(msgs::Init {
2469 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2470 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2471 assert_eq!(msgs::Init {
2472 features: InitFeatures::from_le_bytes(vec![0xFF]),
2473 }.encode(), hex::decode("0001ff0001ff").unwrap());
2474 assert_eq!(msgs::Init {
2475 features: InitFeatures::from_le_bytes(vec![]),
2476 }.encode(), hex::decode("00000000").unwrap());
2480 fn encoding_error() {
2481 let error = msgs::ErrorMessage {
2482 channel_id: [2; 32],
2483 data: String::from("rust-lightning"),
2485 let encoded_value = error.encode();
2486 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2487 assert_eq!(encoded_value, target_value);
2491 fn encoding_ping() {
2492 let ping = msgs::Ping {
2496 let encoded_value = ping.encode();
2497 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2498 assert_eq!(encoded_value, target_value);
2502 fn encoding_pong() {
2503 let pong = msgs::Pong {
2506 let encoded_value = pong.encode();
2507 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2508 assert_eq!(encoded_value, target_value);
2512 fn encoding_legacy_onion_hop_data() {
2513 let msg = msgs::OnionHopData {
2514 format: OnionHopDataFormat::Legacy {
2515 short_channel_id: 0xdeadbeef1bad1dea,
2517 amt_to_forward: 0x0badf00d01020304,
2518 outgoing_cltv_value: 0xffffffff,
2520 let encoded_value = msg.encode();
2521 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2522 assert_eq!(encoded_value, target_value);
2526 fn encoding_nonfinal_onion_hop_data() {
2527 let mut msg = msgs::OnionHopData {
2528 format: OnionHopDataFormat::NonFinalNode {
2529 short_channel_id: 0xdeadbeef1bad1dea,
2531 amt_to_forward: 0x0badf00d01020304,
2532 outgoing_cltv_value: 0xffffffff,
2534 let encoded_value = msg.encode();
2535 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2536 assert_eq!(encoded_value, target_value);
2537 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2538 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2539 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2540 } else { panic!(); }
2541 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2542 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2546 fn encoding_final_onion_hop_data() {
2547 let mut msg = msgs::OnionHopData {
2548 format: OnionHopDataFormat::FinalNode {
2550 keysend_preimage: None,
2552 amt_to_forward: 0x0badf00d01020304,
2553 outgoing_cltv_value: 0xffffffff,
2555 let encoded_value = msg.encode();
2556 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2557 assert_eq!(encoded_value, target_value);
2558 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2559 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2560 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2561 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2565 fn encoding_final_onion_hop_data_with_secret() {
2566 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2567 let mut msg = msgs::OnionHopData {
2568 format: OnionHopDataFormat::FinalNode {
2569 payment_data: Some(FinalOnionHopData {
2570 payment_secret: expected_payment_secret,
2571 total_msat: 0x1badca1f
2573 keysend_preimage: None,
2575 amt_to_forward: 0x0badf00d01020304,
2576 outgoing_cltv_value: 0xffffffff,
2578 let encoded_value = msg.encode();
2579 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2580 assert_eq!(encoded_value, target_value);
2581 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2582 if let OnionHopDataFormat::FinalNode {
2583 payment_data: Some(FinalOnionHopData {
2585 total_msat: 0x1badca1f
2587 keysend_preimage: None,
2589 assert_eq!(payment_secret, expected_payment_secret);
2590 } else { panic!(); }
2591 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2592 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2596 fn query_channel_range_end_blocknum() {
2597 let tests: Vec<(u32, u32, u32)> = vec![
2598 (10000, 1500, 11500),
2599 (0, 0xffffffff, 0xffffffff),
2600 (1, 0xffffffff, 0xffffffff),
2603 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2604 let sut = msgs::QueryChannelRange {
2605 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2609 assert_eq!(sut.end_blocknum(), expected);
2614 fn encoding_query_channel_range() {
2615 let mut query_channel_range = msgs::QueryChannelRange {
2616 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2617 first_blocknum: 100000,
2618 number_of_blocks: 1500,
2620 let encoded_value = query_channel_range.encode();
2621 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2622 assert_eq!(encoded_value, target_value);
2624 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2625 assert_eq!(query_channel_range.first_blocknum, 100000);
2626 assert_eq!(query_channel_range.number_of_blocks, 1500);
2630 fn encoding_reply_channel_range() {
2631 do_encoding_reply_channel_range(0);
2632 do_encoding_reply_channel_range(1);
2635 fn do_encoding_reply_channel_range(encoding_type: u8) {
2636 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2637 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2638 let mut reply_channel_range = msgs::ReplyChannelRange {
2639 chain_hash: expected_chain_hash,
2640 first_blocknum: 756230,
2641 number_of_blocks: 1500,
2642 sync_complete: true,
2643 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2646 if encoding_type == 0 {
2647 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2648 let encoded_value = reply_channel_range.encode();
2649 assert_eq!(encoded_value, target_value);
2651 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2652 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2653 assert_eq!(reply_channel_range.first_blocknum, 756230);
2654 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2655 assert_eq!(reply_channel_range.sync_complete, true);
2656 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2657 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2658 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2660 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2661 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2662 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2667 fn encoding_query_short_channel_ids() {
2668 do_encoding_query_short_channel_ids(0);
2669 do_encoding_query_short_channel_ids(1);
2672 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2673 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2674 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2675 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2676 chain_hash: expected_chain_hash,
2677 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2680 if encoding_type == 0 {
2681 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2682 let encoded_value = query_short_channel_ids.encode();
2683 assert_eq!(encoded_value, target_value);
2685 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2686 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2687 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2688 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2689 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2691 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2692 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2693 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2698 fn encoding_reply_short_channel_ids_end() {
2699 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2700 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2701 chain_hash: expected_chain_hash,
2702 full_information: true,
2704 let encoded_value = reply_short_channel_ids_end.encode();
2705 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2706 assert_eq!(encoded_value, target_value);
2708 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2709 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2710 assert_eq!(reply_short_channel_ids_end.full_information, true);
2714 fn encoding_gossip_timestamp_filter(){
2715 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2716 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2717 chain_hash: expected_chain_hash,
2718 first_timestamp: 1590000000,
2719 timestamp_range: 0xffff_ffff,
2721 let encoded_value = gossip_timestamp_filter.encode();
2722 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2723 assert_eq!(encoded_value, target_value);
2725 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2726 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2727 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2728 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);