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::PublicKey;
28 use bitcoin::secp256k1::ecdsa::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
39 use io_extras::read_to_end;
41 use util::events::MessageSendEventsProvider;
43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt, Hostname};
45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
47 /// 21 million * 10^8 * 1000
48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
50 /// An error in decoding a message or struct.
51 #[derive(Clone, Debug, PartialEq)]
52 pub enum DecodeError {
53 /// A version byte specified something we don't know how to handle.
54 /// Includes unknown realm byte in an OnionHopData packet
56 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
57 UnknownRequiredFeature,
58 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
59 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
60 /// syntactically incorrect, etc
64 /// A length descriptor in the packet didn't describe the later data correctly
66 /// Error from std::io
67 Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
69 /// The message included zlib-compressed values, which we don't support.
70 UnsupportedCompression,
73 /// An init message to be sent or received from a peer
74 #[derive(Clone, Debug, PartialEq)]
76 /// The relevant features which the sender supports
77 pub features: InitFeatures,
78 /// The receipient's network address. This adds the option to report a remote IP address
79 /// back to a connecting peer using the init message. A node can decide to use that information
80 /// to discover a potential update to its public IPv4 address (NAT) and use
81 /// that for a node_announcement update message containing the new address.
82 pub remote_network_address: Option<NetAddress>,
85 /// An error message to be sent or received from a peer
86 #[derive(Clone, Debug, PartialEq)]
87 pub struct ErrorMessage {
88 /// The channel ID involved in the error.
90 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
91 /// with the sending peer should be closed.
92 pub channel_id: [u8; 32],
93 /// A possibly human-readable error description.
94 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
95 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
96 /// the terminal emulator or the logging subsystem.
100 /// A warning message to be sent or received from a peer
101 #[derive(Clone, Debug, PartialEq)]
102 pub struct WarningMessage {
103 /// The channel ID involved in the warning.
105 /// All-0s indicates a warning unrelated to a specific channel.
106 pub channel_id: [u8; 32],
107 /// A possibly human-readable warning description.
108 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
109 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
110 /// the terminal emulator or the logging subsystem.
114 /// A ping message to be sent or received from a peer
115 #[derive(Clone, Debug, PartialEq)]
117 /// The desired response length
119 /// The ping packet size.
120 /// This field is not sent on the wire. byteslen zeros are sent.
124 /// A pong message to be sent or received from a peer
125 #[derive(Clone, Debug, PartialEq)]
127 /// The pong packet size.
128 /// This field is not sent on the wire. byteslen zeros are sent.
132 /// An open_channel message to be sent or received from a peer
133 #[derive(Clone, Debug, PartialEq)]
134 pub struct OpenChannel {
135 /// The genesis hash of the blockchain where the channel is to be opened
136 pub chain_hash: BlockHash,
137 /// A temporary channel ID, until the funding outpoint is announced
138 pub temporary_channel_id: [u8; 32],
139 /// The channel value
140 pub funding_satoshis: u64,
141 /// The amount to push to the counterparty as part of the open, in milli-satoshi
143 /// The threshold below which outputs on transactions broadcast by sender will be omitted
144 pub dust_limit_satoshis: u64,
145 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
146 pub max_htlc_value_in_flight_msat: u64,
147 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
148 pub channel_reserve_satoshis: u64,
149 /// The minimum HTLC size incoming to sender, in milli-satoshi
150 pub htlc_minimum_msat: u64,
151 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
152 pub feerate_per_kw: u32,
153 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
154 pub to_self_delay: u16,
155 /// The maximum number of inbound HTLCs towards sender
156 pub max_accepted_htlcs: u16,
157 /// The sender's key controlling the funding transaction
158 pub funding_pubkey: PublicKey,
159 /// Used to derive a revocation key for transactions broadcast by counterparty
160 pub revocation_basepoint: PublicKey,
161 /// A payment key to sender for transactions broadcast by counterparty
162 pub payment_point: PublicKey,
163 /// Used to derive a payment key to sender for transactions broadcast by sender
164 pub delayed_payment_basepoint: PublicKey,
165 /// Used to derive an HTLC payment key to sender
166 pub htlc_basepoint: PublicKey,
167 /// The first to-be-broadcast-by-sender transaction's per commitment point
168 pub first_per_commitment_point: PublicKey,
170 pub channel_flags: u8,
171 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
172 pub shutdown_scriptpubkey: OptionalField<Script>,
173 /// The channel type that this channel will represent. If none is set, we derive the channel
174 /// type from the intersection of our feature bits with our counterparty's feature bits from
175 /// the Init message.
176 pub channel_type: Option<ChannelTypeFeatures>,
179 /// An accept_channel message to be sent or received from a peer
180 #[derive(Clone, Debug, PartialEq)]
181 pub struct AcceptChannel {
182 /// A temporary channel ID, until the funding outpoint is announced
183 pub temporary_channel_id: [u8; 32],
184 /// The threshold below which outputs on transactions broadcast by sender will be omitted
185 pub dust_limit_satoshis: u64,
186 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
187 pub max_htlc_value_in_flight_msat: u64,
188 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
189 pub channel_reserve_satoshis: u64,
190 /// The minimum HTLC size incoming to sender, in milli-satoshi
191 pub htlc_minimum_msat: u64,
192 /// Minimum depth of the funding transaction before the channel is considered open
193 pub minimum_depth: u32,
194 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
195 pub to_self_delay: u16,
196 /// The maximum number of inbound HTLCs towards sender
197 pub max_accepted_htlcs: u16,
198 /// The sender's key controlling the funding transaction
199 pub funding_pubkey: PublicKey,
200 /// Used to derive a revocation key for transactions broadcast by counterparty
201 pub revocation_basepoint: PublicKey,
202 /// A payment key to sender for transactions broadcast by counterparty
203 pub payment_point: PublicKey,
204 /// Used to derive a payment key to sender for transactions broadcast by sender
205 pub delayed_payment_basepoint: PublicKey,
206 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
207 pub htlc_basepoint: PublicKey,
208 /// The first to-be-broadcast-by-sender transaction's per commitment point
209 pub first_per_commitment_point: PublicKey,
210 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
211 pub shutdown_scriptpubkey: OptionalField<Script>,
212 /// The channel type that this channel will represent. If none is set, we derive the channel
213 /// type from the intersection of our feature bits with our counterparty's feature bits from
214 /// the Init message.
216 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
217 pub channel_type: Option<ChannelTypeFeatures>,
220 /// A funding_created message to be sent or received from a peer
221 #[derive(Clone, Debug, PartialEq)]
222 pub struct FundingCreated {
223 /// A temporary channel ID, until the funding is established
224 pub temporary_channel_id: [u8; 32],
225 /// The funding transaction ID
226 pub funding_txid: Txid,
227 /// The specific output index funding this channel
228 pub funding_output_index: u16,
229 /// The signature of the channel initiator (funder) on the initial commitment transaction
230 pub signature: Signature,
233 /// A funding_signed message to be sent or received from a peer
234 #[derive(Clone, Debug, PartialEq)]
235 pub struct FundingSigned {
237 pub channel_id: [u8; 32],
238 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
239 pub signature: Signature,
242 /// A channel_ready message to be sent or received from a peer
243 #[derive(Clone, Debug, PartialEq)]
244 pub struct ChannelReady {
246 pub channel_id: [u8; 32],
247 /// The per-commitment point of the second commitment transaction
248 pub next_per_commitment_point: PublicKey,
249 /// If set, provides a short_channel_id alias for this channel. The sender will accept payments
250 /// to be forwarded over this SCID and forward them to this messages' recipient.
251 pub short_channel_id_alias: Option<u64>,
254 /// A shutdown message to be sent or received from a peer
255 #[derive(Clone, Debug, PartialEq)]
256 pub struct Shutdown {
258 pub channel_id: [u8; 32],
259 /// The destination of this peer's funds on closing.
260 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
261 pub scriptpubkey: Script,
264 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
265 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
267 #[derive(Clone, Debug, PartialEq)]
268 pub struct ClosingSignedFeeRange {
269 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
271 pub min_fee_satoshis: u64,
272 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
274 pub max_fee_satoshis: u64,
277 /// A closing_signed message to be sent or received from a peer
278 #[derive(Clone, Debug, PartialEq)]
279 pub struct ClosingSigned {
281 pub channel_id: [u8; 32],
282 /// The proposed total fee for the closing transaction
283 pub fee_satoshis: u64,
284 /// A signature on the closing transaction
285 pub signature: Signature,
286 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
288 pub fee_range: Option<ClosingSignedFeeRange>,
291 /// An update_add_htlc message to be sent or received from a peer
292 #[derive(Clone, Debug, PartialEq)]
293 pub struct UpdateAddHTLC {
295 pub channel_id: [u8; 32],
298 /// The HTLC value in milli-satoshi
299 pub amount_msat: u64,
300 /// The payment hash, the pre-image of which controls HTLC redemption
301 pub payment_hash: PaymentHash,
302 /// The expiry height of the HTLC
303 pub cltv_expiry: u32,
304 pub(crate) onion_routing_packet: OnionPacket,
307 /// An update_fulfill_htlc message to be sent or received from a peer
308 #[derive(Clone, Debug, PartialEq)]
309 pub struct UpdateFulfillHTLC {
311 pub channel_id: [u8; 32],
314 /// The pre-image of the payment hash, allowing HTLC redemption
315 pub payment_preimage: PaymentPreimage,
318 /// An update_fail_htlc message to be sent or received from a peer
319 #[derive(Clone, Debug, PartialEq)]
320 pub struct UpdateFailHTLC {
322 pub channel_id: [u8; 32],
325 pub(crate) reason: OnionErrorPacket,
328 /// An update_fail_malformed_htlc message to be sent or received from a peer
329 #[derive(Clone, Debug, PartialEq)]
330 pub struct UpdateFailMalformedHTLC {
332 pub channel_id: [u8; 32],
335 pub(crate) sha256_of_onion: [u8; 32],
337 pub failure_code: u16,
340 /// A commitment_signed message to be sent or received from a peer
341 #[derive(Clone, Debug, PartialEq)]
342 pub struct CommitmentSigned {
344 pub channel_id: [u8; 32],
345 /// A signature on the commitment transaction
346 pub signature: Signature,
347 /// Signatures on the HTLC transactions
348 pub htlc_signatures: Vec<Signature>,
351 /// A revoke_and_ack message to be sent or received from a peer
352 #[derive(Clone, Debug, PartialEq)]
353 pub struct RevokeAndACK {
355 pub channel_id: [u8; 32],
356 /// The secret corresponding to the per-commitment point
357 pub per_commitment_secret: [u8; 32],
358 /// The next sender-broadcast commitment transaction's per-commitment point
359 pub next_per_commitment_point: PublicKey,
362 /// An update_fee message to be sent or received from a peer
363 #[derive(Clone, Debug, PartialEq)]
364 pub struct UpdateFee {
366 pub channel_id: [u8; 32],
367 /// Fee rate per 1000-weight of the transaction
368 pub feerate_per_kw: u32,
371 #[derive(Clone, Debug, PartialEq)]
372 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
373 /// This is used to convince the recipient that the channel is at a certain commitment
374 /// number even if they lost that data due to a local failure. Of course, the peer may lie
375 /// and even later commitments may have been revoked.
376 pub struct DataLossProtect {
377 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
378 /// belonging to the recipient
379 pub your_last_per_commitment_secret: [u8; 32],
380 /// The sender's per-commitment point for their current commitment transaction
381 pub my_current_per_commitment_point: PublicKey,
384 /// A channel_reestablish message to be sent or received from a peer
385 #[derive(Clone, Debug, PartialEq)]
386 pub struct ChannelReestablish {
388 pub channel_id: [u8; 32],
389 /// The next commitment number for the sender
390 pub next_local_commitment_number: u64,
391 /// The next commitment number for the recipient
392 pub next_remote_commitment_number: u64,
393 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
394 pub data_loss_protect: OptionalField<DataLossProtect>,
397 /// An announcement_signatures message to be sent or received from a peer
398 #[derive(Clone, Debug, PartialEq)]
399 pub struct AnnouncementSignatures {
401 pub channel_id: [u8; 32],
402 /// The short channel ID
403 pub short_channel_id: u64,
404 /// A signature by the node key
405 pub node_signature: Signature,
406 /// A signature by the funding key
407 pub bitcoin_signature: Signature,
410 /// An address which can be used to connect to a remote peer
411 #[derive(Clone, Debug, PartialEq)]
412 pub enum NetAddress {
413 /// An IPv4 address/port on which the peer is listening.
415 /// The 4-byte IPv4 address
417 /// The port on which the node is listening
420 /// An IPv6 address/port on which the peer is listening.
422 /// The 16-byte IPv6 address
424 /// The port on which the node is listening
427 /// An old-style Tor onion address/port on which the peer is listening.
429 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
430 /// addresses. Thus, the details are not parsed here.
432 /// A new-style Tor onion address/port on which the peer is listening.
433 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
434 /// wrap as base32 and append ".onion".
436 /// The ed25519 long-term public key of the peer
437 ed25519_pubkey: [u8; 32],
438 /// The checksum of the pubkey and version, as included in the onion address
440 /// The version byte, as defined by the Tor Onion v3 spec.
442 /// The port on which the node is listening
445 /// A hostname/port on which the peer is listening.
447 /// The hostname on which the node is listening.
449 /// The port on which the node is listening.
454 /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
456 pub(crate) fn get_id(&self) -> u8 {
458 &NetAddress::IPv4 {..} => { 1 },
459 &NetAddress::IPv6 {..} => { 2 },
460 &NetAddress::OnionV2(_) => { 3 },
461 &NetAddress::OnionV3 {..} => { 4 },
462 &NetAddress::Hostname {..} => { 5 },
466 /// Strict byte-length of address descriptor, 1-byte type not recorded
467 fn len(&self) -> u16 {
469 &NetAddress::IPv4 { .. } => { 6 },
470 &NetAddress::IPv6 { .. } => { 18 },
471 &NetAddress::OnionV2(_) => { 12 },
472 &NetAddress::OnionV3 { .. } => { 37 },
473 // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
474 &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
478 /// The maximum length of any address descriptor, not including the 1-byte type.
479 /// This maximum length is reached by a hostname address descriptor:
480 /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
481 pub(crate) const MAX_LEN: u16 = 258;
484 impl Writeable for NetAddress {
485 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
487 &NetAddress::IPv4 { ref addr, ref port } => {
492 &NetAddress::IPv6 { ref addr, ref port } => {
497 &NetAddress::OnionV2(bytes) => {
499 bytes.write(writer)?;
501 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
503 ed25519_pubkey.write(writer)?;
504 checksum.write(writer)?;
505 version.write(writer)?;
508 &NetAddress::Hostname { ref hostname, ref port } => {
510 hostname.write(writer)?;
518 impl Readable for Result<NetAddress, u8> {
519 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
520 let byte = <u8 as Readable>::read(reader)?;
523 Ok(Ok(NetAddress::IPv4 {
524 addr: Readable::read(reader)?,
525 port: Readable::read(reader)?,
529 Ok(Ok(NetAddress::IPv6 {
530 addr: Readable::read(reader)?,
531 port: Readable::read(reader)?,
534 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
536 Ok(Ok(NetAddress::OnionV3 {
537 ed25519_pubkey: Readable::read(reader)?,
538 checksum: Readable::read(reader)?,
539 version: Readable::read(reader)?,
540 port: Readable::read(reader)?,
544 Ok(Ok(NetAddress::Hostname {
545 hostname: Readable::read(reader)?,
546 port: Readable::read(reader)?,
549 _ => return Ok(Err(byte)),
554 impl Readable for NetAddress {
555 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
556 match Readable::read(reader) {
557 Ok(Ok(res)) => Ok(res),
558 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
565 /// The unsigned part of a node_announcement
566 #[derive(Clone, Debug, PartialEq)]
567 pub struct UnsignedNodeAnnouncement {
568 /// The advertised features
569 pub features: NodeFeatures,
570 /// A strictly monotonic announcement counter, with gaps allowed
572 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
574 pub node_id: PublicKey,
575 /// An RGB color for UI purposes
577 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
580 /// List of addresses on which this node is reachable
581 pub addresses: Vec<NetAddress>,
582 pub(crate) excess_address_data: Vec<u8>,
583 pub(crate) excess_data: Vec<u8>,
585 #[derive(Clone, Debug, PartialEq)]
586 /// A node_announcement message to be sent or received from a peer
587 pub struct NodeAnnouncement {
588 /// The signature by the node key
589 pub signature: Signature,
590 /// The actual content of the announcement
591 pub contents: UnsignedNodeAnnouncement,
594 /// The unsigned part of a channel_announcement
595 #[derive(Clone, Debug, PartialEq)]
596 pub struct UnsignedChannelAnnouncement {
597 /// The advertised channel features
598 pub features: ChannelFeatures,
599 /// The genesis hash of the blockchain where the channel is to be opened
600 pub chain_hash: BlockHash,
601 /// The short channel ID
602 pub short_channel_id: u64,
603 /// One of the two node_ids which are endpoints of this channel
604 pub node_id_1: PublicKey,
605 /// The other of the two node_ids which are endpoints of this channel
606 pub node_id_2: PublicKey,
607 /// The funding key for the first node
608 pub bitcoin_key_1: PublicKey,
609 /// The funding key for the second node
610 pub bitcoin_key_2: PublicKey,
611 pub(crate) excess_data: Vec<u8>,
613 /// A channel_announcement message to be sent or received from a peer
614 #[derive(Clone, Debug, PartialEq)]
615 pub struct ChannelAnnouncement {
616 /// Authentication of the announcement by the first public node
617 pub node_signature_1: Signature,
618 /// Authentication of the announcement by the second public node
619 pub node_signature_2: Signature,
620 /// Proof of funding UTXO ownership by the first public node
621 pub bitcoin_signature_1: Signature,
622 /// Proof of funding UTXO ownership by the second public node
623 pub bitcoin_signature_2: Signature,
624 /// The actual announcement
625 pub contents: UnsignedChannelAnnouncement,
628 /// The unsigned part of a channel_update
629 #[derive(Clone, Debug, PartialEq)]
630 pub struct UnsignedChannelUpdate {
631 /// The genesis hash of the blockchain where the channel is to be opened
632 pub chain_hash: BlockHash,
633 /// The short channel ID
634 pub short_channel_id: u64,
635 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
639 /// The number of blocks such that if:
640 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
641 /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
642 /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
643 /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
644 /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
645 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
646 /// constructing the route.
647 pub cltv_expiry_delta: u16,
648 /// The minimum HTLC size incoming to sender, in milli-satoshi
649 pub htlc_minimum_msat: u64,
650 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
651 pub htlc_maximum_msat: OptionalField<u64>,
652 /// The base HTLC fee charged by sender, in milli-satoshi
653 pub fee_base_msat: u32,
654 /// The amount to fee multiplier, in micro-satoshi
655 pub fee_proportional_millionths: u32,
656 /// Excess data which was signed as a part of the message which we do not (yet) understand how
657 /// to decode. This is stored to ensure forward-compatibility as new fields are added to the
659 pub excess_data: Vec<u8>,
661 /// A channel_update message to be sent or received from a peer
662 #[derive(Clone, Debug, PartialEq)]
663 pub struct ChannelUpdate {
664 /// A signature of the channel update
665 pub signature: Signature,
666 /// The actual channel update
667 pub contents: UnsignedChannelUpdate,
670 /// A query_channel_range message is used to query a peer for channel
671 /// UTXOs in a range of blocks. The recipient of a query makes a best
672 /// effort to reply to the query using one or more reply_channel_range
674 #[derive(Clone, Debug, PartialEq)]
675 pub struct QueryChannelRange {
676 /// The genesis hash of the blockchain being queried
677 pub chain_hash: BlockHash,
678 /// The height of the first block for the channel UTXOs being queried
679 pub first_blocknum: u32,
680 /// The number of blocks to include in the query results
681 pub number_of_blocks: u32,
684 /// A reply_channel_range message is a reply to a query_channel_range
685 /// message. Multiple reply_channel_range messages can be sent in reply
686 /// to a single query_channel_range message. The query recipient makes a
687 /// best effort to respond based on their local network view which may
688 /// not be a perfect view of the network. The short_channel_ids in the
689 /// reply are encoded. We only support encoding_type=0 uncompressed
690 /// serialization and do not support encoding_type=1 zlib serialization.
691 #[derive(Clone, Debug, PartialEq)]
692 pub struct ReplyChannelRange {
693 /// The genesis hash of the blockchain being queried
694 pub chain_hash: BlockHash,
695 /// The height of the first block in the range of the reply
696 pub first_blocknum: u32,
697 /// The number of blocks included in the range of the reply
698 pub number_of_blocks: u32,
699 /// True when this is the final reply for a query
700 pub sync_complete: bool,
701 /// The short_channel_ids in the channel range
702 pub short_channel_ids: Vec<u64>,
705 /// A query_short_channel_ids message is used to query a peer for
706 /// routing gossip messages related to one or more short_channel_ids.
707 /// The query recipient will reply with the latest, if available,
708 /// channel_announcement, channel_update and node_announcement messages
709 /// it maintains for the requested short_channel_ids followed by a
710 /// reply_short_channel_ids_end message. The short_channel_ids sent in
711 /// this query are encoded. We only support encoding_type=0 uncompressed
712 /// serialization and do not support encoding_type=1 zlib serialization.
713 #[derive(Clone, Debug, PartialEq)]
714 pub struct QueryShortChannelIds {
715 /// The genesis hash of the blockchain being queried
716 pub chain_hash: BlockHash,
717 /// The short_channel_ids that are being queried
718 pub short_channel_ids: Vec<u64>,
721 /// A reply_short_channel_ids_end message is sent as a reply to a
722 /// query_short_channel_ids message. The query recipient makes a best
723 /// effort to respond based on their local network view which may not be
724 /// a perfect view of the network.
725 #[derive(Clone, Debug, PartialEq)]
726 pub struct ReplyShortChannelIdsEnd {
727 /// The genesis hash of the blockchain that was queried
728 pub chain_hash: BlockHash,
729 /// Indicates if the query recipient maintains up-to-date channel
730 /// information for the chain_hash
731 pub full_information: bool,
734 /// A gossip_timestamp_filter message is used by a node to request
735 /// gossip relay for messages in the requested time range when the
736 /// gossip_queries feature has been negotiated.
737 #[derive(Clone, Debug, PartialEq)]
738 pub struct GossipTimestampFilter {
739 /// The genesis hash of the blockchain for channel and node information
740 pub chain_hash: BlockHash,
741 /// The starting unix timestamp
742 pub first_timestamp: u32,
743 /// The range of information in seconds
744 pub timestamp_range: u32,
747 /// Encoding type for data compression of collections in gossip queries.
748 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
753 /// Used to put an error message in a LightningError
754 #[derive(Clone, Debug)]
755 pub enum ErrorAction {
756 /// The peer took some action which made us think they were useless. Disconnect them.
758 /// An error message which we should make an effort to send before we disconnect.
759 msg: Option<ErrorMessage>
761 /// The peer did something harmless that we weren't able to process, just log and ignore
762 // New code should *not* use this. New code must use IgnoreAndLog, below!
764 /// The peer did something harmless that we weren't able to meaningfully process.
765 /// If the error is logged, log it at the given level.
766 IgnoreAndLog(logger::Level),
767 /// The peer provided us with a gossip message which we'd already seen. In most cases this
768 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
769 /// our own channel announcements.
770 IgnoreDuplicateGossip,
771 /// The peer did something incorrect. Tell them.
773 /// The message to send.
776 /// The peer did something incorrect. Tell them without closing any channels.
778 /// The message to send.
780 /// The peer may have done something harmless that we weren't able to meaningfully process,
781 /// though we should still tell them about it.
782 /// If this event is logged, log it at the given level.
783 log_level: logger::Level,
787 /// An Err type for failure to process messages.
788 #[derive(Clone, Debug)]
789 pub struct LightningError {
790 /// A human-readable message describing the error
792 /// The action which should be taken against the offending peer.
793 pub action: ErrorAction,
796 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
797 /// transaction updates if they were pending.
798 #[derive(Clone, Debug, PartialEq)]
799 pub struct CommitmentUpdate {
800 /// update_add_htlc messages which should be sent
801 pub update_add_htlcs: Vec<UpdateAddHTLC>,
802 /// update_fulfill_htlc messages which should be sent
803 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
804 /// update_fail_htlc messages which should be sent
805 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
806 /// update_fail_malformed_htlc messages which should be sent
807 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
808 /// An update_fee message which should be sent
809 pub update_fee: Option<UpdateFee>,
810 /// Finally, the commitment_signed message which should be sent
811 pub commitment_signed: CommitmentSigned,
814 /// Messages could have optional fields to use with extended features
815 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
816 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
817 /// separate enum type for them.
818 /// (C-not exported) due to a free generic in T
819 #[derive(Clone, Debug, PartialEq)]
820 pub enum OptionalField<T> {
821 /// Optional field is included in message
823 /// Optional field is absent in message
827 /// A trait to describe an object which can receive channel messages.
829 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
830 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
831 pub trait ChannelMessageHandler : MessageSendEventsProvider {
833 /// Handle an incoming open_channel message from the given peer.
834 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
835 /// Handle an incoming accept_channel message from the given peer.
836 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
837 /// Handle an incoming funding_created message from the given peer.
838 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
839 /// Handle an incoming funding_signed message from the given peer.
840 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
841 /// Handle an incoming channel_ready message from the given peer.
842 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
845 /// Handle an incoming shutdown message from the given peer.
846 fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
847 /// Handle an incoming closing_signed message from the given peer.
848 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
851 /// Handle an incoming update_add_htlc message from the given peer.
852 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
853 /// Handle an incoming update_fulfill_htlc message from the given peer.
854 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
855 /// Handle an incoming update_fail_htlc message from the given peer.
856 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
857 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
858 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
859 /// Handle an incoming commitment_signed message from the given peer.
860 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
861 /// Handle an incoming revoke_and_ack message from the given peer.
862 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
864 /// Handle an incoming update_fee message from the given peer.
865 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
867 // Channel-to-announce:
868 /// Handle an incoming announcement_signatures message from the given peer.
869 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
871 // Connection loss/reestablish:
872 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
873 /// is believed to be possible in the future (eg they're sending us messages we don't
874 /// understand or indicate they require unknown feature bits), no_connection_possible is set
875 /// and any outstanding channels should be failed.
876 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
878 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
879 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
880 /// Handle an incoming channel_reestablish message from the given peer.
881 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
883 /// Handle an incoming channel update from the given peer.
884 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
887 /// Handle an incoming error message from the given peer.
888 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
891 /// A trait to describe an object which can receive routing messages.
893 /// # Implementor DoS Warnings
895 /// For `gossip_queries` messages there are potential DoS vectors when handling
896 /// inbound queries. Implementors using an on-disk network graph should be aware of
897 /// repeated disk I/O for queries accessing different parts of the network graph.
898 pub trait RoutingMessageHandler : MessageSendEventsProvider {
899 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
900 /// false or returning an Err otherwise.
901 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
902 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
903 /// or returning an Err otherwise.
904 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
905 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
906 /// false or returning an Err otherwise.
907 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
908 /// Gets a subset of the channel announcements and updates required to dump our routing table
909 /// to a remote node, starting at the short_channel_id indicated by starting_point and
910 /// including the batch_amount entries immediately higher in numerical value than starting_point.
911 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
912 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
913 /// starting at the node *after* the provided publickey and including batch_amount entries
914 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
915 /// If None is provided for starting_point, we start at the first node.
916 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
917 /// Called when a connection is established with a peer. This can be used to
918 /// perform routing table synchronization using a strategy defined by the
920 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
921 /// Handles the reply of a query we initiated to learn about channels
922 /// for a given range of blocks. We can expect to receive one or more
923 /// replies to a single query.
924 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
925 /// Handles the reply of a query we initiated asking for routing gossip
926 /// messages for a list of channels. We should receive this message when
927 /// a node has completed its best effort to send us the pertaining routing
929 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
930 /// Handles when a peer asks us to send a list of short_channel_ids
931 /// for the requested range of blocks.
932 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
933 /// Handles when a peer asks us to send routing gossip messages for a
934 /// list of short_channel_ids.
935 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
938 mod fuzzy_internal_msgs {
940 use ln::{PaymentPreimage, PaymentSecret};
942 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
943 // them from untrusted input):
945 pub(crate) struct FinalOnionHopData {
946 pub(crate) payment_secret: PaymentSecret,
947 /// The total value, in msat, of the payment as received by the ultimate recipient.
948 /// Message serialization may panic if this value is more than 21 million Bitcoin.
949 pub(crate) total_msat: u64,
952 pub(crate) enum OnionHopDataFormat {
953 Legacy { // aka Realm-0
954 short_channel_id: u64,
957 short_channel_id: u64,
960 payment_data: Option<FinalOnionHopData>,
961 keysend_preimage: Option<PaymentPreimage>,
965 pub struct OnionHopData {
966 pub(crate) format: OnionHopDataFormat,
967 /// The value, in msat, of the payment after this hop's fee is deducted.
968 /// Message serialization may panic if this value is more than 21 million Bitcoin.
969 pub(crate) amt_to_forward: u64,
970 pub(crate) outgoing_cltv_value: u32,
971 // 12 bytes of 0-padding for Legacy format
974 pub struct DecodedOnionErrorPacket {
975 pub(crate) hmac: [u8; 32],
976 pub(crate) failuremsg: Vec<u8>,
977 pub(crate) pad: Vec<u8>,
981 pub use self::fuzzy_internal_msgs::*;
983 pub(crate) use self::fuzzy_internal_msgs::*;
986 pub(crate) struct OnionPacket {
987 pub(crate) version: u8,
988 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
989 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
990 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
991 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
992 pub(crate) hop_data: [u8; 20*65],
993 pub(crate) hmac: [u8; 32],
996 impl PartialEq for OnionPacket {
997 fn eq(&self, other: &OnionPacket) -> bool {
998 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
999 if i != j { return false; }
1001 self.version == other.version &&
1002 self.public_key == other.public_key &&
1003 self.hmac == other.hmac
1007 impl fmt::Debug for OnionPacket {
1008 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1009 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1013 #[derive(Clone, Debug, PartialEq)]
1014 pub(crate) struct OnionErrorPacket {
1015 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1016 // (TODO) We limit it in decode to much lower...
1017 pub(crate) data: Vec<u8>,
1020 impl fmt::Display for DecodeError {
1021 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1023 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1024 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1025 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1026 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1027 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1028 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1029 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1034 impl From<io::Error> for DecodeError {
1035 fn from(e: io::Error) -> Self {
1036 if e.kind() == io::ErrorKind::UnexpectedEof {
1037 DecodeError::ShortRead
1039 DecodeError::Io(e.kind())
1044 impl Writeable for OptionalField<Script> {
1045 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1047 OptionalField::Present(ref script) => {
1048 // Note that Writeable for script includes the 16-bit length tag for us
1051 OptionalField::Absent => {}
1057 impl Readable for OptionalField<Script> {
1058 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1059 match <u16 as Readable>::read(r) {
1061 let mut buf = vec![0; len as usize];
1062 r.read_exact(&mut buf)?;
1063 Ok(OptionalField::Present(Script::from(buf)))
1065 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1071 impl Writeable for OptionalField<u64> {
1072 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1074 OptionalField::Present(ref value) => {
1077 OptionalField::Absent => {}
1083 impl Readable for OptionalField<u64> {
1084 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1085 let value: u64 = Readable::read(r)?;
1086 Ok(OptionalField::Present(value))
1091 impl_writeable_msg!(AcceptChannel, {
1092 temporary_channel_id,
1093 dust_limit_satoshis,
1094 max_htlc_value_in_flight_msat,
1095 channel_reserve_satoshis,
1101 revocation_basepoint,
1103 delayed_payment_basepoint,
1105 first_per_commitment_point,
1106 shutdown_scriptpubkey
1108 (1, channel_type, option),
1111 impl_writeable_msg!(AnnouncementSignatures, {
1118 impl Writeable for ChannelReestablish {
1119 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1120 self.channel_id.write(w)?;
1121 self.next_local_commitment_number.write(w)?;
1122 self.next_remote_commitment_number.write(w)?;
1123 match self.data_loss_protect {
1124 OptionalField::Present(ref data_loss_protect) => {
1125 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1126 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1128 OptionalField::Absent => {}
1134 impl Readable for ChannelReestablish{
1135 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1137 channel_id: Readable::read(r)?,
1138 next_local_commitment_number: Readable::read(r)?,
1139 next_remote_commitment_number: Readable::read(r)?,
1140 data_loss_protect: {
1141 match <[u8; 32] as Readable>::read(r) {
1142 Ok(your_last_per_commitment_secret) =>
1143 OptionalField::Present(DataLossProtect {
1144 your_last_per_commitment_secret,
1145 my_current_per_commitment_point: Readable::read(r)?,
1147 Err(DecodeError::ShortRead) => OptionalField::Absent,
1148 Err(e) => return Err(e)
1155 impl_writeable_msg!(ClosingSigned,
1156 { channel_id, fee_satoshis, signature },
1157 { (1, fee_range, option) }
1160 impl_writeable!(ClosingSignedFeeRange, {
1165 impl_writeable_msg!(CommitmentSigned, {
1171 impl_writeable!(DecodedOnionErrorPacket, {
1177 impl_writeable_msg!(FundingCreated, {
1178 temporary_channel_id,
1180 funding_output_index,
1184 impl_writeable_msg!(FundingSigned, {
1189 impl_writeable_msg!(ChannelReady, {
1191 next_per_commitment_point,
1193 (1, short_channel_id_alias, option),
1196 impl Writeable for Init {
1197 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1198 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1199 // our relevant feature bits. This keeps us compatible with old nodes.
1200 self.features.write_up_to_13(w)?;
1201 self.features.write(w)?;
1202 encode_tlv_stream!(w, {
1203 (3, self.remote_network_address, option)
1209 impl Readable for Init {
1210 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1211 let global_features: InitFeatures = Readable::read(r)?;
1212 let features: InitFeatures = Readable::read(r)?;
1213 let mut remote_network_address: Option<NetAddress> = None;
1214 decode_tlv_stream!(r, {
1215 (3, remote_network_address, option)
1218 features: features.or(global_features),
1219 remote_network_address,
1224 impl_writeable_msg!(OpenChannel, {
1226 temporary_channel_id,
1229 dust_limit_satoshis,
1230 max_htlc_value_in_flight_msat,
1231 channel_reserve_satoshis,
1237 revocation_basepoint,
1239 delayed_payment_basepoint,
1241 first_per_commitment_point,
1243 shutdown_scriptpubkey
1245 (1, channel_type, option),
1248 impl_writeable_msg!(RevokeAndACK, {
1250 per_commitment_secret,
1251 next_per_commitment_point
1254 impl_writeable_msg!(Shutdown, {
1259 impl_writeable_msg!(UpdateFailHTLC, {
1265 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1272 impl_writeable_msg!(UpdateFee, {
1277 impl_writeable_msg!(UpdateFulfillHTLC, {
1283 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1284 // serialization format in a way which assumes we know the total serialized length/message end
1286 impl_writeable!(OnionErrorPacket, {
1290 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1291 // serialization format in a way which assumes we know the total serialized length/message end
1293 impl Writeable for OnionPacket {
1294 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1295 self.version.write(w)?;
1296 match self.public_key {
1297 Ok(pubkey) => pubkey.write(w)?,
1298 Err(_) => [0u8;33].write(w)?,
1300 w.write_all(&self.hop_data)?;
1301 self.hmac.write(w)?;
1306 impl Readable for OnionPacket {
1307 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1309 version: Readable::read(r)?,
1311 let mut buf = [0u8;33];
1312 r.read_exact(&mut buf)?;
1313 PublicKey::from_slice(&buf)
1315 hop_data: Readable::read(r)?,
1316 hmac: Readable::read(r)?,
1321 impl_writeable_msg!(UpdateAddHTLC, {
1327 onion_routing_packet
1330 impl Writeable for FinalOnionHopData {
1331 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1332 self.payment_secret.0.write(w)?;
1333 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1337 impl Readable for FinalOnionHopData {
1338 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1339 let secret: [u8; 32] = Readable::read(r)?;
1340 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1341 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1345 impl Writeable for OnionHopData {
1346 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1348 OnionHopDataFormat::Legacy { short_channel_id } => {
1350 short_channel_id.write(w)?;
1351 self.amt_to_forward.write(w)?;
1352 self.outgoing_cltv_value.write(w)?;
1353 w.write_all(&[0;12])?;
1355 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1356 encode_varint_length_prefixed_tlv!(w, {
1357 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1358 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1359 (6, short_channel_id, required)
1362 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1363 encode_varint_length_prefixed_tlv!(w, {
1364 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1365 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1366 (8, payment_data, option),
1367 (5482373484, keysend_preimage, option)
1375 impl Readable for OnionHopData {
1376 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1377 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1378 let v: VarInt = Decodable::consensus_decode(&mut r)
1379 .map_err(|e| match e {
1380 Error::Io(ioe) => DecodeError::from(ioe),
1381 _ => DecodeError::InvalidValue
1383 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1384 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1385 let mut rd = FixedLengthReader::new(r, v.0);
1386 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1387 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1388 let mut short_id: Option<u64> = None;
1389 let mut payment_data: Option<FinalOnionHopData> = None;
1390 let mut keysend_preimage: Option<PaymentPreimage> = None;
1391 // The TLV type is chosen to be compatible with lnd and c-lightning.
1392 decode_tlv_stream!(&mut rd, {
1394 (4, cltv_value, required),
1395 (6, short_id, option),
1396 (8, payment_data, option),
1397 (5482373484, keysend_preimage, option)
1399 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1400 let format = if let Some(short_channel_id) = short_id {
1401 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1402 OnionHopDataFormat::NonFinalNode {
1406 if let &Some(ref data) = &payment_data {
1407 if data.total_msat > MAX_VALUE_MSAT {
1408 return Err(DecodeError::InvalidValue);
1411 OnionHopDataFormat::FinalNode {
1416 (format, amt.0, cltv_value.0)
1418 let format = OnionHopDataFormat::Legacy {
1419 short_channel_id: Readable::read(r)?,
1421 let amt: u64 = Readable::read(r)?;
1422 let cltv_value: u32 = Readable::read(r)?;
1423 r.read_exact(&mut [0; 12])?;
1424 (format, amt, cltv_value)
1427 if amt > MAX_VALUE_MSAT {
1428 return Err(DecodeError::InvalidValue);
1432 amt_to_forward: amt,
1433 outgoing_cltv_value: cltv_value,
1438 impl Writeable for Ping {
1439 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1440 self.ponglen.write(w)?;
1441 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1446 impl Readable for Ping {
1447 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1449 ponglen: Readable::read(r)?,
1451 let byteslen = Readable::read(r)?;
1452 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1459 impl Writeable for Pong {
1460 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1461 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1466 impl Readable for Pong {
1467 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1470 let byteslen = Readable::read(r)?;
1471 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1478 impl Writeable for UnsignedChannelAnnouncement {
1479 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1480 self.features.write(w)?;
1481 self.chain_hash.write(w)?;
1482 self.short_channel_id.write(w)?;
1483 self.node_id_1.write(w)?;
1484 self.node_id_2.write(w)?;
1485 self.bitcoin_key_1.write(w)?;
1486 self.bitcoin_key_2.write(w)?;
1487 w.write_all(&self.excess_data[..])?;
1492 impl Readable for UnsignedChannelAnnouncement {
1493 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1495 features: Readable::read(r)?,
1496 chain_hash: Readable::read(r)?,
1497 short_channel_id: Readable::read(r)?,
1498 node_id_1: Readable::read(r)?,
1499 node_id_2: Readable::read(r)?,
1500 bitcoin_key_1: Readable::read(r)?,
1501 bitcoin_key_2: Readable::read(r)?,
1502 excess_data: read_to_end(r)?,
1507 impl_writeable!(ChannelAnnouncement, {
1510 bitcoin_signature_1,
1511 bitcoin_signature_2,
1515 impl Writeable for UnsignedChannelUpdate {
1516 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1517 let mut message_flags: u8 = 0;
1518 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1521 self.chain_hash.write(w)?;
1522 self.short_channel_id.write(w)?;
1523 self.timestamp.write(w)?;
1524 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1525 all_flags.write(w)?;
1526 self.cltv_expiry_delta.write(w)?;
1527 self.htlc_minimum_msat.write(w)?;
1528 self.fee_base_msat.write(w)?;
1529 self.fee_proportional_millionths.write(w)?;
1530 self.htlc_maximum_msat.write(w)?;
1531 w.write_all(&self.excess_data[..])?;
1536 impl Readable for UnsignedChannelUpdate {
1537 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1538 let has_htlc_maximum_msat;
1540 chain_hash: Readable::read(r)?,
1541 short_channel_id: Readable::read(r)?,
1542 timestamp: Readable::read(r)?,
1544 let flags: u16 = Readable::read(r)?;
1545 let message_flags = flags >> 8;
1546 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1549 cltv_expiry_delta: Readable::read(r)?,
1550 htlc_minimum_msat: Readable::read(r)?,
1551 fee_base_msat: Readable::read(r)?,
1552 fee_proportional_millionths: Readable::read(r)?,
1553 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1554 excess_data: read_to_end(r)?,
1559 impl_writeable!(ChannelUpdate, {
1564 impl Writeable for ErrorMessage {
1565 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1566 self.channel_id.write(w)?;
1567 (self.data.len() as u16).write(w)?;
1568 w.write_all(self.data.as_bytes())?;
1573 impl Readable for ErrorMessage {
1574 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1576 channel_id: Readable::read(r)?,
1578 let sz: usize = <u16 as Readable>::read(r)? as usize;
1579 let mut data = Vec::with_capacity(sz);
1581 r.read_exact(&mut data)?;
1582 match String::from_utf8(data) {
1584 Err(_) => return Err(DecodeError::InvalidValue),
1591 impl Writeable for WarningMessage {
1592 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1593 self.channel_id.write(w)?;
1594 (self.data.len() as u16).write(w)?;
1595 w.write_all(self.data.as_bytes())?;
1600 impl Readable for WarningMessage {
1601 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1603 channel_id: Readable::read(r)?,
1605 let sz: usize = <u16 as Readable>::read(r)? as usize;
1606 let mut data = Vec::with_capacity(sz);
1608 r.read_exact(&mut data)?;
1609 match String::from_utf8(data) {
1611 Err(_) => return Err(DecodeError::InvalidValue),
1618 impl Writeable for UnsignedNodeAnnouncement {
1619 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1620 self.features.write(w)?;
1621 self.timestamp.write(w)?;
1622 self.node_id.write(w)?;
1623 w.write_all(&self.rgb)?;
1624 self.alias.write(w)?;
1626 let mut addr_len = 0;
1627 for addr in self.addresses.iter() {
1628 addr_len += 1 + addr.len();
1630 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1631 for addr in self.addresses.iter() {
1634 w.write_all(&self.excess_address_data[..])?;
1635 w.write_all(&self.excess_data[..])?;
1640 impl Readable for UnsignedNodeAnnouncement {
1641 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1642 let features: NodeFeatures = Readable::read(r)?;
1643 let timestamp: u32 = Readable::read(r)?;
1644 let node_id: PublicKey = Readable::read(r)?;
1645 let mut rgb = [0; 3];
1646 r.read_exact(&mut rgb)?;
1647 let alias: [u8; 32] = Readable::read(r)?;
1649 let addr_len: u16 = Readable::read(r)?;
1650 let mut addresses: Vec<NetAddress> = Vec::new();
1651 let mut addr_readpos = 0;
1652 let mut excess = false;
1653 let mut excess_byte = 0;
1655 if addr_len <= addr_readpos { break; }
1656 match Readable::read(r) {
1658 if addr_len < addr_readpos + 1 + addr.len() {
1659 return Err(DecodeError::BadLengthDescriptor);
1661 addr_readpos += (1 + addr.len()) as u16;
1662 addresses.push(addr);
1664 Ok(Err(unknown_descriptor)) => {
1666 excess_byte = unknown_descriptor;
1669 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1670 Err(e) => return Err(e),
1674 let mut excess_data = vec![];
1675 let excess_address_data = if addr_readpos < addr_len {
1676 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1677 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1679 excess_address_data[0] = excess_byte;
1684 excess_data.push(excess_byte);
1688 excess_data.extend(read_to_end(r)?.iter());
1689 Ok(UnsignedNodeAnnouncement {
1696 excess_address_data,
1702 impl_writeable!(NodeAnnouncement, {
1707 impl Readable for QueryShortChannelIds {
1708 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1709 let chain_hash: BlockHash = Readable::read(r)?;
1711 let encoding_len: u16 = Readable::read(r)?;
1712 let encoding_type: u8 = Readable::read(r)?;
1714 // Must be encoding_type=0 uncompressed serialization. We do not
1715 // support encoding_type=1 zlib serialization.
1716 if encoding_type != EncodingType::Uncompressed as u8 {
1717 return Err(DecodeError::UnsupportedCompression);
1720 // We expect the encoding_len to always includes the 1-byte
1721 // encoding_type and that short_channel_ids are 8-bytes each
1722 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1723 return Err(DecodeError::InvalidValue);
1726 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1727 // less the 1-byte encoding_type
1728 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1729 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1730 for _ in 0..short_channel_id_count {
1731 short_channel_ids.push(Readable::read(r)?);
1734 Ok(QueryShortChannelIds {
1741 impl Writeable for QueryShortChannelIds {
1742 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1743 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1744 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1746 self.chain_hash.write(w)?;
1747 encoding_len.write(w)?;
1749 // We only support type=0 uncompressed serialization
1750 (EncodingType::Uncompressed as u8).write(w)?;
1752 for scid in self.short_channel_ids.iter() {
1760 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1765 impl QueryChannelRange {
1767 * Calculates the overflow safe ending block height for the query.
1768 * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1770 pub fn end_blocknum(&self) -> u32 {
1771 match self.first_blocknum.checked_add(self.number_of_blocks) {
1772 Some(block) => block,
1773 None => u32::max_value(),
1778 impl_writeable_msg!(QueryChannelRange, {
1784 impl Readable for ReplyChannelRange {
1785 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1786 let chain_hash: BlockHash = Readable::read(r)?;
1787 let first_blocknum: u32 = Readable::read(r)?;
1788 let number_of_blocks: u32 = Readable::read(r)?;
1789 let sync_complete: bool = Readable::read(r)?;
1791 let encoding_len: u16 = Readable::read(r)?;
1792 let encoding_type: u8 = Readable::read(r)?;
1794 // Must be encoding_type=0 uncompressed serialization. We do not
1795 // support encoding_type=1 zlib serialization.
1796 if encoding_type != EncodingType::Uncompressed as u8 {
1797 return Err(DecodeError::UnsupportedCompression);
1800 // We expect the encoding_len to always includes the 1-byte
1801 // encoding_type and that short_channel_ids are 8-bytes each
1802 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1803 return Err(DecodeError::InvalidValue);
1806 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1807 // less the 1-byte encoding_type
1808 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1809 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1810 for _ in 0..short_channel_id_count {
1811 short_channel_ids.push(Readable::read(r)?);
1814 Ok(ReplyChannelRange {
1824 impl Writeable for ReplyChannelRange {
1825 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1826 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1827 self.chain_hash.write(w)?;
1828 self.first_blocknum.write(w)?;
1829 self.number_of_blocks.write(w)?;
1830 self.sync_complete.write(w)?;
1832 encoding_len.write(w)?;
1833 (EncodingType::Uncompressed as u8).write(w)?;
1834 for scid in self.short_channel_ids.iter() {
1842 impl_writeable_msg!(GossipTimestampFilter, {
1851 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1852 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1854 use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1855 use util::ser::{Writeable, Readable, Hostname};
1857 use bitcoin::hashes::hex::FromHex;
1858 use bitcoin::util::address::Address;
1859 use bitcoin::network::constants::Network;
1860 use bitcoin::blockdata::script::Builder;
1861 use bitcoin::blockdata::opcodes;
1862 use bitcoin::hash_types::{Txid, BlockHash};
1864 use bitcoin::secp256k1::{PublicKey,SecretKey};
1865 use bitcoin::secp256k1::{Secp256k1, Message};
1869 use core::convert::TryFrom;
1872 fn encoding_channel_reestablish_no_secret() {
1873 let cr = msgs::ChannelReestablish {
1874 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],
1875 next_local_commitment_number: 3,
1876 next_remote_commitment_number: 4,
1877 data_loss_protect: OptionalField::Absent,
1880 let encoded_value = cr.encode();
1883 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]
1888 fn encoding_channel_reestablish_with_secret() {
1890 let secp_ctx = Secp256k1::new();
1891 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1894 let cr = msgs::ChannelReestablish {
1895 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],
1896 next_local_commitment_number: 3,
1897 next_remote_commitment_number: 4,
1898 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1901 let encoded_value = cr.encode();
1904 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]
1908 macro_rules! get_keys_from {
1909 ($slice: expr, $secp_ctx: expr) => {
1911 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1912 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1918 macro_rules! get_sig_on {
1919 ($privkey: expr, $ctx: expr, $string: expr) => {
1921 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1922 $ctx.sign_ecdsa(&sighash, &$privkey)
1928 fn encoding_announcement_signatures() {
1929 let secp_ctx = Secp256k1::new();
1930 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1931 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1932 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1933 let announcement_signatures = msgs::AnnouncementSignatures {
1934 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],
1935 short_channel_id: 2316138423780173,
1936 node_signature: sig_1,
1937 bitcoin_signature: sig_2,
1940 let encoded_value = announcement_signatures.encode();
1941 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1944 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1945 let secp_ctx = Secp256k1::new();
1946 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1947 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1948 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1949 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1950 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1951 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1952 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1953 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1954 let mut features = ChannelFeatures::known();
1955 if unknown_features_bits {
1956 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1958 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1960 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1961 short_channel_id: 2316138423780173,
1962 node_id_1: pubkey_1,
1963 node_id_2: pubkey_2,
1964 bitcoin_key_1: pubkey_3,
1965 bitcoin_key_2: pubkey_4,
1966 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1968 let channel_announcement = msgs::ChannelAnnouncement {
1969 node_signature_1: sig_1,
1970 node_signature_2: sig_2,
1971 bitcoin_signature_1: sig_3,
1972 bitcoin_signature_2: sig_4,
1973 contents: unsigned_channel_announcement,
1975 let encoded_value = channel_announcement.encode();
1976 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1977 if unknown_features_bits {
1978 target_value.append(&mut hex::decode("0002ffff").unwrap());
1980 target_value.append(&mut hex::decode("0000").unwrap());
1982 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1983 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1985 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1987 assert_eq!(encoded_value, target_value);
1991 fn encoding_channel_announcement() {
1992 do_encoding_channel_announcement(true, false);
1993 do_encoding_channel_announcement(false, true);
1994 do_encoding_channel_announcement(false, false);
1995 do_encoding_channel_announcement(true, true);
1998 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, hostname: bool, excess_address_data: bool, excess_data: bool) {
1999 let secp_ctx = Secp256k1::new();
2000 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2001 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2002 let features = if unknown_features_bits {
2003 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2005 // Set to some features we may support
2006 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2008 let mut addresses = Vec::new();
2010 addresses.push(msgs::NetAddress::IPv4 {
2011 addr: [255, 254, 253, 252],
2016 addresses.push(msgs::NetAddress::IPv6 {
2017 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2022 addresses.push(msgs::NetAddress::OnionV2(
2023 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2027 addresses.push(msgs::NetAddress::OnionV3 {
2028 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],
2035 addresses.push(msgs::NetAddress::Hostname {
2036 hostname: Hostname::try_from(String::from("host")).unwrap(),
2040 let mut addr_len = 0;
2041 for addr in &addresses {
2042 addr_len += addr.len() + 1;
2044 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2046 timestamp: 20190119,
2051 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() },
2052 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() },
2054 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2055 let node_announcement = msgs::NodeAnnouncement {
2057 contents: unsigned_node_announcement,
2059 let encoded_value = node_announcement.encode();
2060 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2061 if unknown_features_bits {
2062 target_value.append(&mut hex::decode("0002ffff").unwrap());
2064 target_value.append(&mut hex::decode("000122").unwrap());
2066 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2067 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2069 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2072 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2075 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2078 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2081 target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2083 if excess_address_data {
2084 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2087 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2089 assert_eq!(encoded_value, target_value);
2093 fn encoding_node_announcement() {
2094 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2095 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2096 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2097 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2098 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2099 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2100 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2101 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2102 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2103 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2106 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2107 let secp_ctx = Secp256k1::new();
2108 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2109 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2110 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2111 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2112 short_channel_id: 2316138423780173,
2113 timestamp: 20190119,
2114 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2115 cltv_expiry_delta: 144,
2116 htlc_minimum_msat: 1000000,
2117 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2118 fee_base_msat: 10000,
2119 fee_proportional_millionths: 20,
2120 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2122 let channel_update = msgs::ChannelUpdate {
2124 contents: unsigned_channel_update
2126 let encoded_value = channel_update.encode();
2127 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2128 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2129 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2130 if htlc_maximum_msat {
2131 target_value.append(&mut hex::decode("01").unwrap());
2133 target_value.append(&mut hex::decode("00").unwrap());
2135 target_value.append(&mut hex::decode("00").unwrap());
2137 let flag = target_value.last_mut().unwrap();
2141 let flag = target_value.last_mut().unwrap();
2142 *flag = *flag | 1 << 1;
2144 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2145 if htlc_maximum_msat {
2146 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2149 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2151 assert_eq!(encoded_value, target_value);
2155 fn encoding_channel_update() {
2156 do_encoding_channel_update(false, false, false, false);
2157 do_encoding_channel_update(false, false, false, true);
2158 do_encoding_channel_update(true, false, false, false);
2159 do_encoding_channel_update(true, false, false, true);
2160 do_encoding_channel_update(false, true, false, false);
2161 do_encoding_channel_update(false, true, false, true);
2162 do_encoding_channel_update(false, false, true, false);
2163 do_encoding_channel_update(false, false, true, true);
2164 do_encoding_channel_update(true, true, true, false);
2165 do_encoding_channel_update(true, true, true, true);
2168 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2169 let secp_ctx = Secp256k1::new();
2170 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2171 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2172 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2173 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2174 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2175 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2176 let open_channel = msgs::OpenChannel {
2177 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2178 temporary_channel_id: [2; 32],
2179 funding_satoshis: 1311768467284833366,
2180 push_msat: 2536655962884945560,
2181 dust_limit_satoshis: 3608586615801332854,
2182 max_htlc_value_in_flight_msat: 8517154655701053848,
2183 channel_reserve_satoshis: 8665828695742877976,
2184 htlc_minimum_msat: 2316138423780173,
2185 feerate_per_kw: 821716,
2186 to_self_delay: 49340,
2187 max_accepted_htlcs: 49340,
2188 funding_pubkey: pubkey_1,
2189 revocation_basepoint: pubkey_2,
2190 payment_point: pubkey_3,
2191 delayed_payment_basepoint: pubkey_4,
2192 htlc_basepoint: pubkey_5,
2193 first_per_commitment_point: pubkey_6,
2194 channel_flags: if random_bit { 1 << 5 } else { 0 },
2195 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2196 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2198 let encoded_value = open_channel.encode();
2199 let mut target_value = Vec::new();
2200 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2201 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2203 target_value.append(&mut hex::decode("20").unwrap());
2205 target_value.append(&mut hex::decode("00").unwrap());
2208 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2211 target_value.append(&mut hex::decode("0100").unwrap());
2213 assert_eq!(encoded_value, target_value);
2217 fn encoding_open_channel() {
2218 do_encoding_open_channel(false, false, false);
2219 do_encoding_open_channel(false, false, true);
2220 do_encoding_open_channel(false, true, false);
2221 do_encoding_open_channel(false, true, true);
2222 do_encoding_open_channel(true, false, false);
2223 do_encoding_open_channel(true, false, true);
2224 do_encoding_open_channel(true, true, false);
2225 do_encoding_open_channel(true, true, true);
2228 fn do_encoding_accept_channel(shutdown: bool) {
2229 let secp_ctx = Secp256k1::new();
2230 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2231 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2232 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2233 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2234 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2235 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2236 let accept_channel = msgs::AcceptChannel {
2237 temporary_channel_id: [2; 32],
2238 dust_limit_satoshis: 1311768467284833366,
2239 max_htlc_value_in_flight_msat: 2536655962884945560,
2240 channel_reserve_satoshis: 3608586615801332854,
2241 htlc_minimum_msat: 2316138423780173,
2242 minimum_depth: 821716,
2243 to_self_delay: 49340,
2244 max_accepted_htlcs: 49340,
2245 funding_pubkey: pubkey_1,
2246 revocation_basepoint: pubkey_2,
2247 payment_point: pubkey_3,
2248 delayed_payment_basepoint: pubkey_4,
2249 htlc_basepoint: pubkey_5,
2250 first_per_commitment_point: pubkey_6,
2251 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2254 let encoded_value = accept_channel.encode();
2255 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2257 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2259 assert_eq!(encoded_value, target_value);
2263 fn encoding_accept_channel() {
2264 do_encoding_accept_channel(false);
2265 do_encoding_accept_channel(true);
2269 fn encoding_funding_created() {
2270 let secp_ctx = Secp256k1::new();
2271 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2272 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2273 let funding_created = msgs::FundingCreated {
2274 temporary_channel_id: [2; 32],
2275 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2276 funding_output_index: 255,
2279 let encoded_value = funding_created.encode();
2280 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2281 assert_eq!(encoded_value, target_value);
2285 fn encoding_funding_signed() {
2286 let secp_ctx = Secp256k1::new();
2287 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2288 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2289 let funding_signed = msgs::FundingSigned {
2290 channel_id: [2; 32],
2293 let encoded_value = funding_signed.encode();
2294 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2295 assert_eq!(encoded_value, target_value);
2299 fn encoding_channel_ready() {
2300 let secp_ctx = Secp256k1::new();
2301 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2302 let channel_ready = msgs::ChannelReady {
2303 channel_id: [2; 32],
2304 next_per_commitment_point: pubkey_1,
2305 short_channel_id_alias: None,
2307 let encoded_value = channel_ready.encode();
2308 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2309 assert_eq!(encoded_value, target_value);
2312 fn do_encoding_shutdown(script_type: u8) {
2313 let secp_ctx = Secp256k1::new();
2314 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2315 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2316 let shutdown = msgs::Shutdown {
2317 channel_id: [2; 32],
2319 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2320 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2321 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2322 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2324 let encoded_value = shutdown.encode();
2325 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2326 if script_type == 1 {
2327 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2328 } else if script_type == 2 {
2329 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2330 } else if script_type == 3 {
2331 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2332 } else if script_type == 4 {
2333 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2335 assert_eq!(encoded_value, target_value);
2339 fn encoding_shutdown() {
2340 do_encoding_shutdown(1);
2341 do_encoding_shutdown(2);
2342 do_encoding_shutdown(3);
2343 do_encoding_shutdown(4);
2347 fn encoding_closing_signed() {
2348 let secp_ctx = Secp256k1::new();
2349 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2350 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2351 let closing_signed = msgs::ClosingSigned {
2352 channel_id: [2; 32],
2353 fee_satoshis: 2316138423780173,
2357 let encoded_value = closing_signed.encode();
2358 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2359 assert_eq!(encoded_value, target_value);
2360 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2362 let closing_signed_with_range = msgs::ClosingSigned {
2363 channel_id: [2; 32],
2364 fee_satoshis: 2316138423780173,
2366 fee_range: Some(msgs::ClosingSignedFeeRange {
2367 min_fee_satoshis: 0xdeadbeef,
2368 max_fee_satoshis: 0x1badcafe01234567,
2371 let encoded_value_with_range = closing_signed_with_range.encode();
2372 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2373 assert_eq!(encoded_value_with_range, target_value_with_range);
2374 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2375 closing_signed_with_range);
2379 fn encoding_update_add_htlc() {
2380 let secp_ctx = Secp256k1::new();
2381 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2382 let onion_routing_packet = msgs::OnionPacket {
2384 public_key: Ok(pubkey_1),
2385 hop_data: [1; 20*65],
2388 let update_add_htlc = msgs::UpdateAddHTLC {
2389 channel_id: [2; 32],
2390 htlc_id: 2316138423780173,
2391 amount_msat: 3608586615801332854,
2392 payment_hash: PaymentHash([1; 32]),
2393 cltv_expiry: 821716,
2394 onion_routing_packet
2396 let encoded_value = update_add_htlc.encode();
2397 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2398 assert_eq!(encoded_value, target_value);
2402 fn encoding_update_fulfill_htlc() {
2403 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2404 channel_id: [2; 32],
2405 htlc_id: 2316138423780173,
2406 payment_preimage: PaymentPreimage([1; 32]),
2408 let encoded_value = update_fulfill_htlc.encode();
2409 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2410 assert_eq!(encoded_value, target_value);
2414 fn encoding_update_fail_htlc() {
2415 let reason = OnionErrorPacket {
2416 data: [1; 32].to_vec(),
2418 let update_fail_htlc = msgs::UpdateFailHTLC {
2419 channel_id: [2; 32],
2420 htlc_id: 2316138423780173,
2423 let encoded_value = update_fail_htlc.encode();
2424 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2425 assert_eq!(encoded_value, target_value);
2429 fn encoding_update_fail_malformed_htlc() {
2430 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2431 channel_id: [2; 32],
2432 htlc_id: 2316138423780173,
2433 sha256_of_onion: [1; 32],
2436 let encoded_value = update_fail_malformed_htlc.encode();
2437 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2438 assert_eq!(encoded_value, target_value);
2441 fn do_encoding_commitment_signed(htlcs: bool) {
2442 let secp_ctx = Secp256k1::new();
2443 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2444 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2445 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2446 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2447 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2448 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2449 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2450 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2451 let commitment_signed = msgs::CommitmentSigned {
2452 channel_id: [2; 32],
2454 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2456 let encoded_value = commitment_signed.encode();
2457 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2459 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2461 target_value.append(&mut hex::decode("0000").unwrap());
2463 assert_eq!(encoded_value, target_value);
2467 fn encoding_commitment_signed() {
2468 do_encoding_commitment_signed(true);
2469 do_encoding_commitment_signed(false);
2473 fn encoding_revoke_and_ack() {
2474 let secp_ctx = Secp256k1::new();
2475 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2476 let raa = msgs::RevokeAndACK {
2477 channel_id: [2; 32],
2478 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],
2479 next_per_commitment_point: pubkey_1,
2481 let encoded_value = raa.encode();
2482 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2483 assert_eq!(encoded_value, target_value);
2487 fn encoding_update_fee() {
2488 let update_fee = msgs::UpdateFee {
2489 channel_id: [2; 32],
2490 feerate_per_kw: 20190119,
2492 let encoded_value = update_fee.encode();
2493 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2494 assert_eq!(encoded_value, target_value);
2498 fn encoding_init() {
2499 assert_eq!(msgs::Init {
2500 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2501 remote_network_address: None,
2502 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2503 assert_eq!(msgs::Init {
2504 features: InitFeatures::from_le_bytes(vec![0xFF]),
2505 remote_network_address: None,
2506 }.encode(), hex::decode("0001ff0001ff").unwrap());
2507 assert_eq!(msgs::Init {
2508 features: InitFeatures::from_le_bytes(vec![]),
2509 remote_network_address: None,
2510 }.encode(), hex::decode("00000000").unwrap());
2512 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2513 remote_network_address: Some(msgs::NetAddress::IPv4 {
2514 addr: [127, 0, 0, 1],
2518 let encoded_value = init_msg.encode();
2519 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2520 assert_eq!(encoded_value, target_value);
2521 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2525 fn encoding_error() {
2526 let error = msgs::ErrorMessage {
2527 channel_id: [2; 32],
2528 data: String::from("rust-lightning"),
2530 let encoded_value = error.encode();
2531 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2532 assert_eq!(encoded_value, target_value);
2536 fn encoding_warning() {
2537 let error = msgs::WarningMessage {
2538 channel_id: [2; 32],
2539 data: String::from("rust-lightning"),
2541 let encoded_value = error.encode();
2542 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2543 assert_eq!(encoded_value, target_value);
2547 fn encoding_ping() {
2548 let ping = msgs::Ping {
2552 let encoded_value = ping.encode();
2553 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2554 assert_eq!(encoded_value, target_value);
2558 fn encoding_pong() {
2559 let pong = msgs::Pong {
2562 let encoded_value = pong.encode();
2563 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2564 assert_eq!(encoded_value, target_value);
2568 fn encoding_legacy_onion_hop_data() {
2569 let msg = msgs::OnionHopData {
2570 format: OnionHopDataFormat::Legacy {
2571 short_channel_id: 0xdeadbeef1bad1dea,
2573 amt_to_forward: 0x0badf00d01020304,
2574 outgoing_cltv_value: 0xffffffff,
2576 let encoded_value = msg.encode();
2577 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2578 assert_eq!(encoded_value, target_value);
2582 fn encoding_nonfinal_onion_hop_data() {
2583 let mut msg = msgs::OnionHopData {
2584 format: OnionHopDataFormat::NonFinalNode {
2585 short_channel_id: 0xdeadbeef1bad1dea,
2587 amt_to_forward: 0x0badf00d01020304,
2588 outgoing_cltv_value: 0xffffffff,
2590 let encoded_value = msg.encode();
2591 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2592 assert_eq!(encoded_value, target_value);
2593 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2594 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2595 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2596 } else { panic!(); }
2597 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2598 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2602 fn encoding_final_onion_hop_data() {
2603 let mut msg = msgs::OnionHopData {
2604 format: OnionHopDataFormat::FinalNode {
2606 keysend_preimage: None,
2608 amt_to_forward: 0x0badf00d01020304,
2609 outgoing_cltv_value: 0xffffffff,
2611 let encoded_value = msg.encode();
2612 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2613 assert_eq!(encoded_value, target_value);
2614 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2615 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2616 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2617 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2621 fn encoding_final_onion_hop_data_with_secret() {
2622 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2623 let mut msg = msgs::OnionHopData {
2624 format: OnionHopDataFormat::FinalNode {
2625 payment_data: Some(FinalOnionHopData {
2626 payment_secret: expected_payment_secret,
2627 total_msat: 0x1badca1f
2629 keysend_preimage: None,
2631 amt_to_forward: 0x0badf00d01020304,
2632 outgoing_cltv_value: 0xffffffff,
2634 let encoded_value = msg.encode();
2635 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2636 assert_eq!(encoded_value, target_value);
2637 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2638 if let OnionHopDataFormat::FinalNode {
2639 payment_data: Some(FinalOnionHopData {
2641 total_msat: 0x1badca1f
2643 keysend_preimage: None,
2645 assert_eq!(payment_secret, expected_payment_secret);
2646 } else { panic!(); }
2647 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2648 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2652 fn query_channel_range_end_blocknum() {
2653 let tests: Vec<(u32, u32, u32)> = vec![
2654 (10000, 1500, 11500),
2655 (0, 0xffffffff, 0xffffffff),
2656 (1, 0xffffffff, 0xffffffff),
2659 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2660 let sut = msgs::QueryChannelRange {
2661 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2665 assert_eq!(sut.end_blocknum(), expected);
2670 fn encoding_query_channel_range() {
2671 let mut query_channel_range = msgs::QueryChannelRange {
2672 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2673 first_blocknum: 100000,
2674 number_of_blocks: 1500,
2676 let encoded_value = query_channel_range.encode();
2677 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2678 assert_eq!(encoded_value, target_value);
2680 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2681 assert_eq!(query_channel_range.first_blocknum, 100000);
2682 assert_eq!(query_channel_range.number_of_blocks, 1500);
2686 fn encoding_reply_channel_range() {
2687 do_encoding_reply_channel_range(0);
2688 do_encoding_reply_channel_range(1);
2691 fn do_encoding_reply_channel_range(encoding_type: u8) {
2692 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2693 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2694 let mut reply_channel_range = msgs::ReplyChannelRange {
2695 chain_hash: expected_chain_hash,
2696 first_blocknum: 756230,
2697 number_of_blocks: 1500,
2698 sync_complete: true,
2699 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2702 if encoding_type == 0 {
2703 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2704 let encoded_value = reply_channel_range.encode();
2705 assert_eq!(encoded_value, target_value);
2707 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2708 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2709 assert_eq!(reply_channel_range.first_blocknum, 756230);
2710 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2711 assert_eq!(reply_channel_range.sync_complete, true);
2712 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2713 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2714 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2716 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2717 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2718 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2723 fn encoding_query_short_channel_ids() {
2724 do_encoding_query_short_channel_ids(0);
2725 do_encoding_query_short_channel_ids(1);
2728 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2729 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2730 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2731 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2732 chain_hash: expected_chain_hash,
2733 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2736 if encoding_type == 0 {
2737 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2738 let encoded_value = query_short_channel_ids.encode();
2739 assert_eq!(encoded_value, target_value);
2741 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2742 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2743 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2744 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2745 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2747 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2748 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2749 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2754 fn encoding_reply_short_channel_ids_end() {
2755 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2756 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2757 chain_hash: expected_chain_hash,
2758 full_information: true,
2760 let encoded_value = reply_short_channel_ids_end.encode();
2761 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2762 assert_eq!(encoded_value, target_value);
2764 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2765 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2766 assert_eq!(reply_short_channel_ids_end.full_information, true);
2770 fn encoding_gossip_timestamp_filter(){
2771 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2772 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2773 chain_hash: expected_chain_hash,
2774 first_timestamp: 1590000000,
2775 timestamp_range: 0xffff_ffff,
2777 let encoded_value = gossip_timestamp_filter.encode();
2778 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2779 assert_eq!(encoded_value, target_value);
2781 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2782 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2783 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2784 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);