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
84 pub channel_id: [u8; 32],
85 /// A possibly human-readable error description.
86 /// The string should be sanitized before it is used (e.g. emitted to logs
87 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
88 /// vulnerability in the terminal emulator or the logging subsystem.
92 /// A ping message to be sent or received from a peer
93 #[derive(Clone, Debug, PartialEq)]
95 /// The desired response length
97 /// The ping packet size.
98 /// This field is not sent on the wire. byteslen zeros are sent.
102 /// A pong message to be sent or received from a peer
103 #[derive(Clone, Debug, PartialEq)]
105 /// The pong packet size.
106 /// This field is not sent on the wire. byteslen zeros are sent.
110 /// An open_channel message to be sent or received from a peer
111 #[derive(Clone, Debug, PartialEq)]
112 pub struct OpenChannel {
113 /// The genesis hash of the blockchain where the channel is to be opened
114 pub chain_hash: BlockHash,
115 /// A temporary channel ID, until the funding outpoint is announced
116 pub temporary_channel_id: [u8; 32],
117 /// The channel value
118 pub funding_satoshis: u64,
119 /// The amount to push to the counterparty as part of the open, in milli-satoshi
121 /// The threshold below which outputs on transactions broadcast by sender will be omitted
122 pub dust_limit_satoshis: u64,
123 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
124 pub max_htlc_value_in_flight_msat: u64,
125 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
126 pub channel_reserve_satoshis: u64,
127 /// The minimum HTLC size incoming to sender, in milli-satoshi
128 pub htlc_minimum_msat: u64,
129 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
130 pub feerate_per_kw: u32,
131 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
132 pub to_self_delay: u16,
133 /// The maximum number of inbound HTLCs towards sender
134 pub max_accepted_htlcs: u16,
135 /// The sender's key controlling the funding transaction
136 pub funding_pubkey: PublicKey,
137 /// Used to derive a revocation key for transactions broadcast by counterparty
138 pub revocation_basepoint: PublicKey,
139 /// A payment key to sender for transactions broadcast by counterparty
140 pub payment_point: PublicKey,
141 /// Used to derive a payment key to sender for transactions broadcast by sender
142 pub delayed_payment_basepoint: PublicKey,
143 /// Used to derive an HTLC payment key to sender
144 pub htlc_basepoint: PublicKey,
145 /// The first to-be-broadcast-by-sender transaction's per commitment point
146 pub first_per_commitment_point: PublicKey,
148 pub channel_flags: u8,
149 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
150 pub shutdown_scriptpubkey: OptionalField<Script>,
151 /// The channel type that this channel will represent. If none is set, we derive the channel
152 /// type from the intersection of our feature bits with our counterparty's feature bits from
153 /// the Init message.
154 pub channel_type: Option<ChannelTypeFeatures>,
157 /// An accept_channel message to be sent or received from a peer
158 #[derive(Clone, Debug, PartialEq)]
159 pub struct AcceptChannel {
160 /// A temporary channel ID, until the funding outpoint is announced
161 pub temporary_channel_id: [u8; 32],
162 /// The threshold below which outputs on transactions broadcast by sender will be omitted
163 pub dust_limit_satoshis: u64,
164 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
165 pub max_htlc_value_in_flight_msat: u64,
166 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
167 pub channel_reserve_satoshis: u64,
168 /// The minimum HTLC size incoming to sender, in milli-satoshi
169 pub htlc_minimum_msat: u64,
170 /// Minimum depth of the funding transaction before the channel is considered open
171 pub minimum_depth: u32,
172 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
173 pub to_self_delay: u16,
174 /// The maximum number of inbound HTLCs towards sender
175 pub max_accepted_htlcs: u16,
176 /// The sender's key controlling the funding transaction
177 pub funding_pubkey: PublicKey,
178 /// Used to derive a revocation key for transactions broadcast by counterparty
179 pub revocation_basepoint: PublicKey,
180 /// A payment key to sender for transactions broadcast by counterparty
181 pub payment_point: PublicKey,
182 /// Used to derive a payment key to sender for transactions broadcast by sender
183 pub delayed_payment_basepoint: PublicKey,
184 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
185 pub htlc_basepoint: PublicKey,
186 /// The first to-be-broadcast-by-sender transaction's per commitment point
187 pub first_per_commitment_point: PublicKey,
188 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
189 pub shutdown_scriptpubkey: OptionalField<Script>,
192 /// A funding_created message to be sent or received from a peer
193 #[derive(Clone, Debug, PartialEq)]
194 pub struct FundingCreated {
195 /// A temporary channel ID, until the funding is established
196 pub temporary_channel_id: [u8; 32],
197 /// The funding transaction ID
198 pub funding_txid: Txid,
199 /// The specific output index funding this channel
200 pub funding_output_index: u16,
201 /// The signature of the channel initiator (funder) on the initial commitment transaction
202 pub signature: Signature,
205 /// A funding_signed message to be sent or received from a peer
206 #[derive(Clone, Debug, PartialEq)]
207 pub struct FundingSigned {
209 pub channel_id: [u8; 32],
210 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
211 pub signature: Signature,
214 /// A funding_locked message to be sent or received from a peer
215 #[derive(Clone, Debug, PartialEq)]
216 pub struct FundingLocked {
218 pub channel_id: [u8; 32],
219 /// The per-commitment point of the second commitment transaction
220 pub next_per_commitment_point: PublicKey,
223 /// A shutdown message to be sent or received from a peer
224 #[derive(Clone, Debug, PartialEq)]
225 pub struct Shutdown {
227 pub channel_id: [u8; 32],
228 /// The destination of this peer's funds on closing.
229 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
230 pub scriptpubkey: Script,
233 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
234 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
236 #[derive(Clone, Debug, PartialEq)]
237 pub struct ClosingSignedFeeRange {
238 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
240 pub min_fee_satoshis: u64,
241 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
243 pub max_fee_satoshis: u64,
246 /// A closing_signed message to be sent or received from a peer
247 #[derive(Clone, Debug, PartialEq)]
248 pub struct ClosingSigned {
250 pub channel_id: [u8; 32],
251 /// The proposed total fee for the closing transaction
252 pub fee_satoshis: u64,
253 /// A signature on the closing transaction
254 pub signature: Signature,
255 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
257 pub fee_range: Option<ClosingSignedFeeRange>,
260 /// An update_add_htlc message to be sent or received from a peer
261 #[derive(Clone, Debug, PartialEq)]
262 pub struct UpdateAddHTLC {
264 pub channel_id: [u8; 32],
267 /// The HTLC value in milli-satoshi
268 pub amount_msat: u64,
269 /// The payment hash, the pre-image of which controls HTLC redemption
270 pub payment_hash: PaymentHash,
271 /// The expiry height of the HTLC
272 pub cltv_expiry: u32,
273 pub(crate) onion_routing_packet: OnionPacket,
276 /// An update_fulfill_htlc message to be sent or received from a peer
277 #[derive(Clone, Debug, PartialEq)]
278 pub struct UpdateFulfillHTLC {
280 pub channel_id: [u8; 32],
283 /// The pre-image of the payment hash, allowing HTLC redemption
284 pub payment_preimage: PaymentPreimage,
287 /// An update_fail_htlc message to be sent or received from a peer
288 #[derive(Clone, Debug, PartialEq)]
289 pub struct UpdateFailHTLC {
291 pub channel_id: [u8; 32],
294 pub(crate) reason: OnionErrorPacket,
297 /// An update_fail_malformed_htlc message to be sent or received from a peer
298 #[derive(Clone, Debug, PartialEq)]
299 pub struct UpdateFailMalformedHTLC {
301 pub channel_id: [u8; 32],
304 pub(crate) sha256_of_onion: [u8; 32],
306 pub failure_code: u16,
309 /// A commitment_signed message to be sent or received from a peer
310 #[derive(Clone, Debug, PartialEq)]
311 pub struct CommitmentSigned {
313 pub channel_id: [u8; 32],
314 /// A signature on the commitment transaction
315 pub signature: Signature,
316 /// Signatures on the HTLC transactions
317 pub htlc_signatures: Vec<Signature>,
320 /// A revoke_and_ack message to be sent or received from a peer
321 #[derive(Clone, Debug, PartialEq)]
322 pub struct RevokeAndACK {
324 pub channel_id: [u8; 32],
325 /// The secret corresponding to the per-commitment point
326 pub per_commitment_secret: [u8; 32],
327 /// The next sender-broadcast commitment transaction's per-commitment point
328 pub next_per_commitment_point: PublicKey,
331 /// An update_fee message to be sent or received from a peer
332 #[derive(Clone, Debug, PartialEq)]
333 pub struct UpdateFee {
335 pub channel_id: [u8; 32],
336 /// Fee rate per 1000-weight of the transaction
337 pub feerate_per_kw: u32,
340 #[derive(Clone, Debug, PartialEq)]
341 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
342 /// This is used to convince the recipient that the channel is at a certain commitment
343 /// number even if they lost that data due to a local failure. Of course, the peer may lie
344 /// and even later commitments may have been revoked.
345 pub struct DataLossProtect {
346 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
347 /// belonging to the recipient
348 pub your_last_per_commitment_secret: [u8; 32],
349 /// The sender's per-commitment point for their current commitment transaction
350 pub my_current_per_commitment_point: PublicKey,
353 /// A channel_reestablish message to be sent or received from a peer
354 #[derive(Clone, Debug, PartialEq)]
355 pub struct ChannelReestablish {
357 pub channel_id: [u8; 32],
358 /// The next commitment number for the sender
359 pub next_local_commitment_number: u64,
360 /// The next commitment number for the recipient
361 pub next_remote_commitment_number: u64,
362 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
363 pub data_loss_protect: OptionalField<DataLossProtect>,
366 /// An announcement_signatures message to be sent or received from a peer
367 #[derive(Clone, Debug, PartialEq)]
368 pub struct AnnouncementSignatures {
370 pub channel_id: [u8; 32],
371 /// The short channel ID
372 pub short_channel_id: u64,
373 /// A signature by the node key
374 pub node_signature: Signature,
375 /// A signature by the funding key
376 pub bitcoin_signature: Signature,
379 /// An address which can be used to connect to a remote peer
380 #[derive(Clone, Debug, PartialEq)]
381 pub enum NetAddress {
382 /// An IPv4 address/port on which the peer is listening.
384 /// The 4-byte IPv4 address
386 /// The port on which the node is listening
389 /// An IPv6 address/port on which the peer is listening.
391 /// The 16-byte IPv6 address
393 /// The port on which the node is listening
396 /// An old-style Tor onion address/port on which the peer is listening.
398 /// The bytes (usually encoded in base32 with ".onion" appended)
400 /// The port on which the node is listening
403 /// A new-style Tor onion address/port on which the peer is listening.
404 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
405 /// wrap as base32 and append ".onion".
407 /// The ed25519 long-term public key of the peer
408 ed25519_pubkey: [u8; 32],
409 /// The checksum of the pubkey and version, as included in the onion address
411 /// The version byte, as defined by the Tor Onion v3 spec.
413 /// The port on which the node is listening
418 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
420 pub(crate) fn get_id(&self) -> u8 {
422 &NetAddress::IPv4 {..} => { 1 },
423 &NetAddress::IPv6 {..} => { 2 },
424 &NetAddress::OnionV2 {..} => { 3 },
425 &NetAddress::OnionV3 {..} => { 4 },
429 /// Strict byte-length of address descriptor, 1-byte type not recorded
430 fn len(&self) -> u16 {
432 &NetAddress::IPv4 { .. } => { 6 },
433 &NetAddress::IPv6 { .. } => { 18 },
434 &NetAddress::OnionV2 { .. } => { 12 },
435 &NetAddress::OnionV3 { .. } => { 37 },
439 /// The maximum length of any address descriptor, not including the 1-byte type
440 pub(crate) const MAX_LEN: u16 = 37;
443 impl Writeable for NetAddress {
444 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
446 &NetAddress::IPv4 { ref addr, ref port } => {
451 &NetAddress::IPv6 { ref addr, ref port } => {
456 &NetAddress::OnionV2 { ref addr, ref port } => {
461 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
463 ed25519_pubkey.write(writer)?;
464 checksum.write(writer)?;
465 version.write(writer)?;
473 impl Readable for Result<NetAddress, u8> {
474 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
475 let byte = <u8 as Readable>::read(reader)?;
478 Ok(Ok(NetAddress::IPv4 {
479 addr: Readable::read(reader)?,
480 port: Readable::read(reader)?,
484 Ok(Ok(NetAddress::IPv6 {
485 addr: Readable::read(reader)?,
486 port: Readable::read(reader)?,
490 Ok(Ok(NetAddress::OnionV2 {
491 addr: Readable::read(reader)?,
492 port: Readable::read(reader)?,
496 Ok(Ok(NetAddress::OnionV3 {
497 ed25519_pubkey: Readable::read(reader)?,
498 checksum: Readable::read(reader)?,
499 version: Readable::read(reader)?,
500 port: Readable::read(reader)?,
503 _ => return Ok(Err(byte)),
508 impl Readable for NetAddress {
509 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
510 match Readable::read(reader) {
511 Ok(Ok(res)) => Ok(res),
512 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
519 /// The unsigned part of a node_announcement
520 #[derive(Clone, Debug, PartialEq)]
521 pub struct UnsignedNodeAnnouncement {
522 /// The advertised features
523 pub features: NodeFeatures,
524 /// A strictly monotonic announcement counter, with gaps allowed
526 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
528 pub node_id: PublicKey,
529 /// An RGB color for UI purposes
531 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
534 /// List of addresses on which this node is reachable
535 pub addresses: Vec<NetAddress>,
536 pub(crate) excess_address_data: Vec<u8>,
537 pub(crate) excess_data: Vec<u8>,
539 #[derive(Clone, Debug, PartialEq)]
540 /// A node_announcement message to be sent or received from a peer
541 pub struct NodeAnnouncement {
542 /// The signature by the node key
543 pub signature: Signature,
544 /// The actual content of the announcement
545 pub contents: UnsignedNodeAnnouncement,
548 /// The unsigned part of a channel_announcement
549 #[derive(Clone, Debug, PartialEq)]
550 pub struct UnsignedChannelAnnouncement {
551 /// The advertised channel features
552 pub features: ChannelFeatures,
553 /// The genesis hash of the blockchain where the channel is to be opened
554 pub chain_hash: BlockHash,
555 /// The short channel ID
556 pub short_channel_id: u64,
557 /// One of the two node_ids which are endpoints of this channel
558 pub node_id_1: PublicKey,
559 /// The other of the two node_ids which are endpoints of this channel
560 pub node_id_2: PublicKey,
561 /// The funding key for the first node
562 pub bitcoin_key_1: PublicKey,
563 /// The funding key for the second node
564 pub bitcoin_key_2: PublicKey,
565 pub(crate) excess_data: Vec<u8>,
567 /// A channel_announcement message to be sent or received from a peer
568 #[derive(Clone, Debug, PartialEq)]
569 pub struct ChannelAnnouncement {
570 /// Authentication of the announcement by the first public node
571 pub node_signature_1: Signature,
572 /// Authentication of the announcement by the second public node
573 pub node_signature_2: Signature,
574 /// Proof of funding UTXO ownership by the first public node
575 pub bitcoin_signature_1: Signature,
576 /// Proof of funding UTXO ownership by the second public node
577 pub bitcoin_signature_2: Signature,
578 /// The actual announcement
579 pub contents: UnsignedChannelAnnouncement,
582 /// The unsigned part of a channel_update
583 #[derive(Clone, Debug, PartialEq)]
584 pub struct UnsignedChannelUpdate {
585 /// The genesis hash of the blockchain where the channel is to be opened
586 pub chain_hash: BlockHash,
587 /// The short channel ID
588 pub short_channel_id: u64,
589 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
593 /// The number of blocks such that if:
594 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
595 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
596 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
597 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
598 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
599 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
600 /// constructing the route.
601 pub cltv_expiry_delta: u16,
602 /// The minimum HTLC size incoming to sender, in milli-satoshi
603 pub htlc_minimum_msat: u64,
604 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
605 pub htlc_maximum_msat: OptionalField<u64>,
606 /// The base HTLC fee charged by sender, in milli-satoshi
607 pub fee_base_msat: u32,
608 /// The amount to fee multiplier, in micro-satoshi
609 pub fee_proportional_millionths: u32,
610 pub(crate) excess_data: Vec<u8>,
612 /// A channel_update message to be sent or received from a peer
613 #[derive(Clone, Debug, PartialEq)]
614 pub struct ChannelUpdate {
615 /// A signature of the channel update
616 pub signature: Signature,
617 /// The actual channel update
618 pub contents: UnsignedChannelUpdate,
621 /// A query_channel_range message is used to query a peer for channel
622 /// UTXOs in a range of blocks. The recipient of a query makes a best
623 /// effort to reply to the query using one or more reply_channel_range
625 #[derive(Clone, Debug, PartialEq)]
626 pub struct QueryChannelRange {
627 /// The genesis hash of the blockchain being queried
628 pub chain_hash: BlockHash,
629 /// The height of the first block for the channel UTXOs being queried
630 pub first_blocknum: u32,
631 /// The number of blocks to include in the query results
632 pub number_of_blocks: u32,
635 /// A reply_channel_range message is a reply to a query_channel_range
636 /// message. Multiple reply_channel_range messages can be sent in reply
637 /// to a single query_channel_range message. The query recipient makes a
638 /// best effort to respond based on their local network view which may
639 /// not be a perfect view of the network. The short_channel_ids in the
640 /// reply are encoded. We only support encoding_type=0 uncompressed
641 /// serialization and do not support encoding_type=1 zlib serialization.
642 #[derive(Clone, Debug, PartialEq)]
643 pub struct ReplyChannelRange {
644 /// The genesis hash of the blockchain being queried
645 pub chain_hash: BlockHash,
646 /// The height of the first block in the range of the reply
647 pub first_blocknum: u32,
648 /// The number of blocks included in the range of the reply
649 pub number_of_blocks: u32,
650 /// True when this is the final reply for a query
651 pub sync_complete: bool,
652 /// The short_channel_ids in the channel range
653 pub short_channel_ids: Vec<u64>,
656 /// A query_short_channel_ids message is used to query a peer for
657 /// routing gossip messages related to one or more short_channel_ids.
658 /// The query recipient will reply with the latest, if available,
659 /// channel_announcement, channel_update and node_announcement messages
660 /// it maintains for the requested short_channel_ids followed by a
661 /// reply_short_channel_ids_end message. The short_channel_ids sent in
662 /// this query are encoded. We only support encoding_type=0 uncompressed
663 /// serialization and do not support encoding_type=1 zlib serialization.
664 #[derive(Clone, Debug, PartialEq)]
665 pub struct QueryShortChannelIds {
666 /// The genesis hash of the blockchain being queried
667 pub chain_hash: BlockHash,
668 /// The short_channel_ids that are being queried
669 pub short_channel_ids: Vec<u64>,
672 /// A reply_short_channel_ids_end message is sent as a reply to a
673 /// query_short_channel_ids message. The query recipient makes a best
674 /// effort to respond based on their local network view which may not be
675 /// a perfect view of the network.
676 #[derive(Clone, Debug, PartialEq)]
677 pub struct ReplyShortChannelIdsEnd {
678 /// The genesis hash of the blockchain that was queried
679 pub chain_hash: BlockHash,
680 /// Indicates if the query recipient maintains up-to-date channel
681 /// information for the chain_hash
682 pub full_information: bool,
685 /// A gossip_timestamp_filter message is used by a node to request
686 /// gossip relay for messages in the requested time range when the
687 /// gossip_queries feature has been negotiated.
688 #[derive(Clone, Debug, PartialEq)]
689 pub struct GossipTimestampFilter {
690 /// The genesis hash of the blockchain for channel and node information
691 pub chain_hash: BlockHash,
692 /// The starting unix timestamp
693 pub first_timestamp: u32,
694 /// The range of information in seconds
695 pub timestamp_range: u32,
698 /// Encoding type for data compression of collections in gossip queries.
699 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
704 /// Used to put an error message in a LightningError
705 #[derive(Clone, Debug)]
706 pub enum ErrorAction {
707 /// The peer took some action which made us think they were useless. Disconnect them.
709 /// An error message which we should make an effort to send before we disconnect.
710 msg: Option<ErrorMessage>
712 /// The peer did something harmless that we weren't able to process, just log and ignore
713 // New code should *not* use this. New code must use IgnoreAndLog, below!
715 /// The peer did something harmless that we weren't able to meaningfully process.
716 /// If the error is logged, log it at the given level.
717 IgnoreAndLog(logger::Level),
718 /// The peer provided us with a gossip message which we'd already seen. In most cases this
719 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
720 /// our own channel announcements.
721 IgnoreDuplicateGossip,
722 /// The peer did something incorrect. Tell them.
724 /// The message to send.
729 /// An Err type for failure to process messages.
730 #[derive(Clone, Debug)]
731 pub struct LightningError {
732 /// A human-readable message describing the error
734 /// The action which should be taken against the offending peer.
735 pub action: ErrorAction,
738 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
739 /// transaction updates if they were pending.
740 #[derive(Clone, Debug, PartialEq)]
741 pub struct CommitmentUpdate {
742 /// update_add_htlc messages which should be sent
743 pub update_add_htlcs: Vec<UpdateAddHTLC>,
744 /// update_fulfill_htlc messages which should be sent
745 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
746 /// update_fail_htlc messages which should be sent
747 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
748 /// update_fail_malformed_htlc messages which should be sent
749 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
750 /// An update_fee message which should be sent
751 pub update_fee: Option<UpdateFee>,
752 /// Finally, the commitment_signed message which should be sent
753 pub commitment_signed: CommitmentSigned,
756 /// Messages could have optional fields to use with extended features
757 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
758 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
759 /// separate enum type for them.
760 /// (C-not exported) due to a free generic in T
761 #[derive(Clone, Debug, PartialEq)]
762 pub enum OptionalField<T> {
763 /// Optional field is included in message
765 /// Optional field is absent in message
769 /// A trait to describe an object which can receive channel messages.
771 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
772 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
773 pub trait ChannelMessageHandler : MessageSendEventsProvider {
775 /// Handle an incoming open_channel message from the given peer.
776 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
777 /// Handle an incoming accept_channel message from the given peer.
778 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
779 /// Handle an incoming funding_created message from the given peer.
780 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
781 /// Handle an incoming funding_signed message from the given peer.
782 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
783 /// Handle an incoming funding_locked message from the given peer.
784 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
787 /// Handle an incoming shutdown message from the given peer.
788 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
789 /// Handle an incoming closing_signed message from the given peer.
790 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
793 /// Handle an incoming update_add_htlc message from the given peer.
794 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
795 /// Handle an incoming update_fulfill_htlc message from the given peer.
796 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
797 /// Handle an incoming update_fail_htlc message from the given peer.
798 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
799 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
800 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
801 /// Handle an incoming commitment_signed message from the given peer.
802 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
803 /// Handle an incoming revoke_and_ack message from the given peer.
804 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
806 /// Handle an incoming update_fee message from the given peer.
807 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
809 // Channel-to-announce:
810 /// Handle an incoming announcement_signatures message from the given peer.
811 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
813 // Connection loss/reestablish:
814 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
815 /// is believed to be possible in the future (eg they're sending us messages we don't
816 /// understand or indicate they require unknown feature bits), no_connection_possible is set
817 /// and any outstanding channels should be failed.
818 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
820 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
821 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
822 /// Handle an incoming channel_reestablish message from the given peer.
823 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
825 /// Handle an incoming channel update from the given peer.
826 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
829 /// Handle an incoming error message from the given peer.
830 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
833 /// A trait to describe an object which can receive routing messages.
835 /// # Implementor DoS Warnings
837 /// For `gossip_queries` messages there are potential DoS vectors when handling
838 /// inbound queries. Implementors using an on-disk network graph should be aware of
839 /// repeated disk I/O for queries accessing different parts of the network graph.
840 pub trait RoutingMessageHandler : MessageSendEventsProvider {
841 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
842 /// false or returning an Err otherwise.
843 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
844 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
845 /// or returning an Err otherwise.
846 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
847 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
848 /// false or returning an Err otherwise.
849 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
850 /// Gets a subset of the channel announcements and updates required to dump our routing table
851 /// to a remote node, starting at the short_channel_id indicated by starting_point and
852 /// including the batch_amount entries immediately higher in numerical value than starting_point.
853 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
854 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
855 /// starting at the node *after* the provided publickey and including batch_amount entries
856 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
857 /// If None is provided for starting_point, we start at the first node.
858 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
859 /// Called when a connection is established with a peer. This can be used to
860 /// perform routing table synchronization using a strategy defined by the
862 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
863 /// Handles the reply of a query we initiated to learn about channels
864 /// for a given range of blocks. We can expect to receive one or more
865 /// replies to a single query.
866 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
867 /// Handles the reply of a query we initiated asking for routing gossip
868 /// messages for a list of channels. We should receive this message when
869 /// a node has completed its best effort to send us the pertaining routing
871 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
872 /// Handles when a peer asks us to send a list of short_channel_ids
873 /// for the requested range of blocks.
874 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
875 /// Handles when a peer asks us to send routing gossip messages for a
876 /// list of short_channel_ids.
877 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
880 mod fuzzy_internal_msgs {
882 use ln::{PaymentPreimage, PaymentSecret};
884 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
885 // them from untrusted input):
887 pub(crate) struct FinalOnionHopData {
888 pub(crate) payment_secret: PaymentSecret,
889 /// The total value, in msat, of the payment as received by the ultimate recipient.
890 /// Message serialization may panic if this value is more than 21 million Bitcoin.
891 pub(crate) total_msat: u64,
894 pub(crate) enum OnionHopDataFormat {
895 Legacy { // aka Realm-0
896 short_channel_id: u64,
899 short_channel_id: u64,
902 payment_data: Option<FinalOnionHopData>,
903 keysend_preimage: Option<PaymentPreimage>,
907 pub struct OnionHopData {
908 pub(crate) format: OnionHopDataFormat,
909 /// The value, in msat, of the payment after this hop's fee is deducted.
910 /// Message serialization may panic if this value is more than 21 million Bitcoin.
911 pub(crate) amt_to_forward: u64,
912 pub(crate) outgoing_cltv_value: u32,
913 // 12 bytes of 0-padding for Legacy format
916 pub struct DecodedOnionErrorPacket {
917 pub(crate) hmac: [u8; 32],
918 pub(crate) failuremsg: Vec<u8>,
919 pub(crate) pad: Vec<u8>,
922 #[cfg(feature = "fuzztarget")]
923 pub use self::fuzzy_internal_msgs::*;
924 #[cfg(not(feature = "fuzztarget"))]
925 pub(crate) use self::fuzzy_internal_msgs::*;
928 pub(crate) struct OnionPacket {
929 pub(crate) version: u8,
930 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
931 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
932 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
933 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
934 pub(crate) hop_data: [u8; 20*65],
935 pub(crate) hmac: [u8; 32],
938 impl PartialEq for OnionPacket {
939 fn eq(&self, other: &OnionPacket) -> bool {
940 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
941 if i != j { return false; }
943 self.version == other.version &&
944 self.public_key == other.public_key &&
945 self.hmac == other.hmac
949 impl fmt::Debug for OnionPacket {
950 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
951 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
955 #[derive(Clone, Debug, PartialEq)]
956 pub(crate) struct OnionErrorPacket {
957 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
958 // (TODO) We limit it in decode to much lower...
959 pub(crate) data: Vec<u8>,
962 impl fmt::Display for DecodeError {
963 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
965 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
966 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
967 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
968 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
969 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
970 DecodeError::Io(ref e) => e.fmt(f),
971 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
976 impl From<io::Error> for DecodeError {
977 fn from(e: io::Error) -> Self {
978 if e.kind() == io::ErrorKind::UnexpectedEof {
979 DecodeError::ShortRead
981 DecodeError::Io(e.kind())
986 impl Writeable for OptionalField<Script> {
987 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
989 OptionalField::Present(ref script) => {
990 // Note that Writeable for script includes the 16-bit length tag for us
993 OptionalField::Absent => {}
999 impl Readable for OptionalField<Script> {
1000 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1001 match <u16 as Readable>::read(r) {
1003 let mut buf = vec![0; len as usize];
1004 r.read_exact(&mut buf)?;
1005 Ok(OptionalField::Present(Script::from(buf)))
1007 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1013 impl Writeable for OptionalField<u64> {
1014 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1016 OptionalField::Present(ref value) => {
1019 OptionalField::Absent => {}
1025 impl Readable for OptionalField<u64> {
1026 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1027 let value: u64 = Readable::read(r)?;
1028 Ok(OptionalField::Present(value))
1033 impl_writeable_msg!(AcceptChannel, {
1034 temporary_channel_id,
1035 dust_limit_satoshis,
1036 max_htlc_value_in_flight_msat,
1037 channel_reserve_satoshis,
1043 revocation_basepoint,
1045 delayed_payment_basepoint,
1047 first_per_commitment_point,
1048 shutdown_scriptpubkey
1051 impl_writeable_msg!(AnnouncementSignatures, {
1058 impl Writeable for ChannelReestablish {
1059 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1060 self.channel_id.write(w)?;
1061 self.next_local_commitment_number.write(w)?;
1062 self.next_remote_commitment_number.write(w)?;
1063 match self.data_loss_protect {
1064 OptionalField::Present(ref data_loss_protect) => {
1065 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1066 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1068 OptionalField::Absent => {}
1074 impl Readable for ChannelReestablish{
1075 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1077 channel_id: Readable::read(r)?,
1078 next_local_commitment_number: Readable::read(r)?,
1079 next_remote_commitment_number: Readable::read(r)?,
1080 data_loss_protect: {
1081 match <[u8; 32] as Readable>::read(r) {
1082 Ok(your_last_per_commitment_secret) =>
1083 OptionalField::Present(DataLossProtect {
1084 your_last_per_commitment_secret,
1085 my_current_per_commitment_point: Readable::read(r)?,
1087 Err(DecodeError::ShortRead) => OptionalField::Absent,
1088 Err(e) => return Err(e)
1095 impl_writeable_msg!(ClosingSigned,
1096 { channel_id, fee_satoshis, signature },
1097 { (1, fee_range, option) }
1100 impl_writeable!(ClosingSignedFeeRange, {
1105 impl_writeable_msg!(CommitmentSigned, {
1111 impl_writeable!(DecodedOnionErrorPacket, {
1117 impl_writeable_msg!(FundingCreated, {
1118 temporary_channel_id,
1120 funding_output_index,
1124 impl_writeable_msg!(FundingSigned, {
1129 impl_writeable_msg!(FundingLocked, {
1131 next_per_commitment_point,
1134 impl Writeable for Init {
1135 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1136 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1137 // our relevant feature bits. This keeps us compatible with old nodes.
1138 self.features.write_up_to_13(w)?;
1139 self.features.write(w)
1143 impl Readable for Init {
1144 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1145 let global_features: InitFeatures = Readable::read(r)?;
1146 let features: InitFeatures = Readable::read(r)?;
1148 features: features.or(global_features),
1153 impl_writeable_msg!(OpenChannel, {
1155 temporary_channel_id,
1158 dust_limit_satoshis,
1159 max_htlc_value_in_flight_msat,
1160 channel_reserve_satoshis,
1166 revocation_basepoint,
1168 delayed_payment_basepoint,
1170 first_per_commitment_point,
1172 shutdown_scriptpubkey
1174 (1, channel_type, option),
1177 impl_writeable_msg!(RevokeAndACK, {
1179 per_commitment_secret,
1180 next_per_commitment_point
1183 impl_writeable_msg!(Shutdown, {
1188 impl_writeable_msg!(UpdateFailHTLC, {
1194 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1201 impl_writeable_msg!(UpdateFee, {
1206 impl_writeable_msg!(UpdateFulfillHTLC, {
1212 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1213 // serialization format in a way which assumes we know the total serialized length/message end
1215 impl_writeable!(OnionErrorPacket, {
1219 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1220 // serialization format in a way which assumes we know the total serialized length/message end
1222 impl Writeable for OnionPacket {
1223 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1224 self.version.write(w)?;
1225 match self.public_key {
1226 Ok(pubkey) => pubkey.write(w)?,
1227 Err(_) => [0u8;33].write(w)?,
1229 w.write_all(&self.hop_data)?;
1230 self.hmac.write(w)?;
1235 impl Readable for OnionPacket {
1236 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1238 version: Readable::read(r)?,
1240 let mut buf = [0u8;33];
1241 r.read_exact(&mut buf)?;
1242 PublicKey::from_slice(&buf)
1244 hop_data: Readable::read(r)?,
1245 hmac: Readable::read(r)?,
1250 impl_writeable_msg!(UpdateAddHTLC, {
1256 onion_routing_packet
1259 impl Writeable for FinalOnionHopData {
1260 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1261 self.payment_secret.0.write(w)?;
1262 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1266 impl Readable for FinalOnionHopData {
1267 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1268 let secret: [u8; 32] = Readable::read(r)?;
1269 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1270 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1274 impl Writeable for OnionHopData {
1275 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1276 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1277 // check values are sane long before we get here, though its possible in the future
1278 // user-generated messages may hit this.
1279 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1281 OnionHopDataFormat::Legacy { short_channel_id } => {
1283 short_channel_id.write(w)?;
1284 self.amt_to_forward.write(w)?;
1285 self.outgoing_cltv_value.write(w)?;
1286 w.write_all(&[0;12])?;
1288 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1289 encode_varint_length_prefixed_tlv!(w, {
1290 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1291 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1292 (6, short_channel_id, required)
1295 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1296 if let Some(final_data) = payment_data {
1297 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1299 encode_varint_length_prefixed_tlv!(w, {
1300 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1301 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1302 (8, payment_data, option),
1303 (5482373484, keysend_preimage, option)
1311 impl Readable for OnionHopData {
1312 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1313 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1314 let v: VarInt = Decodable::consensus_decode(&mut r)
1315 .map_err(|e| match e {
1316 Error::Io(ioe) => DecodeError::from(ioe),
1317 _ => DecodeError::InvalidValue
1319 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1320 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1321 let mut rd = FixedLengthReader::new(r, v.0);
1322 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1323 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1324 let mut short_id: Option<u64> = None;
1325 let mut payment_data: Option<FinalOnionHopData> = None;
1326 let mut keysend_preimage: Option<PaymentPreimage> = None;
1327 // The TLV type is chosen to be compatible with lnd and c-lightning.
1328 decode_tlv_stream!(&mut rd, {
1330 (4, cltv_value, required),
1331 (6, short_id, option),
1332 (8, payment_data, option),
1333 (5482373484, keysend_preimage, option)
1335 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1336 let format = if let Some(short_channel_id) = short_id {
1337 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1338 OnionHopDataFormat::NonFinalNode {
1342 if let &Some(ref data) = &payment_data {
1343 if data.total_msat > MAX_VALUE_MSAT {
1344 return Err(DecodeError::InvalidValue);
1347 OnionHopDataFormat::FinalNode {
1352 (format, amt.0, cltv_value.0)
1354 let format = OnionHopDataFormat::Legacy {
1355 short_channel_id: Readable::read(r)?,
1357 let amt: u64 = Readable::read(r)?;
1358 let cltv_value: u32 = Readable::read(r)?;
1359 r.read_exact(&mut [0; 12])?;
1360 (format, amt, cltv_value)
1363 if amt > MAX_VALUE_MSAT {
1364 return Err(DecodeError::InvalidValue);
1368 amt_to_forward: amt,
1369 outgoing_cltv_value: cltv_value,
1374 impl Writeable for Ping {
1375 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1376 self.ponglen.write(w)?;
1377 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1382 impl Readable for Ping {
1383 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1385 ponglen: Readable::read(r)?,
1387 let byteslen = Readable::read(r)?;
1388 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1395 impl Writeable for Pong {
1396 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1397 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1402 impl Readable for Pong {
1403 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1406 let byteslen = Readable::read(r)?;
1407 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1414 impl Writeable for UnsignedChannelAnnouncement {
1415 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1416 self.features.write(w)?;
1417 self.chain_hash.write(w)?;
1418 self.short_channel_id.write(w)?;
1419 self.node_id_1.write(w)?;
1420 self.node_id_2.write(w)?;
1421 self.bitcoin_key_1.write(w)?;
1422 self.bitcoin_key_2.write(w)?;
1423 w.write_all(&self.excess_data[..])?;
1428 impl Readable for UnsignedChannelAnnouncement {
1429 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1431 features: Readable::read(r)?,
1432 chain_hash: Readable::read(r)?,
1433 short_channel_id: Readable::read(r)?,
1434 node_id_1: Readable::read(r)?,
1435 node_id_2: Readable::read(r)?,
1436 bitcoin_key_1: Readable::read(r)?,
1437 bitcoin_key_2: Readable::read(r)?,
1438 excess_data: read_to_end(r)?,
1443 impl_writeable!(ChannelAnnouncement, {
1446 bitcoin_signature_1,
1447 bitcoin_signature_2,
1451 impl Writeable for UnsignedChannelUpdate {
1452 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1453 let mut message_flags: u8 = 0;
1454 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1457 self.chain_hash.write(w)?;
1458 self.short_channel_id.write(w)?;
1459 self.timestamp.write(w)?;
1460 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1461 all_flags.write(w)?;
1462 self.cltv_expiry_delta.write(w)?;
1463 self.htlc_minimum_msat.write(w)?;
1464 self.fee_base_msat.write(w)?;
1465 self.fee_proportional_millionths.write(w)?;
1466 self.htlc_maximum_msat.write(w)?;
1467 w.write_all(&self.excess_data[..])?;
1472 impl Readable for UnsignedChannelUpdate {
1473 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1474 let has_htlc_maximum_msat;
1476 chain_hash: Readable::read(r)?,
1477 short_channel_id: Readable::read(r)?,
1478 timestamp: Readable::read(r)?,
1480 let flags: u16 = Readable::read(r)?;
1481 let message_flags = flags >> 8;
1482 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1485 cltv_expiry_delta: Readable::read(r)?,
1486 htlc_minimum_msat: Readable::read(r)?,
1487 fee_base_msat: Readable::read(r)?,
1488 fee_proportional_millionths: Readable::read(r)?,
1489 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1490 excess_data: read_to_end(r)?,
1495 impl_writeable!(ChannelUpdate, {
1500 impl Writeable for ErrorMessage {
1501 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1502 self.channel_id.write(w)?;
1503 (self.data.len() as u16).write(w)?;
1504 w.write_all(self.data.as_bytes())?;
1509 impl Readable for ErrorMessage {
1510 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1512 channel_id: Readable::read(r)?,
1514 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1515 let data = read_to_end(r)?;
1516 sz = cmp::min(data.len(), sz);
1517 match String::from_utf8(data[..sz as usize].to_vec()) {
1519 Err(_) => return Err(DecodeError::InvalidValue),
1526 impl Writeable for UnsignedNodeAnnouncement {
1527 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1528 self.features.write(w)?;
1529 self.timestamp.write(w)?;
1530 self.node_id.write(w)?;
1531 w.write_all(&self.rgb)?;
1532 self.alias.write(w)?;
1534 let mut addr_len = 0;
1535 for addr in self.addresses.iter() {
1536 addr_len += 1 + addr.len();
1538 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1539 for addr in self.addresses.iter() {
1542 w.write_all(&self.excess_address_data[..])?;
1543 w.write_all(&self.excess_data[..])?;
1548 impl Readable for UnsignedNodeAnnouncement {
1549 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1550 let features: NodeFeatures = Readable::read(r)?;
1551 let timestamp: u32 = Readable::read(r)?;
1552 let node_id: PublicKey = Readable::read(r)?;
1553 let mut rgb = [0; 3];
1554 r.read_exact(&mut rgb)?;
1555 let alias: [u8; 32] = Readable::read(r)?;
1557 let addr_len: u16 = Readable::read(r)?;
1558 let mut addresses: Vec<NetAddress> = Vec::new();
1559 let mut addr_readpos = 0;
1560 let mut excess = false;
1561 let mut excess_byte = 0;
1563 if addr_len <= addr_readpos { break; }
1564 match Readable::read(r) {
1566 if addr_len < addr_readpos + 1 + addr.len() {
1567 return Err(DecodeError::BadLengthDescriptor);
1569 addr_readpos += (1 + addr.len()) as u16;
1570 addresses.push(addr);
1572 Ok(Err(unknown_descriptor)) => {
1574 excess_byte = unknown_descriptor;
1577 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1578 Err(e) => return Err(e),
1582 let mut excess_data = vec![];
1583 let excess_address_data = if addr_readpos < addr_len {
1584 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1585 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1587 excess_address_data[0] = excess_byte;
1592 excess_data.push(excess_byte);
1596 excess_data.extend(read_to_end(r)?.iter());
1597 Ok(UnsignedNodeAnnouncement {
1604 excess_address_data,
1610 impl_writeable!(NodeAnnouncement, {
1615 impl Readable for QueryShortChannelIds {
1616 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1617 let chain_hash: BlockHash = Readable::read(r)?;
1619 let encoding_len: u16 = Readable::read(r)?;
1620 let encoding_type: u8 = Readable::read(r)?;
1622 // Must be encoding_type=0 uncompressed serialization. We do not
1623 // support encoding_type=1 zlib serialization.
1624 if encoding_type != EncodingType::Uncompressed as u8 {
1625 return Err(DecodeError::UnsupportedCompression);
1628 // We expect the encoding_len to always includes the 1-byte
1629 // encoding_type and that short_channel_ids are 8-bytes each
1630 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1631 return Err(DecodeError::InvalidValue);
1634 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1635 // less the 1-byte encoding_type
1636 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1637 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1638 for _ in 0..short_channel_id_count {
1639 short_channel_ids.push(Readable::read(r)?);
1642 Ok(QueryShortChannelIds {
1649 impl Writeable for QueryShortChannelIds {
1650 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1651 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1652 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1654 self.chain_hash.write(w)?;
1655 encoding_len.write(w)?;
1657 // We only support type=0 uncompressed serialization
1658 (EncodingType::Uncompressed as u8).write(w)?;
1660 for scid in self.short_channel_ids.iter() {
1668 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1673 impl QueryChannelRange {
1675 * Calculates the overflow safe ending block height for the query.
1676 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1678 pub fn end_blocknum(&self) -> u32 {
1679 match self.first_blocknum.checked_add(self.number_of_blocks) {
1680 Some(block) => block,
1681 None => u32::max_value(),
1686 impl_writeable_msg!(QueryChannelRange, {
1692 impl Readable for ReplyChannelRange {
1693 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1694 let chain_hash: BlockHash = Readable::read(r)?;
1695 let first_blocknum: u32 = Readable::read(r)?;
1696 let number_of_blocks: u32 = Readable::read(r)?;
1697 let sync_complete: bool = Readable::read(r)?;
1699 let encoding_len: u16 = Readable::read(r)?;
1700 let encoding_type: u8 = Readable::read(r)?;
1702 // Must be encoding_type=0 uncompressed serialization. We do not
1703 // support encoding_type=1 zlib serialization.
1704 if encoding_type != EncodingType::Uncompressed as u8 {
1705 return Err(DecodeError::UnsupportedCompression);
1708 // We expect the encoding_len to always includes the 1-byte
1709 // encoding_type and that short_channel_ids are 8-bytes each
1710 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1711 return Err(DecodeError::InvalidValue);
1714 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1715 // less the 1-byte encoding_type
1716 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1717 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1718 for _ in 0..short_channel_id_count {
1719 short_channel_ids.push(Readable::read(r)?);
1722 Ok(ReplyChannelRange {
1732 impl Writeable for ReplyChannelRange {
1733 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1734 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1735 self.chain_hash.write(w)?;
1736 self.first_blocknum.write(w)?;
1737 self.number_of_blocks.write(w)?;
1738 self.sync_complete.write(w)?;
1740 encoding_len.write(w)?;
1741 (EncodingType::Uncompressed as u8).write(w)?;
1742 for scid in self.short_channel_ids.iter() {
1750 impl_writeable_msg!(GossipTimestampFilter, {
1759 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1760 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1762 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1763 use util::ser::{Writeable, Readable};
1765 use bitcoin::hashes::hex::FromHex;
1766 use bitcoin::util::address::Address;
1767 use bitcoin::network::constants::Network;
1768 use bitcoin::blockdata::script::Builder;
1769 use bitcoin::blockdata::opcodes;
1770 use bitcoin::hash_types::{Txid, BlockHash};
1772 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1773 use bitcoin::secp256k1::{Secp256k1, Message};
1779 fn encoding_channel_reestablish_no_secret() {
1780 let cr = msgs::ChannelReestablish {
1781 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],
1782 next_local_commitment_number: 3,
1783 next_remote_commitment_number: 4,
1784 data_loss_protect: OptionalField::Absent,
1787 let encoded_value = cr.encode();
1790 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]
1795 fn encoding_channel_reestablish_with_secret() {
1797 let secp_ctx = Secp256k1::new();
1798 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1801 let cr = msgs::ChannelReestablish {
1802 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],
1803 next_local_commitment_number: 3,
1804 next_remote_commitment_number: 4,
1805 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1808 let encoded_value = cr.encode();
1811 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]
1815 macro_rules! get_keys_from {
1816 ($slice: expr, $secp_ctx: expr) => {
1818 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1819 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1825 macro_rules! get_sig_on {
1826 ($privkey: expr, $ctx: expr, $string: expr) => {
1828 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1829 $ctx.sign(&sighash, &$privkey)
1835 fn encoding_announcement_signatures() {
1836 let secp_ctx = Secp256k1::new();
1837 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1838 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1839 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1840 let announcement_signatures = msgs::AnnouncementSignatures {
1841 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],
1842 short_channel_id: 2316138423780173,
1843 node_signature: sig_1,
1844 bitcoin_signature: sig_2,
1847 let encoded_value = announcement_signatures.encode();
1848 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1851 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1852 let secp_ctx = Secp256k1::new();
1853 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1854 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1855 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1856 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1857 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1858 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1859 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1860 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1861 let mut features = ChannelFeatures::known();
1862 if unknown_features_bits {
1863 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1865 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1867 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1868 short_channel_id: 2316138423780173,
1869 node_id_1: pubkey_1,
1870 node_id_2: pubkey_2,
1871 bitcoin_key_1: pubkey_3,
1872 bitcoin_key_2: pubkey_4,
1873 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1875 let channel_announcement = msgs::ChannelAnnouncement {
1876 node_signature_1: sig_1,
1877 node_signature_2: sig_2,
1878 bitcoin_signature_1: sig_3,
1879 bitcoin_signature_2: sig_4,
1880 contents: unsigned_channel_announcement,
1882 let encoded_value = channel_announcement.encode();
1883 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1884 if unknown_features_bits {
1885 target_value.append(&mut hex::decode("0002ffff").unwrap());
1887 target_value.append(&mut hex::decode("0000").unwrap());
1889 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1890 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1892 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1894 assert_eq!(encoded_value, target_value);
1898 fn encoding_channel_announcement() {
1899 do_encoding_channel_announcement(true, false);
1900 do_encoding_channel_announcement(false, true);
1901 do_encoding_channel_announcement(false, false);
1902 do_encoding_channel_announcement(true, true);
1905 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1906 let secp_ctx = Secp256k1::new();
1907 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1908 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1909 let features = if unknown_features_bits {
1910 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1912 // Set to some features we may support
1913 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1915 let mut addresses = Vec::new();
1917 addresses.push(msgs::NetAddress::IPv4 {
1918 addr: [255, 254, 253, 252],
1923 addresses.push(msgs::NetAddress::IPv6 {
1924 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1929 addresses.push(msgs::NetAddress::OnionV2 {
1930 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1935 addresses.push(msgs::NetAddress::OnionV3 {
1936 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],
1942 let mut addr_len = 0;
1943 for addr in &addresses {
1944 addr_len += addr.len() + 1;
1946 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1948 timestamp: 20190119,
1953 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() },
1954 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() },
1956 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1957 let node_announcement = msgs::NodeAnnouncement {
1959 contents: unsigned_node_announcement,
1961 let encoded_value = node_announcement.encode();
1962 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1963 if unknown_features_bits {
1964 target_value.append(&mut hex::decode("0002ffff").unwrap());
1966 target_value.append(&mut hex::decode("000122").unwrap());
1968 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1969 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1971 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1974 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1977 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1980 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1982 if excess_address_data {
1983 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1986 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1988 assert_eq!(encoded_value, target_value);
1992 fn encoding_node_announcement() {
1993 do_encoding_node_announcement(true, true, true, true, true, true, true);
1994 do_encoding_node_announcement(false, false, false, false, false, false, false);
1995 do_encoding_node_announcement(false, true, false, false, false, false, false);
1996 do_encoding_node_announcement(false, false, true, false, false, false, false);
1997 do_encoding_node_announcement(false, false, false, true, false, false, false);
1998 do_encoding_node_announcement(false, false, false, false, true, false, false);
1999 do_encoding_node_announcement(false, false, false, false, false, true, false);
2000 do_encoding_node_announcement(false, true, false, true, false, true, false);
2001 do_encoding_node_announcement(false, false, true, false, true, false, false);
2004 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2005 let secp_ctx = Secp256k1::new();
2006 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2007 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2008 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2009 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2010 short_channel_id: 2316138423780173,
2011 timestamp: 20190119,
2012 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2013 cltv_expiry_delta: 144,
2014 htlc_minimum_msat: 1000000,
2015 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2016 fee_base_msat: 10000,
2017 fee_proportional_millionths: 20,
2018 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2020 let channel_update = msgs::ChannelUpdate {
2022 contents: unsigned_channel_update
2024 let encoded_value = channel_update.encode();
2025 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2026 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2027 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2028 if htlc_maximum_msat {
2029 target_value.append(&mut hex::decode("01").unwrap());
2031 target_value.append(&mut hex::decode("00").unwrap());
2033 target_value.append(&mut hex::decode("00").unwrap());
2035 let flag = target_value.last_mut().unwrap();
2039 let flag = target_value.last_mut().unwrap();
2040 *flag = *flag | 1 << 1;
2042 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2043 if htlc_maximum_msat {
2044 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2047 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2049 assert_eq!(encoded_value, target_value);
2053 fn encoding_channel_update() {
2054 do_encoding_channel_update(false, false, false, false);
2055 do_encoding_channel_update(false, false, false, true);
2056 do_encoding_channel_update(true, false, false, false);
2057 do_encoding_channel_update(true, false, false, true);
2058 do_encoding_channel_update(false, true, false, false);
2059 do_encoding_channel_update(false, true, false, true);
2060 do_encoding_channel_update(false, false, true, false);
2061 do_encoding_channel_update(false, false, true, true);
2062 do_encoding_channel_update(true, true, true, false);
2063 do_encoding_channel_update(true, true, true, true);
2066 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2067 let secp_ctx = Secp256k1::new();
2068 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2069 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2070 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2071 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2072 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2073 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2074 let open_channel = msgs::OpenChannel {
2075 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2076 temporary_channel_id: [2; 32],
2077 funding_satoshis: 1311768467284833366,
2078 push_msat: 2536655962884945560,
2079 dust_limit_satoshis: 3608586615801332854,
2080 max_htlc_value_in_flight_msat: 8517154655701053848,
2081 channel_reserve_satoshis: 8665828695742877976,
2082 htlc_minimum_msat: 2316138423780173,
2083 feerate_per_kw: 821716,
2084 to_self_delay: 49340,
2085 max_accepted_htlcs: 49340,
2086 funding_pubkey: pubkey_1,
2087 revocation_basepoint: pubkey_2,
2088 payment_point: pubkey_3,
2089 delayed_payment_basepoint: pubkey_4,
2090 htlc_basepoint: pubkey_5,
2091 first_per_commitment_point: pubkey_6,
2092 channel_flags: if random_bit { 1 << 5 } else { 0 },
2093 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2094 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2096 let encoded_value = open_channel.encode();
2097 let mut target_value = Vec::new();
2098 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2099 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2101 target_value.append(&mut hex::decode("20").unwrap());
2103 target_value.append(&mut hex::decode("00").unwrap());
2106 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2109 target_value.append(&mut hex::decode("0100").unwrap());
2111 assert_eq!(encoded_value, target_value);
2115 fn encoding_open_channel() {
2116 do_encoding_open_channel(false, false, false);
2117 do_encoding_open_channel(false, false, true);
2118 do_encoding_open_channel(false, true, false);
2119 do_encoding_open_channel(false, true, true);
2120 do_encoding_open_channel(true, false, false);
2121 do_encoding_open_channel(true, false, true);
2122 do_encoding_open_channel(true, true, false);
2123 do_encoding_open_channel(true, true, true);
2126 fn do_encoding_accept_channel(shutdown: bool) {
2127 let secp_ctx = Secp256k1::new();
2128 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2129 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2130 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2131 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2132 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2133 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2134 let accept_channel = msgs::AcceptChannel {
2135 temporary_channel_id: [2; 32],
2136 dust_limit_satoshis: 1311768467284833366,
2137 max_htlc_value_in_flight_msat: 2536655962884945560,
2138 channel_reserve_satoshis: 3608586615801332854,
2139 htlc_minimum_msat: 2316138423780173,
2140 minimum_depth: 821716,
2141 to_self_delay: 49340,
2142 max_accepted_htlcs: 49340,
2143 funding_pubkey: pubkey_1,
2144 revocation_basepoint: pubkey_2,
2145 payment_point: pubkey_3,
2146 delayed_payment_basepoint: pubkey_4,
2147 htlc_basepoint: pubkey_5,
2148 first_per_commitment_point: pubkey_6,
2149 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2151 let encoded_value = accept_channel.encode();
2152 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2154 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2156 assert_eq!(encoded_value, target_value);
2160 fn encoding_accept_channel() {
2161 do_encoding_accept_channel(false);
2162 do_encoding_accept_channel(true);
2166 fn encoding_funding_created() {
2167 let secp_ctx = Secp256k1::new();
2168 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2169 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2170 let funding_created = msgs::FundingCreated {
2171 temporary_channel_id: [2; 32],
2172 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2173 funding_output_index: 255,
2176 let encoded_value = funding_created.encode();
2177 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2178 assert_eq!(encoded_value, target_value);
2182 fn encoding_funding_signed() {
2183 let secp_ctx = Secp256k1::new();
2184 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2185 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2186 let funding_signed = msgs::FundingSigned {
2187 channel_id: [2; 32],
2190 let encoded_value = funding_signed.encode();
2191 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2192 assert_eq!(encoded_value, target_value);
2196 fn encoding_funding_locked() {
2197 let secp_ctx = Secp256k1::new();
2198 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2199 let funding_locked = msgs::FundingLocked {
2200 channel_id: [2; 32],
2201 next_per_commitment_point: pubkey_1,
2203 let encoded_value = funding_locked.encode();
2204 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2205 assert_eq!(encoded_value, target_value);
2208 fn do_encoding_shutdown(script_type: u8) {
2209 let secp_ctx = Secp256k1::new();
2210 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2211 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2212 let shutdown = msgs::Shutdown {
2213 channel_id: [2; 32],
2215 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2216 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2217 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2218 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2220 let encoded_value = shutdown.encode();
2221 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2222 if script_type == 1 {
2223 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2224 } else if script_type == 2 {
2225 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2226 } else if script_type == 3 {
2227 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2228 } else if script_type == 4 {
2229 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2231 assert_eq!(encoded_value, target_value);
2235 fn encoding_shutdown() {
2236 do_encoding_shutdown(1);
2237 do_encoding_shutdown(2);
2238 do_encoding_shutdown(3);
2239 do_encoding_shutdown(4);
2243 fn encoding_closing_signed() {
2244 let secp_ctx = Secp256k1::new();
2245 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2246 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2247 let closing_signed = msgs::ClosingSigned {
2248 channel_id: [2; 32],
2249 fee_satoshis: 2316138423780173,
2253 let encoded_value = closing_signed.encode();
2254 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2255 assert_eq!(encoded_value, target_value);
2256 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2258 let closing_signed_with_range = msgs::ClosingSigned {
2259 channel_id: [2; 32],
2260 fee_satoshis: 2316138423780173,
2262 fee_range: Some(msgs::ClosingSignedFeeRange {
2263 min_fee_satoshis: 0xdeadbeef,
2264 max_fee_satoshis: 0x1badcafe01234567,
2267 let encoded_value_with_range = closing_signed_with_range.encode();
2268 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2269 assert_eq!(encoded_value_with_range, target_value_with_range);
2270 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2271 closing_signed_with_range);
2275 fn encoding_update_add_htlc() {
2276 let secp_ctx = Secp256k1::new();
2277 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2278 let onion_routing_packet = msgs::OnionPacket {
2280 public_key: Ok(pubkey_1),
2281 hop_data: [1; 20*65],
2284 let update_add_htlc = msgs::UpdateAddHTLC {
2285 channel_id: [2; 32],
2286 htlc_id: 2316138423780173,
2287 amount_msat: 3608586615801332854,
2288 payment_hash: PaymentHash([1; 32]),
2289 cltv_expiry: 821716,
2290 onion_routing_packet
2292 let encoded_value = update_add_htlc.encode();
2293 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2294 assert_eq!(encoded_value, target_value);
2298 fn encoding_update_fulfill_htlc() {
2299 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2300 channel_id: [2; 32],
2301 htlc_id: 2316138423780173,
2302 payment_preimage: PaymentPreimage([1; 32]),
2304 let encoded_value = update_fulfill_htlc.encode();
2305 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2306 assert_eq!(encoded_value, target_value);
2310 fn encoding_update_fail_htlc() {
2311 let reason = OnionErrorPacket {
2312 data: [1; 32].to_vec(),
2314 let update_fail_htlc = msgs::UpdateFailHTLC {
2315 channel_id: [2; 32],
2316 htlc_id: 2316138423780173,
2319 let encoded_value = update_fail_htlc.encode();
2320 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2321 assert_eq!(encoded_value, target_value);
2325 fn encoding_update_fail_malformed_htlc() {
2326 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2327 channel_id: [2; 32],
2328 htlc_id: 2316138423780173,
2329 sha256_of_onion: [1; 32],
2332 let encoded_value = update_fail_malformed_htlc.encode();
2333 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2334 assert_eq!(encoded_value, target_value);
2337 fn do_encoding_commitment_signed(htlcs: bool) {
2338 let secp_ctx = Secp256k1::new();
2339 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2340 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2341 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2342 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2343 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2344 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2345 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2346 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2347 let commitment_signed = msgs::CommitmentSigned {
2348 channel_id: [2; 32],
2350 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2352 let encoded_value = commitment_signed.encode();
2353 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2355 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2357 target_value.append(&mut hex::decode("0000").unwrap());
2359 assert_eq!(encoded_value, target_value);
2363 fn encoding_commitment_signed() {
2364 do_encoding_commitment_signed(true);
2365 do_encoding_commitment_signed(false);
2369 fn encoding_revoke_and_ack() {
2370 let secp_ctx = Secp256k1::new();
2371 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2372 let raa = msgs::RevokeAndACK {
2373 channel_id: [2; 32],
2374 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],
2375 next_per_commitment_point: pubkey_1,
2377 let encoded_value = raa.encode();
2378 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2379 assert_eq!(encoded_value, target_value);
2383 fn encoding_update_fee() {
2384 let update_fee = msgs::UpdateFee {
2385 channel_id: [2; 32],
2386 feerate_per_kw: 20190119,
2388 let encoded_value = update_fee.encode();
2389 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2390 assert_eq!(encoded_value, target_value);
2394 fn encoding_init() {
2395 assert_eq!(msgs::Init {
2396 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2397 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2398 assert_eq!(msgs::Init {
2399 features: InitFeatures::from_le_bytes(vec![0xFF]),
2400 }.encode(), hex::decode("0001ff0001ff").unwrap());
2401 assert_eq!(msgs::Init {
2402 features: InitFeatures::from_le_bytes(vec![]),
2403 }.encode(), hex::decode("00000000").unwrap());
2407 fn encoding_error() {
2408 let error = msgs::ErrorMessage {
2409 channel_id: [2; 32],
2410 data: String::from("rust-lightning"),
2412 let encoded_value = error.encode();
2413 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2414 assert_eq!(encoded_value, target_value);
2418 fn encoding_ping() {
2419 let ping = msgs::Ping {
2423 let encoded_value = ping.encode();
2424 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2425 assert_eq!(encoded_value, target_value);
2429 fn encoding_pong() {
2430 let pong = msgs::Pong {
2433 let encoded_value = pong.encode();
2434 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2435 assert_eq!(encoded_value, target_value);
2439 fn encoding_legacy_onion_hop_data() {
2440 let msg = msgs::OnionHopData {
2441 format: OnionHopDataFormat::Legacy {
2442 short_channel_id: 0xdeadbeef1bad1dea,
2444 amt_to_forward: 0x0badf00d01020304,
2445 outgoing_cltv_value: 0xffffffff,
2447 let encoded_value = msg.encode();
2448 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2449 assert_eq!(encoded_value, target_value);
2453 fn encoding_nonfinal_onion_hop_data() {
2454 let mut msg = msgs::OnionHopData {
2455 format: OnionHopDataFormat::NonFinalNode {
2456 short_channel_id: 0xdeadbeef1bad1dea,
2458 amt_to_forward: 0x0badf00d01020304,
2459 outgoing_cltv_value: 0xffffffff,
2461 let encoded_value = msg.encode();
2462 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2463 assert_eq!(encoded_value, target_value);
2464 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2465 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2466 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2467 } else { panic!(); }
2468 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2469 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2473 fn encoding_final_onion_hop_data() {
2474 let mut msg = msgs::OnionHopData {
2475 format: OnionHopDataFormat::FinalNode {
2477 keysend_preimage: None,
2479 amt_to_forward: 0x0badf00d01020304,
2480 outgoing_cltv_value: 0xffffffff,
2482 let encoded_value = msg.encode();
2483 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2484 assert_eq!(encoded_value, target_value);
2485 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2486 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2487 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2488 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2492 fn encoding_final_onion_hop_data_with_secret() {
2493 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2494 let mut msg = msgs::OnionHopData {
2495 format: OnionHopDataFormat::FinalNode {
2496 payment_data: Some(FinalOnionHopData {
2497 payment_secret: expected_payment_secret,
2498 total_msat: 0x1badca1f
2500 keysend_preimage: None,
2502 amt_to_forward: 0x0badf00d01020304,
2503 outgoing_cltv_value: 0xffffffff,
2505 let encoded_value = msg.encode();
2506 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2507 assert_eq!(encoded_value, target_value);
2508 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2509 if let OnionHopDataFormat::FinalNode {
2510 payment_data: Some(FinalOnionHopData {
2512 total_msat: 0x1badca1f
2514 keysend_preimage: None,
2516 assert_eq!(payment_secret, expected_payment_secret);
2517 } else { panic!(); }
2518 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2519 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2523 fn query_channel_range_end_blocknum() {
2524 let tests: Vec<(u32, u32, u32)> = vec![
2525 (10000, 1500, 11500),
2526 (0, 0xffffffff, 0xffffffff),
2527 (1, 0xffffffff, 0xffffffff),
2530 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2531 let sut = msgs::QueryChannelRange {
2532 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2536 assert_eq!(sut.end_blocknum(), expected);
2541 fn encoding_query_channel_range() {
2542 let mut query_channel_range = msgs::QueryChannelRange {
2543 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2544 first_blocknum: 100000,
2545 number_of_blocks: 1500,
2547 let encoded_value = query_channel_range.encode();
2548 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2549 assert_eq!(encoded_value, target_value);
2551 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2552 assert_eq!(query_channel_range.first_blocknum, 100000);
2553 assert_eq!(query_channel_range.number_of_blocks, 1500);
2557 fn encoding_reply_channel_range() {
2558 do_encoding_reply_channel_range(0);
2559 do_encoding_reply_channel_range(1);
2562 fn do_encoding_reply_channel_range(encoding_type: u8) {
2563 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2564 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2565 let mut reply_channel_range = msgs::ReplyChannelRange {
2566 chain_hash: expected_chain_hash,
2567 first_blocknum: 756230,
2568 number_of_blocks: 1500,
2569 sync_complete: true,
2570 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2573 if encoding_type == 0 {
2574 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2575 let encoded_value = reply_channel_range.encode();
2576 assert_eq!(encoded_value, target_value);
2578 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2579 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2580 assert_eq!(reply_channel_range.first_blocknum, 756230);
2581 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2582 assert_eq!(reply_channel_range.sync_complete, true);
2583 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2584 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2585 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2587 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2588 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2589 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2594 fn encoding_query_short_channel_ids() {
2595 do_encoding_query_short_channel_ids(0);
2596 do_encoding_query_short_channel_ids(1);
2599 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2600 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2601 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2602 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2603 chain_hash: expected_chain_hash,
2604 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2607 if encoding_type == 0 {
2608 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2609 let encoded_value = query_short_channel_ids.encode();
2610 assert_eq!(encoded_value, target_value);
2612 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2613 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2614 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2615 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2616 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2618 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2619 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2620 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2625 fn encoding_reply_short_channel_ids_end() {
2626 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2627 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2628 chain_hash: expected_chain_hash,
2629 full_information: true,
2631 let encoded_value = reply_short_channel_ids_end.encode();
2632 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2633 assert_eq!(encoded_value, target_value);
2635 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2636 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2637 assert_eq!(reply_short_channel_ids_end.full_information, true);
2641 fn encoding_gossip_timestamp_filter(){
2642 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2643 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2644 chain_hash: expected_chain_hash,
2645 first_timestamp: 1590000000,
2646 timestamp_range: 0xffff_ffff,
2648 let encoded_value = gossip_timestamp_filter.encode();
2649 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2650 assert_eq!(encoded_value, target_value);
2652 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2653 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2654 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2655 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);