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>,
209 /// A funding_created message to be sent or received from a peer
210 #[derive(Clone, Debug, PartialEq)]
211 pub struct FundingCreated {
212 /// A temporary channel ID, until the funding is established
213 pub temporary_channel_id: [u8; 32],
214 /// The funding transaction ID
215 pub funding_txid: Txid,
216 /// The specific output index funding this channel
217 pub funding_output_index: u16,
218 /// The signature of the channel initiator (funder) on the initial commitment transaction
219 pub signature: Signature,
222 /// A funding_signed message to be sent or received from a peer
223 #[derive(Clone, Debug, PartialEq)]
224 pub struct FundingSigned {
226 pub channel_id: [u8; 32],
227 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
228 pub signature: Signature,
231 /// A funding_locked message to be sent or received from a peer
232 #[derive(Clone, Debug, PartialEq)]
233 pub struct FundingLocked {
235 pub channel_id: [u8; 32],
236 /// The per-commitment point of the second commitment transaction
237 pub next_per_commitment_point: PublicKey,
240 /// A shutdown message to be sent or received from a peer
241 #[derive(Clone, Debug, PartialEq)]
242 pub struct Shutdown {
244 pub channel_id: [u8; 32],
245 /// The destination of this peer's funds on closing.
246 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
247 pub scriptpubkey: Script,
250 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
251 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
253 #[derive(Clone, Debug, PartialEq)]
254 pub struct ClosingSignedFeeRange {
255 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
257 pub min_fee_satoshis: u64,
258 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
260 pub max_fee_satoshis: u64,
263 /// A closing_signed message to be sent or received from a peer
264 #[derive(Clone, Debug, PartialEq)]
265 pub struct ClosingSigned {
267 pub channel_id: [u8; 32],
268 /// The proposed total fee for the closing transaction
269 pub fee_satoshis: u64,
270 /// A signature on the closing transaction
271 pub signature: Signature,
272 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
274 pub fee_range: Option<ClosingSignedFeeRange>,
277 /// An update_add_htlc message to be sent or received from a peer
278 #[derive(Clone, Debug, PartialEq)]
279 pub struct UpdateAddHTLC {
281 pub channel_id: [u8; 32],
284 /// The HTLC value in milli-satoshi
285 pub amount_msat: u64,
286 /// The payment hash, the pre-image of which controls HTLC redemption
287 pub payment_hash: PaymentHash,
288 /// The expiry height of the HTLC
289 pub cltv_expiry: u32,
290 pub(crate) onion_routing_packet: OnionPacket,
293 /// An update_fulfill_htlc message to be sent or received from a peer
294 #[derive(Clone, Debug, PartialEq)]
295 pub struct UpdateFulfillHTLC {
297 pub channel_id: [u8; 32],
300 /// The pre-image of the payment hash, allowing HTLC redemption
301 pub payment_preimage: PaymentPreimage,
304 /// An update_fail_htlc message to be sent or received from a peer
305 #[derive(Clone, Debug, PartialEq)]
306 pub struct UpdateFailHTLC {
308 pub channel_id: [u8; 32],
311 pub(crate) reason: OnionErrorPacket,
314 /// An update_fail_malformed_htlc message to be sent or received from a peer
315 #[derive(Clone, Debug, PartialEq)]
316 pub struct UpdateFailMalformedHTLC {
318 pub channel_id: [u8; 32],
321 pub(crate) sha256_of_onion: [u8; 32],
323 pub failure_code: u16,
326 /// A commitment_signed message to be sent or received from a peer
327 #[derive(Clone, Debug, PartialEq)]
328 pub struct CommitmentSigned {
330 pub channel_id: [u8; 32],
331 /// A signature on the commitment transaction
332 pub signature: Signature,
333 /// Signatures on the HTLC transactions
334 pub htlc_signatures: Vec<Signature>,
337 /// A revoke_and_ack message to be sent or received from a peer
338 #[derive(Clone, Debug, PartialEq)]
339 pub struct RevokeAndACK {
341 pub channel_id: [u8; 32],
342 /// The secret corresponding to the per-commitment point
343 pub per_commitment_secret: [u8; 32],
344 /// The next sender-broadcast commitment transaction's per-commitment point
345 pub next_per_commitment_point: PublicKey,
348 /// An update_fee message to be sent or received from a peer
349 #[derive(Clone, Debug, PartialEq)]
350 pub struct UpdateFee {
352 pub channel_id: [u8; 32],
353 /// Fee rate per 1000-weight of the transaction
354 pub feerate_per_kw: u32,
357 #[derive(Clone, Debug, PartialEq)]
358 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
359 /// This is used to convince the recipient that the channel is at a certain commitment
360 /// number even if they lost that data due to a local failure. Of course, the peer may lie
361 /// and even later commitments may have been revoked.
362 pub struct DataLossProtect {
363 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
364 /// belonging to the recipient
365 pub your_last_per_commitment_secret: [u8; 32],
366 /// The sender's per-commitment point for their current commitment transaction
367 pub my_current_per_commitment_point: PublicKey,
370 /// A channel_reestablish message to be sent or received from a peer
371 #[derive(Clone, Debug, PartialEq)]
372 pub struct ChannelReestablish {
374 pub channel_id: [u8; 32],
375 /// The next commitment number for the sender
376 pub next_local_commitment_number: u64,
377 /// The next commitment number for the recipient
378 pub next_remote_commitment_number: u64,
379 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
380 pub data_loss_protect: OptionalField<DataLossProtect>,
383 /// An announcement_signatures message to be sent or received from a peer
384 #[derive(Clone, Debug, PartialEq)]
385 pub struct AnnouncementSignatures {
387 pub channel_id: [u8; 32],
388 /// The short channel ID
389 pub short_channel_id: u64,
390 /// A signature by the node key
391 pub node_signature: Signature,
392 /// A signature by the funding key
393 pub bitcoin_signature: Signature,
396 /// An address which can be used to connect to a remote peer
397 #[derive(Clone, Debug, PartialEq)]
398 pub enum NetAddress {
399 /// An IPv4 address/port on which the peer is listening.
401 /// The 4-byte IPv4 address
403 /// The port on which the node is listening
406 /// An IPv6 address/port on which the peer is listening.
408 /// The 16-byte IPv6 address
410 /// The port on which the node is listening
413 /// An old-style Tor onion address/port on which the peer is listening.
415 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
416 /// addresses. Thus, the details are not parsed here.
418 /// A new-style Tor onion address/port on which the peer is listening.
419 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
420 /// wrap as base32 and append ".onion".
422 /// The ed25519 long-term public key of the peer
423 ed25519_pubkey: [u8; 32],
424 /// The checksum of the pubkey and version, as included in the onion address
426 /// The version byte, as defined by the Tor Onion v3 spec.
428 /// The port on which the node is listening
433 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
435 pub(crate) fn get_id(&self) -> u8 {
437 &NetAddress::IPv4 {..} => { 1 },
438 &NetAddress::IPv6 {..} => { 2 },
439 &NetAddress::OnionV2(_) => { 3 },
440 &NetAddress::OnionV3 {..} => { 4 },
444 /// Strict byte-length of address descriptor, 1-byte type not recorded
445 fn len(&self) -> u16 {
447 &NetAddress::IPv4 { .. } => { 6 },
448 &NetAddress::IPv6 { .. } => { 18 },
449 &NetAddress::OnionV2(_) => { 12 },
450 &NetAddress::OnionV3 { .. } => { 37 },
454 /// The maximum length of any address descriptor, not including the 1-byte type
455 pub(crate) const MAX_LEN: u16 = 37;
458 impl Writeable for NetAddress {
459 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
461 &NetAddress::IPv4 { ref addr, ref port } => {
466 &NetAddress::IPv6 { ref addr, ref port } => {
471 &NetAddress::OnionV2(bytes) => {
473 bytes.write(writer)?;
475 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
477 ed25519_pubkey.write(writer)?;
478 checksum.write(writer)?;
479 version.write(writer)?;
487 impl Readable for Result<NetAddress, u8> {
488 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
489 let byte = <u8 as Readable>::read(reader)?;
492 Ok(Ok(NetAddress::IPv4 {
493 addr: Readable::read(reader)?,
494 port: Readable::read(reader)?,
498 Ok(Ok(NetAddress::IPv6 {
499 addr: Readable::read(reader)?,
500 port: Readable::read(reader)?,
503 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
505 Ok(Ok(NetAddress::OnionV3 {
506 ed25519_pubkey: Readable::read(reader)?,
507 checksum: Readable::read(reader)?,
508 version: Readable::read(reader)?,
509 port: Readable::read(reader)?,
512 _ => return Ok(Err(byte)),
517 impl Readable for NetAddress {
518 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
519 match Readable::read(reader) {
520 Ok(Ok(res)) => Ok(res),
521 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
528 /// The unsigned part of a node_announcement
529 #[derive(Clone, Debug, PartialEq)]
530 pub struct UnsignedNodeAnnouncement {
531 /// The advertised features
532 pub features: NodeFeatures,
533 /// A strictly monotonic announcement counter, with gaps allowed
535 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
537 pub node_id: PublicKey,
538 /// An RGB color for UI purposes
540 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
543 /// List of addresses on which this node is reachable
544 pub addresses: Vec<NetAddress>,
545 pub(crate) excess_address_data: Vec<u8>,
546 pub(crate) excess_data: Vec<u8>,
548 #[derive(Clone, Debug, PartialEq)]
549 /// A node_announcement message to be sent or received from a peer
550 pub struct NodeAnnouncement {
551 /// The signature by the node key
552 pub signature: Signature,
553 /// The actual content of the announcement
554 pub contents: UnsignedNodeAnnouncement,
557 /// The unsigned part of a channel_announcement
558 #[derive(Clone, Debug, PartialEq)]
559 pub struct UnsignedChannelAnnouncement {
560 /// The advertised channel features
561 pub features: ChannelFeatures,
562 /// The genesis hash of the blockchain where the channel is to be opened
563 pub chain_hash: BlockHash,
564 /// The short channel ID
565 pub short_channel_id: u64,
566 /// One of the two node_ids which are endpoints of this channel
567 pub node_id_1: PublicKey,
568 /// The other of the two node_ids which are endpoints of this channel
569 pub node_id_2: PublicKey,
570 /// The funding key for the first node
571 pub bitcoin_key_1: PublicKey,
572 /// The funding key for the second node
573 pub bitcoin_key_2: PublicKey,
574 pub(crate) excess_data: Vec<u8>,
576 /// A channel_announcement message to be sent or received from a peer
577 #[derive(Clone, Debug, PartialEq)]
578 pub struct ChannelAnnouncement {
579 /// Authentication of the announcement by the first public node
580 pub node_signature_1: Signature,
581 /// Authentication of the announcement by the second public node
582 pub node_signature_2: Signature,
583 /// Proof of funding UTXO ownership by the first public node
584 pub bitcoin_signature_1: Signature,
585 /// Proof of funding UTXO ownership by the second public node
586 pub bitcoin_signature_2: Signature,
587 /// The actual announcement
588 pub contents: UnsignedChannelAnnouncement,
591 /// The unsigned part of a channel_update
592 #[derive(Clone, Debug, PartialEq)]
593 pub struct UnsignedChannelUpdate {
594 /// The genesis hash of the blockchain where the channel is to be opened
595 pub chain_hash: BlockHash,
596 /// The short channel ID
597 pub short_channel_id: u64,
598 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
602 /// The number of blocks such that if:
603 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
604 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
605 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
606 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
607 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
608 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
609 /// constructing the route.
610 pub cltv_expiry_delta: u16,
611 /// The minimum HTLC size incoming to sender, in milli-satoshi
612 pub htlc_minimum_msat: u64,
613 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
614 pub htlc_maximum_msat: OptionalField<u64>,
615 /// The base HTLC fee charged by sender, in milli-satoshi
616 pub fee_base_msat: u32,
617 /// The amount to fee multiplier, in micro-satoshi
618 pub fee_proportional_millionths: u32,
619 pub(crate) excess_data: Vec<u8>,
621 /// A channel_update message to be sent or received from a peer
622 #[derive(Clone, Debug, PartialEq)]
623 pub struct ChannelUpdate {
624 /// A signature of the channel update
625 pub signature: Signature,
626 /// The actual channel update
627 pub contents: UnsignedChannelUpdate,
630 /// A query_channel_range message is used to query a peer for channel
631 /// UTXOs in a range of blocks. The recipient of a query makes a best
632 /// effort to reply to the query using one or more reply_channel_range
634 #[derive(Clone, Debug, PartialEq)]
635 pub struct QueryChannelRange {
636 /// The genesis hash of the blockchain being queried
637 pub chain_hash: BlockHash,
638 /// The height of the first block for the channel UTXOs being queried
639 pub first_blocknum: u32,
640 /// The number of blocks to include in the query results
641 pub number_of_blocks: u32,
644 /// A reply_channel_range message is a reply to a query_channel_range
645 /// message. Multiple reply_channel_range messages can be sent in reply
646 /// to a single query_channel_range message. The query recipient makes a
647 /// best effort to respond based on their local network view which may
648 /// not be a perfect view of the network. The short_channel_ids in the
649 /// reply are encoded. We only support encoding_type=0 uncompressed
650 /// serialization and do not support encoding_type=1 zlib serialization.
651 #[derive(Clone, Debug, PartialEq)]
652 pub struct ReplyChannelRange {
653 /// The genesis hash of the blockchain being queried
654 pub chain_hash: BlockHash,
655 /// The height of the first block in the range of the reply
656 pub first_blocknum: u32,
657 /// The number of blocks included in the range of the reply
658 pub number_of_blocks: u32,
659 /// True when this is the final reply for a query
660 pub sync_complete: bool,
661 /// The short_channel_ids in the channel range
662 pub short_channel_ids: Vec<u64>,
665 /// A query_short_channel_ids message is used to query a peer for
666 /// routing gossip messages related to one or more short_channel_ids.
667 /// The query recipient will reply with the latest, if available,
668 /// channel_announcement, channel_update and node_announcement messages
669 /// it maintains for the requested short_channel_ids followed by a
670 /// reply_short_channel_ids_end message. The short_channel_ids sent in
671 /// this query are encoded. We only support encoding_type=0 uncompressed
672 /// serialization and do not support encoding_type=1 zlib serialization.
673 #[derive(Clone, Debug, PartialEq)]
674 pub struct QueryShortChannelIds {
675 /// The genesis hash of the blockchain being queried
676 pub chain_hash: BlockHash,
677 /// The short_channel_ids that are being queried
678 pub short_channel_ids: Vec<u64>,
681 /// A reply_short_channel_ids_end message is sent as a reply to a
682 /// query_short_channel_ids message. The query recipient makes a best
683 /// effort to respond based on their local network view which may not be
684 /// a perfect view of the network.
685 #[derive(Clone, Debug, PartialEq)]
686 pub struct ReplyShortChannelIdsEnd {
687 /// The genesis hash of the blockchain that was queried
688 pub chain_hash: BlockHash,
689 /// Indicates if the query recipient maintains up-to-date channel
690 /// information for the chain_hash
691 pub full_information: bool,
694 /// A gossip_timestamp_filter message is used by a node to request
695 /// gossip relay for messages in the requested time range when the
696 /// gossip_queries feature has been negotiated.
697 #[derive(Clone, Debug, PartialEq)]
698 pub struct GossipTimestampFilter {
699 /// The genesis hash of the blockchain for channel and node information
700 pub chain_hash: BlockHash,
701 /// The starting unix timestamp
702 pub first_timestamp: u32,
703 /// The range of information in seconds
704 pub timestamp_range: u32,
707 /// Encoding type for data compression of collections in gossip queries.
708 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
713 /// Used to put an error message in a LightningError
714 #[derive(Clone, Debug)]
715 pub enum ErrorAction {
716 /// The peer took some action which made us think they were useless. Disconnect them.
718 /// An error message which we should make an effort to send before we disconnect.
719 msg: Option<ErrorMessage>
721 /// The peer did something harmless that we weren't able to process, just log and ignore
722 // New code should *not* use this. New code must use IgnoreAndLog, below!
724 /// The peer did something harmless that we weren't able to meaningfully process.
725 /// If the error is logged, log it at the given level.
726 IgnoreAndLog(logger::Level),
727 /// The peer provided us with a gossip message which we'd already seen. In most cases this
728 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
729 /// our own channel announcements.
730 IgnoreDuplicateGossip,
731 /// The peer did something incorrect. Tell them.
733 /// The message to send.
736 /// The peer did something incorrect. Tell them without closing any channels.
738 /// The message to send.
740 /// The peer may have done something harmless that we weren't able to meaningfully process,
741 /// though we should still tell them about it.
742 /// If this event is logged, log it at the given level.
743 log_level: logger::Level,
747 /// An Err type for failure to process messages.
748 #[derive(Clone, Debug)]
749 pub struct LightningError {
750 /// A human-readable message describing the error
752 /// The action which should be taken against the offending peer.
753 pub action: ErrorAction,
756 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
757 /// transaction updates if they were pending.
758 #[derive(Clone, Debug, PartialEq)]
759 pub struct CommitmentUpdate {
760 /// update_add_htlc messages which should be sent
761 pub update_add_htlcs: Vec<UpdateAddHTLC>,
762 /// update_fulfill_htlc messages which should be sent
763 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
764 /// update_fail_htlc messages which should be sent
765 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
766 /// update_fail_malformed_htlc messages which should be sent
767 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
768 /// An update_fee message which should be sent
769 pub update_fee: Option<UpdateFee>,
770 /// Finally, the commitment_signed message which should be sent
771 pub commitment_signed: CommitmentSigned,
774 /// Messages could have optional fields to use with extended features
775 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
776 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
777 /// separate enum type for them.
778 /// (C-not exported) due to a free generic in T
779 #[derive(Clone, Debug, PartialEq)]
780 pub enum OptionalField<T> {
781 /// Optional field is included in message
783 /// Optional field is absent in message
787 /// A trait to describe an object which can receive channel messages.
789 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
790 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
791 pub trait ChannelMessageHandler : MessageSendEventsProvider {
793 /// Handle an incoming open_channel message from the given peer.
794 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
795 /// Handle an incoming accept_channel message from the given peer.
796 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
797 /// Handle an incoming funding_created message from the given peer.
798 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
799 /// Handle an incoming funding_signed message from the given peer.
800 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
801 /// Handle an incoming funding_locked message from the given peer.
802 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
805 /// Handle an incoming shutdown message from the given peer.
806 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
807 /// Handle an incoming closing_signed message from the given peer.
808 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
811 /// Handle an incoming update_add_htlc message from the given peer.
812 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
813 /// Handle an incoming update_fulfill_htlc message from the given peer.
814 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
815 /// Handle an incoming update_fail_htlc message from the given peer.
816 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
817 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
818 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
819 /// Handle an incoming commitment_signed message from the given peer.
820 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
821 /// Handle an incoming revoke_and_ack message from the given peer.
822 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
824 /// Handle an incoming update_fee message from the given peer.
825 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
827 // Channel-to-announce:
828 /// Handle an incoming announcement_signatures message from the given peer.
829 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
831 // Connection loss/reestablish:
832 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
833 /// is believed to be possible in the future (eg they're sending us messages we don't
834 /// understand or indicate they require unknown feature bits), no_connection_possible is set
835 /// and any outstanding channels should be failed.
836 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
838 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
839 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
840 /// Handle an incoming channel_reestablish message from the given peer.
841 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
843 /// Handle an incoming channel update from the given peer.
844 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
847 /// Handle an incoming error message from the given peer.
848 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
851 /// A trait to describe an object which can receive routing messages.
853 /// # Implementor DoS Warnings
855 /// For `gossip_queries` messages there are potential DoS vectors when handling
856 /// inbound queries. Implementors using an on-disk network graph should be aware of
857 /// repeated disk I/O for queries accessing different parts of the network graph.
858 pub trait RoutingMessageHandler : MessageSendEventsProvider {
859 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
860 /// false or returning an Err otherwise.
861 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
862 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
863 /// or returning an Err otherwise.
864 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
865 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
866 /// false or returning an Err otherwise.
867 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
868 /// Gets a subset of the channel announcements and updates required to dump our routing table
869 /// to a remote node, starting at the short_channel_id indicated by starting_point and
870 /// including the batch_amount entries immediately higher in numerical value than starting_point.
871 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
872 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
873 /// starting at the node *after* the provided publickey and including batch_amount entries
874 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
875 /// If None is provided for starting_point, we start at the first node.
876 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
877 /// Called when a connection is established with a peer. This can be used to
878 /// perform routing table synchronization using a strategy defined by the
880 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
881 /// Handles the reply of a query we initiated to learn about channels
882 /// for a given range of blocks. We can expect to receive one or more
883 /// replies to a single query.
884 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
885 /// Handles the reply of a query we initiated asking for routing gossip
886 /// messages for a list of channels. We should receive this message when
887 /// a node has completed its best effort to send us the pertaining routing
889 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
890 /// Handles when a peer asks us to send a list of short_channel_ids
891 /// for the requested range of blocks.
892 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
893 /// Handles when a peer asks us to send routing gossip messages for a
894 /// list of short_channel_ids.
895 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
898 mod fuzzy_internal_msgs {
900 use ln::{PaymentPreimage, PaymentSecret};
902 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
903 // them from untrusted input):
905 pub(crate) struct FinalOnionHopData {
906 pub(crate) payment_secret: PaymentSecret,
907 /// The total value, in msat, of the payment as received by the ultimate recipient.
908 /// Message serialization may panic if this value is more than 21 million Bitcoin.
909 pub(crate) total_msat: u64,
912 pub(crate) enum OnionHopDataFormat {
913 Legacy { // aka Realm-0
914 short_channel_id: u64,
917 short_channel_id: u64,
920 payment_data: Option<FinalOnionHopData>,
921 keysend_preimage: Option<PaymentPreimage>,
925 pub struct OnionHopData {
926 pub(crate) format: OnionHopDataFormat,
927 /// The value, in msat, of the payment after this hop's fee is deducted.
928 /// Message serialization may panic if this value is more than 21 million Bitcoin.
929 pub(crate) amt_to_forward: u64,
930 pub(crate) outgoing_cltv_value: u32,
931 // 12 bytes of 0-padding for Legacy format
934 pub struct DecodedOnionErrorPacket {
935 pub(crate) hmac: [u8; 32],
936 pub(crate) failuremsg: Vec<u8>,
937 pub(crate) pad: Vec<u8>,
940 #[cfg(feature = "fuzztarget")]
941 pub use self::fuzzy_internal_msgs::*;
942 #[cfg(not(feature = "fuzztarget"))]
943 pub(crate) use self::fuzzy_internal_msgs::*;
946 pub(crate) struct OnionPacket {
947 pub(crate) version: u8,
948 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
949 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
950 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
951 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
952 pub(crate) hop_data: [u8; 20*65],
953 pub(crate) hmac: [u8; 32],
956 impl PartialEq for OnionPacket {
957 fn eq(&self, other: &OnionPacket) -> bool {
958 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
959 if i != j { return false; }
961 self.version == other.version &&
962 self.public_key == other.public_key &&
963 self.hmac == other.hmac
967 impl fmt::Debug for OnionPacket {
968 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
969 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
973 #[derive(Clone, Debug, PartialEq)]
974 pub(crate) struct OnionErrorPacket {
975 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
976 // (TODO) We limit it in decode to much lower...
977 pub(crate) data: Vec<u8>,
980 impl fmt::Display for DecodeError {
981 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
983 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
984 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
985 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
986 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
987 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
988 DecodeError::Io(ref e) => e.fmt(f),
989 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
994 impl From<io::Error> for DecodeError {
995 fn from(e: io::Error) -> Self {
996 if e.kind() == io::ErrorKind::UnexpectedEof {
997 DecodeError::ShortRead
999 DecodeError::Io(e.kind())
1004 impl Writeable for OptionalField<Script> {
1005 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1007 OptionalField::Present(ref script) => {
1008 // Note that Writeable for script includes the 16-bit length tag for us
1011 OptionalField::Absent => {}
1017 impl Readable for OptionalField<Script> {
1018 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1019 match <u16 as Readable>::read(r) {
1021 let mut buf = vec![0; len as usize];
1022 r.read_exact(&mut buf)?;
1023 Ok(OptionalField::Present(Script::from(buf)))
1025 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1031 impl Writeable for OptionalField<u64> {
1032 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1034 OptionalField::Present(ref value) => {
1037 OptionalField::Absent => {}
1043 impl Readable for OptionalField<u64> {
1044 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1045 let value: u64 = Readable::read(r)?;
1046 Ok(OptionalField::Present(value))
1051 impl_writeable_msg!(AcceptChannel, {
1052 temporary_channel_id,
1053 dust_limit_satoshis,
1054 max_htlc_value_in_flight_msat,
1055 channel_reserve_satoshis,
1061 revocation_basepoint,
1063 delayed_payment_basepoint,
1065 first_per_commitment_point,
1066 shutdown_scriptpubkey
1069 impl_writeable_msg!(AnnouncementSignatures, {
1076 impl Writeable for ChannelReestablish {
1077 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1078 self.channel_id.write(w)?;
1079 self.next_local_commitment_number.write(w)?;
1080 self.next_remote_commitment_number.write(w)?;
1081 match self.data_loss_protect {
1082 OptionalField::Present(ref data_loss_protect) => {
1083 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1084 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1086 OptionalField::Absent => {}
1092 impl Readable for ChannelReestablish{
1093 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1095 channel_id: Readable::read(r)?,
1096 next_local_commitment_number: Readable::read(r)?,
1097 next_remote_commitment_number: Readable::read(r)?,
1098 data_loss_protect: {
1099 match <[u8; 32] as Readable>::read(r) {
1100 Ok(your_last_per_commitment_secret) =>
1101 OptionalField::Present(DataLossProtect {
1102 your_last_per_commitment_secret,
1103 my_current_per_commitment_point: Readable::read(r)?,
1105 Err(DecodeError::ShortRead) => OptionalField::Absent,
1106 Err(e) => return Err(e)
1113 impl_writeable_msg!(ClosingSigned,
1114 { channel_id, fee_satoshis, signature },
1115 { (1, fee_range, option) }
1118 impl_writeable!(ClosingSignedFeeRange, {
1123 impl_writeable_msg!(CommitmentSigned, {
1129 impl_writeable!(DecodedOnionErrorPacket, {
1135 impl_writeable_msg!(FundingCreated, {
1136 temporary_channel_id,
1138 funding_output_index,
1142 impl_writeable_msg!(FundingSigned, {
1147 impl_writeable_msg!(FundingLocked, {
1149 next_per_commitment_point,
1152 impl Writeable for Init {
1153 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1154 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1155 // our relevant feature bits. This keeps us compatible with old nodes.
1156 self.features.write_up_to_13(w)?;
1157 self.features.write(w)
1161 impl Readable for Init {
1162 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1163 let global_features: InitFeatures = Readable::read(r)?;
1164 let features: InitFeatures = Readable::read(r)?;
1166 features: features.or(global_features),
1171 impl_writeable_msg!(OpenChannel, {
1173 temporary_channel_id,
1176 dust_limit_satoshis,
1177 max_htlc_value_in_flight_msat,
1178 channel_reserve_satoshis,
1184 revocation_basepoint,
1186 delayed_payment_basepoint,
1188 first_per_commitment_point,
1190 shutdown_scriptpubkey
1192 (1, channel_type, option),
1195 impl_writeable_msg!(RevokeAndACK, {
1197 per_commitment_secret,
1198 next_per_commitment_point
1201 impl_writeable_msg!(Shutdown, {
1206 impl_writeable_msg!(UpdateFailHTLC, {
1212 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1219 impl_writeable_msg!(UpdateFee, {
1224 impl_writeable_msg!(UpdateFulfillHTLC, {
1230 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1231 // serialization format in a way which assumes we know the total serialized length/message end
1233 impl_writeable!(OnionErrorPacket, {
1237 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1238 // serialization format in a way which assumes we know the total serialized length/message end
1240 impl Writeable for OnionPacket {
1241 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1242 self.version.write(w)?;
1243 match self.public_key {
1244 Ok(pubkey) => pubkey.write(w)?,
1245 Err(_) => [0u8;33].write(w)?,
1247 w.write_all(&self.hop_data)?;
1248 self.hmac.write(w)?;
1253 impl Readable for OnionPacket {
1254 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1256 version: Readable::read(r)?,
1258 let mut buf = [0u8;33];
1259 r.read_exact(&mut buf)?;
1260 PublicKey::from_slice(&buf)
1262 hop_data: Readable::read(r)?,
1263 hmac: Readable::read(r)?,
1268 impl_writeable_msg!(UpdateAddHTLC, {
1274 onion_routing_packet
1277 impl Writeable for FinalOnionHopData {
1278 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1279 self.payment_secret.0.write(w)?;
1280 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1284 impl Readable for FinalOnionHopData {
1285 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1286 let secret: [u8; 32] = Readable::read(r)?;
1287 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1288 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1292 impl Writeable for OnionHopData {
1293 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1294 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1295 // check values are sane long before we get here, though its possible in the future
1296 // user-generated messages may hit this.
1297 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1299 OnionHopDataFormat::Legacy { short_channel_id } => {
1301 short_channel_id.write(w)?;
1302 self.amt_to_forward.write(w)?;
1303 self.outgoing_cltv_value.write(w)?;
1304 w.write_all(&[0;12])?;
1306 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1307 encode_varint_length_prefixed_tlv!(w, {
1308 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1309 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1310 (6, short_channel_id, required)
1313 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1314 if let Some(final_data) = payment_data {
1315 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1317 encode_varint_length_prefixed_tlv!(w, {
1318 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1319 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1320 (8, payment_data, option),
1321 (5482373484, keysend_preimage, option)
1329 impl Readable for OnionHopData {
1330 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1331 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1332 let v: VarInt = Decodable::consensus_decode(&mut r)
1333 .map_err(|e| match e {
1334 Error::Io(ioe) => DecodeError::from(ioe),
1335 _ => DecodeError::InvalidValue
1337 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1338 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1339 let mut rd = FixedLengthReader::new(r, v.0);
1340 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1341 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1342 let mut short_id: Option<u64> = None;
1343 let mut payment_data: Option<FinalOnionHopData> = None;
1344 let mut keysend_preimage: Option<PaymentPreimage> = None;
1345 // The TLV type is chosen to be compatible with lnd and c-lightning.
1346 decode_tlv_stream!(&mut rd, {
1348 (4, cltv_value, required),
1349 (6, short_id, option),
1350 (8, payment_data, option),
1351 (5482373484, keysend_preimage, option)
1353 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1354 let format = if let Some(short_channel_id) = short_id {
1355 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1356 OnionHopDataFormat::NonFinalNode {
1360 if let &Some(ref data) = &payment_data {
1361 if data.total_msat > MAX_VALUE_MSAT {
1362 return Err(DecodeError::InvalidValue);
1365 OnionHopDataFormat::FinalNode {
1370 (format, amt.0, cltv_value.0)
1372 let format = OnionHopDataFormat::Legacy {
1373 short_channel_id: Readable::read(r)?,
1375 let amt: u64 = Readable::read(r)?;
1376 let cltv_value: u32 = Readable::read(r)?;
1377 r.read_exact(&mut [0; 12])?;
1378 (format, amt, cltv_value)
1381 if amt > MAX_VALUE_MSAT {
1382 return Err(DecodeError::InvalidValue);
1386 amt_to_forward: amt,
1387 outgoing_cltv_value: cltv_value,
1392 impl Writeable for Ping {
1393 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1394 self.ponglen.write(w)?;
1395 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1400 impl Readable for Ping {
1401 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1403 ponglen: Readable::read(r)?,
1405 let byteslen = Readable::read(r)?;
1406 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1413 impl Writeable for Pong {
1414 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1415 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1420 impl Readable for Pong {
1421 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1424 let byteslen = Readable::read(r)?;
1425 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1432 impl Writeable for UnsignedChannelAnnouncement {
1433 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1434 self.features.write(w)?;
1435 self.chain_hash.write(w)?;
1436 self.short_channel_id.write(w)?;
1437 self.node_id_1.write(w)?;
1438 self.node_id_2.write(w)?;
1439 self.bitcoin_key_1.write(w)?;
1440 self.bitcoin_key_2.write(w)?;
1441 w.write_all(&self.excess_data[..])?;
1446 impl Readable for UnsignedChannelAnnouncement {
1447 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1449 features: Readable::read(r)?,
1450 chain_hash: Readable::read(r)?,
1451 short_channel_id: Readable::read(r)?,
1452 node_id_1: Readable::read(r)?,
1453 node_id_2: Readable::read(r)?,
1454 bitcoin_key_1: Readable::read(r)?,
1455 bitcoin_key_2: Readable::read(r)?,
1456 excess_data: read_to_end(r)?,
1461 impl_writeable!(ChannelAnnouncement, {
1464 bitcoin_signature_1,
1465 bitcoin_signature_2,
1469 impl Writeable for UnsignedChannelUpdate {
1470 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1471 let mut message_flags: u8 = 0;
1472 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1475 self.chain_hash.write(w)?;
1476 self.short_channel_id.write(w)?;
1477 self.timestamp.write(w)?;
1478 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1479 all_flags.write(w)?;
1480 self.cltv_expiry_delta.write(w)?;
1481 self.htlc_minimum_msat.write(w)?;
1482 self.fee_base_msat.write(w)?;
1483 self.fee_proportional_millionths.write(w)?;
1484 self.htlc_maximum_msat.write(w)?;
1485 w.write_all(&self.excess_data[..])?;
1490 impl Readable for UnsignedChannelUpdate {
1491 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1492 let has_htlc_maximum_msat;
1494 chain_hash: Readable::read(r)?,
1495 short_channel_id: Readable::read(r)?,
1496 timestamp: Readable::read(r)?,
1498 let flags: u16 = Readable::read(r)?;
1499 let message_flags = flags >> 8;
1500 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1503 cltv_expiry_delta: Readable::read(r)?,
1504 htlc_minimum_msat: Readable::read(r)?,
1505 fee_base_msat: Readable::read(r)?,
1506 fee_proportional_millionths: Readable::read(r)?,
1507 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1508 excess_data: read_to_end(r)?,
1513 impl_writeable!(ChannelUpdate, {
1518 impl Writeable for ErrorMessage {
1519 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1520 self.channel_id.write(w)?;
1521 (self.data.len() as u16).write(w)?;
1522 w.write_all(self.data.as_bytes())?;
1527 impl Readable for ErrorMessage {
1528 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1530 channel_id: Readable::read(r)?,
1532 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1533 let data = read_to_end(r)?;
1534 sz = cmp::min(data.len(), sz);
1535 match String::from_utf8(data[..sz as usize].to_vec()) {
1537 Err(_) => return Err(DecodeError::InvalidValue),
1544 impl Writeable for WarningMessage {
1545 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1546 self.channel_id.write(w)?;
1547 (self.data.len() as u16).write(w)?;
1548 w.write_all(self.data.as_bytes())?;
1553 impl Readable for WarningMessage {
1554 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1556 channel_id: Readable::read(r)?,
1558 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1559 let data = read_to_end(r)?;
1560 sz = cmp::min(data.len(), sz);
1561 match String::from_utf8(data[..sz as usize].to_vec()) {
1563 Err(_) => return Err(DecodeError::InvalidValue),
1570 impl Writeable for UnsignedNodeAnnouncement {
1571 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1572 self.features.write(w)?;
1573 self.timestamp.write(w)?;
1574 self.node_id.write(w)?;
1575 w.write_all(&self.rgb)?;
1576 self.alias.write(w)?;
1578 let mut addr_len = 0;
1579 for addr in self.addresses.iter() {
1580 addr_len += 1 + addr.len();
1582 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1583 for addr in self.addresses.iter() {
1586 w.write_all(&self.excess_address_data[..])?;
1587 w.write_all(&self.excess_data[..])?;
1592 impl Readable for UnsignedNodeAnnouncement {
1593 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1594 let features: NodeFeatures = Readable::read(r)?;
1595 let timestamp: u32 = Readable::read(r)?;
1596 let node_id: PublicKey = Readable::read(r)?;
1597 let mut rgb = [0; 3];
1598 r.read_exact(&mut rgb)?;
1599 let alias: [u8; 32] = Readable::read(r)?;
1601 let addr_len: u16 = Readable::read(r)?;
1602 let mut addresses: Vec<NetAddress> = Vec::new();
1603 let mut addr_readpos = 0;
1604 let mut excess = false;
1605 let mut excess_byte = 0;
1607 if addr_len <= addr_readpos { break; }
1608 match Readable::read(r) {
1610 if addr_len < addr_readpos + 1 + addr.len() {
1611 return Err(DecodeError::BadLengthDescriptor);
1613 addr_readpos += (1 + addr.len()) as u16;
1614 addresses.push(addr);
1616 Ok(Err(unknown_descriptor)) => {
1618 excess_byte = unknown_descriptor;
1621 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1622 Err(e) => return Err(e),
1626 let mut excess_data = vec![];
1627 let excess_address_data = if addr_readpos < addr_len {
1628 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1629 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1631 excess_address_data[0] = excess_byte;
1636 excess_data.push(excess_byte);
1640 excess_data.extend(read_to_end(r)?.iter());
1641 Ok(UnsignedNodeAnnouncement {
1648 excess_address_data,
1654 impl_writeable!(NodeAnnouncement, {
1659 impl Readable for QueryShortChannelIds {
1660 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1661 let chain_hash: BlockHash = Readable::read(r)?;
1663 let encoding_len: u16 = Readable::read(r)?;
1664 let encoding_type: u8 = Readable::read(r)?;
1666 // Must be encoding_type=0 uncompressed serialization. We do not
1667 // support encoding_type=1 zlib serialization.
1668 if encoding_type != EncodingType::Uncompressed as u8 {
1669 return Err(DecodeError::UnsupportedCompression);
1672 // We expect the encoding_len to always includes the 1-byte
1673 // encoding_type and that short_channel_ids are 8-bytes each
1674 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1675 return Err(DecodeError::InvalidValue);
1678 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1679 // less the 1-byte encoding_type
1680 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1681 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1682 for _ in 0..short_channel_id_count {
1683 short_channel_ids.push(Readable::read(r)?);
1686 Ok(QueryShortChannelIds {
1693 impl Writeable for QueryShortChannelIds {
1694 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1695 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1696 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1698 self.chain_hash.write(w)?;
1699 encoding_len.write(w)?;
1701 // We only support type=0 uncompressed serialization
1702 (EncodingType::Uncompressed as u8).write(w)?;
1704 for scid in self.short_channel_ids.iter() {
1712 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1717 impl QueryChannelRange {
1719 * Calculates the overflow safe ending block height for the query.
1720 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1722 pub fn end_blocknum(&self) -> u32 {
1723 match self.first_blocknum.checked_add(self.number_of_blocks) {
1724 Some(block) => block,
1725 None => u32::max_value(),
1730 impl_writeable_msg!(QueryChannelRange, {
1736 impl Readable for ReplyChannelRange {
1737 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1738 let chain_hash: BlockHash = Readable::read(r)?;
1739 let first_blocknum: u32 = Readable::read(r)?;
1740 let number_of_blocks: u32 = Readable::read(r)?;
1741 let sync_complete: bool = Readable::read(r)?;
1743 let encoding_len: u16 = Readable::read(r)?;
1744 let encoding_type: u8 = Readable::read(r)?;
1746 // Must be encoding_type=0 uncompressed serialization. We do not
1747 // support encoding_type=1 zlib serialization.
1748 if encoding_type != EncodingType::Uncompressed as u8 {
1749 return Err(DecodeError::UnsupportedCompression);
1752 // We expect the encoding_len to always includes the 1-byte
1753 // encoding_type and that short_channel_ids are 8-bytes each
1754 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1755 return Err(DecodeError::InvalidValue);
1758 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1759 // less the 1-byte encoding_type
1760 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1761 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1762 for _ in 0..short_channel_id_count {
1763 short_channel_ids.push(Readable::read(r)?);
1766 Ok(ReplyChannelRange {
1776 impl Writeable for ReplyChannelRange {
1777 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1778 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1779 self.chain_hash.write(w)?;
1780 self.first_blocknum.write(w)?;
1781 self.number_of_blocks.write(w)?;
1782 self.sync_complete.write(w)?;
1784 encoding_len.write(w)?;
1785 (EncodingType::Uncompressed as u8).write(w)?;
1786 for scid in self.short_channel_ids.iter() {
1794 impl_writeable_msg!(GossipTimestampFilter, {
1803 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1804 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1806 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1807 use util::ser::{Writeable, Readable};
1809 use bitcoin::hashes::hex::FromHex;
1810 use bitcoin::util::address::Address;
1811 use bitcoin::network::constants::Network;
1812 use bitcoin::blockdata::script::Builder;
1813 use bitcoin::blockdata::opcodes;
1814 use bitcoin::hash_types::{Txid, BlockHash};
1816 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1817 use bitcoin::secp256k1::{Secp256k1, Message};
1823 fn encoding_channel_reestablish_no_secret() {
1824 let cr = msgs::ChannelReestablish {
1825 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],
1826 next_local_commitment_number: 3,
1827 next_remote_commitment_number: 4,
1828 data_loss_protect: OptionalField::Absent,
1831 let encoded_value = cr.encode();
1834 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]
1839 fn encoding_channel_reestablish_with_secret() {
1841 let secp_ctx = Secp256k1::new();
1842 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1845 let cr = msgs::ChannelReestablish {
1846 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],
1847 next_local_commitment_number: 3,
1848 next_remote_commitment_number: 4,
1849 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1852 let encoded_value = cr.encode();
1855 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]
1859 macro_rules! get_keys_from {
1860 ($slice: expr, $secp_ctx: expr) => {
1862 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1863 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1869 macro_rules! get_sig_on {
1870 ($privkey: expr, $ctx: expr, $string: expr) => {
1872 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1873 $ctx.sign(&sighash, &$privkey)
1879 fn encoding_announcement_signatures() {
1880 let secp_ctx = Secp256k1::new();
1881 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1882 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1883 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1884 let announcement_signatures = msgs::AnnouncementSignatures {
1885 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],
1886 short_channel_id: 2316138423780173,
1887 node_signature: sig_1,
1888 bitcoin_signature: sig_2,
1891 let encoded_value = announcement_signatures.encode();
1892 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1895 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1896 let secp_ctx = Secp256k1::new();
1897 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1898 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1899 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1900 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1901 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1902 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1903 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1904 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1905 let mut features = ChannelFeatures::known();
1906 if unknown_features_bits {
1907 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1909 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1911 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1912 short_channel_id: 2316138423780173,
1913 node_id_1: pubkey_1,
1914 node_id_2: pubkey_2,
1915 bitcoin_key_1: pubkey_3,
1916 bitcoin_key_2: pubkey_4,
1917 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1919 let channel_announcement = msgs::ChannelAnnouncement {
1920 node_signature_1: sig_1,
1921 node_signature_2: sig_2,
1922 bitcoin_signature_1: sig_3,
1923 bitcoin_signature_2: sig_4,
1924 contents: unsigned_channel_announcement,
1926 let encoded_value = channel_announcement.encode();
1927 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1928 if unknown_features_bits {
1929 target_value.append(&mut hex::decode("0002ffff").unwrap());
1931 target_value.append(&mut hex::decode("0000").unwrap());
1933 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1934 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1936 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1938 assert_eq!(encoded_value, target_value);
1942 fn encoding_channel_announcement() {
1943 do_encoding_channel_announcement(true, false);
1944 do_encoding_channel_announcement(false, true);
1945 do_encoding_channel_announcement(false, false);
1946 do_encoding_channel_announcement(true, true);
1949 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1950 let secp_ctx = Secp256k1::new();
1951 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1952 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1953 let features = if unknown_features_bits {
1954 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1956 // Set to some features we may support
1957 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1959 let mut addresses = Vec::new();
1961 addresses.push(msgs::NetAddress::IPv4 {
1962 addr: [255, 254, 253, 252],
1967 addresses.push(msgs::NetAddress::IPv6 {
1968 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1973 addresses.push(msgs::NetAddress::OnionV2(
1974 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
1978 addresses.push(msgs::NetAddress::OnionV3 {
1979 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],
1985 let mut addr_len = 0;
1986 for addr in &addresses {
1987 addr_len += addr.len() + 1;
1989 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1991 timestamp: 20190119,
1996 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() },
1997 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() },
1999 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2000 let node_announcement = msgs::NodeAnnouncement {
2002 contents: unsigned_node_announcement,
2004 let encoded_value = node_announcement.encode();
2005 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2006 if unknown_features_bits {
2007 target_value.append(&mut hex::decode("0002ffff").unwrap());
2009 target_value.append(&mut hex::decode("000122").unwrap());
2011 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2012 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2014 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2017 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2020 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2023 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2025 if excess_address_data {
2026 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2029 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2031 assert_eq!(encoded_value, target_value);
2035 fn encoding_node_announcement() {
2036 do_encoding_node_announcement(true, true, true, true, true, true, true);
2037 do_encoding_node_announcement(false, false, false, false, false, false, false);
2038 do_encoding_node_announcement(false, true, false, false, false, false, false);
2039 do_encoding_node_announcement(false, false, true, false, false, false, false);
2040 do_encoding_node_announcement(false, false, false, true, false, false, false);
2041 do_encoding_node_announcement(false, false, false, false, true, false, false);
2042 do_encoding_node_announcement(false, false, false, false, false, true, false);
2043 do_encoding_node_announcement(false, true, false, true, false, true, false);
2044 do_encoding_node_announcement(false, false, true, false, true, false, false);
2047 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2048 let secp_ctx = Secp256k1::new();
2049 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2050 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2051 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2052 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2053 short_channel_id: 2316138423780173,
2054 timestamp: 20190119,
2055 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2056 cltv_expiry_delta: 144,
2057 htlc_minimum_msat: 1000000,
2058 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2059 fee_base_msat: 10000,
2060 fee_proportional_millionths: 20,
2061 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2063 let channel_update = msgs::ChannelUpdate {
2065 contents: unsigned_channel_update
2067 let encoded_value = channel_update.encode();
2068 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2069 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2070 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2071 if htlc_maximum_msat {
2072 target_value.append(&mut hex::decode("01").unwrap());
2074 target_value.append(&mut hex::decode("00").unwrap());
2076 target_value.append(&mut hex::decode("00").unwrap());
2078 let flag = target_value.last_mut().unwrap();
2082 let flag = target_value.last_mut().unwrap();
2083 *flag = *flag | 1 << 1;
2085 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2086 if htlc_maximum_msat {
2087 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2090 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2092 assert_eq!(encoded_value, target_value);
2096 fn encoding_channel_update() {
2097 do_encoding_channel_update(false, false, false, false);
2098 do_encoding_channel_update(false, false, false, true);
2099 do_encoding_channel_update(true, false, false, false);
2100 do_encoding_channel_update(true, false, false, true);
2101 do_encoding_channel_update(false, true, false, false);
2102 do_encoding_channel_update(false, true, false, true);
2103 do_encoding_channel_update(false, false, true, false);
2104 do_encoding_channel_update(false, false, true, true);
2105 do_encoding_channel_update(true, true, true, false);
2106 do_encoding_channel_update(true, true, true, true);
2109 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2110 let secp_ctx = Secp256k1::new();
2111 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2112 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2113 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2114 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2115 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2116 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2117 let open_channel = msgs::OpenChannel {
2118 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2119 temporary_channel_id: [2; 32],
2120 funding_satoshis: 1311768467284833366,
2121 push_msat: 2536655962884945560,
2122 dust_limit_satoshis: 3608586615801332854,
2123 max_htlc_value_in_flight_msat: 8517154655701053848,
2124 channel_reserve_satoshis: 8665828695742877976,
2125 htlc_minimum_msat: 2316138423780173,
2126 feerate_per_kw: 821716,
2127 to_self_delay: 49340,
2128 max_accepted_htlcs: 49340,
2129 funding_pubkey: pubkey_1,
2130 revocation_basepoint: pubkey_2,
2131 payment_point: pubkey_3,
2132 delayed_payment_basepoint: pubkey_4,
2133 htlc_basepoint: pubkey_5,
2134 first_per_commitment_point: pubkey_6,
2135 channel_flags: if random_bit { 1 << 5 } else { 0 },
2136 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2137 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2139 let encoded_value = open_channel.encode();
2140 let mut target_value = Vec::new();
2141 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2142 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2144 target_value.append(&mut hex::decode("20").unwrap());
2146 target_value.append(&mut hex::decode("00").unwrap());
2149 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2152 target_value.append(&mut hex::decode("0100").unwrap());
2154 assert_eq!(encoded_value, target_value);
2158 fn encoding_open_channel() {
2159 do_encoding_open_channel(false, false, false);
2160 do_encoding_open_channel(false, false, true);
2161 do_encoding_open_channel(false, true, false);
2162 do_encoding_open_channel(false, true, true);
2163 do_encoding_open_channel(true, false, false);
2164 do_encoding_open_channel(true, false, true);
2165 do_encoding_open_channel(true, true, false);
2166 do_encoding_open_channel(true, true, true);
2169 fn do_encoding_accept_channel(shutdown: bool) {
2170 let secp_ctx = Secp256k1::new();
2171 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2172 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2173 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2174 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2175 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2176 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2177 let accept_channel = msgs::AcceptChannel {
2178 temporary_channel_id: [2; 32],
2179 dust_limit_satoshis: 1311768467284833366,
2180 max_htlc_value_in_flight_msat: 2536655962884945560,
2181 channel_reserve_satoshis: 3608586615801332854,
2182 htlc_minimum_msat: 2316138423780173,
2183 minimum_depth: 821716,
2184 to_self_delay: 49340,
2185 max_accepted_htlcs: 49340,
2186 funding_pubkey: pubkey_1,
2187 revocation_basepoint: pubkey_2,
2188 payment_point: pubkey_3,
2189 delayed_payment_basepoint: pubkey_4,
2190 htlc_basepoint: pubkey_5,
2191 first_per_commitment_point: pubkey_6,
2192 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2194 let encoded_value = accept_channel.encode();
2195 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2197 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2199 assert_eq!(encoded_value, target_value);
2203 fn encoding_accept_channel() {
2204 do_encoding_accept_channel(false);
2205 do_encoding_accept_channel(true);
2209 fn encoding_funding_created() {
2210 let secp_ctx = Secp256k1::new();
2211 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2212 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2213 let funding_created = msgs::FundingCreated {
2214 temporary_channel_id: [2; 32],
2215 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2216 funding_output_index: 255,
2219 let encoded_value = funding_created.encode();
2220 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2221 assert_eq!(encoded_value, target_value);
2225 fn encoding_funding_signed() {
2226 let secp_ctx = Secp256k1::new();
2227 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2228 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2229 let funding_signed = msgs::FundingSigned {
2230 channel_id: [2; 32],
2233 let encoded_value = funding_signed.encode();
2234 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2235 assert_eq!(encoded_value, target_value);
2239 fn encoding_funding_locked() {
2240 let secp_ctx = Secp256k1::new();
2241 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2242 let funding_locked = msgs::FundingLocked {
2243 channel_id: [2; 32],
2244 next_per_commitment_point: pubkey_1,
2246 let encoded_value = funding_locked.encode();
2247 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2248 assert_eq!(encoded_value, target_value);
2251 fn do_encoding_shutdown(script_type: u8) {
2252 let secp_ctx = Secp256k1::new();
2253 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2254 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2255 let shutdown = msgs::Shutdown {
2256 channel_id: [2; 32],
2258 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2259 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2260 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2261 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2263 let encoded_value = shutdown.encode();
2264 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2265 if script_type == 1 {
2266 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2267 } else if script_type == 2 {
2268 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2269 } else if script_type == 3 {
2270 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2271 } else if script_type == 4 {
2272 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2274 assert_eq!(encoded_value, target_value);
2278 fn encoding_shutdown() {
2279 do_encoding_shutdown(1);
2280 do_encoding_shutdown(2);
2281 do_encoding_shutdown(3);
2282 do_encoding_shutdown(4);
2286 fn encoding_closing_signed() {
2287 let secp_ctx = Secp256k1::new();
2288 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2289 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2290 let closing_signed = msgs::ClosingSigned {
2291 channel_id: [2; 32],
2292 fee_satoshis: 2316138423780173,
2296 let encoded_value = closing_signed.encode();
2297 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2298 assert_eq!(encoded_value, target_value);
2299 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2301 let closing_signed_with_range = msgs::ClosingSigned {
2302 channel_id: [2; 32],
2303 fee_satoshis: 2316138423780173,
2305 fee_range: Some(msgs::ClosingSignedFeeRange {
2306 min_fee_satoshis: 0xdeadbeef,
2307 max_fee_satoshis: 0x1badcafe01234567,
2310 let encoded_value_with_range = closing_signed_with_range.encode();
2311 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2312 assert_eq!(encoded_value_with_range, target_value_with_range);
2313 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2314 closing_signed_with_range);
2318 fn encoding_update_add_htlc() {
2319 let secp_ctx = Secp256k1::new();
2320 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2321 let onion_routing_packet = msgs::OnionPacket {
2323 public_key: Ok(pubkey_1),
2324 hop_data: [1; 20*65],
2327 let update_add_htlc = msgs::UpdateAddHTLC {
2328 channel_id: [2; 32],
2329 htlc_id: 2316138423780173,
2330 amount_msat: 3608586615801332854,
2331 payment_hash: PaymentHash([1; 32]),
2332 cltv_expiry: 821716,
2333 onion_routing_packet
2335 let encoded_value = update_add_htlc.encode();
2336 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2337 assert_eq!(encoded_value, target_value);
2341 fn encoding_update_fulfill_htlc() {
2342 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2343 channel_id: [2; 32],
2344 htlc_id: 2316138423780173,
2345 payment_preimage: PaymentPreimage([1; 32]),
2347 let encoded_value = update_fulfill_htlc.encode();
2348 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2349 assert_eq!(encoded_value, target_value);
2353 fn encoding_update_fail_htlc() {
2354 let reason = OnionErrorPacket {
2355 data: [1; 32].to_vec(),
2357 let update_fail_htlc = msgs::UpdateFailHTLC {
2358 channel_id: [2; 32],
2359 htlc_id: 2316138423780173,
2362 let encoded_value = update_fail_htlc.encode();
2363 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2364 assert_eq!(encoded_value, target_value);
2368 fn encoding_update_fail_malformed_htlc() {
2369 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2370 channel_id: [2; 32],
2371 htlc_id: 2316138423780173,
2372 sha256_of_onion: [1; 32],
2375 let encoded_value = update_fail_malformed_htlc.encode();
2376 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2377 assert_eq!(encoded_value, target_value);
2380 fn do_encoding_commitment_signed(htlcs: bool) {
2381 let secp_ctx = Secp256k1::new();
2382 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2383 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2384 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2385 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2386 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2387 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2388 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2389 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2390 let commitment_signed = msgs::CommitmentSigned {
2391 channel_id: [2; 32],
2393 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2395 let encoded_value = commitment_signed.encode();
2396 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2398 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2400 target_value.append(&mut hex::decode("0000").unwrap());
2402 assert_eq!(encoded_value, target_value);
2406 fn encoding_commitment_signed() {
2407 do_encoding_commitment_signed(true);
2408 do_encoding_commitment_signed(false);
2412 fn encoding_revoke_and_ack() {
2413 let secp_ctx = Secp256k1::new();
2414 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2415 let raa = msgs::RevokeAndACK {
2416 channel_id: [2; 32],
2417 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],
2418 next_per_commitment_point: pubkey_1,
2420 let encoded_value = raa.encode();
2421 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2422 assert_eq!(encoded_value, target_value);
2426 fn encoding_update_fee() {
2427 let update_fee = msgs::UpdateFee {
2428 channel_id: [2; 32],
2429 feerate_per_kw: 20190119,
2431 let encoded_value = update_fee.encode();
2432 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2433 assert_eq!(encoded_value, target_value);
2437 fn encoding_init() {
2438 assert_eq!(msgs::Init {
2439 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2440 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2441 assert_eq!(msgs::Init {
2442 features: InitFeatures::from_le_bytes(vec![0xFF]),
2443 }.encode(), hex::decode("0001ff0001ff").unwrap());
2444 assert_eq!(msgs::Init {
2445 features: InitFeatures::from_le_bytes(vec![]),
2446 }.encode(), hex::decode("00000000").unwrap());
2450 fn encoding_error() {
2451 let error = msgs::ErrorMessage {
2452 channel_id: [2; 32],
2453 data: String::from("rust-lightning"),
2455 let encoded_value = error.encode();
2456 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2457 assert_eq!(encoded_value, target_value);
2461 fn encoding_warning() {
2462 let error = msgs::WarningMessage {
2463 channel_id: [2; 32],
2464 data: String::from("rust-lightning"),
2466 let encoded_value = error.encode();
2467 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2468 assert_eq!(encoded_value, target_value);
2472 fn encoding_ping() {
2473 let ping = msgs::Ping {
2477 let encoded_value = ping.encode();
2478 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2479 assert_eq!(encoded_value, target_value);
2483 fn encoding_pong() {
2484 let pong = msgs::Pong {
2487 let encoded_value = pong.encode();
2488 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2489 assert_eq!(encoded_value, target_value);
2493 fn encoding_legacy_onion_hop_data() {
2494 let msg = msgs::OnionHopData {
2495 format: OnionHopDataFormat::Legacy {
2496 short_channel_id: 0xdeadbeef1bad1dea,
2498 amt_to_forward: 0x0badf00d01020304,
2499 outgoing_cltv_value: 0xffffffff,
2501 let encoded_value = msg.encode();
2502 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2503 assert_eq!(encoded_value, target_value);
2507 fn encoding_nonfinal_onion_hop_data() {
2508 let mut msg = msgs::OnionHopData {
2509 format: OnionHopDataFormat::NonFinalNode {
2510 short_channel_id: 0xdeadbeef1bad1dea,
2512 amt_to_forward: 0x0badf00d01020304,
2513 outgoing_cltv_value: 0xffffffff,
2515 let encoded_value = msg.encode();
2516 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2517 assert_eq!(encoded_value, target_value);
2518 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2519 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2520 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2521 } else { panic!(); }
2522 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2523 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2527 fn encoding_final_onion_hop_data() {
2528 let mut msg = msgs::OnionHopData {
2529 format: OnionHopDataFormat::FinalNode {
2531 keysend_preimage: None,
2533 amt_to_forward: 0x0badf00d01020304,
2534 outgoing_cltv_value: 0xffffffff,
2536 let encoded_value = msg.encode();
2537 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2538 assert_eq!(encoded_value, target_value);
2539 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2540 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2541 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2542 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2546 fn encoding_final_onion_hop_data_with_secret() {
2547 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2548 let mut msg = msgs::OnionHopData {
2549 format: OnionHopDataFormat::FinalNode {
2550 payment_data: Some(FinalOnionHopData {
2551 payment_secret: expected_payment_secret,
2552 total_msat: 0x1badca1f
2554 keysend_preimage: None,
2556 amt_to_forward: 0x0badf00d01020304,
2557 outgoing_cltv_value: 0xffffffff,
2559 let encoded_value = msg.encode();
2560 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2561 assert_eq!(encoded_value, target_value);
2562 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2563 if let OnionHopDataFormat::FinalNode {
2564 payment_data: Some(FinalOnionHopData {
2566 total_msat: 0x1badca1f
2568 keysend_preimage: None,
2570 assert_eq!(payment_secret, expected_payment_secret);
2571 } else { panic!(); }
2572 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2573 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2577 fn query_channel_range_end_blocknum() {
2578 let tests: Vec<(u32, u32, u32)> = vec![
2579 (10000, 1500, 11500),
2580 (0, 0xffffffff, 0xffffffff),
2581 (1, 0xffffffff, 0xffffffff),
2584 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2585 let sut = msgs::QueryChannelRange {
2586 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2590 assert_eq!(sut.end_blocknum(), expected);
2595 fn encoding_query_channel_range() {
2596 let mut query_channel_range = msgs::QueryChannelRange {
2597 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2598 first_blocknum: 100000,
2599 number_of_blocks: 1500,
2601 let encoded_value = query_channel_range.encode();
2602 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2603 assert_eq!(encoded_value, target_value);
2605 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2606 assert_eq!(query_channel_range.first_blocknum, 100000);
2607 assert_eq!(query_channel_range.number_of_blocks, 1500);
2611 fn encoding_reply_channel_range() {
2612 do_encoding_reply_channel_range(0);
2613 do_encoding_reply_channel_range(1);
2616 fn do_encoding_reply_channel_range(encoding_type: u8) {
2617 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2618 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2619 let mut reply_channel_range = msgs::ReplyChannelRange {
2620 chain_hash: expected_chain_hash,
2621 first_blocknum: 756230,
2622 number_of_blocks: 1500,
2623 sync_complete: true,
2624 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2627 if encoding_type == 0 {
2628 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2629 let encoded_value = reply_channel_range.encode();
2630 assert_eq!(encoded_value, target_value);
2632 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2633 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2634 assert_eq!(reply_channel_range.first_blocknum, 756230);
2635 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2636 assert_eq!(reply_channel_range.sync_complete, true);
2637 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2638 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2639 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2641 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2642 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2643 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2648 fn encoding_query_short_channel_ids() {
2649 do_encoding_query_short_channel_ids(0);
2650 do_encoding_query_short_channel_ids(1);
2653 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2654 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2655 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2656 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2657 chain_hash: expected_chain_hash,
2658 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2661 if encoding_type == 0 {
2662 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2663 let encoded_value = query_short_channel_ids.encode();
2664 assert_eq!(encoded_value, target_value);
2666 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2667 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2668 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2669 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2670 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2672 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2673 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2674 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2679 fn encoding_reply_short_channel_ids_end() {
2680 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2681 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2682 chain_hash: expected_chain_hash,
2683 full_information: true,
2685 let encoded_value = reply_short_channel_ids_end.encode();
2686 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2687 assert_eq!(encoded_value, target_value);
2689 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2690 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2691 assert_eq!(reply_short_channel_ids_end.full_information, true);
2695 fn encoding_gossip_timestamp_filter(){
2696 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2697 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2698 chain_hash: expected_chain_hash,
2699 first_timestamp: 1590000000,
2700 timestamp_range: 0xffff_ffff,
2702 let encoded_value = gossip_timestamp_filter.encode();
2703 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2704 assert_eq!(encoded_value, target_value);
2706 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2707 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2708 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2709 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);