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::util::events::{MessageSendEventsProvider, OnionMessageProvider};
44 use crate::util::logger;
45 use crate::util::ser::{LengthReadable, Readable, ReadableArgs, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname};
47 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
49 use crate::routing::gossip::NodeId;
51 /// 21 million * 10^8 * 1000
52 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
54 /// An error in decoding a message or struct.
55 #[derive(Clone, Debug, PartialEq, Eq)]
56 pub enum DecodeError {
57 /// A version byte specified something we don't know how to handle.
59 /// Includes unknown realm byte in an onion hop data packet.
61 /// Unknown feature mandating we fail to parse message (e.g., TLV with an even, unknown type)
62 UnknownRequiredFeature,
63 /// Value was invalid.
65 /// For example, a byte which was supposed to be a bool was something other than a 0
66 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
67 /// syntactically incorrect, etc.
69 /// The buffer to be read was too short.
71 /// A length descriptor in the packet didn't describe the later data correctly.
73 /// Error from [`std::io`].
75 /// The message included zlib-compressed values, which we don't support.
76 UnsupportedCompression,
79 /// An [`init`] message to be sent to or received from a peer.
81 /// [`init`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-init-message
82 #[derive(Clone, Debug, PartialEq, Eq)]
84 /// The relevant features which the sender supports.
85 pub features: InitFeatures,
86 /// The receipient's network address.
88 /// This adds the option to report a remote IP address back to a connecting peer using the init
89 /// message. A node can decide to use that information to discover a potential update to its
90 /// public IPv4 address (NAT) and use that for a [`NodeAnnouncement`] update message containing
92 pub remote_network_address: Option<NetAddress>,
95 /// An [`error`] message to be sent to or received from a peer.
97 /// [`error`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
98 #[derive(Clone, Debug, PartialEq, Eq)]
99 pub struct ErrorMessage {
100 /// The channel ID involved in the error.
102 /// All-0s indicates a general error unrelated to a specific channel, after which all channels
103 /// with the sending peer should be closed.
104 pub channel_id: [u8; 32],
105 /// A possibly human-readable error description.
107 /// The string should be sanitized before it is used (e.g., emitted to logs or printed to
108 /// `stdout`). Otherwise, a well crafted error message may trigger a security vulnerability in
109 /// the terminal emulator or the logging subsystem.
113 /// A [`warning`] message to be sent to or received from a peer.
115 /// [`warning`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
116 #[derive(Clone, Debug, PartialEq, Eq)]
117 pub struct WarningMessage {
118 /// The channel ID involved in the warning.
120 /// All-0s indicates a warning unrelated to a specific channel.
121 pub channel_id: [u8; 32],
122 /// A possibly human-readable warning description.
124 /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
125 /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
126 /// the terminal emulator or the logging subsystem.
130 /// A [`ping`] message to be sent to or received from a peer.
132 /// [`ping`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
133 #[derive(Clone, Debug, PartialEq, Eq)]
135 /// The desired response length.
137 /// The ping packet size.
139 /// This field is not sent on the wire. byteslen zeros are sent.
143 /// A [`pong`] message to be sent to or received from a peer.
145 /// [`pong`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
146 #[derive(Clone, Debug, PartialEq, Eq)]
148 /// The pong packet size.
150 /// This field is not sent on the wire. byteslen zeros are sent.
154 /// An [`open_channel`] message to be sent to or received from a peer.
156 /// [`open_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
157 #[derive(Clone, Debug, PartialEq, Eq)]
158 pub struct OpenChannel {
159 /// The genesis hash of the blockchain where the channel is to be opened
160 pub chain_hash: BlockHash,
161 /// A temporary channel ID, until the funding outpoint is announced
162 pub temporary_channel_id: [u8; 32],
163 /// The channel value
164 pub funding_satoshis: u64,
165 /// The amount to push to the counterparty as part of the open, in milli-satoshi
167 /// The threshold below which outputs on transactions broadcast by sender will be omitted
168 pub dust_limit_satoshis: u64,
169 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
170 pub max_htlc_value_in_flight_msat: u64,
171 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
172 pub channel_reserve_satoshis: u64,
173 /// The minimum HTLC size incoming to sender, in milli-satoshi
174 pub htlc_minimum_msat: u64,
175 /// The feerate per 1000-weight of sender generated transactions, until updated by
177 pub feerate_per_kw: u32,
178 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if
179 /// they broadcast a commitment transaction
180 pub to_self_delay: u16,
181 /// The maximum number of inbound HTLCs towards sender
182 pub max_accepted_htlcs: u16,
183 /// The sender's key controlling the funding transaction
184 pub funding_pubkey: PublicKey,
185 /// Used to derive a revocation key for transactions broadcast by counterparty
186 pub revocation_basepoint: PublicKey,
187 /// A payment key to sender for transactions broadcast by counterparty
188 pub payment_point: PublicKey,
189 /// Used to derive a payment key to sender for transactions broadcast by sender
190 pub delayed_payment_basepoint: PublicKey,
191 /// Used to derive an HTLC payment key to sender
192 pub htlc_basepoint: PublicKey,
193 /// The first to-be-broadcast-by-sender transaction's per commitment point
194 pub first_per_commitment_point: PublicKey,
195 /// The channel flags to be used
196 pub channel_flags: u8,
197 /// Optionally, a request to pre-set the to-sender output's `scriptPubkey` for when we collaboratively close
198 pub shutdown_scriptpubkey: OptionalField<Script>,
199 /// The channel type that this channel will represent
201 /// If this is `None`, we derive the channel type from the intersection of our
202 /// feature bits with our counterparty's feature bits from the [`Init`] message.
203 pub channel_type: Option<ChannelTypeFeatures>,
206 /// An [`accept_channel`] message to be sent to or received from a peer.
208 /// [`accept_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel-message
209 #[derive(Clone, Debug, PartialEq, Eq)]
210 pub struct AcceptChannel {
211 /// A temporary channel ID, until the funding outpoint is announced
212 pub temporary_channel_id: [u8; 32],
213 /// The threshold below which outputs on transactions broadcast by sender will be omitted
214 pub dust_limit_satoshis: u64,
215 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
216 pub max_htlc_value_in_flight_msat: u64,
217 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
218 pub channel_reserve_satoshis: u64,
219 /// The minimum HTLC size incoming to sender, in milli-satoshi
220 pub htlc_minimum_msat: u64,
221 /// Minimum depth of the funding transaction before the channel is considered open
222 pub minimum_depth: u32,
223 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
224 pub to_self_delay: u16,
225 /// The maximum number of inbound HTLCs towards sender
226 pub max_accepted_htlcs: u16,
227 /// The sender's key controlling the funding transaction
228 pub funding_pubkey: PublicKey,
229 /// Used to derive a revocation key for transactions broadcast by counterparty
230 pub revocation_basepoint: PublicKey,
231 /// A payment key to sender for transactions broadcast by counterparty
232 pub payment_point: PublicKey,
233 /// Used to derive a payment key to sender for transactions broadcast by sender
234 pub delayed_payment_basepoint: PublicKey,
235 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
236 pub htlc_basepoint: PublicKey,
237 /// The first to-be-broadcast-by-sender transaction's per commitment point
238 pub first_per_commitment_point: PublicKey,
239 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
240 pub shutdown_scriptpubkey: OptionalField<Script>,
241 /// The channel type that this channel will represent.
243 /// If this is `None`, we derive the channel type from the intersection of
244 /// our feature bits with our counterparty's feature bits from the [`Init`] message.
245 /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
246 pub channel_type: Option<ChannelTypeFeatures>,
249 /// A [`funding_created`] message to be sent to or received from a peer.
251 /// [`funding_created`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_created-message
252 #[derive(Clone, Debug, PartialEq, Eq)]
253 pub struct FundingCreated {
254 /// A temporary channel ID, until the funding is established
255 pub temporary_channel_id: [u8; 32],
256 /// The funding transaction ID
257 pub funding_txid: Txid,
258 /// The specific output index funding this channel
259 pub funding_output_index: u16,
260 /// The signature of the channel initiator (funder) on the initial commitment transaction
261 pub signature: Signature,
264 /// A [`funding_signed`] message to be sent to or received from a peer.
266 /// [`funding_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_signed-message
267 #[derive(Clone, Debug, PartialEq, Eq)]
268 pub struct FundingSigned {
270 pub channel_id: [u8; 32],
271 /// The signature of the channel acceptor (fundee) on the initial commitment transaction
272 pub signature: Signature,
275 /// A [`channel_ready`] message to be sent to or received from a peer.
277 /// [`channel_ready`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message
278 #[derive(Clone, Debug, PartialEq, Eq)]
279 pub struct ChannelReady {
281 pub channel_id: [u8; 32],
282 /// The per-commitment point of the second commitment transaction
283 pub next_per_commitment_point: PublicKey,
284 /// If set, provides a `short_channel_id` alias for this channel.
286 /// The sender will accept payments to be forwarded over this SCID and forward them to this
287 /// messages' recipient.
288 pub short_channel_id_alias: Option<u64>,
291 /// A [`shutdown`] message to be sent to or received from a peer.
293 /// [`shutdown`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-initiation-shutdown
294 #[derive(Clone, Debug, PartialEq, Eq)]
295 pub struct Shutdown {
297 pub channel_id: [u8; 32],
298 /// The destination of this peer's funds on closing.
300 /// Must be in one of these forms: P2PKH, P2SH, P2WPKH, P2WSH, P2TR.
301 pub scriptpubkey: Script,
304 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
306 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
308 #[derive(Clone, Debug, PartialEq, Eq)]
309 pub struct ClosingSignedFeeRange {
310 /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
312 pub min_fee_satoshis: u64,
313 /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
315 pub max_fee_satoshis: u64,
318 /// A [`closing_signed`] message to be sent to or received from a peer.
320 /// [`closing_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-negotiation-closing_signed
321 #[derive(Clone, Debug, PartialEq, Eq)]
322 pub struct ClosingSigned {
324 pub channel_id: [u8; 32],
325 /// The proposed total fee for the closing transaction
326 pub fee_satoshis: u64,
327 /// A signature on the closing transaction
328 pub signature: Signature,
329 /// The minimum and maximum fees which the sender is willing to accept, provided only by new
331 pub fee_range: Option<ClosingSignedFeeRange>,
334 /// An [`update_add_htlc`] message to be sent to or received from a peer.
336 /// [`update_add_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#adding-an-htlc-update_add_htlc
337 #[derive(Clone, Debug, PartialEq, Eq)]
338 pub struct UpdateAddHTLC {
340 pub channel_id: [u8; 32],
343 /// The HTLC value in milli-satoshi
344 pub amount_msat: u64,
345 /// The payment hash, the pre-image of which controls HTLC redemption
346 pub payment_hash: PaymentHash,
347 /// The expiry height of the HTLC
348 pub cltv_expiry: u32,
349 pub(crate) onion_routing_packet: OnionPacket,
352 /// An onion message to be sent to or received from a peer.
354 // TODO: update with link to OM when they are merged into the BOLTs
355 #[derive(Clone, Debug, PartialEq, Eq)]
356 pub struct OnionMessage {
357 /// Used in decrypting the onion packet's payload.
358 pub blinding_point: PublicKey,
359 pub(crate) onion_routing_packet: onion_message::Packet,
362 /// An [`update_fulfill_htlc`] message to be sent to or received from a peer.
364 /// [`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
365 #[derive(Clone, Debug, PartialEq, Eq)]
366 pub struct UpdateFulfillHTLC {
368 pub channel_id: [u8; 32],
371 /// The pre-image of the payment hash, allowing HTLC redemption
372 pub payment_preimage: PaymentPreimage,
375 /// An [`update_fail_htlc`] message to be sent to or received from a peer.
377 /// [`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
378 #[derive(Clone, Debug, PartialEq, Eq)]
379 pub struct UpdateFailHTLC {
381 pub channel_id: [u8; 32],
384 pub(crate) reason: OnionErrorPacket,
387 /// An [`update_fail_malformed_htlc`] message to be sent to or received from a peer.
389 /// [`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
390 #[derive(Clone, Debug, PartialEq, Eq)]
391 pub struct UpdateFailMalformedHTLC {
393 pub channel_id: [u8; 32],
396 pub(crate) sha256_of_onion: [u8; 32],
398 pub failure_code: u16,
401 /// A [`commitment_signed`] message to be sent to or received from a peer.
403 /// [`commitment_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#committing-updates-so-far-commitment_signed
404 #[derive(Clone, Debug, PartialEq, Eq)]
405 pub struct CommitmentSigned {
407 pub channel_id: [u8; 32],
408 /// A signature on the commitment transaction
409 pub signature: Signature,
410 /// Signatures on the HTLC transactions
411 pub htlc_signatures: Vec<Signature>,
414 /// A [`revoke_and_ack`] message to be sent to or received from a peer.
416 /// [`revoke_and_ack`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#completing-the-transition-to-the-updated-state-revoke_and_ack
417 #[derive(Clone, Debug, PartialEq, Eq)]
418 pub struct RevokeAndACK {
420 pub channel_id: [u8; 32],
421 /// The secret corresponding to the per-commitment point
422 pub per_commitment_secret: [u8; 32],
423 /// The next sender-broadcast commitment transaction's per-commitment point
424 pub next_per_commitment_point: PublicKey,
427 /// An [`update_fee`] message to be sent to or received from a peer
429 /// [`update_fee`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#updating-fees-update_fee
430 #[derive(Clone, Debug, PartialEq, Eq)]
431 pub struct UpdateFee {
433 pub channel_id: [u8; 32],
434 /// Fee rate per 1000-weight of the transaction
435 pub feerate_per_kw: u32,
438 #[derive(Clone, Debug, PartialEq, Eq)]
439 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
441 /// This is used to convince the recipient that the channel is at a certain commitment
442 /// number even if they lost that data due to a local failure. Of course, the peer may lie
443 /// and even later commitments may have been revoked.
444 pub struct DataLossProtect {
445 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
446 /// belonging to the recipient
447 pub your_last_per_commitment_secret: [u8; 32],
448 /// The sender's per-commitment point for their current commitment transaction
449 pub my_current_per_commitment_point: PublicKey,
452 /// A [`channel_reestablish`] message to be sent to or received from a peer.
454 /// [`channel_reestablish`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#message-retransmission
455 #[derive(Clone, Debug, PartialEq, Eq)]
456 pub struct ChannelReestablish {
458 pub channel_id: [u8; 32],
459 /// The next commitment number for the sender
460 pub next_local_commitment_number: u64,
461 /// The next commitment number for the recipient
462 pub next_remote_commitment_number: u64,
463 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
464 pub data_loss_protect: OptionalField<DataLossProtect>,
467 /// An [`announcement_signatures`] message to be sent to or received from a peer.
469 /// [`announcement_signatures`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-announcement_signatures-message
470 #[derive(Clone, Debug, PartialEq, Eq)]
471 pub struct AnnouncementSignatures {
473 pub channel_id: [u8; 32],
474 /// The short channel ID
475 pub short_channel_id: u64,
476 /// A signature by the node key
477 pub node_signature: Signature,
478 /// A signature by the funding key
479 pub bitcoin_signature: Signature,
482 /// An address which can be used to connect to a remote peer.
483 #[derive(Clone, Debug, PartialEq, Eq)]
484 pub enum NetAddress {
485 /// An IPv4 address/port on which the peer is listening.
487 /// The 4-byte IPv4 address
489 /// The port on which the node is listening
492 /// An IPv6 address/port on which the peer is listening.
494 /// The 16-byte IPv6 address
496 /// The port on which the node is listening
499 /// An old-style Tor onion address/port on which the peer is listening.
501 /// This field is deprecated and the Tor network generally no longer supports V2 Onion
502 /// addresses. Thus, the details are not parsed here.
504 /// A new-style Tor onion address/port on which the peer is listening.
506 /// To create the human-readable "hostname", concatenate the ED25519 pubkey, checksum, and version,
507 /// wrap as base32 and append ".onion".
509 /// The ed25519 long-term public key of the peer
510 ed25519_pubkey: [u8; 32],
511 /// The checksum of the pubkey and version, as included in the onion address
513 /// The version byte, as defined by the Tor Onion v3 spec.
515 /// The port on which the node is listening
518 /// A hostname/port on which the peer is listening.
520 /// The hostname on which the node is listening.
522 /// The port on which the node is listening.
527 /// Gets the ID of this address type. Addresses in [`NodeAnnouncement`] messages should be sorted
529 pub(crate) fn get_id(&self) -> u8 {
531 &NetAddress::IPv4 {..} => { 1 },
532 &NetAddress::IPv6 {..} => { 2 },
533 &NetAddress::OnionV2(_) => { 3 },
534 &NetAddress::OnionV3 {..} => { 4 },
535 &NetAddress::Hostname {..} => { 5 },
539 /// Strict byte-length of address descriptor, 1-byte type not recorded
540 fn len(&self) -> u16 {
542 &NetAddress::IPv4 { .. } => { 6 },
543 &NetAddress::IPv6 { .. } => { 18 },
544 &NetAddress::OnionV2(_) => { 12 },
545 &NetAddress::OnionV3 { .. } => { 37 },
546 // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
547 &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
551 /// The maximum length of any address descriptor, not including the 1-byte type.
552 /// This maximum length is reached by a hostname address descriptor:
553 /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
554 pub(crate) const MAX_LEN: u16 = 258;
557 impl Writeable for NetAddress {
558 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
560 &NetAddress::IPv4 { ref addr, ref port } => {
565 &NetAddress::IPv6 { ref addr, ref port } => {
570 &NetAddress::OnionV2(bytes) => {
572 bytes.write(writer)?;
574 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
576 ed25519_pubkey.write(writer)?;
577 checksum.write(writer)?;
578 version.write(writer)?;
581 &NetAddress::Hostname { ref hostname, ref port } => {
583 hostname.write(writer)?;
591 impl Readable for Result<NetAddress, u8> {
592 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
593 let byte = <u8 as Readable>::read(reader)?;
596 Ok(Ok(NetAddress::IPv4 {
597 addr: Readable::read(reader)?,
598 port: Readable::read(reader)?,
602 Ok(Ok(NetAddress::IPv6 {
603 addr: Readable::read(reader)?,
604 port: Readable::read(reader)?,
607 3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
609 Ok(Ok(NetAddress::OnionV3 {
610 ed25519_pubkey: Readable::read(reader)?,
611 checksum: Readable::read(reader)?,
612 version: Readable::read(reader)?,
613 port: Readable::read(reader)?,
617 Ok(Ok(NetAddress::Hostname {
618 hostname: Readable::read(reader)?,
619 port: Readable::read(reader)?,
622 _ => return Ok(Err(byte)),
627 impl Readable for NetAddress {
628 fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
629 match Readable::read(reader) {
630 Ok(Ok(res)) => Ok(res),
631 Ok(Err(_)) => Err(DecodeError::UnknownVersion),
637 /// Represents the set of gossip messages that require a signature from a node's identity key.
638 pub enum UnsignedGossipMessage<'a> {
639 /// An unsigned channel announcement.
640 ChannelAnnouncement(&'a UnsignedChannelAnnouncement),
641 /// An unsigned channel update.
642 ChannelUpdate(&'a UnsignedChannelUpdate),
643 /// An unsigned node announcement.
644 NodeAnnouncement(&'a UnsignedNodeAnnouncement)
647 impl<'a> Writeable for UnsignedGossipMessage<'a> {
648 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
650 UnsignedGossipMessage::ChannelAnnouncement(ref msg) => msg.write(writer),
651 UnsignedGossipMessage::ChannelUpdate(ref msg) => msg.write(writer),
652 UnsignedGossipMessage::NodeAnnouncement(ref msg) => msg.write(writer),
657 /// The unsigned part of a [`node_announcement`] message.
659 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
660 #[derive(Clone, Debug, PartialEq, Eq)]
661 pub struct UnsignedNodeAnnouncement {
662 /// The advertised features
663 pub features: NodeFeatures,
664 /// A strictly monotonic announcement counter, with gaps allowed
666 /// The `node_id` this announcement originated from (don't rebroadcast the `node_announcement` back
668 pub node_id: PublicKey,
669 /// An RGB color for UI purposes
671 /// An alias, for UI purposes.
673 /// This should be sanitized before use. There is no guarantee of uniqueness.
675 /// List of addresses on which this node is reachable
676 pub addresses: Vec<NetAddress>,
677 pub(crate) excess_address_data: Vec<u8>,
678 pub(crate) excess_data: Vec<u8>,
680 #[derive(Clone, Debug, PartialEq, Eq)]
681 /// A [`node_announcement`] message to be sent to or received from a peer.
683 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
684 pub struct NodeAnnouncement {
685 /// The signature by the node key
686 pub signature: Signature,
687 /// The actual content of the announcement
688 pub contents: UnsignedNodeAnnouncement,
691 /// The unsigned part of a [`channel_announcement`] message.
693 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
694 #[derive(Clone, Debug, PartialEq, Eq)]
695 pub struct UnsignedChannelAnnouncement {
696 /// The advertised channel features
697 pub features: ChannelFeatures,
698 /// The genesis hash of the blockchain where the channel is to be opened
699 pub chain_hash: BlockHash,
700 /// The short channel ID
701 pub short_channel_id: u64,
702 /// One of the two `node_id`s which are endpoints of this channel
703 pub node_id_1: NodeId,
704 /// The other of the two `node_id`s which are endpoints of this channel
705 pub node_id_2: NodeId,
706 /// The funding key for the first node
707 pub bitcoin_key_1: NodeId,
708 /// The funding key for the second node
709 pub bitcoin_key_2: NodeId,
710 pub(crate) excess_data: Vec<u8>,
712 /// A [`channel_announcement`] message to be sent to or received from a peer.
714 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
715 #[derive(Clone, Debug, PartialEq, Eq)]
716 pub struct ChannelAnnouncement {
717 /// Authentication of the announcement by the first public node
718 pub node_signature_1: Signature,
719 /// Authentication of the announcement by the second public node
720 pub node_signature_2: Signature,
721 /// Proof of funding UTXO ownership by the first public node
722 pub bitcoin_signature_1: Signature,
723 /// Proof of funding UTXO ownership by the second public node
724 pub bitcoin_signature_2: Signature,
725 /// The actual announcement
726 pub contents: UnsignedChannelAnnouncement,
729 /// The unsigned part of a [`channel_update`] message.
731 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
732 #[derive(Clone, Debug, PartialEq, Eq)]
733 pub struct UnsignedChannelUpdate {
734 /// The genesis hash of the blockchain where the channel is to be opened
735 pub chain_hash: BlockHash,
736 /// The short channel ID
737 pub short_channel_id: u64,
738 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
742 /// The number of blocks such that if:
743 /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
744 /// then we need to fail the HTLC backwards. When forwarding an HTLC, `cltv_expiry_delta` determines
745 /// the outgoing HTLC's minimum `cltv_expiry` value -- so, if an incoming HTLC comes in with a
746 /// `cltv_expiry` of 100000, and the node we're forwarding to has a `cltv_expiry_delta` value of 10,
747 /// then we'll check that the outgoing HTLC's `cltv_expiry` value is at least 100010 before
748 /// forwarding. Note that the HTLC sender is the one who originally sets this value when
749 /// constructing the route.
750 pub cltv_expiry_delta: u16,
751 /// The minimum HTLC size incoming to sender, in milli-satoshi
752 pub htlc_minimum_msat: u64,
753 /// The maximum HTLC value incoming to sender, in milli-satoshi.
755 /// This used to be optional.
756 pub htlc_maximum_msat: u64,
757 /// The base HTLC fee charged by sender, in milli-satoshi
758 pub fee_base_msat: u32,
759 /// The amount to fee multiplier, in micro-satoshi
760 pub fee_proportional_millionths: u32,
761 /// Excess data which was signed as a part of the message which we do not (yet) understand how
764 /// This is stored to ensure forward-compatibility as new fields are added to the lightning gossip protocol.
765 pub excess_data: Vec<u8>,
767 /// A [`channel_update`] message to be sent to or received from a peer.
769 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
770 #[derive(Clone, Debug, PartialEq, Eq)]
771 pub struct ChannelUpdate {
772 /// A signature of the channel update
773 pub signature: Signature,
774 /// The actual channel update
775 pub contents: UnsignedChannelUpdate,
778 /// A [`query_channel_range`] message is used to query a peer for channel
779 /// UTXOs in a range of blocks. The recipient of a query makes a best
780 /// effort to reply to the query using one or more [`ReplyChannelRange`]
783 /// [`query_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
784 #[derive(Clone, Debug, PartialEq, Eq)]
785 pub struct QueryChannelRange {
786 /// The genesis hash of the blockchain being queried
787 pub chain_hash: BlockHash,
788 /// The height of the first block for the channel UTXOs being queried
789 pub first_blocknum: u32,
790 /// The number of blocks to include in the query results
791 pub number_of_blocks: u32,
794 /// A [`reply_channel_range`] message is a reply to a [`QueryChannelRange`]
797 /// Multiple `reply_channel_range` messages can be sent in reply
798 /// to a single [`QueryChannelRange`] message. The query recipient makes a
799 /// best effort to respond based on their local network view which may
800 /// not be a perfect view of the network. The `short_channel_id`s in the
801 /// reply are encoded. We only support `encoding_type=0` uncompressed
802 /// serialization and do not support `encoding_type=1` zlib serialization.
804 /// [`reply_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
805 #[derive(Clone, Debug, PartialEq, Eq)]
806 pub struct ReplyChannelRange {
807 /// The genesis hash of the blockchain being queried
808 pub chain_hash: BlockHash,
809 /// The height of the first block in the range of the reply
810 pub first_blocknum: u32,
811 /// The number of blocks included in the range of the reply
812 pub number_of_blocks: u32,
813 /// True when this is the final reply for a query
814 pub sync_complete: bool,
815 /// The `short_channel_id`s in the channel range
816 pub short_channel_ids: Vec<u64>,
819 /// A [`query_short_channel_ids`] message is used to query a peer for
820 /// routing gossip messages related to one or more `short_channel_id`s.
822 /// The query recipient will reply with the latest, if available,
823 /// [`ChannelAnnouncement`], [`ChannelUpdate`] and [`NodeAnnouncement`] messages
824 /// it maintains for the requested `short_channel_id`s followed by a
825 /// [`ReplyShortChannelIdsEnd`] message. The `short_channel_id`s sent in
826 /// this query are encoded. We only support `encoding_type=0` uncompressed
827 /// serialization and do not support `encoding_type=1` zlib serialization.
829 /// [`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
830 #[derive(Clone, Debug, PartialEq, Eq)]
831 pub struct QueryShortChannelIds {
832 /// The genesis hash of the blockchain being queried
833 pub chain_hash: BlockHash,
834 /// The short_channel_ids that are being queried
835 pub short_channel_ids: Vec<u64>,
838 /// A [`reply_short_channel_ids_end`] message is sent as a reply to a
839 /// message. The query recipient makes a best
840 /// effort to respond based on their local network view which may not be
841 /// a perfect view of the network.
843 /// [`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
844 #[derive(Clone, Debug, PartialEq, Eq)]
845 pub struct ReplyShortChannelIdsEnd {
846 /// The genesis hash of the blockchain that was queried
847 pub chain_hash: BlockHash,
848 /// Indicates if the query recipient maintains up-to-date channel
849 /// information for the `chain_hash`
850 pub full_information: bool,
853 /// A [`gossip_timestamp_filter`] message is used by a node to request
854 /// gossip relay for messages in the requested time range when the
855 /// `gossip_queries` feature has been negotiated.
857 /// [`gossip_timestamp_filter`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-gossip_timestamp_filter-message
858 #[derive(Clone, Debug, PartialEq, Eq)]
859 pub struct GossipTimestampFilter {
860 /// The genesis hash of the blockchain for channel and node information
861 pub chain_hash: BlockHash,
862 /// The starting unix timestamp
863 pub first_timestamp: u32,
864 /// The range of information in seconds
865 pub timestamp_range: u32,
868 /// Encoding type for data compression of collections in gossip queries.
870 /// We do not support `encoding_type=1` zlib serialization [defined in BOLT
871 /// #7](https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#query-messages).
876 /// Used to put an error message in a [`LightningError`].
877 #[derive(Clone, Debug)]
878 pub enum ErrorAction {
879 /// The peer took some action which made us think they were useless. Disconnect them.
881 /// An error message which we should make an effort to send before we disconnect.
882 msg: Option<ErrorMessage>
884 /// The peer did something harmless that we weren't able to process, just log and ignore
885 // New code should *not* use this. New code must use IgnoreAndLog, below!
887 /// The peer did something harmless that we weren't able to meaningfully process.
888 /// If the error is logged, log it at the given level.
889 IgnoreAndLog(logger::Level),
890 /// The peer provided us with a gossip message which we'd already seen. In most cases this
891 /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
892 /// our own channel announcements.
893 IgnoreDuplicateGossip,
894 /// The peer did something incorrect. Tell them.
896 /// The message to send.
899 /// The peer did something incorrect. Tell them without closing any channels.
901 /// The message to send.
903 /// The peer may have done something harmless that we weren't able to meaningfully process,
904 /// though we should still tell them about it.
905 /// If this event is logged, log it at the given level.
906 log_level: logger::Level,
910 /// An Err type for failure to process messages.
911 #[derive(Clone, Debug)]
912 pub struct LightningError {
913 /// A human-readable message describing the error
915 /// The action which should be taken against the offending peer.
916 pub action: ErrorAction,
919 /// Struct used to return values from [`RevokeAndACK`] messages, containing a bunch of commitment
920 /// transaction updates if they were pending.
921 #[derive(Clone, Debug, PartialEq, Eq)]
922 pub struct CommitmentUpdate {
923 /// `update_add_htlc` messages which should be sent
924 pub update_add_htlcs: Vec<UpdateAddHTLC>,
925 /// `update_fulfill_htlc` messages which should be sent
926 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
927 /// `update_fail_htlc` messages which should be sent
928 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
929 /// `update_fail_malformed_htlc` messages which should be sent
930 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
931 /// An `update_fee` message which should be sent
932 pub update_fee: Option<UpdateFee>,
933 /// A `commitment_signed` message which should be sent
934 pub commitment_signed: CommitmentSigned,
937 /// Messages could have optional fields to use with extended features
938 /// As we wish to serialize these differently from `Option<T>`s (`Options` get a tag byte, but
939 /// [`OptionalField`] simply gets `Present` if there are enough bytes to read into it), we have a
940 /// separate enum type for them.
942 /// (C-not exported) due to a free generic in `T`
943 #[derive(Clone, Debug, PartialEq, Eq)]
944 pub enum OptionalField<T> {
945 /// Optional field is included in message
947 /// Optional field is absent in message
951 /// A trait to describe an object which can receive channel messages.
953 /// Messages MAY be called in parallel when they originate from different `their_node_ids`, however
954 /// they MUST NOT be called in parallel when the two calls have the same `their_node_id`.
955 pub trait ChannelMessageHandler : MessageSendEventsProvider {
957 /// Handle an incoming `open_channel` message from the given peer.
958 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel);
959 /// Handle an incoming `accept_channel` message from the given peer.
960 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel);
961 /// Handle an incoming `funding_created` message from the given peer.
962 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
963 /// Handle an incoming `funding_signed` message from the given peer.
964 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
965 /// Handle an incoming `channel_ready` message from the given peer.
966 fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
969 /// Handle an incoming `shutdown` message from the given peer.
970 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
971 /// Handle an incoming `closing_signed` message from the given peer.
972 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
975 /// Handle an incoming `update_add_htlc` message from the given peer.
976 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
977 /// Handle an incoming `update_fulfill_htlc` message from the given peer.
978 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
979 /// Handle an incoming `update_fail_htlc` message from the given peer.
980 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
981 /// Handle an incoming `update_fail_malformed_htlc` message from the given peer.
982 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
983 /// Handle an incoming `commitment_signed` message from the given peer.
984 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
985 /// Handle an incoming `revoke_and_ack` message from the given peer.
986 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
988 /// Handle an incoming `update_fee` message from the given peer.
989 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
991 // Channel-to-announce:
992 /// Handle an incoming `announcement_signatures` message from the given peer.
993 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
995 // Connection loss/reestablish:
996 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
997 /// is believed to be possible in the future (eg they're sending us messages we don't
998 /// understand or indicate they require unknown feature bits), `no_connection_possible` is set
999 /// and any outstanding channels should be failed.
1001 /// Note that in some rare cases this may be called without a corresponding
1002 /// [`Self::peer_connected`].
1003 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
1005 /// Handle a peer reconnecting, possibly generating `channel_reestablish` message(s).
1007 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1008 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1009 /// message handlers may still wish to communicate with this peer.
1010 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init) -> Result<(), ()>;
1011 /// Handle an incoming `channel_reestablish` message from the given peer.
1012 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
1014 /// Handle an incoming `channel_update` message from the given peer.
1015 fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
1018 /// Handle an incoming `error` message from the given peer.
1019 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
1021 // Handler information:
1022 /// Gets the node feature flags which this handler itself supports. All available handlers are
1023 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1024 /// which are broadcasted in our [`NodeAnnouncement`] message.
1025 fn provided_node_features(&self) -> NodeFeatures;
1027 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1028 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1029 /// which are sent in our [`Init`] message.
1031 /// Note that this method is called before [`Self::peer_connected`].
1032 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1035 /// A trait to describe an object which can receive routing messages.
1037 /// # Implementor DoS Warnings
1039 /// For messages enabled with the `gossip_queries` feature there are potential DoS vectors when
1040 /// handling inbound queries. Implementors using an on-disk network graph should be aware of
1041 /// repeated disk I/O for queries accessing different parts of the network graph.
1042 pub trait RoutingMessageHandler : MessageSendEventsProvider {
1043 /// Handle an incoming `node_announcement` message, returning `true` if it should be forwarded on,
1044 /// `false` or returning an `Err` otherwise.
1045 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
1046 /// Handle a `channel_announcement` message, returning `true` if it should be forwarded on, `false`
1047 /// or returning an `Err` otherwise.
1048 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
1049 /// Handle an incoming `channel_update` message, returning true if it should be forwarded on,
1050 /// `false` or returning an `Err` otherwise.
1051 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
1052 /// Gets channel announcements and updates required to dump our routing table to a remote node,
1053 /// starting at the `short_channel_id` indicated by `starting_point` and including announcements
1054 /// for a single channel.
1055 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
1056 /// Gets a node announcement required to dump our routing table to a remote node, starting at
1057 /// the node *after* the provided pubkey and including up to one announcement immediately
1058 /// higher (as defined by `<PublicKey as Ord>::cmp`) than `starting_point`.
1059 /// If `None` is provided for `starting_point`, we start at the first node.
1060 fn get_next_node_announcement(&self, starting_point: Option<&PublicKey>) -> Option<NodeAnnouncement>;
1061 /// Called when a connection is established with a peer. This can be used to
1062 /// perform routing table synchronization using a strategy defined by the
1065 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1066 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1067 /// message handlers may still wish to communicate with this peer.
1068 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init) -> Result<(), ()>;
1069 /// Handles the reply of a query we initiated to learn about channels
1070 /// for a given range of blocks. We can expect to receive one or more
1071 /// replies to a single query.
1072 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
1073 /// Handles the reply of a query we initiated asking for routing gossip
1074 /// messages for a list of channels. We should receive this message when
1075 /// a node has completed its best effort to send us the pertaining routing
1076 /// gossip messages.
1077 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
1078 /// Handles when a peer asks us to send a list of `short_channel_id`s
1079 /// for the requested range of blocks.
1080 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
1081 /// Handles when a peer asks us to send routing gossip messages for a
1082 /// list of `short_channel_id`s.
1083 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
1085 // Handler information:
1086 /// Gets the node feature flags which this handler itself supports. All available handlers are
1087 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1088 /// which are broadcasted in our [`NodeAnnouncement`] message.
1089 fn provided_node_features(&self) -> NodeFeatures;
1090 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1091 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1092 /// which are sent in our [`Init`] message.
1094 /// Note that this method is called before [`Self::peer_connected`].
1095 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1098 /// A trait to describe an object that can receive onion messages.
1099 pub trait OnionMessageHandler : OnionMessageProvider {
1100 /// Handle an incoming `onion_message` message from the given peer.
1101 fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
1102 /// Called when a connection is established with a peer. Can be used to track which peers
1103 /// advertise onion message support and are online.
1105 /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1106 /// with us. Implementors should be somewhat conservative about doing so, however, as other
1107 /// message handlers may still wish to communicate with this peer.
1108 fn peer_connected(&self, their_node_id: &PublicKey, init: &Init) -> Result<(), ()>;
1109 /// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
1110 /// drop and refuse to forward onion messages to this peer.
1112 /// Note that in some rare cases this may be called without a corresponding
1113 /// [`Self::peer_connected`].
1114 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
1116 // Handler information:
1117 /// Gets the node feature flags which this handler itself supports. All available handlers are
1118 /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1119 /// which are broadcasted in our [`NodeAnnouncement`] message.
1120 fn provided_node_features(&self) -> NodeFeatures;
1122 /// Gets the init feature flags which should be sent to the given peer. All available handlers
1123 /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1124 /// which are sent in our [`Init`] message.
1126 /// Note that this method is called before [`Self::peer_connected`].
1127 fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1130 mod fuzzy_internal_msgs {
1131 use crate::prelude::*;
1132 use crate::ln::{PaymentPreimage, PaymentSecret};
1134 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1135 // them from untrusted input):
1137 pub(crate) struct FinalOnionHopData {
1138 pub(crate) payment_secret: PaymentSecret,
1139 /// The total value, in msat, of the payment as received by the ultimate recipient.
1140 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1141 pub(crate) total_msat: u64,
1144 pub(crate) enum OnionHopDataFormat {
1146 short_channel_id: u64,
1149 payment_data: Option<FinalOnionHopData>,
1150 keysend_preimage: Option<PaymentPreimage>,
1154 pub struct OnionHopData {
1155 pub(crate) format: OnionHopDataFormat,
1156 /// The value, in msat, of the payment after this hop's fee is deducted.
1157 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1158 pub(crate) amt_to_forward: u64,
1159 pub(crate) outgoing_cltv_value: u32,
1162 pub struct DecodedOnionErrorPacket {
1163 pub(crate) hmac: [u8; 32],
1164 pub(crate) failuremsg: Vec<u8>,
1165 pub(crate) pad: Vec<u8>,
1169 pub use self::fuzzy_internal_msgs::*;
1170 #[cfg(not(fuzzing))]
1171 pub(crate) use self::fuzzy_internal_msgs::*;
1174 pub(crate) struct OnionPacket {
1175 pub(crate) version: u8,
1176 /// In order to ensure we always return an error on onion decode in compliance with [BOLT
1177 /// #4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md), we have to
1178 /// deserialize `OnionPacket`s contained in [`UpdateAddHTLC`] messages even if the ephemeral
1179 /// public key (here) is bogus, so we hold a [`Result`] instead of a [`PublicKey`] as we'd
1181 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
1182 pub(crate) hop_data: [u8; 20*65],
1183 pub(crate) hmac: [u8; 32],
1186 impl onion_utils::Packet for OnionPacket {
1187 type Data = onion_utils::FixedSizeOnionPacket;
1188 fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1191 public_key: Ok(pubkey),
1192 hop_data: hop_data.0,
1198 impl Eq for OnionPacket { }
1199 impl PartialEq for OnionPacket {
1200 fn eq(&self, other: &OnionPacket) -> bool {
1201 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
1202 if i != j { return false; }
1204 self.version == other.version &&
1205 self.public_key == other.public_key &&
1206 self.hmac == other.hmac
1210 impl fmt::Debug for OnionPacket {
1211 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1212 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1216 #[derive(Clone, Debug, PartialEq, Eq)]
1217 pub(crate) struct OnionErrorPacket {
1218 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1219 // (TODO) We limit it in decode to much lower...
1220 pub(crate) data: Vec<u8>,
1223 impl fmt::Display for DecodeError {
1224 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1226 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1227 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1228 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1229 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1230 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1231 DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1232 DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1237 impl From<io::Error> for DecodeError {
1238 fn from(e: io::Error) -> Self {
1239 if e.kind() == io::ErrorKind::UnexpectedEof {
1240 DecodeError::ShortRead
1242 DecodeError::Io(e.kind())
1247 impl Writeable for OptionalField<Script> {
1248 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1250 OptionalField::Present(ref script) => {
1251 // Note that Writeable for script includes the 16-bit length tag for us
1254 OptionalField::Absent => {}
1260 impl Readable for OptionalField<Script> {
1261 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1262 match <u16 as Readable>::read(r) {
1264 let mut buf = vec![0; len as usize];
1265 r.read_exact(&mut buf)?;
1266 Ok(OptionalField::Present(Script::from(buf)))
1268 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1274 impl Writeable for OptionalField<u64> {
1275 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1277 OptionalField::Present(ref value) => {
1280 OptionalField::Absent => {}
1286 impl Readable for OptionalField<u64> {
1287 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1288 let value: u64 = Readable::read(r)?;
1289 Ok(OptionalField::Present(value))
1294 impl_writeable_msg!(AcceptChannel, {
1295 temporary_channel_id,
1296 dust_limit_satoshis,
1297 max_htlc_value_in_flight_msat,
1298 channel_reserve_satoshis,
1304 revocation_basepoint,
1306 delayed_payment_basepoint,
1308 first_per_commitment_point,
1309 shutdown_scriptpubkey
1311 (1, channel_type, option),
1314 impl_writeable_msg!(AnnouncementSignatures, {
1321 impl Writeable for ChannelReestablish {
1322 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1323 self.channel_id.write(w)?;
1324 self.next_local_commitment_number.write(w)?;
1325 self.next_remote_commitment_number.write(w)?;
1326 match self.data_loss_protect {
1327 OptionalField::Present(ref data_loss_protect) => {
1328 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1329 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1331 OptionalField::Absent => {}
1337 impl Readable for ChannelReestablish{
1338 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1340 channel_id: Readable::read(r)?,
1341 next_local_commitment_number: Readable::read(r)?,
1342 next_remote_commitment_number: Readable::read(r)?,
1343 data_loss_protect: {
1344 match <[u8; 32] as Readable>::read(r) {
1345 Ok(your_last_per_commitment_secret) =>
1346 OptionalField::Present(DataLossProtect {
1347 your_last_per_commitment_secret,
1348 my_current_per_commitment_point: Readable::read(r)?,
1350 Err(DecodeError::ShortRead) => OptionalField::Absent,
1351 Err(e) => return Err(e)
1358 impl_writeable_msg!(ClosingSigned,
1359 { channel_id, fee_satoshis, signature },
1360 { (1, fee_range, option) }
1363 impl_writeable!(ClosingSignedFeeRange, {
1368 impl_writeable_msg!(CommitmentSigned, {
1374 impl_writeable!(DecodedOnionErrorPacket, {
1380 impl_writeable_msg!(FundingCreated, {
1381 temporary_channel_id,
1383 funding_output_index,
1387 impl_writeable_msg!(FundingSigned, {
1392 impl_writeable_msg!(ChannelReady, {
1394 next_per_commitment_point,
1396 (1, short_channel_id_alias, option),
1399 impl Writeable for Init {
1400 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1401 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1402 // our relevant feature bits. This keeps us compatible with old nodes.
1403 self.features.write_up_to_13(w)?;
1404 self.features.write(w)?;
1405 encode_tlv_stream!(w, {
1406 (3, self.remote_network_address, option)
1412 impl Readable for Init {
1413 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1414 let global_features: InitFeatures = Readable::read(r)?;
1415 let features: InitFeatures = Readable::read(r)?;
1416 let mut remote_network_address: Option<NetAddress> = None;
1417 decode_tlv_stream!(r, {
1418 (3, remote_network_address, option)
1421 features: features.or(global_features),
1422 remote_network_address,
1427 impl_writeable_msg!(OpenChannel, {
1429 temporary_channel_id,
1432 dust_limit_satoshis,
1433 max_htlc_value_in_flight_msat,
1434 channel_reserve_satoshis,
1440 revocation_basepoint,
1442 delayed_payment_basepoint,
1444 first_per_commitment_point,
1446 shutdown_scriptpubkey
1448 (1, channel_type, option),
1451 impl_writeable_msg!(RevokeAndACK, {
1453 per_commitment_secret,
1454 next_per_commitment_point
1457 impl_writeable_msg!(Shutdown, {
1462 impl_writeable_msg!(UpdateFailHTLC, {
1468 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1475 impl_writeable_msg!(UpdateFee, {
1480 impl_writeable_msg!(UpdateFulfillHTLC, {
1486 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1487 // serialization format in a way which assumes we know the total serialized length/message end
1489 impl_writeable!(OnionErrorPacket, {
1493 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1494 // serialization format in a way which assumes we know the total serialized length/message end
1496 impl Writeable for OnionPacket {
1497 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1498 self.version.write(w)?;
1499 match self.public_key {
1500 Ok(pubkey) => pubkey.write(w)?,
1501 Err(_) => [0u8;33].write(w)?,
1503 w.write_all(&self.hop_data)?;
1504 self.hmac.write(w)?;
1509 impl Readable for OnionPacket {
1510 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1512 version: Readable::read(r)?,
1514 let mut buf = [0u8;33];
1515 r.read_exact(&mut buf)?;
1516 PublicKey::from_slice(&buf)
1518 hop_data: Readable::read(r)?,
1519 hmac: Readable::read(r)?,
1524 impl_writeable_msg!(UpdateAddHTLC, {
1530 onion_routing_packet
1533 impl Readable for OnionMessage {
1534 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1535 let blinding_point: PublicKey = Readable::read(r)?;
1536 let len: u16 = Readable::read(r)?;
1537 let mut packet_reader = FixedLengthReader::new(r, len as u64);
1538 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
1541 onion_routing_packet,
1546 impl Writeable for OnionMessage {
1547 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1548 self.blinding_point.write(w)?;
1549 let onion_packet_len = self.onion_routing_packet.serialized_length();
1550 (onion_packet_len as u16).write(w)?;
1551 self.onion_routing_packet.write(w)?;
1556 impl Writeable for FinalOnionHopData {
1557 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1558 self.payment_secret.0.write(w)?;
1559 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
1563 impl Readable for FinalOnionHopData {
1564 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1565 let secret: [u8; 32] = Readable::read(r)?;
1566 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
1567 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1571 impl Writeable for OnionHopData {
1572 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1574 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1575 _encode_varint_length_prefixed_tlv!(w, {
1576 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1577 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1578 (6, short_channel_id, required)
1581 OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1582 _encode_varint_length_prefixed_tlv!(w, {
1583 (2, HighZeroBytesDroppedBigSize(self.amt_to_forward), required),
1584 (4, HighZeroBytesDroppedBigSize(self.outgoing_cltv_value), required),
1585 (8, payment_data, option),
1586 (5482373484, keysend_preimage, option)
1594 impl Readable for OnionHopData {
1595 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1596 let mut amt = HighZeroBytesDroppedBigSize(0u64);
1597 let mut cltv_value = HighZeroBytesDroppedBigSize(0u32);
1598 let mut short_id: Option<u64> = None;
1599 let mut payment_data: Option<FinalOnionHopData> = None;
1600 let mut keysend_preimage: Option<PaymentPreimage> = None;
1601 read_tlv_fields!(r, {
1603 (4, cltv_value, required),
1604 (6, short_id, option),
1605 (8, payment_data, option),
1606 // See https://github.com/lightning/blips/blob/master/blip-0003.md
1607 (5482373484, keysend_preimage, option)
1610 let format = if let Some(short_channel_id) = short_id {
1611 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1612 OnionHopDataFormat::NonFinalNode {
1616 if let &Some(ref data) = &payment_data {
1617 if data.total_msat > MAX_VALUE_MSAT {
1618 return Err(DecodeError::InvalidValue);
1621 OnionHopDataFormat::FinalNode {
1627 if amt.0 > MAX_VALUE_MSAT {
1628 return Err(DecodeError::InvalidValue);
1632 amt_to_forward: amt.0,
1633 outgoing_cltv_value: cltv_value.0,
1638 // ReadableArgs because we need onion_utils::decode_next_hop to accommodate payment packets and
1639 // onion message packets.
1640 impl ReadableArgs<()> for OnionHopData {
1641 fn read<R: Read>(r: &mut R, _arg: ()) -> Result<Self, DecodeError> {
1642 <Self as Readable>::read(r)
1646 impl Writeable for Ping {
1647 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1648 self.ponglen.write(w)?;
1649 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1654 impl Readable for Ping {
1655 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1657 ponglen: Readable::read(r)?,
1659 let byteslen = Readable::read(r)?;
1660 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1667 impl Writeable for Pong {
1668 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1669 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1674 impl Readable for Pong {
1675 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1678 let byteslen = Readable::read(r)?;
1679 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1686 impl Writeable for UnsignedChannelAnnouncement {
1687 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1688 self.features.write(w)?;
1689 self.chain_hash.write(w)?;
1690 self.short_channel_id.write(w)?;
1691 self.node_id_1.write(w)?;
1692 self.node_id_2.write(w)?;
1693 self.bitcoin_key_1.write(w)?;
1694 self.bitcoin_key_2.write(w)?;
1695 w.write_all(&self.excess_data[..])?;
1700 impl Readable for UnsignedChannelAnnouncement {
1701 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1703 features: Readable::read(r)?,
1704 chain_hash: Readable::read(r)?,
1705 short_channel_id: Readable::read(r)?,
1706 node_id_1: Readable::read(r)?,
1707 node_id_2: Readable::read(r)?,
1708 bitcoin_key_1: Readable::read(r)?,
1709 bitcoin_key_2: Readable::read(r)?,
1710 excess_data: read_to_end(r)?,
1715 impl_writeable!(ChannelAnnouncement, {
1718 bitcoin_signature_1,
1719 bitcoin_signature_2,
1723 impl Writeable for UnsignedChannelUpdate {
1724 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1725 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
1726 const MESSAGE_FLAGS: u8 = 1;
1727 self.chain_hash.write(w)?;
1728 self.short_channel_id.write(w)?;
1729 self.timestamp.write(w)?;
1730 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
1731 all_flags.write(w)?;
1732 self.cltv_expiry_delta.write(w)?;
1733 self.htlc_minimum_msat.write(w)?;
1734 self.fee_base_msat.write(w)?;
1735 self.fee_proportional_millionths.write(w)?;
1736 self.htlc_maximum_msat.write(w)?;
1737 w.write_all(&self.excess_data[..])?;
1742 impl Readable for UnsignedChannelUpdate {
1743 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1745 chain_hash: Readable::read(r)?,
1746 short_channel_id: Readable::read(r)?,
1747 timestamp: Readable::read(r)?,
1749 let flags: u16 = Readable::read(r)?;
1750 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
1753 cltv_expiry_delta: Readable::read(r)?,
1754 htlc_minimum_msat: Readable::read(r)?,
1755 fee_base_msat: Readable::read(r)?,
1756 fee_proportional_millionths: Readable::read(r)?,
1757 htlc_maximum_msat: Readable::read(r)?,
1758 excess_data: read_to_end(r)?,
1763 impl_writeable!(ChannelUpdate, {
1768 impl Writeable for ErrorMessage {
1769 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1770 self.channel_id.write(w)?;
1771 (self.data.len() as u16).write(w)?;
1772 w.write_all(self.data.as_bytes())?;
1777 impl Readable for ErrorMessage {
1778 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1780 channel_id: Readable::read(r)?,
1782 let sz: usize = <u16 as Readable>::read(r)? as usize;
1783 let mut data = Vec::with_capacity(sz);
1785 r.read_exact(&mut data)?;
1786 match String::from_utf8(data) {
1788 Err(_) => return Err(DecodeError::InvalidValue),
1795 impl Writeable for WarningMessage {
1796 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1797 self.channel_id.write(w)?;
1798 (self.data.len() as u16).write(w)?;
1799 w.write_all(self.data.as_bytes())?;
1804 impl Readable for WarningMessage {
1805 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1807 channel_id: Readable::read(r)?,
1809 let sz: usize = <u16 as Readable>::read(r)? as usize;
1810 let mut data = Vec::with_capacity(sz);
1812 r.read_exact(&mut data)?;
1813 match String::from_utf8(data) {
1815 Err(_) => return Err(DecodeError::InvalidValue),
1822 impl Writeable for UnsignedNodeAnnouncement {
1823 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1824 self.features.write(w)?;
1825 self.timestamp.write(w)?;
1826 self.node_id.write(w)?;
1827 w.write_all(&self.rgb)?;
1828 self.alias.write(w)?;
1830 let mut addr_len = 0;
1831 for addr in self.addresses.iter() {
1832 addr_len += 1 + addr.len();
1834 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1835 for addr in self.addresses.iter() {
1838 w.write_all(&self.excess_address_data[..])?;
1839 w.write_all(&self.excess_data[..])?;
1844 impl Readable for UnsignedNodeAnnouncement {
1845 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1846 let features: NodeFeatures = Readable::read(r)?;
1847 let timestamp: u32 = Readable::read(r)?;
1848 let node_id: PublicKey = Readable::read(r)?;
1849 let mut rgb = [0; 3];
1850 r.read_exact(&mut rgb)?;
1851 let alias: [u8; 32] = Readable::read(r)?;
1853 let addr_len: u16 = Readable::read(r)?;
1854 let mut addresses: Vec<NetAddress> = Vec::new();
1855 let mut addr_readpos = 0;
1856 let mut excess = false;
1857 let mut excess_byte = 0;
1859 if addr_len <= addr_readpos { break; }
1860 match Readable::read(r) {
1862 if addr_len < addr_readpos + 1 + addr.len() {
1863 return Err(DecodeError::BadLengthDescriptor);
1865 addr_readpos += (1 + addr.len()) as u16;
1866 addresses.push(addr);
1868 Ok(Err(unknown_descriptor)) => {
1870 excess_byte = unknown_descriptor;
1873 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1874 Err(e) => return Err(e),
1878 let mut excess_data = vec![];
1879 let excess_address_data = if addr_readpos < addr_len {
1880 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1881 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1883 excess_address_data[0] = excess_byte;
1888 excess_data.push(excess_byte);
1892 excess_data.extend(read_to_end(r)?.iter());
1893 Ok(UnsignedNodeAnnouncement {
1900 excess_address_data,
1906 impl_writeable!(NodeAnnouncement, {
1911 impl Readable for QueryShortChannelIds {
1912 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1913 let chain_hash: BlockHash = Readable::read(r)?;
1915 let encoding_len: u16 = Readable::read(r)?;
1916 let encoding_type: u8 = Readable::read(r)?;
1918 // Must be encoding_type=0 uncompressed serialization. We do not
1919 // support encoding_type=1 zlib serialization.
1920 if encoding_type != EncodingType::Uncompressed as u8 {
1921 return Err(DecodeError::UnsupportedCompression);
1924 // We expect the encoding_len to always includes the 1-byte
1925 // encoding_type and that short_channel_ids are 8-bytes each
1926 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1927 return Err(DecodeError::InvalidValue);
1930 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1931 // less the 1-byte encoding_type
1932 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1933 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1934 for _ in 0..short_channel_id_count {
1935 short_channel_ids.push(Readable::read(r)?);
1938 Ok(QueryShortChannelIds {
1945 impl Writeable for QueryShortChannelIds {
1946 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1947 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1948 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1950 self.chain_hash.write(w)?;
1951 encoding_len.write(w)?;
1953 // We only support type=0 uncompressed serialization
1954 (EncodingType::Uncompressed as u8).write(w)?;
1956 for scid in self.short_channel_ids.iter() {
1964 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1969 impl QueryChannelRange {
1970 /// Calculates the overflow safe ending block height for the query.
1972 /// Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`.
1973 pub fn end_blocknum(&self) -> u32 {
1974 match self.first_blocknum.checked_add(self.number_of_blocks) {
1975 Some(block) => block,
1976 None => u32::max_value(),
1981 impl_writeable_msg!(QueryChannelRange, {
1987 impl Readable for ReplyChannelRange {
1988 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1989 let chain_hash: BlockHash = Readable::read(r)?;
1990 let first_blocknum: u32 = Readable::read(r)?;
1991 let number_of_blocks: u32 = Readable::read(r)?;
1992 let sync_complete: bool = Readable::read(r)?;
1994 let encoding_len: u16 = Readable::read(r)?;
1995 let encoding_type: u8 = Readable::read(r)?;
1997 // Must be encoding_type=0 uncompressed serialization. We do not
1998 // support encoding_type=1 zlib serialization.
1999 if encoding_type != EncodingType::Uncompressed as u8 {
2000 return Err(DecodeError::UnsupportedCompression);
2003 // We expect the encoding_len to always includes the 1-byte
2004 // encoding_type and that short_channel_ids are 8-bytes each
2005 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2006 return Err(DecodeError::InvalidValue);
2009 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2010 // less the 1-byte encoding_type
2011 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2012 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2013 for _ in 0..short_channel_id_count {
2014 short_channel_ids.push(Readable::read(r)?);
2017 Ok(ReplyChannelRange {
2027 impl Writeable for ReplyChannelRange {
2028 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2029 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2030 self.chain_hash.write(w)?;
2031 self.first_blocknum.write(w)?;
2032 self.number_of_blocks.write(w)?;
2033 self.sync_complete.write(w)?;
2035 encoding_len.write(w)?;
2036 (EncodingType::Uncompressed as u8).write(w)?;
2037 for scid in self.short_channel_ids.iter() {
2045 impl_writeable_msg!(GossipTimestampFilter, {
2054 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
2055 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
2056 use crate::ln::msgs;
2057 use crate::ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
2058 use crate::routing::gossip::NodeId;
2059 use crate::util::ser::{Writeable, Readable, Hostname};
2061 use bitcoin::hashes::hex::FromHex;
2062 use bitcoin::util::address::Address;
2063 use bitcoin::network::constants::Network;
2064 use bitcoin::blockdata::script::Builder;
2065 use bitcoin::blockdata::opcodes;
2066 use bitcoin::hash_types::{Txid, BlockHash};
2068 use bitcoin::secp256k1::{PublicKey,SecretKey};
2069 use bitcoin::secp256k1::{Secp256k1, Message};
2071 use crate::io::{self, Cursor};
2072 use crate::prelude::*;
2073 use core::convert::TryFrom;
2076 fn encoding_channel_reestablish_no_secret() {
2077 let cr = msgs::ChannelReestablish {
2078 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],
2079 next_local_commitment_number: 3,
2080 next_remote_commitment_number: 4,
2081 data_loss_protect: OptionalField::Absent,
2084 let encoded_value = cr.encode();
2087 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]
2092 fn encoding_channel_reestablish_with_secret() {
2094 let secp_ctx = Secp256k1::new();
2095 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2098 let cr = msgs::ChannelReestablish {
2099 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],
2100 next_local_commitment_number: 3,
2101 next_remote_commitment_number: 4,
2102 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
2105 let encoded_value = cr.encode();
2108 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]
2112 macro_rules! get_keys_from {
2113 ($slice: expr, $secp_ctx: expr) => {
2115 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
2116 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2122 macro_rules! get_sig_on {
2123 ($privkey: expr, $ctx: expr, $string: expr) => {
2125 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2126 $ctx.sign_ecdsa(&sighash, &$privkey)
2132 fn encoding_announcement_signatures() {
2133 let secp_ctx = Secp256k1::new();
2134 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2135 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2136 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2137 let announcement_signatures = msgs::AnnouncementSignatures {
2138 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],
2139 short_channel_id: 2316138423780173,
2140 node_signature: sig_1,
2141 bitcoin_signature: sig_2,
2144 let encoded_value = announcement_signatures.encode();
2145 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2148 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2149 let secp_ctx = Secp256k1::new();
2150 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2151 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2152 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2153 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2154 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2155 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2156 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2157 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2158 let mut features = ChannelFeatures::empty();
2159 if unknown_features_bits {
2160 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2162 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2164 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2165 short_channel_id: 2316138423780173,
2166 node_id_1: NodeId::from_pubkey(&pubkey_1),
2167 node_id_2: NodeId::from_pubkey(&pubkey_2),
2168 bitcoin_key_1: NodeId::from_pubkey(&pubkey_3),
2169 bitcoin_key_2: NodeId::from_pubkey(&pubkey_4),
2170 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
2172 let channel_announcement = msgs::ChannelAnnouncement {
2173 node_signature_1: sig_1,
2174 node_signature_2: sig_2,
2175 bitcoin_signature_1: sig_3,
2176 bitcoin_signature_2: sig_4,
2177 contents: unsigned_channel_announcement,
2179 let encoded_value = channel_announcement.encode();
2180 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
2181 if unknown_features_bits {
2182 target_value.append(&mut hex::decode("0002ffff").unwrap());
2184 target_value.append(&mut hex::decode("0000").unwrap());
2186 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2187 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
2189 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
2191 assert_eq!(encoded_value, target_value);
2195 fn encoding_channel_announcement() {
2196 do_encoding_channel_announcement(true, false);
2197 do_encoding_channel_announcement(false, true);
2198 do_encoding_channel_announcement(false, false);
2199 do_encoding_channel_announcement(true, true);
2202 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) {
2203 let secp_ctx = Secp256k1::new();
2204 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2205 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2206 let features = if unknown_features_bits {
2207 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2209 // Set to some features we may support
2210 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2212 let mut addresses = Vec::new();
2214 addresses.push(msgs::NetAddress::IPv4 {
2215 addr: [255, 254, 253, 252],
2220 addresses.push(msgs::NetAddress::IPv6 {
2221 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2226 addresses.push(msgs::NetAddress::OnionV2(
2227 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2231 addresses.push(msgs::NetAddress::OnionV3 {
2232 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],
2239 addresses.push(msgs::NetAddress::Hostname {
2240 hostname: Hostname::try_from(String::from("host")).unwrap(),
2244 let mut addr_len = 0;
2245 for addr in &addresses {
2246 addr_len += addr.len() + 1;
2248 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2250 timestamp: 20190119,
2255 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() },
2256 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() },
2258 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2259 let node_announcement = msgs::NodeAnnouncement {
2261 contents: unsigned_node_announcement,
2263 let encoded_value = node_announcement.encode();
2264 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2265 if unknown_features_bits {
2266 target_value.append(&mut hex::decode("0002ffff").unwrap());
2268 target_value.append(&mut hex::decode("000122").unwrap());
2270 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2271 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2273 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2276 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2279 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2282 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2285 target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2287 if excess_address_data {
2288 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2291 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2293 assert_eq!(encoded_value, target_value);
2297 fn encoding_node_announcement() {
2298 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2299 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2300 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2301 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2302 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2303 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2304 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2305 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2306 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2307 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2310 fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
2311 let secp_ctx = Secp256k1::new();
2312 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2313 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2314 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2315 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2316 short_channel_id: 2316138423780173,
2317 timestamp: 20190119,
2318 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2319 cltv_expiry_delta: 144,
2320 htlc_minimum_msat: 1000000,
2321 htlc_maximum_msat: 131355275467161,
2322 fee_base_msat: 10000,
2323 fee_proportional_millionths: 20,
2324 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2326 let channel_update = msgs::ChannelUpdate {
2328 contents: unsigned_channel_update
2330 let encoded_value = channel_update.encode();
2331 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2332 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2333 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2334 target_value.append(&mut hex::decode("01").unwrap());
2335 target_value.append(&mut hex::decode("00").unwrap());
2337 let flag = target_value.last_mut().unwrap();
2341 let flag = target_value.last_mut().unwrap();
2342 *flag = *flag | 1 << 1;
2344 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2345 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2347 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2349 assert_eq!(encoded_value, target_value);
2353 fn encoding_channel_update() {
2354 do_encoding_channel_update(false, false, false);
2355 do_encoding_channel_update(false, false, true);
2356 do_encoding_channel_update(true, false, false);
2357 do_encoding_channel_update(true, false, true);
2358 do_encoding_channel_update(false, true, false);
2359 do_encoding_channel_update(false, true, true);
2360 do_encoding_channel_update(true, true, false);
2361 do_encoding_channel_update(true, true, true);
2364 fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2365 let secp_ctx = Secp256k1::new();
2366 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2367 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2368 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2369 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2370 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2371 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2372 let open_channel = msgs::OpenChannel {
2373 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2374 temporary_channel_id: [2; 32],
2375 funding_satoshis: 1311768467284833366,
2376 push_msat: 2536655962884945560,
2377 dust_limit_satoshis: 3608586615801332854,
2378 max_htlc_value_in_flight_msat: 8517154655701053848,
2379 channel_reserve_satoshis: 8665828695742877976,
2380 htlc_minimum_msat: 2316138423780173,
2381 feerate_per_kw: 821716,
2382 to_self_delay: 49340,
2383 max_accepted_htlcs: 49340,
2384 funding_pubkey: pubkey_1,
2385 revocation_basepoint: pubkey_2,
2386 payment_point: pubkey_3,
2387 delayed_payment_basepoint: pubkey_4,
2388 htlc_basepoint: pubkey_5,
2389 first_per_commitment_point: pubkey_6,
2390 channel_flags: if random_bit { 1 << 5 } else { 0 },
2391 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2392 channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2394 let encoded_value = open_channel.encode();
2395 let mut target_value = Vec::new();
2396 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2397 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2399 target_value.append(&mut hex::decode("20").unwrap());
2401 target_value.append(&mut hex::decode("00").unwrap());
2404 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2407 target_value.append(&mut hex::decode("0100").unwrap());
2409 assert_eq!(encoded_value, target_value);
2413 fn encoding_open_channel() {
2414 do_encoding_open_channel(false, false, false);
2415 do_encoding_open_channel(false, false, true);
2416 do_encoding_open_channel(false, true, false);
2417 do_encoding_open_channel(false, true, true);
2418 do_encoding_open_channel(true, false, false);
2419 do_encoding_open_channel(true, false, true);
2420 do_encoding_open_channel(true, true, false);
2421 do_encoding_open_channel(true, true, true);
2424 fn do_encoding_accept_channel(shutdown: bool) {
2425 let secp_ctx = Secp256k1::new();
2426 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2427 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2428 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2429 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2430 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2431 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2432 let accept_channel = msgs::AcceptChannel {
2433 temporary_channel_id: [2; 32],
2434 dust_limit_satoshis: 1311768467284833366,
2435 max_htlc_value_in_flight_msat: 2536655962884945560,
2436 channel_reserve_satoshis: 3608586615801332854,
2437 htlc_minimum_msat: 2316138423780173,
2438 minimum_depth: 821716,
2439 to_self_delay: 49340,
2440 max_accepted_htlcs: 49340,
2441 funding_pubkey: pubkey_1,
2442 revocation_basepoint: pubkey_2,
2443 payment_point: pubkey_3,
2444 delayed_payment_basepoint: pubkey_4,
2445 htlc_basepoint: pubkey_5,
2446 first_per_commitment_point: pubkey_6,
2447 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2450 let encoded_value = accept_channel.encode();
2451 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2453 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2455 assert_eq!(encoded_value, target_value);
2459 fn encoding_accept_channel() {
2460 do_encoding_accept_channel(false);
2461 do_encoding_accept_channel(true);
2465 fn encoding_funding_created() {
2466 let secp_ctx = Secp256k1::new();
2467 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2468 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2469 let funding_created = msgs::FundingCreated {
2470 temporary_channel_id: [2; 32],
2471 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2472 funding_output_index: 255,
2475 let encoded_value = funding_created.encode();
2476 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2477 assert_eq!(encoded_value, target_value);
2481 fn encoding_funding_signed() {
2482 let secp_ctx = Secp256k1::new();
2483 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2484 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2485 let funding_signed = msgs::FundingSigned {
2486 channel_id: [2; 32],
2489 let encoded_value = funding_signed.encode();
2490 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2491 assert_eq!(encoded_value, target_value);
2495 fn encoding_channel_ready() {
2496 let secp_ctx = Secp256k1::new();
2497 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2498 let channel_ready = msgs::ChannelReady {
2499 channel_id: [2; 32],
2500 next_per_commitment_point: pubkey_1,
2501 short_channel_id_alias: None,
2503 let encoded_value = channel_ready.encode();
2504 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2505 assert_eq!(encoded_value, target_value);
2508 fn do_encoding_shutdown(script_type: u8) {
2509 let secp_ctx = Secp256k1::new();
2510 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2511 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2512 let shutdown = msgs::Shutdown {
2513 channel_id: [2; 32],
2515 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2516 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2517 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2518 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2520 let encoded_value = shutdown.encode();
2521 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2522 if script_type == 1 {
2523 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2524 } else if script_type == 2 {
2525 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2526 } else if script_type == 3 {
2527 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2528 } else if script_type == 4 {
2529 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2531 assert_eq!(encoded_value, target_value);
2535 fn encoding_shutdown() {
2536 do_encoding_shutdown(1);
2537 do_encoding_shutdown(2);
2538 do_encoding_shutdown(3);
2539 do_encoding_shutdown(4);
2543 fn encoding_closing_signed() {
2544 let secp_ctx = Secp256k1::new();
2545 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2546 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2547 let closing_signed = msgs::ClosingSigned {
2548 channel_id: [2; 32],
2549 fee_satoshis: 2316138423780173,
2553 let encoded_value = closing_signed.encode();
2554 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2555 assert_eq!(encoded_value, target_value);
2556 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2558 let closing_signed_with_range = msgs::ClosingSigned {
2559 channel_id: [2; 32],
2560 fee_satoshis: 2316138423780173,
2562 fee_range: Some(msgs::ClosingSignedFeeRange {
2563 min_fee_satoshis: 0xdeadbeef,
2564 max_fee_satoshis: 0x1badcafe01234567,
2567 let encoded_value_with_range = closing_signed_with_range.encode();
2568 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2569 assert_eq!(encoded_value_with_range, target_value_with_range);
2570 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2571 closing_signed_with_range);
2575 fn encoding_update_add_htlc() {
2576 let secp_ctx = Secp256k1::new();
2577 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2578 let onion_routing_packet = msgs::OnionPacket {
2580 public_key: Ok(pubkey_1),
2581 hop_data: [1; 20*65],
2584 let update_add_htlc = msgs::UpdateAddHTLC {
2585 channel_id: [2; 32],
2586 htlc_id: 2316138423780173,
2587 amount_msat: 3608586615801332854,
2588 payment_hash: PaymentHash([1; 32]),
2589 cltv_expiry: 821716,
2590 onion_routing_packet
2592 let encoded_value = update_add_htlc.encode();
2593 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2594 assert_eq!(encoded_value, target_value);
2598 fn encoding_update_fulfill_htlc() {
2599 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2600 channel_id: [2; 32],
2601 htlc_id: 2316138423780173,
2602 payment_preimage: PaymentPreimage([1; 32]),
2604 let encoded_value = update_fulfill_htlc.encode();
2605 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2606 assert_eq!(encoded_value, target_value);
2610 fn encoding_update_fail_htlc() {
2611 let reason = OnionErrorPacket {
2612 data: [1; 32].to_vec(),
2614 let update_fail_htlc = msgs::UpdateFailHTLC {
2615 channel_id: [2; 32],
2616 htlc_id: 2316138423780173,
2619 let encoded_value = update_fail_htlc.encode();
2620 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2621 assert_eq!(encoded_value, target_value);
2625 fn encoding_update_fail_malformed_htlc() {
2626 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2627 channel_id: [2; 32],
2628 htlc_id: 2316138423780173,
2629 sha256_of_onion: [1; 32],
2632 let encoded_value = update_fail_malformed_htlc.encode();
2633 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2634 assert_eq!(encoded_value, target_value);
2637 fn do_encoding_commitment_signed(htlcs: bool) {
2638 let secp_ctx = Secp256k1::new();
2639 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2640 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2641 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2642 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2643 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2644 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2645 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2646 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2647 let commitment_signed = msgs::CommitmentSigned {
2648 channel_id: [2; 32],
2650 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2652 let encoded_value = commitment_signed.encode();
2653 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2655 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2657 target_value.append(&mut hex::decode("0000").unwrap());
2659 assert_eq!(encoded_value, target_value);
2663 fn encoding_commitment_signed() {
2664 do_encoding_commitment_signed(true);
2665 do_encoding_commitment_signed(false);
2669 fn encoding_revoke_and_ack() {
2670 let secp_ctx = Secp256k1::new();
2671 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2672 let raa = msgs::RevokeAndACK {
2673 channel_id: [2; 32],
2674 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],
2675 next_per_commitment_point: pubkey_1,
2677 let encoded_value = raa.encode();
2678 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2679 assert_eq!(encoded_value, target_value);
2683 fn encoding_update_fee() {
2684 let update_fee = msgs::UpdateFee {
2685 channel_id: [2; 32],
2686 feerate_per_kw: 20190119,
2688 let encoded_value = update_fee.encode();
2689 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2690 assert_eq!(encoded_value, target_value);
2694 fn encoding_init() {
2695 assert_eq!(msgs::Init {
2696 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2697 remote_network_address: None,
2698 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2699 assert_eq!(msgs::Init {
2700 features: InitFeatures::from_le_bytes(vec![0xFF]),
2701 remote_network_address: None,
2702 }.encode(), hex::decode("0001ff0001ff").unwrap());
2703 assert_eq!(msgs::Init {
2704 features: InitFeatures::from_le_bytes(vec![]),
2705 remote_network_address: None,
2706 }.encode(), hex::decode("00000000").unwrap());
2708 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2709 remote_network_address: Some(msgs::NetAddress::IPv4 {
2710 addr: [127, 0, 0, 1],
2714 let encoded_value = init_msg.encode();
2715 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2716 assert_eq!(encoded_value, target_value);
2717 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2721 fn encoding_error() {
2722 let error = msgs::ErrorMessage {
2723 channel_id: [2; 32],
2724 data: String::from("rust-lightning"),
2726 let encoded_value = error.encode();
2727 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2728 assert_eq!(encoded_value, target_value);
2732 fn encoding_warning() {
2733 let error = msgs::WarningMessage {
2734 channel_id: [2; 32],
2735 data: String::from("rust-lightning"),
2737 let encoded_value = error.encode();
2738 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2739 assert_eq!(encoded_value, target_value);
2743 fn encoding_ping() {
2744 let ping = msgs::Ping {
2748 let encoded_value = ping.encode();
2749 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2750 assert_eq!(encoded_value, target_value);
2754 fn encoding_pong() {
2755 let pong = msgs::Pong {
2758 let encoded_value = pong.encode();
2759 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2760 assert_eq!(encoded_value, target_value);
2764 fn encoding_nonfinal_onion_hop_data() {
2765 let mut msg = msgs::OnionHopData {
2766 format: OnionHopDataFormat::NonFinalNode {
2767 short_channel_id: 0xdeadbeef1bad1dea,
2769 amt_to_forward: 0x0badf00d01020304,
2770 outgoing_cltv_value: 0xffffffff,
2772 let encoded_value = msg.encode();
2773 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2774 assert_eq!(encoded_value, target_value);
2775 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2776 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2777 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2778 } else { panic!(); }
2779 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2780 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2784 fn encoding_final_onion_hop_data() {
2785 let mut msg = msgs::OnionHopData {
2786 format: OnionHopDataFormat::FinalNode {
2788 keysend_preimage: None,
2790 amt_to_forward: 0x0badf00d01020304,
2791 outgoing_cltv_value: 0xffffffff,
2793 let encoded_value = msg.encode();
2794 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2795 assert_eq!(encoded_value, target_value);
2796 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2797 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2798 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2799 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2803 fn encoding_final_onion_hop_data_with_secret() {
2804 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2805 let mut msg = msgs::OnionHopData {
2806 format: OnionHopDataFormat::FinalNode {
2807 payment_data: Some(FinalOnionHopData {
2808 payment_secret: expected_payment_secret,
2809 total_msat: 0x1badca1f
2811 keysend_preimage: None,
2813 amt_to_forward: 0x0badf00d01020304,
2814 outgoing_cltv_value: 0xffffffff,
2816 let encoded_value = msg.encode();
2817 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2818 assert_eq!(encoded_value, target_value);
2819 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2820 if let OnionHopDataFormat::FinalNode {
2821 payment_data: Some(FinalOnionHopData {
2823 total_msat: 0x1badca1f
2825 keysend_preimage: None,
2827 assert_eq!(payment_secret, expected_payment_secret);
2828 } else { panic!(); }
2829 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2830 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2834 fn query_channel_range_end_blocknum() {
2835 let tests: Vec<(u32, u32, u32)> = vec![
2836 (10000, 1500, 11500),
2837 (0, 0xffffffff, 0xffffffff),
2838 (1, 0xffffffff, 0xffffffff),
2841 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2842 let sut = msgs::QueryChannelRange {
2843 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2847 assert_eq!(sut.end_blocknum(), expected);
2852 fn encoding_query_channel_range() {
2853 let mut query_channel_range = msgs::QueryChannelRange {
2854 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2855 first_blocknum: 100000,
2856 number_of_blocks: 1500,
2858 let encoded_value = query_channel_range.encode();
2859 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2860 assert_eq!(encoded_value, target_value);
2862 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2863 assert_eq!(query_channel_range.first_blocknum, 100000);
2864 assert_eq!(query_channel_range.number_of_blocks, 1500);
2868 fn encoding_reply_channel_range() {
2869 do_encoding_reply_channel_range(0);
2870 do_encoding_reply_channel_range(1);
2873 fn do_encoding_reply_channel_range(encoding_type: u8) {
2874 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2875 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2876 let mut reply_channel_range = msgs::ReplyChannelRange {
2877 chain_hash: expected_chain_hash,
2878 first_blocknum: 756230,
2879 number_of_blocks: 1500,
2880 sync_complete: true,
2881 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2884 if encoding_type == 0 {
2885 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2886 let encoded_value = reply_channel_range.encode();
2887 assert_eq!(encoded_value, target_value);
2889 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2890 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2891 assert_eq!(reply_channel_range.first_blocknum, 756230);
2892 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2893 assert_eq!(reply_channel_range.sync_complete, true);
2894 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2895 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2896 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2898 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2899 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2900 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2905 fn encoding_query_short_channel_ids() {
2906 do_encoding_query_short_channel_ids(0);
2907 do_encoding_query_short_channel_ids(1);
2910 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2911 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2912 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2913 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2914 chain_hash: expected_chain_hash,
2915 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2918 if encoding_type == 0 {
2919 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2920 let encoded_value = query_short_channel_ids.encode();
2921 assert_eq!(encoded_value, target_value);
2923 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2924 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2925 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2926 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2927 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2929 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2930 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2931 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2936 fn encoding_reply_short_channel_ids_end() {
2937 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2938 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2939 chain_hash: expected_chain_hash,
2940 full_information: true,
2942 let encoded_value = reply_short_channel_ids_end.encode();
2943 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2944 assert_eq!(encoded_value, target_value);
2946 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2947 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2948 assert_eq!(reply_short_channel_ids_end.full_information, true);
2952 fn encoding_gossip_timestamp_filter(){
2953 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2954 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2955 chain_hash: expected_chain_hash,
2956 first_timestamp: 1590000000,
2957 timestamp_range: 0xffff_ffff,
2959 let encoded_value = gossip_timestamp_filter.encode();
2960 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2961 assert_eq!(encoded_value, target_value);
2963 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2964 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2965 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2966 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
2970 fn decode_onion_hop_data_len_as_bigsize() {
2971 // Tests that we can decode an onion payload that is >253 bytes.
2972 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
2973 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
2976 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
2977 // payload length to be encoded over multiple bytes rather than a single u8.
2978 let big_payload = encode_big_payload().unwrap();
2979 let mut rd = Cursor::new(&big_payload[..]);
2980 <msgs::OnionHopData as Readable>::read(&mut rd).unwrap();
2982 // see above test, needs to be a separate method for use of the serialization macros.
2983 fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
2984 use crate::util::ser::HighZeroBytesDroppedBigSize;
2985 let payload = msgs::OnionHopData {
2986 format: OnionHopDataFormat::NonFinalNode {
2987 short_channel_id: 0xdeadbeef1bad1dea,
2989 amt_to_forward: 1000,
2990 outgoing_cltv_value: 0xffffffff,
2992 let mut encoded_payload = Vec::new();
2993 let test_bytes = vec![42u8; 1000];
2994 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = payload.format {
2995 _encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
2996 (1, test_bytes, vec_type),
2997 (2, HighZeroBytesDroppedBigSize(payload.amt_to_forward), required),
2998 (4, HighZeroBytesDroppedBigSize(payload.outgoing_cltv_value), required),
2999 (6, short_channel_id, required)