_ 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::secp256k1::PublicKey;
  28 use bitcoin::secp256k1::ecdsa::Signature;
  29 use bitcoin::secp256k1;
  30 use bitcoin::blockdata::script::Script;
  31 use bitcoin::hash_types::{Txid, BlockHash};
  32
  33 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
  34
  35 use prelude::*;
  36 use core::fmt;
  37 use core::fmt::Debug;
  38 use io::{self, Read};
  39 use io_extras::read_to_end;
  40
  41 use util::events::MessageSendEventsProvider;
  42 use util::logger;
  43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt, Hostname};
  44
  45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  46
  47 /// 21 million * 10^8 * 1000
  48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
  49
  50 /// An error in decoding a message or struct.
  51 #[derive(Clone, Debug, PartialEq)]
  52 pub enum DecodeError {
  53         /// A version byte specified something we don't know how to handle.
  54         /// Includes unknown realm byte in an OnionHopData packet
  55         UnknownVersion,
  56         /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
  57         UnknownRequiredFeature,
  58         /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
  59         /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
  60         /// syntactically incorrect, etc
  61         InvalidValue,
  62         /// Buffer too short
  63         ShortRead,
  64         /// A length descriptor in the packet didn't describe the later data correctly
  65         BadLengthDescriptor,
  66         /// Error from std::io
  67         Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
  68         io::ErrorKind),
  69         /// The message included zlib-compressed values, which we don't support.
  70         UnsupportedCompression,
  71 }
  72
  73 /// An init message to be sent or received from a peer
  74 #[derive(Clone, Debug, PartialEq)]
  75 pub struct Init {
  76         /// The relevant features which the sender supports
  77         pub features: InitFeatures,
  78         /// The receipient's network address. This adds the option to report a remote IP address
  79         /// back to a connecting peer using the init message. A node can decide to use that information
  80         /// to discover a potential update to its public IPv4 address (NAT) and use
  81         /// that for a node_announcement update message containing the new address.
  82         pub remote_network_address: Option<NetAddress>,
  83 }
  84
  85 /// An error message to be sent or received from a peer
  86 #[derive(Clone, Debug, PartialEq)]
  87 pub struct ErrorMessage {
  88         /// The channel ID involved in the error.
  89         ///
  90         /// All-0s indicates a general error unrelated to a specific channel, after which all channels
  91         /// with the sending peer should be closed.
  92         pub channel_id: [u8; 32],
  93         /// A possibly human-readable error description.
  94         /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
  95         /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
  96         /// the terminal emulator or the logging subsystem.
  97         pub data: String,
  98 }
  99
 100 /// A warning message to be sent or received from a peer
 101 #[derive(Clone, Debug, PartialEq)]
 102 pub struct WarningMessage {
 103         /// The channel ID involved in the warning.
 104         ///
 105         /// All-0s indicates a warning unrelated to a specific channel.
 106         pub channel_id: [u8; 32],
 107         /// A possibly human-readable warning description.
 108         /// The string should be sanitized before it is used (e.g. emitted to logs or printed to
 109         /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
 110         /// the terminal emulator or the logging subsystem.
 111         pub data: String,
 112 }
 113
 114 /// A ping message to be sent or received from a peer
 115 #[derive(Clone, Debug, PartialEq)]
 116 pub struct Ping {
 117         /// The desired response length
 118         pub ponglen: u16,
 119         /// The ping packet size.
 120         /// This field is not sent on the wire. byteslen zeros are sent.
 121         pub byteslen: u16,
 122 }
 123
 124 /// A pong message to be sent or received from a peer
 125 #[derive(Clone, Debug, PartialEq)]
 126 pub struct Pong {
 127         /// The pong packet size.
 128         /// This field is not sent on the wire. byteslen zeros are sent.
 129         pub byteslen: u16,
 130 }
 131
 132 /// An open_channel message to be sent or received from a peer
 133 #[derive(Clone, Debug, PartialEq)]
 134 pub struct OpenChannel {
 135         /// The genesis hash of the blockchain where the channel is to be opened
 136         pub chain_hash: BlockHash,
 137         /// A temporary channel ID, until the funding outpoint is announced
 138         pub temporary_channel_id: [u8; 32],
 139         /// The channel value
 140         pub funding_satoshis: u64,
 141         /// The amount to push to the counterparty as part of the open, in milli-satoshi
 142         pub push_msat: u64,
 143         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 144         pub dust_limit_satoshis: u64,
 145         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 146         pub max_htlc_value_in_flight_msat: u64,
 147         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 148         pub channel_reserve_satoshis: u64,
 149         /// The minimum HTLC size incoming to sender, in milli-satoshi
 150         pub htlc_minimum_msat: u64,
 151         /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
 152         pub feerate_per_kw: u32,
 153         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
 154         pub to_self_delay: u16,
 155         /// The maximum number of inbound HTLCs towards sender
 156         pub max_accepted_htlcs: u16,
 157         /// The sender's key controlling the funding transaction
 158         pub funding_pubkey: PublicKey,
 159         /// Used to derive a revocation key for transactions broadcast by counterparty
 160         pub revocation_basepoint: PublicKey,
 161         /// A payment key to sender for transactions broadcast by counterparty
 162         pub payment_point: PublicKey,
 163         /// Used to derive a payment key to sender for transactions broadcast by sender
 164         pub delayed_payment_basepoint: PublicKey,
 165         /// Used to derive an HTLC payment key to sender
 166         pub htlc_basepoint: PublicKey,
 167         /// The first to-be-broadcast-by-sender transaction's per commitment point
 168         pub first_per_commitment_point: PublicKey,
 169         /// Channel flags
 170         pub channel_flags: u8,
 171         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 172         pub shutdown_scriptpubkey: OptionalField<Script>,
 173         /// The channel type that this channel will represent. If none is set, we derive the channel
 174         /// type from the intersection of our feature bits with our counterparty's feature bits from
 175         /// the Init message.
 176         pub channel_type: Option<ChannelTypeFeatures>,
 177 }
 178
 179 /// An accept_channel message to be sent or received from a peer
 180 #[derive(Clone, Debug, PartialEq)]
 181 pub struct AcceptChannel {
 182         /// A temporary channel ID, until the funding outpoint is announced
 183         pub temporary_channel_id: [u8; 32],
 184         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 185         pub dust_limit_satoshis: u64,
 186         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 187         pub max_htlc_value_in_flight_msat: u64,
 188         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 189         pub channel_reserve_satoshis: u64,
 190         /// The minimum HTLC size incoming to sender, in milli-satoshi
 191         pub htlc_minimum_msat: u64,
 192         /// Minimum depth of the funding transaction before the channel is considered open
 193         pub minimum_depth: u32,
 194         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
 195         pub to_self_delay: u16,
 196         /// The maximum number of inbound HTLCs towards sender
 197         pub max_accepted_htlcs: u16,
 198         /// The sender's key controlling the funding transaction
 199         pub funding_pubkey: PublicKey,
 200         /// Used to derive a revocation key for transactions broadcast by counterparty
 201         pub revocation_basepoint: PublicKey,
 202         /// A payment key to sender for transactions broadcast by counterparty
 203         pub payment_point: PublicKey,
 204         /// Used to derive a payment key to sender for transactions broadcast by sender
 205         pub delayed_payment_basepoint: PublicKey,
 206         /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
 207         pub htlc_basepoint: PublicKey,
 208         /// The first to-be-broadcast-by-sender transaction's per commitment point
 209         pub first_per_commitment_point: PublicKey,
 210         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 211         pub shutdown_scriptpubkey: OptionalField<Script>,
 212         /// The channel type that this channel will represent. If none is set, we derive the channel
 213         /// type from the intersection of our feature bits with our counterparty's feature bits from
 214         /// the Init message.
 215         ///
 216         /// This is required to match the equivalent field in [`OpenChannel::channel_type`].
 217         pub channel_type: Option<ChannelTypeFeatures>,
 218 }
 219
 220 /// A funding_created message to be sent or received from a peer
 221 #[derive(Clone, Debug, PartialEq)]
 222 pub struct FundingCreated {
 223         /// A temporary channel ID, until the funding is established
 224         pub temporary_channel_id: [u8; 32],
 225         /// The funding transaction ID
 226         pub funding_txid: Txid,
 227         /// The specific output index funding this channel
 228         pub funding_output_index: u16,
 229         /// The signature of the channel initiator (funder) on the initial commitment transaction
 230         pub signature: Signature,
 231 }
 232
 233 /// A funding_signed message to be sent or received from a peer
 234 #[derive(Clone, Debug, PartialEq)]
 235 pub struct FundingSigned {
 236         /// The channel ID
 237         pub channel_id: [u8; 32],
 238         /// The signature of the channel acceptor (fundee) on the initial commitment transaction
 239         pub signature: Signature,
 240 }
 241
 242 /// A channel_ready message to be sent or received from a peer
 243 #[derive(Clone, Debug, PartialEq)]
 244 pub struct ChannelReady {
 245         /// The channel ID
 246         pub channel_id: [u8; 32],
 247         /// The per-commitment point of the second commitment transaction
 248         pub next_per_commitment_point: PublicKey,
 249         /// If set, provides a short_channel_id alias for this channel. The sender will accept payments
 250         /// to be forwarded over this SCID and forward them to this messages' recipient.
 251         pub short_channel_id_alias: Option<u64>,
 252 }
 253
 254 /// A shutdown message to be sent or received from a peer
 255 #[derive(Clone, Debug, PartialEq)]
 256 pub struct Shutdown {
 257         /// The channel ID
 258         pub channel_id: [u8; 32],
 259         /// The destination of this peer's funds on closing.
 260         /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
 261         pub scriptpubkey: Script,
 262 }
 263
 264 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
 265 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
 266 /// to use.
 267 #[derive(Clone, Debug, PartialEq)]
 268 pub struct ClosingSignedFeeRange {
 269         /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
 270         /// transaction.
 271         pub min_fee_satoshis: u64,
 272         /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
 273         /// transaction.
 274         pub max_fee_satoshis: u64,
 275 }
 276
 277 /// A closing_signed message to be sent or received from a peer
 278 #[derive(Clone, Debug, PartialEq)]
 279 pub struct ClosingSigned {
 280         /// The channel ID
 281         pub channel_id: [u8; 32],
 282         /// The proposed total fee for the closing transaction
 283         pub fee_satoshis: u64,
 284         /// A signature on the closing transaction
 285         pub signature: Signature,
 286         /// The minimum and maximum fees which the sender is willing to accept, provided only by new
 287         /// nodes.
 288         pub fee_range: Option<ClosingSignedFeeRange>,
 289 }
 290
 291 /// An update_add_htlc message to be sent or received from a peer
 292 #[derive(Clone, Debug, PartialEq)]
 293 pub struct UpdateAddHTLC {
 294         /// The channel ID
 295         pub channel_id: [u8; 32],
 296         /// The HTLC ID
 297         pub htlc_id: u64,
 298         /// The HTLC value in milli-satoshi
 299         pub amount_msat: u64,
 300         /// The payment hash, the pre-image of which controls HTLC redemption
 301         pub payment_hash: PaymentHash,
 302         /// The expiry height of the HTLC
 303         pub cltv_expiry: u32,
 304         pub(crate) onion_routing_packet: OnionPacket,
 305 }
 306
 307 /// An update_fulfill_htlc message to be sent or received from a peer
 308 #[derive(Clone, Debug, PartialEq)]
 309 pub struct UpdateFulfillHTLC {
 310         /// The channel ID
 311         pub channel_id: [u8; 32],
 312         /// The HTLC ID
 313         pub htlc_id: u64,
 314         /// The pre-image of the payment hash, allowing HTLC redemption
 315         pub payment_preimage: PaymentPreimage,
 316 }
 317
 318 /// An update_fail_htlc message to be sent or received from a peer
 319 #[derive(Clone, Debug, PartialEq)]
 320 pub struct UpdateFailHTLC {
 321         /// The channel ID
 322         pub channel_id: [u8; 32],
 323         /// The HTLC ID
 324         pub htlc_id: u64,
 325         pub(crate) reason: OnionErrorPacket,
 326 }
 327
 328 /// An update_fail_malformed_htlc message to be sent or received from a peer
 329 #[derive(Clone, Debug, PartialEq)]
 330 pub struct UpdateFailMalformedHTLC {
 331         /// The channel ID
 332         pub channel_id: [u8; 32],
 333         /// The HTLC ID
 334         pub htlc_id: u64,
 335         pub(crate) sha256_of_onion: [u8; 32],
 336         /// The failure code
 337         pub failure_code: u16,
 338 }
 339
 340 /// A commitment_signed message to be sent or received from a peer
 341 #[derive(Clone, Debug, PartialEq)]
 342 pub struct CommitmentSigned {
 343         /// The channel ID
 344         pub channel_id: [u8; 32],
 345         /// A signature on the commitment transaction
 346         pub signature: Signature,
 347         /// Signatures on the HTLC transactions
 348         pub htlc_signatures: Vec<Signature>,
 349 }
 350
 351 /// A revoke_and_ack message to be sent or received from a peer
 352 #[derive(Clone, Debug, PartialEq)]
 353 pub struct RevokeAndACK {
 354         /// The channel ID
 355         pub channel_id: [u8; 32],
 356         /// The secret corresponding to the per-commitment point
 357         pub per_commitment_secret: [u8; 32],
 358         /// The next sender-broadcast commitment transaction's per-commitment point
 359         pub next_per_commitment_point: PublicKey,
 360 }
 361
 362 /// An update_fee message to be sent or received from a peer
 363 #[derive(Clone, Debug, PartialEq)]
 364 pub struct UpdateFee {
 365         /// The channel ID
 366         pub channel_id: [u8; 32],
 367         /// Fee rate per 1000-weight of the transaction
 368         pub feerate_per_kw: u32,
 369 }
 370
 371 #[derive(Clone, Debug, PartialEq)]
 372 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
 373 /// This is used to convince the recipient that the channel is at a certain commitment
 374 /// number even if they lost that data due to a local failure.  Of course, the peer may lie
 375 /// and even later commitments may have been revoked.
 376 pub struct DataLossProtect {
 377         /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
 378         /// belonging to the recipient
 379         pub your_last_per_commitment_secret: [u8; 32],
 380         /// The sender's per-commitment point for their current commitment transaction
 381         pub my_current_per_commitment_point: PublicKey,
 382 }
 383
 384 /// A channel_reestablish message to be sent or received from a peer
 385 #[derive(Clone, Debug, PartialEq)]
 386 pub struct ChannelReestablish {
 387         /// The channel ID
 388         pub channel_id: [u8; 32],
 389         /// The next commitment number for the sender
 390         pub next_local_commitment_number: u64,
 391         /// The next commitment number for the recipient
 392         pub next_remote_commitment_number: u64,
 393         /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
 394         pub data_loss_protect: OptionalField<DataLossProtect>,
 395 }
 396
 397 /// An announcement_signatures message to be sent or received from a peer
 398 #[derive(Clone, Debug, PartialEq)]
 399 pub struct AnnouncementSignatures {
 400         /// The channel ID
 401         pub channel_id: [u8; 32],
 402         /// The short channel ID
 403         pub short_channel_id: u64,
 404         /// A signature by the node key
 405         pub node_signature: Signature,
 406         /// A signature by the funding key
 407         pub bitcoin_signature: Signature,
 408 }
 409
 410 /// An address which can be used to connect to a remote peer
 411 #[derive(Clone, Debug, PartialEq)]
 412 pub enum NetAddress {
 413         /// An IPv4 address/port on which the peer is listening.
 414         IPv4 {
 415                 /// The 4-byte IPv4 address
 416                 addr: [u8; 4],
 417                 /// The port on which the node is listening
 418                 port: u16,
 419         },
 420         /// An IPv6 address/port on which the peer is listening.
 421         IPv6 {
 422                 /// The 16-byte IPv6 address
 423                 addr: [u8; 16],
 424                 /// The port on which the node is listening
 425                 port: u16,
 426         },
 427         /// An old-style Tor onion address/port on which the peer is listening.
 428         ///
 429         /// This field is deprecated and the Tor network generally no longer supports V2 Onion
 430         /// addresses. Thus, the details are not parsed here.
 431         OnionV2([u8; 12]),
 432         /// A new-style Tor onion address/port on which the peer is listening.
 433         /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
 434         /// wrap as base32 and append ".onion".
 435         OnionV3 {
 436                 /// The ed25519 long-term public key of the peer
 437                 ed25519_pubkey: [u8; 32],
 438                 /// The checksum of the pubkey and version, as included in the onion address
 439                 checksum: u16,
 440                 /// The version byte, as defined by the Tor Onion v3 spec.
 441                 version: u8,
 442                 /// The port on which the node is listening
 443                 port: u16,
 444         },
 445         /// A hostname/port on which the peer is listening.
 446         Hostname {
 447                 /// The hostname on which the node is listening.
 448                 hostname: Hostname,
 449                 /// The port on which the node is listening.
 450                 port: u16,
 451         },
 452 }
 453 impl NetAddress {
 454         /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
 455         /// by this.
 456         pub(crate) fn get_id(&self) -> u8 {
 457                 match self {
 458                         &NetAddress::IPv4 {..} => { 1 },
 459                         &NetAddress::IPv6 {..} => { 2 },
 460                         &NetAddress::OnionV2(_) => { 3 },
 461                         &NetAddress::OnionV3 {..} => { 4 },
 462                         &NetAddress::Hostname {..} => { 5 },
 463                 }
 464         }
 465
 466         /// Strict byte-length of address descriptor, 1-byte type not recorded
 467         fn len(&self) -> u16 {
 468                 match self {
 469                         &NetAddress::IPv4 { .. } => { 6 },
 470                         &NetAddress::IPv6 { .. } => { 18 },
 471                         &NetAddress::OnionV2(_) => { 12 },
 472                         &NetAddress::OnionV3 { .. } => { 37 },
 473                         // Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
 474                         &NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
 475                 }
 476         }
 477
 478         /// The maximum length of any address descriptor, not including the 1-byte type.
 479         /// This maximum length is reached by a hostname address descriptor:
 480         /// a hostname with a maximum length of 255, its 1-byte length and a 2-byte port.
 481         pub(crate) const MAX_LEN: u16 = 258;
 482 }
 483
 484 impl Writeable for NetAddress {
 485         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 486                 match self {
 487                         &NetAddress::IPv4 { ref addr, ref port } => {
 488                                 1u8.write(writer)?;
 489                                 addr.write(writer)?;
 490                                 port.write(writer)?;
 491                         },
 492                         &NetAddress::IPv6 { ref addr, ref port } => {
 493                                 2u8.write(writer)?;
 494                                 addr.write(writer)?;
 495                                 port.write(writer)?;
 496                         },
 497                         &NetAddress::OnionV2(bytes) => {
 498                                 3u8.write(writer)?;
 499                                 bytes.write(writer)?;
 500                         },
 501                         &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
 502                                 4u8.write(writer)?;
 503                                 ed25519_pubkey.write(writer)?;
 504                                 checksum.write(writer)?;
 505                                 version.write(writer)?;
 506                                 port.write(writer)?;
 507                         },
 508                         &NetAddress::Hostname { ref hostname, ref port } => {
 509                                 5u8.write(writer)?;
 510                                 hostname.write(writer)?;
 511                                 port.write(writer)?;
 512                         },
 513                 }
 514                 Ok(())
 515         }
 516 }
 517
 518 impl Readable for Result<NetAddress, u8> {
 519         fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
 520                 let byte = <u8 as Readable>::read(reader)?;
 521                 match byte {
 522                         1 => {
 523                                 Ok(Ok(NetAddress::IPv4 {
 524                                         addr: Readable::read(reader)?,
 525                                         port: Readable::read(reader)?,
 526                                 }))
 527                         },
 528                         2 => {
 529                                 Ok(Ok(NetAddress::IPv6 {
 530                                         addr: Readable::read(reader)?,
 531                                         port: Readable::read(reader)?,
 532                                 }))
 533                         },
 534                         3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
 535                         4 => {
 536                                 Ok(Ok(NetAddress::OnionV3 {
 537                                         ed25519_pubkey: Readable::read(reader)?,
 538                                         checksum: Readable::read(reader)?,
 539                                         version: Readable::read(reader)?,
 540                                         port: Readable::read(reader)?,
 541                                 }))
 542                         },
 543                         5 => {
 544                                 Ok(Ok(NetAddress::Hostname {
 545                                         hostname: Readable::read(reader)?,
 546                                         port: Readable::read(reader)?,
 547                                 }))
 548                         },
 549                         _ => return Ok(Err(byte)),
 550                 }
 551         }
 552 }
 553
 554 impl Readable for NetAddress {
 555         fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
 556                 match Readable::read(reader) {
 557                         Ok(Ok(res)) => Ok(res),
 558                         Ok(Err(_)) => Err(DecodeError::UnknownVersion),
 559                         Err(e) => Err(e),
 560                 }
 561         }
 562 }
 563
 564
 565 /// The unsigned part of a node_announcement
 566 #[derive(Clone, Debug, PartialEq)]
 567 pub struct UnsignedNodeAnnouncement {
 568         /// The advertised features
 569         pub features: NodeFeatures,
 570         /// A strictly monotonic announcement counter, with gaps allowed
 571         pub timestamp: u32,
 572         /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
 573         /// to this node).
 574         pub node_id: PublicKey,
 575         /// An RGB color for UI purposes
 576         pub rgb: [u8; 3],
 577         /// An alias, for UI purposes.  This should be sanitized before use.  There is no guarantee
 578         /// of uniqueness.
 579         pub alias: [u8; 32],
 580         /// List of addresses on which this node is reachable
 581         pub addresses: Vec<NetAddress>,
 582         pub(crate) excess_address_data: Vec<u8>,
 583         pub(crate) excess_data: Vec<u8>,
 584 }
 585 #[derive(Clone, Debug, PartialEq)]
 586 /// A node_announcement message to be sent or received from a peer
 587 pub struct NodeAnnouncement {
 588         /// The signature by the node key
 589         pub signature: Signature,
 590         /// The actual content of the announcement
 591         pub contents: UnsignedNodeAnnouncement,
 592 }
 593
 594 /// The unsigned part of a channel_announcement
 595 #[derive(Clone, Debug, PartialEq)]
 596 pub struct UnsignedChannelAnnouncement {
 597         /// The advertised channel features
 598         pub features: ChannelFeatures,
 599         /// The genesis hash of the blockchain where the channel is to be opened
 600         pub chain_hash: BlockHash,
 601         /// The short channel ID
 602         pub short_channel_id: u64,
 603         /// One of the two node_ids which are endpoints of this channel
 604         pub node_id_1: PublicKey,
 605         /// The other of the two node_ids which are endpoints of this channel
 606         pub node_id_2: PublicKey,
 607         /// The funding key for the first node
 608         pub bitcoin_key_1: PublicKey,
 609         /// The funding key for the second node
 610         pub bitcoin_key_2: PublicKey,
 611         pub(crate) excess_data: Vec<u8>,
 612 }
 613 /// A channel_announcement message to be sent or received from a peer
 614 #[derive(Clone, Debug, PartialEq)]
 615 pub struct ChannelAnnouncement {
 616         /// Authentication of the announcement by the first public node
 617         pub node_signature_1: Signature,
 618         /// Authentication of the announcement by the second public node
 619         pub node_signature_2: Signature,
 620         /// Proof of funding UTXO ownership by the first public node
 621         pub bitcoin_signature_1: Signature,
 622         /// Proof of funding UTXO ownership by the second public node
 623         pub bitcoin_signature_2: Signature,
 624         /// The actual announcement
 625         pub contents: UnsignedChannelAnnouncement,
 626 }
 627
 628 /// The unsigned part of a channel_update
 629 #[derive(Clone, Debug, PartialEq)]
 630 pub struct UnsignedChannelUpdate {
 631         /// The genesis hash of the blockchain where the channel is to be opened
 632         pub chain_hash: BlockHash,
 633         /// The short channel ID
 634         pub short_channel_id: u64,
 635         /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
 636         pub timestamp: u32,
 637         /// Channel flags
 638         pub flags: u8,
 639         /// The number of blocks such that if:
 640         /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
 641         /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
 642         /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
 643         /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
 644         /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
 645         /// forwarding. Note that the HTLC sender is the one who originally sets this value when
 646         /// constructing the route.
 647         pub cltv_expiry_delta: u16,
 648         /// The minimum HTLC size incoming to sender, in milli-satoshi
 649         pub htlc_minimum_msat: u64,
 650         /// The maximum HTLC value incoming to sender, in milli-satoshi. Used to be optional.
 651         pub htlc_maximum_msat: u64,
 652         /// The base HTLC fee charged by sender, in milli-satoshi
 653         pub fee_base_msat: u32,
 654         /// The amount to fee multiplier, in micro-satoshi
 655         pub fee_proportional_millionths: u32,
 656         /// Excess data which was signed as a part of the message which we do not (yet) understand how
 657         /// to decode. This is stored to ensure forward-compatibility as new fields are added to the
 658         /// lightning gossip
 659         pub excess_data: Vec<u8>,
 660 }
 661 /// A channel_update message to be sent or received from a peer
 662 #[derive(Clone, Debug, PartialEq)]
 663 pub struct ChannelUpdate {
 664         /// A signature of the channel update
 665         pub signature: Signature,
 666         /// The actual channel update
 667         pub contents: UnsignedChannelUpdate,
 668 }
 669
 670 /// A query_channel_range message is used to query a peer for channel
 671 /// UTXOs in a range of blocks. The recipient of a query makes a best
 672 /// effort to reply to the query using one or more reply_channel_range
 673 /// messages.
 674 #[derive(Clone, Debug, PartialEq)]
 675 pub struct QueryChannelRange {
 676         /// The genesis hash of the blockchain being queried
 677         pub chain_hash: BlockHash,
 678         /// The height of the first block for the channel UTXOs being queried
 679         pub first_blocknum: u32,
 680         /// The number of blocks to include in the query results
 681         pub number_of_blocks: u32,
 682 }
 683
 684 /// A reply_channel_range message is a reply to a query_channel_range
 685 /// message. Multiple reply_channel_range messages can be sent in reply
 686 /// to a single query_channel_range message. The query recipient makes a
 687 /// best effort to respond based on their local network view which may
 688 /// not be a perfect view of the network. The short_channel_ids in the
 689 /// reply are encoded. We only support encoding_type=0 uncompressed
 690 /// serialization and do not support encoding_type=1 zlib serialization.
 691 #[derive(Clone, Debug, PartialEq)]
 692 pub struct ReplyChannelRange {
 693         /// The genesis hash of the blockchain being queried
 694         pub chain_hash: BlockHash,
 695         /// The height of the first block in the range of the reply
 696         pub first_blocknum: u32,
 697         /// The number of blocks included in the range of the reply
 698         pub number_of_blocks: u32,
 699         /// True when this is the final reply for a query
 700         pub sync_complete: bool,
 701         /// The short_channel_ids in the channel range
 702         pub short_channel_ids: Vec<u64>,
 703 }
 704
 705 /// A query_short_channel_ids message is used to query a peer for
 706 /// routing gossip messages related to one or more short_channel_ids.
 707 /// The query recipient will reply with the latest, if available,
 708 /// channel_announcement, channel_update and node_announcement messages
 709 /// it maintains for the requested short_channel_ids followed by a
 710 /// reply_short_channel_ids_end message. The short_channel_ids sent in
 711 /// this query are encoded. We only support encoding_type=0 uncompressed
 712 /// serialization and do not support encoding_type=1 zlib serialization.
 713 #[derive(Clone, Debug, PartialEq)]
 714 pub struct QueryShortChannelIds {
 715         /// The genesis hash of the blockchain being queried
 716         pub chain_hash: BlockHash,
 717         /// The short_channel_ids that are being queried
 718         pub short_channel_ids: Vec<u64>,
 719 }
 720
 721 /// A reply_short_channel_ids_end message is sent as a reply to a
 722 /// query_short_channel_ids message. The query recipient makes a best
 723 /// effort to respond based on their local network view which may not be
 724 /// a perfect view of the network.
 725 #[derive(Clone, Debug, PartialEq)]
 726 pub struct ReplyShortChannelIdsEnd {
 727         /// The genesis hash of the blockchain that was queried
 728         pub chain_hash: BlockHash,
 729         /// Indicates if the query recipient maintains up-to-date channel
 730         /// information for the chain_hash
 731         pub full_information: bool,
 732 }
 733
 734 /// A gossip_timestamp_filter message is used by a node to request
 735 /// gossip relay for messages in the requested time range when the
 736 /// gossip_queries feature has been negotiated.
 737 #[derive(Clone, Debug, PartialEq)]
 738 pub struct GossipTimestampFilter {
 739         /// The genesis hash of the blockchain for channel and node information
 740         pub chain_hash: BlockHash,
 741         /// The starting unix timestamp
 742         pub first_timestamp: u32,
 743         /// The range of information in seconds
 744         pub timestamp_range: u32,
 745 }
 746
 747 /// Encoding type for data compression of collections in gossip queries.
 748 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
 749 enum EncodingType {
 750         Uncompressed = 0x00,
 751 }
 752
 753 /// Used to put an error message in a LightningError
 754 #[derive(Clone, Debug)]
 755 pub enum ErrorAction {
 756         /// The peer took some action which made us think they were useless. Disconnect them.
 757         DisconnectPeer {
 758                 /// An error message which we should make an effort to send before we disconnect.
 759                 msg: Option<ErrorMessage>
 760         },
 761         /// The peer did something harmless that we weren't able to process, just log and ignore
 762         // New code should *not* use this. New code must use IgnoreAndLog, below!
 763         IgnoreError,
 764         /// The peer did something harmless that we weren't able to meaningfully process.
 765         /// If the error is logged, log it at the given level.
 766         IgnoreAndLog(logger::Level),
 767         /// The peer provided us with a gossip message which we'd already seen. In most cases this
 768         /// should be ignored, but it may result in the message being forwarded if it is a duplicate of
 769         /// our own channel announcements.
 770         IgnoreDuplicateGossip,
 771         /// The peer did something incorrect. Tell them.
 772         SendErrorMessage {
 773                 /// The message to send.
 774                 msg: ErrorMessage,
 775         },
 776         /// The peer did something incorrect. Tell them without closing any channels.
 777         SendWarningMessage {
 778                 /// The message to send.
 779                 msg: WarningMessage,
 780                 /// The peer may have done something harmless that we weren't able to meaningfully process,
 781                 /// though we should still tell them about it.
 782                 /// If this event is logged, log it at the given level.
 783                 log_level: logger::Level,
 784         },
 785 }
 786
 787 /// An Err type for failure to process messages.
 788 #[derive(Clone, Debug)]
 789 pub struct LightningError {
 790         /// A human-readable message describing the error
 791         pub err: String,
 792         /// The action which should be taken against the offending peer.
 793         pub action: ErrorAction,
 794 }
 795
 796 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
 797 /// transaction updates if they were pending.
 798 #[derive(Clone, Debug, PartialEq)]
 799 pub struct CommitmentUpdate {
 800         /// update_add_htlc messages which should be sent
 801         pub update_add_htlcs: Vec<UpdateAddHTLC>,
 802         /// update_fulfill_htlc messages which should be sent
 803         pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
 804         /// update_fail_htlc messages which should be sent
 805         pub update_fail_htlcs: Vec<UpdateFailHTLC>,
 806         /// update_fail_malformed_htlc messages which should be sent
 807         pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
 808         /// An update_fee message which should be sent
 809         pub update_fee: Option<UpdateFee>,
 810         /// Finally, the commitment_signed message which should be sent
 811         pub commitment_signed: CommitmentSigned,
 812 }
 813
 814 /// Messages could have optional fields to use with extended features
 815 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
 816 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
 817 /// separate enum type for them.
 818 /// (C-not exported) due to a free generic in T
 819 #[derive(Clone, Debug, PartialEq)]
 820 pub enum OptionalField<T> {
 821         /// Optional field is included in message
 822         Present(T),
 823         /// Optional field is absent in message
 824         Absent
 825 }
 826
 827 /// A trait to describe an object which can receive channel messages.
 828 ///
 829 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
 830 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
 831 pub trait ChannelMessageHandler : MessageSendEventsProvider {
 832         //Channel init:
 833         /// Handle an incoming open_channel message from the given peer.
 834         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
 835         /// Handle an incoming accept_channel message from the given peer.
 836         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
 837         /// Handle an incoming funding_created message from the given peer.
 838         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
 839         /// Handle an incoming funding_signed message from the given peer.
 840         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
 841         /// Handle an incoming channel_ready message from the given peer.
 842         fn handle_channel_ready(&self, their_node_id: &PublicKey, msg: &ChannelReady);
 843
 844         // Channl close:
 845         /// Handle an incoming shutdown message from the given peer.
 846         fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
 847         /// Handle an incoming closing_signed message from the given peer.
 848         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
 849
 850         // HTLC handling:
 851         /// Handle an incoming update_add_htlc message from the given peer.
 852         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
 853         /// Handle an incoming update_fulfill_htlc message from the given peer.
 854         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
 855         /// Handle an incoming update_fail_htlc message from the given peer.
 856         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
 857         /// Handle an incoming update_fail_malformed_htlc message from the given peer.
 858         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
 859         /// Handle an incoming commitment_signed message from the given peer.
 860         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
 861         /// Handle an incoming revoke_and_ack message from the given peer.
 862         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
 863
 864         /// Handle an incoming update_fee message from the given peer.
 865         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
 866
 867         // Channel-to-announce:
 868         /// Handle an incoming announcement_signatures message from the given peer.
 869         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
 870
 871         // Connection loss/reestablish:
 872         /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
 873         /// is believed to be possible in the future (eg they're sending us messages we don't
 874         /// understand or indicate they require unknown feature bits), no_connection_possible is set
 875         /// and any outstanding channels should be failed.
 876         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
 877
 878         /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
 879         fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
 880         /// Handle an incoming channel_reestablish message from the given peer.
 881         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
 882
 883         /// Handle an incoming channel update from the given peer.
 884         fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
 885
 886         // Error:
 887         /// Handle an incoming error message from the given peer.
 888         fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
 889 }
 890
 891 /// A trait to describe an object which can receive routing messages.
 892 ///
 893 /// # Implementor DoS Warnings
 894 ///
 895 /// For `gossip_queries` messages there are potential DoS vectors when handling
 896 /// inbound queries. Implementors using an on-disk network graph should be aware of
 897 /// repeated disk I/O for queries accessing different parts of the network graph.
 898 pub trait RoutingMessageHandler : MessageSendEventsProvider {
 899         /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
 900         /// false or returning an Err otherwise.
 901         fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
 902         /// Handle a channel_announcement message, returning true if it should be forwarded on, false
 903         /// or returning an Err otherwise.
 904         fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
 905         /// Handle an incoming channel_update message, returning true if it should be forwarded on,
 906         /// false or returning an Err otherwise.
 907         fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
 908         /// Gets a subset of the channel announcements and updates required to dump our routing table
 909         /// to a remote node, starting at the short_channel_id indicated by starting_point and
 910         /// including the batch_amount entries immediately higher in numerical value than starting_point.
 911         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
 912         /// Gets a subset of the node announcements required to dump our routing table to a remote node,
 913         /// starting at the node *after* the provided publickey and including batch_amount entries
 914         /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
 915         /// If None is provided for starting_point, we start at the first node.
 916         fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
 917         /// Called when a connection is established with a peer. This can be used to
 918         /// perform routing table synchronization using a strategy defined by the
 919         /// implementor.
 920         fn peer_connected(&self, their_node_id: &PublicKey, init: &Init);
 921         /// Handles the reply of a query we initiated to learn about channels
 922         /// for a given range of blocks. We can expect to receive one or more
 923         /// replies to a single query.
 924         fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
 925         /// Handles the reply of a query we initiated asking for routing gossip
 926         /// messages for a list of channels. We should receive this message when
 927         /// a node has completed its best effort to send us the pertaining routing
 928         /// gossip messages.
 929         fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
 930         /// Handles when a peer asks us to send a list of short_channel_ids
 931         /// for the requested range of blocks.
 932         fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
 933         /// Handles when a peer asks us to send routing gossip messages for a
 934         /// list of short_channel_ids.
 935         fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
 936 }
 937
 938 mod fuzzy_internal_msgs {
 939         use prelude::*;
 940         use ln::{PaymentPreimage, PaymentSecret};
 941
 942         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
 943         // them from untrusted input):
 944         #[derive(Clone)]
 945         pub(crate) struct FinalOnionHopData {
 946                 pub(crate) payment_secret: PaymentSecret,
 947                 /// The total value, in msat, of the payment as received by the ultimate recipient.
 948                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
 949                 pub(crate) total_msat: u64,
 950         }
 951
 952         pub(crate) enum OnionHopDataFormat {
 953                 Legacy { // aka Realm-0
 954                         short_channel_id: u64,
 955                 },
 956                 NonFinalNode {
 957                         short_channel_id: u64,
 958                 },
 959                 FinalNode {
 960                         payment_data: Option<FinalOnionHopData>,
 961                         keysend_preimage: Option<PaymentPreimage>,
 962                 },
 963         }
 964
 965         pub struct OnionHopData {
 966                 pub(crate) format: OnionHopDataFormat,
 967                 /// The value, in msat, of the payment after this hop's fee is deducted.
 968                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
 969                 pub(crate) amt_to_forward: u64,
 970                 pub(crate) outgoing_cltv_value: u32,
 971                 // 12 bytes of 0-padding for Legacy format
 972         }
 973
 974         pub struct DecodedOnionErrorPacket {
 975                 pub(crate) hmac: [u8; 32],
 976                 pub(crate) failuremsg: Vec<u8>,
 977                 pub(crate) pad: Vec<u8>,
 978         }
 979 }
 980 #[cfg(fuzzing)]
 981 pub use self::fuzzy_internal_msgs::*;
 982 #[cfg(not(fuzzing))]
 983 pub(crate) use self::fuzzy_internal_msgs::*;
 984
 985 #[derive(Clone)]
 986 pub(crate) struct OnionPacket {
 987         pub(crate) version: u8,
 988         /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
 989         /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
 990         /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
 991         pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
 992         pub(crate) hop_data: [u8; 20*65],
 993         pub(crate) hmac: [u8; 32],
 994 }
 995
 996 impl PartialEq for OnionPacket {
 997         fn eq(&self, other: &OnionPacket) -> bool {
 998                 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
 999                         if i != j { return false; }
1000                 }
1001                 self.version == other.version &&
1002                         self.public_key == other.public_key &&
1003                         self.hmac == other.hmac
1004         }
1005 }
1006
1007 impl fmt::Debug for OnionPacket {
1008         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1009                 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
1010         }
1011 }
1012
1013 #[derive(Clone, Debug, PartialEq)]
1014 pub(crate) struct OnionErrorPacket {
1015         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
1016         // (TODO) We limit it in decode to much lower...
1017         pub(crate) data: Vec<u8>,
1018 }
1019
1020 impl fmt::Display for DecodeError {
1021         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1022                 match *self {
1023                         DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
1024                         DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
1025                         DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
1026                         DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
1027                         DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
1028                         DecodeError::Io(ref e) => fmt::Debug::fmt(e, f),
1029                         DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
1030                 }
1031         }
1032 }
1033
1034 impl From<io::Error> for DecodeError {
1035         fn from(e: io::Error) -> Self {
1036                 if e.kind() == io::ErrorKind::UnexpectedEof {
1037                         DecodeError::ShortRead
1038                 } else {
1039                         DecodeError::Io(e.kind())
1040                 }
1041         }
1042 }
1043
1044 impl Writeable for OptionalField<Script> {
1045         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1046                 match *self {
1047                         OptionalField::Present(ref script) => {
1048                                 // Note that Writeable for script includes the 16-bit length tag for us
1049                                 script.write(w)?;
1050                         },
1051                         OptionalField::Absent => {}
1052                 }
1053                 Ok(())
1054         }
1055 }
1056
1057 impl Readable for OptionalField<Script> {
1058         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1059                 match <u16 as Readable>::read(r) {
1060                         Ok(len) => {
1061                                 let mut buf = vec![0; len as usize];
1062                                 r.read_exact(&mut buf)?;
1063                                 Ok(OptionalField::Present(Script::from(buf)))
1064                         },
1065                         Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1066                         Err(e) => Err(e)
1067                 }
1068         }
1069 }
1070
1071 impl Writeable for OptionalField<u64> {
1072         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1073                 match *self {
1074                         OptionalField::Present(ref value) => {
1075                                 value.write(w)?;
1076                         },
1077                         OptionalField::Absent => {}
1078                 }
1079                 Ok(())
1080         }
1081 }
1082
1083 impl Readable for OptionalField<u64> {
1084         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1085                 let value: u64 = Readable::read(r)?;
1086                 Ok(OptionalField::Present(value))
1087         }
1088 }
1089
1090
1091 impl_writeable_msg!(AcceptChannel, {
1092         temporary_channel_id,
1093         dust_limit_satoshis,
1094         max_htlc_value_in_flight_msat,
1095         channel_reserve_satoshis,
1096         htlc_minimum_msat,
1097         minimum_depth,
1098         to_self_delay,
1099         max_accepted_htlcs,
1100         funding_pubkey,
1101         revocation_basepoint,
1102         payment_point,
1103         delayed_payment_basepoint,
1104         htlc_basepoint,
1105         first_per_commitment_point,
1106         shutdown_scriptpubkey
1107 }, {
1108         (1, channel_type, option),
1109 });
1110
1111 impl_writeable_msg!(AnnouncementSignatures, {
1112         channel_id,
1113         short_channel_id,
1114         node_signature,
1115         bitcoin_signature
1116 }, {});
1117
1118 impl Writeable for ChannelReestablish {
1119         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1120                 self.channel_id.write(w)?;
1121                 self.next_local_commitment_number.write(w)?;
1122                 self.next_remote_commitment_number.write(w)?;
1123                 match self.data_loss_protect {
1124                         OptionalField::Present(ref data_loss_protect) => {
1125                                 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1126                                 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1127                         },
1128                         OptionalField::Absent => {}
1129                 }
1130                 Ok(())
1131         }
1132 }
1133
1134 impl Readable for ChannelReestablish{
1135         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1136                 Ok(Self {
1137                         channel_id: Readable::read(r)?,
1138                         next_local_commitment_number: Readable::read(r)?,
1139                         next_remote_commitment_number: Readable::read(r)?,
1140                         data_loss_protect: {
1141                                 match <[u8; 32] as Readable>::read(r) {
1142                                         Ok(your_last_per_commitment_secret) =>
1143                                                 OptionalField::Present(DataLossProtect {
1144                                                         your_last_per_commitment_secret,
1145                                                         my_current_per_commitment_point: Readable::read(r)?,
1146                                                 }),
1147                                         Err(DecodeError::ShortRead) => OptionalField::Absent,
1148                                         Err(e) => return Err(e)
1149                                 }
1150                         }
1151                 })
1152         }
1153 }
1154
1155 impl_writeable_msg!(ClosingSigned,
1156         { channel_id, fee_satoshis, signature },
1157         { (1, fee_range, option) }
1158 );
1159
1160 impl_writeable!(ClosingSignedFeeRange, {
1161         min_fee_satoshis,
1162         max_fee_satoshis
1163 });
1164
1165 impl_writeable_msg!(CommitmentSigned, {
1166         channel_id,
1167         signature,
1168         htlc_signatures
1169 }, {});
1170
1171 impl_writeable!(DecodedOnionErrorPacket, {
1172         hmac,
1173         failuremsg,
1174         pad
1175 });
1176
1177 impl_writeable_msg!(FundingCreated, {
1178         temporary_channel_id,
1179         funding_txid,
1180         funding_output_index,
1181         signature
1182 }, {});
1183
1184 impl_writeable_msg!(FundingSigned, {
1185         channel_id,
1186         signature
1187 }, {});
1188
1189 impl_writeable_msg!(ChannelReady, {
1190         channel_id,
1191         next_per_commitment_point,
1192 }, {
1193         (1, short_channel_id_alias, option),
1194 });
1195
1196 impl Writeable for Init {
1197         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1198                 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1199                 // our relevant feature bits. This keeps us compatible with old nodes.
1200                 self.features.write_up_to_13(w)?;
1201                 self.features.write(w)?;
1202                 encode_tlv_stream!(w, {
1203                         (3, self.remote_network_address, option)
1204                 });
1205                 Ok(())
1206         }
1207 }
1208
1209 impl Readable for Init {
1210         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1211                 let global_features: InitFeatures = Readable::read(r)?;
1212                 let features: InitFeatures = Readable::read(r)?;
1213                 let mut remote_network_address: Option<NetAddress> = None;
1214                 decode_tlv_stream!(r, {
1215                         (3, remote_network_address, option)
1216                 });
1217                 Ok(Init {
1218                         features: features.or(global_features),
1219                         remote_network_address,
1220                 })
1221         }
1222 }
1223
1224 impl_writeable_msg!(OpenChannel, {
1225         chain_hash,
1226         temporary_channel_id,
1227         funding_satoshis,
1228         push_msat,
1229         dust_limit_satoshis,
1230         max_htlc_value_in_flight_msat,
1231         channel_reserve_satoshis,
1232         htlc_minimum_msat,
1233         feerate_per_kw,
1234         to_self_delay,
1235         max_accepted_htlcs,
1236         funding_pubkey,
1237         revocation_basepoint,
1238         payment_point,
1239         delayed_payment_basepoint,
1240         htlc_basepoint,
1241         first_per_commitment_point,
1242         channel_flags,
1243         shutdown_scriptpubkey
1244 }, {
1245         (1, channel_type, option),
1246 });
1247
1248 impl_writeable_msg!(RevokeAndACK, {
1249         channel_id,
1250         per_commitment_secret,
1251         next_per_commitment_point
1252 }, {});
1253
1254 impl_writeable_msg!(Shutdown, {
1255         channel_id,
1256         scriptpubkey
1257 }, {});
1258
1259 impl_writeable_msg!(UpdateFailHTLC, {
1260         channel_id,
1261         htlc_id,
1262         reason
1263 }, {});
1264
1265 impl_writeable_msg!(UpdateFailMalformedHTLC, {
1266         channel_id,
1267         htlc_id,
1268         sha256_of_onion,
1269         failure_code
1270 }, {});
1271
1272 impl_writeable_msg!(UpdateFee, {
1273         channel_id,
1274         feerate_per_kw
1275 }, {});
1276
1277 impl_writeable_msg!(UpdateFulfillHTLC, {
1278         channel_id,
1279         htlc_id,
1280         payment_preimage
1281 }, {});
1282
1283 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1284 // serialization format in a way which assumes we know the total serialized length/message end
1285 // position.
1286 impl_writeable!(OnionErrorPacket, {
1287         data
1288 });
1289
1290 // Note that this is written as a part of ChannelManager objects, and thus cannot change its
1291 // serialization format in a way which assumes we know the total serialized length/message end
1292 // position.
1293 impl Writeable for OnionPacket {
1294         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1295                 self.version.write(w)?;
1296                 match self.public_key {
1297                         Ok(pubkey) => pubkey.write(w)?,
1298                         Err(_) => [0u8;33].write(w)?,
1299                 }
1300                 w.write_all(&self.hop_data)?;
1301                 self.hmac.write(w)?;
1302                 Ok(())
1303         }
1304 }
1305
1306 impl Readable for OnionPacket {
1307         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1308                 Ok(OnionPacket {
1309                         version: Readable::read(r)?,
1310                         public_key: {
1311                                 let mut buf = [0u8;33];
1312                                 r.read_exact(&mut buf)?;
1313                                 PublicKey::from_slice(&buf)
1314                         },
1315                         hop_data: Readable::read(r)?,
1316                         hmac: Readable::read(r)?,
1317                 })
1318         }
1319 }
1320
1321 impl_writeable_msg!(UpdateAddHTLC, {
1322         channel_id,
1323         htlc_id,
1324         amount_msat,
1325         payment_hash,
1326         cltv_expiry,
1327         onion_routing_packet
1328 }, {});
1329
1330 impl Writeable for FinalOnionHopData {
1331         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1332                 self.payment_secret.0.write(w)?;
1333                 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1334         }
1335 }
1336
1337 impl Readable for FinalOnionHopData {
1338         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1339                 let secret: [u8; 32] = Readable::read(r)?;
1340                 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1341                 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1342         }
1343 }
1344
1345 impl Writeable for OnionHopData {
1346         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1347                 match self.format {
1348                         OnionHopDataFormat::Legacy { short_channel_id } => {
1349                                 0u8.write(w)?;
1350                                 short_channel_id.write(w)?;
1351                                 self.amt_to_forward.write(w)?;
1352                                 self.outgoing_cltv_value.write(w)?;
1353                                 w.write_all(&[0;12])?;
1354                         },
1355                         OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1356                                 encode_varint_length_prefixed_tlv!(w, {
1357                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1358                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1359                                         (6, short_channel_id, required)
1360                                 });
1361                         },
1362                         OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1363                                 encode_varint_length_prefixed_tlv!(w, {
1364                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1365                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1366                                         (8, payment_data, option),
1367                                         (5482373484, keysend_preimage, option)
1368                                 });
1369                         },
1370                 }
1371                 Ok(())
1372         }
1373 }
1374
1375 impl Readable for OnionHopData {
1376         fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1377                 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1378                 let v: VarInt = Decodable::consensus_decode(&mut r)
1379                         .map_err(|e| match e {
1380                                 Error::Io(ioe) => DecodeError::from(ioe),
1381                                 _ => DecodeError::InvalidValue
1382                         })?;
1383                 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1384                 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1385                         let mut rd = FixedLengthReader::new(r, v.0);
1386                         let mut amt = HighZeroBytesDroppedVarInt(0u64);
1387                         let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1388                         let mut short_id: Option<u64> = None;
1389                         let mut payment_data: Option<FinalOnionHopData> = None;
1390                         let mut keysend_preimage: Option<PaymentPreimage> = None;
1391                         // The TLV type is chosen to be compatible with lnd and c-lightning.
1392                         decode_tlv_stream!(&mut rd, {
1393                                 (2, amt, required),
1394                                 (4, cltv_value, required),
1395                                 (6, short_id, option),
1396                                 (8, payment_data, option),
1397                                 (5482373484, keysend_preimage, option)
1398                         });
1399                         rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1400                         let format = if let Some(short_channel_id) = short_id {
1401                                 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1402                                 OnionHopDataFormat::NonFinalNode {
1403                                         short_channel_id,
1404                                 }
1405                         } else {
1406                                 if let &Some(ref data) = &payment_data {
1407                                         if data.total_msat > MAX_VALUE_MSAT {
1408                                                 return Err(DecodeError::InvalidValue);
1409                                         }
1410                                 }
1411                                 OnionHopDataFormat::FinalNode {
1412                                         payment_data,
1413                                         keysend_preimage,
1414                                 }
1415                         };
1416                         (format, amt.0, cltv_value.0)
1417                 } else {
1418                         let format = OnionHopDataFormat::Legacy {
1419                                 short_channel_id: Readable::read(r)?,
1420                         };
1421                         let amt: u64 = Readable::read(r)?;
1422                         let cltv_value: u32 = Readable::read(r)?;
1423                         r.read_exact(&mut [0; 12])?;
1424                         (format, amt, cltv_value)
1425                 };
1426
1427                 if amt > MAX_VALUE_MSAT {
1428                         return Err(DecodeError::InvalidValue);
1429                 }
1430                 Ok(OnionHopData {
1431                         format,
1432                         amt_to_forward: amt,
1433                         outgoing_cltv_value: cltv_value,
1434                 })
1435         }
1436 }
1437
1438 impl Writeable for Ping {
1439         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1440                 self.ponglen.write(w)?;
1441                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1442                 Ok(())
1443         }
1444 }
1445
1446 impl Readable for Ping {
1447         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1448                 Ok(Ping {
1449                         ponglen: Readable::read(r)?,
1450                         byteslen: {
1451                                 let byteslen = Readable::read(r)?;
1452                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1453                                 byteslen
1454                         }
1455                 })
1456         }
1457 }
1458
1459 impl Writeable for Pong {
1460         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1461                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1462                 Ok(())
1463         }
1464 }
1465
1466 impl Readable for Pong {
1467         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1468                 Ok(Pong {
1469                         byteslen: {
1470                                 let byteslen = Readable::read(r)?;
1471                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1472                                 byteslen
1473                         }
1474                 })
1475         }
1476 }
1477
1478 impl Writeable for UnsignedChannelAnnouncement {
1479         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1480                 self.features.write(w)?;
1481                 self.chain_hash.write(w)?;
1482                 self.short_channel_id.write(w)?;
1483                 self.node_id_1.write(w)?;
1484                 self.node_id_2.write(w)?;
1485                 self.bitcoin_key_1.write(w)?;
1486                 self.bitcoin_key_2.write(w)?;
1487                 w.write_all(&self.excess_data[..])?;
1488                 Ok(())
1489         }
1490 }
1491
1492 impl Readable for UnsignedChannelAnnouncement {
1493         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1494                 Ok(Self {
1495                         features: Readable::read(r)?,
1496                         chain_hash: Readable::read(r)?,
1497                         short_channel_id: Readable::read(r)?,
1498                         node_id_1: Readable::read(r)?,
1499                         node_id_2: Readable::read(r)?,
1500                         bitcoin_key_1: Readable::read(r)?,
1501                         bitcoin_key_2: Readable::read(r)?,
1502                         excess_data: read_to_end(r)?,
1503                 })
1504         }
1505 }
1506
1507 impl_writeable!(ChannelAnnouncement, {
1508         node_signature_1,
1509         node_signature_2,
1510         bitcoin_signature_1,
1511         bitcoin_signature_2,
1512         contents
1513 });
1514
1515 impl Writeable for UnsignedChannelUpdate {
1516         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1517                 // `message_flags` used to indicate presence of `htlc_maximum_msat`, but was deprecated in the spec.
1518                 const MESSAGE_FLAGS: u8 = 1;
1519                 self.chain_hash.write(w)?;
1520                 self.short_channel_id.write(w)?;
1521                 self.timestamp.write(w)?;
1522                 let all_flags = self.flags as u16 | ((MESSAGE_FLAGS as u16) << 8);
1523                 all_flags.write(w)?;
1524                 self.cltv_expiry_delta.write(w)?;
1525                 self.htlc_minimum_msat.write(w)?;
1526                 self.fee_base_msat.write(w)?;
1527                 self.fee_proportional_millionths.write(w)?;
1528                 self.htlc_maximum_msat.write(w)?;
1529                 w.write_all(&self.excess_data[..])?;
1530                 Ok(())
1531         }
1532 }
1533
1534 impl Readable for UnsignedChannelUpdate {
1535         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1536                 Ok(Self {
1537                         chain_hash: Readable::read(r)?,
1538                         short_channel_id: Readable::read(r)?,
1539                         timestamp: Readable::read(r)?,
1540                         flags: {
1541                                 let flags: u16 = Readable::read(r)?;
1542                                 // Note: we ignore the `message_flags` for now, since it was deprecated by the spec.
1543                                 flags as u8
1544                         },
1545                         cltv_expiry_delta: Readable::read(r)?,
1546                         htlc_minimum_msat: Readable::read(r)?,
1547                         fee_base_msat: Readable::read(r)?,
1548                         fee_proportional_millionths: Readable::read(r)?,
1549                         htlc_maximum_msat: Readable::read(r)?,
1550                         excess_data: read_to_end(r)?,
1551                 })
1552         }
1553 }
1554
1555 impl_writeable!(ChannelUpdate, {
1556         signature,
1557         contents
1558 });
1559
1560 impl Writeable for ErrorMessage {
1561         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1562                 self.channel_id.write(w)?;
1563                 (self.data.len() as u16).write(w)?;
1564                 w.write_all(self.data.as_bytes())?;
1565                 Ok(())
1566         }
1567 }
1568
1569 impl Readable for ErrorMessage {
1570         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1571                 Ok(Self {
1572                         channel_id: Readable::read(r)?,
1573                         data: {
1574                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
1575                                 let mut data = Vec::with_capacity(sz);
1576                                 data.resize(sz, 0);
1577                                 r.read_exact(&mut data)?;
1578                                 match String::from_utf8(data) {
1579                                         Ok(s) => s,
1580                                         Err(_) => return Err(DecodeError::InvalidValue),
1581                                 }
1582                         }
1583                 })
1584         }
1585 }
1586
1587 impl Writeable for WarningMessage {
1588         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1589                 self.channel_id.write(w)?;
1590                 (self.data.len() as u16).write(w)?;
1591                 w.write_all(self.data.as_bytes())?;
1592                 Ok(())
1593         }
1594 }
1595
1596 impl Readable for WarningMessage {
1597         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1598                 Ok(Self {
1599                         channel_id: Readable::read(r)?,
1600                         data: {
1601                                 let sz: usize = <u16 as Readable>::read(r)? as usize;
1602                                 let mut data = Vec::with_capacity(sz);
1603                                 data.resize(sz, 0);
1604                                 r.read_exact(&mut data)?;
1605                                 match String::from_utf8(data) {
1606                                         Ok(s) => s,
1607                                         Err(_) => return Err(DecodeError::InvalidValue),
1608                                 }
1609                         }
1610                 })
1611         }
1612 }
1613
1614 impl Writeable for UnsignedNodeAnnouncement {
1615         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1616                 self.features.write(w)?;
1617                 self.timestamp.write(w)?;
1618                 self.node_id.write(w)?;
1619                 w.write_all(&self.rgb)?;
1620                 self.alias.write(w)?;
1621
1622                 let mut addr_len = 0;
1623                 for addr in self.addresses.iter() {
1624                         addr_len += 1 + addr.len();
1625                 }
1626                 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1627                 for addr in self.addresses.iter() {
1628                         addr.write(w)?;
1629                 }
1630                 w.write_all(&self.excess_address_data[..])?;
1631                 w.write_all(&self.excess_data[..])?;
1632                 Ok(())
1633         }
1634 }
1635
1636 impl Readable for UnsignedNodeAnnouncement {
1637         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1638                 let features: NodeFeatures = Readable::read(r)?;
1639                 let timestamp: u32 = Readable::read(r)?;
1640                 let node_id: PublicKey = Readable::read(r)?;
1641                 let mut rgb = [0; 3];
1642                 r.read_exact(&mut rgb)?;
1643                 let alias: [u8; 32] = Readable::read(r)?;
1644
1645                 let addr_len: u16 = Readable::read(r)?;
1646                 let mut addresses: Vec<NetAddress> = Vec::new();
1647                 let mut addr_readpos = 0;
1648                 let mut excess = false;
1649                 let mut excess_byte = 0;
1650                 loop {
1651                         if addr_len <= addr_readpos { break; }
1652                         match Readable::read(r) {
1653                                 Ok(Ok(addr)) => {
1654                                         if addr_len < addr_readpos + 1 + addr.len() {
1655                                                 return Err(DecodeError::BadLengthDescriptor);
1656                                         }
1657                                         addr_readpos += (1 + addr.len()) as u16;
1658                                         addresses.push(addr);
1659                                 },
1660                                 Ok(Err(unknown_descriptor)) => {
1661                                         excess = true;
1662                                         excess_byte = unknown_descriptor;
1663                                         break;
1664                                 },
1665                                 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1666                                 Err(e) => return Err(e),
1667                         }
1668                 }
1669
1670                 let mut excess_data = vec![];
1671                 let excess_address_data = if addr_readpos < addr_len {
1672                         let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1673                         r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1674                         if excess {
1675                                 excess_address_data[0] = excess_byte;
1676                         }
1677                         excess_address_data
1678                 } else {
1679                         if excess {
1680                                 excess_data.push(excess_byte);
1681                         }
1682                         Vec::new()
1683                 };
1684                 excess_data.extend(read_to_end(r)?.iter());
1685                 Ok(UnsignedNodeAnnouncement {
1686                         features,
1687                         timestamp,
1688                         node_id,
1689                         rgb,
1690                         alias,
1691                         addresses,
1692                         excess_address_data,
1693                         excess_data,
1694                 })
1695         }
1696 }
1697
1698 impl_writeable!(NodeAnnouncement, {
1699         signature,
1700         contents
1701 });
1702
1703 impl Readable for QueryShortChannelIds {
1704         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1705                 let chain_hash: BlockHash = Readable::read(r)?;
1706
1707                 let encoding_len: u16 = Readable::read(r)?;
1708                 let encoding_type: u8 = Readable::read(r)?;
1709
1710                 // Must be encoding_type=0 uncompressed serialization. We do not
1711                 // support encoding_type=1 zlib serialization.
1712                 if encoding_type != EncodingType::Uncompressed as u8 {
1713                         return Err(DecodeError::UnsupportedCompression);
1714                 }
1715
1716                 // We expect the encoding_len to always includes the 1-byte
1717                 // encoding_type and that short_channel_ids are 8-bytes each
1718                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1719                         return Err(DecodeError::InvalidValue);
1720                 }
1721
1722                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1723                 // less the 1-byte encoding_type
1724                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1725                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1726                 for _ in 0..short_channel_id_count {
1727                         short_channel_ids.push(Readable::read(r)?);
1728                 }
1729
1730                 Ok(QueryShortChannelIds {
1731                         chain_hash,
1732                         short_channel_ids,
1733                 })
1734         }
1735 }
1736
1737 impl Writeable for QueryShortChannelIds {
1738         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1739                 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1740                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1741
1742                 self.chain_hash.write(w)?;
1743                 encoding_len.write(w)?;
1744
1745                 // We only support type=0 uncompressed serialization
1746                 (EncodingType::Uncompressed as u8).write(w)?;
1747
1748                 for scid in self.short_channel_ids.iter() {
1749                         scid.write(w)?;
1750                 }
1751
1752                 Ok(())
1753         }
1754 }
1755
1756 impl_writeable_msg!(ReplyShortChannelIdsEnd, {
1757         chain_hash,
1758         full_information,
1759 }, {});
1760
1761 impl QueryChannelRange {
1762         /**
1763          * Calculates the overflow safe ending block height for the query.
1764          * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1765          */
1766         pub fn end_blocknum(&self) -> u32 {
1767                 match self.first_blocknum.checked_add(self.number_of_blocks) {
1768                         Some(block) => block,
1769                         None => u32::max_value(),
1770                 }
1771         }
1772 }
1773
1774 impl_writeable_msg!(QueryChannelRange, {
1775         chain_hash,
1776         first_blocknum,
1777         number_of_blocks
1778 }, {});
1779
1780 impl Readable for ReplyChannelRange {
1781         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1782                 let chain_hash: BlockHash = Readable::read(r)?;
1783                 let first_blocknum: u32 = Readable::read(r)?;
1784                 let number_of_blocks: u32 = Readable::read(r)?;
1785                 let sync_complete: bool = Readable::read(r)?;
1786
1787                 let encoding_len: u16 = Readable::read(r)?;
1788                 let encoding_type: u8 = Readable::read(r)?;
1789
1790                 // Must be encoding_type=0 uncompressed serialization. We do not
1791                 // support encoding_type=1 zlib serialization.
1792                 if encoding_type != EncodingType::Uncompressed as u8 {
1793                         return Err(DecodeError::UnsupportedCompression);
1794                 }
1795
1796                 // We expect the encoding_len to always includes the 1-byte
1797                 // encoding_type and that short_channel_ids are 8-bytes each
1798                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1799                         return Err(DecodeError::InvalidValue);
1800                 }
1801
1802                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1803                 // less the 1-byte encoding_type
1804                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1805                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1806                 for _ in 0..short_channel_id_count {
1807                         short_channel_ids.push(Readable::read(r)?);
1808                 }
1809
1810                 Ok(ReplyChannelRange {
1811                         chain_hash,
1812                         first_blocknum,
1813                         number_of_blocks,
1814                         sync_complete,
1815                         short_channel_ids
1816                 })
1817         }
1818 }
1819
1820 impl Writeable for ReplyChannelRange {
1821         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1822                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1823                 self.chain_hash.write(w)?;
1824                 self.first_blocknum.write(w)?;
1825                 self.number_of_blocks.write(w)?;
1826                 self.sync_complete.write(w)?;
1827
1828                 encoding_len.write(w)?;
1829                 (EncodingType::Uncompressed as u8).write(w)?;
1830                 for scid in self.short_channel_ids.iter() {
1831                         scid.write(w)?;
1832                 }
1833
1834                 Ok(())
1835         }
1836 }
1837
1838 impl_writeable_msg!(GossipTimestampFilter, {
1839         chain_hash,
1840         first_timestamp,
1841         timestamp_range,
1842 }, {});
1843
1844 #[cfg(test)]
1845 mod tests {
1846         use hex;
1847         use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1848         use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
1849         use ln::msgs;
1850         use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1851         use util::ser::{Writeable, Readable, Hostname};
1852
1853         use bitcoin::hashes::hex::FromHex;
1854         use bitcoin::util::address::Address;
1855         use bitcoin::network::constants::Network;
1856         use bitcoin::blockdata::script::Builder;
1857         use bitcoin::blockdata::opcodes;
1858         use bitcoin::hash_types::{Txid, BlockHash};
1859
1860         use bitcoin::secp256k1::{PublicKey,SecretKey};
1861         use bitcoin::secp256k1::{Secp256k1, Message};
1862
1863         use io::Cursor;
1864         use prelude::*;
1865         use core::convert::TryFrom;
1866
1867         #[test]
1868         fn encoding_channel_reestablish_no_secret() {
1869                 let cr = msgs::ChannelReestablish {
1870                         channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1871                         next_local_commitment_number: 3,
1872                         next_remote_commitment_number: 4,
1873                         data_loss_protect: OptionalField::Absent,
1874                 };
1875
1876                 let encoded_value = cr.encode();
1877                 assert_eq!(
1878                         encoded_value,
1879                         vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4]
1880                 );
1881         }
1882
1883         #[test]
1884         fn encoding_channel_reestablish_with_secret() {
1885                 let public_key = {
1886                         let secp_ctx = Secp256k1::new();
1887                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1888                 };
1889
1890                 let cr = msgs::ChannelReestablish {
1891                         channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1892                         next_local_commitment_number: 3,
1893                         next_remote_commitment_number: 4,
1894                         data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1895                 };
1896
1897                 let encoded_value = cr.encode();
1898                 assert_eq!(
1899                         encoded_value,
1900                         vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 3, 27, 132, 197, 86, 123, 18, 100, 64, 153, 93, 62, 213, 170, 186, 5, 101, 215, 30, 24, 52, 96, 72, 25, 255, 156, 23, 245, 233, 213, 221, 7, 143]
1901                 );
1902         }
1903
1904         macro_rules! get_keys_from {
1905                 ($slice: expr, $secp_ctx: expr) => {
1906                         {
1907                                 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1908                                 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1909                                 (privkey, pubkey)
1910                         }
1911                 }
1912         }
1913
1914         macro_rules! get_sig_on {
1915                 ($privkey: expr, $ctx: expr, $string: expr) => {
1916                         {
1917                                 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1918                                 $ctx.sign_ecdsa(&sighash, &$privkey)
1919                         }
1920                 }
1921         }
1922
1923         #[test]
1924         fn encoding_announcement_signatures() {
1925                 let secp_ctx = Secp256k1::new();
1926                 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1927                 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1928                 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1929                 let announcement_signatures = msgs::AnnouncementSignatures {
1930                         channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0],
1931                         short_channel_id: 2316138423780173,
1932                         node_signature: sig_1,
1933                         bitcoin_signature: sig_2,
1934                 };
1935
1936                 let encoded_value = announcement_signatures.encode();
1937                 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1938         }
1939
1940         fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1941                 let secp_ctx = Secp256k1::new();
1942                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1943                 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1944                 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1945                 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1946                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1947                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1948                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1949                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1950                 let mut features = ChannelFeatures::known();
1951                 if unknown_features_bits {
1952                         features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1953                 }
1954                 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1955                         features,
1956                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1957                         short_channel_id: 2316138423780173,
1958                         node_id_1: pubkey_1,
1959                         node_id_2: pubkey_2,
1960                         bitcoin_key_1: pubkey_3,
1961                         bitcoin_key_2: pubkey_4,
1962                         excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1963                 };
1964                 let channel_announcement = msgs::ChannelAnnouncement {
1965                         node_signature_1: sig_1,
1966                         node_signature_2: sig_2,
1967                         bitcoin_signature_1: sig_3,
1968                         bitcoin_signature_2: sig_4,
1969                         contents: unsigned_channel_announcement,
1970                 };
1971                 let encoded_value = channel_announcement.encode();
1972                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1973                 if unknown_features_bits {
1974                         target_value.append(&mut hex::decode("0002ffff").unwrap());
1975                 } else {
1976                         target_value.append(&mut hex::decode("0000").unwrap());
1977                 }
1978                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1979                 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1980                 if excess_data {
1981                         target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1982                 }
1983                 assert_eq!(encoded_value, target_value);
1984         }
1985
1986         #[test]
1987         fn encoding_channel_announcement() {
1988                 do_encoding_channel_announcement(true, false);
1989                 do_encoding_channel_announcement(false, true);
1990                 do_encoding_channel_announcement(false, false);
1991                 do_encoding_channel_announcement(true, true);
1992         }
1993
1994         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) {
1995                 let secp_ctx = Secp256k1::new();
1996                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1997                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1998                 let features = if unknown_features_bits {
1999                         NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2000                 } else {
2001                         // Set to some features we may support
2002                         NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2003                 };
2004                 let mut addresses = Vec::new();
2005                 if ipv4 {
2006                         addresses.push(msgs::NetAddress::IPv4 {
2007                                 addr: [255, 254, 253, 252],
2008                                 port: 9735
2009                         });
2010                 }
2011                 if ipv6 {
2012                         addresses.push(msgs::NetAddress::IPv6 {
2013                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2014                                 port: 9735
2015                         });
2016                 }
2017                 if onionv2 {
2018                         addresses.push(msgs::NetAddress::OnionV2(
2019                                 [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
2020                         ));
2021                 }
2022                 if onionv3 {
2023                         addresses.push(msgs::NetAddress::OnionV3 {
2024                                 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],
2025                                 checksum: 32,
2026                                 version: 16,
2027                                 port: 9735
2028                         });
2029                 }
2030                 if hostname {
2031                         addresses.push(msgs::NetAddress::Hostname {
2032                                 hostname: Hostname::try_from(String::from("host")).unwrap(),
2033                                 port: 9735,
2034                         });
2035                 }
2036                 let mut addr_len = 0;
2037                 for addr in &addresses {
2038                         addr_len += addr.len() + 1;
2039                 }
2040                 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2041                         features,
2042                         timestamp: 20190119,
2043                         node_id: pubkey_1,
2044                         rgb: [32; 3],
2045                         alias: [16;32],
2046                         addresses,
2047                         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() },
2048                         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() },
2049                 };
2050                 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2051                 let node_announcement = msgs::NodeAnnouncement {
2052                         signature: sig_1,
2053                         contents: unsigned_node_announcement,
2054                 };
2055                 let encoded_value = node_announcement.encode();
2056                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2057                 if unknown_features_bits {
2058                         target_value.append(&mut hex::decode("0002ffff").unwrap());
2059                 } else {
2060                         target_value.append(&mut hex::decode("000122").unwrap());
2061                 }
2062                 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2063                 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2064                 if ipv4 {
2065                         target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2066                 }
2067                 if ipv6 {
2068                         target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2069                 }
2070                 if onionv2 {
2071                         target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2072                 }
2073                 if onionv3 {
2074                         target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2075                 }
2076                 if hostname {
2077                         target_value.append(&mut hex::decode("0504686f73742607").unwrap());
2078                 }
2079                 if excess_address_data {
2080                         target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2081                 }
2082                 if excess_data {
2083                         target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2084                 }
2085                 assert_eq!(encoded_value, target_value);
2086         }
2087
2088         #[test]
2089         fn encoding_node_announcement() {
2090                 do_encoding_node_announcement(true, true, true, true, true, true, true, true);
2091                 do_encoding_node_announcement(false, false, false, false, false, false, false, false);
2092                 do_encoding_node_announcement(false, true, false, false, false, false, false, false);
2093                 do_encoding_node_announcement(false, false, true, false, false, false, false, false);
2094                 do_encoding_node_announcement(false, false, false, true, false, false, false, false);
2095                 do_encoding_node_announcement(false, false, false, false, true, false, false, false);
2096                 do_encoding_node_announcement(false, false, false, false, false, true, false, false);
2097                 do_encoding_node_announcement(false, false, false, false, false, false, true, false);
2098                 do_encoding_node_announcement(false, true, false, true, false, false, true, false);
2099                 do_encoding_node_announcement(false, false, true, false, true, false, false, false);
2100         }
2101
2102         fn do_encoding_channel_update(direction: bool, disable: bool, excess_data: bool) {
2103                 let secp_ctx = Secp256k1::new();
2104                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2105                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2106                 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2107                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2108                         short_channel_id: 2316138423780173,
2109                         timestamp: 20190119,
2110                         flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2111                         cltv_expiry_delta: 144,
2112                         htlc_minimum_msat: 1000000,
2113                         htlc_maximum_msat: 131355275467161,
2114                         fee_base_msat: 10000,
2115                         fee_proportional_millionths: 20,
2116                         excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2117                 };
2118                 let channel_update = msgs::ChannelUpdate {
2119                         signature: sig_1,
2120                         contents: unsigned_channel_update
2121                 };
2122                 let encoded_value = channel_update.encode();
2123                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2124                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2125                 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2126                 target_value.append(&mut hex::decode("01").unwrap());
2127                 target_value.append(&mut hex::decode("00").unwrap());
2128                 if direction {
2129                         let flag = target_value.last_mut().unwrap();
2130                         *flag = 1;
2131                 }
2132                 if disable {
2133                         let flag = target_value.last_mut().unwrap();
2134                         *flag = *flag | 1 << 1;
2135                 }
2136                 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2137                 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2138                 if excess_data {
2139                         target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2140                 }
2141                 assert_eq!(encoded_value, target_value);
2142         }
2143
2144         #[test]
2145         fn encoding_channel_update() {
2146                 do_encoding_channel_update(false, false, false);
2147                 do_encoding_channel_update(false, false, true);
2148                 do_encoding_channel_update(true, false, false);
2149                 do_encoding_channel_update(true, false, true);
2150                 do_encoding_channel_update(false, true, false);
2151                 do_encoding_channel_update(false, true, true);
2152                 do_encoding_channel_update(true, true, false);
2153                 do_encoding_channel_update(true, true, true);
2154         }
2155
2156         fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
2157                 let secp_ctx = Secp256k1::new();
2158                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2159                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2160                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2161                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2162                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2163                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2164                 let open_channel = msgs::OpenChannel {
2165                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2166                         temporary_channel_id: [2; 32],
2167                         funding_satoshis: 1311768467284833366,
2168                         push_msat: 2536655962884945560,
2169                         dust_limit_satoshis: 3608586615801332854,
2170                         max_htlc_value_in_flight_msat: 8517154655701053848,
2171                         channel_reserve_satoshis: 8665828695742877976,
2172                         htlc_minimum_msat: 2316138423780173,
2173                         feerate_per_kw: 821716,
2174                         to_self_delay: 49340,
2175                         max_accepted_htlcs: 49340,
2176                         funding_pubkey: pubkey_1,
2177                         revocation_basepoint: pubkey_2,
2178                         payment_point: pubkey_3,
2179                         delayed_payment_basepoint: pubkey_4,
2180                         htlc_basepoint: pubkey_5,
2181                         first_per_commitment_point: pubkey_6,
2182                         channel_flags: if random_bit { 1 << 5 } else { 0 },
2183                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2184                         channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
2185                 };
2186                 let encoded_value = open_channel.encode();
2187                 let mut target_value = Vec::new();
2188                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2189                 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2190                 if random_bit {
2191                         target_value.append(&mut hex::decode("20").unwrap());
2192                 } else {
2193                         target_value.append(&mut hex::decode("00").unwrap());
2194                 }
2195                 if shutdown {
2196                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2197                 }
2198                 if incl_chan_type {
2199                         target_value.append(&mut hex::decode("0100").unwrap());
2200                 }
2201                 assert_eq!(encoded_value, target_value);
2202         }
2203
2204         #[test]
2205         fn encoding_open_channel() {
2206                 do_encoding_open_channel(false, false, false);
2207                 do_encoding_open_channel(false, false, true);
2208                 do_encoding_open_channel(false, true, false);
2209                 do_encoding_open_channel(false, true, true);
2210                 do_encoding_open_channel(true, false, false);
2211                 do_encoding_open_channel(true, false, true);
2212                 do_encoding_open_channel(true, true, false);
2213                 do_encoding_open_channel(true, true, true);
2214         }
2215
2216         fn do_encoding_accept_channel(shutdown: bool) {
2217                 let secp_ctx = Secp256k1::new();
2218                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2219                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2220                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2221                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2222                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2223                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2224                 let accept_channel = msgs::AcceptChannel {
2225                         temporary_channel_id: [2; 32],
2226                         dust_limit_satoshis: 1311768467284833366,
2227                         max_htlc_value_in_flight_msat: 2536655962884945560,
2228                         channel_reserve_satoshis: 3608586615801332854,
2229                         htlc_minimum_msat: 2316138423780173,
2230                         minimum_depth: 821716,
2231                         to_self_delay: 49340,
2232                         max_accepted_htlcs: 49340,
2233                         funding_pubkey: pubkey_1,
2234                         revocation_basepoint: pubkey_2,
2235                         payment_point: pubkey_3,
2236                         delayed_payment_basepoint: pubkey_4,
2237                         htlc_basepoint: pubkey_5,
2238                         first_per_commitment_point: pubkey_6,
2239                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
2240                         channel_type: None,
2241                 };
2242                 let encoded_value = accept_channel.encode();
2243                 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2244                 if shutdown {
2245                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2246                 }
2247                 assert_eq!(encoded_value, target_value);
2248         }
2249
2250         #[test]
2251         fn encoding_accept_channel() {
2252                 do_encoding_accept_channel(false);
2253                 do_encoding_accept_channel(true);
2254         }
2255
2256         #[test]
2257         fn encoding_funding_created() {
2258                 let secp_ctx = Secp256k1::new();
2259                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2260                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2261                 let funding_created = msgs::FundingCreated {
2262                         temporary_channel_id: [2; 32],
2263                         funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2264                         funding_output_index: 255,
2265                         signature: sig_1,
2266                 };
2267                 let encoded_value = funding_created.encode();
2268                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2269                 assert_eq!(encoded_value, target_value);
2270         }
2271
2272         #[test]
2273         fn encoding_funding_signed() {
2274                 let secp_ctx = Secp256k1::new();
2275                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2276                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2277                 let funding_signed = msgs::FundingSigned {
2278                         channel_id: [2; 32],
2279                         signature: sig_1,
2280                 };
2281                 let encoded_value = funding_signed.encode();
2282                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2283                 assert_eq!(encoded_value, target_value);
2284         }
2285
2286         #[test]
2287         fn encoding_channel_ready() {
2288                 let secp_ctx = Secp256k1::new();
2289                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2290                 let channel_ready = msgs::ChannelReady {
2291                         channel_id: [2; 32],
2292                         next_per_commitment_point: pubkey_1,
2293                         short_channel_id_alias: None,
2294                 };
2295                 let encoded_value = channel_ready.encode();
2296                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2297                 assert_eq!(encoded_value, target_value);
2298         }
2299
2300         fn do_encoding_shutdown(script_type: u8) {
2301                 let secp_ctx = Secp256k1::new();
2302                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2303                 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2304                 let shutdown = msgs::Shutdown {
2305                         channel_id: [2; 32],
2306                         scriptpubkey:
2307                                      if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).script_pubkey() }
2308                                 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).unwrap().script_pubkey() }
2309                                 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2310                                 else                     { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2311                 };
2312                 let encoded_value = shutdown.encode();
2313                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2314                 if script_type == 1 {
2315                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2316                 } else if script_type == 2 {
2317                         target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2318                 } else if script_type == 3 {
2319                         target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2320                 } else if script_type == 4 {
2321                         target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2322                 }
2323                 assert_eq!(encoded_value, target_value);
2324         }
2325
2326         #[test]
2327         fn encoding_shutdown() {
2328                 do_encoding_shutdown(1);
2329                 do_encoding_shutdown(2);
2330                 do_encoding_shutdown(3);
2331                 do_encoding_shutdown(4);
2332         }
2333
2334         #[test]
2335         fn encoding_closing_signed() {
2336                 let secp_ctx = Secp256k1::new();
2337                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2338                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2339                 let closing_signed = msgs::ClosingSigned {
2340                         channel_id: [2; 32],
2341                         fee_satoshis: 2316138423780173,
2342                         signature: sig_1,
2343                         fee_range: None,
2344                 };
2345                 let encoded_value = closing_signed.encode();
2346                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2347                 assert_eq!(encoded_value, target_value);
2348                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2349
2350                 let closing_signed_with_range = msgs::ClosingSigned {
2351                         channel_id: [2; 32],
2352                         fee_satoshis: 2316138423780173,
2353                         signature: sig_1,
2354                         fee_range: Some(msgs::ClosingSignedFeeRange {
2355                                 min_fee_satoshis: 0xdeadbeef,
2356                                 max_fee_satoshis: 0x1badcafe01234567,
2357                         }),
2358                 };
2359                 let encoded_value_with_range = closing_signed_with_range.encode();
2360                 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2361                 assert_eq!(encoded_value_with_range, target_value_with_range);
2362                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2363                         closing_signed_with_range);
2364         }
2365
2366         #[test]
2367         fn encoding_update_add_htlc() {
2368                 let secp_ctx = Secp256k1::new();
2369                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2370                 let onion_routing_packet = msgs::OnionPacket {
2371                         version: 255,
2372                         public_key: Ok(pubkey_1),
2373                         hop_data: [1; 20*65],
2374                         hmac: [2; 32]
2375                 };
2376                 let update_add_htlc = msgs::UpdateAddHTLC {
2377                         channel_id: [2; 32],
2378                         htlc_id: 2316138423780173,
2379                         amount_msat: 3608586615801332854,
2380                         payment_hash: PaymentHash([1; 32]),
2381                         cltv_expiry: 821716,
2382                         onion_routing_packet
2383                 };
2384                 let encoded_value = update_add_htlc.encode();
2385                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2386                 assert_eq!(encoded_value, target_value);
2387         }
2388
2389         #[test]
2390         fn encoding_update_fulfill_htlc() {
2391                 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2392                         channel_id: [2; 32],
2393                         htlc_id: 2316138423780173,
2394                         payment_preimage: PaymentPreimage([1; 32]),
2395                 };
2396                 let encoded_value = update_fulfill_htlc.encode();
2397                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2398                 assert_eq!(encoded_value, target_value);
2399         }
2400
2401         #[test]
2402         fn encoding_update_fail_htlc() {
2403                 let reason = OnionErrorPacket {
2404                         data: [1; 32].to_vec(),
2405                 };
2406                 let update_fail_htlc = msgs::UpdateFailHTLC {
2407                         channel_id: [2; 32],
2408                         htlc_id: 2316138423780173,
2409                         reason
2410                 };
2411                 let encoded_value = update_fail_htlc.encode();
2412                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2413                 assert_eq!(encoded_value, target_value);
2414         }
2415
2416         #[test]
2417         fn encoding_update_fail_malformed_htlc() {
2418                 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2419                         channel_id: [2; 32],
2420                         htlc_id: 2316138423780173,
2421                         sha256_of_onion: [1; 32],
2422                         failure_code: 255
2423                 };
2424                 let encoded_value = update_fail_malformed_htlc.encode();
2425                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2426                 assert_eq!(encoded_value, target_value);
2427         }
2428
2429         fn do_encoding_commitment_signed(htlcs: bool) {
2430                 let secp_ctx = Secp256k1::new();
2431                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2432                 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2433                 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2434                 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2435                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2436                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2437                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2438                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2439                 let commitment_signed = msgs::CommitmentSigned {
2440                         channel_id: [2; 32],
2441                         signature: sig_1,
2442                         htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2443                 };
2444                 let encoded_value = commitment_signed.encode();
2445                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2446                 if htlcs {
2447                         target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2448                 } else {
2449                         target_value.append(&mut hex::decode("0000").unwrap());
2450                 }
2451                 assert_eq!(encoded_value, target_value);
2452         }
2453
2454         #[test]
2455         fn encoding_commitment_signed() {
2456                 do_encoding_commitment_signed(true);
2457                 do_encoding_commitment_signed(false);
2458         }
2459
2460         #[test]
2461         fn encoding_revoke_and_ack() {
2462                 let secp_ctx = Secp256k1::new();
2463                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2464                 let raa = msgs::RevokeAndACK {
2465                         channel_id: [2; 32],
2466                         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],
2467                         next_per_commitment_point: pubkey_1,
2468                 };
2469                 let encoded_value = raa.encode();
2470                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2471                 assert_eq!(encoded_value, target_value);
2472         }
2473
2474         #[test]
2475         fn encoding_update_fee() {
2476                 let update_fee = msgs::UpdateFee {
2477                         channel_id: [2; 32],
2478                         feerate_per_kw: 20190119,
2479                 };
2480                 let encoded_value = update_fee.encode();
2481                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2482                 assert_eq!(encoded_value, target_value);
2483         }
2484
2485         #[test]
2486         fn encoding_init() {
2487                 assert_eq!(msgs::Init {
2488                         features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2489                         remote_network_address: None,
2490                 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2491                 assert_eq!(msgs::Init {
2492                         features: InitFeatures::from_le_bytes(vec![0xFF]),
2493                         remote_network_address: None,
2494                 }.encode(), hex::decode("0001ff0001ff").unwrap());
2495                 assert_eq!(msgs::Init {
2496                         features: InitFeatures::from_le_bytes(vec![]),
2497                         remote_network_address: None,
2498                 }.encode(), hex::decode("00000000").unwrap());
2499
2500                 let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
2501                         remote_network_address: Some(msgs::NetAddress::IPv4 {
2502                                 addr: [127, 0, 0, 1],
2503                                 port: 1000,
2504                         }),
2505                 };
2506                 let encoded_value = init_msg.encode();
2507                 let target_value = hex::decode("000000000307017f00000103e8").unwrap();
2508                 assert_eq!(encoded_value, target_value);
2509                 assert_eq!(msgs::Init::read(&mut Cursor::new(&target_value)).unwrap(), init_msg);
2510         }
2511
2512         #[test]
2513         fn encoding_error() {
2514                 let error = msgs::ErrorMessage {
2515                         channel_id: [2; 32],
2516                         data: String::from("rust-lightning"),
2517                 };
2518                 let encoded_value = error.encode();
2519                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2520                 assert_eq!(encoded_value, target_value);
2521         }
2522
2523         #[test]
2524         fn encoding_warning() {
2525                 let error = msgs::WarningMessage {
2526                         channel_id: [2; 32],
2527                         data: String::from("rust-lightning"),
2528                 };
2529                 let encoded_value = error.encode();
2530                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2531                 assert_eq!(encoded_value, target_value);
2532         }
2533
2534         #[test]
2535         fn encoding_ping() {
2536                 let ping = msgs::Ping {
2537                         ponglen: 64,
2538                         byteslen: 64
2539                 };
2540                 let encoded_value = ping.encode();
2541                 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2542                 assert_eq!(encoded_value, target_value);
2543         }
2544
2545         #[test]
2546         fn encoding_pong() {
2547                 let pong = msgs::Pong {
2548                         byteslen: 64
2549                 };
2550                 let encoded_value = pong.encode();
2551                 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2552                 assert_eq!(encoded_value, target_value);
2553         }
2554
2555         #[test]
2556         fn encoding_legacy_onion_hop_data() {
2557                 let msg = msgs::OnionHopData {
2558                         format: OnionHopDataFormat::Legacy {
2559                                 short_channel_id: 0xdeadbeef1bad1dea,
2560                         },
2561                         amt_to_forward: 0x0badf00d01020304,
2562                         outgoing_cltv_value: 0xffffffff,
2563                 };
2564                 let encoded_value = msg.encode();
2565                 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2566                 assert_eq!(encoded_value, target_value);
2567         }
2568
2569         #[test]
2570         fn encoding_nonfinal_onion_hop_data() {
2571                 let mut msg = msgs::OnionHopData {
2572                         format: OnionHopDataFormat::NonFinalNode {
2573                                 short_channel_id: 0xdeadbeef1bad1dea,
2574                         },
2575                         amt_to_forward: 0x0badf00d01020304,
2576                         outgoing_cltv_value: 0xffffffff,
2577                 };
2578                 let encoded_value = msg.encode();
2579                 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2580                 assert_eq!(encoded_value, target_value);
2581                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2582                 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2583                         assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2584                 } else { panic!(); }
2585                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2586                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2587         }
2588
2589         #[test]
2590         fn encoding_final_onion_hop_data() {
2591                 let mut msg = msgs::OnionHopData {
2592                         format: OnionHopDataFormat::FinalNode {
2593                                 payment_data: None,
2594                                 keysend_preimage: None,
2595                         },
2596                         amt_to_forward: 0x0badf00d01020304,
2597                         outgoing_cltv_value: 0xffffffff,
2598                 };
2599                 let encoded_value = msg.encode();
2600                 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2601                 assert_eq!(encoded_value, target_value);
2602                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2603                 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2604                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2605                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2606         }
2607
2608         #[test]
2609         fn encoding_final_onion_hop_data_with_secret() {
2610                 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2611                 let mut msg = msgs::OnionHopData {
2612                         format: OnionHopDataFormat::FinalNode {
2613                                 payment_data: Some(FinalOnionHopData {
2614                                         payment_secret: expected_payment_secret,
2615                                         total_msat: 0x1badca1f
2616                                 }),
2617                                 keysend_preimage: None,
2618                         },
2619                         amt_to_forward: 0x0badf00d01020304,
2620                         outgoing_cltv_value: 0xffffffff,
2621                 };
2622                 let encoded_value = msg.encode();
2623                 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2624                 assert_eq!(encoded_value, target_value);
2625                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2626                 if let OnionHopDataFormat::FinalNode {
2627                         payment_data: Some(FinalOnionHopData {
2628                                 payment_secret,
2629                                 total_msat: 0x1badca1f
2630                         }),
2631                         keysend_preimage: None,
2632                 } = msg.format {
2633                         assert_eq!(payment_secret, expected_payment_secret);
2634                 } else { panic!(); }
2635                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2636                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2637         }
2638
2639         #[test]
2640         fn query_channel_range_end_blocknum() {
2641                 let tests: Vec<(u32, u32, u32)> = vec![
2642                         (10000, 1500, 11500),
2643                         (0, 0xffffffff, 0xffffffff),
2644                         (1, 0xffffffff, 0xffffffff),
2645                 ];
2646
2647                 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2648                         let sut = msgs::QueryChannelRange {
2649                                 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2650                                 first_blocknum,
2651                                 number_of_blocks,
2652                         };
2653                         assert_eq!(sut.end_blocknum(), expected);
2654                 }
2655         }
2656
2657         #[test]
2658         fn encoding_query_channel_range() {
2659                 let mut query_channel_range = msgs::QueryChannelRange {
2660                         chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2661                         first_blocknum: 100000,
2662                         number_of_blocks: 1500,
2663                 };
2664                 let encoded_value = query_channel_range.encode();
2665                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2666                 assert_eq!(encoded_value, target_value);
2667
2668                 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2669                 assert_eq!(query_channel_range.first_blocknum, 100000);
2670                 assert_eq!(query_channel_range.number_of_blocks, 1500);
2671         }
2672
2673         #[test]
2674         fn encoding_reply_channel_range() {
2675                 do_encoding_reply_channel_range(0);
2676                 do_encoding_reply_channel_range(1);
2677         }
2678
2679         fn do_encoding_reply_channel_range(encoding_type: u8) {
2680                 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2681                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2682                 let mut reply_channel_range = msgs::ReplyChannelRange {
2683                         chain_hash: expected_chain_hash,
2684                         first_blocknum: 756230,
2685                         number_of_blocks: 1500,
2686                         sync_complete: true,
2687                         short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2688                 };
2689
2690                 if encoding_type == 0 {
2691                         target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2692                         let encoded_value = reply_channel_range.encode();
2693                         assert_eq!(encoded_value, target_value);
2694
2695                         reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2696                         assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2697                         assert_eq!(reply_channel_range.first_blocknum, 756230);
2698                         assert_eq!(reply_channel_range.number_of_blocks, 1500);
2699                         assert_eq!(reply_channel_range.sync_complete, true);
2700                         assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2701                         assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2702                         assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2703                 } else {
2704                         target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2705                         let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2706                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2707                 }
2708         }
2709
2710         #[test]
2711         fn encoding_query_short_channel_ids() {
2712                 do_encoding_query_short_channel_ids(0);
2713                 do_encoding_query_short_channel_ids(1);
2714         }
2715
2716         fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2717                 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2718                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2719                 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2720                         chain_hash: expected_chain_hash,
2721                         short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2722                 };
2723
2724                 if encoding_type == 0 {
2725                         target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2726                         let encoded_value = query_short_channel_ids.encode();
2727                         assert_eq!(encoded_value, target_value);
2728
2729                         query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2730                         assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2731                         assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2732                         assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2733                         assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2734                 } else {
2735                         target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2736                         let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2737                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2738                 }
2739         }
2740
2741         #[test]
2742         fn encoding_reply_short_channel_ids_end() {
2743                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2744                 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2745                         chain_hash: expected_chain_hash,
2746                         full_information: true,
2747                 };
2748                 let encoded_value = reply_short_channel_ids_end.encode();
2749                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2750                 assert_eq!(encoded_value, target_value);
2751
2752                 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2753                 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2754                 assert_eq!(reply_short_channel_ids_end.full_information, true);
2755         }
2756
2757         #[test]
2758         fn encoding_gossip_timestamp_filter(){
2759                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2760                 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2761                         chain_hash: expected_chain_hash,
2762                         first_timestamp: 1590000000,
2763                         timestamp_range: 0xffff_ffff,
2764                 };
2765                 let encoded_value = gossip_timestamp_filter.encode();
2766                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2767                 assert_eq!(encoded_value, target_value);
2768
2769                 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2770                 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2771                 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2772                 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
2773         }
2774 }