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 ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
41 use io_extras::read_to_end;
43 use util::events::{MessageSendEventsProvider, OnionMessageProvider};
45 use util::ser::{BigSize, LengthReadable, Readable, ReadableArgs, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname};
47 use 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)]
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
69 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
71 /// The message included zlib-compressed values, which we don't support.
72 UnsupportedCompression,
75 /// An init message to be sent or received from a peer
76 #[derive(Clone, Debug, PartialEq)]
78 /// The relevant features which the sender supports
79 pub features: InitFeatures,
80 /// The receipient's network address. This adds the option to report a remote IP address
81 /// back to a connecting peer using the init message. A node can decide to use that information
82 /// to discover a potential update to its public IPv4 address (NAT) and use
83 /// that for a node_announcement update message containing the new address.
84 pub remote_network_address: Option<NetAddress>,
87 /// An error message to be sent or received from a peer
88 #[derive(Clone, Debug, PartialEq)]
89 pub struct ErrorMessage {
90 /// The channel ID involved in the error.
92 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
93 /// with the sending peer should be closed.
94 pub channel_id: [u8; 32],
95 /// A possibly human-readable error description.
96 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
97 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
98 /// the terminal emulator or the logging subsystem.
102 /// A warning message to be sent or received from a peer
103 #[derive(Clone, Debug, PartialEq)]
104 pub struct WarningMessage {
105 /// The channel ID involved in the warning.
107 /// All-0s indicates a warning unrelated to a specific channel.
108 pub channel_id: [u8; 32],
109 /// A possibly human-readable warning description.
110 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
111 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
112 /// the terminal emulator or the logging subsystem.
116 /// A ping message to be sent or received from a peer
117 #[derive(Clone, Debug, PartialEq)]
119 /// The desired response length
121 /// The ping packet size.
122 /// This field is not sent on the wire. byteslen zeros are sent.
126 /// A pong message to be sent or received from a peer
127 #[derive(Clone, Debug, PartialEq)]
129 /// The pong packet size.
130 /// This field is not sent on the wire. byteslen zeros are sent.
134 /// An open_channel message to be sent or received from a peer
135 #[derive(Clone, Debug, PartialEq)]
136 pub struct OpenChannel {
137 /// The genesis hash of the blockchain where the channel is to be opened
138 pub chain_hash: BlockHash,
139 /// A temporary channel ID, until the funding outpoint is announced
140 pub temporary_channel_id: [u8; 32],
141 /// The channel value
142 pub funding_satoshis: u64,
143 /// The amount to push to the counterparty as part of the open, in milli-satoshi
145 /// The threshold below which outputs on transactions broadcast by sender will be omitted
146 pub dust_limit_satoshis: u64,
147 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
148 pub max_htlc_value_in_flight_msat: u64,
149 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
150 pub channel_reserve_satoshis: u64,
151 /// The minimum HTLC size incoming to sender, in milli-satoshi
152 pub htlc_minimum_msat: u64,
153 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
154 pub feerate_per_kw: u32,
155 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
156 pub to_self_delay: u16,
157 /// The maximum number of inbound HTLCs towards sender
158 pub max_accepted_htlcs: u16,
159 /// The sender's key controlling the funding transaction
160 pub funding_pubkey: PublicKey,
161 /// Used to derive a revocation key for transactions broadcast by counterparty
162 pub revocation_basepoint: PublicKey,
163 /// A payment key to sender for transactions broadcast by counterparty
164 pub payment_point: PublicKey,
165 /// Used to derive a payment key to sender for transactions broadcast by sender
166 pub delayed_payment_basepoint: PublicKey,
167 /// Used to derive an HTLC payment key to sender
168 pub htlc_basepoint: PublicKey,
169 /// The first to-be-broadcast-by-sender transaction's per commitment point
170 pub first_per_commitment_point: PublicKey,
172 pub channel_flags: u8,
173 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
174 pub shutdown_scriptpubkey: OptionalField<Script>,
175 /// The channel type that this channel will represent. If none is set, we derive the channel
176 /// type from the intersection of our feature bits with our counterparty's feature bits from
177 /// the Init message.
178 pub channel_type: Option<ChannelTypeFeatures>,
181 /// An accept_channel message to be sent or received from a peer
182 #[derive(Clone, Debug, PartialEq)]
183 pub struct AcceptChannel {
184 /// A temporary channel ID, until the funding outpoint is announced
185 pub temporary_channel_id: [u8; 32],
186 /// The threshold below which outputs on transactions broadcast by sender will be omitted
187 pub dust_limit_satoshis: u64,
188 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
189 pub max_htlc_value_in_flight_msat: u64,
190 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
191 pub channel_reserve_satoshis: u64,
192 /// The minimum HTLC size incoming to sender, in milli-satoshi
193 pub htlc_minimum_msat: u64,
194 /// Minimum depth of the funding transaction before the channel is considered open
195 pub minimum_depth: u32,
196 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
197 pub to_self_delay: u16,
198 /// The maximum number of inbound HTLCs towards sender
199 pub max_accepted_htlcs: u16,
200 /// The sender's key controlling the funding transaction
201 pub funding_pubkey: PublicKey,
202 /// Used to derive a revocation key for transactions broadcast by counterparty
203 pub revocation_basepoint: PublicKey,
204 /// A payment key to sender for transactions broadcast by counterparty
205 pub payment_point: PublicKey,
206 /// Used to derive a payment key to sender for transactions broadcast by sender
207 pub delayed_payment_basepoint: PublicKey,
208 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
209 pub htlc_basepoint: PublicKey,
210 /// The first to-be-broadcast-by-sender transaction's per commitment point
211 pub first_per_commitment_point: PublicKey,
212 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
213 pub shutdown_scriptpubkey: OptionalField<Script>,
214 /// The channel type that this channel will represent. If none is set, we derive the channel
215 /// type from the intersection of our feature bits with our counterparty's feature bits from
216 /// the Init message.
218 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
219 pub channel_type: Option<ChannelTypeFeatures>,
222 /// A funding_created message to be sent or received from a peer
223 #[derive(Clone, Debug, PartialEq)]
224 pub struct FundingCreated {
225 /// A temporary channel ID, until the funding is established
226 pub temporary_channel_id: [u8; 32],
227 /// The funding transaction ID
228 pub funding_txid: Txid,
229 /// The specific output index funding this channel
230 pub funding_output_index: u16,
231 /// The signature of the channel initiator (funder) on the initial commitment transaction
232 pub signature: Signature,
235 /// A funding_signed message to be sent or received from a peer
236 #[derive(Clone, Debug, PartialEq)]
237 pub struct FundingSigned {
239 pub channel_id: [u8; 32],
240 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
241 pub signature: Signature,
244 /// A channel_ready message to be sent or received from a peer
245 #[derive(Clone, Debug, PartialEq)]
246 pub struct ChannelReady {
248 pub channel_id: [u8; 32],
249 /// The per-commitment point of the second commitment transaction
250 pub next_per_commitment_point: PublicKey,
251 /// If set, provides a short_channel_id alias for this channel. The sender will accept payments
252 /// to be forwarded over this SCID and forward them to this messages' recipient.
253 pub short_channel_id_alias: Option<u64>,
256 /// A shutdown message to be sent or received from a peer
257 #[derive(Clone, Debug, PartialEq)]
258 pub struct Shutdown {
260 pub channel_id: [u8; 32],
261 /// The destination of this peer's funds on closing.
262 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
263 pub scriptpubkey: Script,
266 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
267 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
269 #[derive(Clone, Debug, PartialEq)]
270 pub struct ClosingSignedFeeRange {
271 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
273 pub min_fee_satoshis: u64,
274 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
276 pub max_fee_satoshis: u64,
279 /// A closing_signed message to be sent or received from a peer
280 #[derive(Clone, Debug, PartialEq)]
281 pub struct ClosingSigned {
283 pub channel_id: [u8; 32],
284 /// The proposed total fee for the closing transaction
285 pub fee_satoshis: u64,
286 /// A signature on the closing transaction
287 pub signature: Signature,
288 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
290 pub fee_range: Option<ClosingSignedFeeRange>,
293 /// An update_add_htlc message to be sent or received from a peer
294 #[derive(Clone, Debug, PartialEq)]
295 pub struct UpdateAddHTLC {
297 pub channel_id: [u8; 32],
300 /// The HTLC value in milli-satoshi
301 pub amount_msat: u64,
302 /// The payment hash, the pre-image of which controls HTLC redemption
303 pub payment_hash: PaymentHash,
304 /// The expiry height of the HTLC
305 pub cltv_expiry: u32,
306 pub(crate) onion_routing_packet: OnionPacket,
309 /// An onion message to be sent or received from a peer
310 #[derive(Clone, Debug, PartialEq)]
311 pub struct OnionMessage {
312 /// Used in decrypting the onion packet's payload.
313 pub blinding_point: PublicKey,
314 pub(crate) onion_routing_packet: onion_message::Packet,
317 /// An update_fulfill_htlc message to be sent or received from a peer
318 #[derive(Clone, Debug, PartialEq)]
319 pub struct UpdateFulfillHTLC {
321 pub channel_id: [u8; 32],
324 /// The pre-image of the payment hash, allowing HTLC redemption
325 pub payment_preimage: PaymentPreimage,
328 /// An update_fail_htlc message to be sent or received from a peer
329 #[derive(Clone, Debug, PartialEq)]
330 pub struct UpdateFailHTLC {
332 pub channel_id: [u8; 32],
335 pub(crate) reason: OnionErrorPacket,
338 /// An update_fail_malformed_htlc message to be sent or received from a peer
339 #[derive(Clone, Debug, PartialEq)]
340 pub struct UpdateFailMalformedHTLC {
342 pub channel_id: [u8; 32],
345 pub(crate) sha256_of_onion: [u8; 32],
347 pub failure_code: u16,
350 /// A commitment_signed message to be sent or received from a peer
351 #[derive(Clone, Debug, PartialEq)]
352 pub struct CommitmentSigned {
354 pub channel_id: [u8; 32],
355 /// A signature on the commitment transaction
356 pub signature: Signature,
357 /// Signatures on the HTLC transactions
358 pub htlc_signatures: Vec<Signature>,
361 /// A revoke_and_ack message to be sent or received from a peer
362 #[derive(Clone, Debug, PartialEq)]
363 pub struct RevokeAndACK {
365 pub channel_id: [u8; 32],
366 /// The secret corresponding to the per-commitment point
367 pub per_commitment_secret: [u8; 32],
368 /// The next sender-broadcast commitment transaction's per-commitment point
369 pub next_per_commitment_point: PublicKey,
372 /// An update_fee message to be sent or received from a peer
373 #[derive(Clone, Debug, PartialEq)]
374 pub struct UpdateFee {
376 pub channel_id: [u8; 32],
377 /// Fee rate per 1000-weight of the transaction
378 pub feerate_per_kw: u32,
381 #[derive(Clone, Debug, PartialEq)]
382 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
383 /// This is used to convince the recipient that the channel is at a certain commitment
384 /// number even if they lost that data due to a local failure. Of course, the peer may lie
385 /// and even later commitments may have been revoked.
386 pub struct DataLossProtect {
387 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
388 /// belonging to the recipient
389 pub your_last_per_commitment_secret: [u8; 32],
390 /// The sender's per-commitment point for their current commitment transaction
391 pub my_current_per_commitment_point: PublicKey,
394 /// A channel_reestablish message to be sent or received from a peer
395 #[derive(Clone, Debug, PartialEq)]
396 pub struct ChannelReestablish {
398 pub channel_id: [u8; 32],
399 /// The next commitment number for the sender
400 pub next_local_commitment_number: u64,
401 /// The next commitment number for the recipient
402 pub next_remote_commitment_number: u64,
403 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
404 pub data_loss_protect: OptionalField<DataLossProtect>,
407 /// An announcement_signatures message to be sent or received from a peer
408 #[derive(Clone, Debug, PartialEq)]
409 pub struct AnnouncementSignatures {
411 pub channel_id: [u8; 32],
412 /// The short channel ID
413 pub short_channel_id: u64,
414 /// A signature by the node key
415 pub node_signature: Signature,
416 /// A signature by the funding key
417 pub bitcoin_signature: Signature,
420 /// An address which can be used to connect to a remote peer
421 #[derive(Clone, Debug, PartialEq)]
422 pub enum NetAddress {
423 /// An IPv4 address/port on which the peer is listening.
425 /// The 4-byte IPv4 address
427 /// The port on which the node is listening
430 /// An IPv6 address/port on which the peer is listening.
432 /// The 16-byte IPv6 address
434 /// The port on which the node is listening
437 /// An old-style Tor onion address/port on which the peer is listening.
439 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
440 /// addresses. Thus, the details are not parsed here.
442 /// A new-style Tor onion address/port on which the peer is listening.
443 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
444 /// wrap as base32 and append ".onion".
446 /// The ed25519 long-term public key of the peer
447 ed25519_pubkey: [u8; 32],
448 /// The checksum of the pubkey and version, as included in the onion address
450 /// The version byte, as defined by the Tor Onion v3 spec.
452 /// The port on which the node is listening
455 /// A hostname/port on which the peer is listening.
457 /// The hostname on which the node is listening.
459 /// The port on which the node is listening.
464 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
466 pub(crate) fn get_id(&self) -> u8 {
468 &NetAddress::IPv4 {..} => { 1 },
469 &NetAddress::IPv6 {..} => { 2 },
470 &NetAddress::OnionV2(_) => { 3 },
471 &NetAddress::OnionV3 {..} => { 4 },
472 &NetAddress::Hostname {..} => { 5 },
476 /// Strict byte-length of address descriptor, 1-byte type not recorded
477 fn len(&self) -> u16 {
479 &NetAddress::IPv4 { .. } => { 6 },
480 &NetAddress::IPv6 { .. } => { 18 },
481 &NetAddress::OnionV2(_) => { 12 },
482 &NetAddress::OnionV3 { .. } => { 37 },
483 // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
484 &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
488 /// The maximum length of any address descriptor, not including the 1-byte type.
489 /// This maximum length is reached by a hostname address descriptor:
490 /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
491 pub(crate) const MAX_LEN: u16 = 258;
494 impl Writeable for NetAddress {
495 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
497 &NetAddress::IPv4 { ref addr, ref port } => {
502 &NetAddress::IPv6 { ref addr, ref port } => {
507 &NetAddress::OnionV2(bytes) => {
509 bytes.write(writer)?;
511 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
513 ed25519_pubkey.write(writer)?;
514 checksum.write(writer)?;
515 version.write(writer)?;
518 &NetAddress::Hostname { ref hostname, ref port } => {
520 hostname.write(writer)?;
528 impl Readable for Result<NetAddress, u8> {
529 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
530 let byte = <u8 as Readable>::read(reader)?;
533 Ok(Ok(NetAddress::IPv4 {
534 addr: Readable::read(reader)?,
535 port: Readable::read(reader)?,
539 Ok(Ok(NetAddress::IPv6 {
540 addr: Readable::read(reader)?,
541 port: Readable::read(reader)?,
544 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
546 Ok(Ok(NetAddress::OnionV3 {
547 ed25519_pubkey: Readable::read(reader)?,
548 checksum: Readable::read(reader)?,
549 version: Readable::read(reader)?,
550 port: Readable::read(reader)?,
554 Ok(Ok(NetAddress::Hostname {
555 hostname: Readable::read(reader)?,
556 port: Readable::read(reader)?,
559 _ => return Ok(Err(byte)),
564 impl Readable for NetAddress {
565 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
566 match Readable::read(reader) {
567 Ok(Ok(res)) => Ok(res),
568 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
575 /// The unsigned part of a node_announcement
576 #[derive(Clone, Debug, PartialEq)]
577 pub struct UnsignedNodeAnnouncement {
578 /// The advertised features
579 pub features: NodeFeatures,
580 /// A strictly monotonic announcement counter, with gaps allowed
582 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
584 pub node_id: PublicKey,
585 /// An RGB color for UI purposes
587 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
590 /// List of addresses on which this node is reachable
591 pub addresses: Vec<NetAddress>,
592 pub(crate) excess_address_data: Vec<u8>,
593 pub(crate) excess_data: Vec<u8>,
595 #[derive(Clone, Debug, PartialEq)]
596 /// A node_announcement message to be sent or received from a peer
597 pub struct NodeAnnouncement {
598 /// The signature by the node key
599 pub signature: Signature,
600 /// The actual content of the announcement
601 pub contents: UnsignedNodeAnnouncement,
604 /// The unsigned part of a channel_announcement
605 #[derive(Clone, Debug, PartialEq)]
606 pub struct UnsignedChannelAnnouncement {
607 /// The advertised channel features
608 pub features: ChannelFeatures,
609 /// The genesis hash of the blockchain where the channel is to be opened
610 pub chain_hash: BlockHash,
611 /// The short channel ID
612 pub short_channel_id: u64,
613 /// One of the two node_ids which are endpoints of this channel
614 pub node_id_1: PublicKey,
615 /// The other of the two node_ids which are endpoints of this channel
616 pub node_id_2: PublicKey,
617 /// The funding key for the first node
618 pub bitcoin_key_1: PublicKey,
619 /// The funding key for the second node
620 pub bitcoin_key_2: PublicKey,
621 pub(crate) excess_data: Vec<u8>,
623 /// A channel_announcement message to be sent or received from a peer
624 #[derive(Clone, Debug, PartialEq)]
625 pub struct ChannelAnnouncement {
626 /// Authentication of the announcement by the first public node
627 pub node_signature_1: Signature,
628 /// Authentication of the announcement by the second public node
629 pub node_signature_2: Signature,
630 /// Proof of funding UTXO ownership by the first public node
631 pub bitcoin_signature_1: Signature,
632 /// Proof of funding UTXO ownership by the second public node
633 pub bitcoin_signature_2: Signature,
634 /// The actual announcement
635 pub contents: UnsignedChannelAnnouncement,
638 /// The unsigned part of a channel_update
639 #[derive(Clone, Debug, PartialEq)]
640 pub struct UnsignedChannelUpdate {
641 /// The genesis hash of the blockchain where the channel is to be opened
642 pub chain_hash: BlockHash,
643 /// The short channel ID
644 pub short_channel_id: u64,
645 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
649 /// The number of blocks such that if:
650 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
651 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
652 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
653 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
654 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
655 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
656 /// constructing the route.
657 pub cltv_expiry_delta: u16,
658 /// The minimum HTLC size incoming to sender, in milli-satoshi
659 pub htlc_minimum_msat: u64,
660 /// The maximum HTLC value incoming to sender, in milli-satoshi. Used to be optional.
661 pub htlc_maximum_msat: u64,
662 /// The base HTLC fee charged by sender, in milli-satoshi
663 pub fee_base_msat: u32,
664 /// The amount to fee multiplier, in micro-satoshi
665 pub fee_proportional_millionths: u32,
666 /// Excess data which was signed as a part of the message which we do not (yet) understand how
667 /// to decode. This is stored to ensure forward-compatibility as new fields are added to the
669 pub excess_data: Vec<u8>,
671 /// A channel_update message to be sent or received from a peer
672 #[derive(Clone, Debug, PartialEq)]
673 pub struct ChannelUpdate {
674 /// A signature of the channel update
675 pub signature: Signature,
676 /// The actual channel update
677 pub contents: UnsignedChannelUpdate,
680 /// A query_channel_range message is used to query a peer for channel
681 /// UTXOs in a range of blocks. The recipient of a query makes a best
682 /// effort to reply to the query using one or more reply_channel_range
684 #[derive(Clone, Debug, PartialEq)]
685 pub struct QueryChannelRange {
686 /// The genesis hash of the blockchain being queried
687 pub chain_hash: BlockHash,
688 /// The height of the first block for the channel UTXOs being queried
689 pub first_blocknum: u32,
690 /// The number of blocks to include in the query results
691 pub number_of_blocks: u32,
694 /// A reply_channel_range message is a reply to a query_channel_range
695 /// message. Multiple reply_channel_range messages can be sent in reply
696 /// to a single query_channel_range message. The query recipient makes a
697 /// best effort to respond based on their local network view which may
698 /// not be a perfect view of the network. The short_channel_ids in the
699 /// reply are encoded. We only support encoding_type=0 uncompressed
700 /// serialization and do not support encoding_type=1 zlib serialization.
701 #[derive(Clone, Debug, PartialEq)]
702 pub struct ReplyChannelRange {
703 /// The genesis hash of the blockchain being queried
704 pub chain_hash: BlockHash,
705 /// The height of the first block in the range of the reply
706 pub first_blocknum: u32,
707 /// The number of blocks included in the range of the reply
708 pub number_of_blocks: u32,
709 /// True when this is the final reply for a query
710 pub sync_complete: bool,
711 /// The short_channel_ids in the channel range
712 pub short_channel_ids: Vec<u64>,
715 /// A query_short_channel_ids message is used to query a peer for
716 /// routing gossip messages related to one or more short_channel_ids.
717 /// The query recipient will reply with the latest, if available,
718 /// channel_announcement, channel_update and node_announcement messages
719 /// it maintains for the requested short_channel_ids followed by a
720 /// reply_short_channel_ids_end message. The short_channel_ids sent in
721 /// this query are encoded. We only support encoding_type=0 uncompressed
722 /// serialization and do not support encoding_type=1 zlib serialization.
723 #[derive(Clone, Debug, PartialEq)]
724 pub struct QueryShortChannelIds {
725 /// The genesis hash of the blockchain being queried
726 pub chain_hash: BlockHash,
727 /// The short_channel_ids that are being queried
728 pub short_channel_ids: Vec<u64>,
731 /// A reply_short_channel_ids_end message is sent as a reply to a
732 /// query_short_channel_ids message. The query recipient makes a best
733 /// effort to respond based on their local network view which may not be
734 /// a perfect view of the network.
735 #[derive(Clone, Debug, PartialEq)]
736 pub struct ReplyShortChannelIdsEnd {
737 /// The genesis hash of the blockchain that was queried
738 pub chain_hash: BlockHash,
739 /// Indicates if the query recipient maintains up-to-date channel
740 /// information for the chain_hash
741 pub full_information: bool,
744 /// A gossip_timestamp_filter message is used by a node to request
745 /// gossip relay for messages in the requested time range when the
746 /// gossip_queries feature has been negotiated.
747 #[derive(Clone, Debug, PartialEq)]
748 pub struct GossipTimestampFilter {
749 /// The genesis hash of the blockchain for channel and node information
750 pub chain_hash: BlockHash,
751 /// The starting unix timestamp
752 pub first_timestamp: u32,
753 /// The range of information in seconds
754 pub timestamp_range: u32,
757 /// Encoding type for data compression of collections in gossip queries.
758 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
763 /// Used to put an error message in a LightningError
764 #[derive(Clone, Debug)]
765 pub enum ErrorAction {
766 /// The peer took some action which made us think they were useless. Disconnect them.
768 /// An error message which we should make an effort to send before we disconnect.
769 msg: Option<ErrorMessage>
771 /// The peer did something harmless that we weren't able to process, just log and ignore
772 // New code should *not* use this. New code must use IgnoreAndLog, below!
774 /// The peer did something harmless that we weren't able to meaningfully process.
775 /// If the error is logged, log it at the given level.
776 IgnoreAndLog(logger::Level),
777 /// The peer provided us with a gossip message which we'd already seen. In most cases this
778 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
779 /// our own channel announcements.
780 IgnoreDuplicateGossip,
781 /// The peer did something incorrect. Tell them.
783 /// The message to send.
786 /// The peer did something incorrect. Tell them without closing any channels.
788 /// The message to send.
790 /// The peer may have done something harmless that we weren't able to meaningfully process,
791 /// though we should still tell them about it.
792 /// If this event is logged, log it at the given level.
793 log_level: logger::Level,
797 /// An Err type for failure to process messages.
798 #[derive(Clone, Debug)]
799 pub struct LightningError {
800 /// A human-readable message describing the error
802 /// The action which should be taken against the offending peer.
803 pub action: ErrorAction,
806 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
807 /// transaction updates if they were pending.
808 #[derive(Clone, Debug, PartialEq)]
809 pub struct CommitmentUpdate {
810 /// update_add_htlc messages which should be sent
811 pub update_add_htlcs: Vec<UpdateAddHTLC>,
812 /// update_fulfill_htlc messages which should be sent
813 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
814 /// update_fail_htlc messages which should be sent
815 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
816 /// update_fail_malformed_htlc messages which should be sent
817 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
818 /// An update_fee message which should be sent
819 pub update_fee: Option<UpdateFee>,
820 /// Finally, the commitment_signed message which should be sent
821 pub commitment_signed: CommitmentSigned,
824 /// Messages could have optional fields to use with extended features
825 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
826 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
827 /// separate enum type for them.
828 /// (C-not exported) due to a free generic in T
829 #[derive(Clone, Debug, PartialEq)]
830 pub enum OptionalField<T> {
831 /// Optional field is included in message
833 /// Optional field is absent in message
837 /// A trait to describe an object which can receive channel messages.
839 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
840 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
841 pub trait ChannelMessageHandler : MessageSendEventsProvider {
843 /// Handle an incoming open_channel message from the given peer.
844 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
845 /// Handle an incoming accept_channel message from the given peer.
846 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
847 /// Handle an incoming funding_created message from the given peer.
848 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
849 /// Handle an incoming funding_signed message from the given peer.
850 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
851 /// Handle an incoming channel_ready message from the given peer.
852 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
855 /// Handle an incoming shutdown message from the given peer.
856 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
857 /// Handle an incoming closing_signed message from the given peer.
858 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
861 /// Handle an incoming update_add_htlc message from the given peer.
862 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
863 /// Handle an incoming update_fulfill_htlc message from the given peer.
864 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
865 /// Handle an incoming update_fail_htlc message from the given peer.
866 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
867 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
868 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
869 /// Handle an incoming commitment_signed message from the given peer.
870 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
871 /// Handle an incoming revoke_and_ack message from the given peer.
872 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
874 /// Handle an incoming update_fee message from the given peer.
875 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
877 // Channel-to-announce:
878 /// Handle an incoming announcement_signatures message from the given peer.
879 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
881 // Connection loss/reestablish:
882 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
883 /// is believed to be possible in the future (eg they're sending us messages we don't
884 /// understand or indicate they require unknown feature bits), no_connection_possible is set
885 /// and any outstanding channels should be failed.
886 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
888 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
889 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
890 /// Handle an incoming channel_reestablish message from the given peer.
891 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
893 /// Handle an incoming channel update from the given peer.
894 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
897 /// Handle an incoming error message from the given peer.
898 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
900 // Handler information:
901 /// Gets the node feature flags which this handler itself supports. All available handlers are
902 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
903 /// which are broadcasted in our [`NodeAnnouncement`] message.
904 fn provided_node_features(&self) -> NodeFeatures;
906 /// Gets the init feature flags which should be sent to the given peer. All available handlers
907 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
908 /// which are sent in our [`Init`] message.
910 /// Note that this method is called before [`Self::peer_connected`].
911 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
914 /// A trait to describe an object which can receive routing messages.
916 /// # Implementor DoS Warnings
918 /// For `gossip_queries` messages there are potential DoS vectors when handling
919 /// inbound queries. Implementors using an on-disk network graph should be aware of
920 /// repeated disk I/O for queries accessing different parts of the network graph.
921 pub trait RoutingMessageHandler : MessageSendEventsProvider {
922 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
923 /// false or returning an Err otherwise.
924 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
925 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
926 /// or returning an Err otherwise.
927 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
928 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
929 /// false or returning an Err otherwise.
930 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
931 /// Gets channel announcements and updates required to dump our routing table to a remote node,
932 /// starting at the short_channel_id indicated by starting_point and including announcements
933 /// for a single channel.
934 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
935 /// Gets a node announcement required to dump our routing table to a remote node, starting at
936 /// the node *after* the provided pubkey and including up to one announcement immediately
937 /// higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
938 /// If None is provided for starting_point, we start at the first node.
939 fn get_next_node_announcement(&self, starting_point: Option<&PublicKey>) -> Option<NodeAnnouncement>;
940 /// Called when a connection is established with a peer. This can be used to
941 /// perform routing table synchronization using a strategy defined by the
943 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
944 /// Handles the reply of a query we initiated to learn about channels
945 /// for a given range of blocks. We can expect to receive one or more
946 /// replies to a single query.
947 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
948 /// Handles the reply of a query we initiated asking for routing gossip
949 /// messages for a list of channels. We should receive this message when
950 /// a node has completed its best effort to send us the pertaining routing
952 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
953 /// Handles when a peer asks us to send a list of short_channel_ids
954 /// for the requested range of blocks.
955 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
956 /// Handles when a peer asks us to send routing gossip messages for a
957 /// list of short_channel_ids.
958 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
960 // Handler information:
961 /// Gets the node feature flags which this handler itself supports. All available handlers are
962 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
963 /// which are broadcasted in our [`NodeAnnouncement`] message.
964 fn provided_node_features(&self) -> NodeFeatures;
965 /// Gets the init feature flags which should be sent to the given peer. All available handlers
966 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
967 /// which are sent in our [`Init`] message.
969 /// Note that this method is called before [`Self::peer_connected`].
970 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
973 /// A trait to describe an object that can receive onion messages.
974 pub trait OnionMessageHandler : OnionMessageProvider {
975 /// Handle an incoming onion_message message from the given peer.
976 fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
977 /// Called when a connection is established with a peer. Can be used to track which peers
978 /// advertise onion message support and are online.
979 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
980 /// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
981 /// drop and refuse to forward onion messages to this peer.
982 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
984 // Handler information:
985 /// Gets the node feature flags which this handler itself supports. All available handlers are
986 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
987 /// which are broadcasted in our [`NodeAnnouncement`] message.
988 fn provided_node_features(&self) -> NodeFeatures;
990 /// Gets the init feature flags which should be sent to the given peer. All available handlers
991 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
992 /// which are sent in our [`Init`] message.
994 /// Note that this method is called before [`Self::peer_connected`].
995 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
998 mod fuzzy_internal_msgs {
1000 use ln::{PaymentPreimage, PaymentSecret};
1002 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1003 // them from untrusted input):
1005 pub(crate) struct FinalOnionHopData {
1006 pub(crate) payment_secret: PaymentSecret,
1007 /// The total value, in msat, of the payment as received by the ultimate recipient.
1008 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1009 pub(crate) total_msat: u64,
1012 pub(crate) enum OnionHopDataFormat {
1013 Legacy { // aka Realm-0
1014 short_channel_id: u64,
1017 short_channel_id: u64,
1020 payment_data: Option<FinalOnionHopData>,
1021 keysend_preimage: Option<PaymentPreimage>,
1025 pub struct OnionHopData {
1026 pub(crate) format: OnionHopDataFormat,
1027 /// The value, in msat, of the payment after this hop's fee is deducted.
1028 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1029 pub(crate) amt_to_forward: u64,
1030 pub(crate) outgoing_cltv_value: u32,
1031 // 12 bytes of 0-padding for Legacy format
1034 pub struct DecodedOnionErrorPacket {
1035 pub(crate) hmac: [u8; 32],
1036 pub(crate) failuremsg: Vec<u8>,
1037 pub(crate) pad: Vec<u8>,
1041 pub use self::fuzzy_internal_msgs::*;
1042 #[cfg(not(fuzzing))]
1043 pub(crate) use self::fuzzy_internal_msgs::*;
1046 pub(crate) struct OnionPacket {
1047 pub(crate) version: u8,
1048 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
1049 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
1050 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
1051 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
1052 pub(crate) hop_data: [u8; 20*65],
1053 pub(crate) hmac: [u8; 32],
1056 impl onion_utils::Packet for OnionPacket {
1057 type Data = onion_utils::FixedSizeOnionPacket;
1058 fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1061 public_key: Ok(pubkey),
1062 hop_data: hop_data.0,
1068 impl PartialEq for OnionPacket {
1069 fn eq(&self, other: &OnionPacket) -> bool {
1070 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
1071 if i != j { return false; }
1073 self.version == other.version &&
1074 self.public_key == other.public_key &&
1075 self.hmac == other.hmac
1079 impl fmt::Debug for OnionPacket {
1080 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1081 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1085 #[derive(Clone, Debug, PartialEq)]
1086 pub(crate) struct OnionErrorPacket {
1087 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1088 // (TODO) We limit it in decode to much lower...
1089 pub(crate) data: Vec<u8>,
1092 impl fmt::Display for DecodeError {
1093 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1095 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1096 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1097 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1098 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1099 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1100 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1101 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1106 impl From<io::Error> for DecodeError {
1107 fn from(e: io::Error) -> Self {
1108 if e.kind() == io::ErrorKind::UnexpectedEof {
1109 DecodeError::ShortRead
1111 DecodeError::Io(e.kind())
1116 impl Writeable for OptionalField<Script> {
1117 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1119 OptionalField::Present(ref script) => {
1120 // Note that Writeable for script includes the 16-bit length tag for us
1123 OptionalField::Absent => {}
1129 impl Readable for OptionalField<Script> {
1130 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1131 match <u16 as Readable>::read(r) {
1133 let mut buf = vec![0; len as usize];
1134 r.read_exact(&mut buf)?;
1135 Ok(OptionalField::Present(Script::from(buf)))
1137 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1143 impl Writeable for OptionalField<u64> {
1144 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1146 OptionalField::Present(ref value) => {
1149 OptionalField::Absent => {}
1155 impl Readable for OptionalField<u64> {
1156 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1157 let value: u64 = Readable::read(r)?;
1158 Ok(OptionalField::Present(value))
1163 impl_writeable_msg!(AcceptChannel, {
1164 temporary_channel_id,
1165 dust_limit_satoshis,
1166 max_htlc_value_in_flight_msat,
1167 channel_reserve_satoshis,
1173 revocation_basepoint,
1175 delayed_payment_basepoint,
1177 first_per_commitment_point,
1178 shutdown_scriptpubkey
1180 (1, channel_type, option),
1183 impl_writeable_msg!(AnnouncementSignatures, {
1190 impl Writeable for ChannelReestablish {
1191 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1192 self.channel_id.write(w)?;
1193 self.next_local_commitment_number.write(w)?;
1194 self.next_remote_commitment_number.write(w)?;
1195 match self.data_loss_protect {
1196 OptionalField::Present(ref data_loss_protect) => {
1197 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1198 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1200 OptionalField::Absent => {}
1206 impl Readable for ChannelReestablish{
1207 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1209 channel_id: Readable::read(r)?,
1210 next_local_commitment_number: Readable::read(r)?,
1211 next_remote_commitment_number: Readable::read(r)?,
1212 data_loss_protect: {
1213 match <[u8; 32] as Readable>::read(r) {
1214 Ok(your_last_per_commitment_secret) =>
1215 OptionalField::Present(DataLossProtect {
1216 your_last_per_commitment_secret,
1217 my_current_per_commitment_point: Readable::read(r)?,
1219 Err(DecodeError::ShortRead) => OptionalField::Absent,
1220 Err(e) => return Err(e)
1227 impl_writeable_msg!(ClosingSigned,
1228 { channel_id, fee_satoshis, signature },
1229 { (1, fee_range, option) }
1232 impl_writeable!(ClosingSignedFeeRange, {
1237 impl_writeable_msg!(CommitmentSigned, {
1243 impl_writeable!(DecodedOnionErrorPacket, {
1249 impl_writeable_msg!(FundingCreated, {
1250 temporary_channel_id,
1252 funding_output_index,
1256 impl_writeable_msg!(FundingSigned, {
1261 impl_writeable_msg!(ChannelReady, {
1263 next_per_commitment_point,
1265 (1, short_channel_id_alias, option),
1268 impl Writeable for Init {
1269 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1270 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1271 // our relevant feature bits. This keeps us compatible with old nodes.
1272 self.features.write_up_to_13(w)?;
1273 self.features.write(w)?;
1274 encode_tlv_stream!(w, {
1275 (3, self.remote_network_address, option)
1281 impl Readable for Init {
1282 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1283 let global_features: InitFeatures = Readable::read(r)?;
1284 let features: InitFeatures = Readable::read(r)?;
1285 let mut remote_network_address: Option<NetAddress> = None;
1286 decode_tlv_stream!(r, {
1287 (3, remote_network_address, option)
1290 features: features.or(global_features),
1291 remote_network_address,
1296 impl_writeable_msg!(OpenChannel, {
1298 temporary_channel_id,
1301 dust_limit_satoshis,
1302 max_htlc_value_in_flight_msat,
1303 channel_reserve_satoshis,
1309 revocation_basepoint,
1311 delayed_payment_basepoint,
1313 first_per_commitment_point,
1315 shutdown_scriptpubkey
1317 (1, channel_type, option),
1320 impl_writeable_msg!(RevokeAndACK, {
1322 per_commitment_secret,
1323 next_per_commitment_point
1326 impl_writeable_msg!(Shutdown, {
1331 impl_writeable_msg!(UpdateFailHTLC, {
1337 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1344 impl_writeable_msg!(UpdateFee, {
1349 impl_writeable_msg!(UpdateFulfillHTLC, {
1355 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1356 // serialization format in a way which assumes we know the total serialized length/message end
1358 impl_writeable!(OnionErrorPacket, {
1362 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1363 // serialization format in a way which assumes we know the total serialized length/message end
1365 impl Writeable for OnionPacket {
1366 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1367 self.version.write(w)?;
1368 match self.public_key {
1369 Ok(pubkey) => pubkey.write(w)?,
1370 Err(_) => [0u8;33].write(w)?,
1372 w.write_all(&self.hop_data)?;
1373 self.hmac.write(w)?;
1378 impl Readable for OnionPacket {
1379 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1381 version: Readable::read(r)?,
1383 let mut buf = [0u8;33];
1384 r.read_exact(&mut buf)?;
1385 PublicKey::from_slice(&buf)
1387 hop_data: Readable::read(r)?,
1388 hmac: Readable::read(r)?,
1393 impl_writeable_msg!(UpdateAddHTLC, {
1399 onion_routing_packet
1402 impl Readable for OnionMessage {
1403 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1404 let blinding_point: PublicKey = Readable::read(r)?;
1405 let len: u16 = Readable::read(r)?;
1406 let mut packet_reader = FixedLengthReader::new(r, len as u64);
1407 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
1410 onion_routing_packet,
1415 impl Writeable for OnionMessage {
1416 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1417 self.blinding_point.write(w)?;
1418 let onion_packet_len = self.onion_routing_packet.serialized_length();
1419 (onion_packet_len as u16).write(w)?;
1420 self.onion_routing_packet.write(w)?;
1425 impl Writeable for FinalOnionHopData {
1426 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1427 self.payment_secret.0.write(w)?;
1428 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
1432 impl Readable for FinalOnionHopData {
1433 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1434 let secret: [u8; 32] = Readable::read(r)?;
1435 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
1436 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1440 impl Writeable for OnionHopData {
1441 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1443 OnionHopDataFormat::Legacy { short_channel_id } => {
1445 short_channel_id.write(w)?;
1446 self.amt_to_forward.write(w)?;
1447 self.outgoing_cltv_value.write(w)?;
1448 w.write_all(&[0;12])?;
1450 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1451 encode_varint_length_prefixed_tlv!(w, {
1452 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1453 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1454 (6, short_channel_id, required)
1457 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1458 encode_varint_length_prefixed_tlv!(w, {
1459 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1460 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1461 (8, payment_data, option),
1462 (5482373484, keysend_preimage, option)
1470 impl Readable for OnionHopData {
1471 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1472 let b: BigSize = Readable::read(r)?;
1473 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1474 let (format, amt, cltv_value) = if b.0 != LEGACY_ONION_HOP_FLAG {
1475 let mut rd = FixedLengthReader::new(r, b.0);
1476 let mut amt = HighZeroBytesDroppedBigSize(0u64);
1477 let mut cltv_value = HighZeroBytesDroppedBigSize(0u32);
1478 let mut short_id: Option<u64> = None;
1479 let mut payment_data: Option<FinalOnionHopData> = None;
1480 let mut keysend_preimage: Option<PaymentPreimage> = None;
1481 decode_tlv_stream!(&mut rd, {
1483 (4, cltv_value, required),
1484 (6, short_id, option),
1485 (8, payment_data, option),
1486 // See https://github.com/lightning/blips/blob/master/blip-0003.md
1487 (5482373484, keysend_preimage, option)
1489 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1490 let format = if let Some(short_channel_id) = short_id {
1491 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1492 OnionHopDataFormat::NonFinalNode {
1496 if let &Some(ref data) = &payment_data {
1497 if data.total_msat > MAX_VALUE_MSAT {
1498 return Err(DecodeError::InvalidValue);
1501 OnionHopDataFormat::FinalNode {
1506 (format, amt.0, cltv_value.0)
1508 let format = OnionHopDataFormat::Legacy {
1509 short_channel_id: Readable::read(r)?,
1511 let amt: u64 = Readable::read(r)?;
1512 let cltv_value: u32 = Readable::read(r)?;
1513 r.read_exact(&mut [0; 12])?;
1514 (format, amt, cltv_value)
1517 if amt > MAX_VALUE_MSAT {
1518 return Err(DecodeError::InvalidValue);
1522 amt_to_forward: amt,
1523 outgoing_cltv_value: cltv_value,
1528 // ReadableArgs because we need onion_utils::decode_next_hop to accommodate payment packets and
1529 // onion message packets.
1530 impl ReadableArgs<()> for OnionHopData {
1531 fn read<R: Read>(r: &mut R, _arg: ()) -> Result<Self, DecodeError> {
1532 <Self as Readable>::read(r)
1536 impl Writeable for Ping {
1537 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1538 self.ponglen.write(w)?;
1539 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1544 impl Readable for Ping {
1545 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1547 ponglen: Readable::read(r)?,
1549 let byteslen = Readable::read(r)?;
1550 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1557 impl Writeable for Pong {
1558 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1559 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1564 impl Readable for Pong {
1565 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1568 let byteslen = Readable::read(r)?;
1569 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1576 impl Writeable for UnsignedChannelAnnouncement {
1577 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1578 self.features.write(w)?;
1579 self.chain_hash.write(w)?;
1580 self.short_channel_id.write(w)?;
1581 self.node_id_1.write(w)?;
1582 self.node_id_2.write(w)?;
1583 self.bitcoin_key_1.write(w)?;
1584 self.bitcoin_key_2.write(w)?;
1585 w.write_all(&self.excess_data[..])?;
1590 impl Readable for UnsignedChannelAnnouncement {
1591 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1593 features: Readable::read(r)?,
1594 chain_hash: Readable::read(r)?,
1595 short_channel_id: Readable::read(r)?,
1596 node_id_1: Readable::read(r)?,
1597 node_id_2: Readable::read(r)?,
1598 bitcoin_key_1: Readable::read(r)?,
1599 bitcoin_key_2: Readable::read(r)?,
1600 excess_data: read_to_end(r)?,
1605 impl_writeable!(ChannelAnnouncement, {
1608 bitcoin_signature_1,
1609 bitcoin_signature_2,
1613 impl Writeable for UnsignedChannelUpdate {
1614 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1615 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
1616 const MESSAGE_FLAGS: u8 = 1;
1617 self.chain_hash.write(w)?;
1618 self.short_channel_id.write(w)?;
1619 self.timestamp.write(w)?;
1620 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
1621 all_flags.write(w)?;
1622 self.cltv_expiry_delta.write(w)?;
1623 self.htlc_minimum_msat.write(w)?;
1624 self.fee_base_msat.write(w)?;
1625 self.fee_proportional_millionths.write(w)?;
1626 self.htlc_maximum_msat.write(w)?;
1627 w.write_all(&self.excess_data[..])?;
1632 impl Readable for UnsignedChannelUpdate {
1633 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1635 chain_hash: Readable::read(r)?,
1636 short_channel_id: Readable::read(r)?,
1637 timestamp: Readable::read(r)?,
1639 let flags: u16 = Readable::read(r)?;
1640 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
1643 cltv_expiry_delta: Readable::read(r)?,
1644 htlc_minimum_msat: Readable::read(r)?,
1645 fee_base_msat: Readable::read(r)?,
1646 fee_proportional_millionths: Readable::read(r)?,
1647 htlc_maximum_msat: Readable::read(r)?,
1648 excess_data: read_to_end(r)?,
1653 impl_writeable!(ChannelUpdate, {
1658 impl Writeable for ErrorMessage {
1659 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1660 self.channel_id.write(w)?;
1661 (self.data.len() as u16).write(w)?;
1662 w.write_all(self.data.as_bytes())?;
1667 impl Readable for ErrorMessage {
1668 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1670 channel_id: Readable::read(r)?,
1672 let sz: usize = <u16 as Readable>::read(r)? as usize;
1673 let mut data = Vec::with_capacity(sz);
1675 r.read_exact(&mut data)?;
1676 match String::from_utf8(data) {
1678 Err(_) => return Err(DecodeError::InvalidValue),
1685 impl Writeable for WarningMessage {
1686 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1687 self.channel_id.write(w)?;
1688 (self.data.len() as u16).write(w)?;
1689 w.write_all(self.data.as_bytes())?;
1694 impl Readable for WarningMessage {
1695 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1697 channel_id: Readable::read(r)?,
1699 let sz: usize = <u16 as Readable>::read(r)? as usize;
1700 let mut data = Vec::with_capacity(sz);
1702 r.read_exact(&mut data)?;
1703 match String::from_utf8(data) {
1705 Err(_) => return Err(DecodeError::InvalidValue),
1712 impl Writeable for UnsignedNodeAnnouncement {
1713 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1714 self.features.write(w)?;
1715 self.timestamp.write(w)?;
1716 self.node_id.write(w)?;
1717 w.write_all(&self.rgb)?;
1718 self.alias.write(w)?;
1720 let mut addr_len = 0;
1721 for addr in self.addresses.iter() {
1722 addr_len += 1 + addr.len();
1724 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1725 for addr in self.addresses.iter() {
1728 w.write_all(&self.excess_address_data[..])?;
1729 w.write_all(&self.excess_data[..])?;
1734 impl Readable for UnsignedNodeAnnouncement {
1735 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1736 let features: NodeFeatures = Readable::read(r)?;
1737 let timestamp: u32 = Readable::read(r)?;
1738 let node_id: PublicKey = Readable::read(r)?;
1739 let mut rgb = [0; 3];
1740 r.read_exact(&mut rgb)?;
1741 let alias: [u8; 32] = Readable::read(r)?;
1743 let addr_len: u16 = Readable::read(r)?;
1744 let mut addresses: Vec<NetAddress> = Vec::new();
1745 let mut addr_readpos = 0;
1746 let mut excess = false;
1747 let mut excess_byte = 0;
1749 if addr_len <= addr_readpos { break; }
1750 match Readable::read(r) {
1752 if addr_len < addr_readpos + 1 + addr.len() {
1753 return Err(DecodeError::BadLengthDescriptor);
1755 addr_readpos += (1 + addr.len()) as u16;
1756 addresses.push(addr);
1758 Ok(Err(unknown_descriptor)) => {
1760 excess_byte = unknown_descriptor;
1763 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1764 Err(e) => return Err(e),
1768 let mut excess_data = vec![];
1769 let excess_address_data = if addr_readpos < addr_len {
1770 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1771 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1773 excess_address_data[0] = excess_byte;
1778 excess_data.push(excess_byte);
1782 excess_data.extend(read_to_end(r)?.iter());
1783 Ok(UnsignedNodeAnnouncement {
1790 excess_address_data,
1796 impl_writeable!(NodeAnnouncement, {
1801 impl Readable for QueryShortChannelIds {
1802 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1803 let chain_hash: BlockHash = Readable::read(r)?;
1805 let encoding_len: u16 = Readable::read(r)?;
1806 let encoding_type: u8 = Readable::read(r)?;
1808 // Must be encoding_type=0 uncompressed serialization. We do not
1809 // support encoding_type=1 zlib serialization.
1810 if encoding_type != EncodingType::Uncompressed as u8 {
1811 return Err(DecodeError::UnsupportedCompression);
1814 // We expect the encoding_len to always includes the 1-byte
1815 // encoding_type and that short_channel_ids are 8-bytes each
1816 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1817 return Err(DecodeError::InvalidValue);
1820 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1821 // less the 1-byte encoding_type
1822 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1823 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1824 for _ in 0..short_channel_id_count {
1825 short_channel_ids.push(Readable::read(r)?);
1828 Ok(QueryShortChannelIds {
1835 impl Writeable for QueryShortChannelIds {
1836 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1837 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1838 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1840 self.chain_hash.write(w)?;
1841 encoding_len.write(w)?;
1843 // We only support type=0 uncompressed serialization
1844 (EncodingType::Uncompressed as u8).write(w)?;
1846 for scid in self.short_channel_ids.iter() {
1854 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1859 impl QueryChannelRange {
1861 * Calculates the overflow safe ending block height for the query.
1862 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1864 pub fn end_blocknum(&self) -> u32 {
1865 match self.first_blocknum.checked_add(self.number_of_blocks) {
1866 Some(block) => block,
1867 None => u32::max_value(),
1872 impl_writeable_msg!(QueryChannelRange, {
1878 impl Readable for ReplyChannelRange {
1879 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1880 let chain_hash: BlockHash = Readable::read(r)?;
1881 let first_blocknum: u32 = Readable::read(r)?;
1882 let number_of_blocks: u32 = Readable::read(r)?;
1883 let sync_complete: bool = Readable::read(r)?;
1885 let encoding_len: u16 = Readable::read(r)?;
1886 let encoding_type: u8 = Readable::read(r)?;
1888 // Must be encoding_type=0 uncompressed serialization. We do not
1889 // support encoding_type=1 zlib serialization.
1890 if encoding_type != EncodingType::Uncompressed as u8 {
1891 return Err(DecodeError::UnsupportedCompression);
1894 // We expect the encoding_len to always includes the 1-byte
1895 // encoding_type and that short_channel_ids are 8-bytes each
1896 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1897 return Err(DecodeError::InvalidValue);
1900 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1901 // less the 1-byte encoding_type
1902 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1903 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1904 for _ in 0..short_channel_id_count {
1905 short_channel_ids.push(Readable::read(r)?);
1908 Ok(ReplyChannelRange {
1918 impl Writeable for ReplyChannelRange {
1919 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1920 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1921 self.chain_hash.write(w)?;
1922 self.first_blocknum.write(w)?;
1923 self.number_of_blocks.write(w)?;
1924 self.sync_complete.write(w)?;
1926 encoding_len.write(w)?;
1927 (EncodingType::Uncompressed as u8).write(w)?;
1928 for scid in self.short_channel_ids.iter() {
1936 impl_writeable_msg!(GossipTimestampFilter, {
1945 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1946 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1948 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1949 use util::ser::{Writeable, Readable, Hostname};
1951 use bitcoin::hashes::hex::FromHex;
1952 use bitcoin::util::address::Address;
1953 use bitcoin::network::constants::Network;
1954 use bitcoin::blockdata::script::Builder;
1955 use bitcoin::blockdata::opcodes;
1956 use bitcoin::hash_types::{Txid, BlockHash};
1958 use bitcoin::secp256k1::{PublicKey,SecretKey};
1959 use bitcoin::secp256k1::{Secp256k1, Message};
1961 use io::{self, Cursor};
1963 use core::convert::TryFrom;
1966 fn encoding_channel_reestablish_no_secret() {
1967 let cr = msgs::ChannelReestablish {
1968 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],
1969 next_local_commitment_number: 3,
1970 next_remote_commitment_number: 4,
1971 data_loss_protect: OptionalField::Absent,
1974 let encoded_value = cr.encode();
1977 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]
1982 fn encoding_channel_reestablish_with_secret() {
1984 let secp_ctx = Secp256k1::new();
1985 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1988 let cr = msgs::ChannelReestablish {
1989 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],
1990 next_local_commitment_number: 3,
1991 next_remote_commitment_number: 4,
1992 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1995 let encoded_value = cr.encode();
1998 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]
2002 macro_rules! get_keys_from {
2003 ($slice: expr, $secp_ctx: expr) => {
2005 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
2006 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2012 macro_rules! get_sig_on {
2013 ($privkey: expr, $ctx: expr, $string: expr) => {
2015 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2016 $ctx.sign_ecdsa(&sighash, &$privkey)
2022 fn encoding_announcement_signatures() {
2023 let secp_ctx = Secp256k1::new();
2024 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2025 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2026 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2027 let announcement_signatures = msgs::AnnouncementSignatures {
2028 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],
2029 short_channel_id: 2316138423780173,
2030 node_signature: sig_1,
2031 bitcoin_signature: sig_2,
2034 let encoded_value = announcement_signatures.encode();
2035 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2038 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2039 let secp_ctx = Secp256k1::new();
2040 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2041 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2042 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2043 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2044 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2045 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2046 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2047 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2048 let mut features = ChannelFeatures::known();
2049 if unknown_features_bits {
2050 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2052 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2054 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2055 short_channel_id: 2316138423780173,
2056 node_id_1: pubkey_1,
2057 node_id_2: pubkey_2,
2058 bitcoin_key_1: pubkey_3,
2059 bitcoin_key_2: pubkey_4,
2060 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
2062 let channel_announcement = msgs::ChannelAnnouncement {
2063 node_signature_1: sig_1,
2064 node_signature_2: sig_2,
2065 bitcoin_signature_1: sig_3,
2066 bitcoin_signature_2: sig_4,
2067 contents: unsigned_channel_announcement,
2069 let encoded_value = channel_announcement.encode();
2070 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
2071 if unknown_features_bits {
2072 target_value.append(&mut hex::decode("0002ffff").unwrap());
2074 target_value.append(&mut hex::decode("0000").unwrap());
2076 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2077 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
2079 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
2081 assert_eq!(encoded_value, target_value);
2085 fn encoding_channel_announcement() {
2086 do_encoding_channel_announcement(true, false);
2087 do_encoding_channel_announcement(false, true);
2088 do_encoding_channel_announcement(false, false);
2089 do_encoding_channel_announcement(true, true);
2092 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) {
2093 let secp_ctx = Secp256k1::new();
2094 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2095 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2096 let features = if unknown_features_bits {
2097 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2099 // Set to some features we may support
2100 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2102 let mut addresses = Vec::new();
2104 addresses.push(msgs::NetAddress::IPv4 {
2105 addr: [255, 254, 253, 252],
2110 addresses.push(msgs::NetAddress::IPv6 {
2111 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2116 addresses.push(msgs::NetAddress::OnionV2(
2117 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2121 addresses.push(msgs::NetAddress::OnionV3 {
2122 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],
2129 addresses.push(msgs::NetAddress::Hostname {
2130 hostname: Hostname::try_from(String::from("host")).unwrap(),
2134 let mut addr_len = 0;
2135 for addr in &addresses {
2136 addr_len += addr.len() + 1;
2138 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2140 timestamp: 20190119,
2145 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() },
2146 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() },
2148 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2149 let node_announcement = msgs::NodeAnnouncement {
2151 contents: unsigned_node_announcement,
2153 let encoded_value = node_announcement.encode();
2154 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2155 if unknown_features_bits {
2156 target_value.append(&mut hex::decode("0002ffff").unwrap());
2158 target_value.append(&mut hex::decode("000122").unwrap());
2160 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2161 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2163 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2166 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2169 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2172 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2175 target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2177 if excess_address_data {
2178 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2181 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2183 assert_eq!(encoded_value, target_value);
2187 fn encoding_node_announcement() {
2188 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2189 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2190 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2191 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2192 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2193 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2194 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2195 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2196 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2197 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2200 fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
2201 let secp_ctx = Secp256k1::new();
2202 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2203 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2204 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2205 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2206 short_channel_id: 2316138423780173,
2207 timestamp: 20190119,
2208 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2209 cltv_expiry_delta: 144,
2210 htlc_minimum_msat: 1000000,
2211 htlc_maximum_msat: 131355275467161,
2212 fee_base_msat: 10000,
2213 fee_proportional_millionths: 20,
2214 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2216 let channel_update = msgs::ChannelUpdate {
2218 contents: unsigned_channel_update
2220 let encoded_value = channel_update.encode();
2221 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2222 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2223 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2224 target_value.append(&mut hex::decode("01").unwrap());
2225 target_value.append(&mut hex::decode("00").unwrap());
2227 let flag = target_value.last_mut().unwrap();
2231 let flag = target_value.last_mut().unwrap();
2232 *flag = *flag | 1 << 1;
2234 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2235 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2237 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2239 assert_eq!(encoded_value, target_value);
2243 fn encoding_channel_update() {
2244 do_encoding_channel_update(false, false, false);
2245 do_encoding_channel_update(false, false, true);
2246 do_encoding_channel_update(true, false, false);
2247 do_encoding_channel_update(true, false, true);
2248 do_encoding_channel_update(false, true, false);
2249 do_encoding_channel_update(false, true, true);
2250 do_encoding_channel_update(true, true, false);
2251 do_encoding_channel_update(true, true, true);
2254 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2255 let secp_ctx = Secp256k1::new();
2256 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2257 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2258 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2259 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2260 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2261 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2262 let open_channel = msgs::OpenChannel {
2263 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2264 temporary_channel_id: [2; 32],
2265 funding_satoshis: 1311768467284833366,
2266 push_msat: 2536655962884945560,
2267 dust_limit_satoshis: 3608586615801332854,
2268 max_htlc_value_in_flight_msat: 8517154655701053848,
2269 channel_reserve_satoshis: 8665828695742877976,
2270 htlc_minimum_msat: 2316138423780173,
2271 feerate_per_kw: 821716,
2272 to_self_delay: 49340,
2273 max_accepted_htlcs: 49340,
2274 funding_pubkey: pubkey_1,
2275 revocation_basepoint: pubkey_2,
2276 payment_point: pubkey_3,
2277 delayed_payment_basepoint: pubkey_4,
2278 htlc_basepoint: pubkey_5,
2279 first_per_commitment_point: pubkey_6,
2280 channel_flags: if random_bit { 1 << 5 } else { 0 },
2281 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2282 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2284 let encoded_value = open_channel.encode();
2285 let mut target_value = Vec::new();
2286 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2287 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2289 target_value.append(&mut hex::decode("20").unwrap());
2291 target_value.append(&mut hex::decode("00").unwrap());
2294 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2297 target_value.append(&mut hex::decode("0100").unwrap());
2299 assert_eq!(encoded_value, target_value);
2303 fn encoding_open_channel() {
2304 do_encoding_open_channel(false, false, false);
2305 do_encoding_open_channel(false, false, true);
2306 do_encoding_open_channel(false, true, false);
2307 do_encoding_open_channel(false, true, true);
2308 do_encoding_open_channel(true, false, false);
2309 do_encoding_open_channel(true, false, true);
2310 do_encoding_open_channel(true, true, false);
2311 do_encoding_open_channel(true, true, true);
2314 fn do_encoding_accept_channel(shutdown: bool) {
2315 let secp_ctx = Secp256k1::new();
2316 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2317 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2318 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2319 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2320 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2321 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2322 let accept_channel = msgs::AcceptChannel {
2323 temporary_channel_id: [2; 32],
2324 dust_limit_satoshis: 1311768467284833366,
2325 max_htlc_value_in_flight_msat: 2536655962884945560,
2326 channel_reserve_satoshis: 3608586615801332854,
2327 htlc_minimum_msat: 2316138423780173,
2328 minimum_depth: 821716,
2329 to_self_delay: 49340,
2330 max_accepted_htlcs: 49340,
2331 funding_pubkey: pubkey_1,
2332 revocation_basepoint: pubkey_2,
2333 payment_point: pubkey_3,
2334 delayed_payment_basepoint: pubkey_4,
2335 htlc_basepoint: pubkey_5,
2336 first_per_commitment_point: pubkey_6,
2337 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2340 let encoded_value = accept_channel.encode();
2341 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2343 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2345 assert_eq!(encoded_value, target_value);
2349 fn encoding_accept_channel() {
2350 do_encoding_accept_channel(false);
2351 do_encoding_accept_channel(true);
2355 fn encoding_funding_created() {
2356 let secp_ctx = Secp256k1::new();
2357 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2358 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2359 let funding_created = msgs::FundingCreated {
2360 temporary_channel_id: [2; 32],
2361 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2362 funding_output_index: 255,
2365 let encoded_value = funding_created.encode();
2366 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2367 assert_eq!(encoded_value, target_value);
2371 fn encoding_funding_signed() {
2372 let secp_ctx = Secp256k1::new();
2373 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2374 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2375 let funding_signed = msgs::FundingSigned {
2376 channel_id: [2; 32],
2379 let encoded_value = funding_signed.encode();
2380 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2381 assert_eq!(encoded_value, target_value);
2385 fn encoding_channel_ready() {
2386 let secp_ctx = Secp256k1::new();
2387 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2388 let channel_ready = msgs::ChannelReady {
2389 channel_id: [2; 32],
2390 next_per_commitment_point: pubkey_1,
2391 short_channel_id_alias: None,
2393 let encoded_value = channel_ready.encode();
2394 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2395 assert_eq!(encoded_value, target_value);
2398 fn do_encoding_shutdown(script_type: u8) {
2399 let secp_ctx = Secp256k1::new();
2400 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2401 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2402 let shutdown = msgs::Shutdown {
2403 channel_id: [2; 32],
2405 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2406 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2407 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2408 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2410 let encoded_value = shutdown.encode();
2411 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2412 if script_type == 1 {
2413 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2414 } else if script_type == 2 {
2415 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2416 } else if script_type == 3 {
2417 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2418 } else if script_type == 4 {
2419 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2421 assert_eq!(encoded_value, target_value);
2425 fn encoding_shutdown() {
2426 do_encoding_shutdown(1);
2427 do_encoding_shutdown(2);
2428 do_encoding_shutdown(3);
2429 do_encoding_shutdown(4);
2433 fn encoding_closing_signed() {
2434 let secp_ctx = Secp256k1::new();
2435 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2436 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2437 let closing_signed = msgs::ClosingSigned {
2438 channel_id: [2; 32],
2439 fee_satoshis: 2316138423780173,
2443 let encoded_value = closing_signed.encode();
2444 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2445 assert_eq!(encoded_value, target_value);
2446 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2448 let closing_signed_with_range = msgs::ClosingSigned {
2449 channel_id: [2; 32],
2450 fee_satoshis: 2316138423780173,
2452 fee_range: Some(msgs::ClosingSignedFeeRange {
2453 min_fee_satoshis: 0xdeadbeef,
2454 max_fee_satoshis: 0x1badcafe01234567,
2457 let encoded_value_with_range = closing_signed_with_range.encode();
2458 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2459 assert_eq!(encoded_value_with_range, target_value_with_range);
2460 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2461 closing_signed_with_range);
2465 fn encoding_update_add_htlc() {
2466 let secp_ctx = Secp256k1::new();
2467 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2468 let onion_routing_packet = msgs::OnionPacket {
2470 public_key: Ok(pubkey_1),
2471 hop_data: [1; 20*65],
2474 let update_add_htlc = msgs::UpdateAddHTLC {
2475 channel_id: [2; 32],
2476 htlc_id: 2316138423780173,
2477 amount_msat: 3608586615801332854,
2478 payment_hash: PaymentHash([1; 32]),
2479 cltv_expiry: 821716,
2480 onion_routing_packet
2482 let encoded_value = update_add_htlc.encode();
2483 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2484 assert_eq!(encoded_value, target_value);
2488 fn encoding_update_fulfill_htlc() {
2489 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2490 channel_id: [2; 32],
2491 htlc_id: 2316138423780173,
2492 payment_preimage: PaymentPreimage([1; 32]),
2494 let encoded_value = update_fulfill_htlc.encode();
2495 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2496 assert_eq!(encoded_value, target_value);
2500 fn encoding_update_fail_htlc() {
2501 let reason = OnionErrorPacket {
2502 data: [1; 32].to_vec(),
2504 let update_fail_htlc = msgs::UpdateFailHTLC {
2505 channel_id: [2; 32],
2506 htlc_id: 2316138423780173,
2509 let encoded_value = update_fail_htlc.encode();
2510 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2511 assert_eq!(encoded_value, target_value);
2515 fn encoding_update_fail_malformed_htlc() {
2516 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2517 channel_id: [2; 32],
2518 htlc_id: 2316138423780173,
2519 sha256_of_onion: [1; 32],
2522 let encoded_value = update_fail_malformed_htlc.encode();
2523 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2524 assert_eq!(encoded_value, target_value);
2527 fn do_encoding_commitment_signed(htlcs: bool) {
2528 let secp_ctx = Secp256k1::new();
2529 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2530 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2531 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2532 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2533 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2534 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2535 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2536 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2537 let commitment_signed = msgs::CommitmentSigned {
2538 channel_id: [2; 32],
2540 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2542 let encoded_value = commitment_signed.encode();
2543 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2545 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2547 target_value.append(&mut hex::decode("0000").unwrap());
2549 assert_eq!(encoded_value, target_value);
2553 fn encoding_commitment_signed() {
2554 do_encoding_commitment_signed(true);
2555 do_encoding_commitment_signed(false);
2559 fn encoding_revoke_and_ack() {
2560 let secp_ctx = Secp256k1::new();
2561 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2562 let raa = msgs::RevokeAndACK {
2563 channel_id: [2; 32],
2564 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],
2565 next_per_commitment_point: pubkey_1,
2567 let encoded_value = raa.encode();
2568 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2569 assert_eq!(encoded_value, target_value);
2573 fn encoding_update_fee() {
2574 let update_fee = msgs::UpdateFee {
2575 channel_id: [2; 32],
2576 feerate_per_kw: 20190119,
2578 let encoded_value = update_fee.encode();
2579 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2580 assert_eq!(encoded_value, target_value);
2584 fn encoding_init() {
2585 assert_eq!(msgs::Init {
2586 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2587 remote_network_address: None,
2588 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2589 assert_eq!(msgs::Init {
2590 features: InitFeatures::from_le_bytes(vec![0xFF]),
2591 remote_network_address: None,
2592 }.encode(), hex::decode("0001ff0001ff").unwrap());
2593 assert_eq!(msgs::Init {
2594 features: InitFeatures::from_le_bytes(vec![]),
2595 remote_network_address: None,
2596 }.encode(), hex::decode("00000000").unwrap());
2598 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2599 remote_network_address: Some(msgs::NetAddress::IPv4 {
2600 addr: [127, 0, 0, 1],
2604 let encoded_value = init_msg.encode();
2605 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2606 assert_eq!(encoded_value, target_value);
2607 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2611 fn encoding_error() {
2612 let error = msgs::ErrorMessage {
2613 channel_id: [2; 32],
2614 data: String::from("rust-lightning"),
2616 let encoded_value = error.encode();
2617 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2618 assert_eq!(encoded_value, target_value);
2622 fn encoding_warning() {
2623 let error = msgs::WarningMessage {
2624 channel_id: [2; 32],
2625 data: String::from("rust-lightning"),
2627 let encoded_value = error.encode();
2628 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2629 assert_eq!(encoded_value, target_value);
2633 fn encoding_ping() {
2634 let ping = msgs::Ping {
2638 let encoded_value = ping.encode();
2639 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2640 assert_eq!(encoded_value, target_value);
2644 fn encoding_pong() {
2645 let pong = msgs::Pong {
2648 let encoded_value = pong.encode();
2649 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2650 assert_eq!(encoded_value, target_value);
2654 fn encoding_legacy_onion_hop_data() {
2655 let msg = msgs::OnionHopData {
2656 format: OnionHopDataFormat::Legacy {
2657 short_channel_id: 0xdeadbeef1bad1dea,
2659 amt_to_forward: 0x0badf00d01020304,
2660 outgoing_cltv_value: 0xffffffff,
2662 let encoded_value = msg.encode();
2663 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2664 assert_eq!(encoded_value, target_value);
2668 fn encoding_nonfinal_onion_hop_data() {
2669 let mut msg = msgs::OnionHopData {
2670 format: OnionHopDataFormat::NonFinalNode {
2671 short_channel_id: 0xdeadbeef1bad1dea,
2673 amt_to_forward: 0x0badf00d01020304,
2674 outgoing_cltv_value: 0xffffffff,
2676 let encoded_value = msg.encode();
2677 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2678 assert_eq!(encoded_value, target_value);
2679 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2680 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2681 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2682 } else { panic!(); }
2683 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2684 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2688 fn encoding_final_onion_hop_data() {
2689 let mut msg = msgs::OnionHopData {
2690 format: OnionHopDataFormat::FinalNode {
2692 keysend_preimage: None,
2694 amt_to_forward: 0x0badf00d01020304,
2695 outgoing_cltv_value: 0xffffffff,
2697 let encoded_value = msg.encode();
2698 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2699 assert_eq!(encoded_value, target_value);
2700 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2701 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2702 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2703 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2707 fn encoding_final_onion_hop_data_with_secret() {
2708 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2709 let mut msg = msgs::OnionHopData {
2710 format: OnionHopDataFormat::FinalNode {
2711 payment_data: Some(FinalOnionHopData {
2712 payment_secret: expected_payment_secret,
2713 total_msat: 0x1badca1f
2715 keysend_preimage: None,
2717 amt_to_forward: 0x0badf00d01020304,
2718 outgoing_cltv_value: 0xffffffff,
2720 let encoded_value = msg.encode();
2721 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2722 assert_eq!(encoded_value, target_value);
2723 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2724 if let OnionHopDataFormat::FinalNode {
2725 payment_data: Some(FinalOnionHopData {
2727 total_msat: 0x1badca1f
2729 keysend_preimage: None,
2731 assert_eq!(payment_secret, expected_payment_secret);
2732 } else { panic!(); }
2733 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2734 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2738 fn query_channel_range_end_blocknum() {
2739 let tests: Vec<(u32, u32, u32)> = vec![
2740 (10000, 1500, 11500),
2741 (0, 0xffffffff, 0xffffffff),
2742 (1, 0xffffffff, 0xffffffff),
2745 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2746 let sut = msgs::QueryChannelRange {
2747 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2751 assert_eq!(sut.end_blocknum(), expected);
2756 fn encoding_query_channel_range() {
2757 let mut query_channel_range = msgs::QueryChannelRange {
2758 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2759 first_blocknum: 100000,
2760 number_of_blocks: 1500,
2762 let encoded_value = query_channel_range.encode();
2763 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2764 assert_eq!(encoded_value, target_value);
2766 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2767 assert_eq!(query_channel_range.first_blocknum, 100000);
2768 assert_eq!(query_channel_range.number_of_blocks, 1500);
2772 fn encoding_reply_channel_range() {
2773 do_encoding_reply_channel_range(0);
2774 do_encoding_reply_channel_range(1);
2777 fn do_encoding_reply_channel_range(encoding_type: u8) {
2778 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2779 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2780 let mut reply_channel_range = msgs::ReplyChannelRange {
2781 chain_hash: expected_chain_hash,
2782 first_blocknum: 756230,
2783 number_of_blocks: 1500,
2784 sync_complete: true,
2785 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2788 if encoding_type == 0 {
2789 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2790 let encoded_value = reply_channel_range.encode();
2791 assert_eq!(encoded_value, target_value);
2793 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2794 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2795 assert_eq!(reply_channel_range.first_blocknum, 756230);
2796 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2797 assert_eq!(reply_channel_range.sync_complete, true);
2798 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2799 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2800 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2802 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2803 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2804 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2809 fn encoding_query_short_channel_ids() {
2810 do_encoding_query_short_channel_ids(0);
2811 do_encoding_query_short_channel_ids(1);
2814 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2815 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2816 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2817 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2818 chain_hash: expected_chain_hash,
2819 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2822 if encoding_type == 0 {
2823 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2824 let encoded_value = query_short_channel_ids.encode();
2825 assert_eq!(encoded_value, target_value);
2827 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2828 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2829 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2830 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2831 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2833 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2834 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2835 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2840 fn encoding_reply_short_channel_ids_end() {
2841 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2842 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2843 chain_hash: expected_chain_hash,
2844 full_information: true,
2846 let encoded_value = reply_short_channel_ids_end.encode();
2847 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2848 assert_eq!(encoded_value, target_value);
2850 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2851 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2852 assert_eq!(reply_short_channel_ids_end.full_information, true);
2856 fn encoding_gossip_timestamp_filter(){
2857 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2858 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2859 chain_hash: expected_chain_hash,
2860 first_timestamp: 1590000000,
2861 timestamp_range: 0xffff_ffff,
2863 let encoded_value = gossip_timestamp_filter.encode();
2864 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2865 assert_eq!(encoded_value, target_value);
2867 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2868 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2869 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2870 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
2874 fn decode_onion_hop_data_len_as_bigsize() {
2875 // Tests that we can decode an onion payload that is >253 bytes.
2876 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
2877 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
2880 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
2881 // payload length to be encoded over multiple bytes rather than a single u8.
2882 let big_payload = encode_big_payload().unwrap();
2883 let mut rd = Cursor::new(&big_payload[..]);
2884 <msgs::OnionHopData as Readable>::read(&mut rd).unwrap();
2886 // see above test, needs to be a separate method for use of the serialization macros.
2887 fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
2888 use util::ser::HighZeroBytesDroppedBigSize;
2889 let payload = msgs::OnionHopData {
2890 format: OnionHopDataFormat::NonFinalNode {
2891 short_channel_id: 0xdeadbeef1bad1dea,
2893 amt_to_forward: 1000,
2894 outgoing_cltv_value: 0xffffffff,
2896 let mut encoded_payload = Vec::new();
2897 let test_bytes = vec![42u8; 1000];
2898 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = payload.format {
2899 encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
2900 (1, test_bytes, vec_type),
2901 (2, HighZeroBytesDroppedBigSize(payload.amt_to_forward), required),
2902 (4, HighZeroBytesDroppedBigSize(payload.outgoing_cltv_value), required),
2903 (6, short_channel_id, required)