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::PublicKey;
28 use bitcoin::secp256k1::ecdsa::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
34 use crate::ln::onion_utils;
35 use crate::onion_message;
37 use crate::prelude::*;
40 use crate::io::{self, Read};
41 use crate::io_extras::read_to_end;
43 use crate::util::events::{MessageSendEventsProvider, OnionMessageProvider};
44 use crate::util::logger;
45 use crate::util::ser::{LengthReadable, Readable, ReadableArgs, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname};
47 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
49 /// 21 million * 10^8 * 1000
50 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
52 /// An error in decoding a message or struct.
53 #[derive(Clone, Debug, PartialEq, Eq)]
54 pub enum DecodeError {
55 /// A version byte specified something we don't know how to handle.
56 /// Includes unknown realm byte in an OnionHopData packet
58 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
59 UnknownRequiredFeature,
60 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
61 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
62 /// syntactically incorrect, etc
66 /// A length descriptor in the packet didn't describe the later data correctly
68 /// Error from std::io
70 /// The message included zlib-compressed values, which we don't support.
71 UnsupportedCompression,
74 /// An init message to be sent or received from a peer
75 #[derive(Clone, Debug, PartialEq, Eq)]
77 /// The relevant features which the sender supports
78 pub features: InitFeatures,
79 /// The receipient's network address. This adds the option to report a remote IP address
80 /// back to a connecting peer using the init message. A node can decide to use that information
81 /// to discover a potential update to its public IPv4 address (NAT) and use
82 /// that for a node_announcement update message containing the new address.
83 pub remote_network_address: Option<NetAddress>,
86 /// An error message to be sent or received from a peer
87 #[derive(Clone, Debug, PartialEq, Eq)]
88 pub struct ErrorMessage {
89 /// The channel ID involved in the error.
91 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
92 /// with the sending peer should be closed.
93 pub channel_id: [u8; 32],
94 /// A possibly human-readable error description.
95 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
96 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
97 /// the terminal emulator or the logging subsystem.
101 /// A warning message to be sent or received from a peer
102 #[derive(Clone, Debug, PartialEq, Eq)]
103 pub struct WarningMessage {
104 /// The channel ID involved in the warning.
106 /// All-0s indicates a warning unrelated to a specific channel.
107 pub channel_id: [u8; 32],
108 /// A possibly human-readable warning description.
109 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
110 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
111 /// the terminal emulator or the logging subsystem.
115 /// A ping message to be sent or received from a peer
116 #[derive(Clone, Debug, PartialEq, Eq)]
118 /// The desired response length
120 /// The ping packet size.
121 /// This field is not sent on the wire. byteslen zeros are sent.
125 /// A pong message to be sent or received from a peer
126 #[derive(Clone, Debug, PartialEq, Eq)]
128 /// The pong packet size.
129 /// This field is not sent on the wire. byteslen zeros are sent.
133 /// An open_channel message to be sent or received from a peer
134 #[derive(Clone, Debug, PartialEq, Eq)]
135 pub struct OpenChannel {
136 /// The genesis hash of the blockchain where the channel is to be opened
137 pub chain_hash: BlockHash,
138 /// A temporary channel ID, until the funding outpoint is announced
139 pub temporary_channel_id: [u8; 32],
140 /// The channel value
141 pub funding_satoshis: u64,
142 /// The amount to push to the counterparty as part of the open, in milli-satoshi
144 /// The threshold below which outputs on transactions broadcast by sender will be omitted
145 pub dust_limit_satoshis: u64,
146 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
147 pub max_htlc_value_in_flight_msat: u64,
148 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
149 pub channel_reserve_satoshis: u64,
150 /// The minimum HTLC size incoming to sender, in milli-satoshi
151 pub htlc_minimum_msat: u64,
152 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
153 pub feerate_per_kw: u32,
154 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
155 pub to_self_delay: u16,
156 /// The maximum number of inbound HTLCs towards sender
157 pub max_accepted_htlcs: u16,
158 /// The sender's key controlling the funding transaction
159 pub funding_pubkey: PublicKey,
160 /// Used to derive a revocation key for transactions broadcast by counterparty
161 pub revocation_basepoint: PublicKey,
162 /// A payment key to sender for transactions broadcast by counterparty
163 pub payment_point: PublicKey,
164 /// Used to derive a payment key to sender for transactions broadcast by sender
165 pub delayed_payment_basepoint: PublicKey,
166 /// Used to derive an HTLC payment key to sender
167 pub htlc_basepoint: PublicKey,
168 /// The first to-be-broadcast-by-sender transaction's per commitment point
169 pub first_per_commitment_point: PublicKey,
171 pub channel_flags: u8,
172 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
173 pub shutdown_scriptpubkey: OptionalField<Script>,
174 /// The channel type that this channel will represent. If none is set, we derive the channel
175 /// type from the intersection of our feature bits with our counterparty's feature bits from
176 /// the Init message.
177 pub channel_type: Option<ChannelTypeFeatures>,
180 /// An accept_channel message to be sent or received from a peer
181 #[derive(Clone, Debug, PartialEq, Eq)]
182 pub struct AcceptChannel {
183 /// A temporary channel ID, until the funding outpoint is announced
184 pub temporary_channel_id: [u8; 32],
185 /// The threshold below which outputs on transactions broadcast by sender will be omitted
186 pub dust_limit_satoshis: u64,
187 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
188 pub max_htlc_value_in_flight_msat: u64,
189 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
190 pub channel_reserve_satoshis: u64,
191 /// The minimum HTLC size incoming to sender, in milli-satoshi
192 pub htlc_minimum_msat: u64,
193 /// Minimum depth of the funding transaction before the channel is considered open
194 pub minimum_depth: u32,
195 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
196 pub to_self_delay: u16,
197 /// The maximum number of inbound HTLCs towards sender
198 pub max_accepted_htlcs: u16,
199 /// The sender's key controlling the funding transaction
200 pub funding_pubkey: PublicKey,
201 /// Used to derive a revocation key for transactions broadcast by counterparty
202 pub revocation_basepoint: PublicKey,
203 /// A payment key to sender for transactions broadcast by counterparty
204 pub payment_point: PublicKey,
205 /// Used to derive a payment key to sender for transactions broadcast by sender
206 pub delayed_payment_basepoint: PublicKey,
207 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
208 pub htlc_basepoint: PublicKey,
209 /// The first to-be-broadcast-by-sender transaction's per commitment point
210 pub first_per_commitment_point: PublicKey,
211 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
212 pub shutdown_scriptpubkey: OptionalField<Script>,
213 /// The channel type that this channel will represent. If none is set, we derive the channel
214 /// type from the intersection of our feature bits with our counterparty's feature bits from
215 /// the Init message.
217 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
218 pub channel_type: Option<ChannelTypeFeatures>,
221 /// A funding_created message to be sent or received from a peer
222 #[derive(Clone, Debug, PartialEq, Eq)]
223 pub struct FundingCreated {
224 /// A temporary channel ID, until the funding is established
225 pub temporary_channel_id: [u8; 32],
226 /// The funding transaction ID
227 pub funding_txid: Txid,
228 /// The specific output index funding this channel
229 pub funding_output_index: u16,
230 /// The signature of the channel initiator (funder) on the initial commitment transaction
231 pub signature: Signature,
234 /// A funding_signed message to be sent or received from a peer
235 #[derive(Clone, Debug, PartialEq, Eq)]
236 pub struct FundingSigned {
238 pub channel_id: [u8; 32],
239 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
240 pub signature: Signature,
243 /// A channel_ready message to be sent or received from a peer
244 #[derive(Clone, Debug, PartialEq, Eq)]
245 pub struct ChannelReady {
247 pub channel_id: [u8; 32],
248 /// The per-commitment point of the second commitment transaction
249 pub next_per_commitment_point: PublicKey,
250 /// If set, provides a short_channel_id alias for this channel. The sender will accept payments
251 /// to be forwarded over this SCID and forward them to this messages' recipient.
252 pub short_channel_id_alias: Option<u64>,
255 /// A shutdown message to be sent or received from a peer
256 #[derive(Clone, Debug, PartialEq, Eq)]
257 pub struct Shutdown {
259 pub channel_id: [u8; 32],
260 /// The destination of this peer's funds on closing.
261 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
262 pub scriptpubkey: Script,
265 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
266 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
268 #[derive(Clone, Debug, PartialEq, Eq)]
269 pub struct ClosingSignedFeeRange {
270 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
272 pub min_fee_satoshis: u64,
273 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
275 pub max_fee_satoshis: u64,
278 /// A closing_signed message to be sent or received from a peer
279 #[derive(Clone, Debug, PartialEq, Eq)]
280 pub struct ClosingSigned {
282 pub channel_id: [u8; 32],
283 /// The proposed total fee for the closing transaction
284 pub fee_satoshis: u64,
285 /// A signature on the closing transaction
286 pub signature: Signature,
287 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
289 pub fee_range: Option<ClosingSignedFeeRange>,
292 /// An update_add_htlc message to be sent or received from a peer
293 #[derive(Clone, Debug, PartialEq, Eq)]
294 pub struct UpdateAddHTLC {
296 pub channel_id: [u8; 32],
299 /// The HTLC value in milli-satoshi
300 pub amount_msat: u64,
301 /// The payment hash, the pre-image of which controls HTLC redemption
302 pub payment_hash: PaymentHash,
303 /// The expiry height of the HTLC
304 pub cltv_expiry: u32,
305 pub(crate) onion_routing_packet: OnionPacket,
308 /// An onion message to be sent or received from a peer
309 #[derive(Clone, Debug, PartialEq, Eq)]
310 pub struct OnionMessage {
311 /// Used in decrypting the onion packet's payload.
312 pub blinding_point: PublicKey,
313 pub(crate) onion_routing_packet: onion_message::Packet,
316 /// An update_fulfill_htlc message to be sent or received from a peer
317 #[derive(Clone, Debug, PartialEq, Eq)]
318 pub struct UpdateFulfillHTLC {
320 pub channel_id: [u8; 32],
323 /// The pre-image of the payment hash, allowing HTLC redemption
324 pub payment_preimage: PaymentPreimage,
327 /// An update_fail_htlc message to be sent or received from a peer
328 #[derive(Clone, Debug, PartialEq, Eq)]
329 pub struct UpdateFailHTLC {
331 pub channel_id: [u8; 32],
334 pub(crate) reason: OnionErrorPacket,
337 /// An update_fail_malformed_htlc message to be sent or received from a peer
338 #[derive(Clone, Debug, PartialEq, Eq)]
339 pub struct UpdateFailMalformedHTLC {
341 pub channel_id: [u8; 32],
344 pub(crate) sha256_of_onion: [u8; 32],
346 pub failure_code: u16,
349 /// A commitment_signed message to be sent or received from a peer
350 #[derive(Clone, Debug, PartialEq, Eq)]
351 pub struct CommitmentSigned {
353 pub channel_id: [u8; 32],
354 /// A signature on the commitment transaction
355 pub signature: Signature,
356 /// Signatures on the HTLC transactions
357 pub htlc_signatures: Vec<Signature>,
360 /// A revoke_and_ack message to be sent or received from a peer
361 #[derive(Clone, Debug, PartialEq, Eq)]
362 pub struct RevokeAndACK {
364 pub channel_id: [u8; 32],
365 /// The secret corresponding to the per-commitment point
366 pub per_commitment_secret: [u8; 32],
367 /// The next sender-broadcast commitment transaction's per-commitment point
368 pub next_per_commitment_point: PublicKey,
371 /// An update_fee message to be sent or received from a peer
372 #[derive(Clone, Debug, PartialEq, Eq)]
373 pub struct UpdateFee {
375 pub channel_id: [u8; 32],
376 /// Fee rate per 1000-weight of the transaction
377 pub feerate_per_kw: u32,
380 #[derive(Clone, Debug, PartialEq, Eq)]
381 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
382 /// This is used to convince the recipient that the channel is at a certain commitment
383 /// number even if they lost that data due to a local failure. Of course, the peer may lie
384 /// and even later commitments may have been revoked.
385 pub struct DataLossProtect {
386 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
387 /// belonging to the recipient
388 pub your_last_per_commitment_secret: [u8; 32],
389 /// The sender's per-commitment point for their current commitment transaction
390 pub my_current_per_commitment_point: PublicKey,
393 /// A channel_reestablish message to be sent or received from a peer
394 #[derive(Clone, Debug, PartialEq, Eq)]
395 pub struct ChannelReestablish {
397 pub channel_id: [u8; 32],
398 /// The next commitment number for the sender
399 pub next_local_commitment_number: u64,
400 /// The next commitment number for the recipient
401 pub next_remote_commitment_number: u64,
402 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
403 pub data_loss_protect: OptionalField<DataLossProtect>,
406 /// An announcement_signatures message to be sent or received from a peer
407 #[derive(Clone, Debug, PartialEq, Eq)]
408 pub struct AnnouncementSignatures {
410 pub channel_id: [u8; 32],
411 /// The short channel ID
412 pub short_channel_id: u64,
413 /// A signature by the node key
414 pub node_signature: Signature,
415 /// A signature by the funding key
416 pub bitcoin_signature: Signature,
419 /// An address which can be used to connect to a remote peer
420 #[derive(Clone, Debug, PartialEq, Eq)]
421 pub enum NetAddress {
422 /// An IPv4 address/port on which the peer is listening.
424 /// The 4-byte IPv4 address
426 /// The port on which the node is listening
429 /// An IPv6 address/port on which the peer is listening.
431 /// The 16-byte IPv6 address
433 /// The port on which the node is listening
436 /// An old-style Tor onion address/port on which the peer is listening.
438 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
439 /// addresses. Thus, the details are not parsed here.
441 /// A new-style Tor onion address/port on which the peer is listening.
442 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
443 /// wrap as base32 and append ".onion".
445 /// The ed25519 long-term public key of the peer
446 ed25519_pubkey: [u8; 32],
447 /// The checksum of the pubkey and version, as included in the onion address
449 /// The version byte, as defined by the Tor Onion v3 spec.
451 /// The port on which the node is listening
454 /// A hostname/port on which the peer is listening.
456 /// The hostname on which the node is listening.
458 /// The port on which the node is listening.
463 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
465 pub(crate) fn get_id(&self) -> u8 {
467 &NetAddress::IPv4 {..} => { 1 },
468 &NetAddress::IPv6 {..} => { 2 },
469 &NetAddress::OnionV2(_) => { 3 },
470 &NetAddress::OnionV3 {..} => { 4 },
471 &NetAddress::Hostname {..} => { 5 },
475 /// Strict byte-length of address descriptor, 1-byte type not recorded
476 fn len(&self) -> u16 {
478 &NetAddress::IPv4 { .. } => { 6 },
479 &NetAddress::IPv6 { .. } => { 18 },
480 &NetAddress::OnionV2(_) => { 12 },
481 &NetAddress::OnionV3 { .. } => { 37 },
482 // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
483 &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
487 /// The maximum length of any address descriptor, not including the 1-byte type.
488 /// This maximum length is reached by a hostname address descriptor:
489 /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
490 pub(crate) const MAX_LEN: u16 = 258;
493 impl Writeable for NetAddress {
494 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
496 &NetAddress::IPv4 { ref addr, ref port } => {
501 &NetAddress::IPv6 { ref addr, ref port } => {
506 &NetAddress::OnionV2(bytes) => {
508 bytes.write(writer)?;
510 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
512 ed25519_pubkey.write(writer)?;
513 checksum.write(writer)?;
514 version.write(writer)?;
517 &NetAddress::Hostname { ref hostname, ref port } => {
519 hostname.write(writer)?;
527 impl Readable for Result<NetAddress, u8> {
528 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
529 let byte = <u8 as Readable>::read(reader)?;
532 Ok(Ok(NetAddress::IPv4 {
533 addr: Readable::read(reader)?,
534 port: Readable::read(reader)?,
538 Ok(Ok(NetAddress::IPv6 {
539 addr: Readable::read(reader)?,
540 port: Readable::read(reader)?,
543 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
545 Ok(Ok(NetAddress::OnionV3 {
546 ed25519_pubkey: Readable::read(reader)?,
547 checksum: Readable::read(reader)?,
548 version: Readable::read(reader)?,
549 port: Readable::read(reader)?,
553 Ok(Ok(NetAddress::Hostname {
554 hostname: Readable::read(reader)?,
555 port: Readable::read(reader)?,
558 _ => return Ok(Err(byte)),
563 impl Readable for NetAddress {
564 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
565 match Readable::read(reader) {
566 Ok(Ok(res)) => Ok(res),
567 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
574 /// The unsigned part of a node_announcement
575 #[derive(Clone, Debug, PartialEq, Eq)]
576 pub struct UnsignedNodeAnnouncement {
577 /// The advertised features
578 pub features: NodeFeatures,
579 /// A strictly monotonic announcement counter, with gaps allowed
581 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
583 pub node_id: PublicKey,
584 /// An RGB color for UI purposes
586 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
589 /// List of addresses on which this node is reachable
590 pub addresses: Vec<NetAddress>,
591 pub(crate) excess_address_data: Vec<u8>,
592 pub(crate) excess_data: Vec<u8>,
594 #[derive(Clone, Debug, PartialEq, Eq)]
595 /// A node_announcement message to be sent or received from a peer
596 pub struct NodeAnnouncement {
597 /// The signature by the node key
598 pub signature: Signature,
599 /// The actual content of the announcement
600 pub contents: UnsignedNodeAnnouncement,
603 /// The unsigned part of a channel_announcement
604 #[derive(Clone, Debug, PartialEq, Eq)]
605 pub struct UnsignedChannelAnnouncement {
606 /// The advertised channel features
607 pub features: ChannelFeatures,
608 /// The genesis hash of the blockchain where the channel is to be opened
609 pub chain_hash: BlockHash,
610 /// The short channel ID
611 pub short_channel_id: u64,
612 /// One of the two node_ids which are endpoints of this channel
613 pub node_id_1: PublicKey,
614 /// The other of the two node_ids which are endpoints of this channel
615 pub node_id_2: PublicKey,
616 /// The funding key for the first node
617 pub bitcoin_key_1: PublicKey,
618 /// The funding key for the second node
619 pub bitcoin_key_2: PublicKey,
620 pub(crate) excess_data: Vec<u8>,
622 /// A channel_announcement message to be sent or received from a peer
623 #[derive(Clone, Debug, PartialEq, Eq)]
624 pub struct ChannelAnnouncement {
625 /// Authentication of the announcement by the first public node
626 pub node_signature_1: Signature,
627 /// Authentication of the announcement by the second public node
628 pub node_signature_2: Signature,
629 /// Proof of funding UTXO ownership by the first public node
630 pub bitcoin_signature_1: Signature,
631 /// Proof of funding UTXO ownership by the second public node
632 pub bitcoin_signature_2: Signature,
633 /// The actual announcement
634 pub contents: UnsignedChannelAnnouncement,
637 /// The unsigned part of a channel_update
638 #[derive(Clone, Debug, PartialEq, Eq)]
639 pub struct UnsignedChannelUpdate {
640 /// The genesis hash of the blockchain where the channel is to be opened
641 pub chain_hash: BlockHash,
642 /// The short channel ID
643 pub short_channel_id: u64,
644 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
648 /// The number of blocks such that if:
649 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
650 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
651 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
652 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
653 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
654 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
655 /// constructing the route.
656 pub cltv_expiry_delta: u16,
657 /// The minimum HTLC size incoming to sender, in milli-satoshi
658 pub htlc_minimum_msat: u64,
659 /// The maximum HTLC value incoming to sender, in milli-satoshi. Used to be optional.
660 pub htlc_maximum_msat: u64,
661 /// The base HTLC fee charged by sender, in milli-satoshi
662 pub fee_base_msat: u32,
663 /// The amount to fee multiplier, in micro-satoshi
664 pub fee_proportional_millionths: u32,
665 /// Excess data which was signed as a part of the message which we do not (yet) understand how
666 /// to decode. This is stored to ensure forward-compatibility as new fields are added to the
668 pub excess_data: Vec<u8>,
670 /// A channel_update message to be sent or received from a peer
671 #[derive(Clone, Debug, PartialEq, Eq)]
672 pub struct ChannelUpdate {
673 /// A signature of the channel update
674 pub signature: Signature,
675 /// The actual channel update
676 pub contents: UnsignedChannelUpdate,
679 /// A query_channel_range message is used to query a peer for channel
680 /// UTXOs in a range of blocks. The recipient of a query makes a best
681 /// effort to reply to the query using one or more reply_channel_range
683 #[derive(Clone, Debug, PartialEq, Eq)]
684 pub struct QueryChannelRange {
685 /// The genesis hash of the blockchain being queried
686 pub chain_hash: BlockHash,
687 /// The height of the first block for the channel UTXOs being queried
688 pub first_blocknum: u32,
689 /// The number of blocks to include in the query results
690 pub number_of_blocks: u32,
693 /// A reply_channel_range message is a reply to a query_channel_range
694 /// message. Multiple reply_channel_range messages can be sent in reply
695 /// to a single query_channel_range message. The query recipient makes a
696 /// best effort to respond based on their local network view which may
697 /// not be a perfect view of the network. The short_channel_ids in the
698 /// reply are encoded. We only support encoding_type=0 uncompressed
699 /// serialization and do not support encoding_type=1 zlib serialization.
700 #[derive(Clone, Debug, PartialEq, Eq)]
701 pub struct ReplyChannelRange {
702 /// The genesis hash of the blockchain being queried
703 pub chain_hash: BlockHash,
704 /// The height of the first block in the range of the reply
705 pub first_blocknum: u32,
706 /// The number of blocks included in the range of the reply
707 pub number_of_blocks: u32,
708 /// True when this is the final reply for a query
709 pub sync_complete: bool,
710 /// The short_channel_ids in the channel range
711 pub short_channel_ids: Vec<u64>,
714 /// A query_short_channel_ids message is used to query a peer for
715 /// routing gossip messages related to one or more short_channel_ids.
716 /// The query recipient will reply with the latest, if available,
717 /// channel_announcement, channel_update and node_announcement messages
718 /// it maintains for the requested short_channel_ids followed by a
719 /// reply_short_channel_ids_end message. The short_channel_ids sent in
720 /// this query are encoded. We only support encoding_type=0 uncompressed
721 /// serialization and do not support encoding_type=1 zlib serialization.
722 #[derive(Clone, Debug, PartialEq, Eq)]
723 pub struct QueryShortChannelIds {
724 /// The genesis hash of the blockchain being queried
725 pub chain_hash: BlockHash,
726 /// The short_channel_ids that are being queried
727 pub short_channel_ids: Vec<u64>,
730 /// A reply_short_channel_ids_end message is sent as a reply to a
731 /// query_short_channel_ids message. The query recipient makes a best
732 /// effort to respond based on their local network view which may not be
733 /// a perfect view of the network.
734 #[derive(Clone, Debug, PartialEq, Eq)]
735 pub struct ReplyShortChannelIdsEnd {
736 /// The genesis hash of the blockchain that was queried
737 pub chain_hash: BlockHash,
738 /// Indicates if the query recipient maintains up-to-date channel
739 /// information for the chain_hash
740 pub full_information: bool,
743 /// A gossip_timestamp_filter message is used by a node to request
744 /// gossip relay for messages in the requested time range when the
745 /// gossip_queries feature has been negotiated.
746 #[derive(Clone, Debug, PartialEq, Eq)]
747 pub struct GossipTimestampFilter {
748 /// The genesis hash of the blockchain for channel and node information
749 pub chain_hash: BlockHash,
750 /// The starting unix timestamp
751 pub first_timestamp: u32,
752 /// The range of information in seconds
753 pub timestamp_range: u32,
756 /// Encoding type for data compression of collections in gossip queries.
757 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
762 /// Used to put an error message in a LightningError
763 #[derive(Clone, Debug)]
764 pub enum ErrorAction {
765 /// The peer took some action which made us think they were useless. Disconnect them.
767 /// An error message which we should make an effort to send before we disconnect.
768 msg: Option<ErrorMessage>
770 /// The peer did something harmless that we weren't able to process, just log and ignore
771 // New code should *not* use this. New code must use IgnoreAndLog, below!
773 /// The peer did something harmless that we weren't able to meaningfully process.
774 /// If the error is logged, log it at the given level.
775 IgnoreAndLog(logger::Level),
776 /// The peer provided us with a gossip message which we'd already seen. In most cases this
777 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
778 /// our own channel announcements.
779 IgnoreDuplicateGossip,
780 /// The peer did something incorrect. Tell them.
782 /// The message to send.
785 /// The peer did something incorrect. Tell them without closing any channels.
787 /// The message to send.
789 /// The peer may have done something harmless that we weren't able to meaningfully process,
790 /// though we should still tell them about it.
791 /// If this event is logged, log it at the given level.
792 log_level: logger::Level,
796 /// An Err type for failure to process messages.
797 #[derive(Clone, Debug)]
798 pub struct LightningError {
799 /// A human-readable message describing the error
801 /// The action which should be taken against the offending peer.
802 pub action: ErrorAction,
805 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
806 /// transaction updates if they were pending.
807 #[derive(Clone, Debug, PartialEq, Eq)]
808 pub struct CommitmentUpdate {
809 /// update_add_htlc messages which should be sent
810 pub update_add_htlcs: Vec<UpdateAddHTLC>,
811 /// update_fulfill_htlc messages which should be sent
812 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
813 /// update_fail_htlc messages which should be sent
814 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
815 /// update_fail_malformed_htlc messages which should be sent
816 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
817 /// An update_fee message which should be sent
818 pub update_fee: Option<UpdateFee>,
819 /// Finally, the commitment_signed message which should be sent
820 pub commitment_signed: CommitmentSigned,
823 /// Messages could have optional fields to use with extended features
824 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
825 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
826 /// separate enum type for them.
827 /// (C-not exported) due to a free generic in T
828 #[derive(Clone, Debug, PartialEq, Eq)]
829 pub enum OptionalField<T> {
830 /// Optional field is included in message
832 /// Optional field is absent in message
836 /// A trait to describe an object which can receive channel messages.
838 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
839 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
840 pub trait ChannelMessageHandler : MessageSendEventsProvider {
842 /// Handle an incoming open_channel message from the given peer.
843 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
844 /// Handle an incoming accept_channel message from the given peer.
845 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
846 /// Handle an incoming funding_created message from the given peer.
847 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
848 /// Handle an incoming funding_signed message from the given peer.
849 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
850 /// Handle an incoming channel_ready message from the given peer.
851 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
854 /// Handle an incoming shutdown message from the given peer.
855 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
856 /// Handle an incoming closing_signed message from the given peer.
857 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
860 /// Handle an incoming update_add_htlc message from the given peer.
861 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
862 /// Handle an incoming update_fulfill_htlc message from the given peer.
863 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
864 /// Handle an incoming update_fail_htlc message from the given peer.
865 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
866 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
867 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
868 /// Handle an incoming commitment_signed message from the given peer.
869 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
870 /// Handle an incoming revoke_and_ack message from the given peer.
871 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
873 /// Handle an incoming update_fee message from the given peer.
874 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
876 // Channel-to-announce:
877 /// Handle an incoming announcement_signatures message from the given peer.
878 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
880 // Connection loss/reestablish:
881 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
882 /// is believed to be possible in the future (eg they're sending us messages we don't
883 /// understand or indicate they require unknown feature bits), no_connection_possible is set
884 /// and any outstanding channels should be failed.
886 /// Note that in some rare cases this may be called without a corresponding
887 /// [`Self::peer_connected`].
888 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
890 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
892 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
893 /// with us. Implementors should be somewhat conservative about doing so, however, as other
894 /// message handlers may still wish to communicate with this peer.
895 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init) -> Result<(), ()>;
896 /// Handle an incoming channel_reestablish message from the given peer.
897 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
899 /// Handle an incoming channel update from the given peer.
900 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
903 /// Handle an incoming error message from the given peer.
904 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
906 // Handler information:
907 /// Gets the node feature flags which this handler itself supports. All available handlers are
908 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
909 /// which are broadcasted in our [`NodeAnnouncement`] message.
910 fn provided_node_features(&self) -> NodeFeatures;
912 /// Gets the init feature flags which should be sent to the given peer. All available handlers
913 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
914 /// which are sent in our [`Init`] message.
916 /// Note that this method is called before [`Self::peer_connected`].
917 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
920 /// A trait to describe an object which can receive routing messages.
922 /// # Implementor DoS Warnings
924 /// For `gossip_queries` messages there are potential DoS vectors when handling
925 /// inbound queries. Implementors using an on-disk network graph should be aware of
926 /// repeated disk I/O for queries accessing different parts of the network graph.
927 pub trait RoutingMessageHandler : MessageSendEventsProvider {
928 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
929 /// false or returning an Err otherwise.
930 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
931 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
932 /// or returning an Err otherwise.
933 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
934 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
935 /// false or returning an Err otherwise.
936 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
937 /// Gets channel announcements and updates required to dump our routing table to a remote node,
938 /// starting at the short_channel_id indicated by starting_point and including announcements
939 /// for a single channel.
940 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
941 /// Gets a node announcement required to dump our routing table to a remote node, starting at
942 /// the node *after* the provided pubkey and including up to one announcement immediately
943 /// higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
944 /// If None is provided for starting_point, we start at the first node.
945 fn get_next_node_announcement(&self, starting_point: Option<&PublicKey>) -> Option<NodeAnnouncement>;
946 /// Called when a connection is established with a peer. This can be used to
947 /// perform routing table synchronization using a strategy defined by the
950 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
951 /// with us. Implementors should be somewhat conservative about doing so, however, as other
952 /// message handlers may still wish to communicate with this peer.
953 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init) -> Result<(), ()>;
954 /// Handles the reply of a query we initiated to learn about channels
955 /// for a given range of blocks. We can expect to receive one or more
956 /// replies to a single query.
957 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
958 /// Handles the reply of a query we initiated asking for routing gossip
959 /// messages for a list of channels. We should receive this message when
960 /// a node has completed its best effort to send us the pertaining routing
962 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
963 /// Handles when a peer asks us to send a list of short_channel_ids
964 /// for the requested range of blocks.
965 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
966 /// Handles when a peer asks us to send routing gossip messages for a
967 /// list of short_channel_ids.
968 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
970 // Handler information:
971 /// Gets the node feature flags which this handler itself supports. All available handlers are
972 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
973 /// which are broadcasted in our [`NodeAnnouncement`] message.
974 fn provided_node_features(&self) -> NodeFeatures;
975 /// Gets the init feature flags which should be sent to the given peer. All available handlers
976 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
977 /// which are sent in our [`Init`] message.
979 /// Note that this method is called before [`Self::peer_connected`].
980 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
983 /// A trait to describe an object that can receive onion messages.
984 pub trait OnionMessageHandler : OnionMessageProvider {
985 /// Handle an incoming onion_message message from the given peer.
986 fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
987 /// Called when a connection is established with a peer. Can be used to track which peers
988 /// advertise onion message support and are online.
990 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
991 /// with us. Implementors should be somewhat conservative about doing so, however, as other
992 /// message handlers may still wish to communicate with this peer.
993 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init) -> Result<(), ()>;
994 /// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
995 /// drop and refuse to forward onion messages to this peer.
997 /// Note that in some rare cases this may be called without a corresponding
998 /// [`Self::peer_connected`].
999 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
1001 // Handler information:
1002 /// Gets the node feature flags which this handler itself supports. All available handlers are
1003 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1004 /// which are broadcasted in our [`NodeAnnouncement`] message.
1005 fn provided_node_features(&self) -> NodeFeatures;
1007 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1008 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1009 /// which are sent in our [`Init`] message.
1011 /// Note that this method is called before [`Self::peer_connected`].
1012 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1015 mod fuzzy_internal_msgs {
1016 use crate::prelude::*;
1017 use crate::ln::{PaymentPreimage, PaymentSecret};
1019 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1020 // them from untrusted input):
1022 pub(crate) struct FinalOnionHopData {
1023 pub(crate) payment_secret: PaymentSecret,
1024 /// The total value, in msat, of the payment as received by the ultimate recipient.
1025 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1026 pub(crate) total_msat: u64,
1029 pub(crate) enum OnionHopDataFormat {
1031 short_channel_id: u64,
1034 payment_data: Option<FinalOnionHopData>,
1035 keysend_preimage: Option<PaymentPreimage>,
1039 pub struct OnionHopData {
1040 pub(crate) format: OnionHopDataFormat,
1041 /// The value, in msat, of the payment after this hop's fee is deducted.
1042 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1043 pub(crate) amt_to_forward: u64,
1044 pub(crate) outgoing_cltv_value: u32,
1047 pub struct DecodedOnionErrorPacket {
1048 pub(crate) hmac: [u8; 32],
1049 pub(crate) failuremsg: Vec<u8>,
1050 pub(crate) pad: Vec<u8>,
1054 pub use self::fuzzy_internal_msgs::*;
1055 #[cfg(not(fuzzing))]
1056 pub(crate) use self::fuzzy_internal_msgs::*;
1059 pub(crate) struct OnionPacket {
1060 pub(crate) version: u8,
1061 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
1062 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
1063 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
1064 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
1065 pub(crate) hop_data: [u8; 20*65],
1066 pub(crate) hmac: [u8; 32],
1069 impl onion_utils::Packet for OnionPacket {
1070 type Data = onion_utils::FixedSizeOnionPacket;
1071 fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1074 public_key: Ok(pubkey),
1075 hop_data: hop_data.0,
1081 impl Eq for OnionPacket { }
1082 impl PartialEq for OnionPacket {
1083 fn eq(&self, other: &OnionPacket) -> bool {
1084 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
1085 if i != j { return false; }
1087 self.version == other.version &&
1088 self.public_key == other.public_key &&
1089 self.hmac == other.hmac
1093 impl fmt::Debug for OnionPacket {
1094 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1095 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1099 #[derive(Clone, Debug, PartialEq, Eq)]
1100 pub(crate) struct OnionErrorPacket {
1101 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1102 // (TODO) We limit it in decode to much lower...
1103 pub(crate) data: Vec<u8>,
1106 impl fmt::Display for DecodeError {
1107 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1109 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1110 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1111 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1112 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1113 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1114 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1115 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1120 impl From<io::Error> for DecodeError {
1121 fn from(e: io::Error) -> Self {
1122 if e.kind() == io::ErrorKind::UnexpectedEof {
1123 DecodeError::ShortRead
1125 DecodeError::Io(e.kind())
1130 impl Writeable for OptionalField<Script> {
1131 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1133 OptionalField::Present(ref script) => {
1134 // Note that Writeable for script includes the 16-bit length tag for us
1137 OptionalField::Absent => {}
1143 impl Readable for OptionalField<Script> {
1144 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1145 match <u16 as Readable>::read(r) {
1147 let mut buf = vec![0; len as usize];
1148 r.read_exact(&mut buf)?;
1149 Ok(OptionalField::Present(Script::from(buf)))
1151 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1157 impl Writeable for OptionalField<u64> {
1158 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1160 OptionalField::Present(ref value) => {
1163 OptionalField::Absent => {}
1169 impl Readable for OptionalField<u64> {
1170 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1171 let value: u64 = Readable::read(r)?;
1172 Ok(OptionalField::Present(value))
1177 impl_writeable_msg!(AcceptChannel, {
1178 temporary_channel_id,
1179 dust_limit_satoshis,
1180 max_htlc_value_in_flight_msat,
1181 channel_reserve_satoshis,
1187 revocation_basepoint,
1189 delayed_payment_basepoint,
1191 first_per_commitment_point,
1192 shutdown_scriptpubkey
1194 (1, channel_type, option),
1197 impl_writeable_msg!(AnnouncementSignatures, {
1204 impl Writeable for ChannelReestablish {
1205 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1206 self.channel_id.write(w)?;
1207 self.next_local_commitment_number.write(w)?;
1208 self.next_remote_commitment_number.write(w)?;
1209 match self.data_loss_protect {
1210 OptionalField::Present(ref data_loss_protect) => {
1211 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1212 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1214 OptionalField::Absent => {}
1220 impl Readable for ChannelReestablish{
1221 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1223 channel_id: Readable::read(r)?,
1224 next_local_commitment_number: Readable::read(r)?,
1225 next_remote_commitment_number: Readable::read(r)?,
1226 data_loss_protect: {
1227 match <[u8; 32] as Readable>::read(r) {
1228 Ok(your_last_per_commitment_secret) =>
1229 OptionalField::Present(DataLossProtect {
1230 your_last_per_commitment_secret,
1231 my_current_per_commitment_point: Readable::read(r)?,
1233 Err(DecodeError::ShortRead) => OptionalField::Absent,
1234 Err(e) => return Err(e)
1241 impl_writeable_msg!(ClosingSigned,
1242 { channel_id, fee_satoshis, signature },
1243 { (1, fee_range, option) }
1246 impl_writeable!(ClosingSignedFeeRange, {
1251 impl_writeable_msg!(CommitmentSigned, {
1257 impl_writeable!(DecodedOnionErrorPacket, {
1263 impl_writeable_msg!(FundingCreated, {
1264 temporary_channel_id,
1266 funding_output_index,
1270 impl_writeable_msg!(FundingSigned, {
1275 impl_writeable_msg!(ChannelReady, {
1277 next_per_commitment_point,
1279 (1, short_channel_id_alias, option),
1282 impl Writeable for Init {
1283 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1284 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1285 // our relevant feature bits. This keeps us compatible with old nodes.
1286 self.features.write_up_to_13(w)?;
1287 self.features.write(w)?;
1288 encode_tlv_stream!(w, {
1289 (3, self.remote_network_address, option)
1295 impl Readable for Init {
1296 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1297 let global_features: InitFeatures = Readable::read(r)?;
1298 let features: InitFeatures = Readable::read(r)?;
1299 let mut remote_network_address: Option<NetAddress> = None;
1300 decode_tlv_stream!(r, {
1301 (3, remote_network_address, option)
1304 features: features.or(global_features),
1305 remote_network_address,
1310 impl_writeable_msg!(OpenChannel, {
1312 temporary_channel_id,
1315 dust_limit_satoshis,
1316 max_htlc_value_in_flight_msat,
1317 channel_reserve_satoshis,
1323 revocation_basepoint,
1325 delayed_payment_basepoint,
1327 first_per_commitment_point,
1329 shutdown_scriptpubkey
1331 (1, channel_type, option),
1334 impl_writeable_msg!(RevokeAndACK, {
1336 per_commitment_secret,
1337 next_per_commitment_point
1340 impl_writeable_msg!(Shutdown, {
1345 impl_writeable_msg!(UpdateFailHTLC, {
1351 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1358 impl_writeable_msg!(UpdateFee, {
1363 impl_writeable_msg!(UpdateFulfillHTLC, {
1369 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1370 // serialization format in a way which assumes we know the total serialized length/message end
1372 impl_writeable!(OnionErrorPacket, {
1376 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1377 // serialization format in a way which assumes we know the total serialized length/message end
1379 impl Writeable for OnionPacket {
1380 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1381 self.version.write(w)?;
1382 match self.public_key {
1383 Ok(pubkey) => pubkey.write(w)?,
1384 Err(_) => [0u8;33].write(w)?,
1386 w.write_all(&self.hop_data)?;
1387 self.hmac.write(w)?;
1392 impl Readable for OnionPacket {
1393 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1395 version: Readable::read(r)?,
1397 let mut buf = [0u8;33];
1398 r.read_exact(&mut buf)?;
1399 PublicKey::from_slice(&buf)
1401 hop_data: Readable::read(r)?,
1402 hmac: Readable::read(r)?,
1407 impl_writeable_msg!(UpdateAddHTLC, {
1413 onion_routing_packet
1416 impl Readable for OnionMessage {
1417 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1418 let blinding_point: PublicKey = Readable::read(r)?;
1419 let len: u16 = Readable::read(r)?;
1420 let mut packet_reader = FixedLengthReader::new(r, len as u64);
1421 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
1424 onion_routing_packet,
1429 impl Writeable for OnionMessage {
1430 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1431 self.blinding_point.write(w)?;
1432 let onion_packet_len = self.onion_routing_packet.serialized_length();
1433 (onion_packet_len as u16).write(w)?;
1434 self.onion_routing_packet.write(w)?;
1439 impl Writeable for FinalOnionHopData {
1440 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1441 self.payment_secret.0.write(w)?;
1442 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
1446 impl Readable for FinalOnionHopData {
1447 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1448 let secret: [u8; 32] = Readable::read(r)?;
1449 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
1450 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1454 impl Writeable for OnionHopData {
1455 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1457 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1458 encode_varint_length_prefixed_tlv!(w, {
1459 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1460 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1461 (6, short_channel_id, required)
1464 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1465 encode_varint_length_prefixed_tlv!(w, {
1466 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1467 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1468 (8, payment_data, option),
1469 (5482373484, keysend_preimage, option)
1477 impl Readable for OnionHopData {
1478 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1479 let mut amt = HighZeroBytesDroppedBigSize(0u64);
1480 let mut cltv_value = HighZeroBytesDroppedBigSize(0u32);
1481 let mut short_id: Option<u64> = None;
1482 let mut payment_data: Option<FinalOnionHopData> = None;
1483 let mut keysend_preimage: Option<PaymentPreimage> = None;
1484 read_tlv_fields!(r, {
1486 (4, cltv_value, required),
1487 (6, short_id, option),
1488 (8, payment_data, option),
1489 // See https://github.com/lightning/blips/blob/master/blip-0003.md
1490 (5482373484, keysend_preimage, option)
1493 let format = if let Some(short_channel_id) = short_id {
1494 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1495 OnionHopDataFormat::NonFinalNode {
1499 if let &Some(ref data) = &payment_data {
1500 if data.total_msat > MAX_VALUE_MSAT {
1501 return Err(DecodeError::InvalidValue);
1504 OnionHopDataFormat::FinalNode {
1510 if amt.0 > MAX_VALUE_MSAT {
1511 return Err(DecodeError::InvalidValue);
1515 amt_to_forward: amt.0,
1516 outgoing_cltv_value: cltv_value.0,
1521 // ReadableArgs because we need onion_utils::decode_next_hop to accommodate payment packets and
1522 // onion message packets.
1523 impl ReadableArgs<()> for OnionHopData {
1524 fn read<R: Read>(r: &mut R, _arg: ()) -> Result<Self, DecodeError> {
1525 <Self as Readable>::read(r)
1529 impl Writeable for Ping {
1530 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1531 self.ponglen.write(w)?;
1532 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1537 impl Readable for Ping {
1538 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1540 ponglen: Readable::read(r)?,
1542 let byteslen = Readable::read(r)?;
1543 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1550 impl Writeable for Pong {
1551 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1552 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1557 impl Readable for Pong {
1558 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1561 let byteslen = Readable::read(r)?;
1562 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1569 impl Writeable for UnsignedChannelAnnouncement {
1570 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1571 self.features.write(w)?;
1572 self.chain_hash.write(w)?;
1573 self.short_channel_id.write(w)?;
1574 self.node_id_1.write(w)?;
1575 self.node_id_2.write(w)?;
1576 self.bitcoin_key_1.write(w)?;
1577 self.bitcoin_key_2.write(w)?;
1578 w.write_all(&self.excess_data[..])?;
1583 impl Readable for UnsignedChannelAnnouncement {
1584 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1586 features: Readable::read(r)?,
1587 chain_hash: Readable::read(r)?,
1588 short_channel_id: Readable::read(r)?,
1589 node_id_1: Readable::read(r)?,
1590 node_id_2: Readable::read(r)?,
1591 bitcoin_key_1: Readable::read(r)?,
1592 bitcoin_key_2: Readable::read(r)?,
1593 excess_data: read_to_end(r)?,
1598 impl_writeable!(ChannelAnnouncement, {
1601 bitcoin_signature_1,
1602 bitcoin_signature_2,
1606 impl Writeable for UnsignedChannelUpdate {
1607 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1608 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
1609 const MESSAGE_FLAGS: u8 = 1;
1610 self.chain_hash.write(w)?;
1611 self.short_channel_id.write(w)?;
1612 self.timestamp.write(w)?;
1613 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
1614 all_flags.write(w)?;
1615 self.cltv_expiry_delta.write(w)?;
1616 self.htlc_minimum_msat.write(w)?;
1617 self.fee_base_msat.write(w)?;
1618 self.fee_proportional_millionths.write(w)?;
1619 self.htlc_maximum_msat.write(w)?;
1620 w.write_all(&self.excess_data[..])?;
1625 impl Readable for UnsignedChannelUpdate {
1626 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1628 chain_hash: Readable::read(r)?,
1629 short_channel_id: Readable::read(r)?,
1630 timestamp: Readable::read(r)?,
1632 let flags: u16 = Readable::read(r)?;
1633 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
1636 cltv_expiry_delta: Readable::read(r)?,
1637 htlc_minimum_msat: Readable::read(r)?,
1638 fee_base_msat: Readable::read(r)?,
1639 fee_proportional_millionths: Readable::read(r)?,
1640 htlc_maximum_msat: Readable::read(r)?,
1641 excess_data: read_to_end(r)?,
1646 impl_writeable!(ChannelUpdate, {
1651 impl Writeable for ErrorMessage {
1652 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1653 self.channel_id.write(w)?;
1654 (self.data.len() as u16).write(w)?;
1655 w.write_all(self.data.as_bytes())?;
1660 impl Readable for ErrorMessage {
1661 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1663 channel_id: Readable::read(r)?,
1665 let sz: usize = <u16 as Readable>::read(r)? as usize;
1666 let mut data = Vec::with_capacity(sz);
1668 r.read_exact(&mut data)?;
1669 match String::from_utf8(data) {
1671 Err(_) => return Err(DecodeError::InvalidValue),
1678 impl Writeable for WarningMessage {
1679 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1680 self.channel_id.write(w)?;
1681 (self.data.len() as u16).write(w)?;
1682 w.write_all(self.data.as_bytes())?;
1687 impl Readable for WarningMessage {
1688 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1690 channel_id: Readable::read(r)?,
1692 let sz: usize = <u16 as Readable>::read(r)? as usize;
1693 let mut data = Vec::with_capacity(sz);
1695 r.read_exact(&mut data)?;
1696 match String::from_utf8(data) {
1698 Err(_) => return Err(DecodeError::InvalidValue),
1705 impl Writeable for UnsignedNodeAnnouncement {
1706 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1707 self.features.write(w)?;
1708 self.timestamp.write(w)?;
1709 self.node_id.write(w)?;
1710 w.write_all(&self.rgb)?;
1711 self.alias.write(w)?;
1713 let mut addr_len = 0;
1714 for addr in self.addresses.iter() {
1715 addr_len += 1 + addr.len();
1717 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1718 for addr in self.addresses.iter() {
1721 w.write_all(&self.excess_address_data[..])?;
1722 w.write_all(&self.excess_data[..])?;
1727 impl Readable for UnsignedNodeAnnouncement {
1728 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1729 let features: NodeFeatures = Readable::read(r)?;
1730 let timestamp: u32 = Readable::read(r)?;
1731 let node_id: PublicKey = Readable::read(r)?;
1732 let mut rgb = [0; 3];
1733 r.read_exact(&mut rgb)?;
1734 let alias: [u8; 32] = Readable::read(r)?;
1736 let addr_len: u16 = Readable::read(r)?;
1737 let mut addresses: Vec<NetAddress> = Vec::new();
1738 let mut addr_readpos = 0;
1739 let mut excess = false;
1740 let mut excess_byte = 0;
1742 if addr_len <= addr_readpos { break; }
1743 match Readable::read(r) {
1745 if addr_len < addr_readpos + 1 + addr.len() {
1746 return Err(DecodeError::BadLengthDescriptor);
1748 addr_readpos += (1 + addr.len()) as u16;
1749 addresses.push(addr);
1751 Ok(Err(unknown_descriptor)) => {
1753 excess_byte = unknown_descriptor;
1756 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1757 Err(e) => return Err(e),
1761 let mut excess_data = vec![];
1762 let excess_address_data = if addr_readpos < addr_len {
1763 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1764 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1766 excess_address_data[0] = excess_byte;
1771 excess_data.push(excess_byte);
1775 excess_data.extend(read_to_end(r)?.iter());
1776 Ok(UnsignedNodeAnnouncement {
1783 excess_address_data,
1789 impl_writeable!(NodeAnnouncement, {
1794 impl Readable for QueryShortChannelIds {
1795 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1796 let chain_hash: BlockHash = Readable::read(r)?;
1798 let encoding_len: u16 = Readable::read(r)?;
1799 let encoding_type: u8 = Readable::read(r)?;
1801 // Must be encoding_type=0 uncompressed serialization. We do not
1802 // support encoding_type=1 zlib serialization.
1803 if encoding_type != EncodingType::Uncompressed as u8 {
1804 return Err(DecodeError::UnsupportedCompression);
1807 // We expect the encoding_len to always includes the 1-byte
1808 // encoding_type and that short_channel_ids are 8-bytes each
1809 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1810 return Err(DecodeError::InvalidValue);
1813 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1814 // less the 1-byte encoding_type
1815 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1816 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1817 for _ in 0..short_channel_id_count {
1818 short_channel_ids.push(Readable::read(r)?);
1821 Ok(QueryShortChannelIds {
1828 impl Writeable for QueryShortChannelIds {
1829 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1830 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1831 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1833 self.chain_hash.write(w)?;
1834 encoding_len.write(w)?;
1836 // We only support type=0 uncompressed serialization
1837 (EncodingType::Uncompressed as u8).write(w)?;
1839 for scid in self.short_channel_ids.iter() {
1847 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1852 impl QueryChannelRange {
1854 * Calculates the overflow safe ending block height for the query.
1855 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1857 pub fn end_blocknum(&self) -> u32 {
1858 match self.first_blocknum.checked_add(self.number_of_blocks) {
1859 Some(block) => block,
1860 None => u32::max_value(),
1865 impl_writeable_msg!(QueryChannelRange, {
1871 impl Readable for ReplyChannelRange {
1872 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1873 let chain_hash: BlockHash = Readable::read(r)?;
1874 let first_blocknum: u32 = Readable::read(r)?;
1875 let number_of_blocks: u32 = Readable::read(r)?;
1876 let sync_complete: bool = Readable::read(r)?;
1878 let encoding_len: u16 = Readable::read(r)?;
1879 let encoding_type: u8 = Readable::read(r)?;
1881 // Must be encoding_type=0 uncompressed serialization. We do not
1882 // support encoding_type=1 zlib serialization.
1883 if encoding_type != EncodingType::Uncompressed as u8 {
1884 return Err(DecodeError::UnsupportedCompression);
1887 // We expect the encoding_len to always includes the 1-byte
1888 // encoding_type and that short_channel_ids are 8-bytes each
1889 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1890 return Err(DecodeError::InvalidValue);
1893 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1894 // less the 1-byte encoding_type
1895 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1896 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1897 for _ in 0..short_channel_id_count {
1898 short_channel_ids.push(Readable::read(r)?);
1901 Ok(ReplyChannelRange {
1911 impl Writeable for ReplyChannelRange {
1912 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1913 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1914 self.chain_hash.write(w)?;
1915 self.first_blocknum.write(w)?;
1916 self.number_of_blocks.write(w)?;
1917 self.sync_complete.write(w)?;
1919 encoding_len.write(w)?;
1920 (EncodingType::Uncompressed as u8).write(w)?;
1921 for scid in self.short_channel_ids.iter() {
1929 impl_writeable_msg!(GossipTimestampFilter, {
1938 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1939 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1940 use crate::ln::msgs;
1941 use crate::ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1942 use crate::util::ser::{Writeable, Readable, Hostname};
1944 use bitcoin::hashes::hex::FromHex;
1945 use bitcoin::util::address::Address;
1946 use bitcoin::network::constants::Network;
1947 use bitcoin::blockdata::script::Builder;
1948 use bitcoin::blockdata::opcodes;
1949 use bitcoin::hash_types::{Txid, BlockHash};
1951 use bitcoin::secp256k1::{PublicKey,SecretKey};
1952 use bitcoin::secp256k1::{Secp256k1, Message};
1954 use crate::io::{self, Cursor};
1955 use crate::prelude::*;
1956 use core::convert::TryFrom;
1959 fn encoding_channel_reestablish_no_secret() {
1960 let cr = msgs::ChannelReestablish {
1961 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],
1962 next_local_commitment_number: 3,
1963 next_remote_commitment_number: 4,
1964 data_loss_protect: OptionalField::Absent,
1967 let encoded_value = cr.encode();
1970 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]
1975 fn encoding_channel_reestablish_with_secret() {
1977 let secp_ctx = Secp256k1::new();
1978 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1981 let cr = msgs::ChannelReestablish {
1982 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],
1983 next_local_commitment_number: 3,
1984 next_remote_commitment_number: 4,
1985 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1988 let encoded_value = cr.encode();
1991 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]
1995 macro_rules! get_keys_from {
1996 ($slice: expr, $secp_ctx: expr) => {
1998 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1999 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2005 macro_rules! get_sig_on {
2006 ($privkey: expr, $ctx: expr, $string: expr) => {
2008 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2009 $ctx.sign_ecdsa(&sighash, &$privkey)
2015 fn encoding_announcement_signatures() {
2016 let secp_ctx = Secp256k1::new();
2017 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2018 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2019 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2020 let announcement_signatures = msgs::AnnouncementSignatures {
2021 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],
2022 short_channel_id: 2316138423780173,
2023 node_signature: sig_1,
2024 bitcoin_signature: sig_2,
2027 let encoded_value = announcement_signatures.encode();
2028 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2031 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2032 let secp_ctx = Secp256k1::new();
2033 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2034 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2035 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2036 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2037 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2038 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2039 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2040 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2041 let mut features = ChannelFeatures::empty();
2042 if unknown_features_bits {
2043 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2045 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2047 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2048 short_channel_id: 2316138423780173,
2049 node_id_1: pubkey_1,
2050 node_id_2: pubkey_2,
2051 bitcoin_key_1: pubkey_3,
2052 bitcoin_key_2: pubkey_4,
2053 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
2055 let channel_announcement = msgs::ChannelAnnouncement {
2056 node_signature_1: sig_1,
2057 node_signature_2: sig_2,
2058 bitcoin_signature_1: sig_3,
2059 bitcoin_signature_2: sig_4,
2060 contents: unsigned_channel_announcement,
2062 let encoded_value = channel_announcement.encode();
2063 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
2064 if unknown_features_bits {
2065 target_value.append(&mut hex::decode("0002ffff").unwrap());
2067 target_value.append(&mut hex::decode("0000").unwrap());
2069 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2070 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
2072 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
2074 assert_eq!(encoded_value, target_value);
2078 fn encoding_channel_announcement() {
2079 do_encoding_channel_announcement(true, false);
2080 do_encoding_channel_announcement(false, true);
2081 do_encoding_channel_announcement(false, false);
2082 do_encoding_channel_announcement(true, true);
2085 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, hostname: bool, excess_address_data: bool, excess_data: bool) {
2086 let secp_ctx = Secp256k1::new();
2087 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2088 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2089 let features = if unknown_features_bits {
2090 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2092 // Set to some features we may support
2093 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2095 let mut addresses = Vec::new();
2097 addresses.push(msgs::NetAddress::IPv4 {
2098 addr: [255, 254, 253, 252],
2103 addresses.push(msgs::NetAddress::IPv6 {
2104 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2109 addresses.push(msgs::NetAddress::OnionV2(
2110 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2114 addresses.push(msgs::NetAddress::OnionV3 {
2115 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],
2122 addresses.push(msgs::NetAddress::Hostname {
2123 hostname: Hostname::try_from(String::from("host")).unwrap(),
2127 let mut addr_len = 0;
2128 for addr in &addresses {
2129 addr_len += addr.len() + 1;
2131 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2133 timestamp: 20190119,
2138 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() },
2139 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() },
2141 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2142 let node_announcement = msgs::NodeAnnouncement {
2144 contents: unsigned_node_announcement,
2146 let encoded_value = node_announcement.encode();
2147 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2148 if unknown_features_bits {
2149 target_value.append(&mut hex::decode("0002ffff").unwrap());
2151 target_value.append(&mut hex::decode("000122").unwrap());
2153 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2154 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2156 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2159 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2162 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2165 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2168 target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2170 if excess_address_data {
2171 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2174 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2176 assert_eq!(encoded_value, target_value);
2180 fn encoding_node_announcement() {
2181 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2182 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2183 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2184 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2185 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2186 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2187 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2188 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2189 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2190 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2193 fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
2194 let secp_ctx = Secp256k1::new();
2195 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2196 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2197 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2198 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2199 short_channel_id: 2316138423780173,
2200 timestamp: 20190119,
2201 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2202 cltv_expiry_delta: 144,
2203 htlc_minimum_msat: 1000000,
2204 htlc_maximum_msat: 131355275467161,
2205 fee_base_msat: 10000,
2206 fee_proportional_millionths: 20,
2207 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2209 let channel_update = msgs::ChannelUpdate {
2211 contents: unsigned_channel_update
2213 let encoded_value = channel_update.encode();
2214 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2215 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2216 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2217 target_value.append(&mut hex::decode("01").unwrap());
2218 target_value.append(&mut hex::decode("00").unwrap());
2220 let flag = target_value.last_mut().unwrap();
2224 let flag = target_value.last_mut().unwrap();
2225 *flag = *flag | 1 << 1;
2227 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2228 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2230 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2232 assert_eq!(encoded_value, target_value);
2236 fn encoding_channel_update() {
2237 do_encoding_channel_update(false, false, false);
2238 do_encoding_channel_update(false, false, true);
2239 do_encoding_channel_update(true, false, false);
2240 do_encoding_channel_update(true, false, true);
2241 do_encoding_channel_update(false, true, false);
2242 do_encoding_channel_update(false, true, true);
2243 do_encoding_channel_update(true, true, false);
2244 do_encoding_channel_update(true, true, true);
2247 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2248 let secp_ctx = Secp256k1::new();
2249 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2250 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2251 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2252 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2253 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2254 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2255 let open_channel = msgs::OpenChannel {
2256 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2257 temporary_channel_id: [2; 32],
2258 funding_satoshis: 1311768467284833366,
2259 push_msat: 2536655962884945560,
2260 dust_limit_satoshis: 3608586615801332854,
2261 max_htlc_value_in_flight_msat: 8517154655701053848,
2262 channel_reserve_satoshis: 8665828695742877976,
2263 htlc_minimum_msat: 2316138423780173,
2264 feerate_per_kw: 821716,
2265 to_self_delay: 49340,
2266 max_accepted_htlcs: 49340,
2267 funding_pubkey: pubkey_1,
2268 revocation_basepoint: pubkey_2,
2269 payment_point: pubkey_3,
2270 delayed_payment_basepoint: pubkey_4,
2271 htlc_basepoint: pubkey_5,
2272 first_per_commitment_point: pubkey_6,
2273 channel_flags: if random_bit { 1 << 5 } else { 0 },
2274 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2275 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2277 let encoded_value = open_channel.encode();
2278 let mut target_value = Vec::new();
2279 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2280 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2282 target_value.append(&mut hex::decode("20").unwrap());
2284 target_value.append(&mut hex::decode("00").unwrap());
2287 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2290 target_value.append(&mut hex::decode("0100").unwrap());
2292 assert_eq!(encoded_value, target_value);
2296 fn encoding_open_channel() {
2297 do_encoding_open_channel(false, false, false);
2298 do_encoding_open_channel(false, false, true);
2299 do_encoding_open_channel(false, true, false);
2300 do_encoding_open_channel(false, true, true);
2301 do_encoding_open_channel(true, false, false);
2302 do_encoding_open_channel(true, false, true);
2303 do_encoding_open_channel(true, true, false);
2304 do_encoding_open_channel(true, true, true);
2307 fn do_encoding_accept_channel(shutdown: bool) {
2308 let secp_ctx = Secp256k1::new();
2309 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2310 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2311 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2312 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2313 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2314 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2315 let accept_channel = msgs::AcceptChannel {
2316 temporary_channel_id: [2; 32],
2317 dust_limit_satoshis: 1311768467284833366,
2318 max_htlc_value_in_flight_msat: 2536655962884945560,
2319 channel_reserve_satoshis: 3608586615801332854,
2320 htlc_minimum_msat: 2316138423780173,
2321 minimum_depth: 821716,
2322 to_self_delay: 49340,
2323 max_accepted_htlcs: 49340,
2324 funding_pubkey: pubkey_1,
2325 revocation_basepoint: pubkey_2,
2326 payment_point: pubkey_3,
2327 delayed_payment_basepoint: pubkey_4,
2328 htlc_basepoint: pubkey_5,
2329 first_per_commitment_point: pubkey_6,
2330 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2333 let encoded_value = accept_channel.encode();
2334 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2336 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2338 assert_eq!(encoded_value, target_value);
2342 fn encoding_accept_channel() {
2343 do_encoding_accept_channel(false);
2344 do_encoding_accept_channel(true);
2348 fn encoding_funding_created() {
2349 let secp_ctx = Secp256k1::new();
2350 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2351 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2352 let funding_created = msgs::FundingCreated {
2353 temporary_channel_id: [2; 32],
2354 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2355 funding_output_index: 255,
2358 let encoded_value = funding_created.encode();
2359 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2360 assert_eq!(encoded_value, target_value);
2364 fn encoding_funding_signed() {
2365 let secp_ctx = Secp256k1::new();
2366 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2367 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2368 let funding_signed = msgs::FundingSigned {
2369 channel_id: [2; 32],
2372 let encoded_value = funding_signed.encode();
2373 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2374 assert_eq!(encoded_value, target_value);
2378 fn encoding_channel_ready() {
2379 let secp_ctx = Secp256k1::new();
2380 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2381 let channel_ready = msgs::ChannelReady {
2382 channel_id: [2; 32],
2383 next_per_commitment_point: pubkey_1,
2384 short_channel_id_alias: None,
2386 let encoded_value = channel_ready.encode();
2387 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2388 assert_eq!(encoded_value, target_value);
2391 fn do_encoding_shutdown(script_type: u8) {
2392 let secp_ctx = Secp256k1::new();
2393 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2394 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2395 let shutdown = msgs::Shutdown {
2396 channel_id: [2; 32],
2398 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2399 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2400 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2401 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2403 let encoded_value = shutdown.encode();
2404 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2405 if script_type == 1 {
2406 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2407 } else if script_type == 2 {
2408 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2409 } else if script_type == 3 {
2410 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2411 } else if script_type == 4 {
2412 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2414 assert_eq!(encoded_value, target_value);
2418 fn encoding_shutdown() {
2419 do_encoding_shutdown(1);
2420 do_encoding_shutdown(2);
2421 do_encoding_shutdown(3);
2422 do_encoding_shutdown(4);
2426 fn encoding_closing_signed() {
2427 let secp_ctx = Secp256k1::new();
2428 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2429 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2430 let closing_signed = msgs::ClosingSigned {
2431 channel_id: [2; 32],
2432 fee_satoshis: 2316138423780173,
2436 let encoded_value = closing_signed.encode();
2437 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2438 assert_eq!(encoded_value, target_value);
2439 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2441 let closing_signed_with_range = msgs::ClosingSigned {
2442 channel_id: [2; 32],
2443 fee_satoshis: 2316138423780173,
2445 fee_range: Some(msgs::ClosingSignedFeeRange {
2446 min_fee_satoshis: 0xdeadbeef,
2447 max_fee_satoshis: 0x1badcafe01234567,
2450 let encoded_value_with_range = closing_signed_with_range.encode();
2451 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2452 assert_eq!(encoded_value_with_range, target_value_with_range);
2453 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2454 closing_signed_with_range);
2458 fn encoding_update_add_htlc() {
2459 let secp_ctx = Secp256k1::new();
2460 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2461 let onion_routing_packet = msgs::OnionPacket {
2463 public_key: Ok(pubkey_1),
2464 hop_data: [1; 20*65],
2467 let update_add_htlc = msgs::UpdateAddHTLC {
2468 channel_id: [2; 32],
2469 htlc_id: 2316138423780173,
2470 amount_msat: 3608586615801332854,
2471 payment_hash: PaymentHash([1; 32]),
2472 cltv_expiry: 821716,
2473 onion_routing_packet
2475 let encoded_value = update_add_htlc.encode();
2476 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2477 assert_eq!(encoded_value, target_value);
2481 fn encoding_update_fulfill_htlc() {
2482 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2483 channel_id: [2; 32],
2484 htlc_id: 2316138423780173,
2485 payment_preimage: PaymentPreimage([1; 32]),
2487 let encoded_value = update_fulfill_htlc.encode();
2488 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2489 assert_eq!(encoded_value, target_value);
2493 fn encoding_update_fail_htlc() {
2494 let reason = OnionErrorPacket {
2495 data: [1; 32].to_vec(),
2497 let update_fail_htlc = msgs::UpdateFailHTLC {
2498 channel_id: [2; 32],
2499 htlc_id: 2316138423780173,
2502 let encoded_value = update_fail_htlc.encode();
2503 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2504 assert_eq!(encoded_value, target_value);
2508 fn encoding_update_fail_malformed_htlc() {
2509 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2510 channel_id: [2; 32],
2511 htlc_id: 2316138423780173,
2512 sha256_of_onion: [1; 32],
2515 let encoded_value = update_fail_malformed_htlc.encode();
2516 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2517 assert_eq!(encoded_value, target_value);
2520 fn do_encoding_commitment_signed(htlcs: bool) {
2521 let secp_ctx = Secp256k1::new();
2522 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2523 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2524 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2525 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2526 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2527 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2528 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2529 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2530 let commitment_signed = msgs::CommitmentSigned {
2531 channel_id: [2; 32],
2533 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2535 let encoded_value = commitment_signed.encode();
2536 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2538 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2540 target_value.append(&mut hex::decode("0000").unwrap());
2542 assert_eq!(encoded_value, target_value);
2546 fn encoding_commitment_signed() {
2547 do_encoding_commitment_signed(true);
2548 do_encoding_commitment_signed(false);
2552 fn encoding_revoke_and_ack() {
2553 let secp_ctx = Secp256k1::new();
2554 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2555 let raa = msgs::RevokeAndACK {
2556 channel_id: [2; 32],
2557 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],
2558 next_per_commitment_point: pubkey_1,
2560 let encoded_value = raa.encode();
2561 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2562 assert_eq!(encoded_value, target_value);
2566 fn encoding_update_fee() {
2567 let update_fee = msgs::UpdateFee {
2568 channel_id: [2; 32],
2569 feerate_per_kw: 20190119,
2571 let encoded_value = update_fee.encode();
2572 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2573 assert_eq!(encoded_value, target_value);
2577 fn encoding_init() {
2578 assert_eq!(msgs::Init {
2579 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2580 remote_network_address: None,
2581 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2582 assert_eq!(msgs::Init {
2583 features: InitFeatures::from_le_bytes(vec![0xFF]),
2584 remote_network_address: None,
2585 }.encode(), hex::decode("0001ff0001ff").unwrap());
2586 assert_eq!(msgs::Init {
2587 features: InitFeatures::from_le_bytes(vec![]),
2588 remote_network_address: None,
2589 }.encode(), hex::decode("00000000").unwrap());
2591 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2592 remote_network_address: Some(msgs::NetAddress::IPv4 {
2593 addr: [127, 0, 0, 1],
2597 let encoded_value = init_msg.encode();
2598 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2599 assert_eq!(encoded_value, target_value);
2600 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2604 fn encoding_error() {
2605 let error = msgs::ErrorMessage {
2606 channel_id: [2; 32],
2607 data: String::from("rust-lightning"),
2609 let encoded_value = error.encode();
2610 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2611 assert_eq!(encoded_value, target_value);
2615 fn encoding_warning() {
2616 let error = msgs::WarningMessage {
2617 channel_id: [2; 32],
2618 data: String::from("rust-lightning"),
2620 let encoded_value = error.encode();
2621 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2622 assert_eq!(encoded_value, target_value);
2626 fn encoding_ping() {
2627 let ping = msgs::Ping {
2631 let encoded_value = ping.encode();
2632 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2633 assert_eq!(encoded_value, target_value);
2637 fn encoding_pong() {
2638 let pong = msgs::Pong {
2641 let encoded_value = pong.encode();
2642 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2643 assert_eq!(encoded_value, target_value);
2647 fn encoding_nonfinal_onion_hop_data() {
2648 let mut msg = msgs::OnionHopData {
2649 format: OnionHopDataFormat::NonFinalNode {
2650 short_channel_id: 0xdeadbeef1bad1dea,
2652 amt_to_forward: 0x0badf00d01020304,
2653 outgoing_cltv_value: 0xffffffff,
2655 let encoded_value = msg.encode();
2656 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2657 assert_eq!(encoded_value, target_value);
2658 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2659 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2660 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2661 } else { panic!(); }
2662 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2663 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2667 fn encoding_final_onion_hop_data() {
2668 let mut msg = msgs::OnionHopData {
2669 format: OnionHopDataFormat::FinalNode {
2671 keysend_preimage: None,
2673 amt_to_forward: 0x0badf00d01020304,
2674 outgoing_cltv_value: 0xffffffff,
2676 let encoded_value = msg.encode();
2677 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2678 assert_eq!(encoded_value, target_value);
2679 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2680 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2681 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2682 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2686 fn encoding_final_onion_hop_data_with_secret() {
2687 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2688 let mut msg = msgs::OnionHopData {
2689 format: OnionHopDataFormat::FinalNode {
2690 payment_data: Some(FinalOnionHopData {
2691 payment_secret: expected_payment_secret,
2692 total_msat: 0x1badca1f
2694 keysend_preimage: None,
2696 amt_to_forward: 0x0badf00d01020304,
2697 outgoing_cltv_value: 0xffffffff,
2699 let encoded_value = msg.encode();
2700 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2701 assert_eq!(encoded_value, target_value);
2702 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2703 if let OnionHopDataFormat::FinalNode {
2704 payment_data: Some(FinalOnionHopData {
2706 total_msat: 0x1badca1f
2708 keysend_preimage: None,
2710 assert_eq!(payment_secret, expected_payment_secret);
2711 } else { panic!(); }
2712 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2713 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2717 fn query_channel_range_end_blocknum() {
2718 let tests: Vec<(u32, u32, u32)> = vec![
2719 (10000, 1500, 11500),
2720 (0, 0xffffffff, 0xffffffff),
2721 (1, 0xffffffff, 0xffffffff),
2724 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2725 let sut = msgs::QueryChannelRange {
2726 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2730 assert_eq!(sut.end_blocknum(), expected);
2735 fn encoding_query_channel_range() {
2736 let mut query_channel_range = msgs::QueryChannelRange {
2737 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2738 first_blocknum: 100000,
2739 number_of_blocks: 1500,
2741 let encoded_value = query_channel_range.encode();
2742 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2743 assert_eq!(encoded_value, target_value);
2745 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2746 assert_eq!(query_channel_range.first_blocknum, 100000);
2747 assert_eq!(query_channel_range.number_of_blocks, 1500);
2751 fn encoding_reply_channel_range() {
2752 do_encoding_reply_channel_range(0);
2753 do_encoding_reply_channel_range(1);
2756 fn do_encoding_reply_channel_range(encoding_type: u8) {
2757 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2758 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2759 let mut reply_channel_range = msgs::ReplyChannelRange {
2760 chain_hash: expected_chain_hash,
2761 first_blocknum: 756230,
2762 number_of_blocks: 1500,
2763 sync_complete: true,
2764 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2767 if encoding_type == 0 {
2768 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2769 let encoded_value = reply_channel_range.encode();
2770 assert_eq!(encoded_value, target_value);
2772 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2773 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2774 assert_eq!(reply_channel_range.first_blocknum, 756230);
2775 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2776 assert_eq!(reply_channel_range.sync_complete, true);
2777 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2778 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2779 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2781 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2782 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2783 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2788 fn encoding_query_short_channel_ids() {
2789 do_encoding_query_short_channel_ids(0);
2790 do_encoding_query_short_channel_ids(1);
2793 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2794 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2795 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2796 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2797 chain_hash: expected_chain_hash,
2798 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2801 if encoding_type == 0 {
2802 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2803 let encoded_value = query_short_channel_ids.encode();
2804 assert_eq!(encoded_value, target_value);
2806 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2807 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2808 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2809 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2810 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2812 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2813 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2814 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2819 fn encoding_reply_short_channel_ids_end() {
2820 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2821 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2822 chain_hash: expected_chain_hash,
2823 full_information: true,
2825 let encoded_value = reply_short_channel_ids_end.encode();
2826 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2827 assert_eq!(encoded_value, target_value);
2829 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2830 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2831 assert_eq!(reply_short_channel_ids_end.full_information, true);
2835 fn encoding_gossip_timestamp_filter(){
2836 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2837 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2838 chain_hash: expected_chain_hash,
2839 first_timestamp: 1590000000,
2840 timestamp_range: 0xffff_ffff,
2842 let encoded_value = gossip_timestamp_filter.encode();
2843 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2844 assert_eq!(encoded_value, target_value);
2846 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2847 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2848 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2849 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
2853 fn decode_onion_hop_data_len_as_bigsize() {
2854 // Tests that we can decode an onion payload that is >253 bytes.
2855 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
2856 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
2859 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
2860 // payload length to be encoded over multiple bytes rather than a single u8.
2861 let big_payload = encode_big_payload().unwrap();
2862 let mut rd = Cursor::new(&big_payload[..]);
2863 <msgs::OnionHopData as Readable>::read(&mut rd).unwrap();
2865 // see above test, needs to be a separate method for use of the serialization macros.
2866 fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
2867 use crate::util::ser::HighZeroBytesDroppedBigSize;
2868 let payload = msgs::OnionHopData {
2869 format: OnionHopDataFormat::NonFinalNode {
2870 short_channel_id: 0xdeadbeef1bad1dea,
2872 amt_to_forward: 1000,
2873 outgoing_cltv_value: 0xffffffff,
2875 let mut encoded_payload = Vec::new();
2876 let test_bytes = vec![42u8; 1000];
2877 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = payload.format {
2878 encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
2879 (1, test_bytes, vec_type),
2880 (2, HighZeroBytesDroppedBigSize(payload.amt_to_forward), required),
2881 (4, HighZeroBytesDroppedBigSize(payload.outgoing_cltv_value), required),
2882 (6, short_channel_id, required)