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, InitFeatures, NodeFeatures};
40 use util::events::MessageSendEventsProvider;
42 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
44 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
46 /// 21 million * 10^8 * 1000
47 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
49 /// An error in decoding a message or struct.
50 #[derive(Clone, Debug, PartialEq)]
51 pub enum DecodeError {
52 /// A version byte specified something we don't know how to handle.
53 /// Includes unknown realm byte in an OnionHopData packet
55 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
56 UnknownRequiredFeature,
57 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
58 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
59 /// syntactically incorrect, etc
63 /// A length descriptor in the packet didn't describe the later data correctly
65 /// Error from std::io
66 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
67 ::std::io::ErrorKind),
68 /// The message included zlib-compressed values, which we don't support.
69 UnsupportedCompression,
72 /// An init message to be sent or received from a peer
73 #[derive(Clone, Debug, PartialEq)]
75 /// The relevant features which the sender supports
76 pub features: InitFeatures,
79 /// An error message to be sent or received from a peer
80 #[derive(Clone, Debug, PartialEq)]
81 pub struct ErrorMessage {
82 /// The channel ID involved in the error
83 pub channel_id: [u8; 32],
84 /// A possibly human-readable error description.
85 /// The string should be sanitized before it is used (e.g. emitted to logs
86 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
87 /// vulnerability in the terminal emulator or the logging subsystem.
91 /// A ping message to be sent or received from a peer
92 #[derive(Clone, Debug, PartialEq)]
94 /// The desired response length
96 /// The ping packet size.
97 /// This field is not sent on the wire. byteslen zeros are sent.
101 /// A pong message to be sent or received from a peer
102 #[derive(Clone, Debug, PartialEq)]
104 /// The pong packet size.
105 /// This field is not sent on the wire. byteslen zeros are sent.
109 /// An open_channel message to be sent or received from a peer
110 #[derive(Clone, Debug, PartialEq)]
111 pub struct OpenChannel {
112 /// The genesis hash of the blockchain where the channel is to be opened
113 pub chain_hash: BlockHash,
114 /// A temporary channel ID, until the funding outpoint is announced
115 pub temporary_channel_id: [u8; 32],
116 /// The channel value
117 pub funding_satoshis: u64,
118 /// The amount to push to the counterparty as part of the open, in milli-satoshi
120 /// The threshold below which outputs on transactions broadcast by sender will be omitted
121 pub dust_limit_satoshis: u64,
122 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
123 pub max_htlc_value_in_flight_msat: u64,
124 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
125 pub channel_reserve_satoshis: u64,
126 /// The minimum HTLC size incoming to sender, in milli-satoshi
127 pub htlc_minimum_msat: u64,
128 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
129 pub feerate_per_kw: u32,
130 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
131 pub to_self_delay: u16,
132 /// The maximum number of inbound HTLCs towards sender
133 pub max_accepted_htlcs: u16,
134 /// The sender's key controlling the funding transaction
135 pub funding_pubkey: PublicKey,
136 /// Used to derive a revocation key for transactions broadcast by counterparty
137 pub revocation_basepoint: PublicKey,
138 /// A payment key to sender for transactions broadcast by counterparty
139 pub payment_point: PublicKey,
140 /// Used to derive a payment key to sender for transactions broadcast by sender
141 pub delayed_payment_basepoint: PublicKey,
142 /// Used to derive an HTLC payment key to sender
143 pub htlc_basepoint: PublicKey,
144 /// The first to-be-broadcast-by-sender transaction's per commitment point
145 pub first_per_commitment_point: PublicKey,
147 pub channel_flags: u8,
148 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
149 pub shutdown_scriptpubkey: OptionalField<Script>,
152 /// An accept_channel message to be sent or received from a peer
153 #[derive(Clone, Debug, PartialEq)]
154 pub struct AcceptChannel {
155 /// A temporary channel ID, until the funding outpoint is announced
156 pub temporary_channel_id: [u8; 32],
157 /// The threshold below which outputs on transactions broadcast by sender will be omitted
158 pub dust_limit_satoshis: u64,
159 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
160 pub max_htlc_value_in_flight_msat: u64,
161 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
162 pub channel_reserve_satoshis: u64,
163 /// The minimum HTLC size incoming to sender, in milli-satoshi
164 pub htlc_minimum_msat: u64,
165 /// Minimum depth of the funding transaction before the channel is considered open
166 pub minimum_depth: u32,
167 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
168 pub to_self_delay: u16,
169 /// The maximum number of inbound HTLCs towards sender
170 pub max_accepted_htlcs: u16,
171 /// The sender's key controlling the funding transaction
172 pub funding_pubkey: PublicKey,
173 /// Used to derive a revocation key for transactions broadcast by counterparty
174 pub revocation_basepoint: PublicKey,
175 /// A payment key to sender for transactions broadcast by counterparty
176 pub payment_point: PublicKey,
177 /// Used to derive a payment key to sender for transactions broadcast by sender
178 pub delayed_payment_basepoint: PublicKey,
179 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
180 pub htlc_basepoint: PublicKey,
181 /// The first to-be-broadcast-by-sender transaction's per commitment point
182 pub first_per_commitment_point: PublicKey,
183 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
184 pub shutdown_scriptpubkey: OptionalField<Script>,
187 /// A funding_created message to be sent or received from a peer
188 #[derive(Clone, Debug, PartialEq)]
189 pub struct FundingCreated {
190 /// A temporary channel ID, until the funding is established
191 pub temporary_channel_id: [u8; 32],
192 /// The funding transaction ID
193 pub funding_txid: Txid,
194 /// The specific output index funding this channel
195 pub funding_output_index: u16,
196 /// The signature of the channel initiator (funder) on the funding transaction
197 pub signature: Signature,
200 /// A funding_signed message to be sent or received from a peer
201 #[derive(Clone, Debug, PartialEq)]
202 pub struct FundingSigned {
204 pub channel_id: [u8; 32],
205 /// The signature of the channel acceptor (fundee) on the funding transaction
206 pub signature: Signature,
209 /// A funding_locked message to be sent or received from a peer
210 #[derive(Clone, Debug, PartialEq)]
211 pub struct FundingLocked {
213 pub channel_id: [u8; 32],
214 /// The per-commitment point of the second commitment transaction
215 pub next_per_commitment_point: PublicKey,
218 /// A shutdown message to be sent or received from a peer
219 #[derive(Clone, Debug, PartialEq)]
220 pub struct Shutdown {
222 pub channel_id: [u8; 32],
223 /// The destination of this peer's funds on closing.
224 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
225 pub scriptpubkey: Script,
228 /// A closing_signed message to be sent or received from a peer
229 #[derive(Clone, Debug, PartialEq)]
230 pub struct ClosingSigned {
232 pub channel_id: [u8; 32],
233 /// The proposed total fee for the closing transaction
234 pub fee_satoshis: u64,
235 /// A signature on the closing transaction
236 pub signature: Signature,
239 /// An update_add_htlc message to be sent or received from a peer
240 #[derive(Clone, Debug, PartialEq)]
241 pub struct UpdateAddHTLC {
243 pub channel_id: [u8; 32],
246 /// The HTLC value in milli-satoshi
247 pub amount_msat: u64,
248 /// The payment hash, the pre-image of which controls HTLC redemption
249 pub payment_hash: PaymentHash,
250 /// The expiry height of the HTLC
251 pub cltv_expiry: u32,
252 pub(crate) onion_routing_packet: OnionPacket,
255 /// An update_fulfill_htlc message to be sent or received from a peer
256 #[derive(Clone, Debug, PartialEq)]
257 pub struct UpdateFulfillHTLC {
259 pub channel_id: [u8; 32],
262 /// The pre-image of the payment hash, allowing HTLC redemption
263 pub payment_preimage: PaymentPreimage,
266 /// An update_fail_htlc message to be sent or received from a peer
267 #[derive(Clone, Debug, PartialEq)]
268 pub struct UpdateFailHTLC {
270 pub channel_id: [u8; 32],
273 pub(crate) reason: OnionErrorPacket,
276 /// An update_fail_malformed_htlc message to be sent or received from a peer
277 #[derive(Clone, Debug, PartialEq)]
278 pub struct UpdateFailMalformedHTLC {
280 pub channel_id: [u8; 32],
283 pub(crate) sha256_of_onion: [u8; 32],
285 pub failure_code: u16,
288 /// A commitment_signed message to be sent or received from a peer
289 #[derive(Clone, Debug, PartialEq)]
290 pub struct CommitmentSigned {
292 pub channel_id: [u8; 32],
293 /// A signature on the commitment transaction
294 pub signature: Signature,
295 /// Signatures on the HTLC transactions
296 pub htlc_signatures: Vec<Signature>,
299 /// A revoke_and_ack message to be sent or received from a peer
300 #[derive(Clone, Debug, PartialEq)]
301 pub struct RevokeAndACK {
303 pub channel_id: [u8; 32],
304 /// The secret corresponding to the per-commitment point
305 pub per_commitment_secret: [u8; 32],
306 /// The next sender-broadcast commitment transaction's per-commitment point
307 pub next_per_commitment_point: PublicKey,
310 /// An update_fee message to be sent or received from a peer
311 #[derive(Clone, Debug, PartialEq)]
312 pub struct UpdateFee {
314 pub channel_id: [u8; 32],
315 /// Fee rate per 1000-weight of the transaction
316 pub feerate_per_kw: u32,
319 #[derive(Clone, Debug, PartialEq)]
320 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
321 /// This is used to convince the recipient that the channel is at a certain commitment
322 /// number even if they lost that data due to a local failure. Of course, the peer may lie
323 /// and even later commitments may have been revoked.
324 pub struct DataLossProtect {
325 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
326 /// belonging to the recipient
327 pub your_last_per_commitment_secret: [u8; 32],
328 /// The sender's per-commitment point for their current commitment transaction
329 pub my_current_per_commitment_point: PublicKey,
332 /// A channel_reestablish message to be sent or received from a peer
333 #[derive(Clone, Debug, PartialEq)]
334 pub struct ChannelReestablish {
336 pub channel_id: [u8; 32],
337 /// The next commitment number for the sender
338 pub next_local_commitment_number: u64,
339 /// The next commitment number for the recipient
340 pub next_remote_commitment_number: u64,
341 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
342 pub data_loss_protect: OptionalField<DataLossProtect>,
345 /// An announcement_signatures message to be sent or received from a peer
346 #[derive(Clone, Debug, PartialEq)]
347 pub struct AnnouncementSignatures {
349 pub channel_id: [u8; 32],
350 /// The short channel ID
351 pub short_channel_id: u64,
352 /// A signature by the node key
353 pub node_signature: Signature,
354 /// A signature by the funding key
355 pub bitcoin_signature: Signature,
358 /// An address which can be used to connect to a remote peer
359 #[derive(Clone, Debug, PartialEq)]
360 pub enum NetAddress {
361 /// An IPv4 address/port on which the peer is listening.
363 /// The 4-byte IPv4 address
365 /// The port on which the node is listening
368 /// An IPv6 address/port on which the peer is listening.
370 /// The 16-byte IPv6 address
372 /// The port on which the node is listening
375 /// An old-style Tor onion address/port on which the peer is listening.
377 /// The bytes (usually encoded in base32 with ".onion" appended)
379 /// The port on which the node is listening
382 /// A new-style Tor onion address/port on which the peer is listening.
383 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
384 /// wrap as base32 and append ".onion".
386 /// The ed25519 long-term public key of the peer
387 ed25519_pubkey: [u8; 32],
388 /// The checksum of the pubkey and version, as included in the onion address
390 /// The version byte, as defined by the Tor Onion v3 spec.
392 /// The port on which the node is listening
397 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
399 pub(crate) fn get_id(&self) -> u8 {
401 &NetAddress::IPv4 {..} => { 1 },
402 &NetAddress::IPv6 {..} => { 2 },
403 &NetAddress::OnionV2 {..} => { 3 },
404 &NetAddress::OnionV3 {..} => { 4 },
408 /// Strict byte-length of address descriptor, 1-byte type not recorded
409 fn len(&self) -> u16 {
411 &NetAddress::IPv4 { .. } => { 6 },
412 &NetAddress::IPv6 { .. } => { 18 },
413 &NetAddress::OnionV2 { .. } => { 12 },
414 &NetAddress::OnionV3 { .. } => { 37 },
418 /// The maximum length of any address descriptor, not including the 1-byte type
419 pub(crate) const MAX_LEN: u16 = 37;
422 impl Writeable for NetAddress {
423 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
425 &NetAddress::IPv4 { ref addr, ref port } => {
430 &NetAddress::IPv6 { ref addr, ref port } => {
435 &NetAddress::OnionV2 { ref addr, ref port } => {
440 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
442 ed25519_pubkey.write(writer)?;
443 checksum.write(writer)?;
444 version.write(writer)?;
452 impl Readable for Result<NetAddress, u8> {
453 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
454 let byte = <u8 as Readable>::read(reader)?;
457 Ok(Ok(NetAddress::IPv4 {
458 addr: Readable::read(reader)?,
459 port: Readable::read(reader)?,
463 Ok(Ok(NetAddress::IPv6 {
464 addr: Readable::read(reader)?,
465 port: Readable::read(reader)?,
469 Ok(Ok(NetAddress::OnionV2 {
470 addr: Readable::read(reader)?,
471 port: Readable::read(reader)?,
475 Ok(Ok(NetAddress::OnionV3 {
476 ed25519_pubkey: Readable::read(reader)?,
477 checksum: Readable::read(reader)?,
478 version: Readable::read(reader)?,
479 port: Readable::read(reader)?,
482 _ => return Ok(Err(byte)),
487 impl Readable for NetAddress {
488 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
489 match Readable::read(reader) {
490 Ok(Ok(res)) => Ok(res),
491 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
498 /// The unsigned part of a node_announcement
499 #[derive(Clone, Debug, PartialEq)]
500 pub struct UnsignedNodeAnnouncement {
501 /// The advertised features
502 pub features: NodeFeatures,
503 /// A strictly monotonic announcement counter, with gaps allowed
505 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
507 pub node_id: PublicKey,
508 /// An RGB color for UI purposes
510 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
513 /// List of addresses on which this node is reachable
514 pub addresses: Vec<NetAddress>,
515 pub(crate) excess_address_data: Vec<u8>,
516 pub(crate) excess_data: Vec<u8>,
518 #[derive(Clone, Debug, PartialEq)]
519 /// A node_announcement message to be sent or received from a peer
520 pub struct NodeAnnouncement {
521 /// The signature by the node key
522 pub signature: Signature,
523 /// The actual content of the announcement
524 pub contents: UnsignedNodeAnnouncement,
527 /// The unsigned part of a channel_announcement
528 #[derive(Clone, Debug, PartialEq)]
529 pub struct UnsignedChannelAnnouncement {
530 /// The advertised channel features
531 pub features: ChannelFeatures,
532 /// The genesis hash of the blockchain where the channel is to be opened
533 pub chain_hash: BlockHash,
534 /// The short channel ID
535 pub short_channel_id: u64,
536 /// One of the two node_ids which are endpoints of this channel
537 pub node_id_1: PublicKey,
538 /// The other of the two node_ids which are endpoints of this channel
539 pub node_id_2: PublicKey,
540 /// The funding key for the first node
541 pub bitcoin_key_1: PublicKey,
542 /// The funding key for the second node
543 pub bitcoin_key_2: PublicKey,
544 pub(crate) excess_data: Vec<u8>,
546 /// A channel_announcement message to be sent or received from a peer
547 #[derive(Clone, Debug, PartialEq)]
548 pub struct ChannelAnnouncement {
549 /// Authentication of the announcement by the first public node
550 pub node_signature_1: Signature,
551 /// Authentication of the announcement by the second public node
552 pub node_signature_2: Signature,
553 /// Proof of funding UTXO ownership by the first public node
554 pub bitcoin_signature_1: Signature,
555 /// Proof of funding UTXO ownership by the second public node
556 pub bitcoin_signature_2: Signature,
557 /// The actual announcement
558 pub contents: UnsignedChannelAnnouncement,
561 /// The unsigned part of a channel_update
562 #[derive(Clone, Debug, PartialEq)]
563 pub struct UnsignedChannelUpdate {
564 /// The genesis hash of the blockchain where the channel is to be opened
565 pub chain_hash: BlockHash,
566 /// The short channel ID
567 pub short_channel_id: u64,
568 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
572 /// The number of blocks such that if:
573 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
574 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
575 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
576 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
577 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
578 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
579 /// constructing the route.
580 pub cltv_expiry_delta: u16,
581 /// The minimum HTLC size incoming to sender, in milli-satoshi
582 pub htlc_minimum_msat: u64,
583 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
584 pub htlc_maximum_msat: OptionalField<u64>,
585 /// The base HTLC fee charged by sender, in milli-satoshi
586 pub fee_base_msat: u32,
587 /// The amount to fee multiplier, in micro-satoshi
588 pub fee_proportional_millionths: u32,
589 pub(crate) excess_data: Vec<u8>,
591 /// A channel_update message to be sent or received from a peer
592 #[derive(Clone, Debug, PartialEq)]
593 pub struct ChannelUpdate {
594 /// A signature of the channel update
595 pub signature: Signature,
596 /// The actual channel update
597 pub contents: UnsignedChannelUpdate,
600 /// A query_channel_range message is used to query a peer for channel
601 /// UTXOs in a range of blocks. The recipient of a query makes a best
602 /// effort to reply to the query using one or more reply_channel_range
604 #[derive(Clone, Debug, PartialEq)]
605 pub struct QueryChannelRange {
606 /// The genesis hash of the blockchain being queried
607 pub chain_hash: BlockHash,
608 /// The height of the first block for the channel UTXOs being queried
609 pub first_blocknum: u32,
610 /// The number of blocks to include in the query results
611 pub number_of_blocks: u32,
614 /// A reply_channel_range message is a reply to a query_channel_range
615 /// message. Multiple reply_channel_range messages can be sent in reply
616 /// to a single query_channel_range message. The query recipient makes a
617 /// best effort to respond based on their local network view which may
618 /// not be a perfect view of the network. The short_channel_ids in the
619 /// reply are encoded. We only support encoding_type=0 uncompressed
620 /// serialization and do not support encoding_type=1 zlib serialization.
621 #[derive(Clone, Debug, PartialEq)]
622 pub struct ReplyChannelRange {
623 /// The genesis hash of the blockchain being queried
624 pub chain_hash: BlockHash,
625 /// The height of the first block in the range of the reply
626 pub first_blocknum: u32,
627 /// The number of blocks included in the range of the reply
628 pub number_of_blocks: u32,
629 /// True when this is the final reply for a query
630 pub sync_complete: bool,
631 /// The short_channel_ids in the channel range
632 pub short_channel_ids: Vec<u64>,
635 /// A query_short_channel_ids message is used to query a peer for
636 /// routing gossip messages related to one or more short_channel_ids.
637 /// The query recipient will reply with the latest, if available,
638 /// channel_announcement, channel_update and node_announcement messages
639 /// it maintains for the requested short_channel_ids followed by a
640 /// reply_short_channel_ids_end message. The short_channel_ids sent in
641 /// this query are encoded. We only support encoding_type=0 uncompressed
642 /// serialization and do not support encoding_type=1 zlib serialization.
643 #[derive(Clone, Debug, PartialEq)]
644 pub struct QueryShortChannelIds {
645 /// The genesis hash of the blockchain being queried
646 pub chain_hash: BlockHash,
647 /// The short_channel_ids that are being queried
648 pub short_channel_ids: Vec<u64>,
651 /// A reply_short_channel_ids_end message is sent as a reply to a
652 /// query_short_channel_ids message. The query recipient makes a best
653 /// effort to respond based on their local network view which may not be
654 /// a perfect view of the network.
655 #[derive(Clone, Debug, PartialEq)]
656 pub struct ReplyShortChannelIdsEnd {
657 /// The genesis hash of the blockchain that was queried
658 pub chain_hash: BlockHash,
659 /// Indicates if the query recipient maintains up-to-date channel
660 /// information for the chain_hash
661 pub full_information: bool,
664 /// A gossip_timestamp_filter message is used by a node to request
665 /// gossip relay for messages in the requested time range when the
666 /// gossip_queries feature has been negotiated.
667 #[derive(Clone, Debug, PartialEq)]
668 pub struct GossipTimestampFilter {
669 /// The genesis hash of the blockchain for channel and node information
670 pub chain_hash: BlockHash,
671 /// The starting unix timestamp
672 pub first_timestamp: u32,
673 /// The range of information in seconds
674 pub timestamp_range: u32,
677 /// Encoding type for data compression of collections in gossip queries.
678 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
683 /// Used to put an error message in a LightningError
684 #[derive(Clone, Debug)]
685 pub enum ErrorAction {
686 /// The peer took some action which made us think they were useless. Disconnect them.
688 /// An error message which we should make an effort to send before we disconnect.
689 msg: Option<ErrorMessage>
691 /// The peer did something harmless that we weren't able to process, just log and ignore
692 // New code should *not* use this. New code must use IgnoreAndLog, below!
694 /// The peer did something harmless that we weren't able to meaningfully process.
695 /// If the error is logged, log it at the given level.
696 IgnoreAndLog(logger::Level),
697 /// The peer did something incorrect. Tell them.
699 /// The message to send.
704 /// An Err type for failure to process messages.
705 #[derive(Clone, Debug)]
706 pub struct LightningError {
707 /// A human-readable message describing the error
709 /// The action which should be taken against the offending peer.
710 pub action: ErrorAction,
713 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
714 /// transaction updates if they were pending.
715 #[derive(Clone, Debug, PartialEq)]
716 pub struct CommitmentUpdate {
717 /// update_add_htlc messages which should be sent
718 pub update_add_htlcs: Vec<UpdateAddHTLC>,
719 /// update_fulfill_htlc messages which should be sent
720 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
721 /// update_fail_htlc messages which should be sent
722 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
723 /// update_fail_malformed_htlc messages which should be sent
724 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
725 /// An update_fee message which should be sent
726 pub update_fee: Option<UpdateFee>,
727 /// Finally, the commitment_signed message which should be sent
728 pub commitment_signed: CommitmentSigned,
731 /// The information we received from a peer along the route of a payment we originated. This is
732 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
733 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
734 #[derive(Clone, Debug, PartialEq)]
735 pub enum HTLCFailChannelUpdate {
736 /// We received an error which included a full ChannelUpdate message.
737 ChannelUpdateMessage {
738 /// The unwrapped message we received
741 /// We received an error which indicated only that a channel has been closed
743 /// The short_channel_id which has now closed.
744 short_channel_id: u64,
745 /// when this true, this channel should be permanently removed from the
746 /// consideration. Otherwise, this channel can be restored as new channel_update is received
749 /// We received an error which indicated only that a node has failed
751 /// The node_id that has failed.
753 /// when this true, node should be permanently removed from the
754 /// consideration. Otherwise, the channels connected to this node can be
755 /// restored as new channel_update is received
760 /// Messages could have optional fields to use with extended features
761 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
762 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
763 /// separate enum type for them.
764 /// (C-not exported) due to a free generic in T
765 #[derive(Clone, Debug, PartialEq)]
766 pub enum OptionalField<T> {
767 /// Optional field is included in message
769 /// Optional field is absent in message
773 /// A trait to describe an object which can receive channel messages.
775 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
776 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
777 pub trait ChannelMessageHandler : MessageSendEventsProvider {
779 /// Handle an incoming open_channel message from the given peer.
780 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
781 /// Handle an incoming accept_channel message from the given peer.
782 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
783 /// Handle an incoming funding_created message from the given peer.
784 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
785 /// Handle an incoming funding_signed message from the given peer.
786 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
787 /// Handle an incoming funding_locked message from the given peer.
788 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
791 /// Handle an incoming shutdown message from the given peer.
792 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
793 /// Handle an incoming closing_signed message from the given peer.
794 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
797 /// Handle an incoming update_add_htlc message from the given peer.
798 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
799 /// Handle an incoming update_fulfill_htlc message from the given peer.
800 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
801 /// Handle an incoming update_fail_htlc message from the given peer.
802 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
803 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
804 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
805 /// Handle an incoming commitment_signed message from the given peer.
806 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
807 /// Handle an incoming revoke_and_ack message from the given peer.
808 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
810 /// Handle an incoming update_fee message from the given peer.
811 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
813 // Channel-to-announce:
814 /// Handle an incoming announcement_signatures message from the given peer.
815 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
817 // Connection loss/reestablish:
818 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
819 /// is believed to be possible in the future (eg they're sending us messages we don't
820 /// understand or indicate they require unknown feature bits), no_connection_possible is set
821 /// and any outstanding channels should be failed.
822 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
824 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
825 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
826 /// Handle an incoming channel_reestablish message from the given peer.
827 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
829 /// Handle an incoming channel update from the given peer.
830 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
833 /// Handle an incoming error message from the given peer.
834 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
837 /// A trait to describe an object which can receive routing messages.
839 /// # Implementor DoS Warnings
841 /// For `gossip_queries` messages there are potential DoS vectors when handling
842 /// inbound queries. Implementors using an on-disk network graph should be aware of
843 /// repeated disk I/O for queries accessing different parts of the network graph.
844 pub trait RoutingMessageHandler : MessageSendEventsProvider {
845 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
846 /// false or returning an Err otherwise.
847 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
848 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
849 /// or returning an Err otherwise.
850 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
851 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
852 /// false or returning an Err otherwise.
853 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
854 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
855 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
856 /// Gets a subset of the channel announcements and updates required to dump our routing table
857 /// to a remote node, starting at the short_channel_id indicated by starting_point and
858 /// including the batch_amount entries immediately higher in numerical value than starting_point.
859 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
860 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
861 /// starting at the node *after* the provided publickey and including batch_amount entries
862 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
863 /// If None is provided for starting_point, we start at the first node.
864 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
865 /// Called when a connection is established with a peer. This can be used to
866 /// perform routing table synchronization using a strategy defined by the
868 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
869 /// Handles the reply of a query we initiated to learn about channels
870 /// for a given range of blocks. We can expect to receive one or more
871 /// replies to a single query.
872 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
873 /// Handles the reply of a query we initiated asking for routing gossip
874 /// messages for a list of channels. We should receive this message when
875 /// a node has completed its best effort to send us the pertaining routing
877 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
878 /// Handles when a peer asks us to send a list of short_channel_ids
879 /// for the requested range of blocks.
880 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
881 /// Handles when a peer asks us to send routing gossip messages for a
882 /// list of short_channel_ids.
883 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
886 mod fuzzy_internal_msgs {
888 use ln::PaymentSecret;
890 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
891 // them from untrusted input):
893 pub(crate) struct FinalOnionHopData {
894 pub(crate) payment_secret: PaymentSecret,
895 /// The total value, in msat, of the payment as received by the ultimate recipient.
896 /// Message serialization may panic if this value is more than 21 million Bitcoin.
897 pub(crate) total_msat: u64,
900 pub(crate) enum OnionHopDataFormat {
901 Legacy { // aka Realm-0
902 short_channel_id: u64,
905 short_channel_id: u64,
908 payment_data: Option<FinalOnionHopData>,
912 pub struct OnionHopData {
913 pub(crate) format: OnionHopDataFormat,
914 /// The value, in msat, of the payment after this hop's fee is deducted.
915 /// Message serialization may panic if this value is more than 21 million Bitcoin.
916 pub(crate) amt_to_forward: u64,
917 pub(crate) outgoing_cltv_value: u32,
918 // 12 bytes of 0-padding for Legacy format
921 pub struct DecodedOnionErrorPacket {
922 pub(crate) hmac: [u8; 32],
923 pub(crate) failuremsg: Vec<u8>,
924 pub(crate) pad: Vec<u8>,
927 #[cfg(feature = "fuzztarget")]
928 pub use self::fuzzy_internal_msgs::*;
929 #[cfg(not(feature = "fuzztarget"))]
930 pub(crate) use self::fuzzy_internal_msgs::*;
933 pub(crate) struct OnionPacket {
934 pub(crate) version: u8,
935 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
936 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
937 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
938 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
939 pub(crate) hop_data: [u8; 20*65],
940 pub(crate) hmac: [u8; 32],
943 impl PartialEq for OnionPacket {
944 fn eq(&self, other: &OnionPacket) -> bool {
945 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
946 if i != j { return false; }
948 self.version == other.version &&
949 self.public_key == other.public_key &&
950 self.hmac == other.hmac
954 impl fmt::Debug for OnionPacket {
955 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
956 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
960 #[derive(Clone, Debug, PartialEq)]
961 pub(crate) struct OnionErrorPacket {
962 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
963 // (TODO) We limit it in decode to much lower...
964 pub(crate) data: Vec<u8>,
967 impl fmt::Display for DecodeError {
968 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
970 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
971 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
972 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
973 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
974 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
975 DecodeError::Io(ref e) => e.fmt(f),
976 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
981 impl From<::std::io::Error> for DecodeError {
982 fn from(e: ::std::io::Error) -> Self {
983 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
984 DecodeError::ShortRead
986 DecodeError::Io(e.kind())
991 impl Writeable for OptionalField<Script> {
992 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
994 OptionalField::Present(ref script) => {
995 // Note that Writeable for script includes the 16-bit length tag for us
998 OptionalField::Absent => {}
1004 impl Readable for OptionalField<Script> {
1005 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1006 match <u16 as Readable>::read(r) {
1008 let mut buf = vec![0; len as usize];
1009 r.read_exact(&mut buf)?;
1010 Ok(OptionalField::Present(Script::from(buf)))
1012 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1018 impl Writeable for OptionalField<u64> {
1019 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1021 OptionalField::Present(ref value) => {
1024 OptionalField::Absent => {}
1030 impl Readable for OptionalField<u64> {
1031 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1032 let value: u64 = Readable::read(r)?;
1033 Ok(OptionalField::Present(value))
1038 impl_writeable_len_match!(AcceptChannel, {
1039 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1042 temporary_channel_id,
1043 dust_limit_satoshis,
1044 max_htlc_value_in_flight_msat,
1045 channel_reserve_satoshis,
1051 revocation_basepoint,
1053 delayed_payment_basepoint,
1055 first_per_commitment_point,
1056 shutdown_scriptpubkey
1059 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1066 impl Writeable for ChannelReestablish {
1067 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1068 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1069 self.channel_id.write(w)?;
1070 self.next_local_commitment_number.write(w)?;
1071 self.next_remote_commitment_number.write(w)?;
1072 match self.data_loss_protect {
1073 OptionalField::Present(ref data_loss_protect) => {
1074 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1075 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1077 OptionalField::Absent => {}
1083 impl Readable for ChannelReestablish{
1084 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1086 channel_id: Readable::read(r)?,
1087 next_local_commitment_number: Readable::read(r)?,
1088 next_remote_commitment_number: Readable::read(r)?,
1089 data_loss_protect: {
1090 match <[u8; 32] as Readable>::read(r) {
1091 Ok(your_last_per_commitment_secret) =>
1092 OptionalField::Present(DataLossProtect {
1093 your_last_per_commitment_secret,
1094 my_current_per_commitment_point: Readable::read(r)?,
1096 Err(DecodeError::ShortRead) => OptionalField::Absent,
1097 Err(e) => return Err(e)
1104 impl_writeable!(ClosingSigned, 32+8+64, {
1110 impl_writeable_len_match!(CommitmentSigned, {
1111 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1118 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1119 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1126 impl_writeable!(FundingCreated, 32+32+2+64, {
1127 temporary_channel_id,
1129 funding_output_index,
1133 impl_writeable!(FundingSigned, 32+64, {
1138 impl_writeable!(FundingLocked, 32+33, {
1140 next_per_commitment_point
1143 impl Writeable for Init {
1144 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1145 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1146 // our relevant feature bits. This keeps us compatible with old nodes.
1147 self.features.write_up_to_13(w)?;
1148 self.features.write(w)
1152 impl Readable for Init {
1153 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1154 let global_features: InitFeatures = Readable::read(r)?;
1155 let features: InitFeatures = Readable::read(r)?;
1157 features: features.or(global_features),
1162 impl_writeable_len_match!(OpenChannel, {
1163 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1167 temporary_channel_id,
1170 dust_limit_satoshis,
1171 max_htlc_value_in_flight_msat,
1172 channel_reserve_satoshis,
1178 revocation_basepoint,
1180 delayed_payment_basepoint,
1182 first_per_commitment_point,
1184 shutdown_scriptpubkey
1187 impl_writeable!(RevokeAndACK, 32+32+33, {
1189 per_commitment_secret,
1190 next_per_commitment_point
1193 impl_writeable_len_match!(Shutdown, {
1194 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1200 impl_writeable_len_match!(UpdateFailHTLC, {
1201 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1208 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1215 impl_writeable!(UpdateFee, 32+4, {
1220 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1226 impl_writeable_len_match!(OnionErrorPacket, {
1227 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1232 impl Writeable for OnionPacket {
1233 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1234 w.size_hint(1 + 33 + 20*65 + 32);
1235 self.version.write(w)?;
1236 match self.public_key {
1237 Ok(pubkey) => pubkey.write(w)?,
1238 Err(_) => [0u8;33].write(w)?,
1240 w.write_all(&self.hop_data)?;
1241 self.hmac.write(w)?;
1246 impl Readable for OnionPacket {
1247 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1249 version: Readable::read(r)?,
1251 let mut buf = [0u8;33];
1252 r.read_exact(&mut buf)?;
1253 PublicKey::from_slice(&buf)
1255 hop_data: Readable::read(r)?,
1256 hmac: Readable::read(r)?,
1261 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1267 onion_routing_packet
1270 impl Writeable for FinalOnionHopData {
1271 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1272 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1273 self.payment_secret.0.write(w)?;
1274 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1278 impl Readable for FinalOnionHopData {
1279 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1280 let secret: [u8; 32] = Readable::read(r)?;
1281 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1282 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1286 impl Writeable for OnionHopData {
1287 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1289 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1290 // check values are sane long before we get here, though its possible in the future
1291 // user-generated messages may hit this.
1292 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1294 OnionHopDataFormat::Legacy { short_channel_id } => {
1296 short_channel_id.write(w)?;
1297 self.amt_to_forward.write(w)?;
1298 self.outgoing_cltv_value.write(w)?;
1299 w.write_all(&[0;12])?;
1301 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1302 encode_varint_length_prefixed_tlv!(w, {
1303 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1304 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1305 (6, short_channel_id, required)
1308 OnionHopDataFormat::FinalNode { ref payment_data } => {
1309 if let Some(final_data) = payment_data {
1310 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1312 encode_varint_length_prefixed_tlv!(w, {
1313 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1314 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1315 (8, payment_data, option)
1323 impl Readable for OnionHopData {
1324 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1325 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1326 let v: VarInt = Decodable::consensus_decode(&mut r)
1327 .map_err(|e| match e {
1328 Error::Io(ioe) => DecodeError::from(ioe),
1329 _ => DecodeError::InvalidValue
1331 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1332 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1333 let mut rd = FixedLengthReader::new(r, v.0);
1334 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1335 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1336 let mut short_id: Option<u64> = None;
1337 let mut payment_data: Option<FinalOnionHopData> = None;
1338 decode_tlv_stream!(&mut rd, {
1340 (4, cltv_value, required),
1341 (6, short_id, option),
1342 (8, payment_data, option),
1344 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1345 let format = if let Some(short_channel_id) = short_id {
1346 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1347 OnionHopDataFormat::NonFinalNode {
1351 if let &Some(ref data) = &payment_data {
1352 if data.total_msat > MAX_VALUE_MSAT {
1353 return Err(DecodeError::InvalidValue);
1356 OnionHopDataFormat::FinalNode {
1360 (format, amt.0, cltv_value.0)
1362 let format = OnionHopDataFormat::Legacy {
1363 short_channel_id: Readable::read(r)?,
1365 let amt: u64 = Readable::read(r)?;
1366 let cltv_value: u32 = Readable::read(r)?;
1367 r.read_exact(&mut [0; 12])?;
1368 (format, amt, cltv_value)
1371 if amt > MAX_VALUE_MSAT {
1372 return Err(DecodeError::InvalidValue);
1376 amt_to_forward: amt,
1377 outgoing_cltv_value: cltv_value,
1382 impl Writeable for Ping {
1383 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1384 w.size_hint(self.byteslen as usize + 4);
1385 self.ponglen.write(w)?;
1386 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1391 impl Readable for Ping {
1392 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1394 ponglen: Readable::read(r)?,
1396 let byteslen = Readable::read(r)?;
1397 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1404 impl Writeable for Pong {
1405 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1406 w.size_hint(self.byteslen as usize + 2);
1407 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1412 impl Readable for Pong {
1413 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1416 let byteslen = Readable::read(r)?;
1417 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1424 impl Writeable for UnsignedChannelAnnouncement {
1425 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1426 w.size_hint(2 + 32 + 8 + 4*33 + self.features.byte_count() + self.excess_data.len());
1427 self.features.write(w)?;
1428 self.chain_hash.write(w)?;
1429 self.short_channel_id.write(w)?;
1430 self.node_id_1.write(w)?;
1431 self.node_id_2.write(w)?;
1432 self.bitcoin_key_1.write(w)?;
1433 self.bitcoin_key_2.write(w)?;
1434 w.write_all(&self.excess_data[..])?;
1439 impl Readable for UnsignedChannelAnnouncement {
1440 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1442 features: Readable::read(r)?,
1443 chain_hash: Readable::read(r)?,
1444 short_channel_id: Readable::read(r)?,
1445 node_id_1: Readable::read(r)?,
1446 node_id_2: Readable::read(r)?,
1447 bitcoin_key_1: Readable::read(r)?,
1448 bitcoin_key_2: Readable::read(r)?,
1450 let mut excess_data = vec![];
1451 r.read_to_end(&mut excess_data)?;
1458 impl_writeable_len_match!(ChannelAnnouncement, {
1459 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1460 2 + 32 + 8 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1464 bitcoin_signature_1,
1465 bitcoin_signature_2,
1469 impl Writeable for UnsignedChannelUpdate {
1470 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1471 let mut size = 64 + self.excess_data.len();
1472 let mut message_flags: u8 = 0;
1473 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1478 self.chain_hash.write(w)?;
1479 self.short_channel_id.write(w)?;
1480 self.timestamp.write(w)?;
1481 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1482 all_flags.write(w)?;
1483 self.cltv_expiry_delta.write(w)?;
1484 self.htlc_minimum_msat.write(w)?;
1485 self.fee_base_msat.write(w)?;
1486 self.fee_proportional_millionths.write(w)?;
1487 self.htlc_maximum_msat.write(w)?;
1488 w.write_all(&self.excess_data[..])?;
1493 impl Readable for UnsignedChannelUpdate {
1494 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1495 let has_htlc_maximum_msat;
1497 chain_hash: Readable::read(r)?,
1498 short_channel_id: Readable::read(r)?,
1499 timestamp: Readable::read(r)?,
1501 let flags: u16 = Readable::read(r)?;
1502 let message_flags = flags >> 8;
1503 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1506 cltv_expiry_delta: Readable::read(r)?,
1507 htlc_minimum_msat: Readable::read(r)?,
1508 fee_base_msat: Readable::read(r)?,
1509 fee_proportional_millionths: Readable::read(r)?,
1510 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1512 let mut excess_data = vec![];
1513 r.read_to_end(&mut excess_data)?;
1520 impl_writeable_len_match!(ChannelUpdate, {
1521 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ref htlc_maximum_msat, ..}, .. },
1522 64 + 64 + excess_data.len() + if let OptionalField::Present(_) = htlc_maximum_msat { 8 } else { 0 } }
1528 impl Writeable for ErrorMessage {
1529 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1530 w.size_hint(32 + 2 + self.data.len());
1531 self.channel_id.write(w)?;
1532 (self.data.len() as u16).write(w)?;
1533 w.write_all(self.data.as_bytes())?;
1538 impl Readable for ErrorMessage {
1539 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1541 channel_id: Readable::read(r)?,
1543 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1544 let mut data = vec![];
1545 let data_len = r.read_to_end(&mut data)?;
1546 sz = cmp::min(data_len, sz);
1547 match String::from_utf8(data[..sz as usize].to_vec()) {
1549 Err(_) => return Err(DecodeError::InvalidValue),
1556 impl Writeable for UnsignedNodeAnnouncement {
1557 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1558 w.size_hint(76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1559 self.features.write(w)?;
1560 self.timestamp.write(w)?;
1561 self.node_id.write(w)?;
1562 w.write_all(&self.rgb)?;
1563 self.alias.write(w)?;
1565 let mut addr_len = 0;
1566 for addr in self.addresses.iter() {
1567 addr_len += 1 + addr.len();
1569 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1570 for addr in self.addresses.iter() {
1573 w.write_all(&self.excess_address_data[..])?;
1574 w.write_all(&self.excess_data[..])?;
1579 impl Readable for UnsignedNodeAnnouncement {
1580 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1581 let features: NodeFeatures = Readable::read(r)?;
1582 let timestamp: u32 = Readable::read(r)?;
1583 let node_id: PublicKey = Readable::read(r)?;
1584 let mut rgb = [0; 3];
1585 r.read_exact(&mut rgb)?;
1586 let alias: [u8; 32] = Readable::read(r)?;
1588 let addr_len: u16 = Readable::read(r)?;
1589 let mut addresses: Vec<NetAddress> = Vec::new();
1590 let mut addr_readpos = 0;
1591 let mut excess = false;
1592 let mut excess_byte = 0;
1594 if addr_len <= addr_readpos { break; }
1595 match Readable::read(r) {
1597 if addr_len < addr_readpos + 1 + addr.len() {
1598 return Err(DecodeError::BadLengthDescriptor);
1600 addr_readpos += (1 + addr.len()) as u16;
1601 addresses.push(addr);
1603 Ok(Err(unknown_descriptor)) => {
1605 excess_byte = unknown_descriptor;
1608 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1609 Err(e) => return Err(e),
1613 let mut excess_data = vec![];
1614 let excess_address_data = if addr_readpos < addr_len {
1615 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1616 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1618 excess_address_data[0] = excess_byte;
1623 excess_data.push(excess_byte);
1627 r.read_to_end(&mut excess_data)?;
1628 Ok(UnsignedNodeAnnouncement {
1635 excess_address_data,
1641 impl_writeable_len_match!(NodeAnnouncement, <=, {
1642 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1643 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1649 impl Readable for QueryShortChannelIds {
1650 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1651 let chain_hash: BlockHash = Readable::read(r)?;
1653 let encoding_len: u16 = Readable::read(r)?;
1654 let encoding_type: u8 = Readable::read(r)?;
1656 // Must be encoding_type=0 uncompressed serialization. We do not
1657 // support encoding_type=1 zlib serialization.
1658 if encoding_type != EncodingType::Uncompressed as u8 {
1659 return Err(DecodeError::UnsupportedCompression);
1662 // We expect the encoding_len to always includes the 1-byte
1663 // encoding_type and that short_channel_ids are 8-bytes each
1664 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1665 return Err(DecodeError::InvalidValue);
1668 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1669 // less the 1-byte encoding_type
1670 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1671 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1672 for _ in 0..short_channel_id_count {
1673 short_channel_ids.push(Readable::read(r)?);
1676 Ok(QueryShortChannelIds {
1683 impl Writeable for QueryShortChannelIds {
1684 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1685 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1686 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1688 w.size_hint(32 + 2 + encoding_len as usize);
1689 self.chain_hash.write(w)?;
1690 encoding_len.write(w)?;
1692 // We only support type=0 uncompressed serialization
1693 (EncodingType::Uncompressed as u8).write(w)?;
1695 for scid in self.short_channel_ids.iter() {
1703 impl Readable for ReplyShortChannelIdsEnd {
1704 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1705 let chain_hash: BlockHash = Readable::read(r)?;
1706 let full_information: bool = Readable::read(r)?;
1707 Ok(ReplyShortChannelIdsEnd {
1714 impl Writeable for ReplyShortChannelIdsEnd {
1715 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1716 w.size_hint(32 + 1);
1717 self.chain_hash.write(w)?;
1718 self.full_information.write(w)?;
1723 impl QueryChannelRange {
1725 * Calculates the overflow safe ending block height for the query.
1726 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1728 pub fn end_blocknum(&self) -> u32 {
1729 match self.first_blocknum.checked_add(self.number_of_blocks) {
1730 Some(block) => block,
1731 None => u32::max_value(),
1736 impl Readable for QueryChannelRange {
1737 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1738 let chain_hash: BlockHash = Readable::read(r)?;
1739 let first_blocknum: u32 = Readable::read(r)?;
1740 let number_of_blocks: u32 = Readable::read(r)?;
1741 Ok(QueryChannelRange {
1749 impl Writeable for QueryChannelRange {
1750 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1751 w.size_hint(32 + 4 + 4);
1752 self.chain_hash.write(w)?;
1753 self.first_blocknum.write(w)?;
1754 self.number_of_blocks.write(w)?;
1759 impl Readable for ReplyChannelRange {
1760 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1761 let chain_hash: BlockHash = Readable::read(r)?;
1762 let first_blocknum: u32 = Readable::read(r)?;
1763 let number_of_blocks: u32 = Readable::read(r)?;
1764 let sync_complete: bool = Readable::read(r)?;
1766 let encoding_len: u16 = Readable::read(r)?;
1767 let encoding_type: u8 = Readable::read(r)?;
1769 // Must be encoding_type=0 uncompressed serialization. We do not
1770 // support encoding_type=1 zlib serialization.
1771 if encoding_type != EncodingType::Uncompressed as u8 {
1772 return Err(DecodeError::UnsupportedCompression);
1775 // We expect the encoding_len to always includes the 1-byte
1776 // encoding_type and that short_channel_ids are 8-bytes each
1777 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1778 return Err(DecodeError::InvalidValue);
1781 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1782 // less the 1-byte encoding_type
1783 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1784 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1785 for _ in 0..short_channel_id_count {
1786 short_channel_ids.push(Readable::read(r)?);
1789 Ok(ReplyChannelRange {
1799 impl Writeable for ReplyChannelRange {
1800 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1801 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1802 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1803 self.chain_hash.write(w)?;
1804 self.first_blocknum.write(w)?;
1805 self.number_of_blocks.write(w)?;
1806 self.sync_complete.write(w)?;
1808 encoding_len.write(w)?;
1809 (EncodingType::Uncompressed as u8).write(w)?;
1810 for scid in self.short_channel_ids.iter() {
1818 impl Readable for GossipTimestampFilter {
1819 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1820 let chain_hash: BlockHash = Readable::read(r)?;
1821 let first_timestamp: u32 = Readable::read(r)?;
1822 let timestamp_range: u32 = Readable::read(r)?;
1823 Ok(GossipTimestampFilter {
1831 impl Writeable for GossipTimestampFilter {
1832 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1833 w.size_hint(32 + 4 + 4);
1834 self.chain_hash.write(w)?;
1835 self.first_timestamp.write(w)?;
1836 self.timestamp_range.write(w)?;
1845 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1847 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1848 use util::ser::{Writeable, Readable};
1850 use bitcoin::hashes::hex::FromHex;
1851 use bitcoin::util::address::Address;
1852 use bitcoin::network::constants::Network;
1853 use bitcoin::blockdata::script::Builder;
1854 use bitcoin::blockdata::opcodes;
1855 use bitcoin::hash_types::{Txid, BlockHash};
1857 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1858 use bitcoin::secp256k1::{Secp256k1, Message};
1861 use std::io::Cursor;
1864 fn encoding_channel_reestablish_no_secret() {
1865 let cr = msgs::ChannelReestablish {
1866 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],
1867 next_local_commitment_number: 3,
1868 next_remote_commitment_number: 4,
1869 data_loss_protect: OptionalField::Absent,
1872 let encoded_value = cr.encode();
1875 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]
1880 fn encoding_channel_reestablish_with_secret() {
1882 let secp_ctx = Secp256k1::new();
1883 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1886 let cr = msgs::ChannelReestablish {
1887 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],
1888 next_local_commitment_number: 3,
1889 next_remote_commitment_number: 4,
1890 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1893 let encoded_value = cr.encode();
1896 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]
1900 macro_rules! get_keys_from {
1901 ($slice: expr, $secp_ctx: expr) => {
1903 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1904 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1910 macro_rules! get_sig_on {
1911 ($privkey: expr, $ctx: expr, $string: expr) => {
1913 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1914 $ctx.sign(&sighash, &$privkey)
1920 fn encoding_announcement_signatures() {
1921 let secp_ctx = Secp256k1::new();
1922 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1923 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1924 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1925 let announcement_signatures = msgs::AnnouncementSignatures {
1926 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],
1927 short_channel_id: 2316138423780173,
1928 node_signature: sig_1,
1929 bitcoin_signature: sig_2,
1932 let encoded_value = announcement_signatures.encode();
1933 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1936 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1937 let secp_ctx = Secp256k1::new();
1938 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1939 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1940 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1941 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1942 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1943 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1944 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1945 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1946 let mut features = ChannelFeatures::known();
1947 if unknown_features_bits {
1948 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1950 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1952 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1953 short_channel_id: 2316138423780173,
1954 node_id_1: pubkey_1,
1955 node_id_2: pubkey_2,
1956 bitcoin_key_1: pubkey_3,
1957 bitcoin_key_2: pubkey_4,
1958 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1960 let channel_announcement = msgs::ChannelAnnouncement {
1961 node_signature_1: sig_1,
1962 node_signature_2: sig_2,
1963 bitcoin_signature_1: sig_3,
1964 bitcoin_signature_2: sig_4,
1965 contents: unsigned_channel_announcement,
1967 let encoded_value = channel_announcement.encode();
1968 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1969 if unknown_features_bits {
1970 target_value.append(&mut hex::decode("0002ffff").unwrap());
1972 target_value.append(&mut hex::decode("0000").unwrap());
1974 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1975 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1977 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1979 assert_eq!(encoded_value, target_value);
1983 fn encoding_channel_announcement() {
1984 do_encoding_channel_announcement(true, false);
1985 do_encoding_channel_announcement(false, true);
1986 do_encoding_channel_announcement(false, false);
1987 do_encoding_channel_announcement(true, true);
1990 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1991 let secp_ctx = Secp256k1::new();
1992 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1993 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1994 let features = if unknown_features_bits {
1995 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1997 // Set to some features we may support
1998 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2000 let mut addresses = Vec::new();
2002 addresses.push(msgs::NetAddress::IPv4 {
2003 addr: [255, 254, 253, 252],
2008 addresses.push(msgs::NetAddress::IPv6 {
2009 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2014 addresses.push(msgs::NetAddress::OnionV2 {
2015 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
2020 addresses.push(msgs::NetAddress::OnionV3 {
2021 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],
2027 let mut addr_len = 0;
2028 for addr in &addresses {
2029 addr_len += addr.len() + 1;
2031 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2033 timestamp: 20190119,
2038 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() },
2039 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() },
2041 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2042 let node_announcement = msgs::NodeAnnouncement {
2044 contents: unsigned_node_announcement,
2046 let encoded_value = node_announcement.encode();
2047 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2048 if unknown_features_bits {
2049 target_value.append(&mut hex::decode("0002ffff").unwrap());
2051 target_value.append(&mut hex::decode("000122").unwrap());
2053 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2054 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2056 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2059 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2062 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2065 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2067 if excess_address_data {
2068 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2071 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2073 assert_eq!(encoded_value, target_value);
2077 fn encoding_node_announcement() {
2078 do_encoding_node_announcement(true, true, true, true, true, true, true);
2079 do_encoding_node_announcement(false, false, false, false, false, false, false);
2080 do_encoding_node_announcement(false, true, false, false, false, false, false);
2081 do_encoding_node_announcement(false, false, true, false, false, false, false);
2082 do_encoding_node_announcement(false, false, false, true, false, false, false);
2083 do_encoding_node_announcement(false, false, false, false, true, false, false);
2084 do_encoding_node_announcement(false, false, false, false, false, true, false);
2085 do_encoding_node_announcement(false, true, false, true, false, true, false);
2086 do_encoding_node_announcement(false, false, true, false, true, false, false);
2089 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2090 let secp_ctx = Secp256k1::new();
2091 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2092 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2093 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2094 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2095 short_channel_id: 2316138423780173,
2096 timestamp: 20190119,
2097 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2098 cltv_expiry_delta: 144,
2099 htlc_minimum_msat: 1000000,
2100 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2101 fee_base_msat: 10000,
2102 fee_proportional_millionths: 20,
2103 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2105 let channel_update = msgs::ChannelUpdate {
2107 contents: unsigned_channel_update
2109 let encoded_value = channel_update.encode();
2110 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2111 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2112 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2113 if htlc_maximum_msat {
2114 target_value.append(&mut hex::decode("01").unwrap());
2116 target_value.append(&mut hex::decode("00").unwrap());
2118 target_value.append(&mut hex::decode("00").unwrap());
2120 let flag = target_value.last_mut().unwrap();
2124 let flag = target_value.last_mut().unwrap();
2125 *flag = *flag | 1 << 1;
2127 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2128 if htlc_maximum_msat {
2129 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2132 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2134 assert_eq!(encoded_value, target_value);
2138 fn encoding_channel_update() {
2139 do_encoding_channel_update(false, false, false, false);
2140 do_encoding_channel_update(false, false, false, true);
2141 do_encoding_channel_update(true, false, false, false);
2142 do_encoding_channel_update(true, false, false, true);
2143 do_encoding_channel_update(false, true, false, false);
2144 do_encoding_channel_update(false, true, false, true);
2145 do_encoding_channel_update(false, false, true, false);
2146 do_encoding_channel_update(false, false, true, true);
2147 do_encoding_channel_update(true, true, true, false);
2148 do_encoding_channel_update(true, true, true, true);
2151 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2152 let secp_ctx = Secp256k1::new();
2153 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2154 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2155 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2156 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2157 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2158 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2159 let open_channel = msgs::OpenChannel {
2160 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2161 temporary_channel_id: [2; 32],
2162 funding_satoshis: 1311768467284833366,
2163 push_msat: 2536655962884945560,
2164 dust_limit_satoshis: 3608586615801332854,
2165 max_htlc_value_in_flight_msat: 8517154655701053848,
2166 channel_reserve_satoshis: 8665828695742877976,
2167 htlc_minimum_msat: 2316138423780173,
2168 feerate_per_kw: 821716,
2169 to_self_delay: 49340,
2170 max_accepted_htlcs: 49340,
2171 funding_pubkey: pubkey_1,
2172 revocation_basepoint: pubkey_2,
2173 payment_point: pubkey_3,
2174 delayed_payment_basepoint: pubkey_4,
2175 htlc_basepoint: pubkey_5,
2176 first_per_commitment_point: pubkey_6,
2177 channel_flags: if random_bit { 1 << 5 } else { 0 },
2178 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2180 let encoded_value = open_channel.encode();
2181 let mut target_value = Vec::new();
2182 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2183 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2185 target_value.append(&mut hex::decode("20").unwrap());
2187 target_value.append(&mut hex::decode("00").unwrap());
2190 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2192 assert_eq!(encoded_value, target_value);
2196 fn encoding_open_channel() {
2197 do_encoding_open_channel(false, false);
2198 do_encoding_open_channel(true, false);
2199 do_encoding_open_channel(false, true);
2200 do_encoding_open_channel(true, true);
2203 fn do_encoding_accept_channel(shutdown: bool) {
2204 let secp_ctx = Secp256k1::new();
2205 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2206 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2207 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2208 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2209 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2210 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2211 let accept_channel = msgs::AcceptChannel {
2212 temporary_channel_id: [2; 32],
2213 dust_limit_satoshis: 1311768467284833366,
2214 max_htlc_value_in_flight_msat: 2536655962884945560,
2215 channel_reserve_satoshis: 3608586615801332854,
2216 htlc_minimum_msat: 2316138423780173,
2217 minimum_depth: 821716,
2218 to_self_delay: 49340,
2219 max_accepted_htlcs: 49340,
2220 funding_pubkey: pubkey_1,
2221 revocation_basepoint: pubkey_2,
2222 payment_point: pubkey_3,
2223 delayed_payment_basepoint: pubkey_4,
2224 htlc_basepoint: pubkey_5,
2225 first_per_commitment_point: pubkey_6,
2226 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2228 let encoded_value = accept_channel.encode();
2229 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2231 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2233 assert_eq!(encoded_value, target_value);
2237 fn encoding_accept_channel() {
2238 do_encoding_accept_channel(false);
2239 do_encoding_accept_channel(true);
2243 fn encoding_funding_created() {
2244 let secp_ctx = Secp256k1::new();
2245 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2246 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2247 let funding_created = msgs::FundingCreated {
2248 temporary_channel_id: [2; 32],
2249 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2250 funding_output_index: 255,
2253 let encoded_value = funding_created.encode();
2254 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2255 assert_eq!(encoded_value, target_value);
2259 fn encoding_funding_signed() {
2260 let secp_ctx = Secp256k1::new();
2261 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2262 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2263 let funding_signed = msgs::FundingSigned {
2264 channel_id: [2; 32],
2267 let encoded_value = funding_signed.encode();
2268 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2269 assert_eq!(encoded_value, target_value);
2273 fn encoding_funding_locked() {
2274 let secp_ctx = Secp256k1::new();
2275 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2276 let funding_locked = msgs::FundingLocked {
2277 channel_id: [2; 32],
2278 next_per_commitment_point: pubkey_1,
2280 let encoded_value = funding_locked.encode();
2281 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2282 assert_eq!(encoded_value, target_value);
2285 fn do_encoding_shutdown(script_type: u8) {
2286 let secp_ctx = Secp256k1::new();
2287 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2288 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2289 let shutdown = msgs::Shutdown {
2290 channel_id: [2; 32],
2292 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2293 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2294 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2295 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2297 let encoded_value = shutdown.encode();
2298 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2299 if script_type == 1 {
2300 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2301 } else if script_type == 2 {
2302 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2303 } else if script_type == 3 {
2304 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2305 } else if script_type == 4 {
2306 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2308 assert_eq!(encoded_value, target_value);
2312 fn encoding_shutdown() {
2313 do_encoding_shutdown(1);
2314 do_encoding_shutdown(2);
2315 do_encoding_shutdown(3);
2316 do_encoding_shutdown(4);
2320 fn encoding_closing_signed() {
2321 let secp_ctx = Secp256k1::new();
2322 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2323 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2324 let closing_signed = msgs::ClosingSigned {
2325 channel_id: [2; 32],
2326 fee_satoshis: 2316138423780173,
2329 let encoded_value = closing_signed.encode();
2330 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2331 assert_eq!(encoded_value, target_value);
2335 fn encoding_update_add_htlc() {
2336 let secp_ctx = Secp256k1::new();
2337 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2338 let onion_routing_packet = msgs::OnionPacket {
2340 public_key: Ok(pubkey_1),
2341 hop_data: [1; 20*65],
2344 let update_add_htlc = msgs::UpdateAddHTLC {
2345 channel_id: [2; 32],
2346 htlc_id: 2316138423780173,
2347 amount_msat: 3608586615801332854,
2348 payment_hash: PaymentHash([1; 32]),
2349 cltv_expiry: 821716,
2350 onion_routing_packet
2352 let encoded_value = update_add_htlc.encode();
2353 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2354 assert_eq!(encoded_value, target_value);
2358 fn encoding_update_fulfill_htlc() {
2359 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2360 channel_id: [2; 32],
2361 htlc_id: 2316138423780173,
2362 payment_preimage: PaymentPreimage([1; 32]),
2364 let encoded_value = update_fulfill_htlc.encode();
2365 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2366 assert_eq!(encoded_value, target_value);
2370 fn encoding_update_fail_htlc() {
2371 let reason = OnionErrorPacket {
2372 data: [1; 32].to_vec(),
2374 let update_fail_htlc = msgs::UpdateFailHTLC {
2375 channel_id: [2; 32],
2376 htlc_id: 2316138423780173,
2379 let encoded_value = update_fail_htlc.encode();
2380 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2381 assert_eq!(encoded_value, target_value);
2385 fn encoding_update_fail_malformed_htlc() {
2386 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2387 channel_id: [2; 32],
2388 htlc_id: 2316138423780173,
2389 sha256_of_onion: [1; 32],
2392 let encoded_value = update_fail_malformed_htlc.encode();
2393 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2394 assert_eq!(encoded_value, target_value);
2397 fn do_encoding_commitment_signed(htlcs: bool) {
2398 let secp_ctx = Secp256k1::new();
2399 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2400 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2401 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2402 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2403 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2404 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2405 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2406 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2407 let commitment_signed = msgs::CommitmentSigned {
2408 channel_id: [2; 32],
2410 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2412 let encoded_value = commitment_signed.encode();
2413 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2415 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2417 target_value.append(&mut hex::decode("0000").unwrap());
2419 assert_eq!(encoded_value, target_value);
2423 fn encoding_commitment_signed() {
2424 do_encoding_commitment_signed(true);
2425 do_encoding_commitment_signed(false);
2429 fn encoding_revoke_and_ack() {
2430 let secp_ctx = Secp256k1::new();
2431 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2432 let raa = msgs::RevokeAndACK {
2433 channel_id: [2; 32],
2434 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],
2435 next_per_commitment_point: pubkey_1,
2437 let encoded_value = raa.encode();
2438 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2439 assert_eq!(encoded_value, target_value);
2443 fn encoding_update_fee() {
2444 let update_fee = msgs::UpdateFee {
2445 channel_id: [2; 32],
2446 feerate_per_kw: 20190119,
2448 let encoded_value = update_fee.encode();
2449 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2450 assert_eq!(encoded_value, target_value);
2454 fn encoding_init() {
2455 assert_eq!(msgs::Init {
2456 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2457 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2458 assert_eq!(msgs::Init {
2459 features: InitFeatures::from_le_bytes(vec![0xFF]),
2460 }.encode(), hex::decode("0001ff0001ff").unwrap());
2461 assert_eq!(msgs::Init {
2462 features: InitFeatures::from_le_bytes(vec![]),
2463 }.encode(), hex::decode("00000000").unwrap());
2467 fn encoding_error() {
2468 let error = msgs::ErrorMessage {
2469 channel_id: [2; 32],
2470 data: String::from("rust-lightning"),
2472 let encoded_value = error.encode();
2473 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2474 assert_eq!(encoded_value, target_value);
2478 fn encoding_ping() {
2479 let ping = msgs::Ping {
2483 let encoded_value = ping.encode();
2484 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2485 assert_eq!(encoded_value, target_value);
2489 fn encoding_pong() {
2490 let pong = msgs::Pong {
2493 let encoded_value = pong.encode();
2494 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2495 assert_eq!(encoded_value, target_value);
2499 fn encoding_legacy_onion_hop_data() {
2500 let msg = msgs::OnionHopData {
2501 format: OnionHopDataFormat::Legacy {
2502 short_channel_id: 0xdeadbeef1bad1dea,
2504 amt_to_forward: 0x0badf00d01020304,
2505 outgoing_cltv_value: 0xffffffff,
2507 let encoded_value = msg.encode();
2508 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2509 assert_eq!(encoded_value, target_value);
2513 fn encoding_nonfinal_onion_hop_data() {
2514 let mut msg = msgs::OnionHopData {
2515 format: OnionHopDataFormat::NonFinalNode {
2516 short_channel_id: 0xdeadbeef1bad1dea,
2518 amt_to_forward: 0x0badf00d01020304,
2519 outgoing_cltv_value: 0xffffffff,
2521 let encoded_value = msg.encode();
2522 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2523 assert_eq!(encoded_value, target_value);
2524 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2525 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2526 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2527 } else { panic!(); }
2528 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2529 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2533 fn encoding_final_onion_hop_data() {
2534 let mut msg = msgs::OnionHopData {
2535 format: OnionHopDataFormat::FinalNode {
2538 amt_to_forward: 0x0badf00d01020304,
2539 outgoing_cltv_value: 0xffffffff,
2541 let encoded_value = msg.encode();
2542 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2543 assert_eq!(encoded_value, target_value);
2544 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2545 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2546 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2547 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2551 fn encoding_final_onion_hop_data_with_secret() {
2552 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2553 let mut msg = msgs::OnionHopData {
2554 format: OnionHopDataFormat::FinalNode {
2555 payment_data: Some(FinalOnionHopData {
2556 payment_secret: expected_payment_secret,
2557 total_msat: 0x1badca1f
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
2573 assert_eq!(payment_secret, expected_payment_secret);
2574 } else { panic!(); }
2575 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2576 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2580 fn query_channel_range_end_blocknum() {
2581 let tests: Vec<(u32, u32, u32)> = vec![
2582 (10000, 1500, 11500),
2583 (0, 0xffffffff, 0xffffffff),
2584 (1, 0xffffffff, 0xffffffff),
2587 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2588 let sut = msgs::QueryChannelRange {
2589 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2593 assert_eq!(sut.end_blocknum(), expected);
2598 fn encoding_query_channel_range() {
2599 let mut query_channel_range = msgs::QueryChannelRange {
2600 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2601 first_blocknum: 100000,
2602 number_of_blocks: 1500,
2604 let encoded_value = query_channel_range.encode();
2605 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2606 assert_eq!(encoded_value, target_value);
2608 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2609 assert_eq!(query_channel_range.first_blocknum, 100000);
2610 assert_eq!(query_channel_range.number_of_blocks, 1500);
2614 fn encoding_reply_channel_range() {
2615 do_encoding_reply_channel_range(0);
2616 do_encoding_reply_channel_range(1);
2619 fn do_encoding_reply_channel_range(encoding_type: u8) {
2620 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2621 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2622 let mut reply_channel_range = msgs::ReplyChannelRange {
2623 chain_hash: expected_chain_hash,
2624 first_blocknum: 756230,
2625 number_of_blocks: 1500,
2626 sync_complete: true,
2627 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2630 if encoding_type == 0 {
2631 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2632 let encoded_value = reply_channel_range.encode();
2633 assert_eq!(encoded_value, target_value);
2635 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2636 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2637 assert_eq!(reply_channel_range.first_blocknum, 756230);
2638 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2639 assert_eq!(reply_channel_range.sync_complete, true);
2640 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2641 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2642 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2644 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2645 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2646 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2651 fn encoding_query_short_channel_ids() {
2652 do_encoding_query_short_channel_ids(0);
2653 do_encoding_query_short_channel_ids(1);
2656 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2657 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2658 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2659 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2660 chain_hash: expected_chain_hash,
2661 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2664 if encoding_type == 0 {
2665 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2666 let encoded_value = query_short_channel_ids.encode();
2667 assert_eq!(encoded_value, target_value);
2669 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2670 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2671 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2672 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2673 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2675 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2676 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2677 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2682 fn encoding_reply_short_channel_ids_end() {
2683 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2684 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2685 chain_hash: expected_chain_hash,
2686 full_information: true,
2688 let encoded_value = reply_short_channel_ids_end.encode();
2689 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2690 assert_eq!(encoded_value, target_value);
2692 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2693 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2694 assert_eq!(reply_short_channel_ids_end.full_information, true);
2698 fn encoding_gossip_timestamp_filter(){
2699 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2700 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2701 chain_hash: expected_chain_hash,
2702 first_timestamp: 1590000000,
2703 timestamp_range: 0xffff_ffff,
2705 let encoded_value = gossip_timestamp_filter.encode();
2706 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2707 assert_eq!(encoded_value, target_value);
2709 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2710 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2711 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2712 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);