1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
12 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
13 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
14 //! server entirely) which handles only channel-related messages you may wish to implement
15 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
18 //! Note that if you go with such an architecture (instead of passing raw socket events to a
19 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
20 //! source node_id of the message, however this does allow you to significantly reduce bandwidth
21 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
22 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
23 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
24 //! raw socket events into your non-internet-facing system and then send routing events back to
25 //! track the network on the less-secure system.
27 use bitcoin::secp256k1::key::PublicKey;
28 use bitcoin::secp256k1::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
39 use io_extras::read_to_end;
41 use util::events::MessageSendEventsProvider;
43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
47 /// 21 million * 10^8 * 1000
48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
50 /// An error in decoding a message or struct.
51 #[derive(Clone, Debug, PartialEq)]
52 pub enum DecodeError {
53 /// A version byte specified something we don't know how to handle.
54 /// Includes unknown realm byte in an OnionHopData packet
56 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
57 UnknownRequiredFeature,
58 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
59 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
60 /// syntactically incorrect, etc
64 /// A length descriptor in the packet didn't describe the later data correctly
66 /// Error from std::io
67 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
69 /// The message included zlib-compressed values, which we don't support.
70 UnsupportedCompression,
73 /// An init message to be sent or received from a peer
74 #[derive(Clone, Debug, PartialEq)]
76 /// The relevant features which the sender supports
77 pub features: InitFeatures,
80 /// An error message to be sent or received from a peer
81 #[derive(Clone, Debug, PartialEq)]
82 pub struct ErrorMessage {
83 /// The channel ID involved in the error.
85 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
86 /// with the sending peer should be closed.
87 pub channel_id: [u8; 32],
88 /// A possibly human-readable error description.
89 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
90 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
91 /// the terminal emulator or the logging subsystem.
95 /// A warning message to be sent or received from a peer
96 #[derive(Clone, Debug, PartialEq)]
97 pub struct WarningMessage {
98 /// The channel ID involved in the warning.
100 /// All-0s indicates a warning unrelated to a specific channel.
101 pub channel_id: [u8; 32],
102 /// A possibly human-readable warning description.
103 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
104 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
105 /// the terminal emulator or the logging subsystem.
109 /// A ping message to be sent or received from a peer
110 #[derive(Clone, Debug, PartialEq)]
112 /// The desired response length
114 /// The ping packet size.
115 /// This field is not sent on the wire. byteslen zeros are sent.
119 /// A pong message to be sent or received from a peer
120 #[derive(Clone, Debug, PartialEq)]
122 /// The pong packet size.
123 /// This field is not sent on the wire. byteslen zeros are sent.
127 /// An open_channel message to be sent or received from a peer
128 #[derive(Clone, Debug, PartialEq)]
129 pub struct OpenChannel {
130 /// The genesis hash of the blockchain where the channel is to be opened
131 pub chain_hash: BlockHash,
132 /// A temporary channel ID, until the funding outpoint is announced
133 pub temporary_channel_id: [u8; 32],
134 /// The channel value
135 pub funding_satoshis: u64,
136 /// The amount to push to the counterparty as part of the open, in milli-satoshi
138 /// The threshold below which outputs on transactions broadcast by sender will be omitted
139 pub dust_limit_satoshis: u64,
140 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
141 pub max_htlc_value_in_flight_msat: u64,
142 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
143 pub channel_reserve_satoshis: u64,
144 /// The minimum HTLC size incoming to sender, in milli-satoshi
145 pub htlc_minimum_msat: u64,
146 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
147 pub feerate_per_kw: u32,
148 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
149 pub to_self_delay: u16,
150 /// The maximum number of inbound HTLCs towards sender
151 pub max_accepted_htlcs: u16,
152 /// The sender's key controlling the funding transaction
153 pub funding_pubkey: PublicKey,
154 /// Used to derive a revocation key for transactions broadcast by counterparty
155 pub revocation_basepoint: PublicKey,
156 /// A payment key to sender for transactions broadcast by counterparty
157 pub payment_point: PublicKey,
158 /// Used to derive a payment key to sender for transactions broadcast by sender
159 pub delayed_payment_basepoint: PublicKey,
160 /// Used to derive an HTLC payment key to sender
161 pub htlc_basepoint: PublicKey,
162 /// The first to-be-broadcast-by-sender transaction's per commitment point
163 pub first_per_commitment_point: PublicKey,
165 pub channel_flags: u8,
166 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
167 pub shutdown_scriptpubkey: OptionalField<Script>,
168 /// The channel type that this channel will represent. If none is set, we derive the channel
169 /// type from the intersection of our feature bits with our counterparty's feature bits from
170 /// the Init message.
171 pub channel_type: Option<ChannelTypeFeatures>,
174 /// An accept_channel message to be sent or received from a peer
175 #[derive(Clone, Debug, PartialEq)]
176 pub struct AcceptChannel {
177 /// A temporary channel ID, until the funding outpoint is announced
178 pub temporary_channel_id: [u8; 32],
179 /// The threshold below which outputs on transactions broadcast by sender will be omitted
180 pub dust_limit_satoshis: u64,
181 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
182 pub max_htlc_value_in_flight_msat: u64,
183 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
184 pub channel_reserve_satoshis: u64,
185 /// The minimum HTLC size incoming to sender, in milli-satoshi
186 pub htlc_minimum_msat: u64,
187 /// Minimum depth of the funding transaction before the channel is considered open
188 pub minimum_depth: u32,
189 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
190 pub to_self_delay: u16,
191 /// The maximum number of inbound HTLCs towards sender
192 pub max_accepted_htlcs: u16,
193 /// The sender's key controlling the funding transaction
194 pub funding_pubkey: PublicKey,
195 /// Used to derive a revocation key for transactions broadcast by counterparty
196 pub revocation_basepoint: PublicKey,
197 /// A payment key to sender for transactions broadcast by counterparty
198 pub payment_point: PublicKey,
199 /// Used to derive a payment key to sender for transactions broadcast by sender
200 pub delayed_payment_basepoint: PublicKey,
201 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
202 pub htlc_basepoint: PublicKey,
203 /// The first to-be-broadcast-by-sender transaction's per commitment point
204 pub first_per_commitment_point: PublicKey,
205 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
206 pub shutdown_scriptpubkey: OptionalField<Script>,
207 /// The channel type that this channel will represent. If none is set, we derive the channel
208 /// type from the intersection of our feature bits with our counterparty's feature bits from
209 /// the Init message.
211 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
212 pub channel_type: Option<ChannelTypeFeatures>,
215 /// A funding_created message to be sent or received from a peer
216 #[derive(Clone, Debug, PartialEq)]
217 pub struct FundingCreated {
218 /// A temporary channel ID, until the funding is established
219 pub temporary_channel_id: [u8; 32],
220 /// The funding transaction ID
221 pub funding_txid: Txid,
222 /// The specific output index funding this channel
223 pub funding_output_index: u16,
224 /// The signature of the channel initiator (funder) on the initial commitment transaction
225 pub signature: Signature,
228 /// A funding_signed message to be sent or received from a peer
229 #[derive(Clone, Debug, PartialEq)]
230 pub struct FundingSigned {
232 pub channel_id: [u8; 32],
233 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
234 pub signature: Signature,
237 /// A funding_locked message to be sent or received from a peer
238 #[derive(Clone, Debug, PartialEq)]
239 pub struct FundingLocked {
241 pub channel_id: [u8; 32],
242 /// The per-commitment point of the second commitment transaction
243 pub next_per_commitment_point: PublicKey,
244 /// If set, provides a short_channel_id alias for this channel. The sender will accept payments
245 /// to be forwarded over this SCID and forward them to this messages' recipient.
246 pub short_channel_id_alias: Option<u64>,
249 /// A shutdown message to be sent or received from a peer
250 #[derive(Clone, Debug, PartialEq)]
251 pub struct Shutdown {
253 pub channel_id: [u8; 32],
254 /// The destination of this peer's funds on closing.
255 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
256 pub scriptpubkey: Script,
259 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
260 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
262 #[derive(Clone, Debug, PartialEq)]
263 pub struct ClosingSignedFeeRange {
264 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
266 pub min_fee_satoshis: u64,
267 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
269 pub max_fee_satoshis: u64,
272 /// A closing_signed message to be sent or received from a peer
273 #[derive(Clone, Debug, PartialEq)]
274 pub struct ClosingSigned {
276 pub channel_id: [u8; 32],
277 /// The proposed total fee for the closing transaction
278 pub fee_satoshis: u64,
279 /// A signature on the closing transaction
280 pub signature: Signature,
281 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
283 pub fee_range: Option<ClosingSignedFeeRange>,
286 /// An update_add_htlc message to be sent or received from a peer
287 #[derive(Clone, Debug, PartialEq)]
288 pub struct UpdateAddHTLC {
290 pub channel_id: [u8; 32],
293 /// The HTLC value in milli-satoshi
294 pub amount_msat: u64,
295 /// The payment hash, the pre-image of which controls HTLC redemption
296 pub payment_hash: PaymentHash,
297 /// The expiry height of the HTLC
298 pub cltv_expiry: u32,
299 pub(crate) onion_routing_packet: OnionPacket,
302 /// An update_fulfill_htlc message to be sent or received from a peer
303 #[derive(Clone, Debug, PartialEq)]
304 pub struct UpdateFulfillHTLC {
306 pub channel_id: [u8; 32],
309 /// The pre-image of the payment hash, allowing HTLC redemption
310 pub payment_preimage: PaymentPreimage,
313 /// An update_fail_htlc message to be sent or received from a peer
314 #[derive(Clone, Debug, PartialEq)]
315 pub struct UpdateFailHTLC {
317 pub channel_id: [u8; 32],
320 pub(crate) reason: OnionErrorPacket,
323 /// An update_fail_malformed_htlc message to be sent or received from a peer
324 #[derive(Clone, Debug, PartialEq)]
325 pub struct UpdateFailMalformedHTLC {
327 pub channel_id: [u8; 32],
330 pub(crate) sha256_of_onion: [u8; 32],
332 pub failure_code: u16,
335 /// A commitment_signed message to be sent or received from a peer
336 #[derive(Clone, Debug, PartialEq)]
337 pub struct CommitmentSigned {
339 pub channel_id: [u8; 32],
340 /// A signature on the commitment transaction
341 pub signature: Signature,
342 /// Signatures on the HTLC transactions
343 pub htlc_signatures: Vec<Signature>,
346 /// A revoke_and_ack message to be sent or received from a peer
347 #[derive(Clone, Debug, PartialEq)]
348 pub struct RevokeAndACK {
350 pub channel_id: [u8; 32],
351 /// The secret corresponding to the per-commitment point
352 pub per_commitment_secret: [u8; 32],
353 /// The next sender-broadcast commitment transaction's per-commitment point
354 pub next_per_commitment_point: PublicKey,
357 /// An update_fee message to be sent or received from a peer
358 #[derive(Clone, Debug, PartialEq)]
359 pub struct UpdateFee {
361 pub channel_id: [u8; 32],
362 /// Fee rate per 1000-weight of the transaction
363 pub feerate_per_kw: u32,
366 #[derive(Clone, Debug, PartialEq)]
367 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
368 /// This is used to convince the recipient that the channel is at a certain commitment
369 /// number even if they lost that data due to a local failure. Of course, the peer may lie
370 /// and even later commitments may have been revoked.
371 pub struct DataLossProtect {
372 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
373 /// belonging to the recipient
374 pub your_last_per_commitment_secret: [u8; 32],
375 /// The sender's per-commitment point for their current commitment transaction
376 pub my_current_per_commitment_point: PublicKey,
379 /// A channel_reestablish message to be sent or received from a peer
380 #[derive(Clone, Debug, PartialEq)]
381 pub struct ChannelReestablish {
383 pub channel_id: [u8; 32],
384 /// The next commitment number for the sender
385 pub next_local_commitment_number: u64,
386 /// The next commitment number for the recipient
387 pub next_remote_commitment_number: u64,
388 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
389 pub data_loss_protect: OptionalField<DataLossProtect>,
392 /// An announcement_signatures message to be sent or received from a peer
393 #[derive(Clone, Debug, PartialEq)]
394 pub struct AnnouncementSignatures {
396 pub channel_id: [u8; 32],
397 /// The short channel ID
398 pub short_channel_id: u64,
399 /// A signature by the node key
400 pub node_signature: Signature,
401 /// A signature by the funding key
402 pub bitcoin_signature: Signature,
405 /// An address which can be used to connect to a remote peer
406 #[derive(Clone, Debug, PartialEq)]
407 pub enum NetAddress {
408 /// An IPv4 address/port on which the peer is listening.
410 /// The 4-byte IPv4 address
412 /// The port on which the node is listening
415 /// An IPv6 address/port on which the peer is listening.
417 /// The 16-byte IPv6 address
419 /// The port on which the node is listening
422 /// An old-style Tor onion address/port on which the peer is listening.
424 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
425 /// addresses. Thus, the details are not parsed here.
427 /// A new-style Tor onion address/port on which the peer is listening.
428 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
429 /// wrap as base32 and append ".onion".
431 /// The ed25519 long-term public key of the peer
432 ed25519_pubkey: [u8; 32],
433 /// The checksum of the pubkey and version, as included in the onion address
435 /// The version byte, as defined by the Tor Onion v3 spec.
437 /// The port on which the node is listening
442 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
444 pub(crate) fn get_id(&self) -> u8 {
446 &NetAddress::IPv4 {..} => { 1 },
447 &NetAddress::IPv6 {..} => { 2 },
448 &NetAddress::OnionV2(_) => { 3 },
449 &NetAddress::OnionV3 {..} => { 4 },
453 /// Strict byte-length of address descriptor, 1-byte type not recorded
454 fn len(&self) -> u16 {
456 &NetAddress::IPv4 { .. } => { 6 },
457 &NetAddress::IPv6 { .. } => { 18 },
458 &NetAddress::OnionV2(_) => { 12 },
459 &NetAddress::OnionV3 { .. } => { 37 },
463 /// The maximum length of any address descriptor, not including the 1-byte type
464 pub(crate) const MAX_LEN: u16 = 37;
467 impl Writeable for NetAddress {
468 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
470 &NetAddress::IPv4 { ref addr, ref port } => {
475 &NetAddress::IPv6 { ref addr, ref port } => {
480 &NetAddress::OnionV2(bytes) => {
482 bytes.write(writer)?;
484 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
486 ed25519_pubkey.write(writer)?;
487 checksum.write(writer)?;
488 version.write(writer)?;
496 impl Readable for Result<NetAddress, u8> {
497 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
498 let byte = <u8 as Readable>::read(reader)?;
501 Ok(Ok(NetAddress::IPv4 {
502 addr: Readable::read(reader)?,
503 port: Readable::read(reader)?,
507 Ok(Ok(NetAddress::IPv6 {
508 addr: Readable::read(reader)?,
509 port: Readable::read(reader)?,
512 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
514 Ok(Ok(NetAddress::OnionV3 {
515 ed25519_pubkey: Readable::read(reader)?,
516 checksum: Readable::read(reader)?,
517 version: Readable::read(reader)?,
518 port: Readable::read(reader)?,
521 _ => return Ok(Err(byte)),
526 impl Readable for NetAddress {
527 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
528 match Readable::read(reader) {
529 Ok(Ok(res)) => Ok(res),
530 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
537 /// The unsigned part of a node_announcement
538 #[derive(Clone, Debug, PartialEq)]
539 pub struct UnsignedNodeAnnouncement {
540 /// The advertised features
541 pub features: NodeFeatures,
542 /// A strictly monotonic announcement counter, with gaps allowed
544 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
546 pub node_id: PublicKey,
547 /// An RGB color for UI purposes
549 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
552 /// List of addresses on which this node is reachable
553 pub addresses: Vec<NetAddress>,
554 pub(crate) excess_address_data: Vec<u8>,
555 pub(crate) excess_data: Vec<u8>,
557 #[derive(Clone, Debug, PartialEq)]
558 /// A node_announcement message to be sent or received from a peer
559 pub struct NodeAnnouncement {
560 /// The signature by the node key
561 pub signature: Signature,
562 /// The actual content of the announcement
563 pub contents: UnsignedNodeAnnouncement,
566 /// The unsigned part of a channel_announcement
567 #[derive(Clone, Debug, PartialEq)]
568 pub struct UnsignedChannelAnnouncement {
569 /// The advertised channel features
570 pub features: ChannelFeatures,
571 /// The genesis hash of the blockchain where the channel is to be opened
572 pub chain_hash: BlockHash,
573 /// The short channel ID
574 pub short_channel_id: u64,
575 /// One of the two node_ids which are endpoints of this channel
576 pub node_id_1: PublicKey,
577 /// The other of the two node_ids which are endpoints of this channel
578 pub node_id_2: PublicKey,
579 /// The funding key for the first node
580 pub bitcoin_key_1: PublicKey,
581 /// The funding key for the second node
582 pub bitcoin_key_2: PublicKey,
583 pub(crate) excess_data: Vec<u8>,
585 /// A channel_announcement message to be sent or received from a peer
586 #[derive(Clone, Debug, PartialEq)]
587 pub struct ChannelAnnouncement {
588 /// Authentication of the announcement by the first public node
589 pub node_signature_1: Signature,
590 /// Authentication of the announcement by the second public node
591 pub node_signature_2: Signature,
592 /// Proof of funding UTXO ownership by the first public node
593 pub bitcoin_signature_1: Signature,
594 /// Proof of funding UTXO ownership by the second public node
595 pub bitcoin_signature_2: Signature,
596 /// The actual announcement
597 pub contents: UnsignedChannelAnnouncement,
600 /// The unsigned part of a channel_update
601 #[derive(Clone, Debug, PartialEq)]
602 pub struct UnsignedChannelUpdate {
603 /// The genesis hash of the blockchain where the channel is to be opened
604 pub chain_hash: BlockHash,
605 /// The short channel ID
606 pub short_channel_id: u64,
607 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
611 /// The number of blocks such that if:
612 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
613 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
614 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
615 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
616 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
617 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
618 /// constructing the route.
619 pub cltv_expiry_delta: u16,
620 /// The minimum HTLC size incoming to sender, in milli-satoshi
621 pub htlc_minimum_msat: u64,
622 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
623 pub htlc_maximum_msat: OptionalField<u64>,
624 /// The base HTLC fee charged by sender, in milli-satoshi
625 pub fee_base_msat: u32,
626 /// The amount to fee multiplier, in micro-satoshi
627 pub fee_proportional_millionths: u32,
628 pub(crate) excess_data: Vec<u8>,
630 /// A channel_update message to be sent or received from a peer
631 #[derive(Clone, Debug, PartialEq)]
632 pub struct ChannelUpdate {
633 /// A signature of the channel update
634 pub signature: Signature,
635 /// The actual channel update
636 pub contents: UnsignedChannelUpdate,
639 /// A query_channel_range message is used to query a peer for channel
640 /// UTXOs in a range of blocks. The recipient of a query makes a best
641 /// effort to reply to the query using one or more reply_channel_range
643 #[derive(Clone, Debug, PartialEq)]
644 pub struct QueryChannelRange {
645 /// The genesis hash of the blockchain being queried
646 pub chain_hash: BlockHash,
647 /// The height of the first block for the channel UTXOs being queried
648 pub first_blocknum: u32,
649 /// The number of blocks to include in the query results
650 pub number_of_blocks: u32,
653 /// A reply_channel_range message is a reply to a query_channel_range
654 /// message. Multiple reply_channel_range messages can be sent in reply
655 /// to a single query_channel_range message. The query recipient makes a
656 /// best effort to respond based on their local network view which may
657 /// not be a perfect view of the network. The short_channel_ids in the
658 /// reply are encoded. We only support encoding_type=0 uncompressed
659 /// serialization and do not support encoding_type=1 zlib serialization.
660 #[derive(Clone, Debug, PartialEq)]
661 pub struct ReplyChannelRange {
662 /// The genesis hash of the blockchain being queried
663 pub chain_hash: BlockHash,
664 /// The height of the first block in the range of the reply
665 pub first_blocknum: u32,
666 /// The number of blocks included in the range of the reply
667 pub number_of_blocks: u32,
668 /// True when this is the final reply for a query
669 pub sync_complete: bool,
670 /// The short_channel_ids in the channel range
671 pub short_channel_ids: Vec<u64>,
674 /// A query_short_channel_ids message is used to query a peer for
675 /// routing gossip messages related to one or more short_channel_ids.
676 /// The query recipient will reply with the latest, if available,
677 /// channel_announcement, channel_update and node_announcement messages
678 /// it maintains for the requested short_channel_ids followed by a
679 /// reply_short_channel_ids_end message. The short_channel_ids sent in
680 /// this query are encoded. We only support encoding_type=0 uncompressed
681 /// serialization and do not support encoding_type=1 zlib serialization.
682 #[derive(Clone, Debug, PartialEq)]
683 pub struct QueryShortChannelIds {
684 /// The genesis hash of the blockchain being queried
685 pub chain_hash: BlockHash,
686 /// The short_channel_ids that are being queried
687 pub short_channel_ids: Vec<u64>,
690 /// A reply_short_channel_ids_end message is sent as a reply to a
691 /// query_short_channel_ids message. The query recipient makes a best
692 /// effort to respond based on their local network view which may not be
693 /// a perfect view of the network.
694 #[derive(Clone, Debug, PartialEq)]
695 pub struct ReplyShortChannelIdsEnd {
696 /// The genesis hash of the blockchain that was queried
697 pub chain_hash: BlockHash,
698 /// Indicates if the query recipient maintains up-to-date channel
699 /// information for the chain_hash
700 pub full_information: bool,
703 /// A gossip_timestamp_filter message is used by a node to request
704 /// gossip relay for messages in the requested time range when the
705 /// gossip_queries feature has been negotiated.
706 #[derive(Clone, Debug, PartialEq)]
707 pub struct GossipTimestampFilter {
708 /// The genesis hash of the blockchain for channel and node information
709 pub chain_hash: BlockHash,
710 /// The starting unix timestamp
711 pub first_timestamp: u32,
712 /// The range of information in seconds
713 pub timestamp_range: u32,
716 /// Encoding type for data compression of collections in gossip queries.
717 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
722 /// Used to put an error message in a LightningError
723 #[derive(Clone, Debug)]
724 pub enum ErrorAction {
725 /// The peer took some action which made us think they were useless. Disconnect them.
727 /// An error message which we should make an effort to send before we disconnect.
728 msg: Option<ErrorMessage>
730 /// The peer did something harmless that we weren't able to process, just log and ignore
731 // New code should *not* use this. New code must use IgnoreAndLog, below!
733 /// The peer did something harmless that we weren't able to meaningfully process.
734 /// If the error is logged, log it at the given level.
735 IgnoreAndLog(logger::Level),
736 /// The peer provided us with a gossip message which we'd already seen. In most cases this
737 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
738 /// our own channel announcements.
739 IgnoreDuplicateGossip,
740 /// The peer did something incorrect. Tell them.
742 /// The message to send.
745 /// The peer did something incorrect. Tell them without closing any channels.
747 /// The message to send.
749 /// The peer may have done something harmless that we weren't able to meaningfully process,
750 /// though we should still tell them about it.
751 /// If this event is logged, log it at the given level.
752 log_level: logger::Level,
756 /// An Err type for failure to process messages.
757 #[derive(Clone, Debug)]
758 pub struct LightningError {
759 /// A human-readable message describing the error
761 /// The action which should be taken against the offending peer.
762 pub action: ErrorAction,
765 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
766 /// transaction updates if they were pending.
767 #[derive(Clone, Debug, PartialEq)]
768 pub struct CommitmentUpdate {
769 /// update_add_htlc messages which should be sent
770 pub update_add_htlcs: Vec<UpdateAddHTLC>,
771 /// update_fulfill_htlc messages which should be sent
772 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
773 /// update_fail_htlc messages which should be sent
774 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
775 /// update_fail_malformed_htlc messages which should be sent
776 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
777 /// An update_fee message which should be sent
778 pub update_fee: Option<UpdateFee>,
779 /// Finally, the commitment_signed message which should be sent
780 pub commitment_signed: CommitmentSigned,
783 /// Messages could have optional fields to use with extended features
784 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
785 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
786 /// separate enum type for them.
787 /// (C-not exported) due to a free generic in T
788 #[derive(Clone, Debug, PartialEq)]
789 pub enum OptionalField<T> {
790 /// Optional field is included in message
792 /// Optional field is absent in message
796 /// A trait to describe an object which can receive channel messages.
798 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
799 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
800 pub trait ChannelMessageHandler : MessageSendEventsProvider {
802 /// Handle an incoming open_channel message from the given peer.
803 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
804 /// Handle an incoming accept_channel message from the given peer.
805 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
806 /// Handle an incoming funding_created message from the given peer.
807 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
808 /// Handle an incoming funding_signed message from the given peer.
809 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
810 /// Handle an incoming funding_locked message from the given peer.
811 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
814 /// Handle an incoming shutdown message from the given peer.
815 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
816 /// Handle an incoming closing_signed message from the given peer.
817 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
820 /// Handle an incoming update_add_htlc message from the given peer.
821 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
822 /// Handle an incoming update_fulfill_htlc message from the given peer.
823 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
824 /// Handle an incoming update_fail_htlc message from the given peer.
825 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
826 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
827 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
828 /// Handle an incoming commitment_signed message from the given peer.
829 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
830 /// Handle an incoming revoke_and_ack message from the given peer.
831 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
833 /// Handle an incoming update_fee message from the given peer.
834 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
836 // Channel-to-announce:
837 /// Handle an incoming announcement_signatures message from the given peer.
838 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
840 // Connection loss/reestablish:
841 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
842 /// is believed to be possible in the future (eg they're sending us messages we don't
843 /// understand or indicate they require unknown feature bits), no_connection_possible is set
844 /// and any outstanding channels should be failed.
845 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
847 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
848 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
849 /// Handle an incoming channel_reestablish message from the given peer.
850 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
852 /// Handle an incoming channel update from the given peer.
853 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
856 /// Handle an incoming error message from the given peer.
857 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
860 /// A trait to describe an object which can receive routing messages.
862 /// # Implementor DoS Warnings
864 /// For `gossip_queries` messages there are potential DoS vectors when handling
865 /// inbound queries. Implementors using an on-disk network graph should be aware of
866 /// repeated disk I/O for queries accessing different parts of the network graph.
867 pub trait RoutingMessageHandler : MessageSendEventsProvider {
868 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
869 /// false or returning an Err otherwise.
870 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
871 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
872 /// or returning an Err otherwise.
873 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
874 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
875 /// false or returning an Err otherwise.
876 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
877 /// Gets a subset of the channel announcements and updates required to dump our routing table
878 /// to a remote node, starting at the short_channel_id indicated by starting_point and
879 /// including the batch_amount entries immediately higher in numerical value than starting_point.
880 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
881 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
882 /// starting at the node *after* the provided publickey and including batch_amount entries
883 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
884 /// If None is provided for starting_point, we start at the first node.
885 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
886 /// Called when a connection is established with a peer. This can be used to
887 /// perform routing table synchronization using a strategy defined by the
889 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
890 /// Handles the reply of a query we initiated to learn about channels
891 /// for a given range of blocks. We can expect to receive one or more
892 /// replies to a single query.
893 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
894 /// Handles the reply of a query we initiated asking for routing gossip
895 /// messages for a list of channels. We should receive this message when
896 /// a node has completed its best effort to send us the pertaining routing
898 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
899 /// Handles when a peer asks us to send a list of short_channel_ids
900 /// for the requested range of blocks.
901 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
902 /// Handles when a peer asks us to send routing gossip messages for a
903 /// list of short_channel_ids.
904 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
907 mod fuzzy_internal_msgs {
909 use ln::{PaymentPreimage, PaymentSecret};
911 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
912 // them from untrusted input):
914 pub(crate) struct FinalOnionHopData {
915 pub(crate) payment_secret: PaymentSecret,
916 /// The total value, in msat, of the payment as received by the ultimate recipient.
917 /// Message serialization may panic if this value is more than 21 million Bitcoin.
918 pub(crate) total_msat: u64,
921 pub(crate) enum OnionHopDataFormat {
922 Legacy { // aka Realm-0
923 short_channel_id: u64,
926 short_channel_id: u64,
929 payment_data: Option<FinalOnionHopData>,
930 keysend_preimage: Option<PaymentPreimage>,
934 pub struct OnionHopData {
935 pub(crate) format: OnionHopDataFormat,
936 /// The value, in msat, of the payment after this hop's fee is deducted.
937 /// Message serialization may panic if this value is more than 21 million Bitcoin.
938 pub(crate) amt_to_forward: u64,
939 pub(crate) outgoing_cltv_value: u32,
940 // 12 bytes of 0-padding for Legacy format
943 pub struct DecodedOnionErrorPacket {
944 pub(crate) hmac: [u8; 32],
945 pub(crate) failuremsg: Vec<u8>,
946 pub(crate) pad: Vec<u8>,
950 pub use self::fuzzy_internal_msgs::*;
952 pub(crate) use self::fuzzy_internal_msgs::*;
955 pub(crate) struct OnionPacket {
956 pub(crate) version: u8,
957 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
958 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
959 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
960 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
961 pub(crate) hop_data: [u8; 20*65],
962 pub(crate) hmac: [u8; 32],
965 impl PartialEq for OnionPacket {
966 fn eq(&self, other: &OnionPacket) -> bool {
967 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
968 if i != j { return false; }
970 self.version == other.version &&
971 self.public_key == other.public_key &&
972 self.hmac == other.hmac
976 impl fmt::Debug for OnionPacket {
977 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
978 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
982 #[derive(Clone, Debug, PartialEq)]
983 pub(crate) struct OnionErrorPacket {
984 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
985 // (TODO) We limit it in decode to much lower...
986 pub(crate) data: Vec<u8>,
989 impl fmt::Display for DecodeError {
990 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
992 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
993 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
994 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
995 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
996 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
997 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
998 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1003 impl From<io::Error> for DecodeError {
1004 fn from(e: io::Error) -> Self {
1005 if e.kind() == io::ErrorKind::UnexpectedEof {
1006 DecodeError::ShortRead
1008 DecodeError::Io(e.kind())
1013 impl Writeable for OptionalField<Script> {
1014 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1016 OptionalField::Present(ref script) => {
1017 // Note that Writeable for script includes the 16-bit length tag for us
1020 OptionalField::Absent => {}
1026 impl Readable for OptionalField<Script> {
1027 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1028 match <u16 as Readable>::read(r) {
1030 let mut buf = vec![0; len as usize];
1031 r.read_exact(&mut buf)?;
1032 Ok(OptionalField::Present(Script::from(buf)))
1034 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1040 impl Writeable for OptionalField<u64> {
1041 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1043 OptionalField::Present(ref value) => {
1046 OptionalField::Absent => {}
1052 impl Readable for OptionalField<u64> {
1053 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1054 let value: u64 = Readable::read(r)?;
1055 Ok(OptionalField::Present(value))
1060 impl_writeable_msg!(AcceptChannel, {
1061 temporary_channel_id,
1062 dust_limit_satoshis,
1063 max_htlc_value_in_flight_msat,
1064 channel_reserve_satoshis,
1070 revocation_basepoint,
1072 delayed_payment_basepoint,
1074 first_per_commitment_point,
1075 shutdown_scriptpubkey
1077 (1, channel_type, option),
1080 impl_writeable_msg!(AnnouncementSignatures, {
1087 impl Writeable for ChannelReestablish {
1088 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1089 self.channel_id.write(w)?;
1090 self.next_local_commitment_number.write(w)?;
1091 self.next_remote_commitment_number.write(w)?;
1092 match self.data_loss_protect {
1093 OptionalField::Present(ref data_loss_protect) => {
1094 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1095 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1097 OptionalField::Absent => {}
1103 impl Readable for ChannelReestablish{
1104 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1106 channel_id: Readable::read(r)?,
1107 next_local_commitment_number: Readable::read(r)?,
1108 next_remote_commitment_number: Readable::read(r)?,
1109 data_loss_protect: {
1110 match <[u8; 32] as Readable>::read(r) {
1111 Ok(your_last_per_commitment_secret) =>
1112 OptionalField::Present(DataLossProtect {
1113 your_last_per_commitment_secret,
1114 my_current_per_commitment_point: Readable::read(r)?,
1116 Err(DecodeError::ShortRead) => OptionalField::Absent,
1117 Err(e) => return Err(e)
1124 impl_writeable_msg!(ClosingSigned,
1125 { channel_id, fee_satoshis, signature },
1126 { (1, fee_range, option) }
1129 impl_writeable!(ClosingSignedFeeRange, {
1134 impl_writeable_msg!(CommitmentSigned, {
1140 impl_writeable!(DecodedOnionErrorPacket, {
1146 impl_writeable_msg!(FundingCreated, {
1147 temporary_channel_id,
1149 funding_output_index,
1153 impl_writeable_msg!(FundingSigned, {
1158 impl_writeable_msg!(FundingLocked, {
1160 next_per_commitment_point,
1162 (1, short_channel_id_alias, option),
1165 impl Writeable for Init {
1166 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1167 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1168 // our relevant feature bits. This keeps us compatible with old nodes.
1169 self.features.write_up_to_13(w)?;
1170 self.features.write(w)
1174 impl Readable for Init {
1175 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1176 let global_features: InitFeatures = Readable::read(r)?;
1177 let features: InitFeatures = Readable::read(r)?;
1179 features: features.or(global_features),
1184 impl_writeable_msg!(OpenChannel, {
1186 temporary_channel_id,
1189 dust_limit_satoshis,
1190 max_htlc_value_in_flight_msat,
1191 channel_reserve_satoshis,
1197 revocation_basepoint,
1199 delayed_payment_basepoint,
1201 first_per_commitment_point,
1203 shutdown_scriptpubkey
1205 (1, channel_type, option),
1208 impl_writeable_msg!(RevokeAndACK, {
1210 per_commitment_secret,
1211 next_per_commitment_point
1214 impl_writeable_msg!(Shutdown, {
1219 impl_writeable_msg!(UpdateFailHTLC, {
1225 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1232 impl_writeable_msg!(UpdateFee, {
1237 impl_writeable_msg!(UpdateFulfillHTLC, {
1243 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1244 // serialization format in a way which assumes we know the total serialized length/message end
1246 impl_writeable!(OnionErrorPacket, {
1250 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1251 // serialization format in a way which assumes we know the total serialized length/message end
1253 impl Writeable for OnionPacket {
1254 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1255 self.version.write(w)?;
1256 match self.public_key {
1257 Ok(pubkey) => pubkey.write(w)?,
1258 Err(_) => [0u8;33].write(w)?,
1260 w.write_all(&self.hop_data)?;
1261 self.hmac.write(w)?;
1266 impl Readable for OnionPacket {
1267 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1269 version: Readable::read(r)?,
1271 let mut buf = [0u8;33];
1272 r.read_exact(&mut buf)?;
1273 PublicKey::from_slice(&buf)
1275 hop_data: Readable::read(r)?,
1276 hmac: Readable::read(r)?,
1281 impl_writeable_msg!(UpdateAddHTLC, {
1287 onion_routing_packet
1290 impl Writeable for FinalOnionHopData {
1291 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1292 self.payment_secret.0.write(w)?;
1293 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1297 impl Readable for FinalOnionHopData {
1298 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1299 let secret: [u8; 32] = Readable::read(r)?;
1300 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1301 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1305 impl Writeable for OnionHopData {
1306 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1308 OnionHopDataFormat::Legacy { short_channel_id } => {
1310 short_channel_id.write(w)?;
1311 self.amt_to_forward.write(w)?;
1312 self.outgoing_cltv_value.write(w)?;
1313 w.write_all(&[0;12])?;
1315 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1316 encode_varint_length_prefixed_tlv!(w, {
1317 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1318 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1319 (6, short_channel_id, required)
1322 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1323 encode_varint_length_prefixed_tlv!(w, {
1324 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1325 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1326 (8, payment_data, option),
1327 (5482373484, keysend_preimage, option)
1335 impl Readable for OnionHopData {
1336 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1337 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1338 let v: VarInt = Decodable::consensus_decode(&mut r)
1339 .map_err(|e| match e {
1340 Error::Io(ioe) => DecodeError::from(ioe),
1341 _ => DecodeError::InvalidValue
1343 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1344 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1345 let mut rd = FixedLengthReader::new(r, v.0);
1346 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1347 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1348 let mut short_id: Option<u64> = None;
1349 let mut payment_data: Option<FinalOnionHopData> = None;
1350 let mut keysend_preimage: Option<PaymentPreimage> = None;
1351 // The TLV type is chosen to be compatible with lnd and c-lightning.
1352 decode_tlv_stream!(&mut rd, {
1354 (4, cltv_value, required),
1355 (6, short_id, option),
1356 (8, payment_data, option),
1357 (5482373484, keysend_preimage, option)
1359 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1360 let format = if let Some(short_channel_id) = short_id {
1361 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1362 OnionHopDataFormat::NonFinalNode {
1366 if let &Some(ref data) = &payment_data {
1367 if data.total_msat > MAX_VALUE_MSAT {
1368 return Err(DecodeError::InvalidValue);
1371 OnionHopDataFormat::FinalNode {
1376 (format, amt.0, cltv_value.0)
1378 let format = OnionHopDataFormat::Legacy {
1379 short_channel_id: Readable::read(r)?,
1381 let amt: u64 = Readable::read(r)?;
1382 let cltv_value: u32 = Readable::read(r)?;
1383 r.read_exact(&mut [0; 12])?;
1384 (format, amt, cltv_value)
1387 if amt > MAX_VALUE_MSAT {
1388 return Err(DecodeError::InvalidValue);
1392 amt_to_forward: amt,
1393 outgoing_cltv_value: cltv_value,
1398 impl Writeable for Ping {
1399 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1400 self.ponglen.write(w)?;
1401 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1406 impl Readable for Ping {
1407 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1409 ponglen: Readable::read(r)?,
1411 let byteslen = Readable::read(r)?;
1412 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1419 impl Writeable for Pong {
1420 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1421 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1426 impl Readable for Pong {
1427 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1430 let byteslen = Readable::read(r)?;
1431 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1438 impl Writeable for UnsignedChannelAnnouncement {
1439 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1440 self.features.write(w)?;
1441 self.chain_hash.write(w)?;
1442 self.short_channel_id.write(w)?;
1443 self.node_id_1.write(w)?;
1444 self.node_id_2.write(w)?;
1445 self.bitcoin_key_1.write(w)?;
1446 self.bitcoin_key_2.write(w)?;
1447 w.write_all(&self.excess_data[..])?;
1452 impl Readable for UnsignedChannelAnnouncement {
1453 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1455 features: Readable::read(r)?,
1456 chain_hash: Readable::read(r)?,
1457 short_channel_id: Readable::read(r)?,
1458 node_id_1: Readable::read(r)?,
1459 node_id_2: Readable::read(r)?,
1460 bitcoin_key_1: Readable::read(r)?,
1461 bitcoin_key_2: Readable::read(r)?,
1462 excess_data: read_to_end(r)?,
1467 impl_writeable!(ChannelAnnouncement, {
1470 bitcoin_signature_1,
1471 bitcoin_signature_2,
1475 impl Writeable for UnsignedChannelUpdate {
1476 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1477 let mut message_flags: u8 = 0;
1478 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1481 self.chain_hash.write(w)?;
1482 self.short_channel_id.write(w)?;
1483 self.timestamp.write(w)?;
1484 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1485 all_flags.write(w)?;
1486 self.cltv_expiry_delta.write(w)?;
1487 self.htlc_minimum_msat.write(w)?;
1488 self.fee_base_msat.write(w)?;
1489 self.fee_proportional_millionths.write(w)?;
1490 self.htlc_maximum_msat.write(w)?;
1491 w.write_all(&self.excess_data[..])?;
1496 impl Readable for UnsignedChannelUpdate {
1497 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1498 let has_htlc_maximum_msat;
1500 chain_hash: Readable::read(r)?,
1501 short_channel_id: Readable::read(r)?,
1502 timestamp: Readable::read(r)?,
1504 let flags: u16 = Readable::read(r)?;
1505 let message_flags = flags >> 8;
1506 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1509 cltv_expiry_delta: Readable::read(r)?,
1510 htlc_minimum_msat: Readable::read(r)?,
1511 fee_base_msat: Readable::read(r)?,
1512 fee_proportional_millionths: Readable::read(r)?,
1513 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1514 excess_data: read_to_end(r)?,
1519 impl_writeable!(ChannelUpdate, {
1524 impl Writeable for ErrorMessage {
1525 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1526 self.channel_id.write(w)?;
1527 (self.data.len() as u16).write(w)?;
1528 w.write_all(self.data.as_bytes())?;
1533 impl Readable for ErrorMessage {
1534 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1536 channel_id: Readable::read(r)?,
1538 let sz: usize = <u16 as Readable>::read(r)? as usize;
1539 let mut data = Vec::with_capacity(sz);
1541 r.read_exact(&mut data)?;
1542 match String::from_utf8(data) {
1544 Err(_) => return Err(DecodeError::InvalidValue),
1551 impl Writeable for WarningMessage {
1552 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1553 self.channel_id.write(w)?;
1554 (self.data.len() as u16).write(w)?;
1555 w.write_all(self.data.as_bytes())?;
1560 impl Readable for WarningMessage {
1561 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1563 channel_id: Readable::read(r)?,
1565 let sz: usize = <u16 as Readable>::read(r)? as usize;
1566 let mut data = Vec::with_capacity(sz);
1568 r.read_exact(&mut data)?;
1569 match String::from_utf8(data) {
1571 Err(_) => return Err(DecodeError::InvalidValue),
1578 impl Writeable for UnsignedNodeAnnouncement {
1579 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1580 self.features.write(w)?;
1581 self.timestamp.write(w)?;
1582 self.node_id.write(w)?;
1583 w.write_all(&self.rgb)?;
1584 self.alias.write(w)?;
1586 let mut addr_len = 0;
1587 for addr in self.addresses.iter() {
1588 addr_len += 1 + addr.len();
1590 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1591 for addr in self.addresses.iter() {
1594 w.write_all(&self.excess_address_data[..])?;
1595 w.write_all(&self.excess_data[..])?;
1600 impl Readable for UnsignedNodeAnnouncement {
1601 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1602 let features: NodeFeatures = Readable::read(r)?;
1603 let timestamp: u32 = Readable::read(r)?;
1604 let node_id: PublicKey = Readable::read(r)?;
1605 let mut rgb = [0; 3];
1606 r.read_exact(&mut rgb)?;
1607 let alias: [u8; 32] = Readable::read(r)?;
1609 let addr_len: u16 = Readable::read(r)?;
1610 let mut addresses: Vec<NetAddress> = Vec::new();
1611 let mut addr_readpos = 0;
1612 let mut excess = false;
1613 let mut excess_byte = 0;
1615 if addr_len <= addr_readpos { break; }
1616 match Readable::read(r) {
1618 if addr_len < addr_readpos + 1 + addr.len() {
1619 return Err(DecodeError::BadLengthDescriptor);
1621 addr_readpos += (1 + addr.len()) as u16;
1622 addresses.push(addr);
1624 Ok(Err(unknown_descriptor)) => {
1626 excess_byte = unknown_descriptor;
1629 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1630 Err(e) => return Err(e),
1634 let mut excess_data = vec![];
1635 let excess_address_data = if addr_readpos < addr_len {
1636 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1637 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1639 excess_address_data[0] = excess_byte;
1644 excess_data.push(excess_byte);
1648 excess_data.extend(read_to_end(r)?.iter());
1649 Ok(UnsignedNodeAnnouncement {
1656 excess_address_data,
1662 impl_writeable!(NodeAnnouncement, {
1667 impl Readable for QueryShortChannelIds {
1668 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1669 let chain_hash: BlockHash = Readable::read(r)?;
1671 let encoding_len: u16 = Readable::read(r)?;
1672 let encoding_type: u8 = Readable::read(r)?;
1674 // Must be encoding_type=0 uncompressed serialization. We do not
1675 // support encoding_type=1 zlib serialization.
1676 if encoding_type != EncodingType::Uncompressed as u8 {
1677 return Err(DecodeError::UnsupportedCompression);
1680 // We expect the encoding_len to always includes the 1-byte
1681 // encoding_type and that short_channel_ids are 8-bytes each
1682 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1683 return Err(DecodeError::InvalidValue);
1686 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1687 // less the 1-byte encoding_type
1688 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1689 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1690 for _ in 0..short_channel_id_count {
1691 short_channel_ids.push(Readable::read(r)?);
1694 Ok(QueryShortChannelIds {
1701 impl Writeable for QueryShortChannelIds {
1702 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1703 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1704 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1706 self.chain_hash.write(w)?;
1707 encoding_len.write(w)?;
1709 // We only support type=0 uncompressed serialization
1710 (EncodingType::Uncompressed as u8).write(w)?;
1712 for scid in self.short_channel_ids.iter() {
1720 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1725 impl QueryChannelRange {
1727 * Calculates the overflow safe ending block height for the query.
1728 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1730 pub fn end_blocknum(&self) -> u32 {
1731 match self.first_blocknum.checked_add(self.number_of_blocks) {
1732 Some(block) => block,
1733 None => u32::max_value(),
1738 impl_writeable_msg!(QueryChannelRange, {
1744 impl Readable for ReplyChannelRange {
1745 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1746 let chain_hash: BlockHash = Readable::read(r)?;
1747 let first_blocknum: u32 = Readable::read(r)?;
1748 let number_of_blocks: u32 = Readable::read(r)?;
1749 let sync_complete: bool = Readable::read(r)?;
1751 let encoding_len: u16 = Readable::read(r)?;
1752 let encoding_type: u8 = Readable::read(r)?;
1754 // Must be encoding_type=0 uncompressed serialization. We do not
1755 // support encoding_type=1 zlib serialization.
1756 if encoding_type != EncodingType::Uncompressed as u8 {
1757 return Err(DecodeError::UnsupportedCompression);
1760 // We expect the encoding_len to always includes the 1-byte
1761 // encoding_type and that short_channel_ids are 8-bytes each
1762 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1763 return Err(DecodeError::InvalidValue);
1766 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1767 // less the 1-byte encoding_type
1768 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1769 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1770 for _ in 0..short_channel_id_count {
1771 short_channel_ids.push(Readable::read(r)?);
1774 Ok(ReplyChannelRange {
1784 impl Writeable for ReplyChannelRange {
1785 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1786 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1787 self.chain_hash.write(w)?;
1788 self.first_blocknum.write(w)?;
1789 self.number_of_blocks.write(w)?;
1790 self.sync_complete.write(w)?;
1792 encoding_len.write(w)?;
1793 (EncodingType::Uncompressed as u8).write(w)?;
1794 for scid in self.short_channel_ids.iter() {
1802 impl_writeable_msg!(GossipTimestampFilter, {
1811 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1812 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1814 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1815 use util::ser::{Writeable, Readable};
1817 use bitcoin::hashes::hex::FromHex;
1818 use bitcoin::util::address::Address;
1819 use bitcoin::network::constants::Network;
1820 use bitcoin::blockdata::script::Builder;
1821 use bitcoin::blockdata::opcodes;
1822 use bitcoin::hash_types::{Txid, BlockHash};
1824 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1825 use bitcoin::secp256k1::{Secp256k1, Message};
1831 fn encoding_channel_reestablish_no_secret() {
1832 let cr = msgs::ChannelReestablish {
1833 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],
1834 next_local_commitment_number: 3,
1835 next_remote_commitment_number: 4,
1836 data_loss_protect: OptionalField::Absent,
1839 let encoded_value = cr.encode();
1842 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]
1847 fn encoding_channel_reestablish_with_secret() {
1849 let secp_ctx = Secp256k1::new();
1850 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1853 let cr = msgs::ChannelReestablish {
1854 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],
1855 next_local_commitment_number: 3,
1856 next_remote_commitment_number: 4,
1857 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1860 let encoded_value = cr.encode();
1863 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]
1867 macro_rules! get_keys_from {
1868 ($slice: expr, $secp_ctx: expr) => {
1870 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1871 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1877 macro_rules! get_sig_on {
1878 ($privkey: expr, $ctx: expr, $string: expr) => {
1880 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1881 $ctx.sign(&sighash, &$privkey)
1887 fn encoding_announcement_signatures() {
1888 let secp_ctx = Secp256k1::new();
1889 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1890 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1891 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1892 let announcement_signatures = msgs::AnnouncementSignatures {
1893 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],
1894 short_channel_id: 2316138423780173,
1895 node_signature: sig_1,
1896 bitcoin_signature: sig_2,
1899 let encoded_value = announcement_signatures.encode();
1900 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1903 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1904 let secp_ctx = Secp256k1::new();
1905 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1906 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1907 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1908 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1909 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1910 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1911 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1912 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1913 let mut features = ChannelFeatures::known();
1914 if unknown_features_bits {
1915 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1917 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1919 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1920 short_channel_id: 2316138423780173,
1921 node_id_1: pubkey_1,
1922 node_id_2: pubkey_2,
1923 bitcoin_key_1: pubkey_3,
1924 bitcoin_key_2: pubkey_4,
1925 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1927 let channel_announcement = msgs::ChannelAnnouncement {
1928 node_signature_1: sig_1,
1929 node_signature_2: sig_2,
1930 bitcoin_signature_1: sig_3,
1931 bitcoin_signature_2: sig_4,
1932 contents: unsigned_channel_announcement,
1934 let encoded_value = channel_announcement.encode();
1935 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1936 if unknown_features_bits {
1937 target_value.append(&mut hex::decode("0002ffff").unwrap());
1939 target_value.append(&mut hex::decode("0000").unwrap());
1941 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1942 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1944 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1946 assert_eq!(encoded_value, target_value);
1950 fn encoding_channel_announcement() {
1951 do_encoding_channel_announcement(true, false);
1952 do_encoding_channel_announcement(false, true);
1953 do_encoding_channel_announcement(false, false);
1954 do_encoding_channel_announcement(true, true);
1957 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1958 let secp_ctx = Secp256k1::new();
1959 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1960 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1961 let features = if unknown_features_bits {
1962 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1964 // Set to some features we may support
1965 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1967 let mut addresses = Vec::new();
1969 addresses.push(msgs::NetAddress::IPv4 {
1970 addr: [255, 254, 253, 252],
1975 addresses.push(msgs::NetAddress::IPv6 {
1976 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1981 addresses.push(msgs::NetAddress::OnionV2(
1982 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
1986 addresses.push(msgs::NetAddress::OnionV3 {
1987 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],
1993 let mut addr_len = 0;
1994 for addr in &addresses {
1995 addr_len += addr.len() + 1;
1997 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1999 timestamp: 20190119,
2004 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() },
2005 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() },
2007 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2008 let node_announcement = msgs::NodeAnnouncement {
2010 contents: unsigned_node_announcement,
2012 let encoded_value = node_announcement.encode();
2013 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2014 if unknown_features_bits {
2015 target_value.append(&mut hex::decode("0002ffff").unwrap());
2017 target_value.append(&mut hex::decode("000122").unwrap());
2019 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2020 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2022 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2025 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2028 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2031 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2033 if excess_address_data {
2034 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2037 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2039 assert_eq!(encoded_value, target_value);
2043 fn encoding_node_announcement() {
2044 do_encoding_node_announcement(true, true, true, true, true, true, true);
2045 do_encoding_node_announcement(false, false, false, false, false, false, false);
2046 do_encoding_node_announcement(false, true, false, false, false, false, false);
2047 do_encoding_node_announcement(false, false, true, false, false, false, false);
2048 do_encoding_node_announcement(false, false, false, true, false, false, false);
2049 do_encoding_node_announcement(false, false, false, false, true, false, false);
2050 do_encoding_node_announcement(false, false, false, false, false, true, false);
2051 do_encoding_node_announcement(false, true, false, true, false, true, false);
2052 do_encoding_node_announcement(false, false, true, false, true, false, false);
2055 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2056 let secp_ctx = Secp256k1::new();
2057 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2058 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2059 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2060 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2061 short_channel_id: 2316138423780173,
2062 timestamp: 20190119,
2063 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2064 cltv_expiry_delta: 144,
2065 htlc_minimum_msat: 1000000,
2066 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2067 fee_base_msat: 10000,
2068 fee_proportional_millionths: 20,
2069 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2071 let channel_update = msgs::ChannelUpdate {
2073 contents: unsigned_channel_update
2075 let encoded_value = channel_update.encode();
2076 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2077 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2078 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2079 if htlc_maximum_msat {
2080 target_value.append(&mut hex::decode("01").unwrap());
2082 target_value.append(&mut hex::decode("00").unwrap());
2084 target_value.append(&mut hex::decode("00").unwrap());
2086 let flag = target_value.last_mut().unwrap();
2090 let flag = target_value.last_mut().unwrap();
2091 *flag = *flag | 1 << 1;
2093 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2094 if htlc_maximum_msat {
2095 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2098 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2100 assert_eq!(encoded_value, target_value);
2104 fn encoding_channel_update() {
2105 do_encoding_channel_update(false, false, false, false);
2106 do_encoding_channel_update(false, false, false, true);
2107 do_encoding_channel_update(true, false, false, false);
2108 do_encoding_channel_update(true, false, false, true);
2109 do_encoding_channel_update(false, true, false, false);
2110 do_encoding_channel_update(false, true, false, true);
2111 do_encoding_channel_update(false, false, true, false);
2112 do_encoding_channel_update(false, false, true, true);
2113 do_encoding_channel_update(true, true, true, false);
2114 do_encoding_channel_update(true, true, true, true);
2117 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2118 let secp_ctx = Secp256k1::new();
2119 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2120 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2121 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2122 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2123 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2124 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2125 let open_channel = msgs::OpenChannel {
2126 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2127 temporary_channel_id: [2; 32],
2128 funding_satoshis: 1311768467284833366,
2129 push_msat: 2536655962884945560,
2130 dust_limit_satoshis: 3608586615801332854,
2131 max_htlc_value_in_flight_msat: 8517154655701053848,
2132 channel_reserve_satoshis: 8665828695742877976,
2133 htlc_minimum_msat: 2316138423780173,
2134 feerate_per_kw: 821716,
2135 to_self_delay: 49340,
2136 max_accepted_htlcs: 49340,
2137 funding_pubkey: pubkey_1,
2138 revocation_basepoint: pubkey_2,
2139 payment_point: pubkey_3,
2140 delayed_payment_basepoint: pubkey_4,
2141 htlc_basepoint: pubkey_5,
2142 first_per_commitment_point: pubkey_6,
2143 channel_flags: if random_bit { 1 << 5 } else { 0 },
2144 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2145 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2147 let encoded_value = open_channel.encode();
2148 let mut target_value = Vec::new();
2149 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2150 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2152 target_value.append(&mut hex::decode("20").unwrap());
2154 target_value.append(&mut hex::decode("00").unwrap());
2157 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2160 target_value.append(&mut hex::decode("0100").unwrap());
2162 assert_eq!(encoded_value, target_value);
2166 fn encoding_open_channel() {
2167 do_encoding_open_channel(false, false, false);
2168 do_encoding_open_channel(false, false, true);
2169 do_encoding_open_channel(false, true, false);
2170 do_encoding_open_channel(false, true, true);
2171 do_encoding_open_channel(true, false, false);
2172 do_encoding_open_channel(true, false, true);
2173 do_encoding_open_channel(true, true, false);
2174 do_encoding_open_channel(true, true, true);
2177 fn do_encoding_accept_channel(shutdown: bool) {
2178 let secp_ctx = Secp256k1::new();
2179 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2180 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2181 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2182 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2183 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2184 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2185 let accept_channel = msgs::AcceptChannel {
2186 temporary_channel_id: [2; 32],
2187 dust_limit_satoshis: 1311768467284833366,
2188 max_htlc_value_in_flight_msat: 2536655962884945560,
2189 channel_reserve_satoshis: 3608586615801332854,
2190 htlc_minimum_msat: 2316138423780173,
2191 minimum_depth: 821716,
2192 to_self_delay: 49340,
2193 max_accepted_htlcs: 49340,
2194 funding_pubkey: pubkey_1,
2195 revocation_basepoint: pubkey_2,
2196 payment_point: pubkey_3,
2197 delayed_payment_basepoint: pubkey_4,
2198 htlc_basepoint: pubkey_5,
2199 first_per_commitment_point: pubkey_6,
2200 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2203 let encoded_value = accept_channel.encode();
2204 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2206 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2208 assert_eq!(encoded_value, target_value);
2212 fn encoding_accept_channel() {
2213 do_encoding_accept_channel(false);
2214 do_encoding_accept_channel(true);
2218 fn encoding_funding_created() {
2219 let secp_ctx = Secp256k1::new();
2220 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2221 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2222 let funding_created = msgs::FundingCreated {
2223 temporary_channel_id: [2; 32],
2224 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2225 funding_output_index: 255,
2228 let encoded_value = funding_created.encode();
2229 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2230 assert_eq!(encoded_value, target_value);
2234 fn encoding_funding_signed() {
2235 let secp_ctx = Secp256k1::new();
2236 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2237 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2238 let funding_signed = msgs::FundingSigned {
2239 channel_id: [2; 32],
2242 let encoded_value = funding_signed.encode();
2243 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2244 assert_eq!(encoded_value, target_value);
2248 fn encoding_funding_locked() {
2249 let secp_ctx = Secp256k1::new();
2250 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2251 let funding_locked = msgs::FundingLocked {
2252 channel_id: [2; 32],
2253 next_per_commitment_point: pubkey_1,
2254 short_channel_id_alias: None,
2256 let encoded_value = funding_locked.encode();
2257 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2258 assert_eq!(encoded_value, target_value);
2261 fn do_encoding_shutdown(script_type: u8) {
2262 let secp_ctx = Secp256k1::new();
2263 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2264 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2265 let shutdown = msgs::Shutdown {
2266 channel_id: [2; 32],
2268 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2269 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2270 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2271 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2273 let encoded_value = shutdown.encode();
2274 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2275 if script_type == 1 {
2276 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2277 } else if script_type == 2 {
2278 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2279 } else if script_type == 3 {
2280 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2281 } else if script_type == 4 {
2282 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2284 assert_eq!(encoded_value, target_value);
2288 fn encoding_shutdown() {
2289 do_encoding_shutdown(1);
2290 do_encoding_shutdown(2);
2291 do_encoding_shutdown(3);
2292 do_encoding_shutdown(4);
2296 fn encoding_closing_signed() {
2297 let secp_ctx = Secp256k1::new();
2298 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2299 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2300 let closing_signed = msgs::ClosingSigned {
2301 channel_id: [2; 32],
2302 fee_satoshis: 2316138423780173,
2306 let encoded_value = closing_signed.encode();
2307 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2308 assert_eq!(encoded_value, target_value);
2309 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2311 let closing_signed_with_range = msgs::ClosingSigned {
2312 channel_id: [2; 32],
2313 fee_satoshis: 2316138423780173,
2315 fee_range: Some(msgs::ClosingSignedFeeRange {
2316 min_fee_satoshis: 0xdeadbeef,
2317 max_fee_satoshis: 0x1badcafe01234567,
2320 let encoded_value_with_range = closing_signed_with_range.encode();
2321 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2322 assert_eq!(encoded_value_with_range, target_value_with_range);
2323 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2324 closing_signed_with_range);
2328 fn encoding_update_add_htlc() {
2329 let secp_ctx = Secp256k1::new();
2330 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2331 let onion_routing_packet = msgs::OnionPacket {
2333 public_key: Ok(pubkey_1),
2334 hop_data: [1; 20*65],
2337 let update_add_htlc = msgs::UpdateAddHTLC {
2338 channel_id: [2; 32],
2339 htlc_id: 2316138423780173,
2340 amount_msat: 3608586615801332854,
2341 payment_hash: PaymentHash([1; 32]),
2342 cltv_expiry: 821716,
2343 onion_routing_packet
2345 let encoded_value = update_add_htlc.encode();
2346 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2347 assert_eq!(encoded_value, target_value);
2351 fn encoding_update_fulfill_htlc() {
2352 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2353 channel_id: [2; 32],
2354 htlc_id: 2316138423780173,
2355 payment_preimage: PaymentPreimage([1; 32]),
2357 let encoded_value = update_fulfill_htlc.encode();
2358 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2359 assert_eq!(encoded_value, target_value);
2363 fn encoding_update_fail_htlc() {
2364 let reason = OnionErrorPacket {
2365 data: [1; 32].to_vec(),
2367 let update_fail_htlc = msgs::UpdateFailHTLC {
2368 channel_id: [2; 32],
2369 htlc_id: 2316138423780173,
2372 let encoded_value = update_fail_htlc.encode();
2373 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2374 assert_eq!(encoded_value, target_value);
2378 fn encoding_update_fail_malformed_htlc() {
2379 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2380 channel_id: [2; 32],
2381 htlc_id: 2316138423780173,
2382 sha256_of_onion: [1; 32],
2385 let encoded_value = update_fail_malformed_htlc.encode();
2386 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2387 assert_eq!(encoded_value, target_value);
2390 fn do_encoding_commitment_signed(htlcs: bool) {
2391 let secp_ctx = Secp256k1::new();
2392 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2393 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2394 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2395 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2396 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2397 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2398 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2399 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2400 let commitment_signed = msgs::CommitmentSigned {
2401 channel_id: [2; 32],
2403 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2405 let encoded_value = commitment_signed.encode();
2406 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2408 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2410 target_value.append(&mut hex::decode("0000").unwrap());
2412 assert_eq!(encoded_value, target_value);
2416 fn encoding_commitment_signed() {
2417 do_encoding_commitment_signed(true);
2418 do_encoding_commitment_signed(false);
2422 fn encoding_revoke_and_ack() {
2423 let secp_ctx = Secp256k1::new();
2424 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2425 let raa = msgs::RevokeAndACK {
2426 channel_id: [2; 32],
2427 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],
2428 next_per_commitment_point: pubkey_1,
2430 let encoded_value = raa.encode();
2431 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2432 assert_eq!(encoded_value, target_value);
2436 fn encoding_update_fee() {
2437 let update_fee = msgs::UpdateFee {
2438 channel_id: [2; 32],
2439 feerate_per_kw: 20190119,
2441 let encoded_value = update_fee.encode();
2442 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2443 assert_eq!(encoded_value, target_value);
2447 fn encoding_init() {
2448 assert_eq!(msgs::Init {
2449 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2450 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2451 assert_eq!(msgs::Init {
2452 features: InitFeatures::from_le_bytes(vec![0xFF]),
2453 }.encode(), hex::decode("0001ff0001ff").unwrap());
2454 assert_eq!(msgs::Init {
2455 features: InitFeatures::from_le_bytes(vec![]),
2456 }.encode(), hex::decode("00000000").unwrap());
2460 fn encoding_error() {
2461 let error = msgs::ErrorMessage {
2462 channel_id: [2; 32],
2463 data: String::from("rust-lightning"),
2465 let encoded_value = error.encode();
2466 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2467 assert_eq!(encoded_value, target_value);
2471 fn encoding_warning() {
2472 let error = msgs::WarningMessage {
2473 channel_id: [2; 32],
2474 data: String::from("rust-lightning"),
2476 let encoded_value = error.encode();
2477 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2478 assert_eq!(encoded_value, target_value);
2482 fn encoding_ping() {
2483 let ping = msgs::Ping {
2487 let encoded_value = ping.encode();
2488 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2489 assert_eq!(encoded_value, target_value);
2493 fn encoding_pong() {
2494 let pong = msgs::Pong {
2497 let encoded_value = pong.encode();
2498 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2499 assert_eq!(encoded_value, target_value);
2503 fn encoding_legacy_onion_hop_data() {
2504 let msg = msgs::OnionHopData {
2505 format: OnionHopDataFormat::Legacy {
2506 short_channel_id: 0xdeadbeef1bad1dea,
2508 amt_to_forward: 0x0badf00d01020304,
2509 outgoing_cltv_value: 0xffffffff,
2511 let encoded_value = msg.encode();
2512 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2513 assert_eq!(encoded_value, target_value);
2517 fn encoding_nonfinal_onion_hop_data() {
2518 let mut msg = msgs::OnionHopData {
2519 format: OnionHopDataFormat::NonFinalNode {
2520 short_channel_id: 0xdeadbeef1bad1dea,
2522 amt_to_forward: 0x0badf00d01020304,
2523 outgoing_cltv_value: 0xffffffff,
2525 let encoded_value = msg.encode();
2526 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2527 assert_eq!(encoded_value, target_value);
2528 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2529 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2530 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2531 } else { panic!(); }
2532 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2533 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2537 fn encoding_final_onion_hop_data() {
2538 let mut msg = msgs::OnionHopData {
2539 format: OnionHopDataFormat::FinalNode {
2541 keysend_preimage: None,
2543 amt_to_forward: 0x0badf00d01020304,
2544 outgoing_cltv_value: 0xffffffff,
2546 let encoded_value = msg.encode();
2547 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2548 assert_eq!(encoded_value, target_value);
2549 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2550 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2551 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2552 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2556 fn encoding_final_onion_hop_data_with_secret() {
2557 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2558 let mut msg = msgs::OnionHopData {
2559 format: OnionHopDataFormat::FinalNode {
2560 payment_data: Some(FinalOnionHopData {
2561 payment_secret: expected_payment_secret,
2562 total_msat: 0x1badca1f
2564 keysend_preimage: None,
2566 amt_to_forward: 0x0badf00d01020304,
2567 outgoing_cltv_value: 0xffffffff,
2569 let encoded_value = msg.encode();
2570 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2571 assert_eq!(encoded_value, target_value);
2572 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2573 if let OnionHopDataFormat::FinalNode {
2574 payment_data: Some(FinalOnionHopData {
2576 total_msat: 0x1badca1f
2578 keysend_preimage: None,
2580 assert_eq!(payment_secret, expected_payment_secret);
2581 } else { panic!(); }
2582 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2583 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2587 fn query_channel_range_end_blocknum() {
2588 let tests: Vec<(u32, u32, u32)> = vec![
2589 (10000, 1500, 11500),
2590 (0, 0xffffffff, 0xffffffff),
2591 (1, 0xffffffff, 0xffffffff),
2594 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2595 let sut = msgs::QueryChannelRange {
2596 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2600 assert_eq!(sut.end_blocknum(), expected);
2605 fn encoding_query_channel_range() {
2606 let mut query_channel_range = msgs::QueryChannelRange {
2607 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2608 first_blocknum: 100000,
2609 number_of_blocks: 1500,
2611 let encoded_value = query_channel_range.encode();
2612 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2613 assert_eq!(encoded_value, target_value);
2615 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2616 assert_eq!(query_channel_range.first_blocknum, 100000);
2617 assert_eq!(query_channel_range.number_of_blocks, 1500);
2621 fn encoding_reply_channel_range() {
2622 do_encoding_reply_channel_range(0);
2623 do_encoding_reply_channel_range(1);
2626 fn do_encoding_reply_channel_range(encoding_type: u8) {
2627 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2628 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2629 let mut reply_channel_range = msgs::ReplyChannelRange {
2630 chain_hash: expected_chain_hash,
2631 first_blocknum: 756230,
2632 number_of_blocks: 1500,
2633 sync_complete: true,
2634 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2637 if encoding_type == 0 {
2638 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2639 let encoded_value = reply_channel_range.encode();
2640 assert_eq!(encoded_value, target_value);
2642 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2643 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2644 assert_eq!(reply_channel_range.first_blocknum, 756230);
2645 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2646 assert_eq!(reply_channel_range.sync_complete, true);
2647 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2648 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2649 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2651 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2652 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2653 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2658 fn encoding_query_short_channel_ids() {
2659 do_encoding_query_short_channel_ids(0);
2660 do_encoding_query_short_channel_ids(1);
2663 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2664 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2665 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2666 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2667 chain_hash: expected_chain_hash,
2668 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2671 if encoding_type == 0 {
2672 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2673 let encoded_value = query_short_channel_ids.encode();
2674 assert_eq!(encoded_value, target_value);
2676 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2677 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2678 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2679 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2680 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2682 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2683 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2684 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2689 fn encoding_reply_short_channel_ids_end() {
2690 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2691 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2692 chain_hash: expected_chain_hash,
2693 full_information: true,
2695 let encoded_value = reply_short_channel_ids_end.encode();
2696 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2697 assert_eq!(encoded_value, target_value);
2699 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2700 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2701 assert_eq!(reply_short_channel_ids_end.full_information, true);
2705 fn encoding_gossip_timestamp_filter(){
2706 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2707 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2708 chain_hash: expected_chain_hash,
2709 first_timestamp: 1590000000,
2710 timestamp_range: 0xffff_ffff,
2712 let encoded_value = gossip_timestamp_filter.encode();
2713 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2714 assert_eq!(encoded_value, target_value);
2716 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2717 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2718 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2719 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);