1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
12 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
13 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
14 //! server entirely) which handles only channel-related messages you may wish to implement
15 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
18 //! Note that if you go with such an architecture (instead of passing raw socket events to a
19 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
20 //! source node_id of the message, however this does allow you to significantly reduce bandwidth
21 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
22 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
23 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
24 //! raw socket events into your non-internet-facing system and then send routing events back to
25 //! track the network on the less-secure system.
27 use bitcoin::secp256k1::key::PublicKey;
28 use bitcoin::secp256k1::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
39 use io_extras::read_to_end;
41 use util::events::MessageSendEventsProvider;
43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
47 /// 21 million * 10^8 * 1000
48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
50 /// An error in decoding a message or struct.
51 #[derive(Clone, Debug, PartialEq)]
52 pub enum DecodeError {
53 /// A version byte specified something we don't know how to handle.
54 /// Includes unknown realm byte in an OnionHopData packet
56 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
57 UnknownRequiredFeature,
58 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
59 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
60 /// syntactically incorrect, etc
64 /// A length descriptor in the packet didn't describe the later data correctly
66 /// Error from std::io
67 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
69 /// The message included zlib-compressed values, which we don't support.
70 UnsupportedCompression,
73 /// An init message to be sent or received from a peer
74 #[derive(Clone, Debug, PartialEq)]
76 /// The relevant features which the sender supports
77 pub features: InitFeatures,
80 /// An error message to be sent or received from a peer
81 #[derive(Clone, Debug, PartialEq)]
82 pub struct ErrorMessage {
83 /// The channel ID involved in the error.
85 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
86 /// with the sending peer should be closed.
87 pub channel_id: [u8; 32],
88 /// A possibly human-readable error description.
89 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
90 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
91 /// the terminal emulator or the logging subsystem.
95 /// A warning message to be sent or received from a peer
96 #[derive(Clone, Debug, PartialEq)]
97 pub struct WarningMessage {
98 /// The channel ID involved in the warning.
100 /// All-0s indicates a warning unrelated to a specific channel.
101 pub channel_id: [u8; 32],
102 /// A possibly human-readable warning description.
103 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
104 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
105 /// the terminal emulator or the logging subsystem.
109 /// A ping message to be sent or received from a peer
110 #[derive(Clone, Debug, PartialEq)]
112 /// The desired response length
114 /// The ping packet size.
115 /// This field is not sent on the wire. byteslen zeros are sent.
119 /// A pong message to be sent or received from a peer
120 #[derive(Clone, Debug, PartialEq)]
122 /// The pong packet size.
123 /// This field is not sent on the wire. byteslen zeros are sent.
127 /// An open_channel message to be sent or received from a peer
128 #[derive(Clone, Debug, PartialEq)]
129 pub struct OpenChannel {
130 /// The genesis hash of the blockchain where the channel is to be opened
131 pub chain_hash: BlockHash,
132 /// A temporary channel ID, until the funding outpoint is announced
133 pub temporary_channel_id: [u8; 32],
134 /// The channel value
135 pub funding_satoshis: u64,
136 /// The amount to push to the counterparty as part of the open, in milli-satoshi
138 /// The threshold below which outputs on transactions broadcast by sender will be omitted
139 pub dust_limit_satoshis: u64,
140 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
141 pub max_htlc_value_in_flight_msat: u64,
142 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
143 pub channel_reserve_satoshis: u64,
144 /// The minimum HTLC size incoming to sender, in milli-satoshi
145 pub htlc_minimum_msat: u64,
146 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
147 pub feerate_per_kw: u32,
148 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
149 pub to_self_delay: u16,
150 /// The maximum number of inbound HTLCs towards sender
151 pub max_accepted_htlcs: u16,
152 /// The sender's key controlling the funding transaction
153 pub funding_pubkey: PublicKey,
154 /// Used to derive a revocation key for transactions broadcast by counterparty
155 pub revocation_basepoint: PublicKey,
156 /// A payment key to sender for transactions broadcast by counterparty
157 pub payment_point: PublicKey,
158 /// Used to derive a payment key to sender for transactions broadcast by sender
159 pub delayed_payment_basepoint: PublicKey,
160 /// Used to derive an HTLC payment key to sender
161 pub htlc_basepoint: PublicKey,
162 /// The first to-be-broadcast-by-sender transaction's per commitment point
163 pub first_per_commitment_point: PublicKey,
165 pub channel_flags: u8,
166 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
167 pub shutdown_scriptpubkey: OptionalField<Script>,
168 /// The channel type that this channel will represent. If none is set, we derive the channel
169 /// type from the intersection of our feature bits with our counterparty's feature bits from
170 /// the Init message.
171 pub channel_type: Option<ChannelTypeFeatures>,
174 /// An accept_channel message to be sent or received from a peer
175 #[derive(Clone, Debug, PartialEq)]
176 pub struct AcceptChannel {
177 /// A temporary channel ID, until the funding outpoint is announced
178 pub temporary_channel_id: [u8; 32],
179 /// The threshold below which outputs on transactions broadcast by sender will be omitted
180 pub dust_limit_satoshis: u64,
181 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
182 pub max_htlc_value_in_flight_msat: u64,
183 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
184 pub channel_reserve_satoshis: u64,
185 /// The minimum HTLC size incoming to sender, in milli-satoshi
186 pub htlc_minimum_msat: u64,
187 /// Minimum depth of the funding transaction before the channel is considered open
188 pub minimum_depth: u32,
189 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
190 pub to_self_delay: u16,
191 /// The maximum number of inbound HTLCs towards sender
192 pub max_accepted_htlcs: u16,
193 /// The sender's key controlling the funding transaction
194 pub funding_pubkey: PublicKey,
195 /// Used to derive a revocation key for transactions broadcast by counterparty
196 pub revocation_basepoint: PublicKey,
197 /// A payment key to sender for transactions broadcast by counterparty
198 pub payment_point: PublicKey,
199 /// Used to derive a payment key to sender for transactions broadcast by sender
200 pub delayed_payment_basepoint: PublicKey,
201 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
202 pub htlc_basepoint: PublicKey,
203 /// The first to-be-broadcast-by-sender transaction's per commitment point
204 pub first_per_commitment_point: PublicKey,
205 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
206 pub shutdown_scriptpubkey: OptionalField<Script>,
207 /// The channel type that this channel will represent. If none is set, we derive the channel
208 /// type from the intersection of our feature bits with our counterparty's feature bits from
209 /// the Init message.
211 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
212 pub channel_type: Option<ChannelTypeFeatures>,
215 /// A funding_created message to be sent or received from a peer
216 #[derive(Clone, Debug, PartialEq)]
217 pub struct FundingCreated {
218 /// A temporary channel ID, until the funding is established
219 pub temporary_channel_id: [u8; 32],
220 /// The funding transaction ID
221 pub funding_txid: Txid,
222 /// The specific output index funding this channel
223 pub funding_output_index: u16,
224 /// The signature of the channel initiator (funder) on the initial commitment transaction
225 pub signature: Signature,
228 /// A funding_signed message to be sent or received from a peer
229 #[derive(Clone, Debug, PartialEq)]
230 pub struct FundingSigned {
232 pub channel_id: [u8; 32],
233 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
234 pub signature: Signature,
237 /// A funding_locked message to be sent or received from a peer
238 #[derive(Clone, Debug, PartialEq)]
239 pub struct FundingLocked {
241 pub channel_id: [u8; 32],
242 /// The per-commitment point of the second commitment transaction
243 pub next_per_commitment_point: PublicKey,
246 /// A shutdown message to be sent or received from a peer
247 #[derive(Clone, Debug, PartialEq)]
248 pub struct Shutdown {
250 pub channel_id: [u8; 32],
251 /// The destination of this peer's funds on closing.
252 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
253 pub scriptpubkey: Script,
256 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
257 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
259 #[derive(Clone, Debug, PartialEq)]
260 pub struct ClosingSignedFeeRange {
261 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
263 pub min_fee_satoshis: u64,
264 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
266 pub max_fee_satoshis: u64,
269 /// A closing_signed message to be sent or received from a peer
270 #[derive(Clone, Debug, PartialEq)]
271 pub struct ClosingSigned {
273 pub channel_id: [u8; 32],
274 /// The proposed total fee for the closing transaction
275 pub fee_satoshis: u64,
276 /// A signature on the closing transaction
277 pub signature: Signature,
278 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
280 pub fee_range: Option<ClosingSignedFeeRange>,
283 /// An update_add_htlc message to be sent or received from a peer
284 #[derive(Clone, Debug, PartialEq)]
285 pub struct UpdateAddHTLC {
287 pub channel_id: [u8; 32],
290 /// The HTLC value in milli-satoshi
291 pub amount_msat: u64,
292 /// The payment hash, the pre-image of which controls HTLC redemption
293 pub payment_hash: PaymentHash,
294 /// The expiry height of the HTLC
295 pub cltv_expiry: u32,
296 pub(crate) onion_routing_packet: OnionPacket,
299 /// An update_fulfill_htlc message to be sent or received from a peer
300 #[derive(Clone, Debug, PartialEq)]
301 pub struct UpdateFulfillHTLC {
303 pub channel_id: [u8; 32],
306 /// The pre-image of the payment hash, allowing HTLC redemption
307 pub payment_preimage: PaymentPreimage,
310 /// An update_fail_htlc message to be sent or received from a peer
311 #[derive(Clone, Debug, PartialEq)]
312 pub struct UpdateFailHTLC {
314 pub channel_id: [u8; 32],
317 pub(crate) reason: OnionErrorPacket,
320 /// An update_fail_malformed_htlc message to be sent or received from a peer
321 #[derive(Clone, Debug, PartialEq)]
322 pub struct UpdateFailMalformedHTLC {
324 pub channel_id: [u8; 32],
327 pub(crate) sha256_of_onion: [u8; 32],
329 pub failure_code: u16,
332 /// A commitment_signed message to be sent or received from a peer
333 #[derive(Clone, Debug, PartialEq)]
334 pub struct CommitmentSigned {
336 pub channel_id: [u8; 32],
337 /// A signature on the commitment transaction
338 pub signature: Signature,
339 /// Signatures on the HTLC transactions
340 pub htlc_signatures: Vec<Signature>,
343 /// A revoke_and_ack message to be sent or received from a peer
344 #[derive(Clone, Debug, PartialEq)]
345 pub struct RevokeAndACK {
347 pub channel_id: [u8; 32],
348 /// The secret corresponding to the per-commitment point
349 pub per_commitment_secret: [u8; 32],
350 /// The next sender-broadcast commitment transaction's per-commitment point
351 pub next_per_commitment_point: PublicKey,
354 /// An update_fee message to be sent or received from a peer
355 #[derive(Clone, Debug, PartialEq)]
356 pub struct UpdateFee {
358 pub channel_id: [u8; 32],
359 /// Fee rate per 1000-weight of the transaction
360 pub feerate_per_kw: u32,
363 #[derive(Clone, Debug, PartialEq)]
364 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
365 /// This is used to convince the recipient that the channel is at a certain commitment
366 /// number even if they lost that data due to a local failure. Of course, the peer may lie
367 /// and even later commitments may have been revoked.
368 pub struct DataLossProtect {
369 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
370 /// belonging to the recipient
371 pub your_last_per_commitment_secret: [u8; 32],
372 /// The sender's per-commitment point for their current commitment transaction
373 pub my_current_per_commitment_point: PublicKey,
376 /// A channel_reestablish message to be sent or received from a peer
377 #[derive(Clone, Debug, PartialEq)]
378 pub struct ChannelReestablish {
380 pub channel_id: [u8; 32],
381 /// The next commitment number for the sender
382 pub next_local_commitment_number: u64,
383 /// The next commitment number for the recipient
384 pub next_remote_commitment_number: u64,
385 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
386 pub data_loss_protect: OptionalField<DataLossProtect>,
389 /// An announcement_signatures message to be sent or received from a peer
390 #[derive(Clone, Debug, PartialEq)]
391 pub struct AnnouncementSignatures {
393 pub channel_id: [u8; 32],
394 /// The short channel ID
395 pub short_channel_id: u64,
396 /// A signature by the node key
397 pub node_signature: Signature,
398 /// A signature by the funding key
399 pub bitcoin_signature: Signature,
402 /// An address which can be used to connect to a remote peer
403 #[derive(Clone, Debug, PartialEq)]
404 pub enum NetAddress {
405 /// An IPv4 address/port on which the peer is listening.
407 /// The 4-byte IPv4 address
409 /// The port on which the node is listening
412 /// An IPv6 address/port on which the peer is listening.
414 /// The 16-byte IPv6 address
416 /// The port on which the node is listening
419 /// An old-style Tor onion address/port on which the peer is listening.
421 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
422 /// addresses. Thus, the details are not parsed here.
424 /// A new-style Tor onion address/port on which the peer is listening.
425 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
426 /// wrap as base32 and append ".onion".
428 /// The ed25519 long-term public key of the peer
429 ed25519_pubkey: [u8; 32],
430 /// The checksum of the pubkey and version, as included in the onion address
432 /// The version byte, as defined by the Tor Onion v3 spec.
434 /// The port on which the node is listening
439 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
441 pub(crate) fn get_id(&self) -> u8 {
443 &NetAddress::IPv4 {..} => { 1 },
444 &NetAddress::IPv6 {..} => { 2 },
445 &NetAddress::OnionV2(_) => { 3 },
446 &NetAddress::OnionV3 {..} => { 4 },
450 /// Strict byte-length of address descriptor, 1-byte type not recorded
451 fn len(&self) -> u16 {
453 &NetAddress::IPv4 { .. } => { 6 },
454 &NetAddress::IPv6 { .. } => { 18 },
455 &NetAddress::OnionV2(_) => { 12 },
456 &NetAddress::OnionV3 { .. } => { 37 },
460 /// The maximum length of any address descriptor, not including the 1-byte type
461 pub(crate) const MAX_LEN: u16 = 37;
464 impl Writeable for NetAddress {
465 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
467 &NetAddress::IPv4 { ref addr, ref port } => {
472 &NetAddress::IPv6 { ref addr, ref port } => {
477 &NetAddress::OnionV2(bytes) => {
479 bytes.write(writer)?;
481 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
483 ed25519_pubkey.write(writer)?;
484 checksum.write(writer)?;
485 version.write(writer)?;
493 impl Readable for Result<NetAddress, u8> {
494 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
495 let byte = <u8 as Readable>::read(reader)?;
498 Ok(Ok(NetAddress::IPv4 {
499 addr: Readable::read(reader)?,
500 port: Readable::read(reader)?,
504 Ok(Ok(NetAddress::IPv6 {
505 addr: Readable::read(reader)?,
506 port: Readable::read(reader)?,
509 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
511 Ok(Ok(NetAddress::OnionV3 {
512 ed25519_pubkey: Readable::read(reader)?,
513 checksum: Readable::read(reader)?,
514 version: Readable::read(reader)?,
515 port: Readable::read(reader)?,
518 _ => return Ok(Err(byte)),
523 impl Readable for NetAddress {
524 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
525 match Readable::read(reader) {
526 Ok(Ok(res)) => Ok(res),
527 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
534 /// The unsigned part of a node_announcement
535 #[derive(Clone, Debug, PartialEq)]
536 pub struct UnsignedNodeAnnouncement {
537 /// The advertised features
538 pub features: NodeFeatures,
539 /// A strictly monotonic announcement counter, with gaps allowed
541 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
543 pub node_id: PublicKey,
544 /// An RGB color for UI purposes
546 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
549 /// List of addresses on which this node is reachable
550 pub addresses: Vec<NetAddress>,
551 pub(crate) excess_address_data: Vec<u8>,
552 pub(crate) excess_data: Vec<u8>,
554 #[derive(Clone, Debug, PartialEq)]
555 /// A node_announcement message to be sent or received from a peer
556 pub struct NodeAnnouncement {
557 /// The signature by the node key
558 pub signature: Signature,
559 /// The actual content of the announcement
560 pub contents: UnsignedNodeAnnouncement,
563 /// The unsigned part of a channel_announcement
564 #[derive(Clone, Debug, PartialEq)]
565 pub struct UnsignedChannelAnnouncement {
566 /// The advertised channel features
567 pub features: ChannelFeatures,
568 /// The genesis hash of the blockchain where the channel is to be opened
569 pub chain_hash: BlockHash,
570 /// The short channel ID
571 pub short_channel_id: u64,
572 /// One of the two node_ids which are endpoints of this channel
573 pub node_id_1: PublicKey,
574 /// The other of the two node_ids which are endpoints of this channel
575 pub node_id_2: PublicKey,
576 /// The funding key for the first node
577 pub bitcoin_key_1: PublicKey,
578 /// The funding key for the second node
579 pub bitcoin_key_2: PublicKey,
580 pub(crate) excess_data: Vec<u8>,
582 /// A channel_announcement message to be sent or received from a peer
583 #[derive(Clone, Debug, PartialEq)]
584 pub struct ChannelAnnouncement {
585 /// Authentication of the announcement by the first public node
586 pub node_signature_1: Signature,
587 /// Authentication of the announcement by the second public node
588 pub node_signature_2: Signature,
589 /// Proof of funding UTXO ownership by the first public node
590 pub bitcoin_signature_1: Signature,
591 /// Proof of funding UTXO ownership by the second public node
592 pub bitcoin_signature_2: Signature,
593 /// The actual announcement
594 pub contents: UnsignedChannelAnnouncement,
597 /// The unsigned part of a channel_update
598 #[derive(Clone, Debug, PartialEq)]
599 pub struct UnsignedChannelUpdate {
600 /// The genesis hash of the blockchain where the channel is to be opened
601 pub chain_hash: BlockHash,
602 /// The short channel ID
603 pub short_channel_id: u64,
604 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
608 /// The number of blocks such that if:
609 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
610 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
611 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
612 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
613 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
614 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
615 /// constructing the route.
616 pub cltv_expiry_delta: u16,
617 /// The minimum HTLC size incoming to sender, in milli-satoshi
618 pub htlc_minimum_msat: u64,
619 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
620 pub htlc_maximum_msat: OptionalField<u64>,
621 /// The base HTLC fee charged by sender, in milli-satoshi
622 pub fee_base_msat: u32,
623 /// The amount to fee multiplier, in micro-satoshi
624 pub fee_proportional_millionths: u32,
625 pub(crate) excess_data: Vec<u8>,
627 /// A channel_update message to be sent or received from a peer
628 #[derive(Clone, Debug, PartialEq)]
629 pub struct ChannelUpdate {
630 /// A signature of the channel update
631 pub signature: Signature,
632 /// The actual channel update
633 pub contents: UnsignedChannelUpdate,
636 /// A query_channel_range message is used to query a peer for channel
637 /// UTXOs in a range of blocks. The recipient of a query makes a best
638 /// effort to reply to the query using one or more reply_channel_range
640 #[derive(Clone, Debug, PartialEq)]
641 pub struct QueryChannelRange {
642 /// The genesis hash of the blockchain being queried
643 pub chain_hash: BlockHash,
644 /// The height of the first block for the channel UTXOs being queried
645 pub first_blocknum: u32,
646 /// The number of blocks to include in the query results
647 pub number_of_blocks: u32,
650 /// A reply_channel_range message is a reply to a query_channel_range
651 /// message. Multiple reply_channel_range messages can be sent in reply
652 /// to a single query_channel_range message. The query recipient makes a
653 /// best effort to respond based on their local network view which may
654 /// not be a perfect view of the network. The short_channel_ids in the
655 /// reply are encoded. We only support encoding_type=0 uncompressed
656 /// serialization and do not support encoding_type=1 zlib serialization.
657 #[derive(Clone, Debug, PartialEq)]
658 pub struct ReplyChannelRange {
659 /// The genesis hash of the blockchain being queried
660 pub chain_hash: BlockHash,
661 /// The height of the first block in the range of the reply
662 pub first_blocknum: u32,
663 /// The number of blocks included in the range of the reply
664 pub number_of_blocks: u32,
665 /// True when this is the final reply for a query
666 pub sync_complete: bool,
667 /// The short_channel_ids in the channel range
668 pub short_channel_ids: Vec<u64>,
671 /// A query_short_channel_ids message is used to query a peer for
672 /// routing gossip messages related to one or more short_channel_ids.
673 /// The query recipient will reply with the latest, if available,
674 /// channel_announcement, channel_update and node_announcement messages
675 /// it maintains for the requested short_channel_ids followed by a
676 /// reply_short_channel_ids_end message. The short_channel_ids sent in
677 /// this query are encoded. We only support encoding_type=0 uncompressed
678 /// serialization and do not support encoding_type=1 zlib serialization.
679 #[derive(Clone, Debug, PartialEq)]
680 pub struct QueryShortChannelIds {
681 /// The genesis hash of the blockchain being queried
682 pub chain_hash: BlockHash,
683 /// The short_channel_ids that are being queried
684 pub short_channel_ids: Vec<u64>,
687 /// A reply_short_channel_ids_end message is sent as a reply to a
688 /// query_short_channel_ids message. The query recipient makes a best
689 /// effort to respond based on their local network view which may not be
690 /// a perfect view of the network.
691 #[derive(Clone, Debug, PartialEq)]
692 pub struct ReplyShortChannelIdsEnd {
693 /// The genesis hash of the blockchain that was queried
694 pub chain_hash: BlockHash,
695 /// Indicates if the query recipient maintains up-to-date channel
696 /// information for the chain_hash
697 pub full_information: bool,
700 /// A gossip_timestamp_filter message is used by a node to request
701 /// gossip relay for messages in the requested time range when the
702 /// gossip_queries feature has been negotiated.
703 #[derive(Clone, Debug, PartialEq)]
704 pub struct GossipTimestampFilter {
705 /// The genesis hash of the blockchain for channel and node information
706 pub chain_hash: BlockHash,
707 /// The starting unix timestamp
708 pub first_timestamp: u32,
709 /// The range of information in seconds
710 pub timestamp_range: u32,
713 /// Encoding type for data compression of collections in gossip queries.
714 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
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 provided us with a gossip message which we'd already seen. In most cases this
734 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
735 /// our own channel announcements.
736 IgnoreDuplicateGossip,
737 /// The peer did something incorrect. Tell them.
739 /// The message to send.
742 /// The peer did something incorrect. Tell them without closing any channels.
744 /// The message to send.
746 /// The peer may have done something harmless that we weren't able to meaningfully process,
747 /// though we should still tell them about it.
748 /// If this event is logged, log it at the given level.
749 log_level: logger::Level,
753 /// An Err type for failure to process messages.
754 #[derive(Clone, Debug)]
755 pub struct LightningError {
756 /// A human-readable message describing the error
758 /// The action which should be taken against the offending peer.
759 pub action: ErrorAction,
762 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
763 /// transaction updates if they were pending.
764 #[derive(Clone, Debug, PartialEq)]
765 pub struct CommitmentUpdate {
766 /// update_add_htlc messages which should be sent
767 pub update_add_htlcs: Vec<UpdateAddHTLC>,
768 /// update_fulfill_htlc messages which should be sent
769 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
770 /// update_fail_htlc messages which should be sent
771 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
772 /// update_fail_malformed_htlc messages which should be sent
773 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
774 /// An update_fee message which should be sent
775 pub update_fee: Option<UpdateFee>,
776 /// Finally, the commitment_signed message which should be sent
777 pub commitment_signed: CommitmentSigned,
780 /// Messages could have optional fields to use with extended features
781 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
782 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
783 /// separate enum type for them.
784 /// (C-not exported) due to a free generic in T
785 #[derive(Clone, Debug, PartialEq)]
786 pub enum OptionalField<T> {
787 /// Optional field is included in message
789 /// Optional field is absent in message
793 /// A trait to describe an object which can receive channel messages.
795 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
796 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
797 pub trait ChannelMessageHandler : MessageSendEventsProvider {
799 /// Handle an incoming open_channel message from the given peer.
800 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
801 /// Handle an incoming accept_channel message from the given peer.
802 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
803 /// Handle an incoming funding_created message from the given peer.
804 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
805 /// Handle an incoming funding_signed message from the given peer.
806 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
807 /// Handle an incoming funding_locked message from the given peer.
808 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
811 /// Handle an incoming shutdown message from the given peer.
812 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
813 /// Handle an incoming closing_signed message from the given peer.
814 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
817 /// Handle an incoming update_add_htlc message from the given peer.
818 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
819 /// Handle an incoming update_fulfill_htlc message from the given peer.
820 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
821 /// Handle an incoming update_fail_htlc message from the given peer.
822 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
823 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
824 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
825 /// Handle an incoming commitment_signed message from the given peer.
826 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
827 /// Handle an incoming revoke_and_ack message from the given peer.
828 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
830 /// Handle an incoming update_fee message from the given peer.
831 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
833 // Channel-to-announce:
834 /// Handle an incoming announcement_signatures message from the given peer.
835 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
837 // Connection loss/reestablish:
838 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
839 /// is believed to be possible in the future (eg they're sending us messages we don't
840 /// understand or indicate they require unknown feature bits), no_connection_possible is set
841 /// and any outstanding channels should be failed.
842 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
844 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
845 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
846 /// Handle an incoming channel_reestablish message from the given peer.
847 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
849 /// Handle an incoming channel update from the given peer.
850 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
853 /// Handle an incoming error message from the given peer.
854 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
857 /// A trait to describe an object which can receive routing messages.
859 /// # Implementor DoS Warnings
861 /// For `gossip_queries` messages there are potential DoS vectors when handling
862 /// inbound queries. Implementors using an on-disk network graph should be aware of
863 /// repeated disk I/O for queries accessing different parts of the network graph.
864 pub trait RoutingMessageHandler : MessageSendEventsProvider {
865 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
866 /// false or returning an Err otherwise.
867 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
868 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
869 /// or returning an Err otherwise.
870 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
871 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
872 /// false or returning an Err otherwise.
873 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
874 /// Gets a subset of the channel announcements and updates required to dump our routing table
875 /// to a remote node, starting at the short_channel_id indicated by starting_point and
876 /// including the batch_amount entries immediately higher in numerical value than starting_point.
877 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
878 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
879 /// starting at the node *after* the provided publickey and including batch_amount entries
880 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
881 /// If None is provided for starting_point, we start at the first node.
882 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
883 /// Called when a connection is established with a peer. This can be used to
884 /// perform routing table synchronization using a strategy defined by the
886 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
887 /// Handles the reply of a query we initiated to learn about channels
888 /// for a given range of blocks. We can expect to receive one or more
889 /// replies to a single query.
890 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
891 /// Handles the reply of a query we initiated asking for routing gossip
892 /// messages for a list of channels. We should receive this message when
893 /// a node has completed its best effort to send us the pertaining routing
895 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
896 /// Handles when a peer asks us to send a list of short_channel_ids
897 /// for the requested range of blocks.
898 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
899 /// Handles when a peer asks us to send routing gossip messages for a
900 /// list of short_channel_ids.
901 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
904 mod fuzzy_internal_msgs {
906 use ln::{PaymentPreimage, PaymentSecret};
908 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
909 // them from untrusted input):
911 pub(crate) struct FinalOnionHopData {
912 pub(crate) payment_secret: PaymentSecret,
913 /// The total value, in msat, of the payment as received by the ultimate recipient.
914 /// Message serialization may panic if this value is more than 21 million Bitcoin.
915 pub(crate) total_msat: u64,
918 pub(crate) enum OnionHopDataFormat {
919 Legacy { // aka Realm-0
920 short_channel_id: u64,
923 short_channel_id: u64,
926 payment_data: Option<FinalOnionHopData>,
927 keysend_preimage: Option<PaymentPreimage>,
931 pub struct OnionHopData {
932 pub(crate) format: OnionHopDataFormat,
933 /// The value, in msat, of the payment after this hop's fee is deducted.
934 /// Message serialization may panic if this value is more than 21 million Bitcoin.
935 pub(crate) amt_to_forward: u64,
936 pub(crate) outgoing_cltv_value: u32,
937 // 12 bytes of 0-padding for Legacy format
940 pub struct DecodedOnionErrorPacket {
941 pub(crate) hmac: [u8; 32],
942 pub(crate) failuremsg: Vec<u8>,
943 pub(crate) pad: Vec<u8>,
947 pub use self::fuzzy_internal_msgs::*;
949 pub(crate) use self::fuzzy_internal_msgs::*;
952 pub(crate) struct OnionPacket {
953 pub(crate) version: u8,
954 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
955 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
956 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
957 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
958 pub(crate) hop_data: [u8; 20*65],
959 pub(crate) hmac: [u8; 32],
962 impl PartialEq for OnionPacket {
963 fn eq(&self, other: &OnionPacket) -> bool {
964 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
965 if i != j { return false; }
967 self.version == other.version &&
968 self.public_key == other.public_key &&
969 self.hmac == other.hmac
973 impl fmt::Debug for OnionPacket {
974 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
975 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
979 #[derive(Clone, Debug, PartialEq)]
980 pub(crate) struct OnionErrorPacket {
981 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
982 // (TODO) We limit it in decode to much lower...
983 pub(crate) data: Vec<u8>,
986 impl fmt::Display for DecodeError {
987 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
989 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
990 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
991 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
992 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
993 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
994 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
995 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1000 impl From<io::Error> for DecodeError {
1001 fn from(e: io::Error) -> Self {
1002 if e.kind() == io::ErrorKind::UnexpectedEof {
1003 DecodeError::ShortRead
1005 DecodeError::Io(e.kind())
1010 impl Writeable for OptionalField<Script> {
1011 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1013 OptionalField::Present(ref script) => {
1014 // Note that Writeable for script includes the 16-bit length tag for us
1017 OptionalField::Absent => {}
1023 impl Readable for OptionalField<Script> {
1024 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1025 match <u16 as Readable>::read(r) {
1027 let mut buf = vec![0; len as usize];
1028 r.read_exact(&mut buf)?;
1029 Ok(OptionalField::Present(Script::from(buf)))
1031 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1037 impl Writeable for OptionalField<u64> {
1038 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1040 OptionalField::Present(ref value) => {
1043 OptionalField::Absent => {}
1049 impl Readable for OptionalField<u64> {
1050 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1051 let value: u64 = Readable::read(r)?;
1052 Ok(OptionalField::Present(value))
1057 impl_writeable_msg!(AcceptChannel, {
1058 temporary_channel_id,
1059 dust_limit_satoshis,
1060 max_htlc_value_in_flight_msat,
1061 channel_reserve_satoshis,
1067 revocation_basepoint,
1069 delayed_payment_basepoint,
1071 first_per_commitment_point,
1072 shutdown_scriptpubkey
1074 (1, channel_type, option),
1077 impl_writeable_msg!(AnnouncementSignatures, {
1084 impl Writeable for ChannelReestablish {
1085 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1086 self.channel_id.write(w)?;
1087 self.next_local_commitment_number.write(w)?;
1088 self.next_remote_commitment_number.write(w)?;
1089 match self.data_loss_protect {
1090 OptionalField::Present(ref data_loss_protect) => {
1091 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1092 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1094 OptionalField::Absent => {}
1100 impl Readable for ChannelReestablish{
1101 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1103 channel_id: Readable::read(r)?,
1104 next_local_commitment_number: Readable::read(r)?,
1105 next_remote_commitment_number: Readable::read(r)?,
1106 data_loss_protect: {
1107 match <[u8; 32] as Readable>::read(r) {
1108 Ok(your_last_per_commitment_secret) =>
1109 OptionalField::Present(DataLossProtect {
1110 your_last_per_commitment_secret,
1111 my_current_per_commitment_point: Readable::read(r)?,
1113 Err(DecodeError::ShortRead) => OptionalField::Absent,
1114 Err(e) => return Err(e)
1121 impl_writeable_msg!(ClosingSigned,
1122 { channel_id, fee_satoshis, signature },
1123 { (1, fee_range, option) }
1126 impl_writeable!(ClosingSignedFeeRange, {
1131 impl_writeable_msg!(CommitmentSigned, {
1137 impl_writeable!(DecodedOnionErrorPacket, {
1143 impl_writeable_msg!(FundingCreated, {
1144 temporary_channel_id,
1146 funding_output_index,
1150 impl_writeable_msg!(FundingSigned, {
1155 impl_writeable_msg!(FundingLocked, {
1157 next_per_commitment_point,
1160 impl Writeable for Init {
1161 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1162 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1163 // our relevant feature bits. This keeps us compatible with old nodes.
1164 self.features.write_up_to_13(w)?;
1165 self.features.write(w)
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)?;
1174 features: features.or(global_features),
1179 impl_writeable_msg!(OpenChannel, {
1181 temporary_channel_id,
1184 dust_limit_satoshis,
1185 max_htlc_value_in_flight_msat,
1186 channel_reserve_satoshis,
1192 revocation_basepoint,
1194 delayed_payment_basepoint,
1196 first_per_commitment_point,
1198 shutdown_scriptpubkey
1200 (1, channel_type, option),
1203 impl_writeable_msg!(RevokeAndACK, {
1205 per_commitment_secret,
1206 next_per_commitment_point
1209 impl_writeable_msg!(Shutdown, {
1214 impl_writeable_msg!(UpdateFailHTLC, {
1220 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1227 impl_writeable_msg!(UpdateFee, {
1232 impl_writeable_msg!(UpdateFulfillHTLC, {
1238 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1239 // serialization format in a way which assumes we know the total serialized length/message end
1241 impl_writeable!(OnionErrorPacket, {
1245 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1246 // serialization format in a way which assumes we know the total serialized length/message end
1248 impl Writeable for OnionPacket {
1249 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1250 self.version.write(w)?;
1251 match self.public_key {
1252 Ok(pubkey) => pubkey.write(w)?,
1253 Err(_) => [0u8;33].write(w)?,
1255 w.write_all(&self.hop_data)?;
1256 self.hmac.write(w)?;
1261 impl Readable for OnionPacket {
1262 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1264 version: Readable::read(r)?,
1266 let mut buf = [0u8;33];
1267 r.read_exact(&mut buf)?;
1268 PublicKey::from_slice(&buf)
1270 hop_data: Readable::read(r)?,
1271 hmac: Readable::read(r)?,
1276 impl_writeable_msg!(UpdateAddHTLC, {
1282 onion_routing_packet
1285 impl Writeable for FinalOnionHopData {
1286 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1287 self.payment_secret.0.write(w)?;
1288 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1292 impl Readable for FinalOnionHopData {
1293 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1294 let secret: [u8; 32] = Readable::read(r)?;
1295 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1296 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1300 impl Writeable for OnionHopData {
1301 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1303 OnionHopDataFormat::Legacy { short_channel_id } => {
1305 short_channel_id.write(w)?;
1306 self.amt_to_forward.write(w)?;
1307 self.outgoing_cltv_value.write(w)?;
1308 w.write_all(&[0;12])?;
1310 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1311 encode_varint_length_prefixed_tlv!(w, {
1312 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1313 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1314 (6, short_channel_id, required)
1317 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1318 encode_varint_length_prefixed_tlv!(w, {
1319 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1320 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1321 (8, payment_data, option),
1322 (5482373484, keysend_preimage, option)
1330 impl Readable for OnionHopData {
1331 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1332 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1333 let v: VarInt = Decodable::consensus_decode(&mut r)
1334 .map_err(|e| match e {
1335 Error::Io(ioe) => DecodeError::from(ioe),
1336 _ => DecodeError::InvalidValue
1338 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1339 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1340 let mut rd = FixedLengthReader::new(r, v.0);
1341 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1342 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1343 let mut short_id: Option<u64> = None;
1344 let mut payment_data: Option<FinalOnionHopData> = None;
1345 let mut keysend_preimage: Option<PaymentPreimage> = None;
1346 // The TLV type is chosen to be compatible with lnd and c-lightning.
1347 decode_tlv_stream!(&mut rd, {
1349 (4, cltv_value, required),
1350 (6, short_id, option),
1351 (8, payment_data, option),
1352 (5482373484, keysend_preimage, option)
1354 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1355 let format = if let Some(short_channel_id) = short_id {
1356 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1357 OnionHopDataFormat::NonFinalNode {
1361 if let &Some(ref data) = &payment_data {
1362 if data.total_msat > MAX_VALUE_MSAT {
1363 return Err(DecodeError::InvalidValue);
1366 OnionHopDataFormat::FinalNode {
1371 (format, amt.0, cltv_value.0)
1373 let format = OnionHopDataFormat::Legacy {
1374 short_channel_id: Readable::read(r)?,
1376 let amt: u64 = Readable::read(r)?;
1377 let cltv_value: u32 = Readable::read(r)?;
1378 r.read_exact(&mut [0; 12])?;
1379 (format, amt, cltv_value)
1382 if amt > MAX_VALUE_MSAT {
1383 return Err(DecodeError::InvalidValue);
1387 amt_to_forward: amt,
1388 outgoing_cltv_value: cltv_value,
1393 impl Writeable for Ping {
1394 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1395 self.ponglen.write(w)?;
1396 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1401 impl Readable for Ping {
1402 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1404 ponglen: Readable::read(r)?,
1406 let byteslen = Readable::read(r)?;
1407 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1414 impl Writeable for Pong {
1415 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1416 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1421 impl Readable for Pong {
1422 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1425 let byteslen = Readable::read(r)?;
1426 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1433 impl Writeable for UnsignedChannelAnnouncement {
1434 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1435 self.features.write(w)?;
1436 self.chain_hash.write(w)?;
1437 self.short_channel_id.write(w)?;
1438 self.node_id_1.write(w)?;
1439 self.node_id_2.write(w)?;
1440 self.bitcoin_key_1.write(w)?;
1441 self.bitcoin_key_2.write(w)?;
1442 w.write_all(&self.excess_data[..])?;
1447 impl Readable for UnsignedChannelAnnouncement {
1448 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1450 features: Readable::read(r)?,
1451 chain_hash: Readable::read(r)?,
1452 short_channel_id: Readable::read(r)?,
1453 node_id_1: Readable::read(r)?,
1454 node_id_2: Readable::read(r)?,
1455 bitcoin_key_1: Readable::read(r)?,
1456 bitcoin_key_2: Readable::read(r)?,
1457 excess_data: read_to_end(r)?,
1462 impl_writeable!(ChannelAnnouncement, {
1465 bitcoin_signature_1,
1466 bitcoin_signature_2,
1470 impl Writeable for UnsignedChannelUpdate {
1471 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1472 let mut message_flags: u8 = 0;
1473 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1476 self.chain_hash.write(w)?;
1477 self.short_channel_id.write(w)?;
1478 self.timestamp.write(w)?;
1479 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1480 all_flags.write(w)?;
1481 self.cltv_expiry_delta.write(w)?;
1482 self.htlc_minimum_msat.write(w)?;
1483 self.fee_base_msat.write(w)?;
1484 self.fee_proportional_millionths.write(w)?;
1485 self.htlc_maximum_msat.write(w)?;
1486 w.write_all(&self.excess_data[..])?;
1491 impl Readable for UnsignedChannelUpdate {
1492 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1493 let has_htlc_maximum_msat;
1495 chain_hash: Readable::read(r)?,
1496 short_channel_id: Readable::read(r)?,
1497 timestamp: Readable::read(r)?,
1499 let flags: u16 = Readable::read(r)?;
1500 let message_flags = flags >> 8;
1501 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1504 cltv_expiry_delta: Readable::read(r)?,
1505 htlc_minimum_msat: Readable::read(r)?,
1506 fee_base_msat: Readable::read(r)?,
1507 fee_proportional_millionths: Readable::read(r)?,
1508 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1509 excess_data: read_to_end(r)?,
1514 impl_writeable!(ChannelUpdate, {
1519 impl Writeable for ErrorMessage {
1520 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1521 self.channel_id.write(w)?;
1522 (self.data.len() as u16).write(w)?;
1523 w.write_all(self.data.as_bytes())?;
1528 impl Readable for ErrorMessage {
1529 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1531 channel_id: Readable::read(r)?,
1533 let sz: usize = <u16 as Readable>::read(r)? as usize;
1534 let mut data = Vec::with_capacity(sz);
1536 r.read_exact(&mut data)?;
1537 match String::from_utf8(data) {
1539 Err(_) => return Err(DecodeError::InvalidValue),
1546 impl Writeable for WarningMessage {
1547 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1548 self.channel_id.write(w)?;
1549 (self.data.len() as u16).write(w)?;
1550 w.write_all(self.data.as_bytes())?;
1555 impl Readable for WarningMessage {
1556 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1558 channel_id: Readable::read(r)?,
1560 let sz: usize = <u16 as Readable>::read(r)? as usize;
1561 let mut data = Vec::with_capacity(sz);
1563 r.read_exact(&mut data)?;
1564 match String::from_utf8(data) {
1566 Err(_) => return Err(DecodeError::InvalidValue),
1573 impl Writeable for UnsignedNodeAnnouncement {
1574 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1575 self.features.write(w)?;
1576 self.timestamp.write(w)?;
1577 self.node_id.write(w)?;
1578 w.write_all(&self.rgb)?;
1579 self.alias.write(w)?;
1581 let mut addr_len = 0;
1582 for addr in self.addresses.iter() {
1583 addr_len += 1 + addr.len();
1585 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1586 for addr in self.addresses.iter() {
1589 w.write_all(&self.excess_address_data[..])?;
1590 w.write_all(&self.excess_data[..])?;
1595 impl Readable for UnsignedNodeAnnouncement {
1596 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1597 let features: NodeFeatures = Readable::read(r)?;
1598 let timestamp: u32 = Readable::read(r)?;
1599 let node_id: PublicKey = Readable::read(r)?;
1600 let mut rgb = [0; 3];
1601 r.read_exact(&mut rgb)?;
1602 let alias: [u8; 32] = Readable::read(r)?;
1604 let addr_len: u16 = Readable::read(r)?;
1605 let mut addresses: Vec<NetAddress> = Vec::new();
1606 let mut addr_readpos = 0;
1607 let mut excess = false;
1608 let mut excess_byte = 0;
1610 if addr_len <= addr_readpos { break; }
1611 match Readable::read(r) {
1613 if addr_len < addr_readpos + 1 + addr.len() {
1614 return Err(DecodeError::BadLengthDescriptor);
1616 addr_readpos += (1 + addr.len()) as u16;
1617 addresses.push(addr);
1619 Ok(Err(unknown_descriptor)) => {
1621 excess_byte = unknown_descriptor;
1624 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1625 Err(e) => return Err(e),
1629 let mut excess_data = vec![];
1630 let excess_address_data = if addr_readpos < addr_len {
1631 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1632 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1634 excess_address_data[0] = excess_byte;
1639 excess_data.push(excess_byte);
1643 excess_data.extend(read_to_end(r)?.iter());
1644 Ok(UnsignedNodeAnnouncement {
1651 excess_address_data,
1657 impl_writeable!(NodeAnnouncement, {
1662 impl Readable for QueryShortChannelIds {
1663 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1664 let chain_hash: BlockHash = Readable::read(r)?;
1666 let encoding_len: u16 = Readable::read(r)?;
1667 let encoding_type: u8 = Readable::read(r)?;
1669 // Must be encoding_type=0 uncompressed serialization. We do not
1670 // support encoding_type=1 zlib serialization.
1671 if encoding_type != EncodingType::Uncompressed as u8 {
1672 return Err(DecodeError::UnsupportedCompression);
1675 // We expect the encoding_len to always includes the 1-byte
1676 // encoding_type and that short_channel_ids are 8-bytes each
1677 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1678 return Err(DecodeError::InvalidValue);
1681 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1682 // less the 1-byte encoding_type
1683 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1684 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1685 for _ in 0..short_channel_id_count {
1686 short_channel_ids.push(Readable::read(r)?);
1689 Ok(QueryShortChannelIds {
1696 impl Writeable for QueryShortChannelIds {
1697 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1698 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1699 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1701 self.chain_hash.write(w)?;
1702 encoding_len.write(w)?;
1704 // We only support type=0 uncompressed serialization
1705 (EncodingType::Uncompressed as u8).write(w)?;
1707 for scid in self.short_channel_ids.iter() {
1715 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1720 impl QueryChannelRange {
1722 * Calculates the overflow safe ending block height for the query.
1723 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1725 pub fn end_blocknum(&self) -> u32 {
1726 match self.first_blocknum.checked_add(self.number_of_blocks) {
1727 Some(block) => block,
1728 None => u32::max_value(),
1733 impl_writeable_msg!(QueryChannelRange, {
1739 impl Readable for ReplyChannelRange {
1740 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1741 let chain_hash: BlockHash = Readable::read(r)?;
1742 let first_blocknum: u32 = Readable::read(r)?;
1743 let number_of_blocks: u32 = Readable::read(r)?;
1744 let sync_complete: bool = Readable::read(r)?;
1746 let encoding_len: u16 = Readable::read(r)?;
1747 let encoding_type: u8 = Readable::read(r)?;
1749 // Must be encoding_type=0 uncompressed serialization. We do not
1750 // support encoding_type=1 zlib serialization.
1751 if encoding_type != EncodingType::Uncompressed as u8 {
1752 return Err(DecodeError::UnsupportedCompression);
1755 // We expect the encoding_len to always includes the 1-byte
1756 // encoding_type and that short_channel_ids are 8-bytes each
1757 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1758 return Err(DecodeError::InvalidValue);
1761 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1762 // less the 1-byte encoding_type
1763 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1764 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1765 for _ in 0..short_channel_id_count {
1766 short_channel_ids.push(Readable::read(r)?);
1769 Ok(ReplyChannelRange {
1779 impl Writeable for ReplyChannelRange {
1780 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1781 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1782 self.chain_hash.write(w)?;
1783 self.first_blocknum.write(w)?;
1784 self.number_of_blocks.write(w)?;
1785 self.sync_complete.write(w)?;
1787 encoding_len.write(w)?;
1788 (EncodingType::Uncompressed as u8).write(w)?;
1789 for scid in self.short_channel_ids.iter() {
1797 impl_writeable_msg!(GossipTimestampFilter, {
1806 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1807 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1809 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1810 use util::ser::{Writeable, Readable};
1812 use bitcoin::hashes::hex::FromHex;
1813 use bitcoin::util::address::Address;
1814 use bitcoin::network::constants::Network;
1815 use bitcoin::blockdata::script::Builder;
1816 use bitcoin::blockdata::opcodes;
1817 use bitcoin::hash_types::{Txid, BlockHash};
1819 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1820 use bitcoin::secp256k1::{Secp256k1, Message};
1826 fn encoding_channel_reestablish_no_secret() {
1827 let cr = msgs::ChannelReestablish {
1828 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],
1829 next_local_commitment_number: 3,
1830 next_remote_commitment_number: 4,
1831 data_loss_protect: OptionalField::Absent,
1834 let encoded_value = cr.encode();
1837 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]
1842 fn encoding_channel_reestablish_with_secret() {
1844 let secp_ctx = Secp256k1::new();
1845 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1848 let cr = msgs::ChannelReestablish {
1849 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],
1850 next_local_commitment_number: 3,
1851 next_remote_commitment_number: 4,
1852 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1855 let encoded_value = cr.encode();
1858 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]
1862 macro_rules! get_keys_from {
1863 ($slice: expr, $secp_ctx: expr) => {
1865 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1866 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1872 macro_rules! get_sig_on {
1873 ($privkey: expr, $ctx: expr, $string: expr) => {
1875 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1876 $ctx.sign(&sighash, &$privkey)
1882 fn encoding_announcement_signatures() {
1883 let secp_ctx = Secp256k1::new();
1884 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1885 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1886 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1887 let announcement_signatures = msgs::AnnouncementSignatures {
1888 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],
1889 short_channel_id: 2316138423780173,
1890 node_signature: sig_1,
1891 bitcoin_signature: sig_2,
1894 let encoded_value = announcement_signatures.encode();
1895 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1898 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1899 let secp_ctx = Secp256k1::new();
1900 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1901 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1902 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1903 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1904 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1905 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1906 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1907 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1908 let mut features = ChannelFeatures::known();
1909 if unknown_features_bits {
1910 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1912 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1914 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1915 short_channel_id: 2316138423780173,
1916 node_id_1: pubkey_1,
1917 node_id_2: pubkey_2,
1918 bitcoin_key_1: pubkey_3,
1919 bitcoin_key_2: pubkey_4,
1920 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1922 let channel_announcement = msgs::ChannelAnnouncement {
1923 node_signature_1: sig_1,
1924 node_signature_2: sig_2,
1925 bitcoin_signature_1: sig_3,
1926 bitcoin_signature_2: sig_4,
1927 contents: unsigned_channel_announcement,
1929 let encoded_value = channel_announcement.encode();
1930 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1931 if unknown_features_bits {
1932 target_value.append(&mut hex::decode("0002ffff").unwrap());
1934 target_value.append(&mut hex::decode("0000").unwrap());
1936 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1937 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1939 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1941 assert_eq!(encoded_value, target_value);
1945 fn encoding_channel_announcement() {
1946 do_encoding_channel_announcement(true, false);
1947 do_encoding_channel_announcement(false, true);
1948 do_encoding_channel_announcement(false, false);
1949 do_encoding_channel_announcement(true, true);
1952 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1953 let secp_ctx = Secp256k1::new();
1954 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1955 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1956 let features = if unknown_features_bits {
1957 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1959 // Set to some features we may support
1960 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1962 let mut addresses = Vec::new();
1964 addresses.push(msgs::NetAddress::IPv4 {
1965 addr: [255, 254, 253, 252],
1970 addresses.push(msgs::NetAddress::IPv6 {
1971 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1976 addresses.push(msgs::NetAddress::OnionV2(
1977 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
1981 addresses.push(msgs::NetAddress::OnionV3 {
1982 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],
1988 let mut addr_len = 0;
1989 for addr in &addresses {
1990 addr_len += addr.len() + 1;
1992 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1994 timestamp: 20190119,
1999 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() },
2000 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() },
2002 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2003 let node_announcement = msgs::NodeAnnouncement {
2005 contents: unsigned_node_announcement,
2007 let encoded_value = node_announcement.encode();
2008 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2009 if unknown_features_bits {
2010 target_value.append(&mut hex::decode("0002ffff").unwrap());
2012 target_value.append(&mut hex::decode("000122").unwrap());
2014 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2015 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2017 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2020 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2023 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2026 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2028 if excess_address_data {
2029 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2032 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2034 assert_eq!(encoded_value, target_value);
2038 fn encoding_node_announcement() {
2039 do_encoding_node_announcement(true, true, true, true, true, true, true);
2040 do_encoding_node_announcement(false, false, false, false, false, false, false);
2041 do_encoding_node_announcement(false, true, false, false, false, false, false);
2042 do_encoding_node_announcement(false, false, true, false, false, false, false);
2043 do_encoding_node_announcement(false, false, false, true, false, false, false);
2044 do_encoding_node_announcement(false, false, false, false, true, false, false);
2045 do_encoding_node_announcement(false, false, false, false, false, true, false);
2046 do_encoding_node_announcement(false, true, false, true, false, true, false);
2047 do_encoding_node_announcement(false, false, true, false, true, false, false);
2050 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2051 let secp_ctx = Secp256k1::new();
2052 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2053 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2054 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2055 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2056 short_channel_id: 2316138423780173,
2057 timestamp: 20190119,
2058 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2059 cltv_expiry_delta: 144,
2060 htlc_minimum_msat: 1000000,
2061 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2062 fee_base_msat: 10000,
2063 fee_proportional_millionths: 20,
2064 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2066 let channel_update = msgs::ChannelUpdate {
2068 contents: unsigned_channel_update
2070 let encoded_value = channel_update.encode();
2071 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2072 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2073 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2074 if htlc_maximum_msat {
2075 target_value.append(&mut hex::decode("01").unwrap());
2077 target_value.append(&mut hex::decode("00").unwrap());
2079 target_value.append(&mut hex::decode("00").unwrap());
2081 let flag = target_value.last_mut().unwrap();
2085 let flag = target_value.last_mut().unwrap();
2086 *flag = *flag | 1 << 1;
2088 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2089 if htlc_maximum_msat {
2090 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2093 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2095 assert_eq!(encoded_value, target_value);
2099 fn encoding_channel_update() {
2100 do_encoding_channel_update(false, false, false, false);
2101 do_encoding_channel_update(false, false, false, true);
2102 do_encoding_channel_update(true, false, false, false);
2103 do_encoding_channel_update(true, false, false, true);
2104 do_encoding_channel_update(false, true, false, false);
2105 do_encoding_channel_update(false, true, false, true);
2106 do_encoding_channel_update(false, false, true, false);
2107 do_encoding_channel_update(false, false, true, true);
2108 do_encoding_channel_update(true, true, true, false);
2109 do_encoding_channel_update(true, true, true, true);
2112 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2113 let secp_ctx = Secp256k1::new();
2114 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2115 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2116 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2117 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2118 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2119 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2120 let open_channel = msgs::OpenChannel {
2121 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2122 temporary_channel_id: [2; 32],
2123 funding_satoshis: 1311768467284833366,
2124 push_msat: 2536655962884945560,
2125 dust_limit_satoshis: 3608586615801332854,
2126 max_htlc_value_in_flight_msat: 8517154655701053848,
2127 channel_reserve_satoshis: 8665828695742877976,
2128 htlc_minimum_msat: 2316138423780173,
2129 feerate_per_kw: 821716,
2130 to_self_delay: 49340,
2131 max_accepted_htlcs: 49340,
2132 funding_pubkey: pubkey_1,
2133 revocation_basepoint: pubkey_2,
2134 payment_point: pubkey_3,
2135 delayed_payment_basepoint: pubkey_4,
2136 htlc_basepoint: pubkey_5,
2137 first_per_commitment_point: pubkey_6,
2138 channel_flags: if random_bit { 1 << 5 } else { 0 },
2139 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2140 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2142 let encoded_value = open_channel.encode();
2143 let mut target_value = Vec::new();
2144 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2145 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2147 target_value.append(&mut hex::decode("20").unwrap());
2149 target_value.append(&mut hex::decode("00").unwrap());
2152 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2155 target_value.append(&mut hex::decode("0100").unwrap());
2157 assert_eq!(encoded_value, target_value);
2161 fn encoding_open_channel() {
2162 do_encoding_open_channel(false, false, false);
2163 do_encoding_open_channel(false, false, true);
2164 do_encoding_open_channel(false, true, false);
2165 do_encoding_open_channel(false, true, true);
2166 do_encoding_open_channel(true, false, false);
2167 do_encoding_open_channel(true, false, true);
2168 do_encoding_open_channel(true, true, false);
2169 do_encoding_open_channel(true, true, true);
2172 fn do_encoding_accept_channel(shutdown: bool) {
2173 let secp_ctx = Secp256k1::new();
2174 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2175 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2176 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2177 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2178 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2179 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2180 let accept_channel = msgs::AcceptChannel {
2181 temporary_channel_id: [2; 32],
2182 dust_limit_satoshis: 1311768467284833366,
2183 max_htlc_value_in_flight_msat: 2536655962884945560,
2184 channel_reserve_satoshis: 3608586615801332854,
2185 htlc_minimum_msat: 2316138423780173,
2186 minimum_depth: 821716,
2187 to_self_delay: 49340,
2188 max_accepted_htlcs: 49340,
2189 funding_pubkey: pubkey_1,
2190 revocation_basepoint: pubkey_2,
2191 payment_point: pubkey_3,
2192 delayed_payment_basepoint: pubkey_4,
2193 htlc_basepoint: pubkey_5,
2194 first_per_commitment_point: pubkey_6,
2195 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2198 let encoded_value = accept_channel.encode();
2199 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2201 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2203 assert_eq!(encoded_value, target_value);
2207 fn encoding_accept_channel() {
2208 do_encoding_accept_channel(false);
2209 do_encoding_accept_channel(true);
2213 fn encoding_funding_created() {
2214 let secp_ctx = Secp256k1::new();
2215 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2216 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2217 let funding_created = msgs::FundingCreated {
2218 temporary_channel_id: [2; 32],
2219 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2220 funding_output_index: 255,
2223 let encoded_value = funding_created.encode();
2224 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2225 assert_eq!(encoded_value, target_value);
2229 fn encoding_funding_signed() {
2230 let secp_ctx = Secp256k1::new();
2231 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2232 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2233 let funding_signed = msgs::FundingSigned {
2234 channel_id: [2; 32],
2237 let encoded_value = funding_signed.encode();
2238 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2239 assert_eq!(encoded_value, target_value);
2243 fn encoding_funding_locked() {
2244 let secp_ctx = Secp256k1::new();
2245 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2246 let funding_locked = msgs::FundingLocked {
2247 channel_id: [2; 32],
2248 next_per_commitment_point: pubkey_1,
2250 let encoded_value = funding_locked.encode();
2251 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2252 assert_eq!(encoded_value, target_value);
2255 fn do_encoding_shutdown(script_type: u8) {
2256 let secp_ctx = Secp256k1::new();
2257 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2258 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2259 let shutdown = msgs::Shutdown {
2260 channel_id: [2; 32],
2262 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2263 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2264 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2265 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2267 let encoded_value = shutdown.encode();
2268 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2269 if script_type == 1 {
2270 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2271 } else if script_type == 2 {
2272 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2273 } else if script_type == 3 {
2274 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2275 } else if script_type == 4 {
2276 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2278 assert_eq!(encoded_value, target_value);
2282 fn encoding_shutdown() {
2283 do_encoding_shutdown(1);
2284 do_encoding_shutdown(2);
2285 do_encoding_shutdown(3);
2286 do_encoding_shutdown(4);
2290 fn encoding_closing_signed() {
2291 let secp_ctx = Secp256k1::new();
2292 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2293 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2294 let closing_signed = msgs::ClosingSigned {
2295 channel_id: [2; 32],
2296 fee_satoshis: 2316138423780173,
2300 let encoded_value = closing_signed.encode();
2301 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2302 assert_eq!(encoded_value, target_value);
2303 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2305 let closing_signed_with_range = msgs::ClosingSigned {
2306 channel_id: [2; 32],
2307 fee_satoshis: 2316138423780173,
2309 fee_range: Some(msgs::ClosingSignedFeeRange {
2310 min_fee_satoshis: 0xdeadbeef,
2311 max_fee_satoshis: 0x1badcafe01234567,
2314 let encoded_value_with_range = closing_signed_with_range.encode();
2315 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2316 assert_eq!(encoded_value_with_range, target_value_with_range);
2317 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2318 closing_signed_with_range);
2322 fn encoding_update_add_htlc() {
2323 let secp_ctx = Secp256k1::new();
2324 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2325 let onion_routing_packet = msgs::OnionPacket {
2327 public_key: Ok(pubkey_1),
2328 hop_data: [1; 20*65],
2331 let update_add_htlc = msgs::UpdateAddHTLC {
2332 channel_id: [2; 32],
2333 htlc_id: 2316138423780173,
2334 amount_msat: 3608586615801332854,
2335 payment_hash: PaymentHash([1; 32]),
2336 cltv_expiry: 821716,
2337 onion_routing_packet
2339 let encoded_value = update_add_htlc.encode();
2340 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2341 assert_eq!(encoded_value, target_value);
2345 fn encoding_update_fulfill_htlc() {
2346 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2347 channel_id: [2; 32],
2348 htlc_id: 2316138423780173,
2349 payment_preimage: PaymentPreimage([1; 32]),
2351 let encoded_value = update_fulfill_htlc.encode();
2352 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2353 assert_eq!(encoded_value, target_value);
2357 fn encoding_update_fail_htlc() {
2358 let reason = OnionErrorPacket {
2359 data: [1; 32].to_vec(),
2361 let update_fail_htlc = msgs::UpdateFailHTLC {
2362 channel_id: [2; 32],
2363 htlc_id: 2316138423780173,
2366 let encoded_value = update_fail_htlc.encode();
2367 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2368 assert_eq!(encoded_value, target_value);
2372 fn encoding_update_fail_malformed_htlc() {
2373 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2374 channel_id: [2; 32],
2375 htlc_id: 2316138423780173,
2376 sha256_of_onion: [1; 32],
2379 let encoded_value = update_fail_malformed_htlc.encode();
2380 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2381 assert_eq!(encoded_value, target_value);
2384 fn do_encoding_commitment_signed(htlcs: bool) {
2385 let secp_ctx = Secp256k1::new();
2386 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2387 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2388 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2389 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2390 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2391 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2392 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2393 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2394 let commitment_signed = msgs::CommitmentSigned {
2395 channel_id: [2; 32],
2397 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2399 let encoded_value = commitment_signed.encode();
2400 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2402 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2404 target_value.append(&mut hex::decode("0000").unwrap());
2406 assert_eq!(encoded_value, target_value);
2410 fn encoding_commitment_signed() {
2411 do_encoding_commitment_signed(true);
2412 do_encoding_commitment_signed(false);
2416 fn encoding_revoke_and_ack() {
2417 let secp_ctx = Secp256k1::new();
2418 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2419 let raa = msgs::RevokeAndACK {
2420 channel_id: [2; 32],
2421 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],
2422 next_per_commitment_point: pubkey_1,
2424 let encoded_value = raa.encode();
2425 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2426 assert_eq!(encoded_value, target_value);
2430 fn encoding_update_fee() {
2431 let update_fee = msgs::UpdateFee {
2432 channel_id: [2; 32],
2433 feerate_per_kw: 20190119,
2435 let encoded_value = update_fee.encode();
2436 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2437 assert_eq!(encoded_value, target_value);
2441 fn encoding_init() {
2442 assert_eq!(msgs::Init {
2443 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2444 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2445 assert_eq!(msgs::Init {
2446 features: InitFeatures::from_le_bytes(vec![0xFF]),
2447 }.encode(), hex::decode("0001ff0001ff").unwrap());
2448 assert_eq!(msgs::Init {
2449 features: InitFeatures::from_le_bytes(vec![]),
2450 }.encode(), hex::decode("00000000").unwrap());
2454 fn encoding_error() {
2455 let error = msgs::ErrorMessage {
2456 channel_id: [2; 32],
2457 data: String::from("rust-lightning"),
2459 let encoded_value = error.encode();
2460 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2461 assert_eq!(encoded_value, target_value);
2465 fn encoding_warning() {
2466 let error = msgs::WarningMessage {
2467 channel_id: [2; 32],
2468 data: String::from("rust-lightning"),
2470 let encoded_value = error.encode();
2471 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2472 assert_eq!(encoded_value, target_value);
2476 fn encoding_ping() {
2477 let ping = msgs::Ping {
2481 let encoded_value = ping.encode();
2482 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2483 assert_eq!(encoded_value, target_value);
2487 fn encoding_pong() {
2488 let pong = msgs::Pong {
2491 let encoded_value = pong.encode();
2492 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2493 assert_eq!(encoded_value, target_value);
2497 fn encoding_legacy_onion_hop_data() {
2498 let msg = msgs::OnionHopData {
2499 format: OnionHopDataFormat::Legacy {
2500 short_channel_id: 0xdeadbeef1bad1dea,
2502 amt_to_forward: 0x0badf00d01020304,
2503 outgoing_cltv_value: 0xffffffff,
2505 let encoded_value = msg.encode();
2506 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2507 assert_eq!(encoded_value, target_value);
2511 fn encoding_nonfinal_onion_hop_data() {
2512 let mut msg = msgs::OnionHopData {
2513 format: OnionHopDataFormat::NonFinalNode {
2514 short_channel_id: 0xdeadbeef1bad1dea,
2516 amt_to_forward: 0x0badf00d01020304,
2517 outgoing_cltv_value: 0xffffffff,
2519 let encoded_value = msg.encode();
2520 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2521 assert_eq!(encoded_value, target_value);
2522 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2523 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2524 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2525 } else { panic!(); }
2526 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2527 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2531 fn encoding_final_onion_hop_data() {
2532 let mut msg = msgs::OnionHopData {
2533 format: OnionHopDataFormat::FinalNode {
2535 keysend_preimage: None,
2537 amt_to_forward: 0x0badf00d01020304,
2538 outgoing_cltv_value: 0xffffffff,
2540 let encoded_value = msg.encode();
2541 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2542 assert_eq!(encoded_value, target_value);
2543 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2544 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2545 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2546 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2550 fn encoding_final_onion_hop_data_with_secret() {
2551 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2552 let mut msg = msgs::OnionHopData {
2553 format: OnionHopDataFormat::FinalNode {
2554 payment_data: Some(FinalOnionHopData {
2555 payment_secret: expected_payment_secret,
2556 total_msat: 0x1badca1f
2558 keysend_preimage: None,
2560 amt_to_forward: 0x0badf00d01020304,
2561 outgoing_cltv_value: 0xffffffff,
2563 let encoded_value = msg.encode();
2564 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2565 assert_eq!(encoded_value, target_value);
2566 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2567 if let OnionHopDataFormat::FinalNode {
2568 payment_data: Some(FinalOnionHopData {
2570 total_msat: 0x1badca1f
2572 keysend_preimage: None,
2574 assert_eq!(payment_secret, expected_payment_secret);
2575 } else { panic!(); }
2576 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2577 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2581 fn query_channel_range_end_blocknum() {
2582 let tests: Vec<(u32, u32, u32)> = vec![
2583 (10000, 1500, 11500),
2584 (0, 0xffffffff, 0xffffffff),
2585 (1, 0xffffffff, 0xffffffff),
2588 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2589 let sut = msgs::QueryChannelRange {
2590 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2594 assert_eq!(sut.end_blocknum(), expected);
2599 fn encoding_query_channel_range() {
2600 let mut query_channel_range = msgs::QueryChannelRange {
2601 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2602 first_blocknum: 100000,
2603 number_of_blocks: 1500,
2605 let encoded_value = query_channel_range.encode();
2606 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2607 assert_eq!(encoded_value, target_value);
2609 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2610 assert_eq!(query_channel_range.first_blocknum, 100000);
2611 assert_eq!(query_channel_range.number_of_blocks, 1500);
2615 fn encoding_reply_channel_range() {
2616 do_encoding_reply_channel_range(0);
2617 do_encoding_reply_channel_range(1);
2620 fn do_encoding_reply_channel_range(encoding_type: u8) {
2621 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2622 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2623 let mut reply_channel_range = msgs::ReplyChannelRange {
2624 chain_hash: expected_chain_hash,
2625 first_blocknum: 756230,
2626 number_of_blocks: 1500,
2627 sync_complete: true,
2628 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2631 if encoding_type == 0 {
2632 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2633 let encoded_value = reply_channel_range.encode();
2634 assert_eq!(encoded_value, target_value);
2636 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2637 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2638 assert_eq!(reply_channel_range.first_blocknum, 756230);
2639 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2640 assert_eq!(reply_channel_range.sync_complete, true);
2641 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2642 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2643 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2645 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2646 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2647 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2652 fn encoding_query_short_channel_ids() {
2653 do_encoding_query_short_channel_ids(0);
2654 do_encoding_query_short_channel_ids(1);
2657 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2658 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2659 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2660 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2661 chain_hash: expected_chain_hash,
2662 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2665 if encoding_type == 0 {
2666 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2667 let encoded_value = query_short_channel_ids.encode();
2668 assert_eq!(encoded_value, target_value);
2670 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2671 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2672 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2673 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2674 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2676 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2677 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2678 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2683 fn encoding_reply_short_channel_ids_end() {
2684 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2685 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2686 chain_hash: expected_chain_hash,
2687 full_information: true,
2689 let encoded_value = reply_short_channel_ids_end.encode();
2690 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2691 assert_eq!(encoded_value, target_value);
2693 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2694 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2695 assert_eq!(reply_short_channel_ids_end.full_information, true);
2699 fn encoding_gossip_timestamp_filter(){
2700 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2701 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2702 chain_hash: expected_chain_hash,
2703 first_timestamp: 1590000000,
2704 timestamp_range: 0xffff_ffff,
2706 let encoded_value = gossip_timestamp_filter.encode();
2707 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2708 assert_eq!(encoded_value, target_value);
2710 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2711 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2712 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2713 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);