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};
39 use util::events::MessageSendEventsProvider;
40 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
42 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
44 /// 21 million * 10^8 * 1000
45 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
47 /// An error in decoding a message or struct.
48 #[derive(Clone, Debug)]
49 pub enum DecodeError {
50 /// A version byte specified something we don't know how to handle.
51 /// Includes unknown realm byte in an OnionHopData packet
53 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
54 UnknownRequiredFeature,
55 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
56 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
57 /// syntactically incorrect, etc
61 /// A length descriptor in the packet didn't describe the later data correctly
63 /// Error from std::io
64 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
65 ::std::io::ErrorKind),
66 /// The message included zlib-compressed values, which we don't support.
67 UnsupportedCompression,
70 /// An init message to be sent or received from a peer
71 #[derive(Clone, Debug, PartialEq)]
73 /// The relevant features which the sender supports
74 pub features: InitFeatures,
77 /// An error message to be sent or received from a peer
78 #[derive(Clone, Debug, PartialEq)]
79 pub struct ErrorMessage {
80 /// The channel ID involved in the error
81 pub channel_id: [u8; 32],
82 /// A possibly human-readable error description.
83 /// The string should be sanitized before it is used (e.g. emitted to logs
84 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
85 /// vulnerability in the terminal emulator or the logging subsystem.
89 /// A ping message to be sent or received from a peer
90 #[derive(Clone, Debug, PartialEq)]
92 /// The desired response length
94 /// The ping packet size.
95 /// This field is not sent on the wire. byteslen zeros are sent.
99 /// A pong message to be sent or received from a peer
100 #[derive(Clone, Debug, PartialEq)]
102 /// The pong packet size.
103 /// This field is not sent on the wire. byteslen zeros are sent.
107 /// An open_channel message to be sent or received from a peer
108 #[derive(Clone, Debug, PartialEq)]
109 pub struct OpenChannel {
110 /// The genesis hash of the blockchain where the channel is to be opened
111 pub chain_hash: BlockHash,
112 /// A temporary channel ID, until the funding outpoint is announced
113 pub temporary_channel_id: [u8; 32],
114 /// The channel value
115 pub funding_satoshis: u64,
116 /// The amount to push to the counterparty as part of the open, in milli-satoshi
118 /// The threshold below which outputs on transactions broadcast by sender will be omitted
119 pub dust_limit_satoshis: u64,
120 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
121 pub max_htlc_value_in_flight_msat: u64,
122 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
123 pub channel_reserve_satoshis: u64,
124 /// The minimum HTLC size incoming to sender, in milli-satoshi
125 pub htlc_minimum_msat: u64,
126 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
127 pub feerate_per_kw: u32,
128 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
129 pub to_self_delay: u16,
130 /// The maximum number of inbound HTLCs towards sender
131 pub max_accepted_htlcs: u16,
132 /// The sender's key controlling the funding transaction
133 pub funding_pubkey: PublicKey,
134 /// Used to derive a revocation key for transactions broadcast by counterparty
135 pub revocation_basepoint: PublicKey,
136 /// A payment key to sender for transactions broadcast by counterparty
137 pub payment_point: PublicKey,
138 /// Used to derive a payment key to sender for transactions broadcast by sender
139 pub delayed_payment_basepoint: PublicKey,
140 /// Used to derive an HTLC payment key to sender
141 pub htlc_basepoint: PublicKey,
142 /// The first to-be-broadcast-by-sender transaction's per commitment point
143 pub first_per_commitment_point: PublicKey,
145 pub channel_flags: u8,
146 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
147 pub shutdown_scriptpubkey: OptionalField<Script>,
150 /// An accept_channel message to be sent or received from a peer
151 #[derive(Clone, Debug, PartialEq)]
152 pub struct AcceptChannel {
153 /// A temporary channel ID, until the funding outpoint is announced
154 pub temporary_channel_id: [u8; 32],
155 /// The threshold below which outputs on transactions broadcast by sender will be omitted
156 pub dust_limit_satoshis: u64,
157 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
158 pub max_htlc_value_in_flight_msat: u64,
159 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
160 pub channel_reserve_satoshis: u64,
161 /// The minimum HTLC size incoming to sender, in milli-satoshi
162 pub htlc_minimum_msat: u64,
163 /// Minimum depth of the funding transaction before the channel is considered open
164 pub minimum_depth: u32,
165 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
166 pub to_self_delay: u16,
167 /// The maximum number of inbound HTLCs towards sender
168 pub max_accepted_htlcs: u16,
169 /// The sender's key controlling the funding transaction
170 pub funding_pubkey: PublicKey,
171 /// Used to derive a revocation key for transactions broadcast by counterparty
172 pub revocation_basepoint: PublicKey,
173 /// A payment key to sender for transactions broadcast by counterparty
174 pub payment_point: PublicKey,
175 /// Used to derive a payment key to sender for transactions broadcast by sender
176 pub delayed_payment_basepoint: PublicKey,
177 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
178 pub htlc_basepoint: PublicKey,
179 /// The first to-be-broadcast-by-sender transaction's per commitment point
180 pub first_per_commitment_point: PublicKey,
181 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
182 pub shutdown_scriptpubkey: OptionalField<Script>,
185 /// A funding_created message to be sent or received from a peer
186 #[derive(Clone, Debug, PartialEq)]
187 pub struct FundingCreated {
188 /// A temporary channel ID, until the funding is established
189 pub temporary_channel_id: [u8; 32],
190 /// The funding transaction ID
191 pub funding_txid: Txid,
192 /// The specific output index funding this channel
193 pub funding_output_index: u16,
194 /// The signature of the channel initiator (funder) on the funding transaction
195 pub signature: Signature,
198 /// A funding_signed message to be sent or received from a peer
199 #[derive(Clone, Debug, PartialEq)]
200 pub struct FundingSigned {
202 pub channel_id: [u8; 32],
203 /// The signature of the channel acceptor (fundee) on the funding transaction
204 pub signature: Signature,
207 /// A funding_locked message to be sent or received from a peer
208 #[derive(Clone, Debug, PartialEq)]
209 pub struct FundingLocked {
211 pub channel_id: [u8; 32],
212 /// The per-commitment point of the second commitment transaction
213 pub next_per_commitment_point: PublicKey,
216 /// A shutdown message to be sent or received from a peer
217 #[derive(Clone, Debug, PartialEq)]
218 pub struct Shutdown {
220 pub channel_id: [u8; 32],
221 /// The destination of this peer's funds on closing.
222 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
223 pub scriptpubkey: Script,
226 /// A closing_signed message to be sent or received from a peer
227 #[derive(Clone, Debug, PartialEq)]
228 pub struct ClosingSigned {
230 pub channel_id: [u8; 32],
231 /// The proposed total fee for the closing transaction
232 pub fee_satoshis: u64,
233 /// A signature on the closing transaction
234 pub signature: Signature,
237 /// An update_add_htlc message to be sent or received from a peer
238 #[derive(Clone, Debug, PartialEq)]
239 pub struct UpdateAddHTLC {
241 pub channel_id: [u8; 32],
244 /// The HTLC value in milli-satoshi
245 pub amount_msat: u64,
246 /// The payment hash, the pre-image of which controls HTLC redemption
247 pub payment_hash: PaymentHash,
248 /// The expiry height of the HTLC
249 pub cltv_expiry: u32,
250 pub(crate) onion_routing_packet: OnionPacket,
253 /// An update_fulfill_htlc message to be sent or received from a peer
254 #[derive(Clone, Debug, PartialEq)]
255 pub struct UpdateFulfillHTLC {
257 pub channel_id: [u8; 32],
260 /// The pre-image of the payment hash, allowing HTLC redemption
261 pub payment_preimage: PaymentPreimage,
264 /// An update_fail_htlc message to be sent or received from a peer
265 #[derive(Clone, Debug, PartialEq)]
266 pub struct UpdateFailHTLC {
268 pub channel_id: [u8; 32],
271 pub(crate) reason: OnionErrorPacket,
274 /// An update_fail_malformed_htlc message to be sent or received from a peer
275 #[derive(Clone, Debug, PartialEq)]
276 pub struct UpdateFailMalformedHTLC {
278 pub channel_id: [u8; 32],
281 pub(crate) sha256_of_onion: [u8; 32],
283 pub failure_code: u16,
286 /// A commitment_signed message to be sent or received from a peer
287 #[derive(Clone, Debug, PartialEq)]
288 pub struct CommitmentSigned {
290 pub channel_id: [u8; 32],
291 /// A signature on the commitment transaction
292 pub signature: Signature,
293 /// Signatures on the HTLC transactions
294 pub htlc_signatures: Vec<Signature>,
297 /// A revoke_and_ack message to be sent or received from a peer
298 #[derive(Clone, Debug, PartialEq)]
299 pub struct RevokeAndACK {
301 pub channel_id: [u8; 32],
302 /// The secret corresponding to the per-commitment point
303 pub per_commitment_secret: [u8; 32],
304 /// The next sender-broadcast commitment transaction's per-commitment point
305 pub next_per_commitment_point: PublicKey,
308 /// An update_fee message to be sent or received from a peer
309 #[derive(Clone, Debug, PartialEq)]
310 pub struct UpdateFee {
312 pub channel_id: [u8; 32],
313 /// Fee rate per 1000-weight of the transaction
314 pub feerate_per_kw: u32,
317 #[derive(Clone, Debug, PartialEq)]
318 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
319 /// This is used to convince the recipient that the channel is at a certain commitment
320 /// number even if they lost that data due to a local failure. Of course, the peer may lie
321 /// and even later commitments may have been revoked.
322 pub struct DataLossProtect {
323 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
324 /// belonging to the recipient
325 pub your_last_per_commitment_secret: [u8; 32],
326 /// The sender's per-commitment point for their current commitment transaction
327 pub my_current_per_commitment_point: PublicKey,
330 /// A channel_reestablish message to be sent or received from a peer
331 #[derive(Clone, Debug, PartialEq)]
332 pub struct ChannelReestablish {
334 pub channel_id: [u8; 32],
335 /// The next commitment number for the sender
336 pub next_local_commitment_number: u64,
337 /// The next commitment number for the recipient
338 pub next_remote_commitment_number: u64,
339 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
340 pub data_loss_protect: OptionalField<DataLossProtect>,
343 /// An announcement_signatures message to be sent or received from a peer
344 #[derive(Clone, Debug, PartialEq)]
345 pub struct AnnouncementSignatures {
347 pub channel_id: [u8; 32],
348 /// The short channel ID
349 pub short_channel_id: u64,
350 /// A signature by the node key
351 pub node_signature: Signature,
352 /// A signature by the funding key
353 pub bitcoin_signature: Signature,
356 /// An address which can be used to connect to a remote peer
357 #[derive(Clone, Debug, PartialEq)]
358 pub enum NetAddress {
359 /// An IPv4 address/port on which the peer is listening.
361 /// The 4-byte IPv4 address
363 /// The port on which the node is listening
366 /// An IPv6 address/port on which the peer is listening.
368 /// The 16-byte IPv6 address
370 /// The port on which the node is listening
373 /// An old-style Tor onion address/port on which the peer is listening.
375 /// The bytes (usually encoded in base32 with ".onion" appended)
377 /// The port on which the node is listening
380 /// A new-style Tor onion address/port on which the peer is listening.
381 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
382 /// wrap as base32 and append ".onion".
384 /// The ed25519 long-term public key of the peer
385 ed25519_pubkey: [u8; 32],
386 /// The checksum of the pubkey and version, as included in the onion address
388 /// The version byte, as defined by the Tor Onion v3 spec.
390 /// The port on which the node is listening
395 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
397 pub(crate) fn get_id(&self) -> u8 {
399 &NetAddress::IPv4 {..} => { 1 },
400 &NetAddress::IPv6 {..} => { 2 },
401 &NetAddress::OnionV2 {..} => { 3 },
402 &NetAddress::OnionV3 {..} => { 4 },
406 /// Strict byte-length of address descriptor, 1-byte type not recorded
407 fn len(&self) -> u16 {
409 &NetAddress::IPv4 { .. } => { 6 },
410 &NetAddress::IPv6 { .. } => { 18 },
411 &NetAddress::OnionV2 { .. } => { 12 },
412 &NetAddress::OnionV3 { .. } => { 37 },
416 /// The maximum length of any address descriptor, not including the 1-byte type
417 pub(crate) const MAX_LEN: u16 = 37;
420 impl Writeable for NetAddress {
421 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
423 &NetAddress::IPv4 { ref addr, ref port } => {
428 &NetAddress::IPv6 { ref addr, ref port } => {
433 &NetAddress::OnionV2 { ref addr, ref port } => {
438 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
440 ed25519_pubkey.write(writer)?;
441 checksum.write(writer)?;
442 version.write(writer)?;
450 impl Readable for Result<NetAddress, u8> {
451 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
452 let byte = <u8 as Readable>::read(reader)?;
455 Ok(Ok(NetAddress::IPv4 {
456 addr: Readable::read(reader)?,
457 port: Readable::read(reader)?,
461 Ok(Ok(NetAddress::IPv6 {
462 addr: Readable::read(reader)?,
463 port: Readable::read(reader)?,
467 Ok(Ok(NetAddress::OnionV2 {
468 addr: Readable::read(reader)?,
469 port: Readable::read(reader)?,
473 Ok(Ok(NetAddress::OnionV3 {
474 ed25519_pubkey: Readable::read(reader)?,
475 checksum: Readable::read(reader)?,
476 version: Readable::read(reader)?,
477 port: Readable::read(reader)?,
480 _ => return Ok(Err(byte)),
485 /// The unsigned part of a node_announcement
486 #[derive(Clone, Debug, PartialEq)]
487 pub struct UnsignedNodeAnnouncement {
488 /// The advertised features
489 pub features: NodeFeatures,
490 /// A strictly monotonic announcement counter, with gaps allowed
492 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
494 pub node_id: PublicKey,
495 /// An RGB color for UI purposes
497 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
500 /// List of addresses on which this node is reachable
501 pub addresses: Vec<NetAddress>,
502 pub(crate) excess_address_data: Vec<u8>,
503 pub(crate) excess_data: Vec<u8>,
505 #[derive(Clone, Debug, PartialEq)]
506 /// A node_announcement message to be sent or received from a peer
507 pub struct NodeAnnouncement {
508 /// The signature by the node key
509 pub signature: Signature,
510 /// The actual content of the announcement
511 pub contents: UnsignedNodeAnnouncement,
514 /// The unsigned part of a channel_announcement
515 #[derive(Clone, Debug, PartialEq)]
516 pub struct UnsignedChannelAnnouncement {
517 /// The advertised channel features
518 pub features: ChannelFeatures,
519 /// The genesis hash of the blockchain where the channel is to be opened
520 pub chain_hash: BlockHash,
521 /// The short channel ID
522 pub short_channel_id: u64,
523 /// One of the two node_ids which are endpoints of this channel
524 pub node_id_1: PublicKey,
525 /// The other of the two node_ids which are endpoints of this channel
526 pub node_id_2: PublicKey,
527 /// The funding key for the first node
528 pub bitcoin_key_1: PublicKey,
529 /// The funding key for the second node
530 pub bitcoin_key_2: PublicKey,
531 pub(crate) excess_data: Vec<u8>,
533 /// A channel_announcement message to be sent or received from a peer
534 #[derive(Clone, Debug, PartialEq)]
535 pub struct ChannelAnnouncement {
536 /// Authentication of the announcement by the first public node
537 pub node_signature_1: Signature,
538 /// Authentication of the announcement by the second public node
539 pub node_signature_2: Signature,
540 /// Proof of funding UTXO ownership by the first public node
541 pub bitcoin_signature_1: Signature,
542 /// Proof of funding UTXO ownership by the second public node
543 pub bitcoin_signature_2: Signature,
544 /// The actual announcement
545 pub contents: UnsignedChannelAnnouncement,
548 /// The unsigned part of a channel_update
549 #[derive(Clone, Debug, PartialEq)]
550 pub struct UnsignedChannelUpdate {
551 /// The genesis hash of the blockchain where the channel is to be opened
552 pub chain_hash: BlockHash,
553 /// The short channel ID
554 pub short_channel_id: u64,
555 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
559 /// The number of blocks such that if:
560 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
561 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
562 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
563 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
564 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
565 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
566 /// constructing the route.
567 pub cltv_expiry_delta: u16,
568 /// The minimum HTLC size incoming to sender, in milli-satoshi
569 pub htlc_minimum_msat: u64,
570 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
571 pub htlc_maximum_msat: OptionalField<u64>,
572 /// The base HTLC fee charged by sender, in milli-satoshi
573 pub fee_base_msat: u32,
574 /// The amount to fee multiplier, in micro-satoshi
575 pub fee_proportional_millionths: u32,
576 pub(crate) excess_data: Vec<u8>,
578 /// A channel_update message to be sent or received from a peer
579 #[derive(Clone, Debug, PartialEq)]
580 pub struct ChannelUpdate {
581 /// A signature of the channel update
582 pub signature: Signature,
583 /// The actual channel update
584 pub contents: UnsignedChannelUpdate,
587 /// A query_channel_range message is used to query a peer for channel
588 /// UTXOs in a range of blocks. The recipient of a query makes a best
589 /// effort to reply to the query using one or more reply_channel_range
591 #[derive(Clone, Debug, PartialEq)]
592 pub struct QueryChannelRange {
593 /// The genesis hash of the blockchain being queried
594 pub chain_hash: BlockHash,
595 /// The height of the first block for the channel UTXOs being queried
596 pub first_blocknum: u32,
597 /// The number of blocks to include in the query results
598 pub number_of_blocks: u32,
601 /// A reply_channel_range message is a reply to a query_channel_range
602 /// message. Multiple reply_channel_range messages can be sent in reply
603 /// to a single query_channel_range message. The query recipient makes a
604 /// best effort to respond based on their local network view which may
605 /// not be a perfect view of the network. The short_channel_ids in the
606 /// reply are encoded. We only support encoding_type=0 uncompressed
607 /// serialization and do not support encoding_type=1 zlib serialization.
608 #[derive(Clone, Debug, PartialEq)]
609 pub struct ReplyChannelRange {
610 /// The genesis hash of the blockchain being queried
611 pub chain_hash: BlockHash,
612 /// The height of the first block in the range of the reply
613 pub first_blocknum: u32,
614 /// The number of blocks included in the range of the reply
615 pub number_of_blocks: u32,
616 /// True when this is the final reply for a query
617 pub sync_complete: bool,
618 /// The short_channel_ids in the channel range
619 pub short_channel_ids: Vec<u64>,
622 /// A query_short_channel_ids message is used to query a peer for
623 /// routing gossip messages related to one or more short_channel_ids.
624 /// The query recipient will reply with the latest, if available,
625 /// channel_announcement, channel_update and node_announcement messages
626 /// it maintains for the requested short_channel_ids followed by a
627 /// reply_short_channel_ids_end message. The short_channel_ids sent in
628 /// this query are encoded. We only support encoding_type=0 uncompressed
629 /// serialization and do not support encoding_type=1 zlib serialization.
630 #[derive(Clone, Debug, PartialEq)]
631 pub struct QueryShortChannelIds {
632 /// The genesis hash of the blockchain being queried
633 pub chain_hash: BlockHash,
634 /// The short_channel_ids that are being queried
635 pub short_channel_ids: Vec<u64>,
638 /// A reply_short_channel_ids_end message is sent as a reply to a
639 /// query_short_channel_ids message. The query recipient makes a best
640 /// effort to respond based on their local network view which may not be
641 /// a perfect view of the network.
642 #[derive(Clone, Debug, PartialEq)]
643 pub struct ReplyShortChannelIdsEnd {
644 /// The genesis hash of the blockchain that was queried
645 pub chain_hash: BlockHash,
646 /// Indicates if the query recipient maintains up-to-date channel
647 /// information for the chain_hash
648 pub full_information: bool,
651 /// A gossip_timestamp_filter message is used by a node to request
652 /// gossip relay for messages in the requested time range when the
653 /// gossip_queries feature has been negotiated.
654 #[derive(Clone, Debug, PartialEq)]
655 pub struct GossipTimestampFilter {
656 /// The genesis hash of the blockchain for channel and node information
657 pub chain_hash: BlockHash,
658 /// The starting unix timestamp
659 pub first_timestamp: u32,
660 /// The range of information in seconds
661 pub timestamp_range: u32,
664 /// Encoding type for data compression of collections in gossip queries.
665 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
670 /// Used to put an error message in a LightningError
671 #[derive(Clone, Debug)]
672 pub enum ErrorAction {
673 /// The peer took some action which made us think they were useless. Disconnect them.
675 /// An error message which we should make an effort to send before we disconnect.
676 msg: Option<ErrorMessage>
678 /// The peer did something harmless that we weren't able to process, just log and ignore
680 /// The peer did something incorrect. Tell them.
682 /// The message to send.
687 /// An Err type for failure to process messages.
688 #[derive(Clone, Debug)]
689 pub struct LightningError {
690 /// A human-readable message describing the error
692 /// The action which should be taken against the offending peer.
693 pub action: ErrorAction,
696 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
697 /// transaction updates if they were pending.
698 #[derive(Clone, Debug, PartialEq)]
699 pub struct CommitmentUpdate {
700 /// update_add_htlc messages which should be sent
701 pub update_add_htlcs: Vec<UpdateAddHTLC>,
702 /// update_fulfill_htlc messages which should be sent
703 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
704 /// update_fail_htlc messages which should be sent
705 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
706 /// update_fail_malformed_htlc messages which should be sent
707 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
708 /// An update_fee message which should be sent
709 pub update_fee: Option<UpdateFee>,
710 /// Finally, the commitment_signed message which should be sent
711 pub commitment_signed: CommitmentSigned,
714 /// The information we received from a peer along the route of a payment we originated. This is
715 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
716 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
717 #[derive(Clone, Debug, PartialEq)]
718 pub enum HTLCFailChannelUpdate {
719 /// We received an error which included a full ChannelUpdate message.
720 ChannelUpdateMessage {
721 /// The unwrapped message we received
724 /// We received an error which indicated only that a channel has been closed
726 /// The short_channel_id which has now closed.
727 short_channel_id: u64,
728 /// when this true, this channel should be permanently removed from the
729 /// consideration. Otherwise, this channel can be restored as new channel_update is received
732 /// We received an error which indicated only that a node has failed
734 /// The node_id that has failed.
736 /// when this true, node should be permanently removed from the
737 /// consideration. Otherwise, the channels connected to this node can be
738 /// restored as new channel_update is received
743 /// Messages could have optional fields to use with extended features
744 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
745 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
746 /// separate enum type for them.
747 /// (C-not exported) due to a free generic in T
748 #[derive(Clone, Debug, PartialEq)]
749 pub enum OptionalField<T> {
750 /// Optional field is included in message
752 /// Optional field is absent in message
756 /// A trait to describe an object which can receive channel messages.
758 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
759 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
760 pub trait ChannelMessageHandler : MessageSendEventsProvider {
762 /// Handle an incoming open_channel message from the given peer.
763 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
764 /// Handle an incoming accept_channel message from the given peer.
765 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
766 /// Handle an incoming funding_created message from the given peer.
767 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
768 /// Handle an incoming funding_signed message from the given peer.
769 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
770 /// Handle an incoming funding_locked message from the given peer.
771 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
774 /// Handle an incoming shutdown message from the given peer.
775 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
776 /// Handle an incoming closing_signed message from the given peer.
777 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
780 /// Handle an incoming update_add_htlc message from the given peer.
781 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
782 /// Handle an incoming update_fulfill_htlc message from the given peer.
783 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
784 /// Handle an incoming update_fail_htlc message from the given peer.
785 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
786 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
787 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
788 /// Handle an incoming commitment_signed message from the given peer.
789 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
790 /// Handle an incoming revoke_and_ack message from the given peer.
791 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
793 /// Handle an incoming update_fee message from the given peer.
794 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
796 // Channel-to-announce:
797 /// Handle an incoming announcement_signatures message from the given peer.
798 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
800 // Connection loss/reestablish:
801 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
802 /// is believed to be possible in the future (eg they're sending us messages we don't
803 /// understand or indicate they require unknown feature bits), no_connection_possible is set
804 /// and any outstanding channels should be failed.
805 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
807 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
808 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
809 /// Handle an incoming channel_reestablish message from the given peer.
810 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
812 /// Handle an incoming channel update from the given peer.
813 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
816 /// Handle an incoming error message from the given peer.
817 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
820 /// A trait to describe an object which can receive routing messages.
822 /// # Implementor DoS Warnings
824 /// For `gossip_queries` messages there are potential DoS vectors when handling
825 /// inbound queries. Implementors using an on-disk network graph should be aware of
826 /// repeated disk I/O for queries accessing different parts of the network graph.
827 pub trait RoutingMessageHandler : MessageSendEventsProvider {
828 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
829 /// false or returning an Err otherwise.
830 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
831 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
832 /// or returning an Err otherwise.
833 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
834 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
835 /// false or returning an Err otherwise.
836 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
837 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
838 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
839 /// Gets a subset of the channel announcements and updates required to dump our routing table
840 /// to a remote node, starting at the short_channel_id indicated by starting_point and
841 /// including the batch_amount entries immediately higher in numerical value than starting_point.
842 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
843 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
844 /// starting at the node *after* the provided publickey and including batch_amount entries
845 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
846 /// If None is provided for starting_point, we start at the first node.
847 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
848 /// Called when a connection is established with a peer. This can be used to
849 /// perform routing table synchronization using a strategy defined by the
851 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
852 /// Handles the reply of a query we initiated to learn about channels
853 /// for a given range of blocks. We can expect to receive one or more
854 /// replies to a single query.
855 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
856 /// Handles the reply of a query we initiated asking for routing gossip
857 /// messages for a list of channels. We should receive this message when
858 /// a node has completed its best effort to send us the pertaining routing
860 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
861 /// Handles when a peer asks us to send a list of short_channel_ids
862 /// for the requested range of blocks.
863 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
864 /// Handles when a peer asks us to send routing gossip messages for a
865 /// list of short_channel_ids.
866 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
869 mod fuzzy_internal_msgs {
870 use ln::PaymentSecret;
872 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
873 // them from untrusted input):
875 pub(crate) struct FinalOnionHopData {
876 pub(crate) payment_secret: PaymentSecret,
877 /// The total value, in msat, of the payment as received by the ultimate recipient.
878 /// Message serialization may panic if this value is more than 21 million Bitcoin.
879 pub(crate) total_msat: u64,
882 pub(crate) enum OnionHopDataFormat {
883 Legacy { // aka Realm-0
884 short_channel_id: u64,
887 short_channel_id: u64,
890 payment_data: Option<FinalOnionHopData>,
894 pub struct OnionHopData {
895 pub(crate) format: OnionHopDataFormat,
896 /// The value, in msat, of the payment after this hop's fee is deducted.
897 /// Message serialization may panic if this value is more than 21 million Bitcoin.
898 pub(crate) amt_to_forward: u64,
899 pub(crate) outgoing_cltv_value: u32,
900 // 12 bytes of 0-padding for Legacy format
903 pub struct DecodedOnionErrorPacket {
904 pub(crate) hmac: [u8; 32],
905 pub(crate) failuremsg: Vec<u8>,
906 pub(crate) pad: Vec<u8>,
909 #[cfg(feature = "fuzztarget")]
910 pub use self::fuzzy_internal_msgs::*;
911 #[cfg(not(feature = "fuzztarget"))]
912 pub(crate) use self::fuzzy_internal_msgs::*;
915 pub(crate) struct OnionPacket {
916 pub(crate) version: u8,
917 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
918 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
919 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
920 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
921 pub(crate) hop_data: [u8; 20*65],
922 pub(crate) hmac: [u8; 32],
925 impl PartialEq for OnionPacket {
926 fn eq(&self, other: &OnionPacket) -> bool {
927 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
928 if i != j { return false; }
930 self.version == other.version &&
931 self.public_key == other.public_key &&
932 self.hmac == other.hmac
936 impl fmt::Debug for OnionPacket {
937 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
938 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
942 #[derive(Clone, Debug, PartialEq)]
943 pub(crate) struct OnionErrorPacket {
944 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
945 // (TODO) We limit it in decode to much lower...
946 pub(crate) data: Vec<u8>,
949 impl fmt::Display for DecodeError {
950 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
952 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
953 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
954 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
955 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
956 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
957 DecodeError::Io(ref e) => e.fmt(f),
958 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
963 impl From<::std::io::Error> for DecodeError {
964 fn from(e: ::std::io::Error) -> Self {
965 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
966 DecodeError::ShortRead
968 DecodeError::Io(e.kind())
973 impl Writeable for OptionalField<Script> {
974 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
976 OptionalField::Present(ref script) => {
977 // Note that Writeable for script includes the 16-bit length tag for us
980 OptionalField::Absent => {}
986 impl Readable for OptionalField<Script> {
987 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
988 match <u16 as Readable>::read(r) {
990 let mut buf = vec![0; len as usize];
991 r.read_exact(&mut buf)?;
992 Ok(OptionalField::Present(Script::from(buf)))
994 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1000 impl Writeable for OptionalField<u64> {
1001 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1003 OptionalField::Present(ref value) => {
1006 OptionalField::Absent => {}
1012 impl Readable for OptionalField<u64> {
1013 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1014 let value: u64 = Readable::read(r)?;
1015 Ok(OptionalField::Present(value))
1020 impl_writeable_len_match!(AcceptChannel, {
1021 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1024 temporary_channel_id,
1025 dust_limit_satoshis,
1026 max_htlc_value_in_flight_msat,
1027 channel_reserve_satoshis,
1033 revocation_basepoint,
1035 delayed_payment_basepoint,
1037 first_per_commitment_point,
1038 shutdown_scriptpubkey
1041 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1048 impl Writeable for ChannelReestablish {
1049 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1050 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1051 self.channel_id.write(w)?;
1052 self.next_local_commitment_number.write(w)?;
1053 self.next_remote_commitment_number.write(w)?;
1054 match self.data_loss_protect {
1055 OptionalField::Present(ref data_loss_protect) => {
1056 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1057 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1059 OptionalField::Absent => {}
1065 impl Readable for ChannelReestablish{
1066 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1068 channel_id: Readable::read(r)?,
1069 next_local_commitment_number: Readable::read(r)?,
1070 next_remote_commitment_number: Readable::read(r)?,
1071 data_loss_protect: {
1072 match <[u8; 32] as Readable>::read(r) {
1073 Ok(your_last_per_commitment_secret) =>
1074 OptionalField::Present(DataLossProtect {
1075 your_last_per_commitment_secret,
1076 my_current_per_commitment_point: Readable::read(r)?,
1078 Err(DecodeError::ShortRead) => OptionalField::Absent,
1079 Err(e) => return Err(e)
1086 impl_writeable!(ClosingSigned, 32+8+64, {
1092 impl_writeable_len_match!(CommitmentSigned, {
1093 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1100 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1101 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1108 impl_writeable!(FundingCreated, 32+32+2+64, {
1109 temporary_channel_id,
1111 funding_output_index,
1115 impl_writeable!(FundingSigned, 32+64, {
1120 impl_writeable!(FundingLocked, 32+33, {
1122 next_per_commitment_point
1125 impl Writeable for Init {
1126 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1127 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1128 // our relevant feature bits. This keeps us compatible with old nodes.
1129 self.features.write_up_to_13(w)?;
1130 self.features.write(w)
1134 impl Readable for Init {
1135 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1136 let global_features: InitFeatures = Readable::read(r)?;
1137 let features: InitFeatures = Readable::read(r)?;
1139 features: features.or(global_features),
1144 impl_writeable_len_match!(OpenChannel, {
1145 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1149 temporary_channel_id,
1152 dust_limit_satoshis,
1153 max_htlc_value_in_flight_msat,
1154 channel_reserve_satoshis,
1160 revocation_basepoint,
1162 delayed_payment_basepoint,
1164 first_per_commitment_point,
1166 shutdown_scriptpubkey
1169 impl_writeable!(RevokeAndACK, 32+32+33, {
1171 per_commitment_secret,
1172 next_per_commitment_point
1175 impl_writeable_len_match!(Shutdown, {
1176 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1182 impl_writeable_len_match!(UpdateFailHTLC, {
1183 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1190 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1197 impl_writeable!(UpdateFee, 32+4, {
1202 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1208 impl_writeable_len_match!(OnionErrorPacket, {
1209 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1214 impl Writeable for OnionPacket {
1215 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1216 w.size_hint(1 + 33 + 20*65 + 32);
1217 self.version.write(w)?;
1218 match self.public_key {
1219 Ok(pubkey) => pubkey.write(w)?,
1220 Err(_) => [0u8;33].write(w)?,
1222 w.write_all(&self.hop_data)?;
1223 self.hmac.write(w)?;
1228 impl Readable for OnionPacket {
1229 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1231 version: Readable::read(r)?,
1233 let mut buf = [0u8;33];
1234 r.read_exact(&mut buf)?;
1235 PublicKey::from_slice(&buf)
1237 hop_data: Readable::read(r)?,
1238 hmac: Readable::read(r)?,
1243 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1249 onion_routing_packet
1252 impl Writeable for FinalOnionHopData {
1253 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1254 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1255 self.payment_secret.0.write(w)?;
1256 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1260 impl Readable for FinalOnionHopData {
1261 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1262 let secret: [u8; 32] = Readable::read(r)?;
1263 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1264 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1268 impl Writeable for OnionHopData {
1269 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1271 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1272 // check values are sane long before we get here, though its possible in the future
1273 // user-generated messages may hit this.
1274 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1276 OnionHopDataFormat::Legacy { short_channel_id } => {
1278 short_channel_id.write(w)?;
1279 self.amt_to_forward.write(w)?;
1280 self.outgoing_cltv_value.write(w)?;
1281 w.write_all(&[0;12])?;
1283 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1284 encode_varint_length_prefixed_tlv!(w, {
1285 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1286 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1287 (6, short_channel_id)
1290 OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1291 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1292 encode_varint_length_prefixed_tlv!(w, {
1293 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1294 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1298 OnionHopDataFormat::FinalNode { payment_data: None } => {
1299 encode_varint_length_prefixed_tlv!(w, {
1300 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1301 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1309 impl Readable for OnionHopData {
1310 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1311 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1312 let v: VarInt = Decodable::consensus_decode(&mut r)
1313 .map_err(|e| match e {
1314 Error::Io(ioe) => DecodeError::from(ioe),
1315 _ => DecodeError::InvalidValue
1317 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1318 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1319 let mut rd = FixedLengthReader::new(r, v.0);
1320 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1321 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1322 let mut short_id: Option<u64> = None;
1323 let mut payment_data: Option<FinalOnionHopData> = None;
1324 decode_tlv!(&mut rd, {
1331 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1332 let format = if let Some(short_channel_id) = short_id {
1333 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1334 OnionHopDataFormat::NonFinalNode {
1338 if let &Some(ref data) = &payment_data {
1339 if data.total_msat > MAX_VALUE_MSAT {
1340 return Err(DecodeError::InvalidValue);
1343 OnionHopDataFormat::FinalNode {
1347 (format, amt.0, cltv_value.0)
1349 let format = OnionHopDataFormat::Legacy {
1350 short_channel_id: Readable::read(r)?,
1352 let amt: u64 = Readable::read(r)?;
1353 let cltv_value: u32 = Readable::read(r)?;
1354 r.read_exact(&mut [0; 12])?;
1355 (format, amt, cltv_value)
1358 if amt > MAX_VALUE_MSAT {
1359 return Err(DecodeError::InvalidValue);
1363 amt_to_forward: amt,
1364 outgoing_cltv_value: cltv_value,
1369 impl Writeable for Ping {
1370 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1371 w.size_hint(self.byteslen as usize + 4);
1372 self.ponglen.write(w)?;
1373 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1378 impl Readable for Ping {
1379 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1381 ponglen: Readable::read(r)?,
1383 let byteslen = Readable::read(r)?;
1384 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1391 impl Writeable for Pong {
1392 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1393 w.size_hint(self.byteslen as usize + 2);
1394 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1399 impl Readable for Pong {
1400 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1403 let byteslen = Readable::read(r)?;
1404 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1411 impl Writeable for UnsignedChannelAnnouncement {
1412 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1413 w.size_hint(2 + 32 + 8 + 4*33 + self.features.byte_count() + self.excess_data.len());
1414 self.features.write(w)?;
1415 self.chain_hash.write(w)?;
1416 self.short_channel_id.write(w)?;
1417 self.node_id_1.write(w)?;
1418 self.node_id_2.write(w)?;
1419 self.bitcoin_key_1.write(w)?;
1420 self.bitcoin_key_2.write(w)?;
1421 w.write_all(&self.excess_data[..])?;
1426 impl Readable for UnsignedChannelAnnouncement {
1427 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1429 features: Readable::read(r)?,
1430 chain_hash: Readable::read(r)?,
1431 short_channel_id: Readable::read(r)?,
1432 node_id_1: Readable::read(r)?,
1433 node_id_2: Readable::read(r)?,
1434 bitcoin_key_1: Readable::read(r)?,
1435 bitcoin_key_2: Readable::read(r)?,
1437 let mut excess_data = vec![];
1438 r.read_to_end(&mut excess_data)?;
1445 impl_writeable_len_match!(ChannelAnnouncement, {
1446 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1447 2 + 32 + 8 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1451 bitcoin_signature_1,
1452 bitcoin_signature_2,
1456 impl Writeable for UnsignedChannelUpdate {
1457 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1458 let mut size = 64 + self.excess_data.len();
1459 let mut message_flags: u8 = 0;
1460 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1465 self.chain_hash.write(w)?;
1466 self.short_channel_id.write(w)?;
1467 self.timestamp.write(w)?;
1468 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1469 all_flags.write(w)?;
1470 self.cltv_expiry_delta.write(w)?;
1471 self.htlc_minimum_msat.write(w)?;
1472 self.fee_base_msat.write(w)?;
1473 self.fee_proportional_millionths.write(w)?;
1474 self.htlc_maximum_msat.write(w)?;
1475 w.write_all(&self.excess_data[..])?;
1480 impl Readable for UnsignedChannelUpdate {
1481 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1482 let has_htlc_maximum_msat;
1484 chain_hash: Readable::read(r)?,
1485 short_channel_id: Readable::read(r)?,
1486 timestamp: Readable::read(r)?,
1488 let flags: u16 = Readable::read(r)?;
1489 let message_flags = flags >> 8;
1490 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1493 cltv_expiry_delta: Readable::read(r)?,
1494 htlc_minimum_msat: Readable::read(r)?,
1495 fee_base_msat: Readable::read(r)?,
1496 fee_proportional_millionths: Readable::read(r)?,
1497 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1499 let mut excess_data = vec![];
1500 r.read_to_end(&mut excess_data)?;
1507 impl_writeable_len_match!(ChannelUpdate, {
1508 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ref htlc_maximum_msat, ..}, .. },
1509 64 + 64 + excess_data.len() + if let OptionalField::Present(_) = htlc_maximum_msat { 8 } else { 0 } }
1515 impl Writeable for ErrorMessage {
1516 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1517 w.size_hint(32 + 2 + self.data.len());
1518 self.channel_id.write(w)?;
1519 (self.data.len() as u16).write(w)?;
1520 w.write_all(self.data.as_bytes())?;
1525 impl Readable for ErrorMessage {
1526 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1528 channel_id: Readable::read(r)?,
1530 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1531 let mut data = vec![];
1532 let data_len = r.read_to_end(&mut data)?;
1533 sz = cmp::min(data_len, sz);
1534 match String::from_utf8(data[..sz as usize].to_vec()) {
1536 Err(_) => return Err(DecodeError::InvalidValue),
1543 impl Writeable for UnsignedNodeAnnouncement {
1544 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1545 w.size_hint(76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1546 self.features.write(w)?;
1547 self.timestamp.write(w)?;
1548 self.node_id.write(w)?;
1549 w.write_all(&self.rgb)?;
1550 self.alias.write(w)?;
1552 let mut addr_len = 0;
1553 for addr in self.addresses.iter() {
1554 addr_len += 1 + addr.len();
1556 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1557 for addr in self.addresses.iter() {
1560 w.write_all(&self.excess_address_data[..])?;
1561 w.write_all(&self.excess_data[..])?;
1566 impl Readable for UnsignedNodeAnnouncement {
1567 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1568 let features: NodeFeatures = Readable::read(r)?;
1569 let timestamp: u32 = Readable::read(r)?;
1570 let node_id: PublicKey = Readable::read(r)?;
1571 let mut rgb = [0; 3];
1572 r.read_exact(&mut rgb)?;
1573 let alias: [u8; 32] = Readable::read(r)?;
1575 let addr_len: u16 = Readable::read(r)?;
1576 let mut addresses: Vec<NetAddress> = Vec::new();
1577 let mut addr_readpos = 0;
1578 let mut excess = false;
1579 let mut excess_byte = 0;
1581 if addr_len <= addr_readpos { break; }
1582 match Readable::read(r) {
1584 if addr_len < addr_readpos + 1 + addr.len() {
1585 return Err(DecodeError::BadLengthDescriptor);
1587 addr_readpos += (1 + addr.len()) as u16;
1588 addresses.push(addr);
1590 Ok(Err(unknown_descriptor)) => {
1592 excess_byte = unknown_descriptor;
1595 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1596 Err(e) => return Err(e),
1600 let mut excess_data = vec![];
1601 let excess_address_data = if addr_readpos < addr_len {
1602 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1603 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1605 excess_address_data[0] = excess_byte;
1610 excess_data.push(excess_byte);
1614 r.read_to_end(&mut excess_data)?;
1615 Ok(UnsignedNodeAnnouncement {
1622 excess_address_data,
1628 impl_writeable_len_match!(NodeAnnouncement, <=, {
1629 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1630 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1636 impl Readable for QueryShortChannelIds {
1637 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1638 let chain_hash: BlockHash = Readable::read(r)?;
1640 let encoding_len: u16 = Readable::read(r)?;
1641 let encoding_type: u8 = Readable::read(r)?;
1643 // Must be encoding_type=0 uncompressed serialization. We do not
1644 // support encoding_type=1 zlib serialization.
1645 if encoding_type != EncodingType::Uncompressed as u8 {
1646 return Err(DecodeError::UnsupportedCompression);
1649 // We expect the encoding_len to always includes the 1-byte
1650 // encoding_type and that short_channel_ids are 8-bytes each
1651 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1652 return Err(DecodeError::InvalidValue);
1655 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1656 // less the 1-byte encoding_type
1657 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1658 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1659 for _ in 0..short_channel_id_count {
1660 short_channel_ids.push(Readable::read(r)?);
1663 Ok(QueryShortChannelIds {
1670 impl Writeable for QueryShortChannelIds {
1671 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1672 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1673 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1675 w.size_hint(32 + 2 + encoding_len as usize);
1676 self.chain_hash.write(w)?;
1677 encoding_len.write(w)?;
1679 // We only support type=0 uncompressed serialization
1680 (EncodingType::Uncompressed as u8).write(w)?;
1682 for scid in self.short_channel_ids.iter() {
1690 impl Readable for ReplyShortChannelIdsEnd {
1691 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1692 let chain_hash: BlockHash = Readable::read(r)?;
1693 let full_information: bool = Readable::read(r)?;
1694 Ok(ReplyShortChannelIdsEnd {
1701 impl Writeable for ReplyShortChannelIdsEnd {
1702 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1703 w.size_hint(32 + 1);
1704 self.chain_hash.write(w)?;
1705 self.full_information.write(w)?;
1710 impl QueryChannelRange {
1712 * Calculates the overflow safe ending block height for the query.
1713 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1715 pub fn end_blocknum(&self) -> u32 {
1716 match self.first_blocknum.checked_add(self.number_of_blocks) {
1717 Some(block) => block,
1718 None => u32::max_value(),
1723 impl Readable for QueryChannelRange {
1724 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1725 let chain_hash: BlockHash = Readable::read(r)?;
1726 let first_blocknum: u32 = Readable::read(r)?;
1727 let number_of_blocks: u32 = Readable::read(r)?;
1728 Ok(QueryChannelRange {
1736 impl Writeable for QueryChannelRange {
1737 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1738 w.size_hint(32 + 4 + 4);
1739 self.chain_hash.write(w)?;
1740 self.first_blocknum.write(w)?;
1741 self.number_of_blocks.write(w)?;
1746 impl Readable for ReplyChannelRange {
1747 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1748 let chain_hash: BlockHash = Readable::read(r)?;
1749 let first_blocknum: u32 = Readable::read(r)?;
1750 let number_of_blocks: u32 = Readable::read(r)?;
1751 let sync_complete: bool = Readable::read(r)?;
1753 let encoding_len: u16 = Readable::read(r)?;
1754 let encoding_type: u8 = Readable::read(r)?;
1756 // Must be encoding_type=0 uncompressed serialization. We do not
1757 // support encoding_type=1 zlib serialization.
1758 if encoding_type != EncodingType::Uncompressed as u8 {
1759 return Err(DecodeError::UnsupportedCompression);
1762 // We expect the encoding_len to always includes the 1-byte
1763 // encoding_type and that short_channel_ids are 8-bytes each
1764 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1765 return Err(DecodeError::InvalidValue);
1768 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1769 // less the 1-byte encoding_type
1770 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1771 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1772 for _ in 0..short_channel_id_count {
1773 short_channel_ids.push(Readable::read(r)?);
1776 Ok(ReplyChannelRange {
1786 impl Writeable for ReplyChannelRange {
1787 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1788 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1789 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1790 self.chain_hash.write(w)?;
1791 self.first_blocknum.write(w)?;
1792 self.number_of_blocks.write(w)?;
1793 self.sync_complete.write(w)?;
1795 encoding_len.write(w)?;
1796 (EncodingType::Uncompressed as u8).write(w)?;
1797 for scid in self.short_channel_ids.iter() {
1805 impl Readable for GossipTimestampFilter {
1806 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1807 let chain_hash: BlockHash = Readable::read(r)?;
1808 let first_timestamp: u32 = Readable::read(r)?;
1809 let timestamp_range: u32 = Readable::read(r)?;
1810 Ok(GossipTimestampFilter {
1818 impl Writeable for GossipTimestampFilter {
1819 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1820 w.size_hint(32 + 4 + 4);
1821 self.chain_hash.write(w)?;
1822 self.first_timestamp.write(w)?;
1823 self.timestamp_range.write(w)?;
1832 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1834 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1835 use util::ser::{Writeable, Readable};
1837 use bitcoin::hashes::hex::FromHex;
1838 use bitcoin::util::address::Address;
1839 use bitcoin::network::constants::Network;
1840 use bitcoin::blockdata::script::Builder;
1841 use bitcoin::blockdata::opcodes;
1842 use bitcoin::hash_types::{Txid, BlockHash};
1844 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1845 use bitcoin::secp256k1::{Secp256k1, Message};
1847 use std::io::Cursor;
1850 fn encoding_channel_reestablish_no_secret() {
1851 let cr = msgs::ChannelReestablish {
1852 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],
1853 next_local_commitment_number: 3,
1854 next_remote_commitment_number: 4,
1855 data_loss_protect: OptionalField::Absent,
1858 let encoded_value = cr.encode();
1861 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]
1866 fn encoding_channel_reestablish_with_secret() {
1868 let secp_ctx = Secp256k1::new();
1869 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1872 let cr = msgs::ChannelReestablish {
1873 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],
1874 next_local_commitment_number: 3,
1875 next_remote_commitment_number: 4,
1876 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1879 let encoded_value = cr.encode();
1882 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]
1886 macro_rules! get_keys_from {
1887 ($slice: expr, $secp_ctx: expr) => {
1889 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1890 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1896 macro_rules! get_sig_on {
1897 ($privkey: expr, $ctx: expr, $string: expr) => {
1899 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1900 $ctx.sign(&sighash, &$privkey)
1906 fn encoding_announcement_signatures() {
1907 let secp_ctx = Secp256k1::new();
1908 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1909 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1910 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1911 let announcement_signatures = msgs::AnnouncementSignatures {
1912 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],
1913 short_channel_id: 2316138423780173,
1914 node_signature: sig_1,
1915 bitcoin_signature: sig_2,
1918 let encoded_value = announcement_signatures.encode();
1919 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1922 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1923 let secp_ctx = Secp256k1::new();
1924 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1925 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1926 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1927 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1928 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1929 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1930 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1931 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1932 let mut features = ChannelFeatures::known();
1933 if unknown_features_bits {
1934 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1936 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1938 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1939 short_channel_id: 2316138423780173,
1940 node_id_1: pubkey_1,
1941 node_id_2: pubkey_2,
1942 bitcoin_key_1: pubkey_3,
1943 bitcoin_key_2: pubkey_4,
1944 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1946 let channel_announcement = msgs::ChannelAnnouncement {
1947 node_signature_1: sig_1,
1948 node_signature_2: sig_2,
1949 bitcoin_signature_1: sig_3,
1950 bitcoin_signature_2: sig_4,
1951 contents: unsigned_channel_announcement,
1953 let encoded_value = channel_announcement.encode();
1954 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1955 if unknown_features_bits {
1956 target_value.append(&mut hex::decode("0002ffff").unwrap());
1958 target_value.append(&mut hex::decode("0000").unwrap());
1960 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1961 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1963 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1965 assert_eq!(encoded_value, target_value);
1969 fn encoding_channel_announcement() {
1970 do_encoding_channel_announcement(true, false);
1971 do_encoding_channel_announcement(false, true);
1972 do_encoding_channel_announcement(false, false);
1973 do_encoding_channel_announcement(true, true);
1976 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1977 let secp_ctx = Secp256k1::new();
1978 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1979 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1980 let features = if unknown_features_bits {
1981 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1983 // Set to some features we may support
1984 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1986 let mut addresses = Vec::new();
1988 addresses.push(msgs::NetAddress::IPv4 {
1989 addr: [255, 254, 253, 252],
1994 addresses.push(msgs::NetAddress::IPv6 {
1995 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2000 addresses.push(msgs::NetAddress::OnionV2 {
2001 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
2006 addresses.push(msgs::NetAddress::OnionV3 {
2007 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],
2013 let mut addr_len = 0;
2014 for addr in &addresses {
2015 addr_len += addr.len() + 1;
2017 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2019 timestamp: 20190119,
2024 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() },
2025 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() },
2027 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2028 let node_announcement = msgs::NodeAnnouncement {
2030 contents: unsigned_node_announcement,
2032 let encoded_value = node_announcement.encode();
2033 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2034 if unknown_features_bits {
2035 target_value.append(&mut hex::decode("0002ffff").unwrap());
2037 target_value.append(&mut hex::decode("000122").unwrap());
2039 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2040 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2042 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2045 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2048 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2051 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2053 if excess_address_data {
2054 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2057 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2059 assert_eq!(encoded_value, target_value);
2063 fn encoding_node_announcement() {
2064 do_encoding_node_announcement(true, true, true, true, true, true, true);
2065 do_encoding_node_announcement(false, false, false, false, false, false, false);
2066 do_encoding_node_announcement(false, true, false, false, false, false, false);
2067 do_encoding_node_announcement(false, false, true, false, false, false, false);
2068 do_encoding_node_announcement(false, false, false, true, false, false, false);
2069 do_encoding_node_announcement(false, false, false, false, true, false, false);
2070 do_encoding_node_announcement(false, false, false, false, false, true, false);
2071 do_encoding_node_announcement(false, true, false, true, false, true, false);
2072 do_encoding_node_announcement(false, false, true, false, true, false, false);
2075 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2076 let secp_ctx = Secp256k1::new();
2077 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2078 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2079 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2080 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2081 short_channel_id: 2316138423780173,
2082 timestamp: 20190119,
2083 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2084 cltv_expiry_delta: 144,
2085 htlc_minimum_msat: 1000000,
2086 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2087 fee_base_msat: 10000,
2088 fee_proportional_millionths: 20,
2089 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2091 let channel_update = msgs::ChannelUpdate {
2093 contents: unsigned_channel_update
2095 let encoded_value = channel_update.encode();
2096 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2097 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2098 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2099 if htlc_maximum_msat {
2100 target_value.append(&mut hex::decode("01").unwrap());
2102 target_value.append(&mut hex::decode("00").unwrap());
2104 target_value.append(&mut hex::decode("00").unwrap());
2106 let flag = target_value.last_mut().unwrap();
2110 let flag = target_value.last_mut().unwrap();
2111 *flag = *flag | 1 << 1;
2113 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2114 if htlc_maximum_msat {
2115 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2118 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2120 assert_eq!(encoded_value, target_value);
2124 fn encoding_channel_update() {
2125 do_encoding_channel_update(false, false, false, false);
2126 do_encoding_channel_update(false, false, false, true);
2127 do_encoding_channel_update(true, false, false, false);
2128 do_encoding_channel_update(true, false, false, true);
2129 do_encoding_channel_update(false, true, false, false);
2130 do_encoding_channel_update(false, true, false, true);
2131 do_encoding_channel_update(false, false, true, false);
2132 do_encoding_channel_update(false, false, true, true);
2133 do_encoding_channel_update(true, true, true, false);
2134 do_encoding_channel_update(true, true, true, true);
2137 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2138 let secp_ctx = Secp256k1::new();
2139 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2140 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2141 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2142 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2143 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2144 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2145 let open_channel = msgs::OpenChannel {
2146 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2147 temporary_channel_id: [2; 32],
2148 funding_satoshis: 1311768467284833366,
2149 push_msat: 2536655962884945560,
2150 dust_limit_satoshis: 3608586615801332854,
2151 max_htlc_value_in_flight_msat: 8517154655701053848,
2152 channel_reserve_satoshis: 8665828695742877976,
2153 htlc_minimum_msat: 2316138423780173,
2154 feerate_per_kw: 821716,
2155 to_self_delay: 49340,
2156 max_accepted_htlcs: 49340,
2157 funding_pubkey: pubkey_1,
2158 revocation_basepoint: pubkey_2,
2159 payment_point: pubkey_3,
2160 delayed_payment_basepoint: pubkey_4,
2161 htlc_basepoint: pubkey_5,
2162 first_per_commitment_point: pubkey_6,
2163 channel_flags: if random_bit { 1 << 5 } else { 0 },
2164 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2166 let encoded_value = open_channel.encode();
2167 let mut target_value = Vec::new();
2168 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2169 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2171 target_value.append(&mut hex::decode("20").unwrap());
2173 target_value.append(&mut hex::decode("00").unwrap());
2176 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2178 assert_eq!(encoded_value, target_value);
2182 fn encoding_open_channel() {
2183 do_encoding_open_channel(false, false);
2184 do_encoding_open_channel(true, false);
2185 do_encoding_open_channel(false, true);
2186 do_encoding_open_channel(true, true);
2189 fn do_encoding_accept_channel(shutdown: bool) {
2190 let secp_ctx = Secp256k1::new();
2191 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2192 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2193 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2194 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2195 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2196 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2197 let accept_channel = msgs::AcceptChannel {
2198 temporary_channel_id: [2; 32],
2199 dust_limit_satoshis: 1311768467284833366,
2200 max_htlc_value_in_flight_msat: 2536655962884945560,
2201 channel_reserve_satoshis: 3608586615801332854,
2202 htlc_minimum_msat: 2316138423780173,
2203 minimum_depth: 821716,
2204 to_self_delay: 49340,
2205 max_accepted_htlcs: 49340,
2206 funding_pubkey: pubkey_1,
2207 revocation_basepoint: pubkey_2,
2208 payment_point: pubkey_3,
2209 delayed_payment_basepoint: pubkey_4,
2210 htlc_basepoint: pubkey_5,
2211 first_per_commitment_point: pubkey_6,
2212 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2214 let encoded_value = accept_channel.encode();
2215 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2217 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2219 assert_eq!(encoded_value, target_value);
2223 fn encoding_accept_channel() {
2224 do_encoding_accept_channel(false);
2225 do_encoding_accept_channel(true);
2229 fn encoding_funding_created() {
2230 let secp_ctx = Secp256k1::new();
2231 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2232 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2233 let funding_created = msgs::FundingCreated {
2234 temporary_channel_id: [2; 32],
2235 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2236 funding_output_index: 255,
2239 let encoded_value = funding_created.encode();
2240 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2241 assert_eq!(encoded_value, target_value);
2245 fn encoding_funding_signed() {
2246 let secp_ctx = Secp256k1::new();
2247 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2248 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2249 let funding_signed = msgs::FundingSigned {
2250 channel_id: [2; 32],
2253 let encoded_value = funding_signed.encode();
2254 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2255 assert_eq!(encoded_value, target_value);
2259 fn encoding_funding_locked() {
2260 let secp_ctx = Secp256k1::new();
2261 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2262 let funding_locked = msgs::FundingLocked {
2263 channel_id: [2; 32],
2264 next_per_commitment_point: pubkey_1,
2266 let encoded_value = funding_locked.encode();
2267 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2268 assert_eq!(encoded_value, target_value);
2271 fn do_encoding_shutdown(script_type: u8) {
2272 let secp_ctx = Secp256k1::new();
2273 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2274 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2275 let shutdown = msgs::Shutdown {
2276 channel_id: [2; 32],
2278 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2279 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2280 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2281 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2283 let encoded_value = shutdown.encode();
2284 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2285 if script_type == 1 {
2286 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2287 } else if script_type == 2 {
2288 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2289 } else if script_type == 3 {
2290 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2291 } else if script_type == 4 {
2292 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2294 assert_eq!(encoded_value, target_value);
2298 fn encoding_shutdown() {
2299 do_encoding_shutdown(1);
2300 do_encoding_shutdown(2);
2301 do_encoding_shutdown(3);
2302 do_encoding_shutdown(4);
2306 fn encoding_closing_signed() {
2307 let secp_ctx = Secp256k1::new();
2308 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2309 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2310 let closing_signed = msgs::ClosingSigned {
2311 channel_id: [2; 32],
2312 fee_satoshis: 2316138423780173,
2315 let encoded_value = closing_signed.encode();
2316 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2317 assert_eq!(encoded_value, target_value);
2321 fn encoding_update_add_htlc() {
2322 let secp_ctx = Secp256k1::new();
2323 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2324 let onion_routing_packet = msgs::OnionPacket {
2326 public_key: Ok(pubkey_1),
2327 hop_data: [1; 20*65],
2330 let update_add_htlc = msgs::UpdateAddHTLC {
2331 channel_id: [2; 32],
2332 htlc_id: 2316138423780173,
2333 amount_msat: 3608586615801332854,
2334 payment_hash: PaymentHash([1; 32]),
2335 cltv_expiry: 821716,
2336 onion_routing_packet
2338 let encoded_value = update_add_htlc.encode();
2339 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2340 assert_eq!(encoded_value, target_value);
2344 fn encoding_update_fulfill_htlc() {
2345 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2346 channel_id: [2; 32],
2347 htlc_id: 2316138423780173,
2348 payment_preimage: PaymentPreimage([1; 32]),
2350 let encoded_value = update_fulfill_htlc.encode();
2351 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2352 assert_eq!(encoded_value, target_value);
2356 fn encoding_update_fail_htlc() {
2357 let reason = OnionErrorPacket {
2358 data: [1; 32].to_vec(),
2360 let update_fail_htlc = msgs::UpdateFailHTLC {
2361 channel_id: [2; 32],
2362 htlc_id: 2316138423780173,
2365 let encoded_value = update_fail_htlc.encode();
2366 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2367 assert_eq!(encoded_value, target_value);
2371 fn encoding_update_fail_malformed_htlc() {
2372 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2373 channel_id: [2; 32],
2374 htlc_id: 2316138423780173,
2375 sha256_of_onion: [1; 32],
2378 let encoded_value = update_fail_malformed_htlc.encode();
2379 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2380 assert_eq!(encoded_value, target_value);
2383 fn do_encoding_commitment_signed(htlcs: bool) {
2384 let secp_ctx = Secp256k1::new();
2385 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2386 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2387 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2388 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2389 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2390 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2391 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2392 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2393 let commitment_signed = msgs::CommitmentSigned {
2394 channel_id: [2; 32],
2396 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2398 let encoded_value = commitment_signed.encode();
2399 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2401 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2403 target_value.append(&mut hex::decode("0000").unwrap());
2405 assert_eq!(encoded_value, target_value);
2409 fn encoding_commitment_signed() {
2410 do_encoding_commitment_signed(true);
2411 do_encoding_commitment_signed(false);
2415 fn encoding_revoke_and_ack() {
2416 let secp_ctx = Secp256k1::new();
2417 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2418 let raa = msgs::RevokeAndACK {
2419 channel_id: [2; 32],
2420 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],
2421 next_per_commitment_point: pubkey_1,
2423 let encoded_value = raa.encode();
2424 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2425 assert_eq!(encoded_value, target_value);
2429 fn encoding_update_fee() {
2430 let update_fee = msgs::UpdateFee {
2431 channel_id: [2; 32],
2432 feerate_per_kw: 20190119,
2434 let encoded_value = update_fee.encode();
2435 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2436 assert_eq!(encoded_value, target_value);
2440 fn encoding_init() {
2441 assert_eq!(msgs::Init {
2442 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2443 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2444 assert_eq!(msgs::Init {
2445 features: InitFeatures::from_le_bytes(vec![0xFF]),
2446 }.encode(), hex::decode("0001ff0001ff").unwrap());
2447 assert_eq!(msgs::Init {
2448 features: InitFeatures::from_le_bytes(vec![]),
2449 }.encode(), hex::decode("00000000").unwrap());
2453 fn encoding_error() {
2454 let error = msgs::ErrorMessage {
2455 channel_id: [2; 32],
2456 data: String::from("rust-lightning"),
2458 let encoded_value = error.encode();
2459 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2460 assert_eq!(encoded_value, target_value);
2464 fn encoding_ping() {
2465 let ping = msgs::Ping {
2469 let encoded_value = ping.encode();
2470 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2471 assert_eq!(encoded_value, target_value);
2475 fn encoding_pong() {
2476 let pong = msgs::Pong {
2479 let encoded_value = pong.encode();
2480 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2481 assert_eq!(encoded_value, target_value);
2485 fn encoding_legacy_onion_hop_data() {
2486 let msg = msgs::OnionHopData {
2487 format: OnionHopDataFormat::Legacy {
2488 short_channel_id: 0xdeadbeef1bad1dea,
2490 amt_to_forward: 0x0badf00d01020304,
2491 outgoing_cltv_value: 0xffffffff,
2493 let encoded_value = msg.encode();
2494 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2495 assert_eq!(encoded_value, target_value);
2499 fn encoding_nonfinal_onion_hop_data() {
2500 let mut msg = msgs::OnionHopData {
2501 format: OnionHopDataFormat::NonFinalNode {
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("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2509 assert_eq!(encoded_value, target_value);
2510 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2511 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2512 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2513 } else { panic!(); }
2514 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2515 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2519 fn encoding_final_onion_hop_data() {
2520 let mut msg = msgs::OnionHopData {
2521 format: OnionHopDataFormat::FinalNode {
2524 amt_to_forward: 0x0badf00d01020304,
2525 outgoing_cltv_value: 0xffffffff,
2527 let encoded_value = msg.encode();
2528 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2529 assert_eq!(encoded_value, target_value);
2530 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2531 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2532 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2533 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2537 fn encoding_final_onion_hop_data_with_secret() {
2538 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2539 let mut msg = msgs::OnionHopData {
2540 format: OnionHopDataFormat::FinalNode {
2541 payment_data: Some(FinalOnionHopData {
2542 payment_secret: expected_payment_secret,
2543 total_msat: 0x1badca1f
2546 amt_to_forward: 0x0badf00d01020304,
2547 outgoing_cltv_value: 0xffffffff,
2549 let encoded_value = msg.encode();
2550 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2551 assert_eq!(encoded_value, target_value);
2552 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2553 if let OnionHopDataFormat::FinalNode {
2554 payment_data: Some(FinalOnionHopData {
2556 total_msat: 0x1badca1f
2559 assert_eq!(payment_secret, expected_payment_secret);
2560 } else { panic!(); }
2561 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2562 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2566 fn query_channel_range_end_blocknum() {
2567 let tests: Vec<(u32, u32, u32)> = vec![
2568 (10000, 1500, 11500),
2569 (0, 0xffffffff, 0xffffffff),
2570 (1, 0xffffffff, 0xffffffff),
2573 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2574 let sut = msgs::QueryChannelRange {
2575 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2579 assert_eq!(sut.end_blocknum(), expected);
2584 fn encoding_query_channel_range() {
2585 let mut query_channel_range = msgs::QueryChannelRange {
2586 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2587 first_blocknum: 100000,
2588 number_of_blocks: 1500,
2590 let encoded_value = query_channel_range.encode();
2591 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2592 assert_eq!(encoded_value, target_value);
2594 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2595 assert_eq!(query_channel_range.first_blocknum, 100000);
2596 assert_eq!(query_channel_range.number_of_blocks, 1500);
2600 fn encoding_reply_channel_range() {
2601 do_encoding_reply_channel_range(0);
2602 do_encoding_reply_channel_range(1);
2605 fn do_encoding_reply_channel_range(encoding_type: u8) {
2606 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2607 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2608 let mut reply_channel_range = msgs::ReplyChannelRange {
2609 chain_hash: expected_chain_hash,
2610 first_blocknum: 756230,
2611 number_of_blocks: 1500,
2612 sync_complete: true,
2613 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2616 if encoding_type == 0 {
2617 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2618 let encoded_value = reply_channel_range.encode();
2619 assert_eq!(encoded_value, target_value);
2621 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2622 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2623 assert_eq!(reply_channel_range.first_blocknum, 756230);
2624 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2625 assert_eq!(reply_channel_range.sync_complete, true);
2626 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2627 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2628 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2630 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2631 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2632 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2637 fn encoding_query_short_channel_ids() {
2638 do_encoding_query_short_channel_ids(0);
2639 do_encoding_query_short_channel_ids(1);
2642 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2643 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2644 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2645 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2646 chain_hash: expected_chain_hash,
2647 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2650 if encoding_type == 0 {
2651 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2652 let encoded_value = query_short_channel_ids.encode();
2653 assert_eq!(encoded_value, target_value);
2655 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2656 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2657 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2658 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2659 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2661 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2662 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2663 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2668 fn encoding_reply_short_channel_ids_end() {
2669 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2670 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2671 chain_hash: expected_chain_hash,
2672 full_information: true,
2674 let encoded_value = reply_short_channel_ids_end.encode();
2675 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2676 assert_eq!(encoded_value, target_value);
2678 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2679 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2680 assert_eq!(reply_short_channel_ids_end.full_information, true);
2684 fn encoding_gossip_timestamp_filter(){
2685 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2686 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2687 chain_hash: expected_chain_hash,
2688 first_timestamp: 1590000000,
2689 timestamp_range: 0xffff_ffff,
2691 let encoded_value = gossip_timestamp_filter.encode();
2692 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2693 assert_eq!(encoded_value, target_value);
2695 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2696 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2697 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2698 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);