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 crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
34 use crate::ln::onion_utils;
35 use crate::onion_message;
37 use crate::prelude::*;
40 use crate::io::{self, Read};
41 use crate::io_extras::read_to_end;
43 use crate::events::{MessageSendEventsProvider, OnionMessageProvider};
44 use crate::util::logger;
45 use crate::util::ser::{LengthReadable, Readable, ReadableArgs, Writeable, Writer, WithoutLength, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname};
47 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
49 use crate::routing::gossip::{NodeAlias, NodeId};
51 /// 21 million * 10^8 * 1000
52 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
55 /// A partial signature that also contains the Musig2 nonce its signer used
56 #[derive(Clone, Debug, PartialEq, Eq)]
57 pub struct PartialSignatureWithNonce(pub musig2::types::PartialSignature, pub musig2::types::PublicNonce);
59 /// An error in decoding a message or struct.
60 #[derive(Clone, Debug, PartialEq, Eq)]
61 pub enum DecodeError {
62 /// A version byte specified something we don't know how to handle.
64 /// Includes unknown realm byte in an onion hop data packet.
66 /// Unknown feature mandating we fail to parse message (e.g., TLV with an even, unknown type)
67 UnknownRequiredFeature,
68 /// Value was invalid.
70 /// For example, a byte which was supposed to be a bool was something other than a 0
71 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
72 /// syntactically incorrect, etc.
74 /// The buffer to be read was too short.
76 /// A length descriptor in the packet didn't describe the later data correctly.
78 /// Error from [`std::io`].
80 /// The message included zlib-compressed values, which we don't support.
81 UnsupportedCompression,
84 /// An [`init`] message to be sent to or received from a peer.
86 /// [`init`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-init-message
87 #[derive(Clone, Debug, PartialEq, Eq)]
89 /// The relevant features which the sender supports.
90 pub features: InitFeatures,
91 /// The receipient's network address.
93 /// This adds the option to report a remote IP address back to a connecting peer using the init
94 /// message. A node can decide to use that information to discover a potential update to its
95 /// public IPv4 address (NAT) and use that for a [`NodeAnnouncement`] update message containing
97 pub remote_network_address: Option<NetAddress>,
100 /// An [`error`] message to be sent to or received from a peer.
102 /// [`error`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
103 #[derive(Clone, Debug, PartialEq, Eq)]
104 pub struct ErrorMessage {
105 /// The channel ID involved in the error.
107 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
108 /// with the sending peer should be closed.
109 pub channel_id: [u8; 32],
110 /// A possibly human-readable error description.
112 /// The string should be sanitized before it is used (e.g., emitted to logs or printed to
113 /// `stdout`). Otherwise, a well crafted error message may trigger a security vulnerability in
114 /// the terminal emulator or the logging subsystem.
118 /// A [`warning`] message to be sent to or received from a peer.
120 /// [`warning`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
121 #[derive(Clone, Debug, PartialEq, Eq)]
122 pub struct WarningMessage {
123 /// The channel ID involved in the warning.
125 /// All-0s indicates a warning unrelated to a specific channel.
126 pub channel_id: [u8; 32],
127 /// A possibly human-readable warning description.
129 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
130 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
131 /// the terminal emulator or the logging subsystem.
135 /// A [`ping`] message to be sent to or received from a peer.
137 /// [`ping`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
138 #[derive(Clone, Debug, PartialEq, Eq)]
140 /// The desired response length.
142 /// The ping packet size.
144 /// This field is not sent on the wire. byteslen zeros are sent.
148 /// A [`pong`] message to be sent to or received from a peer.
150 /// [`pong`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
151 #[derive(Clone, Debug, PartialEq, Eq)]
153 /// The pong packet size.
155 /// This field is not sent on the wire. byteslen zeros are sent.
159 /// An [`open_channel`] message to be sent to or received from a peer.
161 /// [`open_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
162 #[derive(Clone, Debug, PartialEq, Eq)]
163 pub struct OpenChannel {
164 /// The genesis hash of the blockchain where the channel is to be opened
165 pub chain_hash: BlockHash,
166 /// A temporary channel ID, until the funding outpoint is announced
167 pub temporary_channel_id: [u8; 32],
168 /// The channel value
169 pub funding_satoshis: u64,
170 /// The amount to push to the counterparty as part of the open, in milli-satoshi
172 /// The threshold below which outputs on transactions broadcast by sender will be omitted
173 pub dust_limit_satoshis: u64,
174 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
175 pub max_htlc_value_in_flight_msat: u64,
176 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
177 pub channel_reserve_satoshis: u64,
178 /// The minimum HTLC size incoming to sender, in milli-satoshi
179 pub htlc_minimum_msat: u64,
180 /// The feerate per 1000-weight of sender generated transactions, until updated by
182 pub feerate_per_kw: u32,
183 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if
184 /// they broadcast a commitment transaction
185 pub to_self_delay: u16,
186 /// The maximum number of inbound HTLCs towards sender
187 pub max_accepted_htlcs: u16,
188 /// The sender's key controlling the funding transaction
189 pub funding_pubkey: PublicKey,
190 /// Used to derive a revocation key for transactions broadcast by counterparty
191 pub revocation_basepoint: PublicKey,
192 /// A payment key to sender for transactions broadcast by counterparty
193 pub payment_point: PublicKey,
194 /// Used to derive a payment key to sender for transactions broadcast by sender
195 pub delayed_payment_basepoint: PublicKey,
196 /// Used to derive an HTLC payment key to sender
197 pub htlc_basepoint: PublicKey,
198 /// The first to-be-broadcast-by-sender transaction's per commitment point
199 pub first_per_commitment_point: PublicKey,
200 /// The channel flags to be used
201 pub channel_flags: u8,
202 /// Optionally, a request to pre-set the to-sender output's `scriptPubkey` for when we collaboratively close
203 pub shutdown_scriptpubkey: OptionalField<Script>,
204 /// The channel type that this channel will represent
206 /// If this is `None`, we derive the channel type from the intersection of our
207 /// feature bits with our counterparty's feature bits from the [`Init`] message.
208 pub channel_type: Option<ChannelTypeFeatures>,
211 /// An [`accept_channel`] message to be sent to or received from a peer.
213 /// [`accept_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel-message
214 #[derive(Clone, Debug, PartialEq, Eq)]
215 pub struct AcceptChannel {
216 /// A temporary channel ID, until the funding outpoint is announced
217 pub temporary_channel_id: [u8; 32],
218 /// The threshold below which outputs on transactions broadcast by sender will be omitted
219 pub dust_limit_satoshis: u64,
220 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
221 pub max_htlc_value_in_flight_msat: u64,
222 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
223 pub channel_reserve_satoshis: u64,
224 /// The minimum HTLC size incoming to sender, in milli-satoshi
225 pub htlc_minimum_msat: u64,
226 /// Minimum depth of the funding transaction before the channel is considered open
227 pub minimum_depth: u32,
228 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
229 pub to_self_delay: u16,
230 /// The maximum number of inbound HTLCs towards sender
231 pub max_accepted_htlcs: u16,
232 /// The sender's key controlling the funding transaction
233 pub funding_pubkey: PublicKey,
234 /// Used to derive a revocation key for transactions broadcast by counterparty
235 pub revocation_basepoint: PublicKey,
236 /// A payment key to sender for transactions broadcast by counterparty
237 pub payment_point: PublicKey,
238 /// Used to derive a payment key to sender for transactions broadcast by sender
239 pub delayed_payment_basepoint: PublicKey,
240 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
241 pub htlc_basepoint: PublicKey,
242 /// The first to-be-broadcast-by-sender transaction's per commitment point
243 pub first_per_commitment_point: PublicKey,
244 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
245 pub shutdown_scriptpubkey: OptionalField<Script>,
246 /// The channel type that this channel will represent.
248 /// If this is `None`, we derive the channel type from the intersection of
249 /// our feature bits with our counterparty's feature bits from the [`Init`] message.
250 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
251 pub channel_type: Option<ChannelTypeFeatures>,
253 /// Next nonce the channel initiator should use to create a funding output signature against
254 pub next_local_nonce: Option<musig2::types::PublicNonce>,
257 /// A [`funding_created`] message to be sent to or received from a peer.
259 /// [`funding_created`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_created-message
260 #[derive(Clone, Debug, PartialEq, Eq)]
261 pub struct FundingCreated {
262 /// A temporary channel ID, until the funding is established
263 pub temporary_channel_id: [u8; 32],
264 /// The funding transaction ID
265 pub funding_txid: Txid,
266 /// The specific output index funding this channel
267 pub funding_output_index: u16,
268 /// The signature of the channel initiator (funder) on the initial commitment transaction
269 pub signature: Signature,
271 /// The partial signature of the channel initiator (funder)
272 pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
274 /// Next nonce the channel acceptor should use to finalize the funding output signature
275 pub next_local_nonce: Option<musig2::types::PublicNonce>
278 /// A [`funding_signed`] message to be sent to or received from a peer.
280 /// [`funding_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_signed-message
281 #[derive(Clone, Debug, PartialEq, Eq)]
282 pub struct FundingSigned {
284 pub channel_id: [u8; 32],
285 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
286 pub signature: Signature,
288 /// The partial signature of the channel acceptor (fundee)
289 pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
292 /// A [`channel_ready`] message to be sent to or received from a peer.
294 /// [`channel_ready`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message
295 #[derive(Clone, Debug, PartialEq, Eq)]
296 pub struct ChannelReady {
298 pub channel_id: [u8; 32],
299 /// The per-commitment point of the second commitment transaction
300 pub next_per_commitment_point: PublicKey,
301 /// If set, provides a `short_channel_id` alias for this channel.
303 /// The sender will accept payments to be forwarded over this SCID and forward them to this
304 /// messages' recipient.
305 pub short_channel_id_alias: Option<u64>,
308 /// A [`shutdown`] message to be sent to or received from a peer.
310 /// [`shutdown`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-initiation-shutdown
311 #[derive(Clone, Debug, PartialEq, Eq)]
312 pub struct Shutdown {
314 pub channel_id: [u8; 32],
315 /// The destination of this peer's funds on closing.
317 /// Must be in one of these forms: P2PKH, P2SH, P2WPKH, P2WSH, P2TR.
318 pub scriptpubkey: Script,
321 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
323 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
325 #[derive(Clone, Debug, PartialEq, Eq)]
326 pub struct ClosingSignedFeeRange {
327 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
329 pub min_fee_satoshis: u64,
330 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
332 pub max_fee_satoshis: u64,
335 /// A [`closing_signed`] message to be sent to or received from a peer.
337 /// [`closing_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-negotiation-closing_signed
338 #[derive(Clone, Debug, PartialEq, Eq)]
339 pub struct ClosingSigned {
341 pub channel_id: [u8; 32],
342 /// The proposed total fee for the closing transaction
343 pub fee_satoshis: u64,
344 /// A signature on the closing transaction
345 pub signature: Signature,
346 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
348 pub fee_range: Option<ClosingSignedFeeRange>,
351 /// An [`update_add_htlc`] message to be sent to or received from a peer.
353 /// [`update_add_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#adding-an-htlc-update_add_htlc
354 #[derive(Clone, Debug, PartialEq, Eq)]
355 pub struct UpdateAddHTLC {
357 pub channel_id: [u8; 32],
360 /// The HTLC value in milli-satoshi
361 pub amount_msat: u64,
362 /// The payment hash, the pre-image of which controls HTLC redemption
363 pub payment_hash: PaymentHash,
364 /// The expiry height of the HTLC
365 pub cltv_expiry: u32,
366 pub(crate) onion_routing_packet: OnionPacket,
369 /// An onion message to be sent to or received from a peer.
371 // TODO: update with link to OM when they are merged into the BOLTs
372 #[derive(Clone, Debug, PartialEq, Eq)]
373 pub struct OnionMessage {
374 /// Used in decrypting the onion packet's payload.
375 pub blinding_point: PublicKey,
376 pub(crate) onion_routing_packet: onion_message::Packet,
379 /// An [`update_fulfill_htlc`] message to be sent to or received from a peer.
381 /// [`update_fulfill_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#removing-an-htlc-update_fulfill_htlc-update_fail_htlc-and-update_fail_malformed_htlc
382 #[derive(Clone, Debug, PartialEq, Eq)]
383 pub struct UpdateFulfillHTLC {
385 pub channel_id: [u8; 32],
388 /// The pre-image of the payment hash, allowing HTLC redemption
389 pub payment_preimage: PaymentPreimage,
392 /// An [`update_fail_htlc`] message to be sent to or received from a peer.
394 /// [`update_fail_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#removing-an-htlc-update_fulfill_htlc-update_fail_htlc-and-update_fail_malformed_htlc
395 #[derive(Clone, Debug, PartialEq, Eq)]
396 pub struct UpdateFailHTLC {
398 pub channel_id: [u8; 32],
401 pub(crate) reason: OnionErrorPacket,
404 /// An [`update_fail_malformed_htlc`] message to be sent to or received from a peer.
406 /// [`update_fail_malformed_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#removing-an-htlc-update_fulfill_htlc-update_fail_htlc-and-update_fail_malformed_htlc
407 #[derive(Clone, Debug, PartialEq, Eq)]
408 pub struct UpdateFailMalformedHTLC {
410 pub channel_id: [u8; 32],
413 pub(crate) sha256_of_onion: [u8; 32],
415 pub failure_code: u16,
418 /// A [`commitment_signed`] message to be sent to or received from a peer.
420 /// [`commitment_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#committing-updates-so-far-commitment_signed
421 #[derive(Clone, Debug, PartialEq, Eq)]
422 pub struct CommitmentSigned {
424 pub channel_id: [u8; 32],
425 /// A signature on the commitment transaction
426 pub signature: Signature,
427 /// Signatures on the HTLC transactions
428 pub htlc_signatures: Vec<Signature>,
430 /// The partial Taproot signature on the commitment transaction
431 pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
434 /// A [`revoke_and_ack`] message to be sent to or received from a peer.
436 /// [`revoke_and_ack`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#completing-the-transition-to-the-updated-state-revoke_and_ack
437 #[derive(Clone, Debug, PartialEq, Eq)]
438 pub struct RevokeAndACK {
440 pub channel_id: [u8; 32],
441 /// The secret corresponding to the per-commitment point
442 pub per_commitment_secret: [u8; 32],
443 /// The next sender-broadcast commitment transaction's per-commitment point
444 pub next_per_commitment_point: PublicKey,
446 /// Musig nonce the recipient should use in their next commitment signature message
447 pub next_local_nonce: Option<musig2::types::PublicNonce>
450 /// An [`update_fee`] message to be sent to or received from a peer
452 /// [`update_fee`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#updating-fees-update_fee
453 #[derive(Clone, Debug, PartialEq, Eq)]
454 pub struct UpdateFee {
456 pub channel_id: [u8; 32],
457 /// Fee rate per 1000-weight of the transaction
458 pub feerate_per_kw: u32,
461 /// A [`channel_reestablish`] message to be sent to or received from a peer.
463 /// [`channel_reestablish`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#message-retransmission
464 #[derive(Clone, Debug, PartialEq, Eq)]
465 pub struct ChannelReestablish {
467 pub channel_id: [u8; 32],
468 /// The next commitment number for the sender
469 pub next_local_commitment_number: u64,
470 /// The next commitment number for the recipient
471 pub next_remote_commitment_number: u64,
472 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
473 /// belonging to the recipient
474 pub your_last_per_commitment_secret: [u8; 32],
475 /// The sender's per-commitment point for their current commitment transaction
476 pub my_current_per_commitment_point: PublicKey,
479 /// An [`announcement_signatures`] message to be sent to or received from a peer.
481 /// [`announcement_signatures`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-announcement_signatures-message
482 #[derive(Clone, Debug, PartialEq, Eq)]
483 pub struct AnnouncementSignatures {
485 pub channel_id: [u8; 32],
486 /// The short channel ID
487 pub short_channel_id: u64,
488 /// A signature by the node key
489 pub node_signature: Signature,
490 /// A signature by the funding key
491 pub bitcoin_signature: Signature,
494 /// An address which can be used to connect to a remote peer.
495 #[derive(Clone, Debug, PartialEq, Eq)]
496 pub enum NetAddress {
497 /// An IPv4 address/port on which the peer is listening.
499 /// The 4-byte IPv4 address
501 /// The port on which the node is listening
504 /// An IPv6 address/port on which the peer is listening.
506 /// The 16-byte IPv6 address
508 /// The port on which the node is listening
511 /// An old-style Tor onion address/port on which the peer is listening.
513 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
514 /// addresses. Thus, the details are not parsed here.
516 /// A new-style Tor onion address/port on which the peer is listening.
518 /// To create the human-readable "hostname", concatenate the ED25519 pubkey, checksum, and version,
519 /// wrap as base32 and append ".onion".
521 /// The ed25519 long-term public key of the peer
522 ed25519_pubkey: [u8; 32],
523 /// The checksum of the pubkey and version, as included in the onion address
525 /// The version byte, as defined by the Tor Onion v3 spec.
527 /// The port on which the node is listening
530 /// A hostname/port on which the peer is listening.
532 /// The hostname on which the node is listening.
534 /// The port on which the node is listening.
539 /// Gets the ID of this address type. Addresses in [`NodeAnnouncement`] messages should be sorted
541 pub(crate) fn get_id(&self) -> u8 {
543 &NetAddress::IPv4 {..} => { 1 },
544 &NetAddress::IPv6 {..} => { 2 },
545 &NetAddress::OnionV2(_) => { 3 },
546 &NetAddress::OnionV3 {..} => { 4 },
547 &NetAddress::Hostname {..} => { 5 },
551 /// Strict byte-length of address descriptor, 1-byte type not recorded
552 fn len(&self) -> u16 {
554 &NetAddress::IPv4 { .. } => { 6 },
555 &NetAddress::IPv6 { .. } => { 18 },
556 &NetAddress::OnionV2(_) => { 12 },
557 &NetAddress::OnionV3 { .. } => { 37 },
558 // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
559 &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
563 /// The maximum length of any address descriptor, not including the 1-byte type.
564 /// This maximum length is reached by a hostname address descriptor:
565 /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
566 pub(crate) const MAX_LEN: u16 = 258;
569 impl Writeable for NetAddress {
570 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
572 &NetAddress::IPv4 { ref addr, ref port } => {
577 &NetAddress::IPv6 { ref addr, ref port } => {
582 &NetAddress::OnionV2(bytes) => {
584 bytes.write(writer)?;
586 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
588 ed25519_pubkey.write(writer)?;
589 checksum.write(writer)?;
590 version.write(writer)?;
593 &NetAddress::Hostname { ref hostname, ref port } => {
595 hostname.write(writer)?;
603 impl Readable for Result<NetAddress, u8> {
604 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
605 let byte = <u8 as Readable>::read(reader)?;
608 Ok(Ok(NetAddress::IPv4 {
609 addr: Readable::read(reader)?,
610 port: Readable::read(reader)?,
614 Ok(Ok(NetAddress::IPv6 {
615 addr: Readable::read(reader)?,
616 port: Readable::read(reader)?,
619 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
621 Ok(Ok(NetAddress::OnionV3 {
622 ed25519_pubkey: Readable::read(reader)?,
623 checksum: Readable::read(reader)?,
624 version: Readable::read(reader)?,
625 port: Readable::read(reader)?,
629 Ok(Ok(NetAddress::Hostname {
630 hostname: Readable::read(reader)?,
631 port: Readable::read(reader)?,
634 _ => return Ok(Err(byte)),
639 impl Readable for NetAddress {
640 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
641 match Readable::read(reader) {
642 Ok(Ok(res)) => Ok(res),
643 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
649 /// Represents the set of gossip messages that require a signature from a node's identity key.
650 pub enum UnsignedGossipMessage<'a> {
651 /// An unsigned channel announcement.
652 ChannelAnnouncement(&'a UnsignedChannelAnnouncement),
653 /// An unsigned channel update.
654 ChannelUpdate(&'a UnsignedChannelUpdate),
655 /// An unsigned node announcement.
656 NodeAnnouncement(&'a UnsignedNodeAnnouncement)
659 impl<'a> Writeable for UnsignedGossipMessage<'a> {
660 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
662 UnsignedGossipMessage::ChannelAnnouncement(ref msg) => msg.write(writer),
663 UnsignedGossipMessage::ChannelUpdate(ref msg) => msg.write(writer),
664 UnsignedGossipMessage::NodeAnnouncement(ref msg) => msg.write(writer),
669 /// The unsigned part of a [`node_announcement`] message.
671 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
672 #[derive(Clone, Debug, PartialEq, Eq)]
673 pub struct UnsignedNodeAnnouncement {
674 /// The advertised features
675 pub features: NodeFeatures,
676 /// A strictly monotonic announcement counter, with gaps allowed
678 /// The `node_id` this announcement originated from (don't rebroadcast the `node_announcement` back
681 /// An RGB color for UI purposes
683 /// An alias, for UI purposes.
685 /// This should be sanitized before use. There is no guarantee of uniqueness.
686 pub alias: NodeAlias,
687 /// List of addresses on which this node is reachable
688 pub addresses: Vec<NetAddress>,
689 pub(crate) excess_address_data: Vec<u8>,
690 pub(crate) excess_data: Vec<u8>,
692 #[derive(Clone, Debug, PartialEq, Eq)]
693 /// A [`node_announcement`] message to be sent to or received from a peer.
695 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
696 pub struct NodeAnnouncement {
697 /// The signature by the node key
698 pub signature: Signature,
699 /// The actual content of the announcement
700 pub contents: UnsignedNodeAnnouncement,
703 /// The unsigned part of a [`channel_announcement`] message.
705 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
706 #[derive(Clone, Debug, PartialEq, Eq)]
707 pub struct UnsignedChannelAnnouncement {
708 /// The advertised channel features
709 pub features: ChannelFeatures,
710 /// The genesis hash of the blockchain where the channel is to be opened
711 pub chain_hash: BlockHash,
712 /// The short channel ID
713 pub short_channel_id: u64,
714 /// One of the two `node_id`s which are endpoints of this channel
715 pub node_id_1: NodeId,
716 /// The other of the two `node_id`s which are endpoints of this channel
717 pub node_id_2: NodeId,
718 /// The funding key for the first node
719 pub bitcoin_key_1: NodeId,
720 /// The funding key for the second node
721 pub bitcoin_key_2: NodeId,
722 pub(crate) excess_data: Vec<u8>,
724 /// A [`channel_announcement`] message to be sent to or received from a peer.
726 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
727 #[derive(Clone, Debug, PartialEq, Eq)]
728 pub struct ChannelAnnouncement {
729 /// Authentication of the announcement by the first public node
730 pub node_signature_1: Signature,
731 /// Authentication of the announcement by the second public node
732 pub node_signature_2: Signature,
733 /// Proof of funding UTXO ownership by the first public node
734 pub bitcoin_signature_1: Signature,
735 /// Proof of funding UTXO ownership by the second public node
736 pub bitcoin_signature_2: Signature,
737 /// The actual announcement
738 pub contents: UnsignedChannelAnnouncement,
741 /// The unsigned part of a [`channel_update`] message.
743 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
744 #[derive(Clone, Debug, PartialEq, Eq)]
745 pub struct UnsignedChannelUpdate {
746 /// The genesis hash of the blockchain where the channel is to be opened
747 pub chain_hash: BlockHash,
748 /// The short channel ID
749 pub short_channel_id: u64,
750 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
754 /// The number of blocks such that if:
755 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
756 /// then we need to fail the HTLC backwards. When forwarding an HTLC, `cltv_expiry_delta` determines
757 /// the outgoing HTLC's minimum `cltv_expiry` value -- so, if an incoming HTLC comes in with a
758 /// `cltv_expiry` of 100000, and the node we're forwarding to has a `cltv_expiry_delta` value of 10,
759 /// then we'll check that the outgoing HTLC's `cltv_expiry` value is at least 100010 before
760 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
761 /// constructing the route.
762 pub cltv_expiry_delta: u16,
763 /// The minimum HTLC size incoming to sender, in milli-satoshi
764 pub htlc_minimum_msat: u64,
765 /// The maximum HTLC value incoming to sender, in milli-satoshi.
767 /// This used to be optional.
768 pub htlc_maximum_msat: u64,
769 /// The base HTLC fee charged by sender, in milli-satoshi
770 pub fee_base_msat: u32,
771 /// The amount to fee multiplier, in micro-satoshi
772 pub fee_proportional_millionths: u32,
773 /// Excess data which was signed as a part of the message which we do not (yet) understand how
776 /// This is stored to ensure forward-compatibility as new fields are added to the lightning gossip protocol.
777 pub excess_data: Vec<u8>,
779 /// A [`channel_update`] message to be sent to or received from a peer.
781 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
782 #[derive(Clone, Debug, PartialEq, Eq)]
783 pub struct ChannelUpdate {
784 /// A signature of the channel update
785 pub signature: Signature,
786 /// The actual channel update
787 pub contents: UnsignedChannelUpdate,
790 /// A [`query_channel_range`] message is used to query a peer for channel
791 /// UTXOs in a range of blocks. The recipient of a query makes a best
792 /// effort to reply to the query using one or more [`ReplyChannelRange`]
795 /// [`query_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
796 #[derive(Clone, Debug, PartialEq, Eq)]
797 pub struct QueryChannelRange {
798 /// The genesis hash of the blockchain being queried
799 pub chain_hash: BlockHash,
800 /// The height of the first block for the channel UTXOs being queried
801 pub first_blocknum: u32,
802 /// The number of blocks to include in the query results
803 pub number_of_blocks: u32,
806 /// A [`reply_channel_range`] message is a reply to a [`QueryChannelRange`]
809 /// Multiple `reply_channel_range` messages can be sent in reply
810 /// to a single [`QueryChannelRange`] message. The query recipient makes a
811 /// best effort to respond based on their local network view which may
812 /// not be a perfect view of the network. The `short_channel_id`s in the
813 /// reply are encoded. We only support `encoding_type=0` uncompressed
814 /// serialization and do not support `encoding_type=1` zlib serialization.
816 /// [`reply_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
817 #[derive(Clone, Debug, PartialEq, Eq)]
818 pub struct ReplyChannelRange {
819 /// The genesis hash of the blockchain being queried
820 pub chain_hash: BlockHash,
821 /// The height of the first block in the range of the reply
822 pub first_blocknum: u32,
823 /// The number of blocks included in the range of the reply
824 pub number_of_blocks: u32,
825 /// True when this is the final reply for a query
826 pub sync_complete: bool,
827 /// The `short_channel_id`s in the channel range
828 pub short_channel_ids: Vec<u64>,
831 /// A [`query_short_channel_ids`] message is used to query a peer for
832 /// routing gossip messages related to one or more `short_channel_id`s.
834 /// The query recipient will reply with the latest, if available,
835 /// [`ChannelAnnouncement`], [`ChannelUpdate`] and [`NodeAnnouncement`] messages
836 /// it maintains for the requested `short_channel_id`s followed by a
837 /// [`ReplyShortChannelIdsEnd`] message. The `short_channel_id`s sent in
838 /// this query are encoded. We only support `encoding_type=0` uncompressed
839 /// serialization and do not support `encoding_type=1` zlib serialization.
841 /// [`query_short_channel_ids`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_short_channel_idsreply_short_channel_ids_end-messages
842 #[derive(Clone, Debug, PartialEq, Eq)]
843 pub struct QueryShortChannelIds {
844 /// The genesis hash of the blockchain being queried
845 pub chain_hash: BlockHash,
846 /// The short_channel_ids that are being queried
847 pub short_channel_ids: Vec<u64>,
850 /// A [`reply_short_channel_ids_end`] message is sent as a reply to a
851 /// message. The query recipient makes a best
852 /// effort to respond based on their local network view which may not be
853 /// a perfect view of the network.
855 /// [`reply_short_channel_ids_end`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_short_channel_idsreply_short_channel_ids_end-messages
856 #[derive(Clone, Debug, PartialEq, Eq)]
857 pub struct ReplyShortChannelIdsEnd {
858 /// The genesis hash of the blockchain that was queried
859 pub chain_hash: BlockHash,
860 /// Indicates if the query recipient maintains up-to-date channel
861 /// information for the `chain_hash`
862 pub full_information: bool,
865 /// A [`gossip_timestamp_filter`] message is used by a node to request
866 /// gossip relay for messages in the requested time range when the
867 /// `gossip_queries` feature has been negotiated.
869 /// [`gossip_timestamp_filter`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-gossip_timestamp_filter-message
870 #[derive(Clone, Debug, PartialEq, Eq)]
871 pub struct GossipTimestampFilter {
872 /// The genesis hash of the blockchain for channel and node information
873 pub chain_hash: BlockHash,
874 /// The starting unix timestamp
875 pub first_timestamp: u32,
876 /// The range of information in seconds
877 pub timestamp_range: u32,
880 /// Encoding type for data compression of collections in gossip queries.
882 /// We do not support `encoding_type=1` zlib serialization [defined in BOLT
883 /// #7](https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#query-messages).
888 /// Used to put an error message in a [`LightningError`].
889 #[derive(Clone, Debug)]
890 pub enum ErrorAction {
891 /// The peer took some action which made us think they were useless. Disconnect them.
893 /// An error message which we should make an effort to send before we disconnect.
894 msg: Option<ErrorMessage>
896 /// The peer did something harmless that we weren't able to process, just log and ignore
897 // New code should *not* use this. New code must use IgnoreAndLog, below!
899 /// The peer did something harmless that we weren't able to meaningfully process.
900 /// If the error is logged, log it at the given level.
901 IgnoreAndLog(logger::Level),
902 /// The peer provided us with a gossip message which we'd already seen. In most cases this
903 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
904 /// our own channel announcements.
905 IgnoreDuplicateGossip,
906 /// The peer did something incorrect. Tell them.
908 /// The message to send.
911 /// The peer did something incorrect. Tell them without closing any channels.
913 /// The message to send.
915 /// The peer may have done something harmless that we weren't able to meaningfully process,
916 /// though we should still tell them about it.
917 /// If this event is logged, log it at the given level.
918 log_level: logger::Level,
922 /// An Err type for failure to process messages.
923 #[derive(Clone, Debug)]
924 pub struct LightningError {
925 /// A human-readable message describing the error
927 /// The action which should be taken against the offending peer.
928 pub action: ErrorAction,
931 /// Struct used to return values from [`RevokeAndACK`] messages, containing a bunch of commitment
932 /// transaction updates if they were pending.
933 #[derive(Clone, Debug, PartialEq, Eq)]
934 pub struct CommitmentUpdate {
935 /// `update_add_htlc` messages which should be sent
936 pub update_add_htlcs: Vec<UpdateAddHTLC>,
937 /// `update_fulfill_htlc` messages which should be sent
938 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
939 /// `update_fail_htlc` messages which should be sent
940 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
941 /// `update_fail_malformed_htlc` messages which should be sent
942 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
943 /// An `update_fee` message which should be sent
944 pub update_fee: Option<UpdateFee>,
945 /// A `commitment_signed` message which should be sent
946 pub commitment_signed: CommitmentSigned,
949 /// Messages could have optional fields to use with extended features
950 /// As we wish to serialize these differently from `Option<T>`s (`Options` get a tag byte, but
951 /// [`OptionalField`] simply gets `Present` if there are enough bytes to read into it), we have a
952 /// separate enum type for them.
954 /// This is not exported to bindings users due to a free generic in `T`
955 #[derive(Clone, Debug, PartialEq, Eq)]
956 pub enum OptionalField<T> {
957 /// Optional field is included in message
959 /// Optional field is absent in message
963 /// A trait to describe an object which can receive channel messages.
965 /// Messages MAY be called in parallel when they originate from different `their_node_ids`, however
966 /// they MUST NOT be called in parallel when the two calls have the same `their_node_id`.
967 pub trait ChannelMessageHandler : MessageSendEventsProvider {
969 /// Handle an incoming `open_channel` message from the given peer.
970 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel);
971 /// Handle an incoming `accept_channel` message from the given peer.
972 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel);
973 /// Handle an incoming `funding_created` message from the given peer.
974 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
975 /// Handle an incoming `funding_signed` message from the given peer.
976 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
977 /// Handle an incoming `channel_ready` message from the given peer.
978 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
981 /// Handle an incoming `shutdown` message from the given peer.
982 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
983 /// Handle an incoming `closing_signed` message from the given peer.
984 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
987 /// Handle an incoming `update_add_htlc` message from the given peer.
988 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
989 /// Handle an incoming `update_fulfill_htlc` message from the given peer.
990 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
991 /// Handle an incoming `update_fail_htlc` message from the given peer.
992 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
993 /// Handle an incoming `update_fail_malformed_htlc` message from the given peer.
994 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
995 /// Handle an incoming `commitment_signed` message from the given peer.
996 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
997 /// Handle an incoming `revoke_and_ack` message from the given peer.
998 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
1000 /// Handle an incoming `update_fee` message from the given peer.
1001 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
1003 // Channel-to-announce:
1004 /// Handle an incoming `announcement_signatures` message from the given peer.
1005 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
1007 // Connection loss/reestablish:
1008 /// Indicates a connection to the peer failed/an existing connection was lost.
1009 fn peer_disconnected(&self, their_node_id: &PublicKey);
1011 /// Handle a peer reconnecting, possibly generating `channel_reestablish` message(s).
1013 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1014 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1015 /// message handlers may still wish to communicate with this peer.
1016 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init, inbound: bool) -> Result<(), ()>;
1017 /// Handle an incoming `channel_reestablish` message from the given peer.
1018 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
1020 /// Handle an incoming `channel_update` message from the given peer.
1021 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
1024 /// Handle an incoming `error` message from the given peer.
1025 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
1027 // Handler information:
1028 /// Gets the node feature flags which this handler itself supports. All available handlers are
1029 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1030 /// which are broadcasted in our [`NodeAnnouncement`] message.
1031 fn provided_node_features(&self) -> NodeFeatures;
1033 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1034 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1035 /// which are sent in our [`Init`] message.
1037 /// Note that this method is called before [`Self::peer_connected`].
1038 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1041 /// A trait to describe an object which can receive routing messages.
1043 /// # Implementor DoS Warnings
1045 /// For messages enabled with the `gossip_queries` feature there are potential DoS vectors when
1046 /// handling inbound queries. Implementors using an on-disk network graph should be aware of
1047 /// repeated disk I/O for queries accessing different parts of the network graph.
1048 pub trait RoutingMessageHandler : MessageSendEventsProvider {
1049 /// Handle an incoming `node_announcement` message, returning `true` if it should be forwarded on,
1050 /// `false` or returning an `Err` otherwise.
1051 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
1052 /// Handle a `channel_announcement` message, returning `true` if it should be forwarded on, `false`
1053 /// or returning an `Err` otherwise.
1054 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
1055 /// Handle an incoming `channel_update` message, returning true if it should be forwarded on,
1056 /// `false` or returning an `Err` otherwise.
1057 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
1058 /// Gets channel announcements and updates required to dump our routing table to a remote node,
1059 /// starting at the `short_channel_id` indicated by `starting_point` and including announcements
1060 /// for a single channel.
1061 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
1062 /// Gets a node announcement required to dump our routing table to a remote node, starting at
1063 /// the node *after* the provided pubkey and including up to one announcement immediately
1064 /// higher (as defined by `<PublicKey as Ord>::cmp`) than `starting_point`.
1065 /// If `None` is provided for `starting_point`, we start at the first node.
1066 fn get_next_node_announcement(&self, starting_point: Option<&NodeId>) -> Option<NodeAnnouncement>;
1067 /// Called when a connection is established with a peer. This can be used to
1068 /// perform routing table synchronization using a strategy defined by the
1071 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1072 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1073 /// message handlers may still wish to communicate with this peer.
1074 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init, inbound: bool) -> Result<(), ()>;
1075 /// Handles the reply of a query we initiated to learn about channels
1076 /// for a given range of blocks. We can expect to receive one or more
1077 /// replies to a single query.
1078 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
1079 /// Handles the reply of a query we initiated asking for routing gossip
1080 /// messages for a list of channels. We should receive this message when
1081 /// a node has completed its best effort to send us the pertaining routing
1082 /// gossip messages.
1083 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
1084 /// Handles when a peer asks us to send a list of `short_channel_id`s
1085 /// for the requested range of blocks.
1086 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
1087 /// Handles when a peer asks us to send routing gossip messages for a
1088 /// list of `short_channel_id`s.
1089 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
1091 // Handler queueing status:
1092 /// Indicates that there are a large number of [`ChannelAnnouncement`] (or other) messages
1093 /// pending some async action. While there is no guarantee of the rate of future messages, the
1094 /// caller should seek to reduce the rate of new gossip messages handled, especially
1095 /// [`ChannelAnnouncement`]s.
1096 fn processing_queue_high(&self) -> bool;
1098 // Handler information:
1099 /// Gets the node feature flags which this handler itself supports. All available handlers are
1100 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1101 /// which are broadcasted in our [`NodeAnnouncement`] message.
1102 fn provided_node_features(&self) -> NodeFeatures;
1103 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1104 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1105 /// which are sent in our [`Init`] message.
1107 /// Note that this method is called before [`Self::peer_connected`].
1108 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1111 /// A trait to describe an object that can receive onion messages.
1112 pub trait OnionMessageHandler : OnionMessageProvider {
1113 /// Handle an incoming `onion_message` message from the given peer.
1114 fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
1115 /// Called when a connection is established with a peer. Can be used to track which peers
1116 /// advertise onion message support and are online.
1118 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1119 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1120 /// message handlers may still wish to communicate with this peer.
1121 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init, inbound: bool) -> Result<(), ()>;
1122 /// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
1123 /// drop and refuse to forward onion messages to this peer.
1124 fn peer_disconnected(&self, their_node_id: &PublicKey);
1126 // Handler information:
1127 /// Gets the node feature flags which this handler itself supports. All available handlers are
1128 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1129 /// which are broadcasted in our [`NodeAnnouncement`] message.
1130 fn provided_node_features(&self) -> NodeFeatures;
1132 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1133 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1134 /// which are sent in our [`Init`] message.
1136 /// Note that this method is called before [`Self::peer_connected`].
1137 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1140 mod fuzzy_internal_msgs {
1141 use crate::prelude::*;
1142 use crate::ln::{PaymentPreimage, PaymentSecret};
1144 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1145 // them from untrusted input):
1147 pub(crate) struct FinalOnionHopData {
1148 pub(crate) payment_secret: PaymentSecret,
1149 /// The total value, in msat, of the payment as received by the ultimate recipient.
1150 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1151 pub(crate) total_msat: u64,
1154 pub(crate) enum OnionHopDataFormat {
1156 short_channel_id: u64,
1159 payment_data: Option<FinalOnionHopData>,
1160 payment_metadata: Option<Vec<u8>>,
1161 keysend_preimage: Option<PaymentPreimage>,
1165 pub struct OnionHopData {
1166 pub(crate) format: OnionHopDataFormat,
1167 /// The value, in msat, of the payment after this hop's fee is deducted.
1168 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1169 pub(crate) amt_to_forward: u64,
1170 pub(crate) outgoing_cltv_value: u32,
1173 pub struct DecodedOnionErrorPacket {
1174 pub(crate) hmac: [u8; 32],
1175 pub(crate) failuremsg: Vec<u8>,
1176 pub(crate) pad: Vec<u8>,
1180 pub use self::fuzzy_internal_msgs::*;
1181 #[cfg(not(fuzzing))]
1182 pub(crate) use self::fuzzy_internal_msgs::*;
1185 pub(crate) struct OnionPacket {
1186 pub(crate) version: u8,
1187 /// In order to ensure we always return an error on onion decode in compliance with [BOLT
1188 /// #4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md), we have to
1189 /// deserialize `OnionPacket`s contained in [`UpdateAddHTLC`] messages even if the ephemeral
1190 /// public key (here) is bogus, so we hold a [`Result`] instead of a [`PublicKey`] as we'd
1192 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
1193 pub(crate) hop_data: [u8; 20*65],
1194 pub(crate) hmac: [u8; 32],
1197 impl onion_utils::Packet for OnionPacket {
1198 type Data = onion_utils::FixedSizeOnionPacket;
1199 fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1202 public_key: Ok(pubkey),
1203 hop_data: hop_data.0,
1209 impl Eq for OnionPacket { }
1210 impl PartialEq for OnionPacket {
1211 fn eq(&self, other: &OnionPacket) -> bool {
1212 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
1213 if i != j { return false; }
1215 self.version == other.version &&
1216 self.public_key == other.public_key &&
1217 self.hmac == other.hmac
1221 impl fmt::Debug for OnionPacket {
1222 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1223 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1227 #[derive(Clone, Debug, PartialEq, Eq)]
1228 pub(crate) struct OnionErrorPacket {
1229 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1230 // (TODO) We limit it in decode to much lower...
1231 pub(crate) data: Vec<u8>,
1234 impl fmt::Display for DecodeError {
1235 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1237 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1238 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1239 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1240 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1241 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1242 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1243 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1248 impl From<io::Error> for DecodeError {
1249 fn from(e: io::Error) -> Self {
1250 if e.kind() == io::ErrorKind::UnexpectedEof {
1251 DecodeError::ShortRead
1253 DecodeError::Io(e.kind())
1258 impl Writeable for OptionalField<Script> {
1259 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1261 OptionalField::Present(ref script) => {
1262 // Note that Writeable for script includes the 16-bit length tag for us
1265 OptionalField::Absent => {}
1271 impl Readable for OptionalField<Script> {
1272 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1273 match <u16 as Readable>::read(r) {
1275 let mut buf = vec![0; len as usize];
1276 r.read_exact(&mut buf)?;
1277 Ok(OptionalField::Present(Script::from(buf)))
1279 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1285 impl Writeable for OptionalField<u64> {
1286 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1288 OptionalField::Present(ref value) => {
1291 OptionalField::Absent => {}
1297 impl Readable for OptionalField<u64> {
1298 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1299 let value: u64 = Readable::read(r)?;
1300 Ok(OptionalField::Present(value))
1304 #[cfg(not(taproot))]
1305 impl_writeable_msg!(AcceptChannel, {
1306 temporary_channel_id,
1307 dust_limit_satoshis,
1308 max_htlc_value_in_flight_msat,
1309 channel_reserve_satoshis,
1315 revocation_basepoint,
1317 delayed_payment_basepoint,
1319 first_per_commitment_point,
1320 shutdown_scriptpubkey
1322 (1, channel_type, option),
1326 impl_writeable_msg!(AcceptChannel, {
1327 temporary_channel_id,
1328 dust_limit_satoshis,
1329 max_htlc_value_in_flight_msat,
1330 channel_reserve_satoshis,
1336 revocation_basepoint,
1338 delayed_payment_basepoint,
1340 first_per_commitment_point,
1341 shutdown_scriptpubkey
1343 (1, channel_type, option),
1344 (4, next_local_nonce, option),
1347 impl_writeable_msg!(AnnouncementSignatures, {
1354 impl_writeable_msg!(ChannelReestablish, {
1356 next_local_commitment_number,
1357 next_remote_commitment_number,
1358 your_last_per_commitment_secret,
1359 my_current_per_commitment_point,
1362 impl_writeable_msg!(ClosingSigned,
1363 { channel_id, fee_satoshis, signature },
1364 { (1, fee_range, option) }
1367 impl_writeable!(ClosingSignedFeeRange, {
1372 #[cfg(not(taproot))]
1373 impl_writeable_msg!(CommitmentSigned, {
1380 impl_writeable_msg!(CommitmentSigned, {
1385 (2, partial_signature_with_nonce, option)
1388 impl_writeable!(DecodedOnionErrorPacket, {
1394 #[cfg(not(taproot))]
1395 impl_writeable_msg!(FundingCreated, {
1396 temporary_channel_id,
1398 funding_output_index,
1402 impl_writeable_msg!(FundingCreated, {
1403 temporary_channel_id,
1405 funding_output_index,
1408 (2, partial_signature_with_nonce, option),
1409 (4, next_local_nonce, option)
1412 #[cfg(not(taproot))]
1413 impl_writeable_msg!(FundingSigned, {
1419 impl_writeable_msg!(FundingSigned, {
1423 (2, partial_signature_with_nonce, option)
1426 impl_writeable_msg!(ChannelReady, {
1428 next_per_commitment_point,
1430 (1, short_channel_id_alias, option),
1433 impl Writeable for Init {
1434 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1435 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1436 // our relevant feature bits. This keeps us compatible with old nodes.
1437 self.features.write_up_to_13(w)?;
1438 self.features.write(w)?;
1439 encode_tlv_stream!(w, {
1440 (3, self.remote_network_address, option)
1446 impl Readable for Init {
1447 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1448 let global_features: InitFeatures = Readable::read(r)?;
1449 let features: InitFeatures = Readable::read(r)?;
1450 let mut remote_network_address: Option<NetAddress> = None;
1451 decode_tlv_stream!(r, {
1452 (3, remote_network_address, option)
1455 features: features.or(global_features),
1456 remote_network_address,
1461 impl_writeable_msg!(OpenChannel, {
1463 temporary_channel_id,
1466 dust_limit_satoshis,
1467 max_htlc_value_in_flight_msat,
1468 channel_reserve_satoshis,
1474 revocation_basepoint,
1476 delayed_payment_basepoint,
1478 first_per_commitment_point,
1480 shutdown_scriptpubkey
1482 (1, channel_type, option),
1485 #[cfg(not(taproot))]
1486 impl_writeable_msg!(RevokeAndACK, {
1488 per_commitment_secret,
1489 next_per_commitment_point
1493 impl_writeable_msg!(RevokeAndACK, {
1495 per_commitment_secret,
1496 next_per_commitment_point
1498 (4, next_local_nonce, option)
1501 impl_writeable_msg!(Shutdown, {
1506 impl_writeable_msg!(UpdateFailHTLC, {
1512 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1519 impl_writeable_msg!(UpdateFee, {
1524 impl_writeable_msg!(UpdateFulfillHTLC, {
1530 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1531 // serialization format in a way which assumes we know the total serialized length/message end
1533 impl_writeable!(OnionErrorPacket, {
1537 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1538 // serialization format in a way which assumes we know the total serialized length/message end
1540 impl Writeable for OnionPacket {
1541 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1542 self.version.write(w)?;
1543 match self.public_key {
1544 Ok(pubkey) => pubkey.write(w)?,
1545 Err(_) => [0u8;33].write(w)?,
1547 w.write_all(&self.hop_data)?;
1548 self.hmac.write(w)?;
1553 impl Readable for OnionPacket {
1554 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1556 version: Readable::read(r)?,
1558 let mut buf = [0u8;33];
1559 r.read_exact(&mut buf)?;
1560 PublicKey::from_slice(&buf)
1562 hop_data: Readable::read(r)?,
1563 hmac: Readable::read(r)?,
1568 impl_writeable_msg!(UpdateAddHTLC, {
1574 onion_routing_packet
1577 impl Readable for OnionMessage {
1578 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1579 let blinding_point: PublicKey = Readable::read(r)?;
1580 let len: u16 = Readable::read(r)?;
1581 let mut packet_reader = FixedLengthReader::new(r, len as u64);
1582 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
1585 onion_routing_packet,
1590 impl Writeable for OnionMessage {
1591 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1592 self.blinding_point.write(w)?;
1593 let onion_packet_len = self.onion_routing_packet.serialized_length();
1594 (onion_packet_len as u16).write(w)?;
1595 self.onion_routing_packet.write(w)?;
1600 impl Writeable for FinalOnionHopData {
1601 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1602 self.payment_secret.0.write(w)?;
1603 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
1607 impl Readable for FinalOnionHopData {
1608 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1609 let secret: [u8; 32] = Readable::read(r)?;
1610 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
1611 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1615 impl Writeable for OnionHopData {
1616 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1618 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1619 _encode_varint_length_prefixed_tlv!(w, {
1620 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1621 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1622 (6, short_channel_id, required)
1625 OnionHopDataFormat::FinalNode { ref payment_data, ref payment_metadata, ref keysend_preimage } => {
1626 _encode_varint_length_prefixed_tlv!(w, {
1627 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1628 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1629 (8, payment_data, option),
1630 (16, payment_metadata.as_ref().map(|m| WithoutLength(m)), option),
1631 (5482373484, keysend_preimage, option)
1639 impl Readable for OnionHopData {
1640 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1641 let mut amt = HighZeroBytesDroppedBigSize(0u64);
1642 let mut cltv_value = HighZeroBytesDroppedBigSize(0u32);
1643 let mut short_id: Option<u64> = None;
1644 let mut payment_data: Option<FinalOnionHopData> = None;
1645 let mut payment_metadata: Option<WithoutLength<Vec<u8>>> = None;
1646 let mut keysend_preimage: Option<PaymentPreimage> = None;
1647 read_tlv_fields!(r, {
1649 (4, cltv_value, required),
1650 (6, short_id, option),
1651 (8, payment_data, option),
1652 (16, payment_metadata, option),
1653 // See https://github.com/lightning/blips/blob/master/blip-0003.md
1654 (5482373484, keysend_preimage, option)
1657 let format = if let Some(short_channel_id) = short_id {
1658 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1659 if payment_metadata.is_some() { return Err(DecodeError::InvalidValue); }
1660 OnionHopDataFormat::NonFinalNode {
1664 if let Some(data) = &payment_data {
1665 if data.total_msat > MAX_VALUE_MSAT {
1666 return Err(DecodeError::InvalidValue);
1669 OnionHopDataFormat::FinalNode {
1671 payment_metadata: payment_metadata.map(|w| w.0),
1676 if amt.0 > MAX_VALUE_MSAT {
1677 return Err(DecodeError::InvalidValue);
1681 amt_to_forward: amt.0,
1682 outgoing_cltv_value: cltv_value.0,
1687 // ReadableArgs because we need onion_utils::decode_next_hop to accommodate payment packets and
1688 // onion message packets.
1689 impl ReadableArgs<()> for OnionHopData {
1690 fn read<R: Read>(r: &mut R, _arg: ()) -> Result<Self, DecodeError> {
1691 <Self as Readable>::read(r)
1695 impl Writeable for Ping {
1696 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1697 self.ponglen.write(w)?;
1698 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1703 impl Readable for Ping {
1704 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1706 ponglen: Readable::read(r)?,
1708 let byteslen = Readable::read(r)?;
1709 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1716 impl Writeable for Pong {
1717 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1718 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1723 impl Readable for Pong {
1724 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1727 let byteslen = Readable::read(r)?;
1728 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1735 impl Writeable for UnsignedChannelAnnouncement {
1736 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1737 self.features.write(w)?;
1738 self.chain_hash.write(w)?;
1739 self.short_channel_id.write(w)?;
1740 self.node_id_1.write(w)?;
1741 self.node_id_2.write(w)?;
1742 self.bitcoin_key_1.write(w)?;
1743 self.bitcoin_key_2.write(w)?;
1744 w.write_all(&self.excess_data[..])?;
1749 impl Readable for UnsignedChannelAnnouncement {
1750 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1752 features: Readable::read(r)?,
1753 chain_hash: Readable::read(r)?,
1754 short_channel_id: Readable::read(r)?,
1755 node_id_1: Readable::read(r)?,
1756 node_id_2: Readable::read(r)?,
1757 bitcoin_key_1: Readable::read(r)?,
1758 bitcoin_key_2: Readable::read(r)?,
1759 excess_data: read_to_end(r)?,
1764 impl_writeable!(ChannelAnnouncement, {
1767 bitcoin_signature_1,
1768 bitcoin_signature_2,
1772 impl Writeable for UnsignedChannelUpdate {
1773 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1774 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
1775 const MESSAGE_FLAGS: u8 = 1;
1776 self.chain_hash.write(w)?;
1777 self.short_channel_id.write(w)?;
1778 self.timestamp.write(w)?;
1779 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
1780 all_flags.write(w)?;
1781 self.cltv_expiry_delta.write(w)?;
1782 self.htlc_minimum_msat.write(w)?;
1783 self.fee_base_msat.write(w)?;
1784 self.fee_proportional_millionths.write(w)?;
1785 self.htlc_maximum_msat.write(w)?;
1786 w.write_all(&self.excess_data[..])?;
1791 impl Readable for UnsignedChannelUpdate {
1792 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1794 chain_hash: Readable::read(r)?,
1795 short_channel_id: Readable::read(r)?,
1796 timestamp: Readable::read(r)?,
1798 let flags: u16 = Readable::read(r)?;
1799 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
1802 cltv_expiry_delta: Readable::read(r)?,
1803 htlc_minimum_msat: Readable::read(r)?,
1804 fee_base_msat: Readable::read(r)?,
1805 fee_proportional_millionths: Readable::read(r)?,
1806 htlc_maximum_msat: Readable::read(r)?,
1807 excess_data: read_to_end(r)?,
1812 impl_writeable!(ChannelUpdate, {
1817 impl Writeable for ErrorMessage {
1818 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1819 self.channel_id.write(w)?;
1820 (self.data.len() as u16).write(w)?;
1821 w.write_all(self.data.as_bytes())?;
1826 impl Readable for ErrorMessage {
1827 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1829 channel_id: Readable::read(r)?,
1831 let sz: usize = <u16 as Readable>::read(r)? as usize;
1832 let mut data = Vec::with_capacity(sz);
1834 r.read_exact(&mut data)?;
1835 match String::from_utf8(data) {
1837 Err(_) => return Err(DecodeError::InvalidValue),
1844 impl Writeable for WarningMessage {
1845 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1846 self.channel_id.write(w)?;
1847 (self.data.len() as u16).write(w)?;
1848 w.write_all(self.data.as_bytes())?;
1853 impl Readable for WarningMessage {
1854 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1856 channel_id: Readable::read(r)?,
1858 let sz: usize = <u16 as Readable>::read(r)? as usize;
1859 let mut data = Vec::with_capacity(sz);
1861 r.read_exact(&mut data)?;
1862 match String::from_utf8(data) {
1864 Err(_) => return Err(DecodeError::InvalidValue),
1871 impl Writeable for UnsignedNodeAnnouncement {
1872 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1873 self.features.write(w)?;
1874 self.timestamp.write(w)?;
1875 self.node_id.write(w)?;
1876 w.write_all(&self.rgb)?;
1877 self.alias.write(w)?;
1879 let mut addr_len = 0;
1880 for addr in self.addresses.iter() {
1881 addr_len += 1 + addr.len();
1883 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1884 for addr in self.addresses.iter() {
1887 w.write_all(&self.excess_address_data[..])?;
1888 w.write_all(&self.excess_data[..])?;
1893 impl Readable for UnsignedNodeAnnouncement {
1894 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1895 let features: NodeFeatures = Readable::read(r)?;
1896 let timestamp: u32 = Readable::read(r)?;
1897 let node_id: NodeId = Readable::read(r)?;
1898 let mut rgb = [0; 3];
1899 r.read_exact(&mut rgb)?;
1900 let alias: NodeAlias = Readable::read(r)?;
1902 let addr_len: u16 = Readable::read(r)?;
1903 let mut addresses: Vec<NetAddress> = Vec::new();
1904 let mut addr_readpos = 0;
1905 let mut excess = false;
1906 let mut excess_byte = 0;
1908 if addr_len <= addr_readpos { break; }
1909 match Readable::read(r) {
1911 if addr_len < addr_readpos + 1 + addr.len() {
1912 return Err(DecodeError::BadLengthDescriptor);
1914 addr_readpos += (1 + addr.len()) as u16;
1915 addresses.push(addr);
1917 Ok(Err(unknown_descriptor)) => {
1919 excess_byte = unknown_descriptor;
1922 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1923 Err(e) => return Err(e),
1927 let mut excess_data = vec![];
1928 let excess_address_data = if addr_readpos < addr_len {
1929 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1930 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1932 excess_address_data[0] = excess_byte;
1937 excess_data.push(excess_byte);
1941 excess_data.extend(read_to_end(r)?.iter());
1942 Ok(UnsignedNodeAnnouncement {
1949 excess_address_data,
1955 impl_writeable!(NodeAnnouncement, {
1960 impl Readable for QueryShortChannelIds {
1961 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1962 let chain_hash: BlockHash = Readable::read(r)?;
1964 let encoding_len: u16 = Readable::read(r)?;
1965 let encoding_type: u8 = Readable::read(r)?;
1967 // Must be encoding_type=0 uncompressed serialization. We do not
1968 // support encoding_type=1 zlib serialization.
1969 if encoding_type != EncodingType::Uncompressed as u8 {
1970 return Err(DecodeError::UnsupportedCompression);
1973 // We expect the encoding_len to always includes the 1-byte
1974 // encoding_type and that short_channel_ids are 8-bytes each
1975 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1976 return Err(DecodeError::InvalidValue);
1979 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1980 // less the 1-byte encoding_type
1981 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1982 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1983 for _ in 0..short_channel_id_count {
1984 short_channel_ids.push(Readable::read(r)?);
1987 Ok(QueryShortChannelIds {
1994 impl Writeable for QueryShortChannelIds {
1995 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1996 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1997 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1999 self.chain_hash.write(w)?;
2000 encoding_len.write(w)?;
2002 // We only support type=0 uncompressed serialization
2003 (EncodingType::Uncompressed as u8).write(w)?;
2005 for scid in self.short_channel_ids.iter() {
2013 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
2018 impl QueryChannelRange {
2019 /// Calculates the overflow safe ending block height for the query.
2021 /// Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`.
2022 pub fn end_blocknum(&self) -> u32 {
2023 match self.first_blocknum.checked_add(self.number_of_blocks) {
2024 Some(block) => block,
2025 None => u32::max_value(),
2030 impl_writeable_msg!(QueryChannelRange, {
2036 impl Readable for ReplyChannelRange {
2037 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2038 let chain_hash: BlockHash = Readable::read(r)?;
2039 let first_blocknum: u32 = Readable::read(r)?;
2040 let number_of_blocks: u32 = Readable::read(r)?;
2041 let sync_complete: bool = Readable::read(r)?;
2043 let encoding_len: u16 = Readable::read(r)?;
2044 let encoding_type: u8 = Readable::read(r)?;
2046 // Must be encoding_type=0 uncompressed serialization. We do not
2047 // support encoding_type=1 zlib serialization.
2048 if encoding_type != EncodingType::Uncompressed as u8 {
2049 return Err(DecodeError::UnsupportedCompression);
2052 // We expect the encoding_len to always includes the 1-byte
2053 // encoding_type and that short_channel_ids are 8-bytes each
2054 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2055 return Err(DecodeError::InvalidValue);
2058 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2059 // less the 1-byte encoding_type
2060 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2061 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2062 for _ in 0..short_channel_id_count {
2063 short_channel_ids.push(Readable::read(r)?);
2066 Ok(ReplyChannelRange {
2076 impl Writeable for ReplyChannelRange {
2077 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2078 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2079 self.chain_hash.write(w)?;
2080 self.first_blocknum.write(w)?;
2081 self.number_of_blocks.write(w)?;
2082 self.sync_complete.write(w)?;
2084 encoding_len.write(w)?;
2085 (EncodingType::Uncompressed as u8).write(w)?;
2086 for scid in self.short_channel_ids.iter() {
2094 impl_writeable_msg!(GossipTimestampFilter, {
2103 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
2104 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
2105 use crate::ln::msgs;
2106 use crate::ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
2107 use crate::routing::gossip::{NodeAlias, NodeId};
2108 use crate::util::ser::{Writeable, Readable, Hostname};
2110 use bitcoin::hashes::hex::FromHex;
2111 use bitcoin::util::address::Address;
2112 use bitcoin::network::constants::Network;
2113 use bitcoin::blockdata::script::Builder;
2114 use bitcoin::blockdata::opcodes;
2115 use bitcoin::hash_types::{Txid, BlockHash};
2117 use bitcoin::secp256k1::{PublicKey,SecretKey};
2118 use bitcoin::secp256k1::{Secp256k1, Message};
2120 use crate::io::{self, Cursor};
2121 use crate::prelude::*;
2122 use core::convert::TryFrom;
2125 fn encoding_channel_reestablish() {
2127 let secp_ctx = Secp256k1::new();
2128 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2131 let cr = msgs::ChannelReestablish {
2132 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],
2133 next_local_commitment_number: 3,
2134 next_remote_commitment_number: 4,
2135 your_last_per_commitment_secret: [9;32],
2136 my_current_per_commitment_point: public_key,
2139 let encoded_value = cr.encode();
2142 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]
2146 macro_rules! get_keys_from {
2147 ($slice: expr, $secp_ctx: expr) => {
2149 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
2150 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2156 macro_rules! get_sig_on {
2157 ($privkey: expr, $ctx: expr, $string: expr) => {
2159 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2160 $ctx.sign_ecdsa(&sighash, &$privkey)
2166 fn encoding_announcement_signatures() {
2167 let secp_ctx = Secp256k1::new();
2168 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2169 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2170 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2171 let announcement_signatures = msgs::AnnouncementSignatures {
2172 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],
2173 short_channel_id: 2316138423780173,
2174 node_signature: sig_1,
2175 bitcoin_signature: sig_2,
2178 let encoded_value = announcement_signatures.encode();
2179 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2182 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2183 let secp_ctx = Secp256k1::new();
2184 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2185 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2186 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2187 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2188 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2189 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2190 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2191 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2192 let mut features = ChannelFeatures::empty();
2193 if unknown_features_bits {
2194 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2196 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2198 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2199 short_channel_id: 2316138423780173,
2200 node_id_1: NodeId::from_pubkey(&pubkey_1),
2201 node_id_2: NodeId::from_pubkey(&pubkey_2),
2202 bitcoin_key_1: NodeId::from_pubkey(&pubkey_3),
2203 bitcoin_key_2: NodeId::from_pubkey(&pubkey_4),
2204 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
2206 let channel_announcement = msgs::ChannelAnnouncement {
2207 node_signature_1: sig_1,
2208 node_signature_2: sig_2,
2209 bitcoin_signature_1: sig_3,
2210 bitcoin_signature_2: sig_4,
2211 contents: unsigned_channel_announcement,
2213 let encoded_value = channel_announcement.encode();
2214 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
2215 if unknown_features_bits {
2216 target_value.append(&mut hex::decode("0002ffff").unwrap());
2218 target_value.append(&mut hex::decode("0000").unwrap());
2220 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2221 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
2223 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
2225 assert_eq!(encoded_value, target_value);
2229 fn encoding_channel_announcement() {
2230 do_encoding_channel_announcement(true, false);
2231 do_encoding_channel_announcement(false, true);
2232 do_encoding_channel_announcement(false, false);
2233 do_encoding_channel_announcement(true, true);
2236 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) {
2237 let secp_ctx = Secp256k1::new();
2238 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2239 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2240 let features = if unknown_features_bits {
2241 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2243 // Set to some features we may support
2244 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2246 let mut addresses = Vec::new();
2248 addresses.push(msgs::NetAddress::IPv4 {
2249 addr: [255, 254, 253, 252],
2254 addresses.push(msgs::NetAddress::IPv6 {
2255 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2260 addresses.push(msgs::NetAddress::OnionV2(
2261 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2265 addresses.push(msgs::NetAddress::OnionV3 {
2266 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],
2273 addresses.push(msgs::NetAddress::Hostname {
2274 hostname: Hostname::try_from(String::from("host")).unwrap(),
2278 let mut addr_len = 0;
2279 for addr in &addresses {
2280 addr_len += addr.len() + 1;
2282 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2284 timestamp: 20190119,
2285 node_id: NodeId::from_pubkey(&pubkey_1),
2287 alias: NodeAlias([16;32]),
2289 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() },
2290 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() },
2292 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2293 let node_announcement = msgs::NodeAnnouncement {
2295 contents: unsigned_node_announcement,
2297 let encoded_value = node_announcement.encode();
2298 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2299 if unknown_features_bits {
2300 target_value.append(&mut hex::decode("0002ffff").unwrap());
2302 target_value.append(&mut hex::decode("000122").unwrap());
2304 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2305 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2307 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2310 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2313 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2316 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2319 target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2321 if excess_address_data {
2322 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2325 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2327 assert_eq!(encoded_value, target_value);
2331 fn encoding_node_announcement() {
2332 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2333 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2334 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2335 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2336 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2337 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2338 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2339 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2340 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2341 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2344 fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
2345 let secp_ctx = Secp256k1::new();
2346 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2347 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2348 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2349 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2350 short_channel_id: 2316138423780173,
2351 timestamp: 20190119,
2352 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2353 cltv_expiry_delta: 144,
2354 htlc_minimum_msat: 1000000,
2355 htlc_maximum_msat: 131355275467161,
2356 fee_base_msat: 10000,
2357 fee_proportional_millionths: 20,
2358 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2360 let channel_update = msgs::ChannelUpdate {
2362 contents: unsigned_channel_update
2364 let encoded_value = channel_update.encode();
2365 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2366 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2367 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2368 target_value.append(&mut hex::decode("01").unwrap());
2369 target_value.append(&mut hex::decode("00").unwrap());
2371 let flag = target_value.last_mut().unwrap();
2375 let flag = target_value.last_mut().unwrap();
2376 *flag = *flag | 1 << 1;
2378 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2379 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2381 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2383 assert_eq!(encoded_value, target_value);
2387 fn encoding_channel_update() {
2388 do_encoding_channel_update(false, false, false);
2389 do_encoding_channel_update(false, false, true);
2390 do_encoding_channel_update(true, false, false);
2391 do_encoding_channel_update(true, false, true);
2392 do_encoding_channel_update(false, true, false);
2393 do_encoding_channel_update(false, true, true);
2394 do_encoding_channel_update(true, true, false);
2395 do_encoding_channel_update(true, true, true);
2398 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2399 let secp_ctx = Secp256k1::new();
2400 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2401 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2402 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2403 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2404 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2405 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2406 let open_channel = msgs::OpenChannel {
2407 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2408 temporary_channel_id: [2; 32],
2409 funding_satoshis: 1311768467284833366,
2410 push_msat: 2536655962884945560,
2411 dust_limit_satoshis: 3608586615801332854,
2412 max_htlc_value_in_flight_msat: 8517154655701053848,
2413 channel_reserve_satoshis: 8665828695742877976,
2414 htlc_minimum_msat: 2316138423780173,
2415 feerate_per_kw: 821716,
2416 to_self_delay: 49340,
2417 max_accepted_htlcs: 49340,
2418 funding_pubkey: pubkey_1,
2419 revocation_basepoint: pubkey_2,
2420 payment_point: pubkey_3,
2421 delayed_payment_basepoint: pubkey_4,
2422 htlc_basepoint: pubkey_5,
2423 first_per_commitment_point: pubkey_6,
2424 channel_flags: if random_bit { 1 << 5 } else { 0 },
2425 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2426 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2428 let encoded_value = open_channel.encode();
2429 let mut target_value = Vec::new();
2430 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2431 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2433 target_value.append(&mut hex::decode("20").unwrap());
2435 target_value.append(&mut hex::decode("00").unwrap());
2438 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2441 target_value.append(&mut hex::decode("0100").unwrap());
2443 assert_eq!(encoded_value, target_value);
2447 fn encoding_open_channel() {
2448 do_encoding_open_channel(false, false, false);
2449 do_encoding_open_channel(false, false, true);
2450 do_encoding_open_channel(false, true, false);
2451 do_encoding_open_channel(false, true, true);
2452 do_encoding_open_channel(true, false, false);
2453 do_encoding_open_channel(true, false, true);
2454 do_encoding_open_channel(true, true, false);
2455 do_encoding_open_channel(true, true, true);
2458 fn do_encoding_accept_channel(shutdown: bool) {
2459 let secp_ctx = Secp256k1::new();
2460 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2461 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2462 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2463 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2464 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2465 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2466 let accept_channel = msgs::AcceptChannel {
2467 temporary_channel_id: [2; 32],
2468 dust_limit_satoshis: 1311768467284833366,
2469 max_htlc_value_in_flight_msat: 2536655962884945560,
2470 channel_reserve_satoshis: 3608586615801332854,
2471 htlc_minimum_msat: 2316138423780173,
2472 minimum_depth: 821716,
2473 to_self_delay: 49340,
2474 max_accepted_htlcs: 49340,
2475 funding_pubkey: pubkey_1,
2476 revocation_basepoint: pubkey_2,
2477 payment_point: pubkey_3,
2478 delayed_payment_basepoint: pubkey_4,
2479 htlc_basepoint: pubkey_5,
2480 first_per_commitment_point: pubkey_6,
2481 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2484 next_local_nonce: None,
2486 let encoded_value = accept_channel.encode();
2487 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2489 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2491 assert_eq!(encoded_value, target_value);
2495 fn encoding_accept_channel() {
2496 do_encoding_accept_channel(false);
2497 do_encoding_accept_channel(true);
2501 fn encoding_funding_created() {
2502 let secp_ctx = Secp256k1::new();
2503 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2504 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2505 let funding_created = msgs::FundingCreated {
2506 temporary_channel_id: [2; 32],
2507 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2508 funding_output_index: 255,
2511 partial_signature_with_nonce: None,
2513 next_local_nonce: None,
2515 let encoded_value = funding_created.encode();
2516 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2517 assert_eq!(encoded_value, target_value);
2521 fn encoding_funding_signed() {
2522 let secp_ctx = Secp256k1::new();
2523 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2524 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2525 let funding_signed = msgs::FundingSigned {
2526 channel_id: [2; 32],
2529 partial_signature_with_nonce: None,
2531 let encoded_value = funding_signed.encode();
2532 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2533 assert_eq!(encoded_value, target_value);
2537 fn encoding_channel_ready() {
2538 let secp_ctx = Secp256k1::new();
2539 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2540 let channel_ready = msgs::ChannelReady {
2541 channel_id: [2; 32],
2542 next_per_commitment_point: pubkey_1,
2543 short_channel_id_alias: None,
2545 let encoded_value = channel_ready.encode();
2546 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2547 assert_eq!(encoded_value, target_value);
2550 fn do_encoding_shutdown(script_type: u8) {
2551 let secp_ctx = Secp256k1::new();
2552 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2553 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2554 let shutdown = msgs::Shutdown {
2555 channel_id: [2; 32],
2557 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2558 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2559 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2560 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2562 let encoded_value = shutdown.encode();
2563 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2564 if script_type == 1 {
2565 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2566 } else if script_type == 2 {
2567 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2568 } else if script_type == 3 {
2569 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2570 } else if script_type == 4 {
2571 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2573 assert_eq!(encoded_value, target_value);
2577 fn encoding_shutdown() {
2578 do_encoding_shutdown(1);
2579 do_encoding_shutdown(2);
2580 do_encoding_shutdown(3);
2581 do_encoding_shutdown(4);
2585 fn encoding_closing_signed() {
2586 let secp_ctx = Secp256k1::new();
2587 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2588 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2589 let closing_signed = msgs::ClosingSigned {
2590 channel_id: [2; 32],
2591 fee_satoshis: 2316138423780173,
2595 let encoded_value = closing_signed.encode();
2596 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2597 assert_eq!(encoded_value, target_value);
2598 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2600 let closing_signed_with_range = msgs::ClosingSigned {
2601 channel_id: [2; 32],
2602 fee_satoshis: 2316138423780173,
2604 fee_range: Some(msgs::ClosingSignedFeeRange {
2605 min_fee_satoshis: 0xdeadbeef,
2606 max_fee_satoshis: 0x1badcafe01234567,
2609 let encoded_value_with_range = closing_signed_with_range.encode();
2610 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2611 assert_eq!(encoded_value_with_range, target_value_with_range);
2612 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2613 closing_signed_with_range);
2617 fn encoding_update_add_htlc() {
2618 let secp_ctx = Secp256k1::new();
2619 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2620 let onion_routing_packet = msgs::OnionPacket {
2622 public_key: Ok(pubkey_1),
2623 hop_data: [1; 20*65],
2626 let update_add_htlc = msgs::UpdateAddHTLC {
2627 channel_id: [2; 32],
2628 htlc_id: 2316138423780173,
2629 amount_msat: 3608586615801332854,
2630 payment_hash: PaymentHash([1; 32]),
2631 cltv_expiry: 821716,
2632 onion_routing_packet
2634 let encoded_value = update_add_htlc.encode();
2635 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2636 assert_eq!(encoded_value, target_value);
2640 fn encoding_update_fulfill_htlc() {
2641 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2642 channel_id: [2; 32],
2643 htlc_id: 2316138423780173,
2644 payment_preimage: PaymentPreimage([1; 32]),
2646 let encoded_value = update_fulfill_htlc.encode();
2647 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2648 assert_eq!(encoded_value, target_value);
2652 fn encoding_update_fail_htlc() {
2653 let reason = OnionErrorPacket {
2654 data: [1; 32].to_vec(),
2656 let update_fail_htlc = msgs::UpdateFailHTLC {
2657 channel_id: [2; 32],
2658 htlc_id: 2316138423780173,
2661 let encoded_value = update_fail_htlc.encode();
2662 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2663 assert_eq!(encoded_value, target_value);
2667 fn encoding_update_fail_malformed_htlc() {
2668 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2669 channel_id: [2; 32],
2670 htlc_id: 2316138423780173,
2671 sha256_of_onion: [1; 32],
2674 let encoded_value = update_fail_malformed_htlc.encode();
2675 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2676 assert_eq!(encoded_value, target_value);
2679 fn do_encoding_commitment_signed(htlcs: bool) {
2680 let secp_ctx = Secp256k1::new();
2681 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2682 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2683 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2684 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2685 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2686 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2687 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2688 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2689 let commitment_signed = msgs::CommitmentSigned {
2690 channel_id: [2; 32],
2692 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2694 partial_signature_with_nonce: None,
2696 let encoded_value = commitment_signed.encode();
2697 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2699 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2701 target_value.append(&mut hex::decode("0000").unwrap());
2703 assert_eq!(encoded_value, target_value);
2707 fn encoding_commitment_signed() {
2708 do_encoding_commitment_signed(true);
2709 do_encoding_commitment_signed(false);
2713 fn encoding_revoke_and_ack() {
2714 let secp_ctx = Secp256k1::new();
2715 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2716 let raa = msgs::RevokeAndACK {
2717 channel_id: [2; 32],
2718 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],
2719 next_per_commitment_point: pubkey_1,
2721 next_local_nonce: None,
2723 let encoded_value = raa.encode();
2724 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2725 assert_eq!(encoded_value, target_value);
2729 fn encoding_update_fee() {
2730 let update_fee = msgs::UpdateFee {
2731 channel_id: [2; 32],
2732 feerate_per_kw: 20190119,
2734 let encoded_value = update_fee.encode();
2735 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2736 assert_eq!(encoded_value, target_value);
2740 fn encoding_init() {
2741 assert_eq!(msgs::Init {
2742 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2743 remote_network_address: None,
2744 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2745 assert_eq!(msgs::Init {
2746 features: InitFeatures::from_le_bytes(vec![0xFF]),
2747 remote_network_address: None,
2748 }.encode(), hex::decode("0001ff0001ff").unwrap());
2749 assert_eq!(msgs::Init {
2750 features: InitFeatures::from_le_bytes(vec![]),
2751 remote_network_address: None,
2752 }.encode(), hex::decode("00000000").unwrap());
2754 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2755 remote_network_address: Some(msgs::NetAddress::IPv4 {
2756 addr: [127, 0, 0, 1],
2760 let encoded_value = init_msg.encode();
2761 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2762 assert_eq!(encoded_value, target_value);
2763 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2767 fn encoding_error() {
2768 let error = msgs::ErrorMessage {
2769 channel_id: [2; 32],
2770 data: String::from("rust-lightning"),
2772 let encoded_value = error.encode();
2773 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2774 assert_eq!(encoded_value, target_value);
2778 fn encoding_warning() {
2779 let error = msgs::WarningMessage {
2780 channel_id: [2; 32],
2781 data: String::from("rust-lightning"),
2783 let encoded_value = error.encode();
2784 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2785 assert_eq!(encoded_value, target_value);
2789 fn encoding_ping() {
2790 let ping = msgs::Ping {
2794 let encoded_value = ping.encode();
2795 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2796 assert_eq!(encoded_value, target_value);
2800 fn encoding_pong() {
2801 let pong = msgs::Pong {
2804 let encoded_value = pong.encode();
2805 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2806 assert_eq!(encoded_value, target_value);
2810 fn encoding_nonfinal_onion_hop_data() {
2811 let mut msg = msgs::OnionHopData {
2812 format: OnionHopDataFormat::NonFinalNode {
2813 short_channel_id: 0xdeadbeef1bad1dea,
2815 amt_to_forward: 0x0badf00d01020304,
2816 outgoing_cltv_value: 0xffffffff,
2818 let encoded_value = msg.encode();
2819 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2820 assert_eq!(encoded_value, target_value);
2821 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2822 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2823 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2824 } else { panic!(); }
2825 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2826 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2830 fn encoding_final_onion_hop_data() {
2831 let mut msg = msgs::OnionHopData {
2832 format: OnionHopDataFormat::FinalNode {
2834 payment_metadata: None,
2835 keysend_preimage: None,
2837 amt_to_forward: 0x0badf00d01020304,
2838 outgoing_cltv_value: 0xffffffff,
2840 let encoded_value = msg.encode();
2841 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2842 assert_eq!(encoded_value, target_value);
2843 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2844 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2845 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2846 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2850 fn encoding_final_onion_hop_data_with_secret() {
2851 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2852 let mut msg = msgs::OnionHopData {
2853 format: OnionHopDataFormat::FinalNode {
2854 payment_data: Some(FinalOnionHopData {
2855 payment_secret: expected_payment_secret,
2856 total_msat: 0x1badca1f
2858 payment_metadata: None,
2859 keysend_preimage: None,
2861 amt_to_forward: 0x0badf00d01020304,
2862 outgoing_cltv_value: 0xffffffff,
2864 let encoded_value = msg.encode();
2865 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2866 assert_eq!(encoded_value, target_value);
2867 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2868 if let OnionHopDataFormat::FinalNode {
2869 payment_data: Some(FinalOnionHopData {
2871 total_msat: 0x1badca1f
2873 payment_metadata: None,
2874 keysend_preimage: None,
2876 assert_eq!(payment_secret, expected_payment_secret);
2877 } else { panic!(); }
2878 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2879 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2883 fn query_channel_range_end_blocknum() {
2884 let tests: Vec<(u32, u32, u32)> = vec![
2885 (10000, 1500, 11500),
2886 (0, 0xffffffff, 0xffffffff),
2887 (1, 0xffffffff, 0xffffffff),
2890 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2891 let sut = msgs::QueryChannelRange {
2892 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2896 assert_eq!(sut.end_blocknum(), expected);
2901 fn encoding_query_channel_range() {
2902 let mut query_channel_range = msgs::QueryChannelRange {
2903 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2904 first_blocknum: 100000,
2905 number_of_blocks: 1500,
2907 let encoded_value = query_channel_range.encode();
2908 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2909 assert_eq!(encoded_value, target_value);
2911 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2912 assert_eq!(query_channel_range.first_blocknum, 100000);
2913 assert_eq!(query_channel_range.number_of_blocks, 1500);
2917 fn encoding_reply_channel_range() {
2918 do_encoding_reply_channel_range(0);
2919 do_encoding_reply_channel_range(1);
2922 fn do_encoding_reply_channel_range(encoding_type: u8) {
2923 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2924 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2925 let mut reply_channel_range = msgs::ReplyChannelRange {
2926 chain_hash: expected_chain_hash,
2927 first_blocknum: 756230,
2928 number_of_blocks: 1500,
2929 sync_complete: true,
2930 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2933 if encoding_type == 0 {
2934 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2935 let encoded_value = reply_channel_range.encode();
2936 assert_eq!(encoded_value, target_value);
2938 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2939 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2940 assert_eq!(reply_channel_range.first_blocknum, 756230);
2941 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2942 assert_eq!(reply_channel_range.sync_complete, true);
2943 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2944 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2945 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2947 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2948 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2949 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2954 fn encoding_query_short_channel_ids() {
2955 do_encoding_query_short_channel_ids(0);
2956 do_encoding_query_short_channel_ids(1);
2959 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2960 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2961 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2962 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2963 chain_hash: expected_chain_hash,
2964 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2967 if encoding_type == 0 {
2968 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2969 let encoded_value = query_short_channel_ids.encode();
2970 assert_eq!(encoded_value, target_value);
2972 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2973 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2974 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2975 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2976 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2978 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2979 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2980 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2985 fn encoding_reply_short_channel_ids_end() {
2986 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2987 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2988 chain_hash: expected_chain_hash,
2989 full_information: true,
2991 let encoded_value = reply_short_channel_ids_end.encode();
2992 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2993 assert_eq!(encoded_value, target_value);
2995 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2996 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2997 assert_eq!(reply_short_channel_ids_end.full_information, true);
3001 fn encoding_gossip_timestamp_filter(){
3002 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
3003 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
3004 chain_hash: expected_chain_hash,
3005 first_timestamp: 1590000000,
3006 timestamp_range: 0xffff_ffff,
3008 let encoded_value = gossip_timestamp_filter.encode();
3009 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
3010 assert_eq!(encoded_value, target_value);
3012 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
3013 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
3014 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
3015 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
3019 fn decode_onion_hop_data_len_as_bigsize() {
3020 // Tests that we can decode an onion payload that is >253 bytes.
3021 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
3022 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
3025 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
3026 // payload length to be encoded over multiple bytes rather than a single u8.
3027 let big_payload = encode_big_payload().unwrap();
3028 let mut rd = Cursor::new(&big_payload[..]);
3029 <msgs::OnionHopData as Readable>::read(&mut rd).unwrap();
3031 // see above test, needs to be a separate method for use of the serialization macros.
3032 fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
3033 use crate::util::ser::HighZeroBytesDroppedBigSize;
3034 let payload = msgs::OnionHopData {
3035 format: OnionHopDataFormat::NonFinalNode {
3036 short_channel_id: 0xdeadbeef1bad1dea,
3038 amt_to_forward: 1000,
3039 outgoing_cltv_value: 0xffffffff,
3041 let mut encoded_payload = Vec::new();
3042 let test_bytes = vec![42u8; 1000];
3043 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = payload.format {
3044 _encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
3045 (1, test_bytes, vec_type),
3046 (2, HighZeroBytesDroppedBigSize(payload.amt_to_forward), required),
3047 (4, HighZeroBytesDroppedBigSize(payload.outgoing_cltv_value), required),
3048 (6, short_channel_id, required)