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, IterWriteWrapper};
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,
78 /// The set of encoding types which our peer supports for gossip messages, excluding those we
79 /// do not understand.
80 pub gossip_compression_encodings: Vec<GossipEncodingType>,
83 /// An error message to be sent or received from a peer
84 #[derive(Clone, Debug, PartialEq)]
85 pub struct ErrorMessage {
86 /// The channel ID involved in the error
87 pub channel_id: [u8; 32],
88 /// A possibly human-readable error description.
89 /// The string should be sanitized before it is used (e.g. emitted to logs
90 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
91 /// vulnerability in the terminal emulator or the logging subsystem.
95 /// A ping message to be sent or received from a peer
96 #[derive(Clone, Debug, PartialEq)]
98 /// The desired response length
100 /// The ping packet size.
101 /// This field is not sent on the wire. byteslen zeros are sent.
105 /// A pong message to be sent or received from a peer
106 #[derive(Clone, Debug, PartialEq)]
108 /// The pong packet size.
109 /// This field is not sent on the wire. byteslen zeros are sent.
113 /// An open_channel message to be sent or received from a peer
114 #[derive(Clone, Debug, PartialEq)]
115 pub struct OpenChannel {
116 /// The genesis hash of the blockchain where the channel is to be opened
117 pub chain_hash: BlockHash,
118 /// A temporary channel ID, until the funding outpoint is announced
119 pub temporary_channel_id: [u8; 32],
120 /// The channel value
121 pub funding_satoshis: u64,
122 /// The amount to push to the counterparty as part of the open, in milli-satoshi
124 /// The threshold below which outputs on transactions broadcast by sender will be omitted
125 pub dust_limit_satoshis: u64,
126 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
127 pub max_htlc_value_in_flight_msat: u64,
128 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
129 pub channel_reserve_satoshis: u64,
130 /// The minimum HTLC size incoming to sender, in milli-satoshi
131 pub htlc_minimum_msat: u64,
132 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
133 pub feerate_per_kw: u32,
134 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
135 pub to_self_delay: u16,
136 /// The maximum number of inbound HTLCs towards sender
137 pub max_accepted_htlcs: u16,
138 /// The sender's key controlling the funding transaction
139 pub funding_pubkey: PublicKey,
140 /// Used to derive a revocation key for transactions broadcast by counterparty
141 pub revocation_basepoint: PublicKey,
142 /// A payment key to sender for transactions broadcast by counterparty
143 pub payment_point: PublicKey,
144 /// Used to derive a payment key to sender for transactions broadcast by sender
145 pub delayed_payment_basepoint: PublicKey,
146 /// Used to derive an HTLC payment key to sender
147 pub htlc_basepoint: PublicKey,
148 /// The first to-be-broadcast-by-sender transaction's per commitment point
149 pub first_per_commitment_point: PublicKey,
151 pub channel_flags: u8,
152 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
153 pub shutdown_scriptpubkey: OptionalField<Script>,
154 /// The channel type that this channel will represent. If none is set, we derive the channel
155 /// type from the intersection of our feature bits with our counterparty's feature bits from
156 /// the Init message.
157 pub channel_type: Option<ChannelTypeFeatures>,
160 /// An accept_channel message to be sent or received from a peer
161 #[derive(Clone, Debug, PartialEq)]
162 pub struct AcceptChannel {
163 /// A temporary channel ID, until the funding outpoint is announced
164 pub temporary_channel_id: [u8; 32],
165 /// The threshold below which outputs on transactions broadcast by sender will be omitted
166 pub dust_limit_satoshis: u64,
167 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
168 pub max_htlc_value_in_flight_msat: u64,
169 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
170 pub channel_reserve_satoshis: u64,
171 /// The minimum HTLC size incoming to sender, in milli-satoshi
172 pub htlc_minimum_msat: u64,
173 /// Minimum depth of the funding transaction before the channel is considered open
174 pub minimum_depth: u32,
175 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
176 pub to_self_delay: u16,
177 /// The maximum number of inbound HTLCs towards sender
178 pub max_accepted_htlcs: u16,
179 /// The sender's key controlling the funding transaction
180 pub funding_pubkey: PublicKey,
181 /// Used to derive a revocation key for transactions broadcast by counterparty
182 pub revocation_basepoint: PublicKey,
183 /// A payment key to sender for transactions broadcast by counterparty
184 pub payment_point: PublicKey,
185 /// Used to derive a payment key to sender for transactions broadcast by sender
186 pub delayed_payment_basepoint: PublicKey,
187 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
188 pub htlc_basepoint: PublicKey,
189 /// The first to-be-broadcast-by-sender transaction's per commitment point
190 pub first_per_commitment_point: PublicKey,
191 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
192 pub shutdown_scriptpubkey: OptionalField<Script>,
195 /// A funding_created message to be sent or received from a peer
196 #[derive(Clone, Debug, PartialEq)]
197 pub struct FundingCreated {
198 /// A temporary channel ID, until the funding is established
199 pub temporary_channel_id: [u8; 32],
200 /// The funding transaction ID
201 pub funding_txid: Txid,
202 /// The specific output index funding this channel
203 pub funding_output_index: u16,
204 /// The signature of the channel initiator (funder) on the initial commitment transaction
205 pub signature: Signature,
208 /// A funding_signed message to be sent or received from a peer
209 #[derive(Clone, Debug, PartialEq)]
210 pub struct FundingSigned {
212 pub channel_id: [u8; 32],
213 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
214 pub signature: Signature,
217 /// A funding_locked message to be sent or received from a peer
218 #[derive(Clone, Debug, PartialEq)]
219 pub struct FundingLocked {
221 pub channel_id: [u8; 32],
222 /// The per-commitment point of the second commitment transaction
223 pub next_per_commitment_point: PublicKey,
226 /// A shutdown message to be sent or received from a peer
227 #[derive(Clone, Debug, PartialEq)]
228 pub struct Shutdown {
230 pub channel_id: [u8; 32],
231 /// The destination of this peer's funds on closing.
232 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
233 pub scriptpubkey: Script,
236 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
237 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
239 #[derive(Clone, Debug, PartialEq)]
240 pub struct ClosingSignedFeeRange {
241 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
243 pub min_fee_satoshis: u64,
244 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
246 pub max_fee_satoshis: u64,
249 /// A closing_signed message to be sent or received from a peer
250 #[derive(Clone, Debug, PartialEq)]
251 pub struct ClosingSigned {
253 pub channel_id: [u8; 32],
254 /// The proposed total fee for the closing transaction
255 pub fee_satoshis: u64,
256 /// A signature on the closing transaction
257 pub signature: Signature,
258 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
260 pub fee_range: Option<ClosingSignedFeeRange>,
263 /// An update_add_htlc message to be sent or received from a peer
264 #[derive(Clone, Debug, PartialEq)]
265 pub struct UpdateAddHTLC {
267 pub channel_id: [u8; 32],
270 /// The HTLC value in milli-satoshi
271 pub amount_msat: u64,
272 /// The payment hash, the pre-image of which controls HTLC redemption
273 pub payment_hash: PaymentHash,
274 /// The expiry height of the HTLC
275 pub cltv_expiry: u32,
276 pub(crate) onion_routing_packet: OnionPacket,
279 /// An update_fulfill_htlc message to be sent or received from a peer
280 #[derive(Clone, Debug, PartialEq)]
281 pub struct UpdateFulfillHTLC {
283 pub channel_id: [u8; 32],
286 /// The pre-image of the payment hash, allowing HTLC redemption
287 pub payment_preimage: PaymentPreimage,
290 /// An update_fail_htlc message to be sent or received from a peer
291 #[derive(Clone, Debug, PartialEq)]
292 pub struct UpdateFailHTLC {
294 pub channel_id: [u8; 32],
297 pub(crate) reason: OnionErrorPacket,
300 /// An update_fail_malformed_htlc message to be sent or received from a peer
301 #[derive(Clone, Debug, PartialEq)]
302 pub struct UpdateFailMalformedHTLC {
304 pub channel_id: [u8; 32],
307 pub(crate) sha256_of_onion: [u8; 32],
309 pub failure_code: u16,
312 /// A commitment_signed message to be sent or received from a peer
313 #[derive(Clone, Debug, PartialEq)]
314 pub struct CommitmentSigned {
316 pub channel_id: [u8; 32],
317 /// A signature on the commitment transaction
318 pub signature: Signature,
319 /// Signatures on the HTLC transactions
320 pub htlc_signatures: Vec<Signature>,
323 /// A revoke_and_ack message to be sent or received from a peer
324 #[derive(Clone, Debug, PartialEq)]
325 pub struct RevokeAndACK {
327 pub channel_id: [u8; 32],
328 /// The secret corresponding to the per-commitment point
329 pub per_commitment_secret: [u8; 32],
330 /// The next sender-broadcast commitment transaction's per-commitment point
331 pub next_per_commitment_point: PublicKey,
334 /// An update_fee message to be sent or received from a peer
335 #[derive(Clone, Debug, PartialEq)]
336 pub struct UpdateFee {
338 pub channel_id: [u8; 32],
339 /// Fee rate per 1000-weight of the transaction
340 pub feerate_per_kw: u32,
343 #[derive(Clone, Debug, PartialEq)]
344 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
345 /// This is used to convince the recipient that the channel is at a certain commitment
346 /// number even if they lost that data due to a local failure. Of course, the peer may lie
347 /// and even later commitments may have been revoked.
348 pub struct DataLossProtect {
349 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
350 /// belonging to the recipient
351 pub your_last_per_commitment_secret: [u8; 32],
352 /// The sender's per-commitment point for their current commitment transaction
353 pub my_current_per_commitment_point: PublicKey,
356 /// A channel_reestablish message to be sent or received from a peer
357 #[derive(Clone, Debug, PartialEq)]
358 pub struct ChannelReestablish {
360 pub channel_id: [u8; 32],
361 /// The next commitment number for the sender
362 pub next_local_commitment_number: u64,
363 /// The next commitment number for the recipient
364 pub next_remote_commitment_number: u64,
365 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
366 pub data_loss_protect: OptionalField<DataLossProtect>,
369 /// An announcement_signatures message to be sent or received from a peer
370 #[derive(Clone, Debug, PartialEq)]
371 pub struct AnnouncementSignatures {
373 pub channel_id: [u8; 32],
374 /// The short channel ID
375 pub short_channel_id: u64,
376 /// A signature by the node key
377 pub node_signature: Signature,
378 /// A signature by the funding key
379 pub bitcoin_signature: Signature,
382 /// An address which can be used to connect to a remote peer
383 #[derive(Clone, Debug, PartialEq)]
384 pub enum NetAddress {
385 /// An IPv4 address/port on which the peer is listening.
387 /// The 4-byte IPv4 address
389 /// The port on which the node is listening
392 /// An IPv6 address/port on which the peer is listening.
394 /// The 16-byte IPv6 address
396 /// The port on which the node is listening
399 /// An old-style Tor onion address/port on which the peer is listening.
401 /// The bytes (usually encoded in base32 with ".onion" appended)
403 /// The port on which the node is listening
406 /// A new-style Tor onion address/port on which the peer is listening.
407 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
408 /// wrap as base32 and append ".onion".
410 /// The ed25519 long-term public key of the peer
411 ed25519_pubkey: [u8; 32],
412 /// The checksum of the pubkey and version, as included in the onion address
414 /// The version byte, as defined by the Tor Onion v3 spec.
416 /// The port on which the node is listening
421 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
423 pub(crate) fn get_id(&self) -> u8 {
425 &NetAddress::IPv4 {..} => { 1 },
426 &NetAddress::IPv6 {..} => { 2 },
427 &NetAddress::OnionV2 {..} => { 3 },
428 &NetAddress::OnionV3 {..} => { 4 },
432 /// Strict byte-length of address descriptor, 1-byte type not recorded
433 fn len(&self) -> u16 {
435 &NetAddress::IPv4 { .. } => { 6 },
436 &NetAddress::IPv6 { .. } => { 18 },
437 &NetAddress::OnionV2 { .. } => { 12 },
438 &NetAddress::OnionV3 { .. } => { 37 },
442 /// The maximum length of any address descriptor, not including the 1-byte type
443 pub(crate) const MAX_LEN: u16 = 37;
446 impl Writeable for NetAddress {
447 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
449 &NetAddress::IPv4 { ref addr, ref port } => {
454 &NetAddress::IPv6 { ref addr, ref port } => {
459 &NetAddress::OnionV2 { ref addr, ref port } => {
464 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
466 ed25519_pubkey.write(writer)?;
467 checksum.write(writer)?;
468 version.write(writer)?;
476 impl Readable for Result<NetAddress, u8> {
477 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
478 let byte = <u8 as Readable>::read(reader)?;
481 Ok(Ok(NetAddress::IPv4 {
482 addr: Readable::read(reader)?,
483 port: Readable::read(reader)?,
487 Ok(Ok(NetAddress::IPv6 {
488 addr: Readable::read(reader)?,
489 port: Readable::read(reader)?,
493 Ok(Ok(NetAddress::OnionV2 {
494 addr: Readable::read(reader)?,
495 port: Readable::read(reader)?,
499 Ok(Ok(NetAddress::OnionV3 {
500 ed25519_pubkey: Readable::read(reader)?,
501 checksum: Readable::read(reader)?,
502 version: Readable::read(reader)?,
503 port: Readable::read(reader)?,
506 _ => return Ok(Err(byte)),
511 impl Readable for NetAddress {
512 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
513 match Readable::read(reader) {
514 Ok(Ok(res)) => Ok(res),
515 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
522 /// The unsigned part of a node_announcement
523 #[derive(Clone, Debug, PartialEq)]
524 pub struct UnsignedNodeAnnouncement {
525 /// The advertised features
526 pub features: NodeFeatures,
527 /// A strictly monotonic announcement counter, with gaps allowed
529 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
531 pub node_id: PublicKey,
532 /// An RGB color for UI purposes
534 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
537 /// List of addresses on which this node is reachable
538 pub addresses: Vec<NetAddress>,
539 pub(crate) excess_address_data: Vec<u8>,
540 pub(crate) excess_data: Vec<u8>,
542 #[derive(Clone, Debug, PartialEq)]
543 /// A node_announcement message to be sent or received from a peer
544 pub struct NodeAnnouncement {
545 /// The signature by the node key
546 pub signature: Signature,
547 /// The actual content of the announcement
548 pub contents: UnsignedNodeAnnouncement,
551 /// The unsigned part of a channel_announcement
552 #[derive(Clone, Debug, PartialEq)]
553 pub struct UnsignedChannelAnnouncement {
554 /// The advertised channel features
555 pub features: ChannelFeatures,
556 /// The genesis hash of the blockchain where the channel is to be opened
557 pub chain_hash: BlockHash,
558 /// The short channel ID
559 pub short_channel_id: u64,
560 /// One of the two node_ids which are endpoints of this channel
561 pub node_id_1: PublicKey,
562 /// The other of the two node_ids which are endpoints of this channel
563 pub node_id_2: PublicKey,
564 /// The funding key for the first node
565 pub bitcoin_key_1: PublicKey,
566 /// The funding key for the second node
567 pub bitcoin_key_2: PublicKey,
568 pub(crate) excess_data: Vec<u8>,
570 /// A channel_announcement message to be sent or received from a peer
571 #[derive(Clone, Debug, PartialEq)]
572 pub struct ChannelAnnouncement {
573 /// Authentication of the announcement by the first public node
574 pub node_signature_1: Signature,
575 /// Authentication of the announcement by the second public node
576 pub node_signature_2: Signature,
577 /// Proof of funding UTXO ownership by the first public node
578 pub bitcoin_signature_1: Signature,
579 /// Proof of funding UTXO ownership by the second public node
580 pub bitcoin_signature_2: Signature,
581 /// The actual announcement
582 pub contents: UnsignedChannelAnnouncement,
585 /// The unsigned part of a channel_update
586 #[derive(Clone, Debug, PartialEq)]
587 pub struct UnsignedChannelUpdate {
588 /// The genesis hash of the blockchain where the channel is to be opened
589 pub chain_hash: BlockHash,
590 /// The short channel ID
591 pub short_channel_id: u64,
592 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
596 /// The number of blocks such that if:
597 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
598 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
599 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
600 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
601 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
602 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
603 /// constructing the route.
604 pub cltv_expiry_delta: u16,
605 /// The minimum HTLC size incoming to sender, in milli-satoshi
606 pub htlc_minimum_msat: u64,
607 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
608 pub htlc_maximum_msat: OptionalField<u64>,
609 /// The base HTLC fee charged by sender, in milli-satoshi
610 pub fee_base_msat: u32,
611 /// The amount to fee multiplier, in micro-satoshi
612 pub fee_proportional_millionths: u32,
613 pub(crate) excess_data: Vec<u8>,
615 /// A channel_update message to be sent or received from a peer
616 #[derive(Clone, Debug, PartialEq)]
617 pub struct ChannelUpdate {
618 /// A signature of the channel update
619 pub signature: Signature,
620 /// The actual channel update
621 pub contents: UnsignedChannelUpdate,
624 /// A query_channel_range message is used to query a peer for channel
625 /// UTXOs in a range of blocks. The recipient of a query makes a best
626 /// effort to reply to the query using one or more reply_channel_range
628 #[derive(Clone, Debug, PartialEq)]
629 pub struct QueryChannelRange {
630 /// The genesis hash of the blockchain being queried
631 pub chain_hash: BlockHash,
632 /// The height of the first block for the channel UTXOs being queried
633 pub first_blocknum: u32,
634 /// The number of blocks to include in the query results
635 pub number_of_blocks: u32,
638 /// A reply_channel_range message is a reply to a query_channel_range
639 /// message. Multiple reply_channel_range messages can be sent in reply
640 /// to a single query_channel_range message. The query recipient makes a
641 /// best effort to respond based on their local network view which may
642 /// not be a perfect view of the network. The short_channel_ids in the
643 /// reply are encoded. We only support encoding_type=0 uncompressed
644 /// serialization and do not support encoding_type=1 zlib serialization.
645 #[derive(Clone, Debug, PartialEq)]
646 pub struct ReplyChannelRange {
647 /// The genesis hash of the blockchain being queried
648 pub chain_hash: BlockHash,
649 /// The height of the first block in the range of the reply
650 pub first_blocknum: u32,
651 /// The number of blocks included in the range of the reply
652 pub number_of_blocks: u32,
653 /// True when this is the final reply for a query
654 pub sync_complete: bool,
655 /// The short_channel_ids in the channel range
656 pub short_channel_ids: Vec<u64>,
659 /// A query_short_channel_ids message is used to query a peer for
660 /// routing gossip messages related to one or more short_channel_ids.
661 /// The query recipient will reply with the latest, if available,
662 /// channel_announcement, channel_update and node_announcement messages
663 /// it maintains for the requested short_channel_ids followed by a
664 /// reply_short_channel_ids_end message. The short_channel_ids sent in
665 /// this query are encoded. We only support encoding_type=0 uncompressed
666 /// serialization and do not support encoding_type=1 zlib serialization.
667 #[derive(Clone, Debug, PartialEq)]
668 pub struct QueryShortChannelIds {
669 /// The genesis hash of the blockchain being queried
670 pub chain_hash: BlockHash,
671 /// The short_channel_ids that are being queried
672 pub short_channel_ids: Vec<u64>,
675 /// A reply_short_channel_ids_end message is sent as a reply to a
676 /// query_short_channel_ids message. The query recipient makes a best
677 /// effort to respond based on their local network view which may not be
678 /// a perfect view of the network.
679 #[derive(Clone, Debug, PartialEq)]
680 pub struct ReplyShortChannelIdsEnd {
681 /// The genesis hash of the blockchain that was queried
682 pub chain_hash: BlockHash,
683 /// Indicates if the query recipient maintains up-to-date channel
684 /// information for the chain_hash
685 pub full_information: bool,
688 /// A gossip_timestamp_filter message is used by a node to request
689 /// gossip relay for messages in the requested time range when the
690 /// gossip_queries feature has been negotiated.
691 #[derive(Clone, Debug, PartialEq)]
692 pub struct GossipTimestampFilter {
693 /// The genesis hash of the blockchain for channel and node information
694 pub chain_hash: BlockHash,
695 /// The starting unix timestamp
696 pub first_timestamp: u32,
697 /// The range of information in seconds
698 pub timestamp_range: u32,
701 /// Encoding type for data compression of collections in gossip queries.
702 #[derive(Clone, Copy, Debug, PartialEq)]
703 pub enum GossipEncodingType {
704 // Note that the enum variants here are defined to the values as used in message encodings.
705 // Because they currently match the bit indexes for the gossip encodings field in Init they are
706 // re-used there. If future encodings have different bit positions from encoding fields, code
707 // in Init (de-)serialization will need to adapt.
708 /// Uncompressed gossip query messages sent as-is on the wire
710 /// Gossip messages compressed with the zlib compression algorithm.
711 /// For security reasons, we do not implement this or recommend anyone implement this.
714 const KNOWN_ENCODINGS: [GossipEncodingType; 2] = [GossipEncodingType::Uncompressed, GossipEncodingType::Zlib];
715 /// The gossip encodings which we support here. Note that due to security concerns we do not
716 /// support reading zlib-compressed gossip messages.
717 pub const SUPPORTED_GOSSIP_ENCODINGS: [GossipEncodingType; 1] = [GossipEncodingType::Uncompressed];
719 /// Used to put an error message in a LightningError
720 #[derive(Clone, Debug)]
721 pub enum ErrorAction {
722 /// The peer took some action which made us think they were useless. Disconnect them.
724 /// An error message which we should make an effort to send before we disconnect.
725 msg: Option<ErrorMessage>
727 /// The peer did something harmless that we weren't able to process, just log and ignore
728 // New code should *not* use this. New code must use IgnoreAndLog, below!
730 /// The peer did something harmless that we weren't able to meaningfully process.
731 /// If the error is logged, log it at the given level.
732 IgnoreAndLog(logger::Level),
733 /// The peer did something incorrect. Tell them.
735 /// The message to send.
740 /// An Err type for failure to process messages.
741 #[derive(Clone, Debug)]
742 pub struct LightningError {
743 /// A human-readable message describing the error
745 /// The action which should be taken against the offending peer.
746 pub action: ErrorAction,
749 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
750 /// transaction updates if they were pending.
751 #[derive(Clone, Debug, PartialEq)]
752 pub struct CommitmentUpdate {
753 /// update_add_htlc messages which should be sent
754 pub update_add_htlcs: Vec<UpdateAddHTLC>,
755 /// update_fulfill_htlc messages which should be sent
756 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
757 /// update_fail_htlc messages which should be sent
758 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
759 /// update_fail_malformed_htlc messages which should be sent
760 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
761 /// An update_fee message which should be sent
762 pub update_fee: Option<UpdateFee>,
763 /// Finally, the commitment_signed message which should be sent
764 pub commitment_signed: CommitmentSigned,
767 /// Messages could have optional fields to use with extended features
768 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
769 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
770 /// separate enum type for them.
771 /// (C-not exported) due to a free generic in T
772 #[derive(Clone, Debug, PartialEq)]
773 pub enum OptionalField<T> {
774 /// Optional field is included in message
776 /// Optional field is absent in message
780 /// A trait to describe an object which can receive channel messages.
782 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
783 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
784 pub trait ChannelMessageHandler : MessageSendEventsProvider {
786 /// Handle an incoming open_channel message from the given peer.
787 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
788 /// Handle an incoming accept_channel message from the given peer.
789 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
790 /// Handle an incoming funding_created message from the given peer.
791 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
792 /// Handle an incoming funding_signed message from the given peer.
793 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
794 /// Handle an incoming funding_locked message from the given peer.
795 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
798 /// Handle an incoming shutdown message from the given peer.
799 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
800 /// Handle an incoming closing_signed message from the given peer.
801 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
804 /// Handle an incoming update_add_htlc message from the given peer.
805 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
806 /// Handle an incoming update_fulfill_htlc message from the given peer.
807 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
808 /// Handle an incoming update_fail_htlc message from the given peer.
809 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
810 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
811 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
812 /// Handle an incoming commitment_signed message from the given peer.
813 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
814 /// Handle an incoming revoke_and_ack message from the given peer.
815 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
817 /// Handle an incoming update_fee message from the given peer.
818 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
820 // Channel-to-announce:
821 /// Handle an incoming announcement_signatures message from the given peer.
822 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
824 // Connection loss/reestablish:
825 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
826 /// is believed to be possible in the future (eg they're sending us messages we don't
827 /// understand or indicate they require unknown feature bits), no_connection_possible is set
828 /// and any outstanding channels should be failed.
829 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
831 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
832 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
833 /// Handle an incoming channel_reestablish message from the given peer.
834 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
836 /// Handle an incoming channel update from the given peer.
837 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
840 /// Handle an incoming error message from the given peer.
841 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
844 /// A trait to describe an object which can receive routing messages.
846 /// # Implementor DoS Warnings
848 /// For `gossip_queries` messages there are potential DoS vectors when handling
849 /// inbound queries. Implementors using an on-disk network graph should be aware of
850 /// repeated disk I/O for queries accessing different parts of the network graph.
851 pub trait RoutingMessageHandler : MessageSendEventsProvider {
852 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
853 /// false or returning an Err otherwise.
854 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
855 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
856 /// or returning an Err otherwise.
857 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
858 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
859 /// false or returning an Err otherwise.
860 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
861 /// Gets a subset of the channel announcements and updates required to dump our routing table
862 /// to a remote node, starting at the short_channel_id indicated by starting_point and
863 /// including the batch_amount entries immediately higher in numerical value than starting_point.
864 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
865 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
866 /// starting at the node *after* the provided publickey and including batch_amount entries
867 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
868 /// If None is provided for starting_point, we start at the first node.
869 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
870 /// Called when a connection is established with a peer. This can be used to
871 /// perform routing table synchronization using a strategy defined by the
873 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
874 /// Handles the reply of a query we initiated to learn about channels
875 /// for a given range of blocks. We can expect to receive one or more
876 /// replies to a single query.
877 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
878 /// Handles the reply of a query we initiated asking for routing gossip
879 /// messages for a list of channels. We should receive this message when
880 /// a node has completed its best effort to send us the pertaining routing
882 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
883 /// Handles when a peer asks us to send a list of short_channel_ids
884 /// for the requested range of blocks.
885 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
886 /// Handles when a peer asks us to send routing gossip messages for a
887 /// list of short_channel_ids.
888 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
891 mod fuzzy_internal_msgs {
893 use ln::{PaymentPreimage, PaymentSecret};
895 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
896 // them from untrusted input):
898 pub(crate) struct FinalOnionHopData {
899 pub(crate) payment_secret: PaymentSecret,
900 /// The total value, in msat, of the payment as received by the ultimate recipient.
901 /// Message serialization may panic if this value is more than 21 million Bitcoin.
902 pub(crate) total_msat: u64,
905 pub(crate) enum OnionHopDataFormat {
906 Legacy { // aka Realm-0
907 short_channel_id: u64,
910 short_channel_id: u64,
913 payment_data: Option<FinalOnionHopData>,
914 keysend_preimage: Option<PaymentPreimage>,
918 pub struct OnionHopData {
919 pub(crate) format: OnionHopDataFormat,
920 /// The value, in msat, of the payment after this hop's fee is deducted.
921 /// Message serialization may panic if this value is more than 21 million Bitcoin.
922 pub(crate) amt_to_forward: u64,
923 pub(crate) outgoing_cltv_value: u32,
924 // 12 bytes of 0-padding for Legacy format
927 pub struct DecodedOnionErrorPacket {
928 pub(crate) hmac: [u8; 32],
929 pub(crate) failuremsg: Vec<u8>,
930 pub(crate) pad: Vec<u8>,
933 #[cfg(feature = "fuzztarget")]
934 pub use self::fuzzy_internal_msgs::*;
935 #[cfg(not(feature = "fuzztarget"))]
936 pub(crate) use self::fuzzy_internal_msgs::*;
939 pub(crate) struct OnionPacket {
940 pub(crate) version: u8,
941 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
942 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
943 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
944 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
945 pub(crate) hop_data: [u8; 20*65],
946 pub(crate) hmac: [u8; 32],
949 impl PartialEq for OnionPacket {
950 fn eq(&self, other: &OnionPacket) -> bool {
951 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
952 if i != j { return false; }
954 self.version == other.version &&
955 self.public_key == other.public_key &&
956 self.hmac == other.hmac
960 impl fmt::Debug for OnionPacket {
961 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
962 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
966 #[derive(Clone, Debug, PartialEq)]
967 pub(crate) struct OnionErrorPacket {
968 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
969 // (TODO) We limit it in decode to much lower...
970 pub(crate) data: Vec<u8>,
973 impl fmt::Display for DecodeError {
974 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
976 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
977 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
978 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
979 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
980 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
981 DecodeError::Io(ref e) => e.fmt(f),
982 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
987 impl From<io::Error> for DecodeError {
988 fn from(e: io::Error) -> Self {
989 if e.kind() == io::ErrorKind::UnexpectedEof {
990 DecodeError::ShortRead
992 DecodeError::Io(e.kind())
997 impl Writeable for OptionalField<Script> {
998 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1000 OptionalField::Present(ref script) => {
1001 // Note that Writeable for script includes the 16-bit length tag for us
1004 OptionalField::Absent => {}
1010 impl Readable for OptionalField<Script> {
1011 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1012 match <u16 as Readable>::read(r) {
1014 let mut buf = vec![0; len as usize];
1015 r.read_exact(&mut buf)?;
1016 Ok(OptionalField::Present(Script::from(buf)))
1018 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1024 impl Writeable for OptionalField<u64> {
1025 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1027 OptionalField::Present(ref value) => {
1030 OptionalField::Absent => {}
1036 impl Readable for OptionalField<u64> {
1037 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1038 let value: u64 = Readable::read(r)?;
1039 Ok(OptionalField::Present(value))
1044 impl_writeable_msg!(AcceptChannel, {
1045 temporary_channel_id,
1046 dust_limit_satoshis,
1047 max_htlc_value_in_flight_msat,
1048 channel_reserve_satoshis,
1054 revocation_basepoint,
1056 delayed_payment_basepoint,
1058 first_per_commitment_point,
1059 shutdown_scriptpubkey
1062 impl_writeable_msg!(AnnouncementSignatures, {
1069 impl Writeable for ChannelReestablish {
1070 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1071 self.channel_id.write(w)?;
1072 self.next_local_commitment_number.write(w)?;
1073 self.next_remote_commitment_number.write(w)?;
1074 match self.data_loss_protect {
1075 OptionalField::Present(ref data_loss_protect) => {
1076 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1077 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1079 OptionalField::Absent => {}
1085 impl Readable for ChannelReestablish{
1086 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1088 channel_id: Readable::read(r)?,
1089 next_local_commitment_number: Readable::read(r)?,
1090 next_remote_commitment_number: Readable::read(r)?,
1091 data_loss_protect: {
1092 match <[u8; 32] as Readable>::read(r) {
1093 Ok(your_last_per_commitment_secret) =>
1094 OptionalField::Present(DataLossProtect {
1095 your_last_per_commitment_secret,
1096 my_current_per_commitment_point: Readable::read(r)?,
1098 Err(DecodeError::ShortRead) => OptionalField::Absent,
1099 Err(e) => return Err(e)
1106 impl_writeable_msg!(ClosingSigned,
1107 { channel_id, fee_satoshis, signature },
1108 { (1, fee_range, option) }
1111 impl_writeable!(ClosingSignedFeeRange, {
1116 impl_writeable_msg!(CommitmentSigned, {
1122 impl_writeable!(DecodedOnionErrorPacket, {
1128 impl_writeable_msg!(FundingCreated, {
1129 temporary_channel_id,
1131 funding_output_index,
1135 impl_writeable_msg!(FundingSigned, {
1140 impl_writeable_msg!(FundingLocked, {
1142 next_per_commitment_point,
1145 impl Writeable for Init {
1146 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1147 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1148 // our relevant feature bits. This keeps us compatible with old nodes.
1149 self.features.write_up_to_13(w)?;
1150 self.features.write(w)?;
1151 let mut highest_gossip_encoding = 0;
1152 for enc in self.gossip_compression_encodings.iter() {
1153 highest_gossip_encoding = cmp::max(1 << (*enc as u8), highest_gossip_encoding);
1155 let mut gossip_compression_bits = Vec::new();
1156 gossip_compression_bits.resize(((highest_gossip_encoding + 7) / 8) as usize, 0);
1157 for enc in self.gossip_compression_encodings.iter() {
1158 let val = 1u32 << (*enc as u8);
1159 gossip_compression_bits[(val / 8) as usize] |= (val % 8) as u8;
1161 encode_tlv_stream!(w, {
1162 // 1 - networks field to list genesis block hashes
1163 (3, IterWriteWrapper(gossip_compression_bits.iter()), required)
1169 impl Readable for Init {
1170 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1171 let global_features: InitFeatures = Readable::read(r)?;
1172 let features: InitFeatures = Readable::read(r)?;
1173 let mut gossip_compression_bits = Some(Vec::<u8>::new());
1174 decode_tlv_stream!(r, {
1175 // 1 - networks field to list genesis block hashes
1176 (3, gossip_compression_bits, vec_type),
1178 let gossip_compression_bits = gossip_compression_bits.unwrap();
1179 let mut gossip_compression_encodings = Vec::new();
1180 for encoding in &KNOWN_ENCODINGS {
1181 let enc_val = 1u32 << (*encoding as u8);
1182 if gossip_compression_bits.len() <= (enc_val / 8) as usize { continue; }
1183 if gossip_compression_bits[(enc_val / 8) as usize] & (enc_val % 8) as u8 != 0 {
1184 gossip_compression_encodings.push(*encoding);
1188 features: features.or(global_features),
1189 gossip_compression_encodings,
1194 impl_writeable_msg!(OpenChannel, {
1196 temporary_channel_id,
1199 dust_limit_satoshis,
1200 max_htlc_value_in_flight_msat,
1201 channel_reserve_satoshis,
1207 revocation_basepoint,
1209 delayed_payment_basepoint,
1211 first_per_commitment_point,
1213 shutdown_scriptpubkey
1215 (1, channel_type, option),
1218 impl_writeable_msg!(RevokeAndACK, {
1220 per_commitment_secret,
1221 next_per_commitment_point
1224 impl_writeable_msg!(Shutdown, {
1229 impl_writeable_msg!(UpdateFailHTLC, {
1235 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1242 impl_writeable_msg!(UpdateFee, {
1247 impl_writeable_msg!(UpdateFulfillHTLC, {
1253 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1254 // serialization format in a way which assumes we know the total serialized length/message end
1256 impl_writeable!(OnionErrorPacket, {
1260 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1261 // serialization format in a way which assumes we know the total serialized length/message end
1263 impl Writeable for OnionPacket {
1264 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1265 self.version.write(w)?;
1266 match self.public_key {
1267 Ok(pubkey) => pubkey.write(w)?,
1268 Err(_) => [0u8;33].write(w)?,
1270 w.write_all(&self.hop_data)?;
1271 self.hmac.write(w)?;
1276 impl Readable for OnionPacket {
1277 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1279 version: Readable::read(r)?,
1281 let mut buf = [0u8;33];
1282 r.read_exact(&mut buf)?;
1283 PublicKey::from_slice(&buf)
1285 hop_data: Readable::read(r)?,
1286 hmac: Readable::read(r)?,
1291 impl_writeable_msg!(UpdateAddHTLC, {
1297 onion_routing_packet
1300 impl Writeable for FinalOnionHopData {
1301 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1302 self.payment_secret.0.write(w)?;
1303 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1307 impl Readable for FinalOnionHopData {
1308 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1309 let secret: [u8; 32] = Readable::read(r)?;
1310 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1311 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1315 impl Writeable for OnionHopData {
1316 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1317 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1318 // check values are sane long before we get here, though its possible in the future
1319 // user-generated messages may hit this.
1320 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1322 OnionHopDataFormat::Legacy { short_channel_id } => {
1324 short_channel_id.write(w)?;
1325 self.amt_to_forward.write(w)?;
1326 self.outgoing_cltv_value.write(w)?;
1327 w.write_all(&[0;12])?;
1329 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1330 encode_varint_length_prefixed_tlv!(w, {
1331 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1332 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1333 (6, short_channel_id, required)
1336 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1337 if let Some(final_data) = payment_data {
1338 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1340 encode_varint_length_prefixed_tlv!(w, {
1341 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1342 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1343 (8, payment_data, option),
1344 (5482373484, keysend_preimage, option)
1352 impl Readable for OnionHopData {
1353 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1354 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1355 let v: VarInt = Decodable::consensus_decode(&mut r)
1356 .map_err(|e| match e {
1357 Error::Io(ioe) => DecodeError::from(ioe),
1358 _ => DecodeError::InvalidValue
1360 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1361 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1362 let mut rd = FixedLengthReader::new(r, v.0);
1363 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1364 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1365 let mut short_id: Option<u64> = None;
1366 let mut payment_data: Option<FinalOnionHopData> = None;
1367 let mut keysend_preimage: Option<PaymentPreimage> = None;
1368 // The TLV type is chosen to be compatible with lnd and c-lightning.
1369 decode_tlv_stream!(&mut rd, {
1371 (4, cltv_value, required),
1372 (6, short_id, option),
1373 (8, payment_data, option),
1374 (5482373484, keysend_preimage, option)
1376 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1377 let format = if let Some(short_channel_id) = short_id {
1378 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1379 OnionHopDataFormat::NonFinalNode {
1383 if let &Some(ref data) = &payment_data {
1384 if data.total_msat > MAX_VALUE_MSAT {
1385 return Err(DecodeError::InvalidValue);
1388 OnionHopDataFormat::FinalNode {
1393 (format, amt.0, cltv_value.0)
1395 let format = OnionHopDataFormat::Legacy {
1396 short_channel_id: Readable::read(r)?,
1398 let amt: u64 = Readable::read(r)?;
1399 let cltv_value: u32 = Readable::read(r)?;
1400 r.read_exact(&mut [0; 12])?;
1401 (format, amt, cltv_value)
1404 if amt > MAX_VALUE_MSAT {
1405 return Err(DecodeError::InvalidValue);
1409 amt_to_forward: amt,
1410 outgoing_cltv_value: cltv_value,
1415 impl Writeable for Ping {
1416 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1417 self.ponglen.write(w)?;
1418 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1423 impl Readable for Ping {
1424 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1426 ponglen: Readable::read(r)?,
1428 let byteslen = Readable::read(r)?;
1429 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1436 impl Writeable for Pong {
1437 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1438 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1443 impl Readable for Pong {
1444 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1447 let byteslen = Readable::read(r)?;
1448 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1455 impl Writeable for UnsignedChannelAnnouncement {
1456 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1457 self.features.write(w)?;
1458 self.chain_hash.write(w)?;
1459 self.short_channel_id.write(w)?;
1460 self.node_id_1.write(w)?;
1461 self.node_id_2.write(w)?;
1462 self.bitcoin_key_1.write(w)?;
1463 self.bitcoin_key_2.write(w)?;
1464 w.write_all(&self.excess_data[..])?;
1469 impl Readable for UnsignedChannelAnnouncement {
1470 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1472 features: Readable::read(r)?,
1473 chain_hash: Readable::read(r)?,
1474 short_channel_id: Readable::read(r)?,
1475 node_id_1: Readable::read(r)?,
1476 node_id_2: Readable::read(r)?,
1477 bitcoin_key_1: Readable::read(r)?,
1478 bitcoin_key_2: Readable::read(r)?,
1479 excess_data: read_to_end(r)?,
1484 impl_writeable!(ChannelAnnouncement, {
1487 bitcoin_signature_1,
1488 bitcoin_signature_2,
1492 impl Writeable for UnsignedChannelUpdate {
1493 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1494 let mut message_flags: u8 = 0;
1495 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1498 self.chain_hash.write(w)?;
1499 self.short_channel_id.write(w)?;
1500 self.timestamp.write(w)?;
1501 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1502 all_flags.write(w)?;
1503 self.cltv_expiry_delta.write(w)?;
1504 self.htlc_minimum_msat.write(w)?;
1505 self.fee_base_msat.write(w)?;
1506 self.fee_proportional_millionths.write(w)?;
1507 self.htlc_maximum_msat.write(w)?;
1508 w.write_all(&self.excess_data[..])?;
1513 impl Readable for UnsignedChannelUpdate {
1514 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1515 let has_htlc_maximum_msat;
1517 chain_hash: Readable::read(r)?,
1518 short_channel_id: Readable::read(r)?,
1519 timestamp: Readable::read(r)?,
1521 let flags: u16 = Readable::read(r)?;
1522 let message_flags = flags >> 8;
1523 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1526 cltv_expiry_delta: Readable::read(r)?,
1527 htlc_minimum_msat: Readable::read(r)?,
1528 fee_base_msat: Readable::read(r)?,
1529 fee_proportional_millionths: Readable::read(r)?,
1530 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1531 excess_data: read_to_end(r)?,
1536 impl_writeable!(ChannelUpdate, {
1541 impl Writeable for ErrorMessage {
1542 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1543 self.channel_id.write(w)?;
1544 (self.data.len() as u16).write(w)?;
1545 w.write_all(self.data.as_bytes())?;
1550 impl Readable for ErrorMessage {
1551 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1553 channel_id: Readable::read(r)?,
1555 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1556 let data = read_to_end(r)?;
1557 sz = cmp::min(data.len(), sz);
1558 match String::from_utf8(data[..sz as usize].to_vec()) {
1560 Err(_) => return Err(DecodeError::InvalidValue),
1567 impl Writeable for UnsignedNodeAnnouncement {
1568 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1569 self.features.write(w)?;
1570 self.timestamp.write(w)?;
1571 self.node_id.write(w)?;
1572 w.write_all(&self.rgb)?;
1573 self.alias.write(w)?;
1575 let mut addr_len = 0;
1576 for addr in self.addresses.iter() {
1577 addr_len += 1 + addr.len();
1579 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1580 for addr in self.addresses.iter() {
1583 w.write_all(&self.excess_address_data[..])?;
1584 w.write_all(&self.excess_data[..])?;
1589 impl Readable for UnsignedNodeAnnouncement {
1590 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1591 let features: NodeFeatures = Readable::read(r)?;
1592 let timestamp: u32 = Readable::read(r)?;
1593 let node_id: PublicKey = Readable::read(r)?;
1594 let mut rgb = [0; 3];
1595 r.read_exact(&mut rgb)?;
1596 let alias: [u8; 32] = Readable::read(r)?;
1598 let addr_len: u16 = Readable::read(r)?;
1599 let mut addresses: Vec<NetAddress> = Vec::new();
1600 let mut addr_readpos = 0;
1601 let mut excess = false;
1602 let mut excess_byte = 0;
1604 if addr_len <= addr_readpos { break; }
1605 match Readable::read(r) {
1607 if addr_len < addr_readpos + 1 + addr.len() {
1608 return Err(DecodeError::BadLengthDescriptor);
1610 addr_readpos += (1 + addr.len()) as u16;
1611 addresses.push(addr);
1613 Ok(Err(unknown_descriptor)) => {
1615 excess_byte = unknown_descriptor;
1618 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1619 Err(e) => return Err(e),
1623 let mut excess_data = vec![];
1624 let excess_address_data = if addr_readpos < addr_len {
1625 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1626 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1628 excess_address_data[0] = excess_byte;
1633 excess_data.push(excess_byte);
1637 excess_data.extend(read_to_end(r)?.iter());
1638 Ok(UnsignedNodeAnnouncement {
1645 excess_address_data,
1651 impl_writeable!(NodeAnnouncement, {
1656 impl Readable for QueryShortChannelIds {
1657 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1658 let chain_hash: BlockHash = Readable::read(r)?;
1660 let encoding_len: u16 = Readable::read(r)?;
1661 let encoding_type: u8 = Readable::read(r)?;
1663 // Must be encoding_type=0 uncompressed serialization. We do not
1664 // support encoding_type=1 zlib serialization.
1665 if encoding_type != GossipEncodingType::Uncompressed as u8 {
1666 return Err(DecodeError::UnsupportedCompression);
1669 // We expect the encoding_len to always includes the 1-byte
1670 // encoding_type and that short_channel_ids are 8-bytes each
1671 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1672 return Err(DecodeError::InvalidValue);
1675 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1676 // less the 1-byte encoding_type
1677 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1678 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1679 for _ in 0..short_channel_id_count {
1680 short_channel_ids.push(Readable::read(r)?);
1683 Ok(QueryShortChannelIds {
1690 impl Writeable for QueryShortChannelIds {
1691 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1692 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1693 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1695 self.chain_hash.write(w)?;
1696 encoding_len.write(w)?;
1698 // We only support type=0 uncompressed serialization
1699 (GossipEncodingType::Uncompressed as u8).write(w)?;
1701 for scid in self.short_channel_ids.iter() {
1709 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1714 impl QueryChannelRange {
1716 * Calculates the overflow safe ending block height for the query.
1717 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1719 pub fn end_blocknum(&self) -> u32 {
1720 match self.first_blocknum.checked_add(self.number_of_blocks) {
1721 Some(block) => block,
1722 None => u32::max_value(),
1727 impl_writeable_msg!(QueryChannelRange, {
1733 impl Readable for ReplyChannelRange {
1734 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1735 let chain_hash: BlockHash = Readable::read(r)?;
1736 let first_blocknum: u32 = Readable::read(r)?;
1737 let number_of_blocks: u32 = Readable::read(r)?;
1738 let sync_complete: bool = Readable::read(r)?;
1740 let encoding_len: u16 = Readable::read(r)?;
1741 let encoding_type: u8 = Readable::read(r)?;
1743 // Must be encoding_type=0 uncompressed serialization. We do not
1744 // support encoding_type=1 zlib serialization.
1745 if encoding_type != GossipEncodingType::Uncompressed as u8 {
1746 return Err(DecodeError::UnsupportedCompression);
1749 // We expect the encoding_len to always includes the 1-byte
1750 // encoding_type and that short_channel_ids are 8-bytes each
1751 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1752 return Err(DecodeError::InvalidValue);
1755 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1756 // less the 1-byte encoding_type
1757 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1758 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1759 for _ in 0..short_channel_id_count {
1760 short_channel_ids.push(Readable::read(r)?);
1763 Ok(ReplyChannelRange {
1773 impl Writeable for ReplyChannelRange {
1774 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1775 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1776 self.chain_hash.write(w)?;
1777 self.first_blocknum.write(w)?;
1778 self.number_of_blocks.write(w)?;
1779 self.sync_complete.write(w)?;
1781 encoding_len.write(w)?;
1782 (GossipEncodingType::Uncompressed as u8).write(w)?;
1783 for scid in self.short_channel_ids.iter() {
1791 impl_writeable_msg!(GossipTimestampFilter, {
1800 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1801 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1803 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat, GossipEncodingType};
1804 use util::ser::{Writeable, Readable};
1806 use bitcoin::hashes::hex::FromHex;
1807 use bitcoin::util::address::Address;
1808 use bitcoin::network::constants::Network;
1809 use bitcoin::blockdata::script::Builder;
1810 use bitcoin::blockdata::opcodes;
1811 use bitcoin::hash_types::{Txid, BlockHash};
1813 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1814 use bitcoin::secp256k1::{Secp256k1, Message};
1820 fn encoding_channel_reestablish_no_secret() {
1821 let cr = msgs::ChannelReestablish {
1822 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],
1823 next_local_commitment_number: 3,
1824 next_remote_commitment_number: 4,
1825 data_loss_protect: OptionalField::Absent,
1828 let encoded_value = cr.encode();
1831 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]
1836 fn encoding_channel_reestablish_with_secret() {
1838 let secp_ctx = Secp256k1::new();
1839 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1842 let cr = msgs::ChannelReestablish {
1843 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],
1844 next_local_commitment_number: 3,
1845 next_remote_commitment_number: 4,
1846 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1849 let encoded_value = cr.encode();
1852 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]
1856 macro_rules! get_keys_from {
1857 ($slice: expr, $secp_ctx: expr) => {
1859 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1860 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1866 macro_rules! get_sig_on {
1867 ($privkey: expr, $ctx: expr, $string: expr) => {
1869 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1870 $ctx.sign(&sighash, &$privkey)
1876 fn encoding_announcement_signatures() {
1877 let secp_ctx = Secp256k1::new();
1878 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1879 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1880 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1881 let announcement_signatures = msgs::AnnouncementSignatures {
1882 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],
1883 short_channel_id: 2316138423780173,
1884 node_signature: sig_1,
1885 bitcoin_signature: sig_2,
1888 let encoded_value = announcement_signatures.encode();
1889 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1892 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1893 let secp_ctx = Secp256k1::new();
1894 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1895 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1896 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1897 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1898 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1899 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1900 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1901 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1902 let mut features = ChannelFeatures::known();
1903 if unknown_features_bits {
1904 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1906 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1908 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1909 short_channel_id: 2316138423780173,
1910 node_id_1: pubkey_1,
1911 node_id_2: pubkey_2,
1912 bitcoin_key_1: pubkey_3,
1913 bitcoin_key_2: pubkey_4,
1914 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1916 let channel_announcement = msgs::ChannelAnnouncement {
1917 node_signature_1: sig_1,
1918 node_signature_2: sig_2,
1919 bitcoin_signature_1: sig_3,
1920 bitcoin_signature_2: sig_4,
1921 contents: unsigned_channel_announcement,
1923 let encoded_value = channel_announcement.encode();
1924 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1925 if unknown_features_bits {
1926 target_value.append(&mut hex::decode("0002ffff").unwrap());
1928 target_value.append(&mut hex::decode("0000").unwrap());
1930 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1931 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1933 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1935 assert_eq!(encoded_value, target_value);
1939 fn encoding_channel_announcement() {
1940 do_encoding_channel_announcement(true, false);
1941 do_encoding_channel_announcement(false, true);
1942 do_encoding_channel_announcement(false, false);
1943 do_encoding_channel_announcement(true, true);
1946 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1947 let secp_ctx = Secp256k1::new();
1948 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1949 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1950 let features = if unknown_features_bits {
1951 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1953 // Set to some features we may support
1954 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1956 let mut addresses = Vec::new();
1958 addresses.push(msgs::NetAddress::IPv4 {
1959 addr: [255, 254, 253, 252],
1964 addresses.push(msgs::NetAddress::IPv6 {
1965 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1970 addresses.push(msgs::NetAddress::OnionV2 {
1971 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1976 addresses.push(msgs::NetAddress::OnionV3 {
1977 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],
1983 let mut addr_len = 0;
1984 for addr in &addresses {
1985 addr_len += addr.len() + 1;
1987 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1989 timestamp: 20190119,
1994 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() },
1995 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() },
1997 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1998 let node_announcement = msgs::NodeAnnouncement {
2000 contents: unsigned_node_announcement,
2002 let encoded_value = node_announcement.encode();
2003 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2004 if unknown_features_bits {
2005 target_value.append(&mut hex::decode("0002ffff").unwrap());
2007 target_value.append(&mut hex::decode("000122").unwrap());
2009 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2010 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2012 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2015 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2018 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2021 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2023 if excess_address_data {
2024 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2027 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2029 assert_eq!(encoded_value, target_value);
2033 fn encoding_node_announcement() {
2034 do_encoding_node_announcement(true, true, true, true, true, true, true);
2035 do_encoding_node_announcement(false, false, false, false, false, false, false);
2036 do_encoding_node_announcement(false, true, false, false, false, false, false);
2037 do_encoding_node_announcement(false, false, true, false, false, false, false);
2038 do_encoding_node_announcement(false, false, false, true, false, false, false);
2039 do_encoding_node_announcement(false, false, false, false, true, false, false);
2040 do_encoding_node_announcement(false, false, false, false, false, true, false);
2041 do_encoding_node_announcement(false, true, false, true, false, true, false);
2042 do_encoding_node_announcement(false, false, true, false, true, false, false);
2045 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2046 let secp_ctx = Secp256k1::new();
2047 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2048 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2049 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2050 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2051 short_channel_id: 2316138423780173,
2052 timestamp: 20190119,
2053 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2054 cltv_expiry_delta: 144,
2055 htlc_minimum_msat: 1000000,
2056 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2057 fee_base_msat: 10000,
2058 fee_proportional_millionths: 20,
2059 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2061 let channel_update = msgs::ChannelUpdate {
2063 contents: unsigned_channel_update
2065 let encoded_value = channel_update.encode();
2066 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2067 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2068 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2069 if htlc_maximum_msat {
2070 target_value.append(&mut hex::decode("01").unwrap());
2072 target_value.append(&mut hex::decode("00").unwrap());
2074 target_value.append(&mut hex::decode("00").unwrap());
2076 let flag = target_value.last_mut().unwrap();
2080 let flag = target_value.last_mut().unwrap();
2081 *flag = *flag | 1 << 1;
2083 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2084 if htlc_maximum_msat {
2085 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2088 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2090 assert_eq!(encoded_value, target_value);
2094 fn encoding_channel_update() {
2095 do_encoding_channel_update(false, false, false, false);
2096 do_encoding_channel_update(false, false, false, true);
2097 do_encoding_channel_update(true, false, false, false);
2098 do_encoding_channel_update(true, false, false, true);
2099 do_encoding_channel_update(false, true, false, false);
2100 do_encoding_channel_update(false, true, false, true);
2101 do_encoding_channel_update(false, false, true, false);
2102 do_encoding_channel_update(false, false, true, true);
2103 do_encoding_channel_update(true, true, true, false);
2104 do_encoding_channel_update(true, true, true, true);
2107 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2108 let secp_ctx = Secp256k1::new();
2109 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2110 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2111 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2112 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2113 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2114 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2115 let open_channel = msgs::OpenChannel {
2116 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2117 temporary_channel_id: [2; 32],
2118 funding_satoshis: 1311768467284833366,
2119 push_msat: 2536655962884945560,
2120 dust_limit_satoshis: 3608586615801332854,
2121 max_htlc_value_in_flight_msat: 8517154655701053848,
2122 channel_reserve_satoshis: 8665828695742877976,
2123 htlc_minimum_msat: 2316138423780173,
2124 feerate_per_kw: 821716,
2125 to_self_delay: 49340,
2126 max_accepted_htlcs: 49340,
2127 funding_pubkey: pubkey_1,
2128 revocation_basepoint: pubkey_2,
2129 payment_point: pubkey_3,
2130 delayed_payment_basepoint: pubkey_4,
2131 htlc_basepoint: pubkey_5,
2132 first_per_commitment_point: pubkey_6,
2133 channel_flags: if random_bit { 1 << 5 } else { 0 },
2134 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2135 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2137 let encoded_value = open_channel.encode();
2138 let mut target_value = Vec::new();
2139 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2140 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2142 target_value.append(&mut hex::decode("20").unwrap());
2144 target_value.append(&mut hex::decode("00").unwrap());
2147 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2150 target_value.append(&mut hex::decode("0100").unwrap());
2152 assert_eq!(encoded_value, target_value);
2156 fn encoding_open_channel() {
2157 do_encoding_open_channel(false, false, false);
2158 do_encoding_open_channel(false, false, true);
2159 do_encoding_open_channel(false, true, false);
2160 do_encoding_open_channel(false, true, true);
2161 do_encoding_open_channel(true, false, false);
2162 do_encoding_open_channel(true, false, true);
2163 do_encoding_open_channel(true, true, false);
2164 do_encoding_open_channel(true, true, true);
2167 fn do_encoding_accept_channel(shutdown: bool) {
2168 let secp_ctx = Secp256k1::new();
2169 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2170 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2171 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2172 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2173 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2174 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2175 let accept_channel = msgs::AcceptChannel {
2176 temporary_channel_id: [2; 32],
2177 dust_limit_satoshis: 1311768467284833366,
2178 max_htlc_value_in_flight_msat: 2536655962884945560,
2179 channel_reserve_satoshis: 3608586615801332854,
2180 htlc_minimum_msat: 2316138423780173,
2181 minimum_depth: 821716,
2182 to_self_delay: 49340,
2183 max_accepted_htlcs: 49340,
2184 funding_pubkey: pubkey_1,
2185 revocation_basepoint: pubkey_2,
2186 payment_point: pubkey_3,
2187 delayed_payment_basepoint: pubkey_4,
2188 htlc_basepoint: pubkey_5,
2189 first_per_commitment_point: pubkey_6,
2190 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2192 let encoded_value = accept_channel.encode();
2193 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2195 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2197 assert_eq!(encoded_value, target_value);
2201 fn encoding_accept_channel() {
2202 do_encoding_accept_channel(false);
2203 do_encoding_accept_channel(true);
2207 fn encoding_funding_created() {
2208 let secp_ctx = Secp256k1::new();
2209 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2210 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2211 let funding_created = msgs::FundingCreated {
2212 temporary_channel_id: [2; 32],
2213 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2214 funding_output_index: 255,
2217 let encoded_value = funding_created.encode();
2218 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2219 assert_eq!(encoded_value, target_value);
2223 fn encoding_funding_signed() {
2224 let secp_ctx = Secp256k1::new();
2225 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2226 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2227 let funding_signed = msgs::FundingSigned {
2228 channel_id: [2; 32],
2231 let encoded_value = funding_signed.encode();
2232 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2233 assert_eq!(encoded_value, target_value);
2237 fn encoding_funding_locked() {
2238 let secp_ctx = Secp256k1::new();
2239 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2240 let funding_locked = msgs::FundingLocked {
2241 channel_id: [2; 32],
2242 next_per_commitment_point: pubkey_1,
2244 let encoded_value = funding_locked.encode();
2245 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2246 assert_eq!(encoded_value, target_value);
2249 fn do_encoding_shutdown(script_type: u8) {
2250 let secp_ctx = Secp256k1::new();
2251 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2252 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2253 let shutdown = msgs::Shutdown {
2254 channel_id: [2; 32],
2256 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2257 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2258 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2259 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2261 let encoded_value = shutdown.encode();
2262 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2263 if script_type == 1 {
2264 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2265 } else if script_type == 2 {
2266 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2267 } else if script_type == 3 {
2268 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2269 } else if script_type == 4 {
2270 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2272 assert_eq!(encoded_value, target_value);
2276 fn encoding_shutdown() {
2277 do_encoding_shutdown(1);
2278 do_encoding_shutdown(2);
2279 do_encoding_shutdown(3);
2280 do_encoding_shutdown(4);
2284 fn encoding_closing_signed() {
2285 let secp_ctx = Secp256k1::new();
2286 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2287 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2288 let closing_signed = msgs::ClosingSigned {
2289 channel_id: [2; 32],
2290 fee_satoshis: 2316138423780173,
2294 let encoded_value = closing_signed.encode();
2295 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2296 assert_eq!(encoded_value, target_value);
2297 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2299 let closing_signed_with_range = msgs::ClosingSigned {
2300 channel_id: [2; 32],
2301 fee_satoshis: 2316138423780173,
2303 fee_range: Some(msgs::ClosingSignedFeeRange {
2304 min_fee_satoshis: 0xdeadbeef,
2305 max_fee_satoshis: 0x1badcafe01234567,
2308 let encoded_value_with_range = closing_signed_with_range.encode();
2309 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2310 assert_eq!(encoded_value_with_range, target_value_with_range);
2311 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2312 closing_signed_with_range);
2316 fn encoding_update_add_htlc() {
2317 let secp_ctx = Secp256k1::new();
2318 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2319 let onion_routing_packet = msgs::OnionPacket {
2321 public_key: Ok(pubkey_1),
2322 hop_data: [1; 20*65],
2325 let update_add_htlc = msgs::UpdateAddHTLC {
2326 channel_id: [2; 32],
2327 htlc_id: 2316138423780173,
2328 amount_msat: 3608586615801332854,
2329 payment_hash: PaymentHash([1; 32]),
2330 cltv_expiry: 821716,
2331 onion_routing_packet
2333 let encoded_value = update_add_htlc.encode();
2334 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2335 assert_eq!(encoded_value, target_value);
2339 fn encoding_update_fulfill_htlc() {
2340 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2341 channel_id: [2; 32],
2342 htlc_id: 2316138423780173,
2343 payment_preimage: PaymentPreimage([1; 32]),
2345 let encoded_value = update_fulfill_htlc.encode();
2346 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2347 assert_eq!(encoded_value, target_value);
2351 fn encoding_update_fail_htlc() {
2352 let reason = OnionErrorPacket {
2353 data: [1; 32].to_vec(),
2355 let update_fail_htlc = msgs::UpdateFailHTLC {
2356 channel_id: [2; 32],
2357 htlc_id: 2316138423780173,
2360 let encoded_value = update_fail_htlc.encode();
2361 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2362 assert_eq!(encoded_value, target_value);
2366 fn encoding_update_fail_malformed_htlc() {
2367 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2368 channel_id: [2; 32],
2369 htlc_id: 2316138423780173,
2370 sha256_of_onion: [1; 32],
2373 let encoded_value = update_fail_malformed_htlc.encode();
2374 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2375 assert_eq!(encoded_value, target_value);
2378 fn do_encoding_commitment_signed(htlcs: bool) {
2379 let secp_ctx = Secp256k1::new();
2380 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2381 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2382 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2383 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2384 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2385 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2386 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2387 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2388 let commitment_signed = msgs::CommitmentSigned {
2389 channel_id: [2; 32],
2391 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2393 let encoded_value = commitment_signed.encode();
2394 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2396 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2398 target_value.append(&mut hex::decode("0000").unwrap());
2400 assert_eq!(encoded_value, target_value);
2404 fn encoding_commitment_signed() {
2405 do_encoding_commitment_signed(true);
2406 do_encoding_commitment_signed(false);
2410 fn encoding_revoke_and_ack() {
2411 let secp_ctx = Secp256k1::new();
2412 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2413 let raa = msgs::RevokeAndACK {
2414 channel_id: [2; 32],
2415 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],
2416 next_per_commitment_point: pubkey_1,
2418 let encoded_value = raa.encode();
2419 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2420 assert_eq!(encoded_value, target_value);
2424 fn encoding_update_fee() {
2425 let update_fee = msgs::UpdateFee {
2426 channel_id: [2; 32],
2427 feerate_per_kw: 20190119,
2429 let encoded_value = update_fee.encode();
2430 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2431 assert_eq!(encoded_value, target_value);
2435 fn encoding_init() {
2436 assert_eq!(msgs::Init {
2437 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2438 gossip_compression_encodings: Vec::new(),
2439 }.encode(), hex::decode("00023fff0003ffffff0300").unwrap());
2440 assert_eq!(msgs::Init {
2441 features: InitFeatures::from_le_bytes(vec![0xFF]),
2442 gossip_compression_encodings: Vec::new(),
2443 }.encode(), hex::decode("0001ff0001ff0300").unwrap());
2444 assert_eq!(msgs::Init {
2445 features: InitFeatures::from_le_bytes(vec![]),
2446 gossip_compression_encodings: Vec::new(),
2447 }.encode(), hex::decode("000000000300").unwrap());
2448 assert_eq!(msgs::Init {
2449 features: InitFeatures::from_le_bytes(vec![]),
2450 gossip_compression_encodings: vec![GossipEncodingType::Uncompressed],
2451 }.encode(), hex::decode("00000000030101").unwrap());
2452 assert_eq!(msgs::Init {
2453 features: InitFeatures::from_le_bytes(vec![]),
2454 gossip_compression_encodings: vec![GossipEncodingType::Uncompressed, GossipEncodingType::Zlib],
2455 }.encode(), hex::decode("00000000030103").unwrap());
2459 fn encoding_error() {
2460 let error = msgs::ErrorMessage {
2461 channel_id: [2; 32],
2462 data: String::from("rust-lightning"),
2464 let encoded_value = error.encode();
2465 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2466 assert_eq!(encoded_value, target_value);
2470 fn encoding_ping() {
2471 let ping = msgs::Ping {
2475 let encoded_value = ping.encode();
2476 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2477 assert_eq!(encoded_value, target_value);
2481 fn encoding_pong() {
2482 let pong = msgs::Pong {
2485 let encoded_value = pong.encode();
2486 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2487 assert_eq!(encoded_value, target_value);
2491 fn encoding_legacy_onion_hop_data() {
2492 let msg = msgs::OnionHopData {
2493 format: OnionHopDataFormat::Legacy {
2494 short_channel_id: 0xdeadbeef1bad1dea,
2496 amt_to_forward: 0x0badf00d01020304,
2497 outgoing_cltv_value: 0xffffffff,
2499 let encoded_value = msg.encode();
2500 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2501 assert_eq!(encoded_value, target_value);
2505 fn encoding_nonfinal_onion_hop_data() {
2506 let mut msg = msgs::OnionHopData {
2507 format: OnionHopDataFormat::NonFinalNode {
2508 short_channel_id: 0xdeadbeef1bad1dea,
2510 amt_to_forward: 0x0badf00d01020304,
2511 outgoing_cltv_value: 0xffffffff,
2513 let encoded_value = msg.encode();
2514 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2515 assert_eq!(encoded_value, target_value);
2516 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2517 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2518 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2519 } else { panic!(); }
2520 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2521 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2525 fn encoding_final_onion_hop_data() {
2526 let mut msg = msgs::OnionHopData {
2527 format: OnionHopDataFormat::FinalNode {
2529 keysend_preimage: None,
2531 amt_to_forward: 0x0badf00d01020304,
2532 outgoing_cltv_value: 0xffffffff,
2534 let encoded_value = msg.encode();
2535 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2536 assert_eq!(encoded_value, target_value);
2537 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2538 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2539 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2540 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2544 fn encoding_final_onion_hop_data_with_secret() {
2545 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2546 let mut msg = msgs::OnionHopData {
2547 format: OnionHopDataFormat::FinalNode {
2548 payment_data: Some(FinalOnionHopData {
2549 payment_secret: expected_payment_secret,
2550 total_msat: 0x1badca1f
2552 keysend_preimage: None,
2554 amt_to_forward: 0x0badf00d01020304,
2555 outgoing_cltv_value: 0xffffffff,
2557 let encoded_value = msg.encode();
2558 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2559 assert_eq!(encoded_value, target_value);
2560 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2561 if let OnionHopDataFormat::FinalNode {
2562 payment_data: Some(FinalOnionHopData {
2564 total_msat: 0x1badca1f
2566 keysend_preimage: None,
2568 assert_eq!(payment_secret, expected_payment_secret);
2569 } else { panic!(); }
2570 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2571 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2575 fn query_channel_range_end_blocknum() {
2576 let tests: Vec<(u32, u32, u32)> = vec![
2577 (10000, 1500, 11500),
2578 (0, 0xffffffff, 0xffffffff),
2579 (1, 0xffffffff, 0xffffffff),
2582 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2583 let sut = msgs::QueryChannelRange {
2584 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2588 assert_eq!(sut.end_blocknum(), expected);
2593 fn encoding_query_channel_range() {
2594 let mut query_channel_range = msgs::QueryChannelRange {
2595 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2596 first_blocknum: 100000,
2597 number_of_blocks: 1500,
2599 let encoded_value = query_channel_range.encode();
2600 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2601 assert_eq!(encoded_value, target_value);
2603 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2604 assert_eq!(query_channel_range.first_blocknum, 100000);
2605 assert_eq!(query_channel_range.number_of_blocks, 1500);
2609 fn encoding_reply_channel_range() {
2610 do_encoding_reply_channel_range(0);
2611 do_encoding_reply_channel_range(1);
2614 fn do_encoding_reply_channel_range(encoding_type: u8) {
2615 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2616 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2617 let mut reply_channel_range = msgs::ReplyChannelRange {
2618 chain_hash: expected_chain_hash,
2619 first_blocknum: 756230,
2620 number_of_blocks: 1500,
2621 sync_complete: true,
2622 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2625 if encoding_type == 0 {
2626 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2627 let encoded_value = reply_channel_range.encode();
2628 assert_eq!(encoded_value, target_value);
2630 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2631 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2632 assert_eq!(reply_channel_range.first_blocknum, 756230);
2633 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2634 assert_eq!(reply_channel_range.sync_complete, true);
2635 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2636 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2637 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2639 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2640 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2641 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2646 fn encoding_query_short_channel_ids() {
2647 do_encoding_query_short_channel_ids(0);
2648 do_encoding_query_short_channel_ids(1);
2651 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2652 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2653 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2654 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2655 chain_hash: expected_chain_hash,
2656 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2659 if encoding_type == 0 {
2660 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2661 let encoded_value = query_short_channel_ids.encode();
2662 assert_eq!(encoded_value, target_value);
2664 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2665 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2666 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2667 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2668 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2670 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2671 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2672 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2677 fn encoding_reply_short_channel_ids_end() {
2678 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2679 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2680 chain_hash: expected_chain_hash,
2681 full_information: true,
2683 let encoded_value = reply_short_channel_ids_end.encode();
2684 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2685 assert_eq!(encoded_value, target_value);
2687 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2688 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2689 assert_eq!(reply_short_channel_ids_end.full_information, true);
2693 fn encoding_gossip_timestamp_filter(){
2694 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2695 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2696 chain_hash: expected_chain_hash,
2697 first_timestamp: 1590000000,
2698 timestamp_range: 0xffff_ffff,
2700 let encoded_value = gossip_timestamp_filter.encode();
2701 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2702 assert_eq!(encoded_value, target_value);
2704 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2705 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2706 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2707 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);