_ 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 #[derive(Clone)]
1672 #[cfg_attr(test, derive(Debug, PartialEq))]
1673 /// Information communicated in the onion to the recipient for multi-part tracking and proof that
1674 /// the payment is associated with an invoice.
1675 pub struct FinalOnionHopData {
1676         /// When sending a multi-part payment, this secret is used to identify a payment across HTLCs.
1677         /// Because it is generated by the recipient and included in the invoice, it also provides
1678         /// proof to the recipient that the payment was sent by someone with the generated invoice.
1679         pub payment_secret: PaymentSecret,
1680         /// The intended total amount that this payment is for.
1681         ///
1682         /// Message serialization may panic if this value is more than 21 million Bitcoin.
1683         pub total_msat: u64,
1684 }
1685
1686 mod fuzzy_internal_msgs {
1687         use bitcoin::secp256k1::PublicKey;
1688         use crate::blinded_path::payment::{PaymentConstraints, PaymentRelay};
1689         use crate::prelude::*;
1690         use crate::ln::{PaymentPreimage, PaymentSecret};
1691         use crate::ln::features::BlindedHopFeatures;
1692         use super::FinalOnionHopData;
1693
1694         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
1695         // them from untrusted input):
1696
1697         pub enum InboundOnionPayload {
1698                 Forward {
1699                         short_channel_id: u64,
1700                         /// The value, in msat, of the payment after this hop's fee is deducted.
1701                         amt_to_forward: u64,
1702                         outgoing_cltv_value: u32,
1703                 },
1704                 Receive {
1705                         payment_data: Option<FinalOnionHopData>,
1706                         payment_metadata: Option<Vec<u8>>,
1707                         keysend_preimage: Option<PaymentPreimage>,
1708                         custom_tlvs: Vec<(u64, Vec<u8>)>,
1709                         sender_intended_htlc_amt_msat: u64,
1710                         cltv_expiry_height: u32,
1711                 },
1712                 BlindedForward {
1713                         short_channel_id: u64,
1714                         payment_relay: PaymentRelay,
1715                         payment_constraints: PaymentConstraints,
1716                         features: BlindedHopFeatures,
1717                         intro_node_blinding_point: PublicKey,
1718                 },
1719                 BlindedReceive {
1720                         sender_intended_htlc_amt_msat: u64,
1721                         total_msat: u64,
1722                         cltv_expiry_height: u32,
1723                         payment_secret: PaymentSecret,
1724                         payment_constraints: PaymentConstraints,
1725                         intro_node_blinding_point: Option<PublicKey>,
1726                 }
1727         }
1728
1729         pub(crate) enum OutboundOnionPayload {
1730                 Forward {
1731                         short_channel_id: u64,
1732                         /// The value, in msat, of the payment after this hop's fee is deducted.
1733                         amt_to_forward: u64,
1734                         outgoing_cltv_value: u32,
1735                 },
1736                 Receive {
1737                         payment_data: Option<FinalOnionHopData>,
1738                         payment_metadata: Option<Vec<u8>>,
1739                         keysend_preimage: Option<PaymentPreimage>,
1740                         custom_tlvs: Vec<(u64, Vec<u8>)>,
1741                         sender_intended_htlc_amt_msat: u64,
1742                         cltv_expiry_height: u32,
1743                 },
1744                 BlindedForward {
1745                         encrypted_tlvs: Vec<u8>,
1746                         intro_node_blinding_point: Option<PublicKey>,
1747                 },
1748                 BlindedReceive {
1749                         amt_msat: u64,
1750                         total_msat: u64,
1751                         cltv_expiry_height: u32,
1752                         encrypted_tlvs: Vec<u8>,
1753                         intro_node_blinding_point: Option<PublicKey>, // Set if the introduction node of the blinded path is the final node
1754                 }
1755         }
1756
1757         pub struct DecodedOnionErrorPacket {
1758                 pub(crate) hmac: [u8; 32],
1759                 pub(crate) failuremsg: Vec<u8>,
1760                 pub(crate) pad: Vec<u8>,
1761         }
1762 }
1763 #[cfg(fuzzing)]
1764 pub use self::fuzzy_internal_msgs::*;
1765 #[cfg(not(fuzzing))]
1766 pub(crate) use self::fuzzy_internal_msgs::*;
1767
1768 /// BOLT 4 onion packet including hop data for the next peer.
1769 #[derive(Clone, Hash, PartialEq, Eq)]
1770 pub struct OnionPacket {
1771         /// BOLT 4 version number.
1772         pub version: u8,
1773         /// In order to ensure we always return an error on onion decode in compliance with [BOLT
1774         /// #4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md), we have to
1775         /// deserialize `OnionPacket`s contained in [`UpdateAddHTLC`] messages even if the ephemeral
1776         /// public key (here) is bogus, so we hold a [`Result`] instead of a [`PublicKey`] as we'd
1777         /// like.
1778         pub public_key: Result<PublicKey, secp256k1::Error>,
1779         /// 1300 bytes encrypted payload for the next hop.
1780         pub hop_data: [u8; 20*65],
1781         /// HMAC to verify the integrity of hop_data.
1782         pub hmac: [u8; 32],
1783 }
1784
1785 impl onion_utils::Packet for OnionPacket {
1786         type Data = onion_utils::FixedSizeOnionPacket;
1787         fn new(pubkey: PublicKey, hop_data: onion_utils::FixedSizeOnionPacket, hmac: [u8; 32]) -> Self {
1788                 Self {
1789                         version: 0,
1790                         public_key: Ok(pubkey),
1791                         hop_data: hop_data.0,
1792                         hmac,
1793                 }
1794         }
1795 }
1796
1797 impl fmt::Debug for OnionPacket {
1798         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1799                 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1800         }
1801 }
1802
1803 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
1804 pub(crate) struct OnionErrorPacket {
1805         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1806         // (TODO) We limit it in decode to much lower...
1807         pub(crate) data: Vec<u8>,
1808 }
1809
1810 impl fmt::Display for DecodeError {
1811         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1812                 match *self {
1813                         DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1814                         DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1815                         DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1816                         DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1817                         DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1818                         DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1819                         DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1820                 }
1821         }
1822 }
1823
1824 impl From<io::Error> for DecodeError {
1825         fn from(e: io::Error) -> Self {
1826                 if e.kind() == io::ErrorKind::UnexpectedEof {
1827                         DecodeError::ShortRead
1828                 } else {
1829                         DecodeError::Io(e.kind())
1830                 }
1831         }
1832 }
1833
1834 #[cfg(not(taproot))]
1835 impl_writeable_msg!(AcceptChannel, {
1836         temporary_channel_id,
1837         dust_limit_satoshis,
1838         max_htlc_value_in_flight_msat,
1839         channel_reserve_satoshis,
1840         htlc_minimum_msat,
1841         minimum_depth,
1842         to_self_delay,
1843         max_accepted_htlcs,
1844         funding_pubkey,
1845         revocation_basepoint,
1846         payment_point,
1847         delayed_payment_basepoint,
1848         htlc_basepoint,
1849         first_per_commitment_point,
1850 }, {
1851         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
1852         (1, channel_type, option),
1853 });
1854
1855 #[cfg(taproot)]
1856 impl_writeable_msg!(AcceptChannel, {
1857         temporary_channel_id,
1858         dust_limit_satoshis,
1859         max_htlc_value_in_flight_msat,
1860         channel_reserve_satoshis,
1861         htlc_minimum_msat,
1862         minimum_depth,
1863         to_self_delay,
1864         max_accepted_htlcs,
1865         funding_pubkey,
1866         revocation_basepoint,
1867         payment_point,
1868         delayed_payment_basepoint,
1869         htlc_basepoint,
1870         first_per_commitment_point,
1871 }, {
1872         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
1873         (1, channel_type, option),
1874         (4, next_local_nonce, option),
1875 });
1876
1877 impl_writeable_msg!(AcceptChannelV2, {
1878         temporary_channel_id,
1879         funding_satoshis,
1880         dust_limit_satoshis,
1881         max_htlc_value_in_flight_msat,
1882         htlc_minimum_msat,
1883         minimum_depth,
1884         to_self_delay,
1885         max_accepted_htlcs,
1886         funding_pubkey,
1887         revocation_basepoint,
1888         payment_basepoint,
1889         delayed_payment_basepoint,
1890         htlc_basepoint,
1891         first_per_commitment_point,
1892         second_per_commitment_point,
1893 }, {
1894         (0, shutdown_scriptpubkey, option),
1895         (1, channel_type, option),
1896         (2, require_confirmed_inputs, option),
1897 });
1898
1899 impl_writeable_msg!(Stfu, {
1900         channel_id,
1901         initiator,
1902 }, {});
1903
1904 impl_writeable_msg!(Splice, {
1905         channel_id,
1906         chain_hash,
1907         relative_satoshis,
1908         funding_feerate_perkw,
1909         locktime,
1910         funding_pubkey,
1911 }, {});
1912
1913 impl_writeable_msg!(SpliceAck, {
1914         channel_id,
1915         chain_hash,
1916         relative_satoshis,
1917         funding_pubkey,
1918 }, {});
1919
1920 impl_writeable_msg!(SpliceLocked, {
1921         channel_id,
1922 }, {});
1923
1924 impl_writeable_msg!(TxAddInput, {
1925         channel_id,
1926         serial_id,
1927         prevtx,
1928         prevtx_out,
1929         sequence,
1930 }, {});
1931
1932 impl_writeable_msg!(TxAddOutput, {
1933         channel_id,
1934         serial_id,
1935         sats,
1936         script,
1937 }, {});
1938
1939 impl_writeable_msg!(TxRemoveInput, {
1940         channel_id,
1941         serial_id,
1942 }, {});
1943
1944 impl_writeable_msg!(TxRemoveOutput, {
1945         channel_id,
1946         serial_id,
1947 }, {});
1948
1949 impl_writeable_msg!(TxComplete, {
1950         channel_id,
1951 }, {});
1952
1953 impl_writeable_msg!(TxSignatures, {
1954         channel_id,
1955         tx_hash,
1956         witnesses,
1957 }, {});
1958
1959 impl_writeable_msg!(TxInitRbf, {
1960         channel_id,
1961         locktime,
1962         feerate_sat_per_1000_weight,
1963 }, {
1964         (0, funding_output_contribution, option),
1965 });
1966
1967 impl_writeable_msg!(TxAckRbf, {
1968         channel_id,
1969 }, {
1970         (0, funding_output_contribution, option),
1971 });
1972
1973 impl_writeable_msg!(TxAbort, {
1974         channel_id,
1975         data,
1976 }, {});
1977
1978 impl_writeable_msg!(AnnouncementSignatures, {
1979         channel_id,
1980         short_channel_id,
1981         node_signature,
1982         bitcoin_signature
1983 }, {});
1984
1985 impl_writeable_msg!(ChannelReestablish, {
1986         channel_id,
1987         next_local_commitment_number,
1988         next_remote_commitment_number,
1989         your_last_per_commitment_secret,
1990         my_current_per_commitment_point,
1991 }, {
1992         (0, next_funding_txid, option),
1993 });
1994
1995 impl_writeable_msg!(ClosingSigned,
1996         { channel_id, fee_satoshis, signature },
1997         { (1, fee_range, option) }
1998 );
1999
2000 impl_writeable!(ClosingSignedFeeRange, {
2001         min_fee_satoshis,
2002         max_fee_satoshis
2003 });
2004
2005 #[cfg(not(taproot))]
2006 impl_writeable_msg!(CommitmentSigned, {
2007         channel_id,
2008         signature,
2009         htlc_signatures
2010 }, {});
2011
2012 #[cfg(taproot)]
2013 impl_writeable_msg!(CommitmentSigned, {
2014         channel_id,
2015         signature,
2016         htlc_signatures
2017 }, {
2018         (2, partial_signature_with_nonce, option)
2019 });
2020
2021 impl_writeable!(DecodedOnionErrorPacket, {
2022         hmac,
2023         failuremsg,
2024         pad
2025 });
2026
2027 #[cfg(not(taproot))]
2028 impl_writeable_msg!(FundingCreated, {
2029         temporary_channel_id,
2030         funding_txid,
2031         funding_output_index,
2032         signature
2033 }, {});
2034 #[cfg(taproot)]
2035 impl_writeable_msg!(FundingCreated, {
2036         temporary_channel_id,
2037         funding_txid,
2038         funding_output_index,
2039         signature
2040 }, {
2041         (2, partial_signature_with_nonce, option),
2042         (4, next_local_nonce, option)
2043 });
2044
2045 #[cfg(not(taproot))]
2046 impl_writeable_msg!(FundingSigned, {
2047         channel_id,
2048         signature
2049 }, {});
2050
2051 #[cfg(taproot)]
2052 impl_writeable_msg!(FundingSigned, {
2053         channel_id,
2054         signature
2055 }, {
2056         (2, partial_signature_with_nonce, option)
2057 });
2058
2059 impl_writeable_msg!(ChannelReady, {
2060         channel_id,
2061         next_per_commitment_point,
2062 }, {
2063         (1, short_channel_id_alias, option),
2064 });
2065
2066 impl Writeable for Init {
2067         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2068                 // global_features gets the bottom 13 bits of our features, and local_features gets all of
2069                 // our relevant feature bits. This keeps us compatible with old nodes.
2070                 self.features.write_up_to_13(w)?;
2071                 self.features.write(w)?;
2072                 encode_tlv_stream!(w, {
2073                         (1, self.networks.as_ref().map(|n| WithoutLength(n)), option),
2074                         (3, self.remote_network_address, option),
2075                 });
2076                 Ok(())
2077         }
2078 }
2079
2080 impl Readable for Init {
2081         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2082                 let global_features: InitFeatures = Readable::read(r)?;
2083                 let features: InitFeatures = Readable::read(r)?;
2084                 let mut remote_network_address: Option<SocketAddress> = None;
2085                 let mut networks: Option<WithoutLength<Vec<ChainHash>>> = None;
2086                 decode_tlv_stream!(r, {
2087                         (1, networks, option),
2088                         (3, remote_network_address, option)
2089                 });
2090                 Ok(Init {
2091                         features: features | global_features,
2092                         networks: networks.map(|n| n.0),
2093                         remote_network_address,
2094                 })
2095         }
2096 }
2097
2098 impl_writeable_msg!(OpenChannel, {
2099         chain_hash,
2100         temporary_channel_id,
2101         funding_satoshis,
2102         push_msat,
2103         dust_limit_satoshis,
2104         max_htlc_value_in_flight_msat,
2105         channel_reserve_satoshis,
2106         htlc_minimum_msat,
2107         feerate_per_kw,
2108         to_self_delay,
2109         max_accepted_htlcs,
2110         funding_pubkey,
2111         revocation_basepoint,
2112         payment_point,
2113         delayed_payment_basepoint,
2114         htlc_basepoint,
2115         first_per_commitment_point,
2116         channel_flags,
2117 }, {
2118         (0, shutdown_scriptpubkey, (option, encoding: (ScriptBuf, WithoutLength))), // Don't encode length twice.
2119         (1, channel_type, option),
2120 });
2121
2122 impl_writeable_msg!(OpenChannelV2, {
2123         chain_hash,
2124         temporary_channel_id,
2125         funding_feerate_sat_per_1000_weight,
2126         commitment_feerate_sat_per_1000_weight,
2127         funding_satoshis,
2128         dust_limit_satoshis,
2129         max_htlc_value_in_flight_msat,
2130         htlc_minimum_msat,
2131         to_self_delay,
2132         max_accepted_htlcs,
2133         locktime,
2134         funding_pubkey,
2135         revocation_basepoint,
2136         payment_basepoint,
2137         delayed_payment_basepoint,
2138         htlc_basepoint,
2139         first_per_commitment_point,
2140         second_per_commitment_point,
2141         channel_flags,
2142 }, {
2143         (0, shutdown_scriptpubkey, option),
2144         (1, channel_type, option),
2145         (2, require_confirmed_inputs, option),
2146 });
2147
2148 #[cfg(not(taproot))]
2149 impl_writeable_msg!(RevokeAndACK, {
2150         channel_id,
2151         per_commitment_secret,
2152         next_per_commitment_point
2153 }, {});
2154
2155 #[cfg(taproot)]
2156 impl_writeable_msg!(RevokeAndACK, {
2157         channel_id,
2158         per_commitment_secret,
2159         next_per_commitment_point
2160 }, {
2161         (4, next_local_nonce, option)
2162 });
2163
2164 impl_writeable_msg!(Shutdown, {
2165         channel_id,
2166         scriptpubkey
2167 }, {});
2168
2169 impl_writeable_msg!(UpdateFailHTLC, {
2170         channel_id,
2171         htlc_id,
2172         reason
2173 }, {});
2174
2175 impl_writeable_msg!(UpdateFailMalformedHTLC, {
2176         channel_id,
2177         htlc_id,
2178         sha256_of_onion,
2179         failure_code
2180 }, {});
2181
2182 impl_writeable_msg!(UpdateFee, {
2183         channel_id,
2184         feerate_per_kw
2185 }, {});
2186
2187 impl_writeable_msg!(UpdateFulfillHTLC, {
2188         channel_id,
2189         htlc_id,
2190         payment_preimage
2191 }, {});
2192
2193 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
2194 // serialization format in a way which assumes we know the total serialized length/message end
2195 // position.
2196 impl_writeable!(OnionErrorPacket, {
2197         data
2198 });
2199
2200 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
2201 // serialization format in a way which assumes we know the total serialized length/message end
2202 // position.
2203 impl Writeable for OnionPacket {
2204         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2205                 self.version.write(w)?;
2206                 match self.public_key {
2207                         Ok(pubkey) => pubkey.write(w)?,
2208                         Err(_) => [0u8;33].write(w)?,
2209                 }
2210                 w.write_all(&self.hop_data)?;
2211                 self.hmac.write(w)?;
2212                 Ok(())
2213         }
2214 }
2215
2216 impl Readable for OnionPacket {
2217         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2218                 Ok(OnionPacket {
2219                         version: Readable::read(r)?,
2220                         public_key: {
2221                                 let mut buf = [0u8;33];
2222                                 r.read_exact(&mut buf)?;
2223                                 PublicKey::from_slice(&buf)
2224                         },
2225                         hop_data: Readable::read(r)?,
2226                         hmac: Readable::read(r)?,
2227                 })
2228         }
2229 }
2230
2231 impl_writeable_msg!(UpdateAddHTLC, {
2232         channel_id,
2233         htlc_id,
2234         amount_msat,
2235         payment_hash,
2236         cltv_expiry,
2237         onion_routing_packet,
2238 }, {
2239         (0, blinding_point, option),
2240         (65537, skimmed_fee_msat, option)
2241 });
2242
2243 impl Readable for OnionMessage {
2244         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2245                 let blinding_point: PublicKey = Readable::read(r)?;
2246                 let len: u16 = Readable::read(r)?;
2247                 let mut packet_reader = FixedLengthReader::new(r, len as u64);
2248                 let onion_routing_packet: onion_message::Packet = <onion_message::Packet as LengthReadable>::read(&mut packet_reader)?;
2249                 Ok(Self {
2250                         blinding_point,
2251                         onion_routing_packet,
2252                 })
2253         }
2254 }
2255
2256 impl Writeable for OnionMessage {
2257         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2258                 self.blinding_point.write(w)?;
2259                 let onion_packet_len = self.onion_routing_packet.serialized_length();
2260                 (onion_packet_len as u16).write(w)?;
2261                 self.onion_routing_packet.write(w)?;
2262                 Ok(())
2263         }
2264 }
2265
2266 impl Writeable for FinalOnionHopData {
2267         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2268                 self.payment_secret.0.write(w)?;
2269                 HighZeroBytesDroppedBigSize(self.total_msat).write(w)
2270         }
2271 }
2272
2273 impl Readable for FinalOnionHopData {
2274         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2275                 let secret: [u8; 32] = Readable::read(r)?;
2276                 let amt: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
2277                 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
2278         }
2279 }
2280
2281 impl Writeable for OutboundOnionPayload {
2282         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2283                 match self {
2284                         Self::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } => {
2285                                 _encode_varint_length_prefixed_tlv!(w, {
2286                                         (2, HighZeroBytesDroppedBigSize(*amt_to_forward), required),
2287                                         (4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
2288                                         (6, short_channel_id, required)
2289                                 });
2290                         },
2291                         Self::Receive {
2292                                 ref payment_data, ref payment_metadata, ref keysend_preimage, sender_intended_htlc_amt_msat,
2293                                 cltv_expiry_height, ref custom_tlvs,
2294                         } => {
2295                                 // We need to update [`ln::outbound_payment::RecipientOnionFields::with_custom_tlvs`]
2296                                 // to reject any reserved types in the experimental range if new ones are ever
2297                                 // standardized.
2298                                 let keysend_tlv = keysend_preimage.map(|preimage| (5482373484, preimage.encode()));
2299                                 let mut custom_tlvs: Vec<&(u64, Vec<u8>)> = custom_tlvs.iter().chain(keysend_tlv.iter()).collect();
2300                                 custom_tlvs.sort_unstable_by_key(|(typ, _)| *typ);
2301                                 _encode_varint_length_prefixed_tlv!(w, {
2302                                         (2, HighZeroBytesDroppedBigSize(*sender_intended_htlc_amt_msat), required),
2303                                         (4, HighZeroBytesDroppedBigSize(*cltv_expiry_height), required),
2304                                         (8, payment_data, option),
2305                                         (16, payment_metadata.as_ref().map(|m| WithoutLength(m)), option)
2306                                 }, custom_tlvs.iter());
2307                         },
2308                         Self::BlindedForward { encrypted_tlvs, intro_node_blinding_point } => {
2309                                 _encode_varint_length_prefixed_tlv!(w, {
2310                                         (10, *encrypted_tlvs, required_vec),
2311                                         (12, intro_node_blinding_point, option)
2312                                 });
2313                         },
2314                         Self::BlindedReceive {
2315                                 amt_msat, total_msat, cltv_expiry_height, encrypted_tlvs, intro_node_blinding_point,
2316                         } => {
2317                                 _encode_varint_length_prefixed_tlv!(w, {
2318                                         (2, HighZeroBytesDroppedBigSize(*amt_msat), required),
2319                                         (4, HighZeroBytesDroppedBigSize(*cltv_expiry_height), required),
2320                                         (10, *encrypted_tlvs, required_vec),
2321                                         (12, intro_node_blinding_point, option),
2322                                         (18, HighZeroBytesDroppedBigSize(*total_msat), required)
2323                                 });
2324                         },
2325                 }
2326                 Ok(())
2327         }
2328 }
2329
2330 impl<NS: Deref> ReadableArgs<(Option<PublicKey>, &NS)> for InboundOnionPayload where NS::Target: NodeSigner {
2331         fn read<R: Read>(r: &mut R, args: (Option<PublicKey>, &NS)) -> Result<Self, DecodeError> {
2332                 let (update_add_blinding_point, node_signer) = args;
2333
2334                 let mut amt = None;
2335                 let mut cltv_value = None;
2336                 let mut short_id: Option<u64> = None;
2337                 let mut payment_data: Option<FinalOnionHopData> = None;
2338                 let mut encrypted_tlvs_opt: Option<WithoutLength<Vec<u8>>> = None;
2339                 let mut intro_node_blinding_point = None;
2340                 let mut payment_metadata: Option<WithoutLength<Vec<u8>>> = None;
2341                 let mut total_msat = None;
2342                 let mut keysend_preimage: Option<PaymentPreimage> = None;
2343                 let mut custom_tlvs = Vec::new();
2344
2345                 let tlv_len = BigSize::read(r)?;
2346                 let rd = FixedLengthReader::new(r, tlv_len.0);
2347                 decode_tlv_stream_with_custom_tlv_decode!(rd, {
2348                         (2, amt, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
2349                         (4, cltv_value, (option, encoding: (u32, HighZeroBytesDroppedBigSize))),
2350                         (6, short_id, option),
2351                         (8, payment_data, option),
2352                         (10, encrypted_tlvs_opt, option),
2353                         (12, intro_node_blinding_point, option),
2354                         (16, payment_metadata, option),
2355                         (18, total_msat, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
2356                         // See https://github.com/lightning/blips/blob/master/blip-0003.md
2357                         (5482373484, keysend_preimage, option)
2358                 }, |msg_type: u64, msg_reader: &mut FixedLengthReader<_>| -> Result<bool, DecodeError> {
2359                         if msg_type < 1 << 16 { return Ok(false) }
2360                         let mut value = Vec::new();
2361                         msg_reader.read_to_end(&mut value)?;
2362                         custom_tlvs.push((msg_type, value));
2363                         Ok(true)
2364                 });
2365
2366                 if amt.unwrap_or(0) > MAX_VALUE_MSAT { return Err(DecodeError::InvalidValue) }
2367                 if intro_node_blinding_point.is_some() && update_add_blinding_point.is_some() {
2368                         return Err(DecodeError::InvalidValue)
2369                 }
2370
2371                 if let Some(blinding_point) = intro_node_blinding_point.or(update_add_blinding_point) {
2372                         if short_id.is_some() || payment_data.is_some() || payment_metadata.is_some() ||
2373                                 keysend_preimage.is_some()
2374                         {
2375                                 return Err(DecodeError::InvalidValue)
2376                         }
2377                         let enc_tlvs = encrypted_tlvs_opt.ok_or(DecodeError::InvalidValue)?.0;
2378                         let enc_tlvs_ss = node_signer.ecdh(Recipient::Node, &blinding_point, None)
2379                                 .map_err(|_| DecodeError::InvalidValue)?;
2380                         let rho = onion_utils::gen_rho_from_shared_secret(&enc_tlvs_ss.secret_bytes());
2381                         let mut s = Cursor::new(&enc_tlvs);
2382                         let mut reader = FixedLengthReader::new(&mut s, enc_tlvs.len() as u64);
2383                         match ChaChaPolyReadAdapter::read(&mut reader, rho)? {
2384                                 ChaChaPolyReadAdapter { readable: BlindedPaymentTlvs::Forward(ForwardTlvs {
2385                                         short_channel_id, payment_relay, payment_constraints, features
2386                                 })} => {
2387                                         if amt.is_some() || cltv_value.is_some() || total_msat.is_some() {
2388                                                 return Err(DecodeError::InvalidValue)
2389                                         }
2390                                         Ok(Self::BlindedForward {
2391                                                 short_channel_id,
2392                                                 payment_relay,
2393                                                 payment_constraints,
2394                                                 features,
2395                                                 intro_node_blinding_point: intro_node_blinding_point.ok_or(DecodeError::InvalidValue)?,
2396                                         })
2397                                 },
2398                                 ChaChaPolyReadAdapter { readable: BlindedPaymentTlvs::Receive(ReceiveTlvs {
2399                                         payment_secret, payment_constraints
2400                                 })} => {
2401                                         if total_msat.unwrap_or(0) > MAX_VALUE_MSAT { return Err(DecodeError::InvalidValue) }
2402                                         Ok(Self::BlindedReceive {
2403                                                 sender_intended_htlc_amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
2404                                                 total_msat: total_msat.ok_or(DecodeError::InvalidValue)?,
2405                                                 cltv_expiry_height: cltv_value.ok_or(DecodeError::InvalidValue)?,
2406                                                 payment_secret,
2407                                                 payment_constraints,
2408                                                 intro_node_blinding_point,
2409                                         })
2410                                 },
2411                         }
2412                 } else if let Some(short_channel_id) = short_id {
2413                         if payment_data.is_some() || payment_metadata.is_some() || encrypted_tlvs_opt.is_some() ||
2414                                 total_msat.is_some()
2415                         { return Err(DecodeError::InvalidValue) }
2416                         Ok(Self::Forward {
2417                                 short_channel_id,
2418                                 amt_to_forward: amt.ok_or(DecodeError::InvalidValue)?,
2419                                 outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
2420                         })
2421                 } else {
2422                         if encrypted_tlvs_opt.is_some() || total_msat.is_some() {
2423                                 return Err(DecodeError::InvalidValue)
2424                         }
2425                         if let Some(data) = &payment_data {
2426                                 if data.total_msat > MAX_VALUE_MSAT {
2427                                         return Err(DecodeError::InvalidValue);
2428                                 }
2429                         }
2430                         Ok(Self::Receive {
2431                                 payment_data,
2432                                 payment_metadata: payment_metadata.map(|w| w.0),
2433                                 keysend_preimage,
2434                                 sender_intended_htlc_amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
2435                                 cltv_expiry_height: cltv_value.ok_or(DecodeError::InvalidValue)?,
2436                                 custom_tlvs,
2437                         })
2438                 }
2439         }
2440 }
2441
2442 impl Writeable for Ping {
2443         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2444                 self.ponglen.write(w)?;
2445                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
2446                 Ok(())
2447         }
2448 }
2449
2450 impl Readable for Ping {
2451         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2452                 Ok(Ping {
2453                         ponglen: Readable::read(r)?,
2454                         byteslen: {
2455                                 let byteslen = Readable::read(r)?;
2456                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
2457                                 byteslen
2458                         }
2459                 })
2460         }
2461 }
2462
2463 impl Writeable for Pong {
2464         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2465                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
2466                 Ok(())
2467         }
2468 }
2469
2470 impl Readable for Pong {
2471         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2472                 Ok(Pong {
2473                         byteslen: {
2474                                 let byteslen = Readable::read(r)?;
2475                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
2476                                 byteslen
2477                         }
2478                 })
2479         }
2480 }
2481
2482 impl Writeable for UnsignedChannelAnnouncement {
2483         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2484                 self.features.write(w)?;
2485                 self.chain_hash.write(w)?;
2486                 self.short_channel_id.write(w)?;
2487                 self.node_id_1.write(w)?;
2488                 self.node_id_2.write(w)?;
2489                 self.bitcoin_key_1.write(w)?;
2490                 self.bitcoin_key_2.write(w)?;
2491                 w.write_all(&self.excess_data[..])?;
2492                 Ok(())
2493         }
2494 }
2495
2496 impl Readable for UnsignedChannelAnnouncement {
2497         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2498                 Ok(Self {
2499                         features: Readable::read(r)?,
2500                         chain_hash: Readable::read(r)?,
2501                         short_channel_id: Readable::read(r)?,
2502                         node_id_1: Readable::read(r)?,
2503                         node_id_2: Readable::read(r)?,
2504                         bitcoin_key_1: Readable::read(r)?,
2505                         bitcoin_key_2: Readable::read(r)?,
2506                         excess_data: read_to_end(r)?,
2507                 })
2508         }
2509 }
2510
2511 impl_writeable!(ChannelAnnouncement, {
2512         node_signature_1,
2513         node_signature_2,
2514         bitcoin_signature_1,
2515         bitcoin_signature_2,
2516         contents
2517 });
2518
2519 impl Writeable for UnsignedChannelUpdate {
2520         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2521                 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
2522                 const MESSAGE_FLAGS: u8 = 1;
2523                 self.chain_hash.write(w)?;
2524                 self.short_channel_id.write(w)?;
2525                 self.timestamp.write(w)?;
2526                 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
2527                 all_flags.write(w)?;
2528                 self.cltv_expiry_delta.write(w)?;
2529                 self.htlc_minimum_msat.write(w)?;
2530                 self.fee_base_msat.write(w)?;
2531                 self.fee_proportional_millionths.write(w)?;
2532                 self.htlc_maximum_msat.write(w)?;
2533                 w.write_all(&self.excess_data[..])?;
2534                 Ok(())
2535         }
2536 }
2537
2538 impl Readable for UnsignedChannelUpdate {
2539         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2540                 Ok(Self {
2541                         chain_hash: Readable::read(r)?,
2542                         short_channel_id: Readable::read(r)?,
2543                         timestamp: Readable::read(r)?,
2544                         flags: {
2545                                 let flags: u16 = Readable::read(r)?;
2546                                 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
2547                                 flags as u8
2548                         },
2549                         cltv_expiry_delta: Readable::read(r)?,
2550                         htlc_minimum_msat: Readable::read(r)?,
2551                         fee_base_msat: Readable::read(r)?,
2552                         fee_proportional_millionths: Readable::read(r)?,
2553                         htlc_maximum_msat: Readable::read(r)?,
2554                         excess_data: read_to_end(r)?,
2555                 })
2556         }
2557 }
2558
2559 impl_writeable!(ChannelUpdate, {
2560         signature,
2561         contents
2562 });
2563
2564 impl Writeable for ErrorMessage {
2565         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2566                 self.channel_id.write(w)?;
2567                 (self.data.len() as u16).write(w)?;
2568                 w.write_all(self.data.as_bytes())?;
2569                 Ok(())
2570         }
2571 }
2572
2573 impl Readable for ErrorMessage {
2574         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2575                 Ok(Self {
2576                         channel_id: Readable::read(r)?,
2577                         data: {
2578                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
2579                                 let mut data = Vec::with_capacity(sz);
2580                                 data.resize(sz, 0);
2581                                 r.read_exact(&mut data)?;
2582                                 match String::from_utf8(data) {
2583                                         Ok(s) => s,
2584                                         Err(_) => return Err(DecodeError::InvalidValue),
2585                                 }
2586                         }
2587                 })
2588         }
2589 }
2590
2591 impl Writeable for WarningMessage {
2592         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2593                 self.channel_id.write(w)?;
2594                 (self.data.len() as u16).write(w)?;
2595                 w.write_all(self.data.as_bytes())?;
2596                 Ok(())
2597         }
2598 }
2599
2600 impl Readable for WarningMessage {
2601         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2602                 Ok(Self {
2603                         channel_id: Readable::read(r)?,
2604                         data: {
2605                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
2606                                 let mut data = Vec::with_capacity(sz);
2607                                 data.resize(sz, 0);
2608                                 r.read_exact(&mut data)?;
2609                                 match String::from_utf8(data) {
2610                                         Ok(s) => s,
2611                                         Err(_) => return Err(DecodeError::InvalidValue),
2612                                 }
2613                         }
2614                 })
2615         }
2616 }
2617
2618 impl Writeable for UnsignedNodeAnnouncement {
2619         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2620                 self.features.write(w)?;
2621                 self.timestamp.write(w)?;
2622                 self.node_id.write(w)?;
2623                 w.write_all(&self.rgb)?;
2624                 self.alias.write(w)?;
2625
2626                 let mut addr_len = 0;
2627                 for addr in self.addresses.iter() {
2628                         addr_len += 1 + addr.len();
2629                 }
2630                 (addr_len + self.excess_address_data.len() as u16).write(w)?;
2631                 for addr in self.addresses.iter() {
2632                         addr.write(w)?;
2633                 }
2634                 w.write_all(&self.excess_address_data[..])?;
2635                 w.write_all(&self.excess_data[..])?;
2636                 Ok(())
2637         }
2638 }
2639
2640 impl Readable for UnsignedNodeAnnouncement {
2641         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2642                 let features: NodeFeatures = Readable::read(r)?;
2643                 let timestamp: u32 = Readable::read(r)?;
2644                 let node_id: NodeId = Readable::read(r)?;
2645                 let mut rgb = [0; 3];
2646                 r.read_exact(&mut rgb)?;
2647                 let alias: NodeAlias = Readable::read(r)?;
2648
2649                 let addr_len: u16 = Readable::read(r)?;
2650                 let mut addresses: Vec<SocketAddress> = Vec::new();
2651                 let mut addr_readpos = 0;
2652                 let mut excess = false;
2653                 let mut excess_byte = 0;
2654                 loop {
2655                         if addr_len <= addr_readpos { break; }
2656                         match Readable::read(r) {
2657                                 Ok(Ok(addr)) => {
2658                                         if addr_len < addr_readpos + 1 + addr.len() {
2659                                                 return Err(DecodeError::BadLengthDescriptor);
2660                                         }
2661                                         addr_readpos += (1 + addr.len()) as u16;
2662                                         addresses.push(addr);
2663                                 },
2664                                 Ok(Err(unknown_descriptor)) => {
2665                                         excess = true;
2666                                         excess_byte = unknown_descriptor;
2667                                         break;
2668                                 },
2669                                 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
2670                                 Err(e) => return Err(e),
2671                         }
2672                 }
2673
2674                 let mut excess_data = vec![];
2675                 let excess_address_data = if addr_readpos < addr_len {
2676                         let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
2677                         r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
2678                         if excess {
2679                                 excess_address_data[0] = excess_byte;
2680                         }
2681                         excess_address_data
2682                 } else {
2683                         if excess {
2684                                 excess_data.push(excess_byte);
2685                         }
2686                         Vec::new()
2687                 };
2688                 excess_data.extend(read_to_end(r)?.iter());
2689                 Ok(UnsignedNodeAnnouncement {
2690                         features,
2691                         timestamp,
2692                         node_id,
2693                         rgb,
2694                         alias,
2695                         addresses,
2696                         excess_address_data,
2697                         excess_data,
2698                 })
2699         }
2700 }
2701
2702 impl_writeable!(NodeAnnouncement, {
2703         signature,
2704         contents
2705 });
2706
2707 impl Readable for QueryShortChannelIds {
2708         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2709                 let chain_hash: ChainHash = Readable::read(r)?;
2710
2711                 let encoding_len: u16 = Readable::read(r)?;
2712                 let encoding_type: u8 = Readable::read(r)?;
2713
2714                 // Must be encoding_type=0 uncompressed serialization. We do not
2715                 // support encoding_type=1 zlib serialization.
2716                 if encoding_type != EncodingType::Uncompressed as u8 {
2717                         return Err(DecodeError::UnsupportedCompression);
2718                 }
2719
2720                 // We expect the encoding_len to always includes the 1-byte
2721                 // encoding_type and that short_channel_ids are 8-bytes each
2722                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2723                         return Err(DecodeError::InvalidValue);
2724                 }
2725
2726                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2727                 // less the 1-byte encoding_type
2728                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2729                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2730                 for _ in 0..short_channel_id_count {
2731                         short_channel_ids.push(Readable::read(r)?);
2732                 }
2733
2734                 Ok(QueryShortChannelIds {
2735                         chain_hash,
2736                         short_channel_ids,
2737                 })
2738         }
2739 }
2740
2741 impl Writeable for QueryShortChannelIds {
2742         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2743                 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
2744                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2745
2746                 self.chain_hash.write(w)?;
2747                 encoding_len.write(w)?;
2748
2749                 // We only support type=0 uncompressed serialization
2750                 (EncodingType::Uncompressed as u8).write(w)?;
2751
2752                 for scid in self.short_channel_ids.iter() {
2753                         scid.write(w)?;
2754                 }
2755
2756                 Ok(())
2757         }
2758 }
2759
2760 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
2761         chain_hash,
2762         full_information,
2763 }, {});
2764
2765 impl QueryChannelRange {
2766         /// Calculates the overflow safe ending block height for the query.
2767         ///
2768         /// Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`.
2769         pub fn end_blocknum(&self) -> u32 {
2770                 match self.first_blocknum.checked_add(self.number_of_blocks) {
2771                         Some(block) => block,
2772                         None => u32::max_value(),
2773                 }
2774         }
2775 }
2776
2777 impl_writeable_msg!(QueryChannelRange, {
2778         chain_hash,
2779         first_blocknum,
2780         number_of_blocks
2781 }, {});
2782
2783 impl Readable for ReplyChannelRange {
2784         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
2785                 let chain_hash: ChainHash = Readable::read(r)?;
2786                 let first_blocknum: u32 = Readable::read(r)?;
2787                 let number_of_blocks: u32 = Readable::read(r)?;
2788                 let sync_complete: bool = Readable::read(r)?;
2789
2790                 let encoding_len: u16 = Readable::read(r)?;
2791                 let encoding_type: u8 = Readable::read(r)?;
2792
2793                 // Must be encoding_type=0 uncompressed serialization. We do not
2794                 // support encoding_type=1 zlib serialization.
2795                 if encoding_type != EncodingType::Uncompressed as u8 {
2796                         return Err(DecodeError::UnsupportedCompression);
2797                 }
2798
2799                 // We expect the encoding_len to always includes the 1-byte
2800                 // encoding_type and that short_channel_ids are 8-bytes each
2801                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
2802                         return Err(DecodeError::InvalidValue);
2803                 }
2804
2805                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
2806                 // less the 1-byte encoding_type
2807                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
2808                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
2809                 for _ in 0..short_channel_id_count {
2810                         short_channel_ids.push(Readable::read(r)?);
2811                 }
2812
2813                 Ok(ReplyChannelRange {
2814                         chain_hash,
2815                         first_blocknum,
2816                         number_of_blocks,
2817                         sync_complete,
2818                         short_channel_ids
2819                 })
2820         }
2821 }
2822
2823 impl Writeable for ReplyChannelRange {
2824         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
2825                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
2826                 self.chain_hash.write(w)?;
2827                 self.first_blocknum.write(w)?;
2828                 self.number_of_blocks.write(w)?;
2829                 self.sync_complete.write(w)?;
2830
2831                 encoding_len.write(w)?;
2832                 (EncodingType::Uncompressed as u8).write(w)?;
2833                 for scid in self.short_channel_ids.iter() {
2834                         scid.write(w)?;
2835                 }
2836
2837                 Ok(())
2838         }
2839 }
2840
2841 impl_writeable_msg!(GossipTimestampFilter, {
2842         chain_hash,
2843         first_timestamp,
2844         timestamp_range,
2845 }, {});
2846
2847 #[cfg(test)]
2848 mod tests {
2849         use std::convert::TryFrom;
2850         use bitcoin::{Transaction, TxIn, ScriptBuf, Sequence, Witness, TxOut};
2851         use hex::DisplayHex;
2852         use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
2853         use crate::ln::ChannelId;
2854         use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
2855         use crate::ln::msgs::{self, FinalOnionHopData, OnionErrorPacket};
2856         use crate::ln::msgs::SocketAddress;
2857         use crate::routing::gossip::{NodeAlias, NodeId};
2858         use crate::util::ser::{Writeable, Readable, ReadableArgs, Hostname, TransactionU16LenLimited};
2859         use crate::util::test_utils;
2860
2861         use bitcoin::hashes::hex::FromHex;
2862         use bitcoin::address::Address;
2863         use bitcoin::network::constants::Network;
2864         use bitcoin::blockdata::constants::ChainHash;
2865         use bitcoin::blockdata::script::Builder;
2866         use bitcoin::blockdata::opcodes;
2867         use bitcoin::hash_types::Txid;
2868         use bitcoin::locktime::absolute::LockTime;
2869
2870         use bitcoin::secp256k1::{PublicKey,SecretKey};
2871         use bitcoin::secp256k1::{Secp256k1, Message};
2872
2873         use crate::io::{self, Cursor};
2874         use crate::prelude::*;
2875         use core::str::FromStr;
2876         use crate::chain::transaction::OutPoint;
2877
2878         #[cfg(feature = "std")]
2879         use std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6, ToSocketAddrs};
2880         #[cfg(feature = "std")]
2881         use crate::ln::msgs::SocketAddressParseError;
2882
2883         #[test]
2884         fn encoding_channel_reestablish() {
2885                 let public_key = {
2886                         let secp_ctx = Secp256k1::new();
2887                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2888                 };
2889
2890                 let cr = msgs::ChannelReestablish {
2891                         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]),
2892                         next_local_commitment_number: 3,
2893                         next_remote_commitment_number: 4,
2894                         your_last_per_commitment_secret: [9;32],
2895                         my_current_per_commitment_point: public_key,
2896                         next_funding_txid: None,
2897                 };
2898
2899                 let encoded_value = cr.encode();
2900                 assert_eq!(
2901                         encoded_value,
2902                         vec![
2903                                 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
2904                                 0, 0, 0, 0, 0, 0, 0, 3, // next_local_commitment_number
2905                                 0, 0, 0, 0, 0, 0, 0, 4, // next_remote_commitment_number
2906                                 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
2907                                 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
2908                         ]
2909                 );
2910         }
2911
2912         #[test]
2913         fn encoding_channel_reestablish_with_next_funding_txid() {
2914                 let public_key = {
2915                         let secp_ctx = Secp256k1::new();
2916                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
2917                 };
2918
2919                 let cr = msgs::ChannelReestablish {
2920                         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]),
2921                         next_local_commitment_number: 3,
2922                         next_remote_commitment_number: 4,
2923                         your_last_per_commitment_secret: [9;32],
2924                         my_current_per_commitment_point: public_key,
2925                         next_funding_txid: Some(Txid::from_raw_hash(bitcoin::hashes::Hash::from_slice(&[
2926                                 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,
2927                         ]).unwrap())),
2928                 };
2929
2930                 let encoded_value = cr.encode();
2931                 assert_eq!(
2932                         encoded_value,
2933                         vec![
2934                                 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
2935                                 0, 0, 0, 0, 0, 0, 0, 3, // next_local_commitment_number
2936                                 0, 0, 0, 0, 0, 0, 0, 4, // next_remote_commitment_number
2937                                 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
2938                                 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
2939                                 0, // Type (next_funding_txid)
2940                                 32, // Length
2941                                 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
2942                         ]
2943                 );
2944         }
2945
2946         macro_rules! get_keys_from {
2947                 ($slice: expr, $secp_ctx: expr) => {
2948                         {
2949                                 let privkey = SecretKey::from_slice(&<Vec<u8>>::from_hex($slice).unwrap()[..]).unwrap();
2950                                 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
2951                                 (privkey, pubkey)
2952                         }
2953                 }
2954         }
2955
2956         macro_rules! get_sig_on {
2957                 ($privkey: expr, $ctx: expr, $string: expr) => {
2958                         {
2959                                 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
2960                                 $ctx.sign_ecdsa(&sighash, &$privkey)
2961                         }
2962                 }
2963         }
2964
2965         #[test]
2966         fn encoding_announcement_signatures() {
2967                 let secp_ctx = Secp256k1::new();
2968                 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2969                 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
2970                 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
2971                 let announcement_signatures = msgs::AnnouncementSignatures {
2972                         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]),
2973                         short_channel_id: 2316138423780173,
2974                         node_signature: sig_1,
2975                         bitcoin_signature: sig_2,
2976                 };
2977
2978                 let encoded_value = announcement_signatures.encode();
2979                 assert_eq!(encoded_value, <Vec<u8>>::from_hex("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
2980         }
2981
2982         fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
2983                 let secp_ctx = Secp256k1::new();
2984                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2985                 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2986                 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2987                 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2988                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2989                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2990                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2991                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2992                 let mut features = ChannelFeatures::empty();
2993                 if unknown_features_bits {
2994                         features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
2995                 }
2996                 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
2997                         features,
2998                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
2999                         short_channel_id: 2316138423780173,
3000                         node_id_1: NodeId::from_pubkey(&pubkey_1),
3001                         node_id_2: NodeId::from_pubkey(&pubkey_2),
3002                         bitcoin_key_1: NodeId::from_pubkey(&pubkey_3),
3003                         bitcoin_key_2: NodeId::from_pubkey(&pubkey_4),
3004                         excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
3005                 };
3006                 let channel_announcement = msgs::ChannelAnnouncement {
3007                         node_signature_1: sig_1,
3008                         node_signature_2: sig_2,
3009                         bitcoin_signature_1: sig_3,
3010                         bitcoin_signature_2: sig_4,
3011                         contents: unsigned_channel_announcement,
3012                 };
3013                 let encoded_value = channel_announcement.encode();
3014                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
3015                 if unknown_features_bits {
3016                         target_value.append(&mut <Vec<u8>>::from_hex("0002ffff").unwrap());
3017                 } else {
3018                         target_value.append(&mut <Vec<u8>>::from_hex("0000").unwrap());
3019                 }
3020                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3021                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
3022                 if excess_data {
3023                         target_value.append(&mut <Vec<u8>>::from_hex("0a00001400001e000028").unwrap());
3024                 }
3025                 assert_eq!(encoded_value, target_value);
3026         }
3027
3028         #[test]
3029         fn encoding_channel_announcement() {
3030                 do_encoding_channel_announcement(true, false);
3031                 do_encoding_channel_announcement(false, true);
3032                 do_encoding_channel_announcement(false, false);
3033                 do_encoding_channel_announcement(true, true);
3034         }
3035
3036         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) {
3037                 let secp_ctx = Secp256k1::new();
3038                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3039                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3040                 let features = if unknown_features_bits {
3041                         NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
3042                 } else {
3043                         // Set to some features we may support
3044                         NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
3045                 };
3046                 let mut addresses = Vec::new();
3047                 if ipv4 {
3048                         addresses.push(SocketAddress::TcpIpV4 {
3049                                 addr: [255, 254, 253, 252],
3050                                 port: 9735
3051                         });
3052                 }
3053                 if ipv6 {
3054                         addresses.push(SocketAddress::TcpIpV6 {
3055                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
3056                                 port: 9735
3057                         });
3058                 }
3059                 if onionv2 {
3060                         addresses.push(msgs::SocketAddress::OnionV2(
3061                                 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
3062                         ));
3063                 }
3064                 if onionv3 {
3065                         addresses.push(msgs::SocketAddress::OnionV3 {
3066                                 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],
3067                                 checksum: 32,
3068                                 version: 16,
3069                                 port: 9735
3070                         });
3071                 }
3072                 if hostname {
3073                         addresses.push(SocketAddress::Hostname {
3074                                 hostname: Hostname::try_from(String::from("host")).unwrap(),
3075                                 port: 9735,
3076                         });
3077                 }
3078                 let mut addr_len = 0;
3079                 for addr in &addresses {
3080                         addr_len += addr.len() + 1;
3081                 }
3082                 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
3083                         features,
3084                         timestamp: 20190119,
3085                         node_id: NodeId::from_pubkey(&pubkey_1),
3086                         rgb: [32; 3],
3087                         alias: NodeAlias([16;32]),
3088                         addresses,
3089                         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() },
3090                         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() },
3091                 };
3092                 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
3093                 let node_announcement = msgs::NodeAnnouncement {
3094                         signature: sig_1,
3095                         contents: unsigned_node_announcement,
3096                 };
3097                 let encoded_value = node_announcement.encode();
3098                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3099                 if unknown_features_bits {
3100                         target_value.append(&mut <Vec<u8>>::from_hex("0002ffff").unwrap());
3101                 } else {
3102                         target_value.append(&mut <Vec<u8>>::from_hex("000122").unwrap());
3103                 }
3104                 target_value.append(&mut <Vec<u8>>::from_hex("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
3105                 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
3106                 if ipv4 {
3107                         target_value.append(&mut <Vec<u8>>::from_hex("01fffefdfc2607").unwrap());
3108                 }
3109                 if ipv6 {
3110                         target_value.append(&mut <Vec<u8>>::from_hex("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
3111                 }
3112                 if onionv2 {
3113                         target_value.append(&mut <Vec<u8>>::from_hex("03fffefdfcfbfaf9f8f7f62607").unwrap());
3114                 }
3115                 if onionv3 {
3116                         target_value.append(&mut <Vec<u8>>::from_hex("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
3117                 }
3118                 if hostname {
3119                         target_value.append(&mut <Vec<u8>>::from_hex("0504686f73742607").unwrap());
3120                 }
3121                 if excess_address_data {
3122                         target_value.append(&mut <Vec<u8>>::from_hex("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
3123                 }
3124                 if excess_data {
3125                         target_value.append(&mut <Vec<u8>>::from_hex("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
3126                 }
3127                 assert_eq!(encoded_value, target_value);
3128         }
3129
3130         #[test]
3131         fn encoding_node_announcement() {
3132                 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
3133                 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
3134                 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
3135                 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
3136                 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
3137                 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
3138                 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
3139                 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
3140                 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
3141                 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
3142         }
3143
3144         fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
3145                 let secp_ctx = Secp256k1::new();
3146                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3147                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3148                 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
3149                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3150                         short_channel_id: 2316138423780173,
3151                         timestamp: 20190119,
3152                         flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
3153                         cltv_expiry_delta: 144,
3154                         htlc_minimum_msat: 1000000,
3155                         htlc_maximum_msat: 131355275467161,
3156                         fee_base_msat: 10000,
3157                         fee_proportional_millionths: 20,
3158                         excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
3159                 };
3160                 let channel_update = msgs::ChannelUpdate {
3161                         signature: sig_1,
3162                         contents: unsigned_channel_update
3163                 };
3164                 let encoded_value = channel_update.encode();
3165                 let mut target_value = <Vec<u8>>::from_hex("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3166                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3167                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d013413a7").unwrap());
3168                 target_value.append(&mut <Vec<u8>>::from_hex("01").unwrap());
3169                 target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3170                 if direction {
3171                         let flag = target_value.last_mut().unwrap();
3172                         *flag = 1;
3173                 }
3174                 if disable {
3175                         let flag = target_value.last_mut().unwrap();
3176                         *flag = *flag | 1 << 1;
3177                 }
3178                 target_value.append(&mut <Vec<u8>>::from_hex("009000000000000f42400000271000000014").unwrap());
3179                 target_value.append(&mut <Vec<u8>>::from_hex("0000777788889999").unwrap());
3180                 if excess_data {
3181                         target_value.append(&mut <Vec<u8>>::from_hex("000000003b9aca00").unwrap());
3182                 }
3183                 assert_eq!(encoded_value, target_value);
3184         }
3185
3186         #[test]
3187         fn encoding_channel_update() {
3188                 do_encoding_channel_update(false, false, false);
3189                 do_encoding_channel_update(false, false, true);
3190                 do_encoding_channel_update(true, false, false);
3191                 do_encoding_channel_update(true, false, true);
3192                 do_encoding_channel_update(false, true, false);
3193                 do_encoding_channel_update(false, true, true);
3194                 do_encoding_channel_update(true, true, false);
3195                 do_encoding_channel_update(true, true, true);
3196         }
3197
3198         fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
3199                 let secp_ctx = Secp256k1::new();
3200                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3201                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3202                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3203                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3204                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3205                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3206                 let open_channel = msgs::OpenChannel {
3207                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3208                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3209                         funding_satoshis: 1311768467284833366,
3210                         push_msat: 2536655962884945560,
3211                         dust_limit_satoshis: 3608586615801332854,
3212                         max_htlc_value_in_flight_msat: 8517154655701053848,
3213                         channel_reserve_satoshis: 8665828695742877976,
3214                         htlc_minimum_msat: 2316138423780173,
3215                         feerate_per_kw: 821716,
3216                         to_self_delay: 49340,
3217                         max_accepted_htlcs: 49340,
3218                         funding_pubkey: pubkey_1,
3219                         revocation_basepoint: pubkey_2,
3220                         payment_point: pubkey_3,
3221                         delayed_payment_basepoint: pubkey_4,
3222                         htlc_basepoint: pubkey_5,
3223                         first_per_commitment_point: pubkey_6,
3224                         channel_flags: if random_bit { 1 << 5 } else { 0 },
3225                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3226                         channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
3227                 };
3228                 let encoded_value = open_channel.encode();
3229                 let mut target_value = Vec::new();
3230                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3231                 target_value.append(&mut <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
3232                 if random_bit {
3233                         target_value.append(&mut <Vec<u8>>::from_hex("20").unwrap());
3234                 } else {
3235                         target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3236                 }
3237                 if shutdown {
3238                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3239                 }
3240                 if incl_chan_type {
3241                         target_value.append(&mut <Vec<u8>>::from_hex("0100").unwrap());
3242                 }
3243                 assert_eq!(encoded_value, target_value);
3244         }
3245
3246         #[test]
3247         fn encoding_open_channel() {
3248                 do_encoding_open_channel(false, false, false);
3249                 do_encoding_open_channel(false, false, true);
3250                 do_encoding_open_channel(false, true, false);
3251                 do_encoding_open_channel(false, true, true);
3252                 do_encoding_open_channel(true, false, false);
3253                 do_encoding_open_channel(true, false, true);
3254                 do_encoding_open_channel(true, true, false);
3255                 do_encoding_open_channel(true, true, true);
3256         }
3257
3258         fn do_encoding_open_channelv2(random_bit: bool, shutdown: bool, incl_chan_type: bool, require_confirmed_inputs: bool) {
3259                 let secp_ctx = Secp256k1::new();
3260                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3261                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3262                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3263                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3264                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3265                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3266                 let (_, pubkey_7) = get_keys_from!("0707070707070707070707070707070707070707070707070707070707070707", secp_ctx);
3267                 let open_channelv2 = msgs::OpenChannelV2 {
3268                         chain_hash: ChainHash::using_genesis_block(Network::Bitcoin),
3269                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3270                         funding_feerate_sat_per_1000_weight: 821716,
3271                         commitment_feerate_sat_per_1000_weight: 821716,
3272                         funding_satoshis: 1311768467284833366,
3273                         dust_limit_satoshis: 3608586615801332854,
3274                         max_htlc_value_in_flight_msat: 8517154655701053848,
3275                         htlc_minimum_msat: 2316138423780173,
3276                         to_self_delay: 49340,
3277                         max_accepted_htlcs: 49340,
3278                         locktime: 305419896,
3279                         funding_pubkey: pubkey_1,
3280                         revocation_basepoint: pubkey_2,
3281                         payment_basepoint: pubkey_3,
3282                         delayed_payment_basepoint: pubkey_4,
3283                         htlc_basepoint: pubkey_5,
3284                         first_per_commitment_point: pubkey_6,
3285                         second_per_commitment_point: pubkey_7,
3286                         channel_flags: if random_bit { 1 << 5 } else { 0 },
3287                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3288                         channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
3289                         require_confirmed_inputs: if require_confirmed_inputs { Some(()) } else { None },
3290                 };
3291                 let encoded_value = open_channelv2.encode();
3292                 let mut target_value = Vec::new();
3293                 target_value.append(&mut <Vec<u8>>::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3294                 target_value.append(&mut <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3295                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap());
3296                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap());
3297                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap());
3298                 target_value.append(&mut <Vec<u8>>::from_hex("3214466870114476").unwrap());
3299                 target_value.append(&mut <Vec<u8>>::from_hex("7633030896203198").unwrap());
3300                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d").unwrap());
3301                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap());
3302                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap());
3303                 target_value.append(&mut <Vec<u8>>::from_hex("12345678").unwrap());
3304                 target_value.append(&mut <Vec<u8>>::from_hex("031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap());
3305                 target_value.append(&mut <Vec<u8>>::from_hex("024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d0766").unwrap());
3306                 target_value.append(&mut <Vec<u8>>::from_hex("02531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe337").unwrap());
3307                 target_value.append(&mut <Vec<u8>>::from_hex("03462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
3308                 target_value.append(&mut <Vec<u8>>::from_hex("0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f7").unwrap());
3309                 target_value.append(&mut <Vec<u8>>::from_hex("03f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
3310                 target_value.append(&mut <Vec<u8>>::from_hex("02989c0b76cb563971fdc9bef31ec06c3560f3249d6ee9e5d83c57625596e05f6f").unwrap());
3311
3312                 if random_bit {
3313                         target_value.append(&mut <Vec<u8>>::from_hex("20").unwrap());
3314                 } else {
3315                         target_value.append(&mut <Vec<u8>>::from_hex("00").unwrap());
3316                 }
3317                 if shutdown {
3318                         target_value.append(&mut <Vec<u8>>::from_hex("001b").unwrap()); // Type 0 + Length 27
3319                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3320                 }
3321                 if incl_chan_type {
3322                         target_value.append(&mut <Vec<u8>>::from_hex("0100").unwrap());
3323                 }
3324                 if require_confirmed_inputs {
3325                         target_value.append(&mut <Vec<u8>>::from_hex("0200").unwrap());
3326                 }
3327                 assert_eq!(encoded_value, target_value);
3328         }
3329
3330         #[test]
3331         fn encoding_open_channelv2() {
3332                 do_encoding_open_channelv2(false, false, false, false);
3333                 do_encoding_open_channelv2(false, false, false, true);
3334                 do_encoding_open_channelv2(false, false, true, false);
3335                 do_encoding_open_channelv2(false, false, true, true);
3336                 do_encoding_open_channelv2(false, true, false, false);
3337                 do_encoding_open_channelv2(false, true, false, true);
3338                 do_encoding_open_channelv2(false, true, true, false);
3339                 do_encoding_open_channelv2(false, true, true, true);
3340                 do_encoding_open_channelv2(true, false, false, false);
3341                 do_encoding_open_channelv2(true, false, false, true);
3342                 do_encoding_open_channelv2(true, false, true, false);
3343                 do_encoding_open_channelv2(true, false, true, true);
3344                 do_encoding_open_channelv2(true, true, false, false);
3345                 do_encoding_open_channelv2(true, true, false, true);
3346                 do_encoding_open_channelv2(true, true, true, false);
3347                 do_encoding_open_channelv2(true, true, true, true);
3348         }
3349
3350         fn do_encoding_accept_channel(shutdown: bool) {
3351                 let secp_ctx = Secp256k1::new();
3352                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3353                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3354                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3355                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3356                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3357                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3358                 let accept_channel = msgs::AcceptChannel {
3359                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3360                         dust_limit_satoshis: 1311768467284833366,
3361                         max_htlc_value_in_flight_msat: 2536655962884945560,
3362                         channel_reserve_satoshis: 3608586615801332854,
3363                         htlc_minimum_msat: 2316138423780173,
3364                         minimum_depth: 821716,
3365                         to_self_delay: 49340,
3366                         max_accepted_htlcs: 49340,
3367                         funding_pubkey: pubkey_1,
3368                         revocation_basepoint: pubkey_2,
3369                         payment_point: pubkey_3,
3370                         delayed_payment_basepoint: pubkey_4,
3371                         htlc_basepoint: pubkey_5,
3372                         first_per_commitment_point: pubkey_6,
3373                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3374                         channel_type: None,
3375                         #[cfg(taproot)]
3376                         next_local_nonce: None,
3377                 };
3378                 let encoded_value = accept_channel.encode();
3379                 let mut target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
3380                 if shutdown {
3381                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3382                 }
3383                 assert_eq!(encoded_value, target_value);
3384         }
3385
3386         #[test]
3387         fn encoding_accept_channel() {
3388                 do_encoding_accept_channel(false);
3389                 do_encoding_accept_channel(true);
3390         }
3391
3392         fn do_encoding_accept_channelv2(shutdown: bool) {
3393                 let secp_ctx = Secp256k1::new();
3394                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3395                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3396                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3397                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3398                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
3399                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
3400                 let (_, pubkey_7) = get_keys_from!("0707070707070707070707070707070707070707070707070707070707070707", secp_ctx);
3401                 let accept_channelv2 = msgs::AcceptChannelV2 {
3402                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3403                         funding_satoshis: 1311768467284833366,
3404                         dust_limit_satoshis: 1311768467284833366,
3405                         max_htlc_value_in_flight_msat: 2536655962884945560,
3406                         htlc_minimum_msat: 2316138423780173,
3407                         minimum_depth: 821716,
3408                         to_self_delay: 49340,
3409                         max_accepted_htlcs: 49340,
3410                         funding_pubkey: pubkey_1,
3411                         revocation_basepoint: pubkey_2,
3412                         payment_basepoint: pubkey_3,
3413                         delayed_payment_basepoint: pubkey_4,
3414                         htlc_basepoint: pubkey_5,
3415                         first_per_commitment_point: pubkey_6,
3416                         second_per_commitment_point: pubkey_7,
3417                         shutdown_scriptpubkey: if shutdown { Some(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { None },
3418                         channel_type: None,
3419                         require_confirmed_inputs: None,
3420                 };
3421                 let encoded_value = accept_channelv2.encode();
3422                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // temporary_channel_id
3423                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap()); // funding_satoshis
3424                 target_value.append(&mut <Vec<u8>>::from_hex("1234567890123456").unwrap()); // dust_limit_satoshis
3425                 target_value.append(&mut <Vec<u8>>::from_hex("2334032891223698").unwrap()); // max_htlc_value_in_flight_msat
3426                 target_value.append(&mut <Vec<u8>>::from_hex("00083a840000034d").unwrap()); // htlc_minimum_msat
3427                 target_value.append(&mut <Vec<u8>>::from_hex("000c89d4").unwrap()); //  minimum_depth
3428                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap()); // to_self_delay
3429                 target_value.append(&mut <Vec<u8>>::from_hex("c0bc").unwrap()); // max_accepted_htlcs
3430                 target_value.append(&mut <Vec<u8>>::from_hex("031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap()); // funding_pubkey
3431                 target_value.append(&mut <Vec<u8>>::from_hex("024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d0766").unwrap()); // revocation_basepoint
3432                 target_value.append(&mut <Vec<u8>>::from_hex("02531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe337").unwrap()); // payment_basepoint
3433                 target_value.append(&mut <Vec<u8>>::from_hex("03462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap()); // delayed_payment_basepoint
3434                 target_value.append(&mut <Vec<u8>>::from_hex("0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f7").unwrap()); // htlc_basepoint
3435                 target_value.append(&mut <Vec<u8>>::from_hex("03f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap()); // first_per_commitment_point
3436                 target_value.append(&mut <Vec<u8>>::from_hex("02989c0b76cb563971fdc9bef31ec06c3560f3249d6ee9e5d83c57625596e05f6f").unwrap()); // second_per_commitment_point
3437                 if shutdown {
3438                         target_value.append(&mut <Vec<u8>>::from_hex("001b").unwrap()); // Type 0 + Length 27
3439                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3440                 }
3441                 assert_eq!(encoded_value, target_value);
3442         }
3443
3444         #[test]
3445         fn encoding_accept_channelv2() {
3446                 do_encoding_accept_channelv2(false);
3447                 do_encoding_accept_channelv2(true);
3448         }
3449
3450         #[test]
3451         fn encoding_funding_created() {
3452                 let secp_ctx = Secp256k1::new();
3453                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3454                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3455                 let funding_created = msgs::FundingCreated {
3456                         temporary_channel_id: ChannelId::from_bytes([2; 32]),
3457                         funding_txid: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
3458                         funding_output_index: 255,
3459                         signature: sig_1,
3460                         #[cfg(taproot)]
3461                         partial_signature_with_nonce: None,
3462                         #[cfg(taproot)]
3463                         next_local_nonce: None,
3464                 };
3465                 let encoded_value = funding_created.encode();
3466                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3467                 assert_eq!(encoded_value, target_value);
3468         }
3469
3470         #[test]
3471         fn encoding_funding_signed() {
3472                 let secp_ctx = Secp256k1::new();
3473                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3474                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3475                 let funding_signed = msgs::FundingSigned {
3476                         channel_id: ChannelId::from_bytes([2; 32]),
3477                         signature: sig_1,
3478                         #[cfg(taproot)]
3479                         partial_signature_with_nonce: None,
3480                 };
3481                 let encoded_value = funding_signed.encode();
3482                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3483                 assert_eq!(encoded_value, target_value);
3484         }
3485
3486         #[test]
3487         fn encoding_channel_ready() {
3488                 let secp_ctx = Secp256k1::new();
3489                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3490                 let channel_ready = msgs::ChannelReady {
3491                         channel_id: ChannelId::from_bytes([2; 32]),
3492                         next_per_commitment_point: pubkey_1,
3493                         short_channel_id_alias: None,
3494                 };
3495                 let encoded_value = channel_ready.encode();
3496                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
3497                 assert_eq!(encoded_value, target_value);
3498         }
3499
3500         #[test]
3501         fn encoding_splice() {
3502                 let secp_ctx = Secp256k1::new();
3503                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3504                 let splice = msgs::Splice {
3505                         chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3506                         channel_id: ChannelId::from_bytes([2; 32]),
3507                         relative_satoshis: 123456,
3508                         funding_feerate_perkw: 2000,
3509                         locktime: 0,
3510                         funding_pubkey: pubkey_1,
3511                 };
3512                 let encoded_value = splice.encode();
3513                 assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240000007d000000000031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3514         }
3515
3516         #[test]
3517         fn encoding_stfu() {
3518                 let stfu = msgs::Stfu {
3519                         channel_id: ChannelId::from_bytes([2; 32]),
3520                         initiator: 1,
3521                 };
3522                 let encoded_value = stfu.encode();
3523                 assert_eq!(encoded_value.as_hex().to_string(), "020202020202020202020202020202020202020202020202020202020202020201");
3524         }
3525
3526         #[test]
3527         fn encoding_splice_ack() {
3528                 let secp_ctx = Secp256k1::new();
3529                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3530                 let splice = msgs::SpliceAck {
3531                         chain_hash: ChainHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
3532                         channel_id: ChannelId::from_bytes([2; 32]),
3533                         relative_satoshis: 123456,
3534                         funding_pubkey: pubkey_1,
3535                 };
3536                 let encoded_value = splice.encode();
3537                 assert_eq!(encoded_value.as_hex().to_string(), "02020202020202020202020202020202020202020202020202020202020202026fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000000000000001e240031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f");
3538         }
3539
3540         #[test]
3541         fn encoding_splice_locked() {
3542                 let splice = msgs::SpliceLocked {
3543                         channel_id: ChannelId::from_bytes([2; 32]),
3544                 };
3545                 let encoded_value = splice.encode();
3546                 assert_eq!(encoded_value.as_hex().to_string(), "0202020202020202020202020202020202020202020202020202020202020202");
3547         }
3548
3549         #[test]
3550         fn encoding_tx_add_input() {
3551                 let tx_add_input = msgs::TxAddInput {
3552                         channel_id: ChannelId::from_bytes([2; 32]),
3553                         serial_id: 4886718345,
3554                         prevtx: TransactionU16LenLimited::new(Transaction {
3555                                 version: 2,
3556                                 lock_time: LockTime::ZERO,
3557                                 input: vec![TxIn {
3558                                         previous_output: OutPoint { txid: Txid::from_str("305bab643ee297b8b6b76b320792c8223d55082122cb606bf89382146ced9c77").unwrap(), index: 2 }.into_bitcoin_outpoint(),
3559                                         script_sig: ScriptBuf::new(),
3560                                         sequence: Sequence(0xfffffffd),
3561                                         witness: Witness::from_slice(&vec![
3562                                                 <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap(),
3563                                                 <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap()]),
3564                                 }],
3565                                 output: vec![
3566                                         TxOut {
3567                                                 value: 12704566,
3568                                                 script_pubkey: Address::from_str("bc1qzlffunw52jav8vwdu5x3jfk6sr8u22rmq3xzw2").unwrap().payload.script_pubkey(),
3569                                         },
3570                                         TxOut {
3571                                                 value: 245148,
3572                                                 script_pubkey: Address::from_str("bc1qxmk834g5marzm227dgqvynd23y2nvt2ztwcw2z").unwrap().payload.script_pubkey(),
3573                                         },
3574                                 ],
3575                         }).unwrap(),
3576                         prevtx_out: 305419896,
3577                         sequence: 305419896,
3578                 };
3579                 let encoded_value = tx_add_input.encode();
3580                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000000012345678900de02000000000101779ced6c148293f86b60cb222108553d22c89207326bb7b6b897e23e64ab5b300200000000fdffffff0236dbc1000000000016001417d29e4dd454bac3b1cde50d1926da80cfc5287b9cbd03000000000016001436ec78d514df462da95e6a00c24daa8915362d420247304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701210301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944000000001234567812345678").unwrap();
3581                 assert_eq!(encoded_value, target_value);
3582         }
3583
3584         #[test]
3585         fn encoding_tx_add_output() {
3586                 let tx_add_output = msgs::TxAddOutput {
3587                         channel_id: ChannelId::from_bytes([2; 32]),
3588                         serial_id: 4886718345,
3589                         sats: 4886718345,
3590                         script: Address::from_str("bc1qxmk834g5marzm227dgqvynd23y2nvt2ztwcw2z").unwrap().payload.script_pubkey(),
3591                 };
3592                 let encoded_value = tx_add_output.encode();
3593                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000000012345678900000001234567890016001436ec78d514df462da95e6a00c24daa8915362d42").unwrap();
3594                 assert_eq!(encoded_value, target_value);
3595         }
3596
3597         #[test]
3598         fn encoding_tx_remove_input() {
3599                 let tx_remove_input = msgs::TxRemoveInput {
3600                         channel_id: ChannelId::from_bytes([2; 32]),
3601                         serial_id: 4886718345,
3602                 };
3603                 let encoded_value = tx_remove_input.encode();
3604                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020000000123456789").unwrap();
3605                 assert_eq!(encoded_value, target_value);
3606         }
3607
3608         #[test]
3609         fn encoding_tx_remove_output() {
3610                 let tx_remove_output = msgs::TxRemoveOutput {
3611                         channel_id: ChannelId::from_bytes([2; 32]),
3612                         serial_id: 4886718345,
3613                 };
3614                 let encoded_value = tx_remove_output.encode();
3615                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020000000123456789").unwrap();
3616                 assert_eq!(encoded_value, target_value);
3617         }
3618
3619         #[test]
3620         fn encoding_tx_complete() {
3621                 let tx_complete = msgs::TxComplete {
3622                         channel_id: ChannelId::from_bytes([2; 32]),
3623                 };
3624                 let encoded_value = tx_complete.encode();
3625                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3626                 assert_eq!(encoded_value, target_value);
3627         }
3628
3629         #[test]
3630         fn encoding_tx_signatures() {
3631                 let tx_signatures = msgs::TxSignatures {
3632                         channel_id: ChannelId::from_bytes([2; 32]),
3633                         tx_hash: Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
3634                         witnesses: vec![
3635                                 Witness::from_slice(&vec![
3636                                         <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap(),
3637                                         <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap()]),
3638                                 Witness::from_slice(&vec![
3639                                         <Vec<u8>>::from_hex("3045022100ee00dbf4a862463e837d7c08509de814d620e4d9830fa84818713e0fa358f145022021c3c7060c4d53fe84fd165d60208451108a778c13b92ca4c6bad439236126cc01").unwrap(),
3640                                         <Vec<u8>>::from_hex("028fbbf0b16f5ba5bcb5dd37cd4047ce6f726a21c06682f9ec2f52b057de1dbdb5").unwrap()]),
3641                         ],
3642                 };
3643                 let encoded_value = tx_signatures.encode();
3644                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // channel_id
3645                 target_value.append(&mut <Vec<u8>>::from_hex("6e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c2").unwrap()); // tx_hash (sha256) (big endian byte order)
3646                 target_value.append(&mut <Vec<u8>>::from_hex("0002").unwrap()); // num_witnesses (u16)
3647                 // Witness 1
3648                 target_value.append(&mut <Vec<u8>>::from_hex("006b").unwrap()); // len of witness_data
3649                 target_value.append(&mut <Vec<u8>>::from_hex("02").unwrap()); // num_witness_elements (VarInt)
3650                 target_value.append(&mut <Vec<u8>>::from_hex("47").unwrap()); // len of witness element data (VarInt)
3651                 target_value.append(&mut <Vec<u8>>::from_hex("304402206af85b7dd67450ad12c979302fac49dfacbc6a8620f49c5da2b5721cf9565ca502207002b32fed9ce1bf095f57aeb10c36928ac60b12e723d97d2964a54640ceefa701").unwrap());
3652                 target_value.append(&mut <Vec<u8>>::from_hex("21").unwrap()); // len of witness element data (VarInt)
3653                 target_value.append(&mut <Vec<u8>>::from_hex("0301ab7dc16488303549bfcdd80f6ae5ee4c20bf97ab5410bbd6b1bfa85dcd6944").unwrap());
3654                 // Witness 2
3655                 target_value.append(&mut <Vec<u8>>::from_hex("006c").unwrap()); // len of witness_data
3656                 target_value.append(&mut <Vec<u8>>::from_hex("02").unwrap()); // num_witness_elements (VarInt)
3657                 target_value.append(&mut <Vec<u8>>::from_hex("48").unwrap()); // len of witness element data (VarInt)
3658                 target_value.append(&mut <Vec<u8>>::from_hex("3045022100ee00dbf4a862463e837d7c08509de814d620e4d9830fa84818713e0fa358f145022021c3c7060c4d53fe84fd165d60208451108a778c13b92ca4c6bad439236126cc01").unwrap());
3659                 target_value.append(&mut <Vec<u8>>::from_hex("21").unwrap()); // len of witness element data (VarInt)
3660                 target_value.append(&mut <Vec<u8>>::from_hex("028fbbf0b16f5ba5bcb5dd37cd4047ce6f726a21c06682f9ec2f52b057de1dbdb5").unwrap());
3661                 assert_eq!(encoded_value, target_value);
3662         }
3663
3664         fn do_encoding_tx_init_rbf(funding_value_with_hex_target: Option<(i64, &str)>) {
3665                 let tx_init_rbf = msgs::TxInitRbf {
3666                         channel_id: ChannelId::from_bytes([2; 32]),
3667                         locktime: 305419896,
3668                         feerate_sat_per_1000_weight: 20190119,
3669                         funding_output_contribution: if let Some((value, _)) = funding_value_with_hex_target { Some(value) } else { None },
3670                 };
3671                 let encoded_value = tx_init_rbf.encode();
3672                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap(); // channel_id
3673                 target_value.append(&mut <Vec<u8>>::from_hex("12345678").unwrap()); // locktime
3674                 target_value.append(&mut <Vec<u8>>::from_hex("013413a7").unwrap()); // feerate_sat_per_1000_weight
3675                 if let Some((_, target)) = funding_value_with_hex_target {
3676                         target_value.push(0x00); // Type
3677                         target_value.push(target.len() as u8 / 2); // Length
3678                         target_value.append(&mut <Vec<u8>>::from_hex(target).unwrap()); // Value (i64)
3679                 }
3680                 assert_eq!(encoded_value, target_value);
3681         }
3682
3683         #[test]
3684         fn encoding_tx_init_rbf() {
3685                 do_encoding_tx_init_rbf(Some((1311768467284833366, "1234567890123456")));
3686                 do_encoding_tx_init_rbf(Some((13117684672, "000000030DDFFBC0")));
3687                 do_encoding_tx_init_rbf(None);
3688         }
3689
3690         fn do_encoding_tx_ack_rbf(funding_value_with_hex_target: Option<(i64, &str)>) {
3691                 let tx_ack_rbf = msgs::TxAckRbf {
3692                         channel_id: ChannelId::from_bytes([2; 32]),
3693                         funding_output_contribution: if let Some((value, _)) = funding_value_with_hex_target { Some(value) } else { None },
3694                 };
3695                 let encoded_value = tx_ack_rbf.encode();
3696                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3697                 if let Some((_, target)) = funding_value_with_hex_target {
3698                         target_value.push(0x00); // Type
3699                         target_value.push(target.len() as u8 / 2); // Length
3700                         target_value.append(&mut <Vec<u8>>::from_hex(target).unwrap()); // Value (i64)
3701                 }
3702                 assert_eq!(encoded_value, target_value);
3703         }
3704
3705         #[test]
3706         fn encoding_tx_ack_rbf() {
3707                 do_encoding_tx_ack_rbf(Some((1311768467284833366, "1234567890123456")));
3708                 do_encoding_tx_ack_rbf(Some((13117684672, "000000030DDFFBC0")));
3709                 do_encoding_tx_ack_rbf(None);
3710         }
3711
3712         #[test]
3713         fn encoding_tx_abort() {
3714                 let tx_abort = msgs::TxAbort {
3715                         channel_id: ChannelId::from_bytes([2; 32]),
3716                         data: <Vec<u8>>::from_hex("54686520717569636B2062726F776E20666F78206A756D7073206F76657220746865206C617A7920646F672E").unwrap(),
3717                 };
3718                 let encoded_value = tx_abort.encode();
3719                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202002C54686520717569636B2062726F776E20666F78206A756D7073206F76657220746865206C617A7920646F672E").unwrap();
3720                 assert_eq!(encoded_value, target_value);
3721         }
3722
3723         fn do_encoding_shutdown(script_type: u8) {
3724                 let secp_ctx = Secp256k1::new();
3725                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3726                 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
3727                 let shutdown = msgs::Shutdown {
3728                         channel_id: ChannelId::from_bytes([2; 32]),
3729                         scriptpubkey:
3730                                 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
3731                                 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
3732                                 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
3733                                 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
3734                 };
3735                 let encoded_value = shutdown.encode();
3736                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
3737                 if script_type == 1 {
3738                         target_value.append(&mut <Vec<u8>>::from_hex("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
3739                 } else if script_type == 2 {
3740                         target_value.append(&mut <Vec<u8>>::from_hex("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
3741                 } else if script_type == 3 {
3742                         target_value.append(&mut <Vec<u8>>::from_hex("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
3743                 } else if script_type == 4 {
3744                         target_value.append(&mut <Vec<u8>>::from_hex("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
3745                 }
3746                 assert_eq!(encoded_value, target_value);
3747         }
3748
3749         #[test]
3750         fn encoding_shutdown() {
3751                 do_encoding_shutdown(1);
3752                 do_encoding_shutdown(2);
3753                 do_encoding_shutdown(3);
3754                 do_encoding_shutdown(4);
3755         }
3756
3757         #[test]
3758         fn encoding_closing_signed() {
3759                 let secp_ctx = Secp256k1::new();
3760                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3761                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3762                 let closing_signed = msgs::ClosingSigned {
3763                         channel_id: ChannelId::from_bytes([2; 32]),
3764                         fee_satoshis: 2316138423780173,
3765                         signature: sig_1,
3766                         fee_range: None,
3767                 };
3768                 let encoded_value = closing_signed.encode();
3769                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3770                 assert_eq!(encoded_value, target_value);
3771                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
3772
3773                 let closing_signed_with_range = msgs::ClosingSigned {
3774                         channel_id: ChannelId::from_bytes([2; 32]),
3775                         fee_satoshis: 2316138423780173,
3776                         signature: sig_1,
3777                         fee_range: Some(msgs::ClosingSignedFeeRange {
3778                                 min_fee_satoshis: 0xdeadbeef,
3779                                 max_fee_satoshis: 0x1badcafe01234567,
3780                         }),
3781                 };
3782                 let encoded_value_with_range = closing_signed_with_range.encode();
3783                 let target_value_with_range = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
3784                 assert_eq!(encoded_value_with_range, target_value_with_range);
3785                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
3786                         closing_signed_with_range);
3787         }
3788
3789         #[test]
3790         fn encoding_update_add_htlc() {
3791                 let secp_ctx = Secp256k1::new();
3792                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3793                 let onion_routing_packet = msgs::OnionPacket {
3794                         version: 255,
3795                         public_key: Ok(pubkey_1),
3796                         hop_data: [1; 20*65],
3797                         hmac: [2; 32]
3798                 };
3799                 let update_add_htlc = msgs::UpdateAddHTLC {
3800                         channel_id: ChannelId::from_bytes([2; 32]),
3801                         htlc_id: 2316138423780173,
3802                         amount_msat: 3608586615801332854,
3803                         payment_hash: PaymentHash([1; 32]),
3804                         cltv_expiry: 821716,
3805                         onion_routing_packet,
3806                         skimmed_fee_msat: None,
3807                         blinding_point: None,
3808                 };
3809                 let encoded_value = update_add_htlc.encode();
3810                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
3811                 assert_eq!(encoded_value, target_value);
3812         }
3813
3814         #[test]
3815         fn encoding_update_fulfill_htlc() {
3816                 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
3817                         channel_id: ChannelId::from_bytes([2; 32]),
3818                         htlc_id: 2316138423780173,
3819                         payment_preimage: PaymentPreimage([1; 32]),
3820                 };
3821                 let encoded_value = update_fulfill_htlc.encode();
3822                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
3823                 assert_eq!(encoded_value, target_value);
3824         }
3825
3826         #[test]
3827         fn encoding_update_fail_htlc() {
3828                 let reason = OnionErrorPacket {
3829                         data: [1; 32].to_vec(),
3830                 };
3831                 let update_fail_htlc = msgs::UpdateFailHTLC {
3832                         channel_id: ChannelId::from_bytes([2; 32]),
3833                         htlc_id: 2316138423780173,
3834                         reason
3835                 };
3836                 let encoded_value = update_fail_htlc.encode();
3837                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
3838                 assert_eq!(encoded_value, target_value);
3839         }
3840
3841         #[test]
3842         fn encoding_update_fail_malformed_htlc() {
3843                 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
3844                         channel_id: ChannelId::from_bytes([2; 32]),
3845                         htlc_id: 2316138423780173,
3846                         sha256_of_onion: [1; 32],
3847                         failure_code: 255
3848                 };
3849                 let encoded_value = update_fail_malformed_htlc.encode();
3850                 let target_value = <Vec<u8>>::from_hex("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
3851                 assert_eq!(encoded_value, target_value);
3852         }
3853
3854         fn do_encoding_commitment_signed(htlcs: bool) {
3855                 let secp_ctx = Secp256k1::new();
3856                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3857                 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
3858                 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
3859                 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
3860                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
3861                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
3862                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
3863                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
3864                 let commitment_signed = msgs::CommitmentSigned {
3865                         channel_id: ChannelId::from_bytes([2; 32]),
3866                         signature: sig_1,
3867                         htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
3868                         #[cfg(taproot)]
3869                         partial_signature_with_nonce: None,
3870                 };
3871                 let encoded_value = commitment_signed.encode();
3872                 let mut target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
3873                 if htlcs {
3874                         target_value.append(&mut <Vec<u8>>::from_hex("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
3875                 } else {
3876                         target_value.append(&mut <Vec<u8>>::from_hex("0000").unwrap());
3877                 }
3878                 assert_eq!(encoded_value, target_value);
3879         }
3880
3881         #[test]
3882         fn encoding_commitment_signed() {
3883                 do_encoding_commitment_signed(true);
3884                 do_encoding_commitment_signed(false);
3885         }
3886
3887         #[test]
3888         fn encoding_revoke_and_ack() {
3889                 let secp_ctx = Secp256k1::new();
3890                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
3891                 let raa = msgs::RevokeAndACK {
3892                         channel_id: ChannelId::from_bytes([2; 32]),
3893                         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],
3894                         next_per_commitment_point: pubkey_1,
3895                         #[cfg(taproot)]
3896                         next_local_nonce: None,
3897                 };
3898                 let encoded_value = raa.encode();
3899                 let target_value = <Vec<u8>>::from_hex("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
3900                 assert_eq!(encoded_value, target_value);
3901         }
3902
3903         #[test]
3904         fn encoding_update_fee() {
3905                 let update_fee = msgs::UpdateFee {
3906                         channel_id: ChannelId::from_bytes([2; 32]),
3907                         feerate_per_kw: 20190119,
3908                 };
3909                 let encoded_value = update_fee.encode();
3910                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
3911                 assert_eq!(encoded_value, target_value);
3912         }
3913
3914         #[test]
3915         fn encoding_init() {
3916                 let mainnet_hash = ChainHash::using_genesis_block(Network::Bitcoin);
3917                 assert_eq!(msgs::Init {
3918                         features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
3919                         networks: Some(vec![mainnet_hash]),
3920                         remote_network_address: None,
3921                 }.encode(), <Vec<u8>>::from_hex("00023fff0003ffffff01206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3922                 assert_eq!(msgs::Init {
3923                         features: InitFeatures::from_le_bytes(vec![0xFF]),
3924                         networks: None,
3925                         remote_network_address: None,
3926                 }.encode(), <Vec<u8>>::from_hex("0001ff0001ff").unwrap());
3927                 assert_eq!(msgs::Init {
3928                         features: InitFeatures::from_le_bytes(vec![]),
3929                         networks: Some(vec![mainnet_hash]),
3930                         remote_network_address: None,
3931                 }.encode(), <Vec<u8>>::from_hex("0000000001206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap());
3932                 assert_eq!(msgs::Init {
3933                         features: InitFeatures::from_le_bytes(vec![]),
3934                         networks: Some(vec![ChainHash::from(&[1; 32]), ChainHash::from(&[2; 32])]),
3935                         remote_network_address: None,
3936                 }.encode(), <Vec<u8>>::from_hex("00000000014001010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap());
3937                 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
3938                         networks: Some(vec![mainnet_hash]),
3939                         remote_network_address: Some(SocketAddress::TcpIpV4 {
3940                                 addr: [127, 0, 0, 1],
3941                                 port: 1000,
3942                         }),
3943                 };
3944                 let encoded_value = init_msg.encode();
3945                 let target_value = <Vec<u8>>::from_hex("0000000001206fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d61900000000000307017f00000103e8").unwrap();
3946                 assert_eq!(encoded_value, target_value);
3947                 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
3948         }
3949
3950         #[test]
3951         fn encoding_error() {
3952                 let error = msgs::ErrorMessage {
3953                         channel_id: ChannelId::from_bytes([2; 32]),
3954                         data: String::from("rust-lightning"),
3955                 };
3956                 let encoded_value = error.encode();
3957                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
3958                 assert_eq!(encoded_value, target_value);
3959         }
3960
3961         #[test]
3962         fn encoding_warning() {
3963                 let error = msgs::WarningMessage {
3964                         channel_id: ChannelId::from_bytes([2; 32]),
3965                         data: String::from("rust-lightning"),
3966                 };
3967                 let encoded_value = error.encode();
3968                 let target_value = <Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
3969                 assert_eq!(encoded_value, target_value);
3970         }
3971
3972         #[test]
3973         fn encoding_ping() {
3974                 let ping = msgs::Ping {
3975                         ponglen: 64,
3976                         byteslen: 64
3977                 };
3978                 let encoded_value = ping.encode();
3979                 let target_value = <Vec<u8>>::from_hex("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
3980                 assert_eq!(encoded_value, target_value);
3981         }
3982
3983         #[test]
3984         fn encoding_pong() {
3985                 let pong = msgs::Pong {
3986                         byteslen: 64
3987                 };
3988                 let encoded_value = pong.encode();
3989                 let target_value = <Vec<u8>>::from_hex("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
3990                 assert_eq!(encoded_value, target_value);
3991         }
3992
3993         #[test]
3994         fn encoding_nonfinal_onion_hop_data() {
3995                 let outbound_msg = msgs::OutboundOnionPayload::Forward {
3996                         short_channel_id: 0xdeadbeef1bad1dea,
3997                         amt_to_forward: 0x0badf00d01020304,
3998                         outgoing_cltv_value: 0xffffffff,
3999                 };
4000                 let encoded_value = outbound_msg.encode();
4001                 let target_value = <Vec<u8>>::from_hex("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
4002                 assert_eq!(encoded_value, target_value);
4003
4004                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4005                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4006                 if let msgs::InboundOnionPayload::Forward {
4007                         short_channel_id, amt_to_forward, outgoing_cltv_value
4008                 } = inbound_msg {
4009                         assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
4010                         assert_eq!(amt_to_forward, 0x0badf00d01020304);
4011                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4012                 } else { panic!(); }
4013         }
4014
4015         #[test]
4016         fn encoding_final_onion_hop_data() {
4017                 let outbound_msg = msgs::OutboundOnionPayload::Receive {
4018                         payment_data: None,
4019                         payment_metadata: None,
4020                         keysend_preimage: None,
4021                         sender_intended_htlc_amt_msat: 0x0badf00d01020304,
4022                         cltv_expiry_height: 0xffffffff,
4023                         custom_tlvs: vec![],
4024                 };
4025                 let encoded_value = outbound_msg.encode();
4026                 let target_value = <Vec<u8>>::from_hex("1002080badf00d010203040404ffffffff").unwrap();
4027                 assert_eq!(encoded_value, target_value);
4028
4029                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4030                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4031                 if let msgs::InboundOnionPayload::Receive {
4032                         payment_data: None, sender_intended_htlc_amt_msat, cltv_expiry_height, ..
4033                 } = inbound_msg {
4034                         assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
4035                         assert_eq!(cltv_expiry_height, 0xffffffff);
4036                 } else { panic!(); }
4037         }
4038
4039         #[test]
4040         fn encoding_final_onion_hop_data_with_secret() {
4041                 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
4042                 let outbound_msg = msgs::OutboundOnionPayload::Receive {
4043                         payment_data: Some(FinalOnionHopData {
4044                                 payment_secret: expected_payment_secret,
4045                                 total_msat: 0x1badca1f
4046                         }),
4047                         payment_metadata: None,
4048                         keysend_preimage: None,
4049                         sender_intended_htlc_amt_msat: 0x0badf00d01020304,
4050                         cltv_expiry_height: 0xffffffff,
4051                         custom_tlvs: vec![],
4052                 };
4053                 let encoded_value = outbound_msg.encode();
4054                 let target_value = <Vec<u8>>::from_hex("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
4055                 assert_eq!(encoded_value, target_value);
4056
4057                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4058                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4059                 if let msgs::InboundOnionPayload::Receive {
4060                         payment_data: Some(FinalOnionHopData {
4061                                 payment_secret,
4062                                 total_msat: 0x1badca1f
4063                         }),
4064                         sender_intended_htlc_amt_msat, cltv_expiry_height,
4065                         payment_metadata: None,
4066                         keysend_preimage: None,
4067                         custom_tlvs,
4068                 } = inbound_msg  {
4069                         assert_eq!(payment_secret, expected_payment_secret);
4070                         assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
4071                         assert_eq!(cltv_expiry_height, 0xffffffff);
4072                         assert_eq!(custom_tlvs, vec![]);
4073                 } else { panic!(); }
4074         }
4075
4076         #[test]
4077         fn encoding_final_onion_hop_data_with_bad_custom_tlvs() {
4078                 // If custom TLVs have type number within the range reserved for protocol, treat them as if
4079                 // they're unknown
4080                 let bad_type_range_tlvs = vec![
4081                         ((1 << 16) - 4, vec![42]),
4082                         ((1 << 16) - 2, vec![42; 32]),
4083                 ];
4084                 let mut msg = msgs::OutboundOnionPayload::Receive {
4085                         payment_data: None,
4086                         payment_metadata: None,
4087                         keysend_preimage: None,
4088                         custom_tlvs: bad_type_range_tlvs,
4089                         sender_intended_htlc_amt_msat: 0x0badf00d01020304,
4090                         cltv_expiry_height: 0xffffffff,
4091                 };
4092                 let encoded_value = msg.encode();
4093                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4094                 assert!(msgs::InboundOnionPayload::read(&mut Cursor::new(&encoded_value[..]), (None, &&node_signer)).is_err());
4095                 let good_type_range_tlvs = vec![
4096                         ((1 << 16) - 3, vec![42]),
4097                         ((1 << 16) - 1, vec![42; 32]),
4098                 ];
4099                 if let msgs::OutboundOnionPayload::Receive { ref mut custom_tlvs, .. } = msg {
4100                         *custom_tlvs = good_type_range_tlvs.clone();
4101                 }
4102                 let encoded_value = msg.encode();
4103                 let inbound_msg = ReadableArgs::read(&mut Cursor::new(&encoded_value[..]), (None, &&node_signer)).unwrap();
4104                 match inbound_msg {
4105                         msgs::InboundOnionPayload::Receive { custom_tlvs, .. } => assert!(custom_tlvs.is_empty()),
4106                         _ => panic!(),
4107                 }
4108         }
4109
4110         #[test]
4111         fn encoding_final_onion_hop_data_with_custom_tlvs() {
4112                 let expected_custom_tlvs = vec![
4113                         (5482373483, vec![0x12, 0x34]),
4114                         (5482373487, vec![0x42u8; 8]),
4115                 ];
4116                 let msg = msgs::OutboundOnionPayload::Receive {
4117                         payment_data: None,
4118                         payment_metadata: None,
4119                         keysend_preimage: None,
4120                         custom_tlvs: expected_custom_tlvs.clone(),
4121                         sender_intended_htlc_amt_msat: 0x0badf00d01020304,
4122                         cltv_expiry_height: 0xffffffff,
4123                 };
4124                 let encoded_value = msg.encode();
4125                 let target_value = <Vec<u8>>::from_hex("2e02080badf00d010203040404ffffffffff0000000146c6616b021234ff0000000146c6616f084242424242424242").unwrap();
4126                 assert_eq!(encoded_value, target_value);
4127                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4128                 let inbound_msg: msgs::InboundOnionPayload = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
4129                 if let msgs::InboundOnionPayload::Receive {
4130                         payment_data: None,
4131                         payment_metadata: None,
4132                         keysend_preimage: None,
4133                         custom_tlvs,
4134                         sender_intended_htlc_amt_msat,
4135                         cltv_expiry_height: outgoing_cltv_value,
4136                         ..
4137                 } = inbound_msg {
4138                         assert_eq!(custom_tlvs, expected_custom_tlvs);
4139                         assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
4140                         assert_eq!(outgoing_cltv_value, 0xffffffff);
4141                 } else { panic!(); }
4142         }
4143
4144         #[test]
4145         fn query_channel_range_end_blocknum() {
4146                 let tests: Vec<(u32, u32, u32)> = vec![
4147                         (10000, 1500, 11500),
4148                         (0, 0xffffffff, 0xffffffff),
4149                         (1, 0xffffffff, 0xffffffff),
4150                 ];
4151
4152                 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
4153                         let sut = msgs::QueryChannelRange {
4154                                 chain_hash: ChainHash::using_genesis_block(Network::Regtest),
4155                                 first_blocknum,
4156                                 number_of_blocks,
4157                         };
4158                         assert_eq!(sut.end_blocknum(), expected);
4159                 }
4160         }
4161
4162         #[test]
4163         fn encoding_query_channel_range() {
4164                 let mut query_channel_range = msgs::QueryChannelRange {
4165                         chain_hash: ChainHash::using_genesis_block(Network::Regtest),
4166                         first_blocknum: 100000,
4167                         number_of_blocks: 1500,
4168                 };
4169                 let encoded_value = query_channel_range.encode();
4170                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000186a0000005dc").unwrap();
4171                 assert_eq!(encoded_value, target_value);
4172
4173                 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4174                 assert_eq!(query_channel_range.first_blocknum, 100000);
4175                 assert_eq!(query_channel_range.number_of_blocks, 1500);
4176         }
4177
4178         #[test]
4179         fn encoding_reply_channel_range() {
4180                 do_encoding_reply_channel_range(0);
4181                 do_encoding_reply_channel_range(1);
4182         }
4183
4184         fn do_encoding_reply_channel_range(encoding_type: u8) {
4185                 let mut target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f000b8a06000005dc01").unwrap();
4186                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4187                 let mut reply_channel_range = msgs::ReplyChannelRange {
4188                         chain_hash: expected_chain_hash,
4189                         first_blocknum: 756230,
4190                         number_of_blocks: 1500,
4191                         sync_complete: true,
4192                         short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
4193                 };
4194
4195                 if encoding_type == 0 {
4196                         target_value.append(&mut <Vec<u8>>::from_hex("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
4197                         let encoded_value = reply_channel_range.encode();
4198                         assert_eq!(encoded_value, target_value);
4199
4200                         reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4201                         assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
4202                         assert_eq!(reply_channel_range.first_blocknum, 756230);
4203                         assert_eq!(reply_channel_range.number_of_blocks, 1500);
4204                         assert_eq!(reply_channel_range.sync_complete, true);
4205                         assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
4206                         assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
4207                         assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
4208                 } else {
4209                         target_value.append(&mut <Vec<u8>>::from_hex("001601789c636000833e08659309a65878be010010a9023a").unwrap());
4210                         let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
4211                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
4212                 }
4213         }
4214
4215         #[test]
4216         fn encoding_query_short_channel_ids() {
4217                 do_encoding_query_short_channel_ids(0);
4218                 do_encoding_query_short_channel_ids(1);
4219         }
4220
4221         fn do_encoding_query_short_channel_ids(encoding_type: u8) {
4222                 let mut target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
4223                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4224                 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
4225                         chain_hash: expected_chain_hash,
4226                         short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
4227                 };
4228
4229                 if encoding_type == 0 {
4230                         target_value.append(&mut <Vec<u8>>::from_hex("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
4231                         let encoded_value = query_short_channel_ids.encode();
4232                         assert_eq!(encoded_value, target_value);
4233
4234                         query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4235                         assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
4236                         assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
4237                         assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
4238                         assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
4239                 } else {
4240                         target_value.append(&mut <Vec<u8>>::from_hex("001601789c636000833e08659309a65878be010010a9023a").unwrap());
4241                         let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
4242                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
4243                 }
4244         }
4245
4246         #[test]
4247         fn encoding_reply_short_channel_ids_end() {
4248                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4249                 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
4250                         chain_hash: expected_chain_hash,
4251                         full_information: true,
4252                 };
4253                 let encoded_value = reply_short_channel_ids_end.encode();
4254                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f01").unwrap();
4255                 assert_eq!(encoded_value, target_value);
4256
4257                 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4258                 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
4259                 assert_eq!(reply_short_channel_ids_end.full_information, true);
4260         }
4261
4262         #[test]
4263         fn encoding_gossip_timestamp_filter(){
4264                 let expected_chain_hash = ChainHash::using_genesis_block(Network::Regtest);
4265                 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
4266                         chain_hash: expected_chain_hash,
4267                         first_timestamp: 1590000000,
4268                         timestamp_range: 0xffff_ffff,
4269                 };
4270                 let encoded_value = gossip_timestamp_filter.encode();
4271                 let target_value = <Vec<u8>>::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f5ec57980ffffffff").unwrap();
4272                 assert_eq!(encoded_value, target_value);
4273
4274                 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
4275                 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
4276                 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
4277                 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
4278         }
4279
4280         #[test]
4281         fn decode_onion_hop_data_len_as_bigsize() {
4282                 // Tests that we can decode an onion payload that is >253 bytes.
4283                 // Previously, receiving a payload of this size could've caused us to fail to decode a valid
4284                 // payload, because we were decoding the length (a BigSize, big-endian) as a VarInt
4285                 // (little-endian).
4286
4287                 // Encode a test onion payload with a big custom TLV such that it's >253 bytes, forcing the
4288                 // payload length to be encoded over multiple bytes rather than a single u8.
4289                 let big_payload = encode_big_payload().unwrap();
4290                 let mut rd = Cursor::new(&big_payload[..]);
4291
4292                 let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
4293                 <msgs::InboundOnionPayload as ReadableArgs<(Option<PublicKey>, &&test_utils::TestKeysInterface)>>
4294                         ::read(&mut rd, (None, &&node_signer)).unwrap();
4295         }
4296         // see above test, needs to be a separate method for use of the serialization macros.
4297         fn encode_big_payload() -> Result<Vec<u8>, io::Error> {
4298                 use crate::util::ser::HighZeroBytesDroppedBigSize;
4299                 let payload = msgs::OutboundOnionPayload::Forward {
4300                         short_channel_id: 0xdeadbeef1bad1dea,
4301                         amt_to_forward: 1000,
4302                         outgoing_cltv_value: 0xffffffff,
4303                 };
4304                 let mut encoded_payload = Vec::new();
4305                 let test_bytes = vec![42u8; 1000];
4306                 if let msgs::OutboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } = payload {
4307                         _encode_varint_length_prefixed_tlv!(&mut encoded_payload, {
4308                                 (1, test_bytes, required_vec),
4309                                 (2, HighZeroBytesDroppedBigSize(amt_to_forward), required),
4310                                 (4, HighZeroBytesDroppedBigSize(outgoing_cltv_value), required),
4311                                 (6, short_channel_id, required)
4312                         });
4313                 }
4314                 Ok(encoded_payload)
4315         }
4316
4317         #[test]
4318         #[cfg(feature = "std")]
4319         fn test_socket_address_from_str() {
4320                 let tcpip_v4 = SocketAddress::TcpIpV4 {
4321                         addr: Ipv4Addr::new(127, 0, 0, 1).octets(),
4322                         port: 1234,
4323                 };
4324                 assert_eq!(tcpip_v4, SocketAddress::from_str("127.0.0.1:1234").unwrap());
4325                 assert_eq!(tcpip_v4, SocketAddress::from_str(&tcpip_v4.to_string()).unwrap());
4326
4327                 let tcpip_v6 = SocketAddress::TcpIpV6 {
4328                         addr: Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).octets(),
4329                         port: 1234,
4330                 };
4331                 assert_eq!(tcpip_v6, SocketAddress::from_str("[0:0:0:0:0:0:0:1]:1234").unwrap());
4332                 assert_eq!(tcpip_v6, SocketAddress::from_str(&tcpip_v6.to_string()).unwrap());
4333
4334                 let hostname = SocketAddress::Hostname {
4335                                 hostname: Hostname::try_from("lightning-node.mydomain.com".to_string()).unwrap(),
4336                                 port: 1234,
4337                 };
4338                 assert_eq!(hostname, SocketAddress::from_str("lightning-node.mydomain.com:1234").unwrap());
4339                 assert_eq!(hostname, SocketAddress::from_str(&hostname.to_string()).unwrap());
4340
4341                 let onion_v2 = SocketAddress::OnionV2 ([40, 4, 64, 185, 202, 19, 162, 75, 90, 200, 38, 7],);
4342                 assert_eq!("OnionV2([40, 4, 64, 185, 202, 19, 162, 75, 90, 200, 38, 7])", &onion_v2.to_string());
4343                 assert_eq!(Err(SocketAddressParseError::InvalidOnionV3), SocketAddress::from_str("FACEBOOKCOREWWWI.onion:9735"));
4344
4345                 let onion_v3 = SocketAddress::OnionV3 {
4346                         ed25519_pubkey: [37, 24, 75, 5, 25, 73, 117, 194, 139, 102, 182, 107, 4, 105, 247, 246, 85,
4347                         111, 177, 172, 49, 137, 167, 155, 64, 221, 163, 47, 31, 33, 71, 3],
4348                         checksum: 48326,
4349                         version: 121,
4350                         port: 1234
4351                 };
4352                 assert_eq!(onion_v3, SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion:1234").unwrap());
4353                 assert_eq!(onion_v3, SocketAddress::from_str(&onion_v3.to_string()).unwrap());
4354
4355                 assert_eq!(Err(SocketAddressParseError::InvalidOnionV3), SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6.onion:1234"));
4356                 assert_eq!(Err(SocketAddressParseError::InvalidInput), SocketAddress::from_str("127.0.0.1@1234"));
4357                 assert_eq!(Err(SocketAddressParseError::InvalidInput), "".parse::<SocketAddress>());
4358                 assert!(SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion.onion:9735:94").is_err());
4359                 assert!(SocketAddress::from_str("wrong$%#.com:1234").is_err());
4360                 assert_eq!(Err(SocketAddressParseError::InvalidPort), SocketAddress::from_str("example.com:wrong"));
4361                 assert!("localhost".parse::<SocketAddress>().is_err());
4362                 assert!("localhost:invalid-port".parse::<SocketAddress>().is_err());
4363                 assert!( "invalid-onion-v3-hostname.onion:8080".parse::<SocketAddress>().is_err());
4364                 assert!("b32.example.onion:invalid-port".parse::<SocketAddress>().is_err());
4365                 assert!("invalid-address".parse::<SocketAddress>().is_err());
4366                 assert!(SocketAddress::from_str("pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion.onion:1234").is_err());
4367         }
4368
4369         #[test]
4370         #[cfg(feature = "std")]
4371         fn test_socket_address_to_socket_addrs() {
4372                 assert_eq!(SocketAddress::TcpIpV4 {addr:[0u8; 4], port: 1337,}.to_socket_addrs().unwrap().next().unwrap(),
4373                                    SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(0,0,0,0), 1337)));
4374                 assert_eq!(SocketAddress::TcpIpV6 {addr:[0u8; 16], port: 1337,}.to_socket_addrs().unwrap().next().unwrap(),
4375                                    SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::from([0u8; 16]), 1337, 0, 0)));
4376                 assert_eq!(SocketAddress::Hostname { hostname: Hostname::try_from("0.0.0.0".to_string()).unwrap(), port: 0 }
4377                                            .to_socket_addrs().unwrap().next().unwrap(), SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::from([0u8; 4]),0)));
4378                 assert!(SocketAddress::OnionV2([0u8; 12]).to_socket_addrs().is_err());
4379                 assert!(SocketAddress::OnionV3{ ed25519_pubkey: [37, 24, 75, 5, 25, 73, 117, 194, 139, 102,
4380                         182, 107, 4, 105, 247, 246, 85, 111, 177, 172, 49, 137, 167, 155, 64, 221, 163, 47, 31,
4381                         33, 71, 3],
4382                         checksum: 48326,
4383                         version: 121,
4384                         port: 1234 }.to_socket_addrs().is_err());
4385         }
4386 }