_ Git - rust-lightning/blob - lightning/src/ln/msgs.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
  11 //!
  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
  16 //! daemons/servers.
  17 //!
  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.
  26
  27 use bitcoin::blockdata::constants::ChainHash;
  28 use bitcoin::secp256k1::PublicKey;
  29 use bitcoin::secp256k1::ecdsa::Signature;
  30 use bitcoin::{secp256k1, Witness};
  31 use bitcoin::blockdata::script::ScriptBuf;
  32 use bitcoin::hash_types::Txid;
  33
  34 use crate::blinded_path::payment::{BlindedPaymentTlvs, ForwardTlvs, ReceiveTlvs};
  35 use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
  36 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
  37 use crate::ln::onion_utils;
  38 use crate::onion_message;
  39 use crate::sign::{NodeSigner, Recipient};
  40
  41 use crate::prelude::*;
  42 #[cfg(feature = "std")]
  43 use core::convert::TryFrom;
  44 use core::fmt;
  45 use core::fmt::Debug;
  46 use core::ops::Deref;
  47 #[cfg(feature = "std")]
  48 use core::str::FromStr;
  49 #[cfg(feature = "std")]
  50 use std::net::SocketAddr;
  51 use core::fmt::Display;
  52 use crate::io::{self, Cursor, Read};
  53 use crate::io_extras::read_to_end;
  54
  55 use crate::events::{EventsProvider, MessageSendEventsProvider};
  56 use crate::util::chacha20poly1305rfc::ChaChaPolyReadAdapter;
  57 use crate::util::logger;
  58 use crate::util::ser::{LengthReadable, LengthReadableArgs, Readable, ReadableArgs, Writeable, Writer, WithoutLength, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname, TransactionU16LenLimited, BigSize};
  59 use crate::util::base32;
  60
  61 use crate::routing::gossip::{NodeAlias, NodeId};
  62
  63 /// 21 million * 10^8 * 1000
  64 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
  65
  66 #[cfg(taproot)]
  67 /// A partial signature that also contains the Musig2 nonce its signer used
  68 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
  69 pub struct PartialSignatureWithNonce(pub musig2::types::PartialSignature, pub musig2::types::PublicNonce);
  70
  71 /// An error in decoding a message or struct.
  72 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
  73 pub enum DecodeError {
  74         /// A version byte specified something we don't know how to handle.
  75         ///
  76         /// Includes unknown realm byte in an onion hop data packet.
  77         UnknownVersion,
  78         /// Unknown feature mandating we fail to parse message (e.g., TLV with an even, unknown type)
  79         UnknownRequiredFeature,
  80         /// Value was invalid.
  81         ///
  82         /// For example, a byte which was supposed to be a bool was something other than a 0
  83         /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
  84         /// syntactically incorrect, etc.
  85         InvalidValue,
  86         /// The buffer to be read was too short.
  87         ShortRead,
  88         /// A length descriptor in the packet didn't describe the later data correctly.
  89         BadLengthDescriptor,
  90         /// Error from [`std::io`].
  91         Io(io::ErrorKind),
  92         /// The message included zlib-compressed values, which we don't support.
  93         UnsupportedCompression,
  94 }
  95
  96 /// An [`init`] message to be sent to or received from a peer.
  97 ///
  98 /// [`init`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-init-message
  99 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 100 pub struct Init {
 101         /// The relevant features which the sender supports.
 102         pub features: InitFeatures,
 103         /// Indicates chains the sender is interested in.
 104         ///
 105         /// If there are no common chains, the connection will be closed.
 106         pub networks: Option<Vec<ChainHash>>,
 107         /// The receipient's network address.
 108         ///
 109         /// This adds the option to report a remote IP address back to a connecting peer using the init
 110         /// message. A node can decide to use that information to discover a potential update to its
 111         /// public IPv4 address (NAT) and use that for a [`NodeAnnouncement`] update message containing
 112         /// the new address.
 113         pub remote_network_address: Option<SocketAddress>,
 114 }
 115
 116 /// An [`error`] message to be sent to or received from a peer.
 117 ///
 118 /// [`error`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
 119 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 120 pub struct ErrorMessage {
 121         /// The channel ID involved in the error.
 122         ///
 123         /// All-0s indicates a general error unrelated to a specific channel, after which all channels
 124         /// with the sending peer should be closed.
 125         pub channel_id: ChannelId,
 126         /// A possibly human-readable error description.
 127         ///
 128         /// The string should be sanitized before it is used (e.g., emitted to logs or printed to
 129         /// `stdout`). Otherwise, a well crafted error message may trigger a security vulnerability in
 130         /// the terminal emulator or the logging subsystem.
 131         pub data: String,
 132 }
 133
 134 /// A [`warning`] message to be sent to or received from a peer.
 135 ///
 136 /// [`warning`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages
 137 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 138 pub struct WarningMessage {
 139         /// The channel ID involved in the warning.
 140         ///
 141         /// All-0s indicates a warning unrelated to a specific channel.
 142         pub channel_id: ChannelId,
 143         /// A possibly human-readable warning description.
 144         ///
 145         /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
 146         /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
 147         /// the terminal emulator or the logging subsystem.
 148         pub data: String,
 149 }
 150
 151 /// A [`ping`] message to be sent to or received from a peer.
 152 ///
 153 /// [`ping`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
 154 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 155 pub struct Ping {
 156         /// The desired response length.
 157         pub ponglen: u16,
 158         /// The ping packet size.
 159         ///
 160         /// This field is not sent on the wire. byteslen zeros are sent.
 161         pub byteslen: u16,
 162 }
 163
 164 /// A [`pong`] message to be sent to or received from a peer.
 165 ///
 166 /// [`pong`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
 167 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 168 pub struct Pong {
 169         /// The pong packet size.
 170         ///
 171         /// This field is not sent on the wire. byteslen zeros are sent.
 172         pub byteslen: u16,
 173 }
 174
 175 /// An [`open_channel`] message to be sent to or received from a peer.
 176 ///
 177 /// Used in V1 channel establishment
 178 ///
 179 /// [`open_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
 180 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 181 pub struct OpenChannel {
 182         /// The genesis hash of the blockchain where the channel is to be opened
 183         pub chain_hash: ChainHash,
 184         /// A temporary channel ID, until the funding outpoint is announced
 185         pub temporary_channel_id: ChannelId,
 186         /// The channel value
 187         pub funding_satoshis: u64,
 188         /// The amount to push to the counterparty as part of the open, in milli-satoshi
 189         pub push_msat: u64,
 190         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 191         pub dust_limit_satoshis: u64,
 192         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 193         pub max_htlc_value_in_flight_msat: u64,
 194         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 195         pub channel_reserve_satoshis: u64,
 196         /// The minimum HTLC size incoming to sender, in milli-satoshi
 197         pub htlc_minimum_msat: u64,
 198         /// The feerate per 1000-weight of sender generated transactions, until updated by
 199         /// [`UpdateFee`]
 200         pub feerate_per_kw: u32,
 201         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if
 202         /// they broadcast a commitment transaction
 203         pub to_self_delay: u16,
 204         /// The maximum number of inbound HTLCs towards sender
 205         pub max_accepted_htlcs: u16,
 206         /// The sender's key controlling the funding transaction
 207         pub funding_pubkey: PublicKey,
 208         /// Used to derive a revocation key for transactions broadcast by counterparty
 209         pub revocation_basepoint: PublicKey,
 210         /// A payment key to sender for transactions broadcast by counterparty
 211         pub payment_point: PublicKey,
 212         /// Used to derive a payment key to sender for transactions broadcast by sender
 213         pub delayed_payment_basepoint: PublicKey,
 214         /// Used to derive an HTLC payment key to sender
 215         pub htlc_basepoint: PublicKey,
 216         /// The first to-be-broadcast-by-sender transaction's per commitment point
 217         pub first_per_commitment_point: PublicKey,
 218         /// The channel flags to be used
 219         pub channel_flags: u8,
 220         /// A request to pre-set the to-sender output's `scriptPubkey` for when we collaboratively close
 221         pub shutdown_scriptpubkey: Option<ScriptBuf>,
 222         /// The channel type that this channel will represent
 223         ///
 224         /// If this is `None`, we derive the channel type from the intersection of our
 225         /// feature bits with our counterparty's feature bits from the [`Init`] message.
 226         pub channel_type: Option<ChannelTypeFeatures>,
 227 }
 228
 229 /// An open_channel2 message to be sent by or received from the channel initiator.
 230 ///
 231 /// Used in V2 channel establishment
 232 ///
 233 // TODO(dual_funding): Add spec link for `open_channel2`.
 234 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 235 pub struct OpenChannelV2 {
 236         /// The genesis hash of the blockchain where the channel is to be opened
 237         pub chain_hash: ChainHash,
 238         /// A temporary channel ID derived using a zeroed out value for the channel acceptor's revocation basepoint
 239         pub temporary_channel_id: ChannelId,
 240         /// The feerate for the funding transaction set by the channel initiator
 241         pub funding_feerate_sat_per_1000_weight: u32,
 242         /// The feerate for the commitment transaction set by the channel initiator
 243         pub commitment_feerate_sat_per_1000_weight: u32,
 244         /// Part of the channel value contributed by the channel initiator
 245         pub funding_satoshis: u64,
 246         /// The threshold below which outputs on transactions broadcast by the channel initiator will be
 247         /// omitted
 248         pub dust_limit_satoshis: u64,
 249         /// The maximum inbound HTLC value in flight towards channel initiator, in milli-satoshi
 250         pub max_htlc_value_in_flight_msat: u64,
 251         /// The minimum HTLC size incoming to channel initiator, in milli-satoshi
 252         pub htlc_minimum_msat: u64,
 253         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they
 254         /// broadcast a commitment transaction
 255         pub to_self_delay: u16,
 256         /// The maximum number of inbound HTLCs towards channel initiator
 257         pub max_accepted_htlcs: u16,
 258         /// The locktime for the funding transaction
 259         pub locktime: u32,
 260         /// The channel initiator's key controlling the funding transaction
 261         pub funding_pubkey: PublicKey,
 262         /// Used to derive a revocation key for transactions broadcast by counterparty
 263         pub revocation_basepoint: PublicKey,
 264         /// A payment key to channel initiator for transactions broadcast by counterparty
 265         pub payment_basepoint: PublicKey,
 266         /// Used to derive a payment key to channel initiator for transactions broadcast by channel
 267         /// initiator
 268         pub delayed_payment_basepoint: PublicKey,
 269         /// Used to derive an HTLC payment key to channel initiator
 270         pub htlc_basepoint: PublicKey,
 271         /// The first to-be-broadcast-by-channel-initiator transaction's per commitment point
 272         pub first_per_commitment_point: PublicKey,
 273         /// The second to-be-broadcast-by-channel-initiator transaction's per commitment point
 274         pub second_per_commitment_point: PublicKey,
 275         /// Channel flags
 276         pub channel_flags: u8,
 277         /// Optionally, a request to pre-set the to-channel-initiator output's scriptPubkey for when we
 278         /// collaboratively close
 279         pub shutdown_scriptpubkey: Option<ScriptBuf>,
 280         /// The channel type that this channel will represent. If none is set, we derive the channel
 281         /// type from the intersection of our feature bits with our counterparty's feature bits from
 282         /// the Init message.
 283         pub channel_type: Option<ChannelTypeFeatures>,
 284         /// Optionally, a requirement that only confirmed inputs can be added
 285         pub require_confirmed_inputs: Option<()>,
 286 }
 287
 288 /// An [`accept_channel`] message to be sent to or received from a peer.
 289 ///
 290 /// Used in V1 channel establishment
 291 ///
 292 /// [`accept_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel-message
 293 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 294 pub struct AcceptChannel {
 295         /// A temporary channel ID, until the funding outpoint is announced
 296         pub temporary_channel_id: ChannelId,
 297         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 298         pub dust_limit_satoshis: u64,
 299         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 300         pub max_htlc_value_in_flight_msat: u64,
 301         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 302         pub channel_reserve_satoshis: u64,
 303         /// The minimum HTLC size incoming to sender, in milli-satoshi
 304         pub htlc_minimum_msat: u64,
 305         /// Minimum depth of the funding transaction before the channel is considered open
 306         pub minimum_depth: u32,
 307         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
 308         pub to_self_delay: u16,
 309         /// The maximum number of inbound HTLCs towards sender
 310         pub max_accepted_htlcs: u16,
 311         /// The sender's key controlling the funding transaction
 312         pub funding_pubkey: PublicKey,
 313         /// Used to derive a revocation key for transactions broadcast by counterparty
 314         pub revocation_basepoint: PublicKey,
 315         /// A payment key to sender for transactions broadcast by counterparty
 316         pub payment_point: PublicKey,
 317         /// Used to derive a payment key to sender for transactions broadcast by sender
 318         pub delayed_payment_basepoint: PublicKey,
 319         /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
 320         pub htlc_basepoint: PublicKey,
 321         /// The first to-be-broadcast-by-sender transaction's per commitment point
 322         pub first_per_commitment_point: PublicKey,
 323         /// A request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 324         pub shutdown_scriptpubkey: Option<ScriptBuf>,
 325         /// The channel type that this channel will represent.
 326         ///
 327         /// If this is `None`, we derive the channel type from the intersection of
 328         /// our feature bits with our counterparty's feature bits from the [`Init`] message.
 329         /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
 330         pub channel_type: Option<ChannelTypeFeatures>,
 331         #[cfg(taproot)]
 332         /// Next nonce the channel initiator should use to create a funding output signature against
 333         pub next_local_nonce: Option<musig2::types::PublicNonce>,
 334 }
 335
 336 /// An accept_channel2 message to be sent by or received from the channel accepter.
 337 ///
 338 /// Used in V2 channel establishment
 339 ///
 340 // TODO(dual_funding): Add spec link for `accept_channel2`.
 341 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 342 pub struct AcceptChannelV2 {
 343         /// The same `temporary_channel_id` received from the initiator's `open_channel2` message.
 344         pub temporary_channel_id: ChannelId,
 345         /// Part of the channel value contributed by the channel acceptor
 346         pub funding_satoshis: u64,
 347         /// The threshold below which outputs on transactions broadcast by the channel acceptor will be
 348         /// omitted
 349         pub dust_limit_satoshis: u64,
 350         /// The maximum inbound HTLC value in flight towards channel acceptor, in milli-satoshi
 351         pub max_htlc_value_in_flight_msat: u64,
 352         /// The minimum HTLC size incoming to channel acceptor, in milli-satoshi
 353         pub htlc_minimum_msat: u64,
 354         /// Minimum depth of the funding transaction before the channel is considered open
 355         pub minimum_depth: u32,
 356         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they
 357         /// broadcast a commitment transaction
 358         pub to_self_delay: u16,
 359         /// The maximum number of inbound HTLCs towards channel acceptor
 360         pub max_accepted_htlcs: u16,
 361         /// The channel acceptor's key controlling the funding transaction
 362         pub funding_pubkey: PublicKey,
 363         /// Used to derive a revocation key for transactions broadcast by counterparty
 364         pub revocation_basepoint: PublicKey,
 365         /// A payment key to channel acceptor for transactions broadcast by counterparty
 366         pub payment_basepoint: PublicKey,
 367         /// Used to derive a payment key to channel acceptor for transactions broadcast by channel
 368         /// acceptor
 369         pub delayed_payment_basepoint: PublicKey,
 370         /// Used to derive an HTLC payment key to channel acceptor for transactions broadcast by counterparty
 371         pub htlc_basepoint: PublicKey,
 372         /// The first to-be-broadcast-by-channel-acceptor transaction's per commitment point
 373         pub first_per_commitment_point: PublicKey,
 374         /// The second to-be-broadcast-by-channel-acceptor transaction's per commitment point
 375         pub second_per_commitment_point: PublicKey,
 376         /// Optionally, a request to pre-set the to-channel-acceptor output's scriptPubkey for when we
 377         /// collaboratively close
 378         pub shutdown_scriptpubkey: Option<ScriptBuf>,
 379         /// The channel type that this channel will represent. If none is set, we derive the channel
 380         /// type from the intersection of our feature bits with our counterparty's feature bits from
 381         /// the Init message.
 382         ///
 383         /// This is required to match the equivalent field in [`OpenChannelV2::channel_type`].
 384         pub channel_type: Option<ChannelTypeFeatures>,
 385         /// Optionally, a requirement that only confirmed inputs can be added
 386         pub require_confirmed_inputs: Option<()>,
 387 }
 388
 389 /// A [`funding_created`] message to be sent to or received from a peer.
 390 ///
 391 /// Used in V1 channel establishment
 392 ///
 393 /// [`funding_created`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_created-message
 394 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 395 pub struct FundingCreated {
 396         /// A temporary channel ID, until the funding is established
 397         pub temporary_channel_id: ChannelId,
 398         /// The funding transaction ID
 399         pub funding_txid: Txid,
 400         /// The specific output index funding this channel
 401         pub funding_output_index: u16,
 402         /// The signature of the channel initiator (funder) on the initial commitment transaction
 403         pub signature: Signature,
 404         #[cfg(taproot)]
 405         /// The partial signature of the channel initiator (funder)
 406         pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
 407         #[cfg(taproot)]
 408         /// Next nonce the channel acceptor should use to finalize the funding output signature
 409         pub next_local_nonce: Option<musig2::types::PublicNonce>
 410 }
 411
 412 /// A [`funding_signed`] message to be sent to or received from a peer.
 413 ///
 414 /// Used in V1 channel establishment
 415 ///
 416 /// [`funding_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-funding_signed-message
 417 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 418 pub struct FundingSigned {
 419         /// The channel ID
 420         pub channel_id: ChannelId,
 421         /// The signature of the channel acceptor (fundee) on the initial commitment transaction
 422         pub signature: Signature,
 423         #[cfg(taproot)]
 424         /// The partial signature of the channel acceptor (fundee)
 425         pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
 426 }
 427
 428 /// A [`channel_ready`] message to be sent to or received from a peer.
 429 ///
 430 /// [`channel_ready`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message
 431 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 432 pub struct ChannelReady {
 433         /// The channel ID
 434         pub channel_id: ChannelId,
 435         /// The per-commitment point of the second commitment transaction
 436         pub next_per_commitment_point: PublicKey,
 437         /// If set, provides a `short_channel_id` alias for this channel.
 438         ///
 439         /// The sender will accept payments to be forwarded over this SCID and forward them to this
 440         /// messages' recipient.
 441         pub short_channel_id_alias: Option<u64>,
 442 }
 443
 444 /// An stfu (quiescence) message to be sent by or received from the stfu initiator.
 445 // TODO(splicing): Add spec link for `stfu`; still in draft, using from https://github.com/lightning/bolts/pull/863
 446 #[derive(Clone, Debug, PartialEq, Eq)]
 447 pub struct Stfu {
 448         /// The channel ID where quiescence is intended
 449         pub channel_id: ChannelId,
 450         /// Initiator flag, 1 if initiating, 0 if replying to an stfu.
 451         pub initiator: u8,
 452 }
 453
 454 /// A splice message to be sent by or received from the stfu initiator (splice initiator).
 455 // TODO(splicing): Add spec link for `splice`; still in draft, using from https://github.com/lightning/bolts/pull/863
 456 #[derive(Clone, Debug, PartialEq, Eq)]
 457 pub struct Splice {
 458         /// The channel ID where splicing is intended
 459         pub channel_id: ChannelId,
 460         /// The genesis hash of the blockchain where the channel is intended to be spliced
 461         pub chain_hash: ChainHash,
 462         /// The intended change in channel capacity: the amount to be added (positive value)
 463         /// or removed (negative value) by the sender (splice initiator) by splicing into/from the channel.
 464         pub relative_satoshis: i64,
 465         /// The feerate for the new funding transaction, set by the splice initiator
 466         pub funding_feerate_perkw: u32,
 467         /// The locktime for the new funding transaction
 468         pub locktime: u32,
 469         /// The key of the sender (splice initiator) controlling the new funding transaction
 470         pub funding_pubkey: PublicKey,
 471 }
 472
 473 /// A splice_ack message to be received by or sent to the splice initiator.
 474 ///
 475 // TODO(splicing): Add spec link for `splice_ack`; still in draft, using from https://github.com/lightning/bolts/pull/863
 476 #[derive(Clone, Debug, PartialEq, Eq)]
 477 pub struct SpliceAck {
 478         /// The channel ID where splicing is intended
 479         pub channel_id: ChannelId,
 480         /// The genesis hash of the blockchain where the channel is intended to be spliced
 481         pub chain_hash: ChainHash,
 482         /// The intended change in channel capacity: the amount to be added (positive value)
 483         /// or removed (negative value) by the sender (splice acceptor) by splicing into/from the channel.
 484         pub relative_satoshis: i64,
 485         /// The key of the sender (splice acceptor) controlling the new funding transaction
 486         pub funding_pubkey: PublicKey,
 487 }
 488
 489 /// A splice_locked message to be sent to or received from a peer.
 490 ///
 491 // TODO(splicing): Add spec link for `splice_locked`; still in draft, using from https://github.com/lightning/bolts/pull/863
 492 #[derive(Clone, Debug, PartialEq, Eq)]
 493 pub struct SpliceLocked {
 494         /// The channel ID
 495         pub channel_id: ChannelId,
 496 }
 497
 498 /// A tx_add_input message for adding an input during interactive transaction construction
 499 ///
 500 // TODO(dual_funding): Add spec link for `tx_add_input`.
 501 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 502 pub struct TxAddInput {
 503         /// The channel ID
 504         pub channel_id: ChannelId,
 505         /// A randomly chosen unique identifier for this input, which is even for initiators and odd for
 506         /// non-initiators.
 507         pub serial_id: u64,
 508         /// Serialized transaction that contains the output this input spends to verify that it is non
 509         /// malleable.
 510         pub prevtx: TransactionU16LenLimited,
 511         /// The index of the output being spent
 512         pub prevtx_out: u32,
 513         /// The sequence number of this input
 514         pub sequence: u32,
 515 }
 516
 517 /// A tx_add_output message for adding an output during interactive transaction construction.
 518 ///
 519 // TODO(dual_funding): Add spec link for `tx_add_output`.
 520 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 521 pub struct TxAddOutput {
 522         /// The channel ID
 523         pub channel_id: ChannelId,
 524         /// A randomly chosen unique identifier for this output, which is even for initiators and odd for
 525         /// non-initiators.
 526         pub serial_id: u64,
 527         /// The satoshi value of the output
 528         pub sats: u64,
 529         /// The scriptPubKey for the output
 530         pub script: ScriptBuf,
 531 }
 532
 533 /// A tx_remove_input message for removing an input during interactive transaction construction.
 534 ///
 535 // TODO(dual_funding): Add spec link for `tx_remove_input`.
 536 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 537 pub struct TxRemoveInput {
 538         /// The channel ID
 539         pub channel_id: ChannelId,
 540         /// The serial ID of the input to be removed
 541         pub serial_id: u64,
 542 }
 543
 544 /// A tx_remove_output message for removing an output during interactive transaction construction.
 545 ///
 546 // TODO(dual_funding): Add spec link for `tx_remove_output`.
 547 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 548 pub struct TxRemoveOutput {
 549         /// The channel ID
 550         pub channel_id: ChannelId,
 551         /// The serial ID of the output to be removed
 552         pub serial_id: u64,
 553 }
 554
 555 /// A tx_complete message signalling the conclusion of a peer's transaction contributions during
 556 /// interactive transaction construction.
 557 ///
 558 // TODO(dual_funding): Add spec link for `tx_complete`.
 559 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 560 pub struct TxComplete {
 561         /// The channel ID
 562         pub channel_id: ChannelId,
 563 }
 564
 565 /// A tx_signatures message containing the sender's signatures for a transaction constructed with
 566 /// interactive transaction construction.
 567 ///
 568 // TODO(dual_funding): Add spec link for `tx_signatures`.
 569 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 570 pub struct TxSignatures {
 571         /// The channel ID
 572         pub channel_id: ChannelId,
 573         /// The TXID
 574         pub tx_hash: Txid,
 575         /// The list of witnesses
 576         pub witnesses: Vec<Witness>,
 577 }
 578
 579 /// A tx_init_rbf message which initiates a replacement of the transaction after it's been
 580 /// completed.
 581 ///
 582 // TODO(dual_funding): Add spec link for `tx_init_rbf`.
 583 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 584 pub struct TxInitRbf {
 585         /// The channel ID
 586         pub channel_id: ChannelId,
 587         /// The locktime of the transaction
 588         pub locktime: u32,
 589         /// The feerate of the transaction
 590         pub feerate_sat_per_1000_weight: u32,
 591         /// The number of satoshis the sender will contribute to or, if negative, remove from
 592         /// (e.g. splice-out) the funding output of the transaction
 593         pub funding_output_contribution: Option<i64>,
 594 }
 595
 596 /// A tx_ack_rbf message which acknowledges replacement of the transaction after it's been
 597 /// completed.
 598 ///
 599 // TODO(dual_funding): Add spec link for `tx_ack_rbf`.
 600 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 601 pub struct TxAckRbf {
 602         /// The channel ID
 603         pub channel_id: ChannelId,
 604         /// The number of satoshis the sender will contribute to or, if negative, remove from
 605         /// (e.g. splice-out) the funding output of the transaction
 606         pub funding_output_contribution: Option<i64>,
 607 }
 608
 609 /// A tx_abort message which signals the cancellation of an in-progress transaction negotiation.
 610 ///
 611 // TODO(dual_funding): Add spec link for `tx_abort`.
 612 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 613 pub struct TxAbort {
 614         /// The channel ID
 615         pub channel_id: ChannelId,
 616         /// Message data
 617         pub data: Vec<u8>,
 618 }
 619
 620 /// A [`shutdown`] message to be sent to or received from a peer.
 621 ///
 622 /// [`shutdown`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-initiation-shutdown
 623 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 624 pub struct Shutdown {
 625         /// The channel ID
 626         pub channel_id: ChannelId,
 627         /// The destination of this peer's funds on closing.
 628         ///
 629         /// Must be in one of these forms: P2PKH, P2SH, P2WPKH, P2WSH, P2TR.
 630         pub scriptpubkey: ScriptBuf,
 631 }
 632
 633 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
 634 ///
 635 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
 636 /// to use.
 637 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 638 pub struct ClosingSignedFeeRange {
 639         /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
 640         /// transaction.
 641         pub min_fee_satoshis: u64,
 642         /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
 643         /// transaction.
 644         pub max_fee_satoshis: u64,
 645 }
 646
 647 /// A [`closing_signed`] message to be sent to or received from a peer.
 648 ///
 649 /// [`closing_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-negotiation-closing_signed
 650 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 651 pub struct ClosingSigned {
 652         /// The channel ID
 653         pub channel_id: ChannelId,
 654         /// The proposed total fee for the closing transaction
 655         pub fee_satoshis: u64,
 656         /// A signature on the closing transaction
 657         pub signature: Signature,
 658         /// The minimum and maximum fees which the sender is willing to accept, provided only by new
 659         /// nodes.
 660         pub fee_range: Option<ClosingSignedFeeRange>,
 661 }
 662
 663 /// An [`update_add_htlc`] message to be sent to or received from a peer.
 664 ///
 665 /// [`update_add_htlc`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#adding-an-htlc-update_add_htlc
 666 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 667 pub struct UpdateAddHTLC {
 668         /// The channel ID
 669         pub channel_id: ChannelId,
 670         /// The HTLC ID
 671         pub htlc_id: u64,
 672         /// The HTLC value in milli-satoshi
 673         pub amount_msat: u64,
 674         /// The payment hash, the pre-image of which controls HTLC redemption
 675         pub payment_hash: PaymentHash,
 676         /// The expiry height of the HTLC
 677         pub cltv_expiry: u32,
 678         /// The extra fee skimmed by the sender of this message. See
 679         /// [`ChannelConfig::accept_underpaying_htlcs`].
 680         ///
 681         /// [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
 682         pub skimmed_fee_msat: Option<u64>,
 683         /// The onion routing packet with encrypted data for the next hop.
 684         pub onion_routing_packet: OnionPacket,
 685         /// Provided if we are relaying or receiving a payment within a blinded path, to decrypt the onion
 686         /// routing packet and the recipient-provided encrypted payload within.
 687         pub blinding_point: Option<PublicKey>,
 688 }
 689
 690  /// An onion message to be sent to or received from a peer.
 691  ///
 692  // TODO: update with link to OM when they are merged into the BOLTs
 693 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 694 pub struct OnionMessage {
 695         /// Used in decrypting the onion packet's payload.
 696         pub blinding_point: PublicKey,
 697         /// The full onion packet including hop data, pubkey, and hmac
 698         pub onion_routing_packet: onion_message::Packet,
 699 }
 700
 701 /// An [`update_fulfill_htlc`] message to be sent to or received from a peer.
 702 ///
 703 /// [`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
 704 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 705 pub struct UpdateFulfillHTLC {
 706         /// The channel ID
 707         pub channel_id: ChannelId,
 708         /// The HTLC ID
 709         pub htlc_id: u64,
 710         /// The pre-image of the payment hash, allowing HTLC redemption
 711         pub payment_preimage: PaymentPreimage,
 712 }
 713
 714 /// An [`update_fail_htlc`] message to be sent to or received from a peer.
 715 ///
 716 /// [`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
 717 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 718 pub struct UpdateFailHTLC {
 719         /// The channel ID
 720         pub channel_id: ChannelId,
 721         /// The HTLC ID
 722         pub htlc_id: u64,
 723         pub(crate) reason: OnionErrorPacket,
 724 }
 725
 726 /// An [`update_fail_malformed_htlc`] message to be sent to or received from a peer.
 727 ///
 728 /// [`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
 729 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 730 pub struct UpdateFailMalformedHTLC {
 731         /// The channel ID
 732         pub channel_id: ChannelId,
 733         /// The HTLC ID
 734         pub htlc_id: u64,
 735         pub(crate) sha256_of_onion: [u8; 32],
 736         /// The failure code
 737         pub failure_code: u16,
 738 }
 739
 740 /// A [`commitment_signed`] message to be sent to or received from a peer.
 741 ///
 742 /// [`commitment_signed`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#committing-updates-so-far-commitment_signed
 743 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 744 pub struct CommitmentSigned {
 745         /// The channel ID
 746         pub channel_id: ChannelId,
 747         /// A signature on the commitment transaction
 748         pub signature: Signature,
 749         /// Signatures on the HTLC transactions
 750         pub htlc_signatures: Vec<Signature>,
 751         #[cfg(taproot)]
 752         /// The partial Taproot signature on the commitment transaction
 753         pub partial_signature_with_nonce: Option<PartialSignatureWithNonce>,
 754 }
 755
 756 /// A [`revoke_and_ack`] message to be sent to or received from a peer.
 757 ///
 758 /// [`revoke_and_ack`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#completing-the-transition-to-the-updated-state-revoke_and_ack
 759 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 760 pub struct RevokeAndACK {
 761         /// The channel ID
 762         pub channel_id: ChannelId,
 763         /// The secret corresponding to the per-commitment point
 764         pub per_commitment_secret: [u8; 32],
 765         /// The next sender-broadcast commitment transaction's per-commitment point
 766         pub next_per_commitment_point: PublicKey,
 767         #[cfg(taproot)]
 768         /// Musig nonce the recipient should use in their next commitment signature message
 769         pub next_local_nonce: Option<musig2::types::PublicNonce>
 770 }
 771
 772 /// An [`update_fee`] message to be sent to or received from a peer
 773 ///
 774 /// [`update_fee`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#updating-fees-update_fee
 775 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 776 pub struct UpdateFee {
 777         /// The channel ID
 778         pub channel_id: ChannelId,
 779         /// Fee rate per 1000-weight of the transaction
 780         pub feerate_per_kw: u32,
 781 }
 782
 783 /// A [`channel_reestablish`] message to be sent to or received from a peer.
 784 ///
 785 /// [`channel_reestablish`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#message-retransmission
 786 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 787 pub struct ChannelReestablish {
 788         /// The channel ID
 789         pub channel_id: ChannelId,
 790         /// The next commitment number for the sender
 791         pub next_local_commitment_number: u64,
 792         /// The next commitment number for the recipient
 793         pub next_remote_commitment_number: u64,
 794         /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
 795         /// belonging to the recipient
 796         pub your_last_per_commitment_secret: [u8; 32],
 797         /// The sender's per-commitment point for their current commitment transaction
 798         pub my_current_per_commitment_point: PublicKey,
 799         /// The next funding transaction ID
 800         pub next_funding_txid: Option<Txid>,
 801 }
 802
 803 /// An [`announcement_signatures`] message to be sent to or received from a peer.
 804 ///
 805 /// [`announcement_signatures`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-announcement_signatures-message
 806 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 807 pub struct AnnouncementSignatures {
 808         /// The channel ID
 809         pub channel_id: ChannelId,
 810         /// The short channel ID
 811         pub short_channel_id: u64,
 812         /// A signature by the node key
 813         pub node_signature: Signature,
 814         /// A signature by the funding key
 815         pub bitcoin_signature: Signature,
 816 }
 817
 818 /// An address which can be used to connect to a remote peer.
 819 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 820 pub enum SocketAddress {
 821         /// An IPv4 address and port on which the peer is listening.
 822         TcpIpV4 {
 823                 /// The 4-byte IPv4 address
 824                 addr: [u8; 4],
 825                 /// The port on which the node is listening
 826                 port: u16,
 827         },
 828         /// An IPv6 address and port on which the peer is listening.
 829         TcpIpV6 {
 830                 /// The 16-byte IPv6 address
 831                 addr: [u8; 16],
 832                 /// The port on which the node is listening
 833                 port: u16,
 834         },
 835         /// An old-style Tor onion address/port on which the peer is listening.
 836         ///
 837         /// This field is deprecated and the Tor network generally no longer supports V2 Onion
 838         /// addresses. Thus, the details are not parsed here.
 839         OnionV2([u8; 12]),
 840         /// A new-style Tor onion address/port on which the peer is listening.
 841         ///
 842         /// To create the human-readable "hostname", concatenate the ED25519 pubkey, checksum, and version,
 843         /// wrap as base32 and append ".onion".
 844         OnionV3 {
 845                 /// The ed25519 long-term public key of the peer
 846                 ed25519_pubkey: [u8; 32],
 847                 /// The checksum of the pubkey and version, as included in the onion address
 848                 checksum: u16,
 849                 /// The version byte, as defined by the Tor Onion v3 spec.
 850                 version: u8,
 851                 /// The port on which the node is listening
 852                 port: u16,
 853         },
 854         /// A hostname/port on which the peer is listening.
 855         Hostname {
 856                 /// The hostname on which the node is listening.
 857                 hostname: Hostname,
 858                 /// The port on which the node is listening.
 859                 port: u16,
 860         },
 861 }
 862 impl SocketAddress {
 863         /// Gets the ID of this address type. Addresses in [`NodeAnnouncement`] messages should be sorted
 864         /// by this.
 865         pub(crate) fn get_id(&self) -> u8 {
 866                 match self {
 867                         &SocketAddress::TcpIpV4 {..} => { 1 },
 868                         &SocketAddress::TcpIpV6 {..} => { 2 },
 869                         &SocketAddress::OnionV2(_) => { 3 },
 870                         &SocketAddress::OnionV3 {..} => { 4 },
 871                         &SocketAddress::Hostname {..} => { 5 },
 872                 }
 873         }
 874
 875         /// Strict byte-length of address descriptor, 1-byte type not recorded
 876         fn len(&self) -> u16 {
 877                 match self {
 878                         &SocketAddress::TcpIpV4 { .. } => { 6 },
 879                         &SocketAddress::TcpIpV6 { .. } => { 18 },
 880                         &SocketAddress::OnionV2(_) => { 12 },
 881                         &SocketAddress::OnionV3 { .. } => { 37 },
 882                         // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
 883                         &SocketAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
 884                 }
 885         }
 886
 887         /// The maximum length of any address descriptor, not including the 1-byte type.
 888         /// This maximum length is reached by a hostname address descriptor:
 889         /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
 890         pub(crate) const MAX_LEN: u16 = 258;
 891 }
 892
 893 impl Writeable for SocketAddress {
 894         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 895                 match self {
 896                         &SocketAddress::TcpIpV4 { ref addr, ref port } => {
 897                                 1u8.write(writer)?;
 898                                 addr.write(writer)?;
 899                                 port.write(writer)?;
 900                         },
 901                         &SocketAddress::TcpIpV6 { ref addr, ref port } => {
 902                                 2u8.write(writer)?;
 903                                 addr.write(writer)?;
 904                                 port.write(writer)?;
 905                         },
 906                         &SocketAddress::OnionV2(bytes) => {
 907                                 3u8.write(writer)?;
 908                                 bytes.write(writer)?;
 909                         },
 910                         &SocketAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
 911                                 4u8.write(writer)?;
 912                                 ed25519_pubkey.write(writer)?;
 913                                 checksum.write(writer)?;
 914                                 version.write(writer)?;
 915                                 port.write(writer)?;
 916                         },
 917                         &SocketAddress::Hostname { ref hostname, ref port } => {
 918                                 5u8.write(writer)?;
 919                                 hostname.write(writer)?;
 920                                 port.write(writer)?;
 921                         },
 922                 }
 923                 Ok(())
 924         }
 925 }
 926
 927 impl Readable for Result<SocketAddress, u8> {
 928         fn read<R: Read>(reader: &mut R) -> Result<Result<SocketAddress, u8>, DecodeError> {
 929                 let byte = <u8 as Readable>::read(reader)?;
 930                 match byte {
 931                         1 => {
 932                                 Ok(Ok(SocketAddress::TcpIpV4 {
 933                                         addr: Readable::read(reader)?,
 934                                         port: Readable::read(reader)?,
 935                                 }))
 936                         },
 937                         2 => {
 938                                 Ok(Ok(SocketAddress::TcpIpV6 {
 939                                         addr: Readable::read(reader)?,
 940                                         port: Readable::read(reader)?,
 941                                 }))
 942                         },
 943                         3 => Ok(Ok(SocketAddress::OnionV2(Readable::read(reader)?))),
 944                         4 => {
 945                                 Ok(Ok(SocketAddress::OnionV3 {
 946                                         ed25519_pubkey: Readable::read(reader)?,
 947                                         checksum: Readable::read(reader)?,
 948                                         version: Readable::read(reader)?,
 949                                         port: Readable::read(reader)?,
 950                                 }))
 951                         },
 952                         5 => {
 953                                 Ok(Ok(SocketAddress::Hostname {
 954                                         hostname: Readable::read(reader)?,
 955                                         port: Readable::read(reader)?,
 956                                 }))
 957                         },
 958                         _ => return Ok(Err(byte)),
 959                 }
 960         }
 961 }
 962
 963 impl Readable for SocketAddress {
 964         fn read<R: Read>(reader: &mut R) -> Result<SocketAddress, DecodeError> {
 965                 match Readable::read(reader) {
 966                         Ok(Ok(res)) => Ok(res),
 967                         Ok(Err(_)) => Err(DecodeError::UnknownVersion),
 968                         Err(e) => Err(e),
 969                 }
 970         }
 971 }
 972
 973 /// [`SocketAddress`] error variants
 974 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
 975 pub enum SocketAddressParseError {
 976         /// Socket address (IPv4/IPv6) parsing error
 977         SocketAddrParse,
 978         /// Invalid input format
 979         InvalidInput,
 980         /// Invalid port
 981         InvalidPort,
 982         /// Invalid onion v3 address
 983         InvalidOnionV3,
 984 }
 985
 986 impl fmt::Display for SocketAddressParseError {
 987         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 988                 match self {
 989                         SocketAddressParseError::SocketAddrParse => write!(f, "Socket address (IPv4/IPv6) parsing error"),
 990                         SocketAddressParseError::InvalidInput => write!(f, "Invalid input format. \
 991                                 Expected: \"<ipv4>:<port>\", \"[<ipv6>]:<port>\", \"<onion address>.onion:<port>\" or \"<hostname>:<port>\""),
 992                         SocketAddressParseError::InvalidPort => write!(f, "Invalid port"),
 993                         SocketAddressParseError::InvalidOnionV3 => write!(f, "Invalid onion v3 address"),
 994                 }
 995         }
 996 }
 997
 998 #[cfg(feature = "std")]
 999 impl From<std::net::SocketAddrV4> for SocketAddress {
1000                 fn from(addr: std::net::SocketAddrV4) -> Self {
1001                         SocketAddress::TcpIpV4 { addr: addr.ip().octets(), port: addr.port() }
1002                 }
1003 }
1004
1005 #[cfg(feature = "std")]
1006 impl From<std::net::SocketAddrV6> for SocketAddress {
1007                 fn from(addr: std::net::SocketAddrV6) -> Self {
1008                         SocketAddress::TcpIpV6 { addr: addr.ip().octets(), port: addr.port() }
1009                 }
1010 }
1011
1012 #[cfg(feature = "std")]
1013 impl From<std::net::SocketAddr> for SocketAddress {
1014                 fn from(addr: std::net::SocketAddr) -> Self {
1015                         match addr {
1016                                 std::net::SocketAddr::V4(addr) => addr.into(),
1017                                 std::net::SocketAddr::V6(addr) => addr.into(),
1018                         }
1019                 }
1020 }
1021
1022 #[cfg(feature = "std")]
1023 impl std::net::ToSocketAddrs for SocketAddress {
1024         type Iter = std::vec::IntoIter<std::net::SocketAddr>;
1025
1026         fn to_socket_addrs(&self) -> std::io::Result<Self::Iter> {
1027                 match self {
1028                         SocketAddress::TcpIpV4 { addr, port } => {
1029                                 let ip_addr = std::net::Ipv4Addr::from(*addr);
1030                                 let socket_addr = SocketAddr::new(ip_addr.into(), *port);
1031                                 Ok(vec![socket_addr].into_iter())
1032                         }
1033                         SocketAddress::TcpIpV6 { addr, port } => {
1034                                 let ip_addr = std::net::Ipv6Addr::from(*addr);
1035                                 let socket_addr = SocketAddr::new(ip_addr.into(), *port);
1036                                 Ok(vec![socket_addr].into_iter())
1037                         }
1038                         SocketAddress::Hostname { ref hostname, port } => {
1039                                 (hostname.as_str(), *port).to_socket_addrs()
1040                         }
1041                         SocketAddress::OnionV2(..) => {
1042                                 Err(std::io::Error::new(std::io::ErrorKind::Other, "Resolution of OnionV2 \
1043                                 addresses is currently unsupported."))
1044                         }
1045                         SocketAddress::OnionV3 { .. } => {
1046                                 Err(std::io::Error::new(std::io::ErrorKind::Other, "Resolution of OnionV3 \
1047                                 addresses is currently unsupported."))
1048                         }
1049                 }
1050         }
1051 }
1052
1053 /// Parses an OnionV3 host and port into a [`SocketAddress::OnionV3`].
1054 ///
1055 /// The host part must end with ".onion".
1056 pub fn parse_onion_address(host: &str, port: u16) -> Result<SocketAddress, SocketAddressParseError> {
1057         if host.ends_with(".onion") {
1058                 let domain = &host[..host.len() - ".onion".len()];
1059                 if domain.len() != 56 {
1060                         return Err(SocketAddressParseError::InvalidOnionV3);
1061                 }
1062                 let onion =  base32::Alphabet::RFC4648 { padding: false }.decode(&domain).map_err(|_| SocketAddressParseError::InvalidOnionV3)?;
1063                 if onion.len() != 35 {
1064                         return Err(SocketAddressParseError::InvalidOnionV3);
1065                 }
1066                 let version = onion[0];
1067                 let first_checksum_flag = onion[1];
1068                 let second_checksum_flag = onion[2];
1069                 let mut ed25519_pubkey = [0; 32];
1070                 ed25519_pubkey.copy_from_slice(&onion[3..35]);
1071                 let checksum = u16::from_be_bytes([first_checksum_flag, second_checksum_flag]);
1072                 return Ok(SocketAddress::OnionV3 { ed25519_pubkey, checksum, version, port });
1073
1074         } else {
1075                 return Err(SocketAddressParseError::InvalidInput);
1076         }
1077 }
1078
1079 impl Display for SocketAddress {
1080         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1081                 match self {
1082                         SocketAddress::TcpIpV4{addr, port} => write!(
1083                                 f, "{}.{}.{}.{}:{}", addr[0], addr[1], addr[2], addr[3], port)?,
1084                         SocketAddress::TcpIpV6{addr, port} => write!(
1085                                 f,
1086                                 "[{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}:{:02x}{:02x}]:{}",
1087                                 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5], addr[6], addr[7], addr[8], addr[9], addr[10], addr[11], addr[12], addr[13], addr[14], addr[15], port
1088                         )?,
1089                         SocketAddress::OnionV2(bytes) => write!(f, "OnionV2({:?})", bytes)?,
1090                         SocketAddress::OnionV3 {
1091                                 ed25519_pubkey,
1092                                 checksum,
1093                                 version,
1094                                 port,
1095                         } => {
1096                                 let [first_checksum_flag, second_checksum_flag] = checksum.to_be_bytes();
1097                                 let mut addr = vec![*version, first_checksum_flag, second_checksum_flag];
1098                                 addr.extend_from_slice(ed25519_pubkey);
1099                                 let onion = base32::Alphabet::RFC4648 { padding: false }.encode(&addr);
1100                                 write!(f, "{}.onion:{}", onion, port)?
1101                         },
1102                         SocketAddress::Hostname { hostname, port } => write!(f, "{}:{}", hostname, port)?,
1103                 }
1104                 Ok(())
1105         }
1106 }
1107
1108 #[cfg(feature = "std")]
1109 impl FromStr for SocketAddress {
1110         type Err = SocketAddressParseError;
1111
1112         fn from_str(s: &str) -> Result<Self, Self::Err> {
1113                 match std::net::SocketAddr::from_str(s) {
1114                         Ok(addr) => Ok(addr.into()),
1115                         Err(_) => {
1116                                 let trimmed_input = match s.rfind(":") {
1117                                         Some(pos) => pos,
1118                                         None => return Err(SocketAddressParseError::InvalidInput),
1119                                 };
1120                                 let host = &s[..trimmed_input];
1121                                 let port: u16 = s[trimmed_input + 1..].parse().map_err(|_| SocketAddressParseError::InvalidPort)?;
1122                                 if host.ends_with(".onion") {
1123                                         return parse_onion_address(host, port);
1124                                 };
1125                                 if let Ok(hostname) = Hostname::try_from(s[..trimmed_input].to_string()) {
1126                                         return Ok(SocketAddress::Hostname { hostname, port });
1127                                 };
1128                                 return Err(SocketAddressParseError::SocketAddrParse)
1129                         },
1130                 }
1131         }
1132 }
1133
1134 /// Represents the set of gossip messages that require a signature from a node's identity key.
1135 pub enum UnsignedGossipMessage<'a> {
1136         /// An unsigned channel announcement.
1137         ChannelAnnouncement(&'a UnsignedChannelAnnouncement),
1138         /// An unsigned channel update.
1139         ChannelUpdate(&'a UnsignedChannelUpdate),
1140         /// An unsigned node announcement.
1141         NodeAnnouncement(&'a UnsignedNodeAnnouncement)
1142 }
1143
1144 impl<'a> Writeable for UnsignedGossipMessage<'a> {
1145         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1146                 match self {
1147                         UnsignedGossipMessage::ChannelAnnouncement(ref msg) => msg.write(writer),
1148                         UnsignedGossipMessage::ChannelUpdate(ref msg) => msg.write(writer),
1149                         UnsignedGossipMessage::NodeAnnouncement(ref msg) => msg.write(writer),
1150                 }
1151         }
1152 }
1153
1154 /// The unsigned part of a [`node_announcement`] message.
1155 ///
1156 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
1157 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1158 pub struct UnsignedNodeAnnouncement {
1159         /// The advertised features
1160         pub features: NodeFeatures,
1161         /// A strictly monotonic announcement counter, with gaps allowed
1162         pub timestamp: u32,
1163         /// The `node_id` this announcement originated from (don't rebroadcast the `node_announcement` back
1164         /// to this node).
1165         pub node_id: NodeId,
1166         /// An RGB color for UI purposes
1167         pub rgb: [u8; 3],
1168         /// An alias, for UI purposes.
1169         ///
1170         /// This should be sanitized before use. There is no guarantee of uniqueness.
1171         pub alias: NodeAlias,
1172         /// List of addresses on which this node is reachable
1173         pub addresses: Vec<SocketAddress>,
1174         pub(crate) excess_address_data: Vec<u8>,
1175         pub(crate) excess_data: Vec<u8>,
1176 }
1177 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1178 /// A [`node_announcement`] message to be sent to or received from a peer.
1179 ///
1180 /// [`node_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-node_announcement-message
1181 pub struct NodeAnnouncement {
1182         /// The signature by the node key
1183         pub signature: Signature,
1184         /// The actual content of the announcement
1185         pub contents: UnsignedNodeAnnouncement,
1186 }
1187
1188 /// The unsigned part of a [`channel_announcement`] message.
1189 ///
1190 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
1191 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1192 pub struct UnsignedChannelAnnouncement {
1193         /// The advertised channel features
1194         pub features: ChannelFeatures,
1195         /// The genesis hash of the blockchain where the channel is to be opened
1196         pub chain_hash: ChainHash,
1197         /// The short channel ID
1198         pub short_channel_id: u64,
1199         /// One of the two `node_id`s which are endpoints of this channel
1200         pub node_id_1: NodeId,
1201         /// The other of the two `node_id`s which are endpoints of this channel
1202         pub node_id_2: NodeId,
1203         /// The funding key for the first node
1204         pub bitcoin_key_1: NodeId,
1205         /// The funding key for the second node
1206         pub bitcoin_key_2: NodeId,
1207         /// Excess data which was signed as a part of the message which we do not (yet) understand how
1208         /// to decode.
1209         ///
1210         /// This is stored to ensure forward-compatibility as new fields are added to the lightning gossip protocol.
1211         pub excess_data: Vec<u8>,
1212 }
1213 /// A [`channel_announcement`] message to be sent to or received from a peer.
1214 ///
1215 /// [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
1216 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1217 pub struct ChannelAnnouncement {
1218         /// Authentication of the announcement by the first public node
1219         pub node_signature_1: Signature,
1220         /// Authentication of the announcement by the second public node
1221         pub node_signature_2: Signature,
1222         /// Proof of funding UTXO ownership by the first public node
1223         pub bitcoin_signature_1: Signature,
1224         /// Proof of funding UTXO ownership by the second public node
1225         pub bitcoin_signature_2: Signature,
1226         /// The actual announcement
1227         pub contents: UnsignedChannelAnnouncement,
1228 }
1229
1230 /// The unsigned part of a [`channel_update`] message.
1231 ///
1232 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
1233 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1234 pub struct UnsignedChannelUpdate {
1235         /// The genesis hash of the blockchain where the channel is to be opened
1236         pub chain_hash: ChainHash,
1237         /// The short channel ID
1238         pub short_channel_id: u64,
1239         /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
1240         pub timestamp: u32,
1241         /// Channel flags
1242         pub flags: u8,
1243         /// The number of blocks such that if:
1244         /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
1245         /// then we need to fail the HTLC backwards. When forwarding an HTLC, `cltv_expiry_delta` determines
1246         /// the outgoing HTLC's minimum `cltv_expiry` value -- so, if an incoming HTLC comes in with a
1247         /// `cltv_expiry` of 100000, and the node we're forwarding to has a `cltv_expiry_delta` value of 10,
1248         /// then we'll check that the outgoing HTLC's `cltv_expiry` value is at least 100010 before
1249         /// forwarding. Note that the HTLC sender is the one who originally sets this value when
1250         /// constructing the route.
1251         pub cltv_expiry_delta: u16,
1252         /// The minimum HTLC size incoming to sender, in milli-satoshi
1253         pub htlc_minimum_msat: u64,
1254         /// The maximum HTLC value incoming to sender, in milli-satoshi.
1255         ///
1256         /// This used to be optional.
1257         pub htlc_maximum_msat: u64,
1258         /// The base HTLC fee charged by sender, in milli-satoshi
1259         pub fee_base_msat: u32,
1260         /// The amount to fee multiplier, in micro-satoshi
1261         pub fee_proportional_millionths: u32,
1262         /// Excess data which was signed as a part of the message which we do not (yet) understand how
1263         /// to decode.
1264         ///
1265         /// This is stored to ensure forward-compatibility as new fields are added to the lightning gossip protocol.
1266         pub excess_data: Vec<u8>,
1267 }
1268 /// A [`channel_update`] message to be sent to or received from a peer.
1269 ///
1270 /// [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
1271 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1272 pub struct ChannelUpdate {
1273         /// A signature of the channel update
1274         pub signature: Signature,
1275         /// The actual channel update
1276         pub contents: UnsignedChannelUpdate,
1277 }
1278
1279 /// A [`query_channel_range`] message is used to query a peer for channel
1280 /// UTXOs in a range of blocks. The recipient of a query makes a best
1281 /// effort to reply to the query using one or more [`ReplyChannelRange`]
1282 /// messages.
1283 ///
1284 /// [`query_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
1285 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1286 pub struct QueryChannelRange {
1287         /// The genesis hash of the blockchain being queried
1288         pub chain_hash: ChainHash,
1289         /// The height of the first block for the channel UTXOs being queried
1290         pub first_blocknum: u32,
1291         /// The number of blocks to include in the query results
1292         pub number_of_blocks: u32,
1293 }
1294
1295 /// A [`reply_channel_range`] message is a reply to a [`QueryChannelRange`]
1296 /// message.
1297 ///
1298 /// Multiple `reply_channel_range` messages can be sent in reply
1299 /// to a single [`QueryChannelRange`] message. The query recipient makes a
1300 /// best effort to respond based on their local network view which may
1301 /// not be a perfect view of the network. The `short_channel_id`s in the
1302 /// reply are encoded. We only support `encoding_type=0` uncompressed
1303 /// serialization and do not support `encoding_type=1` zlib serialization.
1304 ///
1305 /// [`reply_channel_range`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-query_channel_range-and-reply_channel_range-messages
1306 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1307 pub struct ReplyChannelRange {
1308         /// The genesis hash of the blockchain being queried
1309         pub chain_hash: ChainHash,
1310         /// The height of the first block in the range of the reply
1311         pub first_blocknum: u32,
1312         /// The number of blocks included in the range of the reply
1313         pub number_of_blocks: u32,
1314         /// True when this is the final reply for a query
1315         pub sync_complete: bool,
1316         /// The `short_channel_id`s in the channel range
1317         pub short_channel_ids: Vec<u64>,
1318 }
1319
1320 /// A [`query_short_channel_ids`] message is used to query a peer for
1321 /// routing gossip messages related to one or more `short_channel_id`s.
1322 ///
1323 /// The query recipient will reply with the latest, if available,
1324 /// [`ChannelAnnouncement`], [`ChannelUpdate`] and [`NodeAnnouncement`] messages
1325 /// it maintains for the requested `short_channel_id`s followed by a
1326 /// [`ReplyShortChannelIdsEnd`] message. The `short_channel_id`s sent in
1327 /// this query are encoded. We only support `encoding_type=0` uncompressed
1328 /// serialization and do not support `encoding_type=1` zlib serialization.
1329 ///
1330 /// [`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
1331 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1332 pub struct QueryShortChannelIds {
1333         /// The genesis hash of the blockchain being queried
1334         pub chain_hash: ChainHash,
1335         /// The short_channel_ids that are being queried
1336         pub short_channel_ids: Vec<u64>,
1337 }
1338
1339 /// A [`reply_short_channel_ids_end`] message is sent as a reply to a
1340 /// message. The query recipient makes a best
1341 /// effort to respond based on their local network view which may not be
1342 /// a perfect view of the network.
1343 ///
1344 /// [`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
1345 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1346 pub struct ReplyShortChannelIdsEnd {
1347         /// The genesis hash of the blockchain that was queried
1348         pub chain_hash: ChainHash,
1349         /// Indicates if the query recipient maintains up-to-date channel
1350         /// information for the `chain_hash`
1351         pub full_information: bool,
1352 }
1353
1354 /// A [`gossip_timestamp_filter`] message is used by a node to request
1355 /// gossip relay for messages in the requested time range when the
1356 /// `gossip_queries` feature has been negotiated.
1357 ///
1358 /// [`gossip_timestamp_filter`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-gossip_timestamp_filter-message
1359 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1360 pub struct GossipTimestampFilter {
1361         /// The genesis hash of the blockchain for channel and node information
1362         pub chain_hash: ChainHash,
1363         /// The starting unix timestamp
1364         pub first_timestamp: u32,
1365         /// The range of information in seconds
1366         pub timestamp_range: u32,
1367 }
1368
1369 /// Encoding type for data compression of collections in gossip queries.
1370 ///
1371 /// We do not support `encoding_type=1` zlib serialization [defined in BOLT
1372 /// #7](https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#query-messages).
1373 enum EncodingType {
1374         Uncompressed = 0x00,
1375 }
1376
1377 /// Used to put an error message in a [`LightningError`].
1378 #[derive(Clone, Debug, Hash, PartialEq)]
1379 pub enum ErrorAction {
1380         /// The peer took some action which made us think they were useless. Disconnect them.
1381         DisconnectPeer {
1382                 /// An error message which we should make an effort to send before we disconnect.
1383                 msg: Option<ErrorMessage>
1384         },
1385         /// The peer did something incorrect. Tell them without closing any channels and disconnect them.
1386         DisconnectPeerWithWarning {
1387                 /// A warning message which we should make an effort to send before we disconnect.
1388                 msg: WarningMessage,
1389         },
1390         /// The peer did something harmless that we weren't able to process, just log and ignore
1391         // New code should *not* use this. New code must use IgnoreAndLog, below!
1392         IgnoreError,
1393         /// The peer did something harmless that we weren't able to meaningfully process.
1394         /// If the error is logged, log it at the given level.
1395         IgnoreAndLog(logger::Level),
1396         /// The peer provided us with a gossip message which we'd already seen. In most cases this
1397         /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
1398         /// our own channel announcements.
1399         IgnoreDuplicateGossip,
1400         /// The peer did something incorrect. Tell them.
1401         SendErrorMessage {
1402                 /// The message to send.
1403                 msg: ErrorMessage,
1404         },
1405         /// The peer did something incorrect. Tell them without closing any channels.
1406         SendWarningMessage {
1407                 /// The message to send.
1408                 msg: WarningMessage,
1409                 /// The peer may have done something harmless that we weren't able to meaningfully process,
1410                 /// though we should still tell them about it.
1411                 /// If this event is logged, log it at the given level.
1412                 log_level: logger::Level,
1413         },
1414 }
1415
1416 /// An Err type for failure to process messages.
1417 #[derive(Clone, Debug)]
1418 pub struct LightningError {
1419         /// A human-readable message describing the error
1420         pub err: String,
1421         /// The action which should be taken against the offending peer.
1422         pub action: ErrorAction,
1423 }
1424
1425 /// Struct used to return values from [`RevokeAndACK`] messages, containing a bunch of commitment
1426 /// transaction updates if they were pending.
1427 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1428 pub struct CommitmentUpdate {
1429         /// `update_add_htlc` messages which should be sent
1430         pub update_add_htlcs: Vec<UpdateAddHTLC>,
1431         /// `update_fulfill_htlc` messages which should be sent
1432         pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
1433         /// `update_fail_htlc` messages which should be sent
1434         pub update_fail_htlcs: Vec<UpdateFailHTLC>,
1435         /// `update_fail_malformed_htlc` messages which should be sent
1436         pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
1437         /// An `update_fee` message which should be sent
1438         pub update_fee: Option<UpdateFee>,
1439         /// A `commitment_signed` message which should be sent
1440         pub commitment_signed: CommitmentSigned,
1441 }
1442
1443 /// A trait to describe an object which can receive channel messages.
1444 ///
1445 /// Messages MAY be called in parallel when they originate from different `their_node_ids`, however
1446 /// they MUST NOT be called in parallel when the two calls have the same `their_node_id`.
1447 pub trait ChannelMessageHandler : MessageSendEventsProvider {
1448         // Channel init:
1449         /// Handle an incoming `open_channel` message from the given peer.
1450         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel);
1451         /// Handle an incoming `open_channel2` message from the given peer.
1452         fn handle_open_channel_v2(&self, their_node_id: &PublicKey, msg: &OpenChannelV2);
1453         /// Handle an incoming `accept_channel` message from the given peer.
1454         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel);
1455         /// Handle an incoming `accept_channel2` message from the given peer.
1456         fn handle_accept_channel_v2(&self, their_node_id: &PublicKey, msg: &AcceptChannelV2);
1457         /// Handle an incoming `funding_created` message from the given peer.
1458         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
1459         /// Handle an incoming `funding_signed` message from the given peer.
1460         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
1461         /// Handle an incoming `channel_ready` message from the given peer.
1462         fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
1463
1464         // Channel close:
1465         /// Handle an incoming `shutdown` message from the given peer.
1466         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
1467         /// Handle an incoming `closing_signed` message from the given peer.
1468         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
1469
1470         // Quiescence
1471         /// Handle an incoming `stfu` message from the given peer.
1472         fn handle_stfu(&self, their_node_id: &PublicKey, msg: &Stfu);
1473
1474         // Splicing
1475         /// Handle an incoming `splice` message from the given peer.
1476         fn handle_splice(&self, their_node_id: &PublicKey, msg: &Splice);
1477         /// Handle an incoming `splice_ack` message from the given peer.
1478         fn handle_splice_ack(&self, their_node_id: &PublicKey, msg: &SpliceAck);
1479         /// Handle an incoming `splice_locked` message from the given peer.
1480         fn handle_splice_locked(&self, their_node_id: &PublicKey, msg: &SpliceLocked);
1481
1482         // Interactive channel construction
1483         /// Handle an incoming `tx_add_input message` from the given peer.
1484         fn handle_tx_add_input(&self, their_node_id: &PublicKey, msg: &TxAddInput);
1485         /// Handle an incoming `tx_add_output` message from the given peer.
1486         fn handle_tx_add_output(&self, their_node_id: &PublicKey, msg: &TxAddOutput);
1487         /// Handle an incoming `tx_remove_input` message from the given peer.
1488         fn handle_tx_remove_input(&self, their_node_id: &PublicKey, msg: &TxRemoveInput);
1489         /// Handle an incoming `tx_remove_output` message from the given peer.
1490         fn handle_tx_remove_output(&self, their_node_id: &PublicKey, msg: &TxRemoveOutput);
1491         /// Handle an incoming `tx_complete message` from the given peer.
1492         fn handle_tx_complete(&self, their_node_id: &PublicKey, msg: &TxComplete);
1493         /// Handle an incoming `tx_signatures` message from the given peer.
1494         fn handle_tx_signatures(&self, their_node_id: &PublicKey, msg: &TxSignatures);
1495         /// Handle an incoming `tx_init_rbf` message from the given peer.
1496         fn handle_tx_init_rbf(&self, their_node_id: &PublicKey, msg: &TxInitRbf);
1497         /// Handle an incoming `tx_ack_rbf` message from the given peer.
1498         fn handle_tx_ack_rbf(&self, their_node_id: &PublicKey, msg: &TxAckRbf);
1499         /// Handle an incoming `tx_abort message` from the given peer.
1500         fn handle_tx_abort(&self, their_node_id: &PublicKey, msg: &TxAbort);
1501
1502         // HTLC handling:
1503         /// Handle an incoming `update_add_htlc` message from the given peer.
1504         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
1505         /// Handle an incoming `update_fulfill_htlc` message from the given peer.
1506         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
1507         /// Handle an incoming `update_fail_htlc` message from the given peer.
1508         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
1509         /// Handle an incoming `update_fail_malformed_htlc` message from the given peer.
1510         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
1511         /// Handle an incoming `commitment_signed` message from the given peer.
1512         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
1513         /// Handle an incoming `revoke_and_ack` message from the given peer.
1514         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
1515
1516         /// Handle an incoming `update_fee` message from the given peer.
1517         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
1518
1519         // Channel-to-announce:
1520         /// Handle an incoming `announcement_signatures` message from the given peer.
1521         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
1522
1523         // Connection loss/reestablish:
1524         /// Indicates a connection to the peer failed/an existing connection was lost.
1525         fn peer_disconnected(&self, their_node_id: &PublicKey);
1526
1527         /// Handle a peer reconnecting, possibly generating `channel_reestablish` message(s).
1528         ///
1529         /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1530         /// with us. Implementors should be somewhat conservative about doing so, however, as other
1531         /// message handlers may still wish to communicate with this peer.
1532         fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init, inbound: bool) -> Result<(), ()>;
1533         /// Handle an incoming `channel_reestablish` message from the given peer.
1534         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
1535
1536         /// Handle an incoming `channel_update` message from the given peer.
1537         fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
1538
1539         // Error:
1540         /// Handle an incoming `error` message from the given peer.
1541         fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
1542
1543         // Handler information:
1544         /// Gets the node feature flags which this handler itself supports. All available handlers are
1545         /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1546         /// which are broadcasted in our [`NodeAnnouncement`] message.
1547         fn provided_node_features(&self) -> NodeFeatures;
1548
1549         /// Gets the init feature flags which should be sent to the given peer. All available handlers
1550         /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1551         /// which are sent in our [`Init`] message.
1552         ///
1553         /// Note that this method is called before [`Self::peer_connected`].
1554         fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1555
1556         /// Gets the chain hashes for this `ChannelMessageHandler` indicating which chains it supports.
1557         ///
1558         /// If it's `None`, then no particular network chain hash compatibility will be enforced when
1559         /// connecting to peers.
1560         fn get_chain_hashes(&self) -> Option<Vec<ChainHash>>;
1561 }
1562
1563 /// A trait to describe an object which can receive routing messages.
1564 ///
1565 /// # Implementor DoS Warnings
1566 ///
1567 /// For messages enabled with the `gossip_queries` feature there are potential DoS vectors when
1568 /// handling inbound queries. Implementors using an on-disk network graph should be aware of
1569 /// repeated disk I/O for queries accessing different parts of the network graph.
1570 pub trait RoutingMessageHandler : MessageSendEventsProvider {
1571         /// Handle an incoming `node_announcement` message, returning `true` if it should be forwarded on,
1572         /// `false` or returning an `Err` otherwise.
1573         fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
1574         /// Handle a `channel_announcement` message, returning `true` if it should be forwarded on, `false`
1575         /// or returning an `Err` otherwise.
1576         fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
1577         /// Handle an incoming `channel_update` message, returning true if it should be forwarded on,
1578         /// `false` or returning an `Err` otherwise.
1579         fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
1580         /// Gets channel announcements and updates required to dump our routing table to a remote node,
1581         /// starting at the `short_channel_id` indicated by `starting_point` and including announcements
1582         /// for a single channel.
1583         fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
1584         /// Gets a node announcement required to dump our routing table to a remote node, starting at
1585         /// the node *after* the provided pubkey and including up to one announcement immediately
1586         /// higher (as defined by `<PublicKey as Ord>::cmp`) than `starting_point`.
1587         /// If `None` is provided for `starting_point`, we start at the first node.
1588         fn get_next_node_announcement(&self, starting_point: Option<&NodeId>) -> Option<NodeAnnouncement>;
1589         /// Called when a connection is established with a peer. This can be used to
1590         /// perform routing table synchronization using a strategy defined by the
1591         /// implementor.
1592         ///
1593         /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1594         /// with us. Implementors should be somewhat conservative about doing so, however, as other
1595         /// message handlers may still wish to communicate with this peer.
1596         fn peer_connected(&self, their_node_id: &PublicKey, init: &Init, inbound: bool) -> Result<(), ()>;
1597         /// Handles the reply of a query we initiated to learn about channels
1598         /// for a given range of blocks. We can expect to receive one or more
1599         /// replies to a single query.
1600         fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
1601         /// Handles the reply of a query we initiated asking for routing gossip
1602         /// messages for a list of channels. We should receive this message when
1603         /// a node has completed its best effort to send us the pertaining routing
1604         /// gossip messages.
1605         fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
1606         /// Handles when a peer asks us to send a list of `short_channel_id`s
1607         /// for the requested range of blocks.
1608         fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
1609         /// Handles when a peer asks us to send routing gossip messages for a
1610         /// list of `short_channel_id`s.
1611         fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
1612
1613         // Handler queueing status:
1614         /// Indicates that there are a large number of [`ChannelAnnouncement`] (or other) messages
1615         /// pending some async action. While there is no guarantee of the rate of future messages, the
1616         /// caller should seek to reduce the rate of new gossip messages handled, especially
1617         /// [`ChannelAnnouncement`]s.
1618         fn processing_queue_high(&self) -> bool;
1619
1620         // Handler information:
1621         /// Gets the node feature flags which this handler itself supports. All available handlers are
1622         /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1623         /// which are broadcasted in our [`NodeAnnouncement`] message.
1624         fn provided_node_features(&self) -> NodeFeatures;
1625         /// Gets the init feature flags which should be sent to the given peer. All available handlers
1626         /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1627         /// which are sent in our [`Init`] message.
1628         ///
1629         /// Note that this method is called before [`Self::peer_connected`].
1630         fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1631 }
1632
1633 /// A handler for received [`OnionMessage`]s and for providing generated ones to send.
1634 pub trait OnionMessageHandler: EventsProvider {
1635         /// Handle an incoming `onion_message` message from the given peer.
1636         fn handle_onion_message(&self, peer_node_id: &PublicKey, msg: &OnionMessage);
1637
1638         /// Returns the next pending onion message for the peer with the given node id.
1639         fn next_onion_message_for_peer(&self, peer_node_id: PublicKey) -> Option<OnionMessage>;
1640
1641         /// Called when a connection is established with a peer. Can be used to track which peers
1642         /// advertise onion message support and are online.
1643         ///
1644         /// May return an `Err(())` if the features the peer supports are not sufficient to communicate
1645         /// with us. Implementors should be somewhat conservative about doing so, however, as other
1646         /// message handlers may still wish to communicate with this peer.
1647         fn peer_connected(&self, their_node_id: &PublicKey, init: &Init, inbound: bool) -> Result<(), ()>;
1648
1649         /// Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to
1650         /// drop and refuse to forward onion messages to this peer.
1651         fn peer_disconnected(&self, their_node_id: &PublicKey);
1652
1653         /// Performs actions that should happen roughly every ten seconds after startup. Allows handlers
1654         /// to drop any buffered onion messages intended for prospective peers.
1655         fn timer_tick_occurred(&self);
1656
1657         // Handler information:
1658         /// Gets the node feature flags which this handler itself supports. All available handlers are
1659         /// queried similarly and their feature flags are OR'd together to form the [`NodeFeatures`]
1660         /// which are broadcasted in our [`NodeAnnouncement`] message.
1661         fn provided_node_features(&self) -> NodeFeatures;
1662
1663         /// Gets the init feature flags which should be sent to the given peer. All available handlers
1664         /// are queried similarly and their feature flags are OR'd together to form the [`InitFeatures`]
1665         /// which are sent in our [`Init`] message.
1666         ///
1667         /// Note that this method is called before [`Self::peer_connected`].
1668         fn provided_init_features(&self, their_node_id: &PublicKey) -> InitFeatures;
1669 }
1670
1671 mod fuzzy_internal_msgs {
1672         use bitcoin::secp256k1::PublicKey;
1673         use crate::blinded_path::payment::{PaymentConstraints, PaymentRelay};
1674         use crate::prelude::*;
1675         use crate::ln::{PaymentPreimage, PaymentSecret};
1676         use crate::ln::features::BlindedHopFeatures;
1677
1678         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1679         // them from untrusted input):
1680         #[derive(Clone)]
1681         #[cfg_attr(test, derive(Debug, PartialEq))]
1682         pub struct FinalOnionHopData {
1683                 pub payment_secret: PaymentSecret,
1684                 /// The total value, in msat, of the payment as received by the ultimate recipient.
1685                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
1686                 pub total_msat: u64,
1687         }
1688
1689         pub enum InboundOnionPayload {
1690                 Forward {
1691                         short_channel_id: u64,
1692                         /// The value, in msat, of the payment after this hop's fee is deducted.
1693                         amt_to_forward: u64,
1694                         outgoing_cltv_value: u32,
1695                 },
1696                 Receive {
1697                         payment_data: Option<FinalOnionHopData>,
1698                         payment_metadata: Option<Vec<u8>>,
1699                         keysend_preimage: Option<PaymentPreimage>,
1700                         custom_tlvs: Vec<(u64, Vec<u8>)>,
1701                         amt_msat: u64,
1702                         outgoing_cltv_value: u32,
1703                 },
1704                 BlindedForward {
1705                         short_channel_id: u64,
1706                         payment_relay: PaymentRelay,
1707                         payment_constraints: PaymentConstraints,
1708                         features: BlindedHopFeatures,
1709                         intro_node_blinding_point: PublicKey,
1710                 },
1711                 BlindedReceive {
1712                         amt_msat: u64,
1713                         total_msat: u64,
1714                         outgoing_cltv_value: u32,
1715                         payment_secret: PaymentSecret,
1716                         payment_constraints: PaymentConstraints,
1717                         intro_node_blinding_point: Option<PublicKey>,
1718                 }
1719         }
1720
1721         pub(crate) enum OutboundOnionPayload {
1722                 Forward {
1723                         short_channel_id: u64,
1724                         /// The value, in msat, of the payment after this hop's fee is deducted.
1725                         amt_to_forward: u64,
1726                         outgoing_cltv_value: u32,
1727                 },
1728                 Receive {
1729                         payment_data: Option<FinalOnionHopData>,
1730                         payment_metadata: Option<Vec<u8>>,
1731                         keysend_preimage: Option<PaymentPreimage>,
1732                         custom_tlvs: Vec<(u64, Vec<u8>)>,
1733                         amt_msat: u64,
1734                         outgoing_cltv_value: u32,
1735                 },
1736                 BlindedForward {
1737                         encrypted_tlvs: Vec<u8>,
1738                         intro_node_blinding_point: Option<PublicKey>,
1739                 },
1740                 BlindedReceive {
1741                         amt_msat: u64,
1742                         total_msat: u64,
1743                         outgoing_cltv_value: u32,
1744                         encrypted_tlvs: Vec<u8>,
1745                         intro_node_blinding_point: Option<PublicKey>, // Set if the introduction node of the blinded path is the final node
1746                 }
1747         }
1748
1749         pub struct DecodedOnionErrorPacket {
1750                 pub(crate) hmac: [u8; 32],
1751                 pub(crate) failuremsg: Vec<u8>,
1752                 pub(crate) pad: Vec<u8>,
1753         }
1754 }
1755 #[cfg(fuzzing)]
1756 pub use self::fuzzy_internal_msgs::*;
1757 #[cfg(not(fuzzing))]
1758 pub(crate) use self::fuzzy_internal_msgs::*;
1759
1760 /// BOLT 4 onion packet including hop data for the next peer.
1761 #[derive(Clone, Hash, PartialEq, Eq)]
1762 pub struct OnionPacket {
1763         /// BOLT 4 version number.
1764         pub version: u8,
1765         /// In order to ensure we always return an error on onion decode in compliance with [BOLT
1766         /// #4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md), we have to
1767         /// deserialize `OnionPacket`s contained in [`UpdateAddHTLC`] messages even if the ephemeral
1768         /// public key (here) is bogus, so we hold a [`Result`] instead of a [`PublicKey`] as we'd
1769         /// like.
1770         pub public_key: Result<PublicKey, secp256k1::Error>,
1771         /// 1300 bytes encrypted payload for the next hop.
1772         pub hop_data: [u8; 20*65],
1773         /// HMAC to verify the integrity of hop_data.
1774         pub hmac: [u8; 32],
1775 }
1776
1777 impl onion_utils::Packet for OnionPacket {
1778         type Data = onion_utils::FixedSizeOnionPacket;
1779         fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1780                 Self {
1781                         version: 0,
1782                         public_key: Ok(pubkey),
1783                         hop_data: hop_data.0,
1784                         hmac,
1785                 }
1786         }
1787 }
1788
1789 impl fmt::Debug for OnionPacket {
1790         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1791                 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1792         }
1793 }
1794
1795 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1796 pub(crate) struct OnionErrorPacket {
1797         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1798         // (TODO) We limit it in decode to much lower...
1799         pub(crate) data: Vec<u8>,
1800 }
1801
1802 impl fmt::Display for DecodeError {
1803         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1804                 match *self {
1805                         DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1806                         DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1807                         DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1808                         DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1809                         DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1810                         DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1811                         DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1812                 }
1813         }
1814 }
1815
1816 impl From<io::Error> for DecodeError {
1817         fn from(e: io::Error) -> Self {
1818                 if e.kind() == io::ErrorKind::UnexpectedEof {
1819                         DecodeError::ShortRead
1820                 } else {
1821                         DecodeError::Io(e.kind())
1822                 }
1823         }
1824 }
1825
1826 #[cfg(not(taproot))]
1827 impl_writeable_msg!(AcceptChannel, {
1828         temporary_channel_id,
1829         dust_limit_satoshis,
1830         max_htlc_value_in_flight_msat,
1831         channel_reserve_satoshis,
1832         htlc_minimum_msat,
1833         minimum_depth,
1834         to_self_delay,
1835         max_accepted_htlcs,
1836         funding_pubkey,
1837         revocation_basepoint,
1838         payment_point,
1839         delayed_payment_basepoint,
1840         htlc_basepoint,
1841         first_per_commitment_point,
1842 }, {
1843         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
1844         (1, channel_type, option),
1845 });
1846
1847 #[cfg(taproot)]
1848 impl_writeable_msg!(AcceptChannel, {
1849         temporary_channel_id,
1850         dust_limit_satoshis,
1851         max_htlc_value_in_flight_msat,
1852         channel_reserve_satoshis,
1853         htlc_minimum_msat,
1854         minimum_depth,
1855         to_self_delay,
1856         max_accepted_htlcs,
1857         funding_pubkey,
1858         revocation_basepoint,
1859         payment_point,
1860         delayed_payment_basepoint,
1861         htlc_basepoint,
1862         first_per_commitment_point,
1863 }, {
1864         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
1865         (1, channel_type, option),
1866         (4, next_local_nonce, option),
1867 });
1868
1869 impl_writeable_msg!(AcceptChannelV2, {
1870         temporary_channel_id,
1871         funding_satoshis,
1872         dust_limit_satoshis,
1873         max_htlc_value_in_flight_msat,
1874         htlc_minimum_msat,
1875         minimum_depth,
1876         to_self_delay,
1877         max_accepted_htlcs,
1878         funding_pubkey,
1879         revocation_basepoint,
1880         payment_basepoint,
1881         delayed_payment_basepoint,
1882         htlc_basepoint,
1883         first_per_commitment_point,
1884         second_per_commitment_point,
1885 }, {
1886         (0, shutdown_scriptpubkey, option),
1887         (1, channel_type, option),
1888         (2, require_confirmed_inputs, option),
1889 });
1890
1891 impl_writeable_msg!(Stfu, {
1892         channel_id,
1893         initiator,
1894 }, {});
1895
1896 impl_writeable_msg!(Splice, {
1897         channel_id,
1898         chain_hash,
1899         relative_satoshis,
1900         funding_feerate_perkw,
1901         locktime,
1902         funding_pubkey,
1903 }, {});
1904
1905 impl_writeable_msg!(SpliceAck, {
1906         channel_id,
1907         chain_hash,
1908         relative_satoshis,
1909         funding_pubkey,
1910 }, {});
1911
1912 impl_writeable_msg!(SpliceLocked, {
1913         channel_id,
1914 }, {});
1915
1916 impl_writeable_msg!(TxAddInput, {
1917         channel_id,
1918         serial_id,
1919         prevtx,
1920         prevtx_out,
1921         sequence,
1922 }, {});
1923
1924 impl_writeable_msg!(TxAddOutput, {
1925         channel_id,
1926         serial_id,
1927         sats,
1928         script,
1929 }, {});
1930
1931 impl_writeable_msg!(TxRemoveInput, {
1932         channel_id,
1933         serial_id,
1934 }, {});
1935
1936 impl_writeable_msg!(TxRemoveOutput, {
1937         channel_id,
1938         serial_id,
1939 }, {});
1940
1941 impl_writeable_msg!(TxComplete, {
1942         channel_id,
1943 }, {});
1944
1945 impl_writeable_msg!(TxSignatures, {
1946         channel_id,
1947         tx_hash,
1948         witnesses,
1949 }, {});
1950
1951 impl_writeable_msg!(TxInitRbf, {
1952         channel_id,
1953         locktime,
1954         feerate_sat_per_1000_weight,
1955 }, {
1956         (0, funding_output_contribution, option),
1957 });
1958
1959 impl_writeable_msg!(TxAckRbf, {
1960         channel_id,
1961 }, {
1962         (0, funding_output_contribution, option),
1963 });
1964
1965 impl_writeable_msg!(TxAbort, {
1966         channel_id,
1967         data,
1968 }, {});
1969
1970 impl_writeable_msg!(AnnouncementSignatures, {
1971         channel_id,
1972         short_channel_id,
1973         node_signature,
1974         bitcoin_signature
1975 }, {});
1976
1977 impl_writeable_msg!(ChannelReestablish, {
1978         channel_id,
1979         next_local_commitment_number,
1980         next_remote_commitment_number,
1981         your_last_per_commitment_secret,
1982         my_current_per_commitment_point,
1983 }, {
1984         (0, next_funding_txid, option),
1985 });
1986
1987 impl_writeable_msg!(ClosingSigned,
1988         { channel_id, fee_satoshis, signature },
1989         { (1, fee_range, option) }
1990 );
1991
1992 impl_writeable!(ClosingSignedFeeRange, {
1993         min_fee_satoshis,
1994         max_fee_satoshis
1995 });
1996
1997 #[cfg(not(taproot))]
1998 impl_writeable_msg!(CommitmentSigned, {
1999         channel_id,
2000         signature,
2001         htlc_signatures
2002 }, {});
2003
2004 #[cfg(taproot)]
2005 impl_writeable_msg!(CommitmentSigned, {
2006         channel_id,
2007         signature,
2008         htlc_signatures
2009 }, {
2010         (2, partial_signature_with_nonce, option)
2011 });
2012
2013 impl_writeable!(DecodedOnionErrorPacket, {
2014         hmac,
2015         failuremsg,
2016         pad
2017 });
2018
2019 #[cfg(not(taproot))]
2020 impl_writeable_msg!(FundingCreated, {
2021         temporary_channel_id,
2022         funding_txid,
2023         funding_output_index,
2024         signature
2025 }, {});
2026 #[cfg(taproot)]
2027 impl_writeable_msg!(FundingCreated, {
2028         temporary_channel_id,
2029         funding_txid,
2030         funding_output_index,
2031         signature
2032 }, {
2033         (2, partial_signature_with_nonce, option),
2034         (4, next_local_nonce, option)
2035 });
2036
2037 #[cfg(not(taproot))]
2038 impl_writeable_msg!(FundingSigned, {
2039         channel_id,
2040         signature
2041 }, {});
2042
2043 #[cfg(taproot)]
2044 impl_writeable_msg!(FundingSigned, {
2045         channel_id,
2046         signature
2047 }, {
2048         (2, partial_signature_with_nonce, option)
2049 });
2050
2051 impl_writeable_msg!(ChannelReady, {
2052         channel_id,
2053         next_per_commitment_point,
2054 }, {
2055         (1, short_channel_id_alias, option),
2056 });
2057
2058 impl Writeable for Init {
2059         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2060                 // global_features gets the bottom 13 bits of our features, and local_features gets all of
2061                 // our relevant feature bits. This keeps us compatible with old nodes.
2062                 self.features.write_up_to_13(w)?;
2063                 self.features.write(w)?;
2064                 encode_tlv_stream!(w, {
2065                         (1, self.networks.as_ref().map(|n| WithoutLength(n)), option),
2066                         (3, self.remote_network_address, option),
2067                 });
2068                 Ok(())
2069         }
2070 }
2071
2072 impl Readable for Init {
2073         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2074                 let global_features: InitFeatures = Readable::read(r)?;
2075                 let features: InitFeatures = Readable::read(r)?;
2076                 let mut remote_network_address: Option<SocketAddress> = None;
2077                 let mut networks: Option<WithoutLength<Vec<ChainHash>>> = None;
2078                 decode_tlv_stream!(r, {
2079                         (1, networks, option),
2080                         (3, remote_network_address, option)
2081                 });
2082                 Ok(Init {
2083                         features: features | global_features,
2084                         networks: networks.map(|n| n.0),
2085                         remote_network_address,
2086                 })
2087         }
2088 }
2089
2090 impl_writeable_msg!(OpenChannel, {
2091         chain_hash,
2092         temporary_channel_id,
2093         funding_satoshis,
2094         push_msat,
2095         dust_limit_satoshis,
2096         max_htlc_value_in_flight_msat,
2097         channel_reserve_satoshis,
2098         htlc_minimum_msat,
2099         feerate_per_kw,
2100         to_self_delay,
2101         max_accepted_htlcs,
2102         funding_pubkey,
2103         revocation_basepoint,
2104         payment_point,
2105         delayed_payment_basepoint,
2106         htlc_basepoint,
2107         first_per_commitment_point,
2108         channel_flags,
2109 }, {
2110         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
2111         (1, channel_type, option),
2112 });
2113
2114 impl_writeable_msg!(OpenChannelV2, {
2115         chain_hash,
2116         temporary_channel_id,
2117         funding_feerate_sat_per_1000_weight,
2118         commitment_feerate_sat_per_1000_weight,
2119         funding_satoshis,
2120         dust_limit_satoshis,
2121         max_htlc_value_in_flight_msat,
2122         htlc_minimum_msat,
2123         to_self_delay,
2124         max_accepted_htlcs,
2125         locktime,
2126         funding_pubkey,
2127         revocation_basepoint,
2128         payment_basepoint,
2129         delayed_payment_basepoint,
2130         htlc_basepoint,
2131         first_per_commitment_point,
2132         second_per_commitment_point,
2133         channel_flags,
2134 }, {
2135         (0, shutdown_scriptpubkey, option),
2136         (1, channel_type, option),
2137         (2, require_confirmed_inputs, option),
2138 });
2139
2140 #[cfg(not(taproot))]
2141 impl_writeable_msg!(RevokeAndACK, {
2142         channel_id,
2143         per_commitment_secret,
2144         next_per_commitment_point
2145 }, {});
2146
2147 #[cfg(taproot)]
2148 impl_writeable_msg!(RevokeAndACK, {
2149         channel_id,
2150         per_commitment_secret,
2151         next_per_commitment_point
2152 }, {
2153         (4, next_local_nonce, option)
2154 });
2155
2156 impl_writeable_msg!(Shutdown, {
2157         channel_id,
2158         scriptpubkey
2159 }, {});
2160
2161 impl_writeable_msg!(UpdateFailHTLC, {
2162         channel_id,
2163         htlc_id,
2164         reason
2165 }, {});
2166
2167 impl_writeable_msg!(UpdateFailMalformedHTLC, {
2168         channel_id,
2169         htlc_id,
2170         sha256_of_onion,
2171         failure_code
2172 }, {});
2173
2174 impl_writeable_msg!(UpdateFee, {
2175         channel_id,
2176         feerate_per_kw
2177 }, {});
2178
2179 impl_writeable_msg!(UpdateFulfillHTLC, {
2180         channel_id,
2181         htlc_id,
2182         payment_preimage
2183 }, {});
2184
2185 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
2186 // serialization format in a way which assumes we know the total serialized length/message end
2187 // position.
2188 impl_writeable!(OnionErrorPacket, {
2189         data
2190 });
2191
2192 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
2193 // serialization format in a way which assumes we know the total serialized length/message end
2194 // position.
2195 impl Writeable for OnionPacket {
2196         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2197                 self.version.write(w)?;
2198                 match self.public_key {
2199                         Ok(pubkey) => pubkey.write(w)?,
2200                         Err(_) => [0u8;33].write(w)?,
2201                 }
2202                 w.write_all(&self.hop_data)?;
2203                 self.hmac.write(w)?;
2204                 Ok(())
2205         }
2206 }
2207
2208 impl Readable for OnionPacket {
2209         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2210                 Ok(OnionPacket {
2211                         version: Readable::read(r)?,
2212                         public_key: {
2213                                 let mut buf = [0u8;33];
2214                                 r.read_exact(&mut buf)?;
2215                                 PublicKey::from_slice(&buf)
2216                         },
2217                         hop_data: Readable::read(r)?,
2218                         hmac: Readable::read(r)?,
2219                 })
2220         }
2221 }
2222
2223 impl_writeable_msg!(UpdateAddHTLC, {
2224         channel_id,
2225         htlc_id,
2226         amount_msat,
2227         payment_hash,
2228         cltv_expiry,
2229         onion_routing_packet,
2230 }, {
2231         (0, blinding_point, option),
2232         (65537, skimmed_fee_msat, option)
2233 });
2234
2235 impl Readable for OnionMessage {
2236         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2237                 let blinding_point: PublicKey = Readable::read(r)?;
2238                 let len: u16 = Readable::read(r)?;
2239                 let mut packet_reader = FixedLengthReader::new(r, len as u64);
2240                 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
2241                 Ok(Self {
2242                         blinding_point,
2243                         onion_routing_packet,
2244                 })
2245         }
2246 }
2247
2248 impl Writeable for OnionMessage {
2249         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2250                 self.blinding_point.write(w)?;
2251                 let onion_packet_len = self.onion_routing_packet.serialized_length();
2252                 (onion_packet_len as u16).write(w)?;
2253                 self.onion_routing_packet.write(w)?;
2254                 Ok(())
2255         }
2256 }
2257
2258 impl Writeable for FinalOnionHopData {
2259         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2260                 self.payment_secret.0.write(w)?;
2261                 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
2262         }
2263 }
2264
2265 impl Readable for FinalOnionHopData {
2266         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2267                 let secret: [u8; 32] = Readable::read(r)?;
2268                 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
2269                 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
2270         }
2271 }
2272
2273 impl Writeable for OutboundOnionPayload {
2274         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2275                 match self {
2276                         Self::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } => {
2277                                 _encode_varint_length_prefixed_tlv!(w, {
2278                                         (2, HighZeroBytesDroppedBigSize(*amt_to_forward), required),
2279                                         (4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
2280                                         (6, short_channel_id, required)
2281                                 });
2282                         },
2283                         Self::Receive {
2284                                 ref payment_data, ref payment_metadata, ref keysend_preimage, amt_msat,
2285                                 outgoing_cltv_value, ref custom_tlvs,
2286                         } => {
2287                                 // We need to update [`ln::outbound_payment::RecipientOnionFields::with_custom_tlvs`]
2288                                 // to reject any reserved types in the experimental range if new ones are ever
2289                                 // standardized.
2290                                 let keysend_tlv = keysend_preimage.map(|preimage| (5482373484, preimage.encode()));
2291                                 let mut custom_tlvs: Vec<&(u64, Vec<u8>)> = custom_tlvs.iter().chain(keysend_tlv.iter()).collect();
2292                                 custom_tlvs.sort_unstable_by_key(|(typ, _)| *typ);
2293                                 _encode_varint_length_prefixed_tlv!(w, {
2294                                         (2, HighZeroBytesDroppedBigSize(*amt_msat), required),
2295                                         (4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
2296                                         (8, payment_data, option),
2297                                         (16, payment_metadata.as_ref().map(|m| WithoutLength(m)), option)
2298                                 }, custom_tlvs.iter());
2299                         },
2300                         Self::BlindedForward { encrypted_tlvs, intro_node_blinding_point } => {
2301                                 _encode_varint_length_prefixed_tlv!(w, {
2302                                         (10, *encrypted_tlvs, required_vec),
2303                                         (12, intro_node_blinding_point, option)
2304                                 });
2305                         },
2306                         Self::BlindedReceive {
2307                                 amt_msat, total_msat, outgoing_cltv_value, encrypted_tlvs,
2308                                 intro_node_blinding_point,
2309                         } => {
2310                                 _encode_varint_length_prefixed_tlv!(w, {
2311                                         (2, HighZeroBytesDroppedBigSize(*amt_msat), required),
2312                                         (4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
2313                                         (10, *encrypted_tlvs, required_vec),
2314                                         (12, intro_node_blinding_point, option),
2315                                         (18, HighZeroBytesDroppedBigSize(*total_msat), required)
2316                                 });
2317                         },
2318                 }
2319                 Ok(())
2320         }
2321 }
2322
2323 impl<NS: Deref> ReadableArgs<(Option<PublicKey>, &NS)> for InboundOnionPayload where NS::Target: NodeSigner {
2324         fn read<R: Read>(r: &mut R, args: (Option<PublicKey>, &NS)) -> Result<Self, DecodeError> {
2325                 let (update_add_blinding_point, node_signer) = args;
2326
2327                 let mut amt = None;
2328                 let mut cltv_value = None;
2329                 let mut short_id: Option<u64> = None;
2330                 let mut payment_data: Option<FinalOnionHopData> = None;
2331                 let mut encrypted_tlvs_opt: Option<WithoutLength<Vec<u8>>> = None;
2332                 let mut intro_node_blinding_point = None;
2333                 let mut payment_metadata: Option<WithoutLength<Vec<u8>>> = None;
2334                 let mut total_msat = None;
2335                 let mut keysend_preimage: Option<PaymentPreimage> = None;
2336                 let mut custom_tlvs = Vec::new();
2337
2338                 let tlv_len = BigSize::read(r)?;
2339                 let rd = FixedLengthReader::new(r, tlv_len.0);
2340                 decode_tlv_stream_with_custom_tlv_decode!(rd, {
2341                         (2, amt, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
2342                         (4, cltv_value, (option, encoding: (u32, HighZeroBytesDroppedBigSize))),
2343                         (6, short_id, option),
2344                         (8, payment_data, option),
2345                         (10, encrypted_tlvs_opt, option),
2346                         (12, intro_node_blinding_point, option),
2347                         (16, payment_metadata, option),
2348                         (18, total_msat, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
2349                         // See https://github.com/lightning/blips/blob/master/blip-0003.md
2350                         (5482373484, keysend_preimage, option)
2351                 }, |msg_type: u64, msg_reader: &mut FixedLengthReader<_>| -> Result<bool, DecodeError> {
2352                         if msg_type < 1 << 16 { return Ok(false) }
2353                         let mut value = Vec::new();
2354                         msg_reader.read_to_end(&mut value)?;
2355                         custom_tlvs.push((msg_type, value));
2356                         Ok(true)
2357                 });
2358
2359                 if amt.unwrap_or(0) > MAX_VALUE_MSAT { return Err(DecodeError::InvalidValue) }
2360                 if intro_node_blinding_point.is_some() && update_add_blinding_point.is_some() {
2361                         return Err(DecodeError::InvalidValue)
2362                 }
2363
2364                 if let Some(blinding_point) = intro_node_blinding_point.or(update_add_blinding_point) {
2365                         if short_id.is_some() || payment_data.is_some() || payment_metadata.is_some() {
2366                                 return Err(DecodeError::InvalidValue)
2367                         }
2368                         let enc_tlvs = encrypted_tlvs_opt.ok_or(DecodeError::InvalidValue)?.0;
2369                         let enc_tlvs_ss = node_signer.ecdh(Recipient::Node, &blinding_point, None)
2370                                 .map_err(|_| DecodeError::InvalidValue)?;
2371                         let rho = onion_utils::gen_rho_from_shared_secret(&enc_tlvs_ss.secret_bytes());
2372                         let mut s = Cursor::new(&enc_tlvs);
2373                         let mut reader = FixedLengthReader::new(&mut s, enc_tlvs.len() as u64);
2374                         match ChaChaPolyReadAdapter::read(&mut reader, rho)? {
2375                                 ChaChaPolyReadAdapter { readable: BlindedPaymentTlvs::Forward(ForwardTlvs {
2376                                         short_channel_id, payment_relay, payment_constraints, features
2377                                 })} => {
2378                                         if amt.is_some() || cltv_value.is_some() || total_msat.is_some() {
2379                                                 return Err(DecodeError::InvalidValue)
2380                                         }
2381                                         Ok(Self::BlindedForward {
2382                                                 short_channel_id,
2383                                                 payment_relay,
2384                                                 payment_constraints,
2385                                                 features,
2386                                                 intro_node_blinding_point: intro_node_blinding_point.ok_or(DecodeError::InvalidValue)?,
2387                                         })
2388                                 },
2389                                 ChaChaPolyReadAdapter { readable: BlindedPaymentTlvs::Receive(ReceiveTlvs {
2390                                         payment_secret, payment_constraints
2391                                 })} => {
2392                                         if total_msat.unwrap_or(0) > MAX_VALUE_MSAT { return Err(DecodeError::InvalidValue) }
2393                                         Ok(Self::BlindedReceive {
2394                                                 amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
2395                                                 total_msat: total_msat.ok_or(DecodeError::InvalidValue)?,
2396                                                 outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
2397                                                 payment_secret,
2398                                                 payment_constraints,
2399                                                 intro_node_blinding_point,
2400                                         })
2401                                 },
2402                         }
2403                 } else if let Some(short_channel_id) = short_id {
2404                         if payment_data.is_some() || payment_metadata.is_some() || encrypted_tlvs_opt.is_some() ||
2405                                 total_msat.is_some()
2406                         { return Err(DecodeError::InvalidValue) }
2407                         Ok(Self::Forward {
2408                                 short_channel_id,
2409                                 amt_to_forward: amt.ok_or(DecodeError::InvalidValue)?,
2410                                 outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
2411                         })
2412                 } else {
2413                         if encrypted_tlvs_opt.is_some() || total_msat.is_some() {
2414                                 return Err(DecodeError::InvalidValue)
2415                         }
2416                         if let Some(data) = &payment_data {
2417                                 if data.total_msat > MAX_VALUE_MSAT {
2418                                         return Err(DecodeError::InvalidValue);
2419                                 }
2420                         }
2421                         Ok(Self::Receive {
2422                                 payment_data,
2423                                 payment_metadata: payment_metadata.map(|w| w.0),
2424                                 keysend_preimage,
2425                                 amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
2426                                 outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
2427                                 custom_tlvs,
2428                         })
2429                 }
2430         }
2431 }
2432
2433 impl Writeable for Ping {
2434         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2435                 self.ponglen.write(w)?;
2436                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
2437                 Ok(())
2438         }
2439 }
2440
2441 impl Readable for Ping {
2442         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2443                 Ok(Ping {
2444                         ponglen: Readable::read(r)?,
2445                         byteslen: {
2446                                 let byteslen = Readable::read(r)?;
2447                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
2448                                 byteslen
2449                         }
2450                 })
2451         }
2452 }
2453
2454 impl Writeable for Pong {
2455         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2456                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
2457                 Ok(())
2458         }
2459 }
2460
2461 impl Readable for Pong {
2462         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2463                 Ok(Pong {
2464                         byteslen: {
2465                                 let byteslen = Readable::read(r)?;
2466                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
2467                                 byteslen
2468                         }
2469                 })
2470         }
2471 }
2472
2473 impl Writeable for UnsignedChannelAnnouncement {
2474         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2475                 self.features.write(w)?;
2476                 self.chain_hash.write(w)?;
2477                 self.short_channel_id.write(w)?;
2478                 self.node_id_1.write(w)?;
2479                 self.node_id_2.write(w)?;
2480                 self.bitcoin_key_1.write(w)?;
2481                 self.bitcoin_key_2.write(w)?;
2482                 w.write_all(&self.excess_data[..])?;
2483                 Ok(())
2484         }
2485 }
2486
2487 impl Readable for UnsignedChannelAnnouncement {
2488         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2489                 Ok(Self {
2490                         features: Readable::read(r)?,
2491                         chain_hash: Readable::read(r)?,
2492                         short_channel_id: Readable::read(r)?,
2493                         node_id_1: Readable::read(r)?,
2494                         node_id_2: Readable::read(r)?,
2495                         bitcoin_key_1: Readable::read(r)?,
2496                         bitcoin_key_2: Readable::read(r)?,
2497                         excess_data: read_to_end(r)?,
2498                 })
2499         }
2500 }
2501
2502 impl_writeable!(ChannelAnnouncement, {
2503         node_signature_1,
2504         node_signature_2,
2505         bitcoin_signature_1,
2506         bitcoin_signature_2,
2507         contents
2508 });
2509
2510 impl Writeable for UnsignedChannelUpdate {
2511         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2512                 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
2513                 const MESSAGE_FLAGS: u8 = 1;
2514                 self.chain_hash.write(w)?;
2515                 self.short_channel_id.write(w)?;
2516                 self.timestamp.write(w)?;
2517                 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
2518                 all_flags.write(w)?;
2519                 self.cltv_expiry_delta.write(w)?;
2520                 self.htlc_minimum_msat.write(w)?;
2521                 self.fee_base_msat.write(w)?;
2522                 self.fee_proportional_millionths.write(w)?;
2523                 self.htlc_maximum_msat.write(w)?;
2524                 w.write_all(&self.excess_data[..])?;
2525                 Ok(())
2526         }
2527 }
2528
2529 impl Readable for UnsignedChannelUpdate {
2530         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2531                 Ok(Self {
2532                         chain_hash: Readable::read(r)?,
2533                         short_channel_id: Readable::read(r)?,
2534                         timestamp: Readable::read(r)?,
2535                         flags: {
2536                                 let flags: u16 = Readable::read(r)?;
2537                                 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
2538                                 flags as u8
2539                         },
2540                         cltv_expiry_delta: Readable::read(r)?,
2541                         htlc_minimum_msat: Readable::read(r)?,
2542                         fee_base_msat: Readable::read(r)?,
2543                         fee_proportional_millionths: Readable::read(r)?,
2544                         htlc_maximum_msat: Readable::read(r)?,
2545                         excess_data: read_to_end(r)?,
2546                 })
2547         }
2548 }
2549
2550 impl_writeable!(ChannelUpdate, {
2551         signature,
2552         contents
2553 });
2554
2555 impl Writeable for ErrorMessage {
2556         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2557                 self.channel_id.write(w)?;
2558                 (self.data.len() as u16).write(w)?;
2559                 w.write_all(self.data.as_bytes())?;
2560                 Ok(())
2561         }
2562 }
2563
2564 impl Readable for ErrorMessage {
2565         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2566                 Ok(Self {
2567                         channel_id: Readable::read(r)?,
2568                         data: {
2569                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
2570                                 let mut data = Vec::with_capacity(sz);
2571                                 data.resize(sz, 0);
2572                                 r.read_exact(&mut data)?;
2573                                 match String::from_utf8(data) {
2574                                         Ok(s) => s,
2575                                         Err(_) => return Err(DecodeError::InvalidValue),
2576                                 }
2577                         }
2578                 })
2579         }
2580 }
2581
2582 impl Writeable for WarningMessage {
2583         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2584                 self.channel_id.write(w)?;
2585                 (self.data.len() as u16).write(w)?;
2586                 w.write_all(self.data.as_bytes())?;
2587                 Ok(())
2588         }
2589 }
2590
2591 impl Readable for WarningMessage {
2592         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2593                 Ok(Self {
2594                         channel_id: Readable::read(r)?,
2595                         data: {
2596                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
2597                                 let mut data = Vec::with_capacity(sz);
2598                                 data.resize(sz, 0);
2599                                 r.read_exact(&mut data)?;
2600                                 match String::from_utf8(data) {
2601                                         Ok(s) => s,
2602                                         Err(_) => return Err(DecodeError::InvalidValue),
2603                                 }
2604                         }
2605                 })
2606         }
2607 }
2608
2609 impl Writeable for UnsignedNodeAnnouncement {
2610         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2611                 self.features.write(w)?;
2612                 self.timestamp.write(w)?;
2613                 self.node_id.write(w)?;
2614                 w.write_all(&self.rgb)?;
2615                 self.alias.write(w)?;
2616
2617                 let mut addr_len = 0;
2618                 for addr in self.addresses.iter() {
2619                         addr_len += 1 + addr.len();
2620                 }
2621                 (addr_len + self.excess_address_data.len() as u16).write(w)?;
2622                 for addr in self.addresses.iter() {
2623                         addr.write(w)?;
2624                 }
2625                 w.write_all(&self.excess_address_data[..])?;
2626                 w.write_all(&self.excess_data[..])?;
2627                 Ok(())
2628         }
2629 }
2630
2631 impl Readable for UnsignedNodeAnnouncement {
2632         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2633                 let features: NodeFeatures = Readable::read(r)?;
2634                 let timestamp: u32 = Readable::read(r)?;
2635                 let node_id: NodeId = Readable::read(r)?;
2636                 let mut rgb = [0; 3];
2637                 r.read_exact(&mut rgb)?;
2638                 let alias: NodeAlias = Readable::read(r)?;
2639
2640                 let addr_len: u16 = Readable::read(r)?;
2641                 let mut addresses: Vec<SocketAddress> = Vec::new();
2642                 let mut addr_readpos = 0;
2643                 let mut excess = false;
2644                 let mut excess_byte = 0;
2645                 loop {
2646                         if addr_len <= addr_readpos { break; }
2647                         match Readable::read(r) {
2648                                 Ok(Ok(addr)) => {
2649                                         if addr_len < addr_readpos + 1 + addr.len() {
2650                                                 return Err(DecodeError::BadLengthDescriptor);
2651                                         }
2652                                         addr_readpos += (1 + addr.len()) as u16;
2653                                         addresses.push(addr);
2654                                 },
2655                                 Ok(Err(unknown_descriptor)) => {
2656                                         excess = true;
2657                                         excess_byte = unknown_descriptor;
2658                                         break;
2659                                 },
2660                                 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
2661                                 Err(e) => return Err(e),
2662                         }
2663                 }
2664
2665                 let mut excess_data = vec![];
2666                 let excess_address_data = if addr_readpos < addr_len {
2667                         let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
2668                         r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
2669                         if excess {
2670                                 excess_address_data[0] = excess_byte;
2671                         }
2672                         excess_address_data
2673                 } else {
2674                         if excess {
2675                                 excess_data.push(excess_byte);
2676                         }
2677                         Vec::new()
2678                 };
2679                 excess_data.extend(read_to_end(r)?.iter());
2680                 Ok(UnsignedNodeAnnouncement {
2681                         features,
2682                         timestamp,
2683                         node_id,
2684                         rgb,
2685                         alias,
2686                         addresses,
2687                         excess_address_data,
2688                         excess_data,
2689                 })
2690         }
2691 }
2692
2693 impl_writeable!(NodeAnnouncement, {
2694         signature,
2695         contents
2696 });
2697
2698 impl Readable for QueryShortChannelIds {
2699         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2700                 let chain_hash: ChainHash = Readable::read(r)?;
2701
2702                 let encoding_len: u16 = Readable::read(r)?;
2703                 let encoding_type: u8 = Readable::read(r)?;
2704
2705                 // Must be encoding_type=0 uncompressed serialization. We do not
2706                 // support encoding_type=1 zlib serialization.
2707                 if encoding_type != EncodingType::Uncompressed as u8 {
2708                         return Err(DecodeError::UnsupportedCompression);
2709                 }
2710
2711                 // We expect the encoding_len to always includes the 1-byte
2712                 // encoding_type and that short_channel_ids are 8-bytes each
2713                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2714                         return Err(DecodeError::InvalidValue);
2715                 }
2716
2717                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2718                 // less the 1-byte encoding_type
2719                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2720                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2721                 for _ in 0..short_channel_id_count {
2722                         short_channel_ids.push(Readable::read(r)?);
2723                 }
2724
2725                 Ok(QueryShortChannelIds {
2726                         chain_hash,
2727                         short_channel_ids,
2728                 })
2729         }
2730 }
2731
2732 impl Writeable for QueryShortChannelIds {
2733         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2734                 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
2735                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2736
2737                 self.chain_hash.write(w)?;
2738                 encoding_len.write(w)?;
2739
2740                 // We only support type=0 uncompressed serialization
2741                 (EncodingType::Uncompressed as u8).write(w)?;
2742
2743                 for scid in self.short_channel_ids.iter() {
2744                         scid.write(w)?;
2745                 }
2746
2747                 Ok(())
2748         }
2749 }
2750
2751 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
2752         chain_hash,
2753         full_information,
2754 }, {});
2755
2756 impl QueryChannelRange {
2757         /// Calculates the overflow safe ending block height for the query.
2758         ///
2759         /// Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`.
2760         pub fn end_blocknum(&self) -> u32 {
2761                 match self.first_blocknum.checked_add(self.number_of_blocks) {
2762                         Some(block) => block,
2763                         None => u32::max_value(),
2764                 }
2765         }
2766 }
2767
2768 impl_writeable_msg!(QueryChannelRange, {
2769         chain_hash,
2770         first_blocknum,
2771         number_of_blocks
2772 }, {});
2773
2774 impl Readable for ReplyChannelRange {
2775         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2776                 let chain_hash: ChainHash = Readable::read(r)?;
2777                 let first_blocknum: u32 = Readable::read(r)?;
2778                 let number_of_blocks: u32 = Readable::read(r)?;
2779                 let sync_complete: bool = Readable::read(r)?;
2780
2781                 let encoding_len: u16 = Readable::read(r)?;
2782                 let encoding_type: u8 = Readable::read(r)?;
2783
2784                 // Must be encoding_type=0 uncompressed serialization. We do not
2785                 // support encoding_type=1 zlib serialization.
2786                 if encoding_type != EncodingType::Uncompressed as u8 {
2787                         return Err(DecodeError::UnsupportedCompression);
2788                 }
2789
2790                 // We expect the encoding_len to always includes the 1-byte
2791                 // encoding_type and that short_channel_ids are 8-bytes each
2792                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2793                         return Err(DecodeError::InvalidValue);
2794                 }
2795
2796                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2797                 // less the 1-byte encoding_type
2798                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2799                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2800                 for _ in 0..short_channel_id_count {
2801                         short_channel_ids.push(Readable::read(r)?);
2802                 }
2803
2804                 Ok(ReplyChannelRange {
2805                         chain_hash,
2806                         first_blocknum,
2807                         number_of_blocks,
2808                         sync_complete,
2809                         short_channel_ids
2810                 })
2811         }
2812 }
2813
2814 impl Writeable for ReplyChannelRange {
2815         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2816                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2817                 self.chain_hash.write(w)?;
2818                 self.first_blocknum.write(w)?;
2819                 self.number_of_blocks.write(w)?;
2820                 self.sync_complete.write(w)?;
2821
2822                 encoding_len.write(w)?;
2823                 (EncodingType::Uncompressed as u8).write(w)?;
2824                 for scid in self.short_channel_ids.iter() {
2825                         scid.write(w)?;
2826                 }
2827
2828                 Ok(())
2829         }
2830 }
2831
2832 impl_writeable_msg!(GossipTimestampFilter, {
2833         chain_hash,
2834         first_timestamp,
2835         timestamp_range,
2836 }, {});
2837
2838 #[cfg(test)]
2839 mod tests {
2840         use std::convert::TryFrom;
2841         use bitcoin::{Transaction, TxIn, ScriptBuf, Sequence, Witness, TxOut};
2842         use hex::DisplayHex;
2843         use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
2844         use crate::ln::ChannelId;
2845         use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
2846         use crate::ln::msgs::{self, FinalOnionHopData, OnionErrorPacket};
2847         use crate::ln::msgs::SocketAddress;
2848         use crate::routing::gossip::{NodeAlias, NodeId};
2849         use crate::util::ser::{Writeable, Readable, ReadableArgs, Hostname, TransactionU16LenLimited};
2850         use crate::util::test_utils;
2851
2852         use bitcoin::hashes::hex::FromHex;
2853         use bitcoin::address::Address;
2854         use bitcoin::network::constants::Network;
2855         use bitcoin::blockdata::constants::ChainHash;
2856         use bitcoin::blockdata::script::Builder;
2857         use bitcoin::blockdata::opcodes;
2858         use bitcoin::hash_types::Txid;
2859         use bitcoin::locktime::absolute::LockTime;
2860
2861         use bitcoin::secp256k1::{PublicKey,SecretKey};
2862         use bitcoin::secp256k1::{Secp256k1, Message};
2863
2864         use crate::io::{self, Cursor};
2865         use crate::prelude::*;
2866         use core::str::FromStr;
2867         use crate::chain::transaction::OutPoint;
2868
2869         #[cfg(feature = "std")]
2870         use std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6, ToSocketAddrs};
2871         #[cfg(feature = "std")]
2872         use crate::ln::msgs::SocketAddressParseError;
2873
2874         #[test]
2875         fn encoding_channel_reestablish() {
2876                 let public_key = {
2877                         let secp_ctx = Secp256k1::new();
2878                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2879                 };
2880
2881                 let cr = msgs::ChannelReestablish {
2882                         channel_id: ChannelId::from_bytes([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]),
2883                         next_local_commitment_number: 3,
2884                         next_remote_commitment_number: 4,
2885                         your_last_per_commitment_secret: [9;32],
2886                         my_current_per_commitment_point: public_key,
2887                         next_funding_txid: None,
2888                 };
2889
2890                 let encoded_value = cr.encode();
2891                 assert_eq!(
2892                         encoded_value,
2893                         vec![
2894                                 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, // channel_id
2895                                 0, 0, 0, 0, 0, 0, 0, 3, // next_local_commitment_number
2896                                 0, 0, 0, 0, 0, 0, 0, 4, // next_remote_commitment_number
2897                                 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, // your_last_per_commitment_secret
2898                                 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, // my_current_per_commitment_point
2899                         ]
2900                 );
2901         }
2902
2903         #[test]
2904         fn encoding_channel_reestablish_with_next_funding_txid() {
2905                 let public_key = {
2906                         let secp_ctx = Secp256k1::new();
2907                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2908                 };
2909
2910                 let cr = msgs::ChannelReestablish {
2911                         channel_id: ChannelId::from_bytes([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]),
2912                         next_local_commitment_number: 3,
2913                         next_remote_commitment_number: 4,
2914                         your_last_per_commitment_secret: [9;32],
2915                         my_current_per_commitment_point: public_key,
2916                         next_funding_txid: Some(Txid::from_raw_hash(bitcoin::hashes::Hash::from_slice(&[
2917                                 48, 167, 250, 69, 152, 48, 103, 172, 164, 99, 59, 19, 23, 11, 92, 84, 15, 80, 4, 12, 98, 82, 75, 31, 201, 11, 91, 23, 98, 23, 53, 124,
2918                         ]).unwrap())),
2919                 };
2920
2921                 let encoded_value = cr.encode();
2922                 assert_eq!(
2923                         encoded_value,
2924                         vec![
2925                                 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, // channel_id
2926                                 0, 0, 0, 0, 0, 0, 0, 3, // next_local_commitment_number
2927                                 0, 0, 0, 0, 0, 0, 0, 4, // next_remote_commitment_number
2928                                 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, // your_last_per_commitment_secret
2929                                 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, // my_current_per_commitment_point
2930                                 0, // Type (next_funding_txid)
2931                                 32, // Length
2932                                 48, 167, 250, 69, 152, 48, 103, 172, 164, 99, 59, 19, 23, 11, 92, 84, 15, 80, 4, 12, 98, 82, 75, 31, 201, 11, 91, 23, 98, 23, 53, 124, // Value
2933                         ]
2934                 );
2935         }
2936
2937         macro_rules! get_keys_from {
2938                 ($slice: expr, $secp_ctx: expr) => {
2939                         {
2940                                 let privkey = SecretKey::from_slice(&<Vec<u8>>::from_hex($slice).unwrap()[..]).unwrap();
2941                                 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2942                                 (privkey, pubkey)
2943                         }
2944                 }
2945         }
2946
2947         macro_rules! get_sig_on {
2948                 ($privkey: expr, $ctx: expr, $string: expr) => {
2949                         {
2950                                 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2951                                 $ctx.sign_ecdsa(&sighash, &$privkey)
2952                         }
2953                 }
2954         }
2955
2956         #[test]
2957         fn encoding_announcement_signatures() {
2958                 let secp_ctx = Secp256k1::new();
2959                 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2960                 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2961                 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2962                 let announcement_signatures = msgs::AnnouncementSignatures {
2963                         channel_id: ChannelId::from_bytes([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]),
2964                         short_channel_id: 2316138423780173,
2965                         node_signature: sig_1,
2966                         bitcoin_signature: sig_2,
2967                 };
2968
2969                 let encoded_value = announcement_signatures.encode();
2970                 assert_eq!(encoded_value, <Vec<u8>>::from_hex("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2971         }
2972
2973         fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2974                 let secp_ctx = Secp256k1::new();
2975                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2976                 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2977                 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2978                 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2979                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2980                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2981                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2982                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2983                 let mut features = ChannelFeatures::empty();
2984                 if unknown_features_bits {
2985                         features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2986                 }
2987                 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2988                         features,
2989                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
2990                         short_channel_id: 2316138423780173,
2991                         node_id_1: NodeId::from_pubkey(&pubkey_1),
2992                         node_id_2: NodeId::from_pubkey(&pubkey_2),
2993                         bitcoin_key_1: NodeId::from_pubkey(&pubkey_3),
2994                         bitcoin_key_2: NodeId::from_pubkey(&pubkey_4),
2995                         excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
2996                 };
2997                 let channel_announcement = msgs::ChannelAnnouncement {
2998                         node_signature_1: sig_1,
2999                         node_signature_2: sig_2,
3000                         bitcoin_signature_1: sig_3,
3001                         bitcoin_signature_2: sig_4,
3002                         contents: unsigned_channel_announcement,
3003                 };
3004                 let encoded_value = channel_announcement.encode();
3005                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
3006                 if unknown_features_bits {
3007                         target_value.append(&mut <Vec<u8>>::from_hex("0002ffff").unwrap());
3008                 } else {
3009                         target_value.append(&mut <Vec<u8>>::from_hex("0000").unwrap());
3010                 }
3011                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3012                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
3013                 if excess_data {
3014                         target_value.append(&mut <Vec<u8>>::from_hex("0a00001400001e000028").unwrap());
3015                 }
3016                 assert_eq!(encoded_value, target_value);
3017         }
3018
3019         #[test]
3020         fn encoding_channel_announcement() {
3021                 do_encoding_channel_announcement(true, false);
3022                 do_encoding_channel_announcement(false, true);
3023                 do_encoding_channel_announcement(false, false);
3024                 do_encoding_channel_announcement(true, true);
3025         }
3026
3027         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) {
3028                 let secp_ctx = Secp256k1::new();
3029                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3030                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3031                 let features = if unknown_features_bits {
3032                         NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
3033                 } else {
3034                         // Set to some features we may support
3035                         NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
3036                 };
3037                 let mut addresses = Vec::new();
3038                 if ipv4 {
3039                         addresses.push(SocketAddress::TcpIpV4 {
3040                                 addr: [255, 254, 253, 252],
3041                                 port: 9735
3042                         });
3043                 }
3044                 if ipv6 {
3045                         addresses.push(SocketAddress::TcpIpV6 {
3046                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
3047                                 port: 9735
3048                         });
3049                 }
3050                 if onionv2 {
3051                         addresses.push(msgs::SocketAddress::OnionV2(
3052                                 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
3053                         ));
3054                 }
3055                 if onionv3 {
3056                         addresses.push(msgs::SocketAddress::OnionV3 {
3057                                 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],
3058                                 checksum: 32,
3059                                 version: 16,
3060                                 port: 9735
3061                         });
3062                 }
3063                 if hostname {
3064                         addresses.push(SocketAddress::Hostname {
3065                                 hostname: Hostname::try_from(String::from("host")).unwrap(),
3066                                 port: 9735,
3067                         });
3068                 }
3069                 let mut addr_len = 0;
3070                 for addr in &addresses {
3071                         addr_len += addr.len() + 1;
3072                 }
3073                 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
3074                         features,
3075                         timestamp: 20190119,
3076                         node_id: NodeId::from_pubkey(&pubkey_1),
3077                         rgb: [32; 3],
3078                         alias: NodeAlias([16;32]),
3079                         addresses,
3080                         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() },
3081                         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() },
3082                 };
3083                 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
3084                 let node_announcement = msgs::NodeAnnouncement {
3085                         signature: sig_1,
3086                         contents: unsigned_node_announcement,
3087                 };
3088                 let encoded_value = node_announcement.encode();
3089                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3090                 if unknown_features_bits {
3091                         target_value.append(&mut <Vec<u8>>::from_hex("0002ffff").unwrap());
3092                 } else {
3093                         target_value.append(&mut <Vec<u8>>::from_hex("000122").unwrap());
3094                 }
3095                 target_value.append(&mut <Vec<u8>>::from_hex("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
3096                 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
3097                 if ipv4 {
3098                         target_value.append(&mut <Vec<u8>>::from_hex("01fffefdfc2607").unwrap());
3099                 }
3100                 if ipv6 {
3101                         target_value.append(&mut <Vec<u8>>::from_hex("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
3102                 }
3103                 if onionv2 {
3104                         target_value.append(&mut <Vec<u8>>::from_hex("03fffefdfcfbfaf9f8f7f62607").unwrap());
3105                 }
3106                 if onionv3 {
3107                         target_value.append(&mut <Vec<u8>>::from_hex("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
3108                 }
3109                 if hostname {
3110                         target_value.append(&mut <Vec<u8>>::from_hex("0504686f73742607").unwrap());
3111                 }
3112                 if excess_address_data {
3113                         target_value.append(&mut <Vec<u8>>::from_hex("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
3114                 }
3115                 if excess_data {
3116                         target_value.append(&mut <Vec<u8>>::from_hex("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
3117                 }
3118                 assert_eq!(encoded_value, target_value);
3119         }
3120
3121         #[test]
3122         fn encoding_node_announcement() {
3123                 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
3124                 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
3125                 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
3126                 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
3127                 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
3128                 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
3129                 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
3130                 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
3131                 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
3132                 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
3133         }
3134
3135         fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
3136                 let secp_ctx = Secp256k1::new();
3137                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3138                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3139                 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
3140                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3141                         short_channel_id: 2316138423780173,
3142                         timestamp: 20190119,
3143                         flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
3144                         cltv_expiry_delta: 144,
3145                         htlc_minimum_msat: 1000000,
3146                         htlc_maximum_msat: 131355275467161,
3147                         fee_base_msat: 10000,
3148                         fee_proportional_millionths: 20,
3149                         excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
3150                 };
3151                 let channel_update = msgs::ChannelUpdate {
3152                         signature: sig_1,
3153                         contents: unsigned_channel_update
3154                 };
3155                 let encoded_value = channel_update.encode();
3156                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3157                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3158                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d013413a7").unwrap());
3159                 target_value.append(&mut <Vec<u8>>::from_hex("01").unwrap());
3160                 target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3161                 if direction {
3162                         let flag = target_value.last_mut().unwrap();
3163                         *flag = 1;
3164                 }
3165                 if disable {
3166                         let flag = target_value.last_mut().unwrap();
3167                         *flag = *flag | 1 << 1;
3168                 }
3169                 target_value.append(&mut <Vec<u8>>::from_hex("009000000000000f42400000271000000014").unwrap());
3170                 target_value.append(&mut <Vec<u8>>::from_hex("0000777788889999").unwrap());
3171                 if excess_data {
3172                         target_value.append(&mut <Vec<u8>>::from_hex("000000003b9aca00").unwrap());
3173                 }
3174                 assert_eq!(encoded_value, target_value);
3175         }
3176
3177         #[test]
3178         fn encoding_channel_update() {
3179                 do_encoding_channel_update(false, false, false);
3180                 do_encoding_channel_update(false, false, true);
3181                 do_encoding_channel_update(true, false, false);
3182                 do_encoding_channel_update(true, false, true);
3183                 do_encoding_channel_update(false, true, false);
3184                 do_encoding_channel_update(false, true, true);
3185                 do_encoding_channel_update(true, true, false);
3186                 do_encoding_channel_update(true, true, true);
3187         }
3188
3189         fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
3190                 let secp_ctx = Secp256k1::new();
3191                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3192                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3193                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3194                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3195                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3196                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3197                 let open_channel = msgs::OpenChannel {
3198                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3199                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3200                         funding_satoshis: 1311768467284833366,
3201                         push_msat: 2536655962884945560,
3202                         dust_limit_satoshis: 3608586615801332854,
3203                         max_htlc_value_in_flight_msat: 8517154655701053848,
3204                         channel_reserve_satoshis: 8665828695742877976,
3205                         htlc_minimum_msat: 2316138423780173,
3206                         feerate_per_kw: 821716,
3207                         to_self_delay: 49340,
3208                         max_accepted_htlcs: 49340,
3209                         funding_pubkey: pubkey_1,
3210                         revocation_basepoint: pubkey_2,
3211                         payment_point: pubkey_3,
3212                         delayed_payment_basepoint: pubkey_4,
3213                         htlc_basepoint: pubkey_5,
3214                         first_per_commitment_point: pubkey_6,
3215                         channel_flags: if random_bit { 1 << 5 } else { 0 },
3216                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3217                         channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
3218                 };
3219                 let encoded_value = open_channel.encode();
3220                 let mut target_value = Vec::new();
3221                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3222                 target_value.append(&mut <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
3223                 if random_bit {
3224                         target_value.append(&mut <Vec<u8>>::from_hex("20").unwrap());
3225                 } else {
3226                         target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3227                 }
3228                 if shutdown {
3229                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3230                 }
3231                 if incl_chan_type {
3232                         target_value.append(&mut <Vec<u8>>::from_hex("0100").unwrap());
3233                 }
3234                 assert_eq!(encoded_value, target_value);
3235         }
3236
3237         #[test]
3238         fn encoding_open_channel() {
3239                 do_encoding_open_channel(false, false, false);
3240                 do_encoding_open_channel(false, false, true);
3241                 do_encoding_open_channel(false, true, false);
3242                 do_encoding_open_channel(false, true, true);
3243                 do_encoding_open_channel(true, false, false);
3244                 do_encoding_open_channel(true, false, true);
3245                 do_encoding_open_channel(true, true, false);
3246                 do_encoding_open_channel(true, true, true);
3247         }
3248
3249         fn do_encoding_open_channelv2(random_bit: bool, shutdown: bool, incl_chan_type: bool, require_confirmed_inputs: bool) {
3250                 let secp_ctx = Secp256k1::new();
3251                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3252                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3253                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3254                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3255                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3256                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3257                 let (_, pubkey_7) = get_keys_from!("0707070707070707070707070707070707070707070707070707070707070707", secp_ctx);
3258                 let open_channelv2 = msgs::OpenChannelV2 {
3259                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3260                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3261                         funding_feerate_sat_per_1000_weight: 821716,
3262                         commitment_feerate_sat_per_1000_weight: 821716,
3263                         funding_satoshis: 1311768467284833366,
3264                         dust_limit_satoshis: 3608586615801332854,
3265                         max_htlc_value_in_flight_msat: 8517154655701053848,
3266                         htlc_minimum_msat: 2316138423780173,
3267                         to_self_delay: 49340,
3268                         max_accepted_htlcs: 49340,
3269                         locktime: 305419896,
3270                         funding_pubkey: pubkey_1,
3271                         revocation_basepoint: pubkey_2,
3272                         payment_basepoint: pubkey_3,
3273                         delayed_payment_basepoint: pubkey_4,
3274                         htlc_basepoint: pubkey_5,
3275                         first_per_commitment_point: pubkey_6,
3276                         second_per_commitment_point: pubkey_7,
3277                         channel_flags: if random_bit { 1 << 5 } else { 0 },
3278                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3279                         channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
3280                         require_confirmed_inputs: if require_confirmed_inputs { Some(()) } else { None },
3281                 };
3282                 let encoded_value = open_channelv2.encode();
3283                 let mut target_value = Vec::new();
3284                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3285                 target_value.append(&mut <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3286                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap());
3287                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap());
3288                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap());
3289                 target_value.append(&mut <Vec<u8>>::from_hex("3214466870114476").unwrap());
3290                 target_value.append(&mut <Vec<u8>>::from_hex("7633030896203198").unwrap());
3291                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d").unwrap());
3292                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap());
3293                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap());
3294                 target_value.append(&mut <Vec<u8>>::from_hex("12345678").unwrap());
3295                 target_value.append(&mut <Vec<u8>>::from_hex("031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap());
3296                 target_value.append(&mut <Vec<u8>>::from_hex("024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d0766").unwrap());
3297                 target_value.append(&mut <Vec<u8>>::from_hex("02531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe337").unwrap());
3298                 target_value.append(&mut <Vec<u8>>::from_hex("03462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
3299                 target_value.append(&mut <Vec<u8>>::from_hex("0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f7").unwrap());
3300                 target_value.append(&mut <Vec<u8>>::from_hex("03f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
3301                 target_value.append(&mut <Vec<u8>>::from_hex("02989c0b76cb563971fdc9bef31ec06c3560f3249d6ee9e5d83c57625596e05f6f").unwrap());
3302
3303                 if random_bit {
3304                         target_value.append(&mut <Vec<u8>>::from_hex("20").unwrap());
3305                 } else {
3306                         target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3307                 }
3308                 if shutdown {
3309                         target_value.append(&mut <Vec<u8>>::from_hex("001b").unwrap()); // Type 0 + Length 27
3310                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3311                 }
3312                 if incl_chan_type {
3313                         target_value.append(&mut <Vec<u8>>::from_hex("0100").unwrap());
3314                 }
3315                 if require_confirmed_inputs {
3316                         target_value.append(&mut <Vec<u8>>::from_hex("0200").unwrap());
3317                 }
3318                 assert_eq!(encoded_value, target_value);
3319         }
3320
3321         #[test]
3322         fn encoding_open_channelv2() {
3323                 do_encoding_open_channelv2(false, false, false, false);
3324                 do_encoding_open_channelv2(false, false, false, true);
3325                 do_encoding_open_channelv2(false, false, true, false);
3326                 do_encoding_open_channelv2(false, false, true, true);
3327                 do_encoding_open_channelv2(false, true, false, false);
3328                 do_encoding_open_channelv2(false, true, false, true);
3329                 do_encoding_open_channelv2(false, true, true, false);
3330                 do_encoding_open_channelv2(false, true, true, true);
3331                 do_encoding_open_channelv2(true, false, false, false);
3332                 do_encoding_open_channelv2(true, false, false, true);
3333                 do_encoding_open_channelv2(true, false, true, false);
3334                 do_encoding_open_channelv2(true, false, true, true);
3335                 do_encoding_open_channelv2(true, true, false, false);
3336                 do_encoding_open_channelv2(true, true, false, true);
3337                 do_encoding_open_channelv2(true, true, true, false);
3338                 do_encoding_open_channelv2(true, true, true, true);
3339         }
3340
3341         fn do_encoding_accept_channel(shutdown: bool) {
3342                 let secp_ctx = Secp256k1::new();
3343                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3344                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3345                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3346                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3347                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3348                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3349                 let accept_channel = msgs::AcceptChannel {
3350                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3351                         dust_limit_satoshis: 1311768467284833366,
3352                         max_htlc_value_in_flight_msat: 2536655962884945560,
3353                         channel_reserve_satoshis: 3608586615801332854,
3354                         htlc_minimum_msat: 2316138423780173,
3355                         minimum_depth: 821716,
3356                         to_self_delay: 49340,
3357                         max_accepted_htlcs: 49340,
3358                         funding_pubkey: pubkey_1,
3359                         revocation_basepoint: pubkey_2,
3360                         payment_point: pubkey_3,
3361                         delayed_payment_basepoint: pubkey_4,
3362                         htlc_basepoint: pubkey_5,
3363                         first_per_commitment_point: pubkey_6,
3364                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3365                         channel_type: None,
3366                         #[cfg(taproot)]
3367                         next_local_nonce: None,
3368                 };
3369                 let encoded_value = accept_channel.encode();
3370                 let mut target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
3371                 if shutdown {
3372                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3373                 }
3374                 assert_eq!(encoded_value, target_value);
3375         }
3376
3377         #[test]
3378         fn encoding_accept_channel() {
3379                 do_encoding_accept_channel(false);
3380                 do_encoding_accept_channel(true);
3381         }
3382
3383         fn do_encoding_accept_channelv2(shutdown: bool) {
3384                 let secp_ctx = Secp256k1::new();
3385                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3386                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3387                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3388                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3389                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3390                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3391                 let (_, pubkey_7) = get_keys_from!("0707070707070707070707070707070707070707070707070707070707070707", secp_ctx);
3392                 let accept_channelv2 = msgs::AcceptChannelV2 {
3393                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3394                         funding_satoshis: 1311768467284833366,
3395                         dust_limit_satoshis: 1311768467284833366,
3396                         max_htlc_value_in_flight_msat: 2536655962884945560,
3397                         htlc_minimum_msat: 2316138423780173,
3398                         minimum_depth: 821716,
3399                         to_self_delay: 49340,
3400                         max_accepted_htlcs: 49340,
3401                         funding_pubkey: pubkey_1,
3402                         revocation_basepoint: pubkey_2,
3403                         payment_basepoint: pubkey_3,
3404                         delayed_payment_basepoint: pubkey_4,
3405                         htlc_basepoint: pubkey_5,
3406                         first_per_commitment_point: pubkey_6,
3407                         second_per_commitment_point: pubkey_7,
3408                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3409                         channel_type: None,
3410                         require_confirmed_inputs: None,
3411                 };
3412                 let encoded_value = accept_channelv2.encode();
3413                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // temporary_channel_id
3414                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap()); // funding_satoshis
3415                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap()); // dust_limit_satoshis
3416                 target_value.append(&mut <Vec<u8>>::from_hex("2334032891223698").unwrap()); // max_htlc_value_in_flight_msat
3417                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d").unwrap()); // htlc_minimum_msat
3418                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap()); //  minimum_depth
3419                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap()); // to_self_delay
3420                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap()); // max_accepted_htlcs
3421                 target_value.append(&mut <Vec<u8>>::from_hex("031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap()); // funding_pubkey
3422                 target_value.append(&mut <Vec<u8>>::from_hex("024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d0766").unwrap()); // revocation_basepoint
3423                 target_value.append(&mut <Vec<u8>>::from_hex("02531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe337").unwrap()); // payment_basepoint
3424                 target_value.append(&mut <Vec<u8>>::from_hex("03462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap()); // delayed_payment_basepoint
3425                 target_value.append(&mut <Vec<u8>>::from_hex("0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f7").unwrap()); // htlc_basepoint
3426                 target_value.append(&mut <Vec<u8>>::from_hex("03f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap()); // first_per_commitment_point
3427                 target_value.append(&mut <Vec<u8>>::from_hex("02989c0b76cb563971fdc9bef31ec06c3560f3249d6ee9e5d83c57625596e05f6f").unwrap()); // second_per_commitment_point
3428                 if shutdown {
3429                         target_value.append(&mut <Vec<u8>>::from_hex("001b").unwrap()); // Type 0 + Length 27
3430                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3431                 }
3432                 assert_eq!(encoded_value, target_value);
3433         }
3434
3435         #[test]
3436         fn encoding_accept_channelv2() {
3437                 do_encoding_accept_channelv2(false);
3438                 do_encoding_accept_channelv2(true);
3439         }
3440
3441         #[test]
3442         fn encoding_funding_created() {
3443                 let secp_ctx = Secp256k1::new();
3444                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3445                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3446                 let funding_created = msgs::FundingCreated {
3447                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3448                         funding_txid: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
3449                         funding_output_index: 255,
3450                         signature: sig_1,
3451                         #[cfg(taproot)]
3452                         partial_signature_with_nonce: None,
3453                         #[cfg(taproot)]
3454                         next_local_nonce: None,
3455                 };
3456                 let encoded_value = funding_created.encode();
3457                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3458                 assert_eq!(encoded_value, target_value);
3459         }
3460
3461         #[test]
3462         fn encoding_funding_signed() {
3463                 let secp_ctx = Secp256k1::new();
3464                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3465                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3466                 let funding_signed = msgs::FundingSigned {
3467                         channel_id: ChannelId::from_bytes([2; 32]),
3468                         signature: sig_1,
3469                         #[cfg(taproot)]
3470                         partial_signature_with_nonce: None,
3471                 };
3472                 let encoded_value = funding_signed.encode();
3473                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3474                 assert_eq!(encoded_value, target_value);
3475         }
3476
3477         #[test]
3478         fn encoding_channel_ready() {
3479                 let secp_ctx = Secp256k1::new();
3480                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3481                 let channel_ready = msgs::ChannelReady {
3482                         channel_id: ChannelId::from_bytes([2; 32]),
3483                         next_per_commitment_point: pubkey_1,
3484                         short_channel_id_alias: None,
3485                 };
3486                 let encoded_value = channel_ready.encode();
3487                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
3488                 assert_eq!(encoded_value, target_value);
3489         }
3490
3491         #[test]
3492         fn encoding_splice() {
3493                 let secp_ctx = Secp256k1::new();
3494                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3495                 let splice = msgs::Splice {
3496                         chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3497                         channel_id: ChannelId::from_bytes([2; 32]),
3498                         relative_satoshis: 123456,
3499                         funding_feerate_perkw: 2000,
3500                         locktime: 0,
3501                         funding_pubkey: pubkey_1,
3502                 };
3503                 let encoded_value = splice.encode();
3504                 assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240000007d000000000031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3505         }
3506
3507         #[test]
3508         fn encoding_stfu() {
3509                 let stfu = msgs::Stfu {
3510                         channel_id: ChannelId::from_bytes([2; 32]),
3511                         initiator: 1,
3512                 };
3513                 let encoded_value = stfu.encode();
3514                 assert_eq!(encoded_value.as_hex().to_string(), "020202020202020202020202020202020202020202020202020202020202020201");
3515         }
3516
3517         #[test]
3518         fn encoding_splice_ack() {
3519                 let secp_ctx = Secp256k1::new();
3520                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3521                 let splice = msgs::SpliceAck {
3522                         chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3523                         channel_id: ChannelId::from_bytes([2; 32]),
3524                         relative_satoshis: 123456,
3525                         funding_pubkey: pubkey_1,
3526                 };
3527                 let encoded_value = splice.encode();
3528                 assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3529         }
3530
3531         #[test]
3532         fn encoding_splice_locked() {
3533                 let splice = msgs::SpliceLocked {
3534                         channel_id: ChannelId::from_bytes([2; 32]),
3535                 };
3536                 let encoded_value = splice.encode();
3537                 assert_eq!(encoded_value.as_hex().to_string(), "0202020202020202020202020202020202020202020202020202020202020202");
3538         }
3539
3540         #[test]
3541         fn encoding_tx_add_input() {
3542                 let tx_add_input = msgs::TxAddInput {
3543                         channel_id: ChannelId::from_bytes([2; 32]),
3544                         serial_id: 4886718345,
3545                         prevtx: TransactionU16LenLimited::new(Transaction {
3546                                 version: 2,
3547                                 lock_time: LockTime::ZERO,
3548                                 input: vec![TxIn {
3549                                         previous_output: OutPoint { txid: Txid::from_str("305bab643ee297b8b6b76b320792c8223d55082122cb606bf89382146ced9c77").unwrap(), index: 2 }.into_bitcoin_outpoint(),
3550                                         script_sig: ScriptBuf::new(),
3551                                         sequence: Sequence(0xfffffffd),
3552                                         witness: Witness::from_slice(&vec![
3553                                                 <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap(),
3554                                                 <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap()]),
3555                                 }],
3556                                 output: vec![
3557                                         TxOut {
3558                                                 value: 12704566,
3559                                                 script_pubkey: Address::from_str("bc1qzlffunw52jav8vwdu5x3jfk6sr8u22rmq3xzw2").unwrap().payload.script_pubkey(),
3560                                         },
3561                                         TxOut {
3562                                                 value: 245148,
3563                                                 script_pubkey: Address::from_str("bc1qxmk834g5marzm227dgqvynd23y2nvt2ztwcw2z").unwrap().payload.script_pubkey(),
3564                                         },
3565                                 ],
3566                         }).unwrap(),
3567                         prevtx_out: 305419896,
3568                         sequence: 305419896,
3569                 };
3570                 let encoded_value = tx_add_input.encode();
3571                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000000012345678900de02000000000101779ced6c148293f86b60cb222108553d22c89207326bb7b6b897e23e64ab5b300200000000fdffffff0236dbc1000000000016001417d29e4dd454bac3b1cde50d1926da80cfc5287b9cbd03000000000016001436ec78d514df462da95e6a00c24daa8915362d420247304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701210301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944000000001234567812345678").unwrap();
3572                 assert_eq!(encoded_value, target_value);
3573         }
3574
3575         #[test]
3576         fn encoding_tx_add_output() {
3577                 let tx_add_output = msgs::TxAddOutput {
3578                         channel_id: ChannelId::from_bytes([2; 32]),
3579                         serial_id: 4886718345,
3580                         sats: 4886718345,
3581                         script: Address::from_str("bc1qxmk834g5marzm227dgqvynd23y2nvt2ztwcw2z").unwrap().payload.script_pubkey(),
3582                 };
3583                 let encoded_value = tx_add_output.encode();
3584                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000000012345678900000001234567890016001436ec78d514df462da95e6a00c24daa8915362d42").unwrap();
3585                 assert_eq!(encoded_value, target_value);
3586         }
3587
3588         #[test]
3589         fn encoding_tx_remove_input() {
3590                 let tx_remove_input = msgs::TxRemoveInput {
3591                         channel_id: ChannelId::from_bytes([2; 32]),
3592                         serial_id: 4886718345,
3593                 };
3594                 let encoded_value = tx_remove_input.encode();
3595                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020000000123456789").unwrap();
3596                 assert_eq!(encoded_value, target_value);
3597         }
3598
3599         #[test]
3600         fn encoding_tx_remove_output() {
3601                 let tx_remove_output = msgs::TxRemoveOutput {
3602                         channel_id: ChannelId::from_bytes([2; 32]),
3603                         serial_id: 4886718345,
3604                 };
3605                 let encoded_value = tx_remove_output.encode();
3606                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020000000123456789").unwrap();
3607                 assert_eq!(encoded_value, target_value);
3608         }
3609
3610         #[test]
3611         fn encoding_tx_complete() {
3612                 let tx_complete = msgs::TxComplete {
3613                         channel_id: ChannelId::from_bytes([2; 32]),
3614                 };
3615                 let encoded_value = tx_complete.encode();
3616                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3617                 assert_eq!(encoded_value, target_value);
3618         }
3619
3620         #[test]
3621         fn encoding_tx_signatures() {
3622                 let tx_signatures = msgs::TxSignatures {
3623                         channel_id: ChannelId::from_bytes([2; 32]),
3624                         tx_hash: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
3625                         witnesses: vec![
3626                                 Witness::from_slice(&vec![
3627                                         <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap(),
3628                                         <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap()]),
3629                                 Witness::from_slice(&vec![
3630                                         <Vec<u8>>::from_hex("3045022100ee00dbf4a862463e837d7c08509de814d620e4d9830fa84818713e0fa358f145022021c3c7060c4d53fe84fd165d60208451108a778c13b92ca4c6bad439236126cc01").unwrap(),
3631                                         <Vec<u8>>::from_hex("028fbbf0b16f5ba5bcb5dd37cd4047ce6f726a21c06682f9ec2f52b057de1dbdb5").unwrap()]),
3632                         ],
3633                 };
3634                 let encoded_value = tx_signatures.encode();
3635                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // channel_id
3636                 target_value.append(&mut <Vec<u8>>::from_hex("6e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c2").unwrap()); // tx_hash (sha256) (big endian byte order)
3637                 target_value.append(&mut <Vec<u8>>::from_hex("0002").unwrap()); // num_witnesses (u16)
3638                 // Witness 1
3639                 target_value.append(&mut <Vec<u8>>::from_hex("006b").unwrap()); // len of witness_data
3640                 target_value.append(&mut <Vec<u8>>::from_hex("02").unwrap()); // num_witness_elements (VarInt)
3641                 target_value.append(&mut <Vec<u8>>::from_hex("47").unwrap()); // len of witness element data (VarInt)
3642                 target_value.append(&mut <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap());
3643                 target_value.append(&mut <Vec<u8>>::from_hex("21").unwrap()); // len of witness element data (VarInt)
3644                 target_value.append(&mut <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap());
3645                 // Witness 2
3646                 target_value.append(&mut <Vec<u8>>::from_hex("006c").unwrap()); // len of witness_data
3647                 target_value.append(&mut <Vec<u8>>::from_hex("02").unwrap()); // num_witness_elements (VarInt)
3648                 target_value.append(&mut <Vec<u8>>::from_hex("48").unwrap()); // len of witness element data (VarInt)
3649                 target_value.append(&mut <Vec<u8>>::from_hex("3045022100ee00dbf4a862463e837d7c08509de814d620e4d9830fa84818713e0fa358f145022021c3c7060c4d53fe84fd165d60208451108a778c13b92ca4c6bad439236126cc01").unwrap());
3650                 target_value.append(&mut <Vec<u8>>::from_hex("21").unwrap()); // len of witness element data (VarInt)
3651                 target_value.append(&mut <Vec<u8>>::from_hex("028fbbf0b16f5ba5bcb5dd37cd4047ce6f726a21c06682f9ec2f52b057de1dbdb5").unwrap());
3652                 assert_eq!(encoded_value, target_value);
3653         }
3654
3655         fn do_encoding_tx_init_rbf(funding_value_with_hex_target: Option<(i64, &str)>) {
3656                 let tx_init_rbf = msgs::TxInitRbf {
3657                         channel_id: ChannelId::from_bytes([2; 32]),
3658                         locktime: 305419896,
3659                         feerate_sat_per_1000_weight: 20190119,
3660                         funding_output_contribution: if let Some((value, _)) = funding_value_with_hex_target { Some(value) } else { None },
3661                 };
3662                 let encoded_value = tx_init_rbf.encode();
3663                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // channel_id
3664                 target_value.append(&mut <Vec<u8>>::from_hex("12345678").unwrap()); // locktime
3665                 target_value.append(&mut <Vec<u8>>::from_hex("013413a7").unwrap()); // feerate_sat_per_1000_weight
3666                 if let Some((_, target)) = funding_value_with_hex_target {
3667                         target_value.push(0x00); // Type
3668                         target_value.push(target.len() as u8 / 2); // Length
3669                         target_value.append(&mut <Vec<u8>>::from_hex(target).unwrap()); // Value (i64)
3670                 }
3671                 assert_eq!(encoded_value, target_value);
3672         }
3673
3674         #[test]
3675         fn encoding_tx_init_rbf() {
3676                 do_encoding_tx_init_rbf(Some((1311768467284833366, "1234567890123456")));
3677                 do_encoding_tx_init_rbf(Some((13117684672, "000000030DDFFBC0")));
3678                 do_encoding_tx_init_rbf(None);
3679         }
3680
3681         fn do_encoding_tx_ack_rbf(funding_value_with_hex_target: Option<(i64, &str)>) {
3682                 let tx_ack_rbf = msgs::TxAckRbf {
3683                         channel_id: ChannelId::from_bytes([2; 32]),
3684                         funding_output_contribution: if let Some((value, _)) = funding_value_with_hex_target { Some(value) } else { None },
3685                 };
3686                 let encoded_value = tx_ack_rbf.encode();
3687                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3688                 if let Some((_, target)) = funding_value_with_hex_target {
3689                         target_value.push(0x00); // Type
3690                         target_value.push(target.len() as u8 / 2); // Length
3691                         target_value.append(&mut <Vec<u8>>::from_hex(target).unwrap()); // Value (i64)
3692                 }
3693                 assert_eq!(encoded_value, target_value);
3694         }
3695
3696         #[test]
3697         fn encoding_tx_ack_rbf() {
3698                 do_encoding_tx_ack_rbf(Some((1311768467284833366, "1234567890123456")));
3699                 do_encoding_tx_ack_rbf(Some((13117684672, "000000030DDFFBC0")));
3700                 do_encoding_tx_ack_rbf(None);
3701         }
3702
3703         #[test]
3704         fn encoding_tx_abort() {
3705                 let tx_abort = msgs::TxAbort {
3706                         channel_id: ChannelId::from_bytes([2; 32]),
3707                         data: <Vec<u8>>::from_hex("54686520717569636B2062726F776E20666F78206A756D7073206F76657220746865206C617A7920646F672E").unwrap(),
3708                 };
3709                 let encoded_value = tx_abort.encode();
3710                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202002C54686520717569636B2062726F776E20666F78206A756D7073206F76657220746865206C617A7920646F672E").unwrap();
3711                 assert_eq!(encoded_value, target_value);
3712         }
3713
3714         fn do_encoding_shutdown(script_type: u8) {
3715                 let secp_ctx = Secp256k1::new();
3716                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3717                 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
3718                 let shutdown = msgs::Shutdown {
3719                         channel_id: ChannelId::from_bytes([2; 32]),
3720                         scriptpubkey:
3721                                 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
3722                                 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
3723                                 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
3724                                 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
3725                 };
3726                 let encoded_value = shutdown.encode();
3727                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3728                 if script_type == 1 {
3729                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3730                 } else if script_type == 2 {
3731                         target_value.append(&mut <Vec<u8>>::from_hex("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
3732                 } else if script_type == 3 {
3733                         target_value.append(&mut <Vec<u8>>::from_hex("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
3734                 } else if script_type == 4 {
3735                         target_value.append(&mut <Vec<u8>>::from_hex("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
3736                 }
3737                 assert_eq!(encoded_value, target_value);
3738         }
3739
3740         #[test]
3741         fn encoding_shutdown() {
3742                 do_encoding_shutdown(1);
3743                 do_encoding_shutdown(2);
3744                 do_encoding_shutdown(3);
3745                 do_encoding_shutdown(4);
3746         }
3747
3748         #[test]
3749         fn encoding_closing_signed() {
3750                 let secp_ctx = Secp256k1::new();
3751                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3752                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3753                 let closing_signed = msgs::ClosingSigned {
3754                         channel_id: ChannelId::from_bytes([2; 32]),
3755                         fee_satoshis: 2316138423780173,
3756                         signature: sig_1,
3757                         fee_range: None,
3758                 };
3759                 let encoded_value = closing_signed.encode();
3760                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3761                 assert_eq!(encoded_value, target_value);
3762                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
3763
3764                 let closing_signed_with_range = msgs::ClosingSigned {
3765                         channel_id: ChannelId::from_bytes([2; 32]),
3766                         fee_satoshis: 2316138423780173,
3767                         signature: sig_1,
3768                         fee_range: Some(msgs::ClosingSignedFeeRange {
3769                                 min_fee_satoshis: 0xdeadbeef,
3770                                 max_fee_satoshis: 0x1badcafe01234567,
3771                         }),
3772                 };
3773                 let encoded_value_with_range = closing_signed_with_range.encode();
3774                 let target_value_with_range = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
3775                 assert_eq!(encoded_value_with_range, target_value_with_range);
3776                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
3777                         closing_signed_with_range);
3778         }
3779
3780         #[test]
3781         fn encoding_update_add_htlc() {
3782                 let secp_ctx = Secp256k1::new();
3783                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3784                 let onion_routing_packet = msgs::OnionPacket {
3785                         version: 255,
3786                         public_key: Ok(pubkey_1),
3787                         hop_data: [1; 20*65],
3788                         hmac: [2; 32]
3789                 };
3790                 let update_add_htlc = msgs::UpdateAddHTLC {
3791                         channel_id: ChannelId::from_bytes([2; 32]),
3792                         htlc_id: 2316138423780173,
3793                         amount_msat: 3608586615801332854,
3794                         payment_hash: PaymentHash([1; 32]),
3795                         cltv_expiry: 821716,
3796                         onion_routing_packet,
3797                         skimmed_fee_msat: None,
3798                         blinding_point: None,
3799                 };
3800                 let encoded_value = update_add_htlc.encode();
3801                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
3802                 assert_eq!(encoded_value, target_value);
3803         }
3804
3805         #[test]
3806         fn encoding_update_fulfill_htlc() {
3807                 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
3808                         channel_id: ChannelId::from_bytes([2; 32]),
3809                         htlc_id: 2316138423780173,
3810                         payment_preimage: PaymentPreimage([1; 32]),
3811                 };
3812                 let encoded_value = update_fulfill_htlc.encode();
3813                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
3814                 assert_eq!(encoded_value, target_value);
3815         }
3816
3817         #[test]
3818         fn encoding_update_fail_htlc() {
3819                 let reason = OnionErrorPacket {
3820                         data: [1; 32].to_vec(),
3821                 };
3822                 let update_fail_htlc = msgs::UpdateFailHTLC {
3823                         channel_id: ChannelId::from_bytes([2; 32]),
3824                         htlc_id: 2316138423780173,
3825                         reason
3826                 };
3827                 let encoded_value = update_fail_htlc.encode();
3828                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
3829                 assert_eq!(encoded_value, target_value);
3830         }
3831
3832         #[test]
3833         fn encoding_update_fail_malformed_htlc() {
3834                 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
3835                         channel_id: ChannelId::from_bytes([2; 32]),
3836                         htlc_id: 2316138423780173,
3837                         sha256_of_onion: [1; 32],
3838                         failure_code: 255
3839                 };
3840                 let encoded_value = update_fail_malformed_htlc.encode();
3841                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
3842                 assert_eq!(encoded_value, target_value);
3843         }
3844
3845         fn do_encoding_commitment_signed(htlcs: bool) {
3846                 let secp_ctx = Secp256k1::new();
3847                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3848                 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3849                 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3850                 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3851                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3852                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
3853                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
3854                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
3855                 let commitment_signed = msgs::CommitmentSigned {
3856                         channel_id: ChannelId::from_bytes([2; 32]),
3857                         signature: sig_1,
3858                         htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
3859                         #[cfg(taproot)]
3860                         partial_signature_with_nonce: None,
3861                 };
3862                 let encoded_value = commitment_signed.encode();
3863                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3864                 if htlcs {
3865                         target_value.append(&mut <Vec<u8>>::from_hex("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
3866                 } else {
3867                         target_value.append(&mut <Vec<u8>>::from_hex("0000").unwrap());
3868                 }
3869                 assert_eq!(encoded_value, target_value);
3870         }
3871
3872         #[test]
3873         fn encoding_commitment_signed() {
3874                 do_encoding_commitment_signed(true);
3875                 do_encoding_commitment_signed(false);
3876         }
3877
3878         #[test]
3879         fn encoding_revoke_and_ack() {
3880                 let secp_ctx = Secp256k1::new();
3881                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3882                 let raa = msgs::RevokeAndACK {
3883                         channel_id: ChannelId::from_bytes([2; 32]),
3884                         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],
3885                         next_per_commitment_point: pubkey_1,
3886                         #[cfg(taproot)]
3887                         next_local_nonce: None,
3888                 };
3889                 let encoded_value = raa.encode();
3890                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
3891                 assert_eq!(encoded_value, target_value);
3892         }
3893
3894         #[test]
3895         fn encoding_update_fee() {
3896                 let update_fee = msgs::UpdateFee {
3897                         channel_id: ChannelId::from_bytes([2; 32]),
3898                         feerate_per_kw: 20190119,
3899                 };
3900                 let encoded_value = update_fee.encode();
3901                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
3902                 assert_eq!(encoded_value, target_value);
3903         }
3904
3905         #[test]
3906         fn encoding_init() {
3907                 let mainnet_hash = ChainHash::using_genesis_block(Network::Bitcoin);
3908                 assert_eq!(msgs::Init {
3909                         features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
3910                         networks: Some(vec![mainnet_hash]),
3911                         remote_network_address: None,
3912                 }.encode(), <Vec<u8>>::from_hex("00023fff0003ffffff01206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3913                 assert_eq!(msgs::Init {
3914                         features: InitFeatures::from_le_bytes(vec![0xFF]),
3915                         networks: None,
3916                         remote_network_address: None,
3917                 }.encode(), <Vec<u8>>::from_hex("0001ff0001ff").unwrap());
3918                 assert_eq!(msgs::Init {
3919                         features: InitFeatures::from_le_bytes(vec![]),
3920                         networks: Some(vec![mainnet_hash]),
3921                         remote_network_address: None,
3922                 }.encode(), <Vec<u8>>::from_hex("0000000001206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3923                 assert_eq!(msgs::Init {
3924                         features: InitFeatures::from_le_bytes(vec![]),
3925                         networks: Some(vec![ChainHash::from(&[1; 32]), ChainHash::from(&[2; 32])]),
3926                         remote_network_address: None,
3927                 }.encode(), <Vec<u8>>::from_hex("00000000014001010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap());
3928                 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
3929                         networks: Some(vec![mainnet_hash]),
3930                         remote_network_address: Some(SocketAddress::TcpIpV4 {
3931                                 addr: [127, 0, 0, 1],
3932                                 port: 1000,
3933                         }),
3934                 };
3935                 let encoded_value = init_msg.encode();
3936                 let target_value = <Vec<u8>>::from_hex("0000000001206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d61900000000000307017f00000103e8").unwrap();
3937                 assert_eq!(encoded_value, target_value);
3938                 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
3939         }
3940
3941         #[test]
3942         fn encoding_error() {
3943                 let error = msgs::ErrorMessage {
3944                         channel_id: ChannelId::from_bytes([2; 32]),
3945                         data: String::from("rust-lightning"),
3946                 };
3947                 let encoded_value = error.encode();
3948                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
3949                 assert_eq!(encoded_value, target_value);
3950         }
3951
3952         #[test]
3953         fn encoding_warning() {
3954                 let error = msgs::WarningMessage {
3955                         channel_id: ChannelId::from_bytes([2; 32]),
3956                         data: String::from("rust-lightning"),
3957                 };
3958                 let encoded_value = error.encode();
3959                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
3960                 assert_eq!(encoded_value, target_value);
3961         }
3962
3963         #[test]
3964         fn encoding_ping() {
3965                 let ping = msgs::Ping {
3966                         ponglen: 64,
3967                         byteslen: 64
3968                 };
3969                 let encoded_value = ping.encode();
3970                 let target_value = <Vec<u8>>::from_hex("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
3971                 assert_eq!(encoded_value, target_value);
3972         }
3973
3974         #[test]
3975         fn encoding_pong() {
3976                 let pong = msgs::Pong {
3977                         byteslen: 64
3978                 };
3979                 let encoded_value = pong.encode();
3980                 let target_value = <Vec<u8>>::from_hex("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
3981                 assert_eq!(encoded_value, target_value);
3982         }
3983
3984         #[test]
3985         fn encoding_nonfinal_onion_hop_data() {
3986                 let outbound_msg = msgs::OutboundOnionPayload::Forward {
3987                         short_channel_id: 0xdeadbeef1bad1dea,
3988                         amt_to_forward: 0x0badf00d01020304,
3989                         outgoing_cltv_value: 0xffffffff,
3990                 };
3991                 let encoded_value = outbound_msg.encode();
3992                 let target_value = <Vec<u8>>::from_hex("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
3993                 assert_eq!(encoded_value, target_value);
3994
3995                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
3996                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
3997                 if let msgs::InboundOnionPayload::Forward {
3998                         short_channel_id, amt_to_forward, outgoing_cltv_value
3999                 } = inbound_msg {
4000                         assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
4001                         assert_eq!(amt_to_forward, 0x0badf00d01020304);
4002                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4003                 } else { panic!(); }
4004         }
4005
4006         #[test]
4007         fn encoding_final_onion_hop_data() {
4008                 let outbound_msg = msgs::OutboundOnionPayload::Receive {
4009                         payment_data: None,
4010                         payment_metadata: None,
4011                         keysend_preimage: None,
4012                         amt_msat: 0x0badf00d01020304,
4013                         outgoing_cltv_value: 0xffffffff,
4014                         custom_tlvs: vec![],
4015                 };
4016                 let encoded_value = outbound_msg.encode();
4017                 let target_value = <Vec<u8>>::from_hex("1002080badf00d010203040404ffffffff").unwrap();
4018                 assert_eq!(encoded_value, target_value);
4019
4020                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4021                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4022                 if let msgs::InboundOnionPayload::Receive {
4023                         payment_data: None, amt_msat, outgoing_cltv_value, ..
4024                 } = inbound_msg {
4025                         assert_eq!(amt_msat, 0x0badf00d01020304);
4026                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4027                 } else { panic!(); }
4028         }
4029
4030         #[test]
4031         fn encoding_final_onion_hop_data_with_secret() {
4032                 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
4033                 let outbound_msg = msgs::OutboundOnionPayload::Receive {
4034                         payment_data: Some(FinalOnionHopData {
4035                                 payment_secret: expected_payment_secret,
4036                                 total_msat: 0x1badca1f
4037                         }),
4038                         payment_metadata: None,
4039                         keysend_preimage: None,
4040                         amt_msat: 0x0badf00d01020304,
4041                         outgoing_cltv_value: 0xffffffff,
4042                         custom_tlvs: vec![],
4043                 };
4044                 let encoded_value = outbound_msg.encode();
4045                 let target_value = <Vec<u8>>::from_hex("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
4046                 assert_eq!(encoded_value, target_value);
4047
4048                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4049                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4050                 if let msgs::InboundOnionPayload::Receive {
4051                         payment_data: Some(FinalOnionHopData {
4052                                 payment_secret,
4053                                 total_msat: 0x1badca1f
4054                         }),
4055                         amt_msat, outgoing_cltv_value,
4056                         payment_metadata: None,
4057                         keysend_preimage: None,
4058                         custom_tlvs,
4059                 } = inbound_msg  {
4060                         assert_eq!(payment_secret, expected_payment_secret);
4061                         assert_eq!(amt_msat, 0x0badf00d01020304);
4062                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4063                         assert_eq!(custom_tlvs, vec![]);
4064                 } else { panic!(); }
4065         }
4066
4067         #[test]
4068         fn encoding_final_onion_hop_data_with_bad_custom_tlvs() {
4069                 // If custom TLVs have type number within the range reserved for protocol, treat them as if
4070                 // they're unknown
4071                 let bad_type_range_tlvs = vec![
4072                         ((1 << 16) - 4, vec![42]),
4073                         ((1 << 16) - 2, vec![42; 32]),
4074                 ];
4075                 let mut msg = msgs::OutboundOnionPayload::Receive {
4076                         payment_data: None,
4077                         payment_metadata: None,
4078                         keysend_preimage: None,
4079                         custom_tlvs: bad_type_range_tlvs,
4080                         amt_msat: 0x0badf00d01020304,
4081                         outgoing_cltv_value: 0xffffffff,
4082                 };
4083                 let encoded_value = msg.encode();
4084                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4085                 assert!(msgs::InboundOnionPayload::read(&mut Cursor::new(&encoded_value[..]), (None, &&node_signer)).is_err());
4086                 let good_type_range_tlvs = vec![
4087                         ((1 << 16) - 3, vec![42]),
4088                         ((1 << 16) - 1, vec![42; 32]),
4089                 ];
4090                 if let msgs::OutboundOnionPayload::Receive { ref mut custom_tlvs, .. } = msg {
4091                         *custom_tlvs = good_type_range_tlvs.clone();
4092                 }
4093                 let encoded_value = msg.encode();
4094                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&encoded_value[..]), (None, &&node_signer)).unwrap();
4095                 match inbound_msg {
4096                         msgs::InboundOnionPayload::Receive { custom_tlvs, .. } => assert!(custom_tlvs.is_empty()),
4097                         _ => panic!(),
4098                 }
4099         }
4100
4101         #[test]
4102         fn encoding_final_onion_hop_data_with_custom_tlvs() {
4103                 let expected_custom_tlvs = vec![
4104                         (5482373483, vec![0x12, 0x34]),
4105                         (5482373487, vec![0x42u8; 8]),
4106                 ];
4107                 let msg = msgs::OutboundOnionPayload::Receive {
4108                         payment_data: None,
4109                         payment_metadata: None,
4110                         keysend_preimage: None,
4111                         custom_tlvs: expected_custom_tlvs.clone(),
4112                         amt_msat: 0x0badf00d01020304,
4113                         outgoing_cltv_value: 0xffffffff,
4114                 };
4115                 let encoded_value = msg.encode();
4116                 let target_value = <Vec<u8>>::from_hex("2e02080badf00d010203040404ffffffffff0000000146c6616b021234ff0000000146c6616f084242424242424242").unwrap();
4117                 assert_eq!(encoded_value, target_value);
4118                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4119                 let inbound_msg: msgs::InboundOnionPayload = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4120                 if let msgs::InboundOnionPayload::Receive {
4121                         payment_data: None,
4122                         payment_metadata: None,
4123                         keysend_preimage: None,
4124                         custom_tlvs,
4125                         amt_msat,
4126                         outgoing_cltv_value,
4127                         ..
4128                 } = inbound_msg {
4129                         assert_eq!(custom_tlvs, expected_custom_tlvs);
4130                         assert_eq!(amt_msat, 0x0badf00d01020304);
4131                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4132                 } else { panic!(); }
4133         }
4134
4135         #[test]
4136         fn query_channel_range_end_blocknum() {
4137                 let tests: Vec<(u32, u32, u32)> = vec![
4138                         (10000, 1500, 11500),
4139                         (0, 0xffffffff, 0xffffffff),
4140                         (1, 0xffffffff, 0xffffffff),
4141                 ];
4142
4143                 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
4144                         let sut = msgs::QueryChannelRange {
4145                                 chain_hash: ChainHash::using_genesis_block(Network::Regtest),
4146                                 first_blocknum,
4147                                 number_of_blocks,
4148                         };
4149                         assert_eq!(sut.end_blocknum(), expected);
4150                 }
4151         }
4152
4153         #[test]
4154         fn encoding_query_channel_range() {
4155                 let mut query_channel_range = msgs::QueryChannelRange {
4156                         chain_hash: ChainHash::using_genesis_block(Network::Regtest),
4157                         first_blocknum: 100000,
4158                         number_of_blocks: 1500,
4159                 };
4160                 let encoded_value = query_channel_range.encode();
4161                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000186a0000005dc").unwrap();
4162                 assert_eq!(encoded_value, target_value);
4163
4164                 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4165                 assert_eq!(query_channel_range.first_blocknum, 100000);
4166                 assert_eq!(query_channel_range.number_of_blocks, 1500);
4167         }
4168
4169         #[test]
4170         fn encoding_reply_channel_range() {
4171                 do_encoding_reply_channel_range(0);
4172                 do_encoding_reply_channel_range(1);
4173         }
4174
4175         fn do_encoding_reply_channel_range(encoding_type: u8) {
4176                 let mut target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000b8a06000005dc01").unwrap();
4177                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4178                 let mut reply_channel_range = msgs::ReplyChannelRange {
4179                         chain_hash: expected_chain_hash,
4180                         first_blocknum: 756230,
4181                         number_of_blocks: 1500,
4182                         sync_complete: true,
4183                         short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
4184                 };
4185
4186                 if encoding_type == 0 {
4187                         target_value.append(&mut <Vec<u8>>::from_hex("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
4188                         let encoded_value = reply_channel_range.encode();
4189                         assert_eq!(encoded_value, target_value);
4190
4191                         reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4192                         assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
4193                         assert_eq!(reply_channel_range.first_blocknum, 756230);
4194                         assert_eq!(reply_channel_range.number_of_blocks, 1500);
4195                         assert_eq!(reply_channel_range.sync_complete, true);
4196                         assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
4197                         assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
4198                         assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
4199                 } else {
4200                         target_value.append(&mut <Vec<u8>>::from_hex("001601789c636000833e08659309a65878be010010a9023a").unwrap());
4201                         let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
4202                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
4203                 }
4204         }
4205
4206         #[test]
4207         fn encoding_query_short_channel_ids() {
4208                 do_encoding_query_short_channel_ids(0);
4209                 do_encoding_query_short_channel_ids(1);
4210         }
4211
4212         fn do_encoding_query_short_channel_ids(encoding_type: u8) {
4213                 let mut target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
4214                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4215                 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
4216                         chain_hash: expected_chain_hash,
4217                         short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
4218                 };
4219
4220                 if encoding_type == 0 {
4221                         target_value.append(&mut <Vec<u8>>::from_hex("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
4222                         let encoded_value = query_short_channel_ids.encode();
4223                         assert_eq!(encoded_value, target_value);
4224
4225                         query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4226                         assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
4227                         assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
4228                         assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
4229                         assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
4230                 } else {
4231                         target_value.append(&mut <Vec<u8>>::from_hex("001601789c636000833e08659309a65878be010010a9023a").unwrap());
4232                         let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
4233                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
4234                 }
4235         }
4236
4237         #[test]
4238         fn encoding_reply_short_channel_ids_end() {
4239                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4240                 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
4241                         chain_hash: expected_chain_hash,
4242                         full_information: true,
4243                 };
4244                 let encoded_value = reply_short_channel_ids_end.encode();
4245                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f01").unwrap();
4246                 assert_eq!(encoded_value, target_value);
4247
4248                 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4249                 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
4250                 assert_eq!(reply_short_channel_ids_end.full_information, true);
4251         }
4252
4253         #[test]
4254         fn encoding_gossip_timestamp_filter(){
4255                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4256                 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
4257                         chain_hash: expected_chain_hash,
4258                         first_timestamp: 1590000000,
4259                         timestamp_range: 0xffff_ffff,
4260                 };
4261                 let encoded_value = gossip_timestamp_filter.encode();
4262                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f5ec57980ffffffff").unwrap();
4263                 assert_eq!(encoded_value, target_value);
4264
4265                 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4266                 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
4267                 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
4268                 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
4269         }
4270
4271         #[test]
4272         fn decode_onion_hop_data_len_as_bigsize() {
4273                 // Tests that we can decode an onion payload that is >253 bytes.
4274                 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
4275                 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
4276                 // (little-endian).
4277
4278                 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
4279                 // payload length to be encoded over multiple bytes rather than a single u8.
4280                 let big_payload = encode_big_payload().unwrap();
4281                 let mut rd = Cursor::new(&big_payload[..]);
4282
4283                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4284                 <msgs::InboundOnionPayload as ReadableArgs<(Option<PublicKey>, &&test_utils::TestKeysInterface)>>
4285                         ::read(&mut rd, (None, &&node_signer)).unwrap();
4286         }
4287         // see above test, needs to be a separate method for use of the serialization macros.
4288         fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
4289                 use crate::util::ser::HighZeroBytesDroppedBigSize;
4290                 let payload = msgs::OutboundOnionPayload::Forward {
4291                         short_channel_id: 0xdeadbeef1bad1dea,
4292                         amt_to_forward: 1000,
4293                         outgoing_cltv_value: 0xffffffff,
4294                 };
4295                 let mut encoded_payload = Vec::new();
4296                 let test_bytes = vec![42u8; 1000];
4297                 if let msgs::OutboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } = payload {
4298                         _encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
4299                                 (1, test_bytes, required_vec),
4300                                 (2, HighZeroBytesDroppedBigSize(amt_to_forward), required),
4301                                 (4, HighZeroBytesDroppedBigSize(outgoing_cltv_value), required),
4302                                 (6, short_channel_id, required)
4303                         });
4304                 }
4305                 Ok(encoded_payload)
4306         }
4307
4308         #[test]
4309         #[cfg(feature = "std")]
4310         fn test_socket_address_from_str() {
4311                 let tcpip_v4 = SocketAddress::TcpIpV4 {
4312                         addr: Ipv4Addr::new(127, 0, 0, 1).octets(),
4313                         port: 1234,
4314                 };
4315                 assert_eq!(tcpip_v4, SocketAddress::from_str("127.0.0.1:1234").unwrap());
4316                 assert_eq!(tcpip_v4, SocketAddress::from_str(&tcpip_v4.to_string()).unwrap());
4317
4318                 let tcpip_v6 = SocketAddress::TcpIpV6 {
4319                         addr: Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).octets(),
4320                         port: 1234,
4321                 };
4322                 assert_eq!(tcpip_v6, SocketAddress::from_str("[0:0:0:0:0:0:0:1]:1234").unwrap());
4323                 assert_eq!(tcpip_v6, SocketAddress::from_str(&tcpip_v6.to_string()).unwrap());
4324
4325                 let hostname = SocketAddress::Hostname {
4326                                 hostname: Hostname::try_from("lightning-node.mydomain.com".to_string()).unwrap(),
4327                                 port: 1234,
4328                 };
4329                 assert_eq!(hostname, SocketAddress::from_str("lightning-node.mydomain.com:1234").unwrap());
4330                 assert_eq!(hostname, SocketAddress::from_str(&hostname.to_string()).unwrap());
4331
4332                 let onion_v2 = SocketAddress::OnionV2 ([40, 4, 64, 185, 202, 19, 162, 75, 90, 200, 38, 7],);
4333                 assert_eq!("OnionV2([40, 4, 64, 185, 202, 19, 162, 75, 90, 200, 38, 7])", &onion_v2.to_string());
4334                 assert_eq!(Err(SocketAddressParseError::InvalidOnionV3), SocketAddress::from_str("FACEBOOKCOREWWWI.onion:9735"));
4335
4336                 let onion_v3 = SocketAddress::OnionV3 {
4337                         ed25519_pubkey: [37, 24, 75, 5, 25, 73, 117, 194, 139, 102, 182, 107, 4, 105, 247, 246, 85,
4338                         111, 177, 172, 49, 137, 167, 155, 64, 221, 163, 47, 31, 33, 71, 3],
4339                         checksum: 48326,
4340                         version: 121,
4341                         port: 1234
4342                 };
4343                 assert_eq!(onion_v3, SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion:1234").unwrap());
4344                 assert_eq!(onion_v3, SocketAddress::from_str(&onion_v3.to_string()).unwrap());
4345
4346                 assert_eq!(Err(SocketAddressParseError::InvalidOnionV3), SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6.onion:1234"));
4347                 assert_eq!(Err(SocketAddressParseError::InvalidInput), SocketAddress::from_str("127.0.0.1@1234"));
4348                 assert_eq!(Err(SocketAddressParseError::InvalidInput), "".parse::<SocketAddress>());
4349                 assert!(SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion.onion:9735:94").is_err());
4350                 assert!(SocketAddress::from_str("wrong$%#.com:1234").is_err());
4351                 assert_eq!(Err(SocketAddressParseError::InvalidPort), SocketAddress::from_str("example.com:wrong"));
4352                 assert!("localhost".parse::<SocketAddress>().is_err());
4353                 assert!("localhost:invalid-port".parse::<SocketAddress>().is_err());
4354                 assert!( "invalid-onion-v3-hostname.onion:8080".parse::<SocketAddress>().is_err());
4355                 assert!("b32.example.onion:invalid-port".parse::<SocketAddress>().is_err());
4356                 assert!("invalid-address".parse::<SocketAddress>().is_err());
4357                 assert!(SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion.onion:1234").is_err());
4358         }
4359
4360         #[test]
4361         #[cfg(feature = "std")]
4362         fn test_socket_address_to_socket_addrs() {
4363                 assert_eq!(SocketAddress::TcpIpV4 {addr:[0u8; 4], port: 1337,}.to_socket_addrs().unwrap().next().unwrap(),
4364                                    SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(0,0,0,0), 1337)));
4365                 assert_eq!(SocketAddress::TcpIpV6 {addr:[0u8; 16], port: 1337,}.to_socket_addrs().unwrap().next().unwrap(),
4366                                    SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::from([0u8; 16]), 1337, 0, 0)));
4367                 assert_eq!(SocketAddress::Hostname { hostname: Hostname::try_from("0.0.0.0".to_string()).unwrap(), port: 0 }
4368                                            .to_socket_addrs().unwrap().next().unwrap(), SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::from([0u8; 4]),0)));
4369                 assert!(SocketAddress::OnionV2([0u8; 12]).to_socket_addrs().is_err());
4370                 assert!(SocketAddress::OnionV3{ ed25519_pubkey: [37, 24, 75, 5, 25, 73, 117, 194, 139, 102,
4371                         182, 107, 4, 105, 247, 246, 85, 111, 177, 172, 49, 137, 167, 155, 64, 221, 163, 47, 31,
4372                         33, 71, 3],
4373                         checksum: 48326,
4374                         version: 121,
4375                         port: 1234 }.to_socket_addrs().is_err());
4376         }
4377 }