_ 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::key::PublicKey;
  28 use bitcoin::secp256k1::Signature;
  29 use bitcoin::secp256k1;
  30 use bitcoin::blockdata::script::Script;
  31 use bitcoin::hash_types::{Txid, BlockHash};
  32
  33 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  34
  35 use std::{cmp, fmt};
  36 use std::io::Read;
  37
  38 use util::events;
  39 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
  40
  41 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
  42
  43 /// 21 million * 10^8 * 1000
  44 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
  45
  46 /// An error in decoding a message or struct.
  47 #[derive(Debug)]
  48 pub enum DecodeError {
  49         /// A version byte specified something we don't know how to handle.
  50         /// Includes unknown realm byte in an OnionHopData packet
  51         UnknownVersion,
  52         /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
  53         UnknownRequiredFeature,
  54         /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
  55         /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
  56         /// syntactically incorrect, etc
  57         InvalidValue,
  58         /// Buffer too short
  59         ShortRead,
  60         /// A length descriptor in the packet didn't describe the later data correctly
  61         BadLengthDescriptor,
  62         /// Error from std::io
  63         Io(::std::io::Error),
  64 }
  65
  66 /// An init message to be sent or received from a peer
  67 pub struct Init {
  68         #[cfg(not(feature = "fuzztarget"))]
  69         pub(crate) features: InitFeatures,
  70         #[cfg(feature = "fuzztarget")]
  71         pub features: InitFeatures,
  72 }
  73
  74 /// An error message to be sent or received from a peer
  75 #[derive(Clone)]
  76 pub struct ErrorMessage {
  77         /// The channel ID involved in the error
  78         pub channel_id: [u8; 32],
  79         /// A possibly human-readable error description.
  80         /// The string should be sanitized before it is used (e.g. emitted to logs
  81         /// or printed to stdout).  Otherwise, a well crafted error message may trigger a security
  82         /// vulnerability in the terminal emulator or the logging subsystem.
  83         pub data: String,
  84 }
  85
  86 /// A ping message to be sent or received from a peer
  87 pub struct Ping {
  88         /// The desired response length
  89         pub ponglen: u16,
  90         /// The ping packet size.
  91         /// This field is not sent on the wire. byteslen zeros are sent.
  92         pub byteslen: u16,
  93 }
  94
  95 /// A pong message to be sent or received from a peer
  96 pub struct Pong {
  97         /// The pong packet size.
  98         /// This field is not sent on the wire. byteslen zeros are sent.
  99         pub byteslen: u16,
 100 }
 101
 102 /// An open_channel message to be sent or received from a peer
 103 #[derive(Clone)]
 104 pub struct OpenChannel {
 105         /// The genesis hash of the blockchain where the channel is to be opened
 106         pub chain_hash: BlockHash,
 107         /// A temporary channel ID, until the funding outpoint is announced
 108         pub temporary_channel_id: [u8; 32],
 109         /// The channel value
 110         pub funding_satoshis: u64,
 111         /// The amount to push to the counterparty as part of the open, in milli-satoshi
 112         pub push_msat: u64,
 113         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 114         pub dust_limit_satoshis: u64,
 115         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 116         pub max_htlc_value_in_flight_msat: u64,
 117         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 118         pub channel_reserve_satoshis: u64,
 119         /// The minimum HTLC size incoming to sender, in milli-satoshi
 120         pub htlc_minimum_msat: u64,
 121         /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
 122         pub feerate_per_kw: u32,
 123         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
 124         pub to_self_delay: u16,
 125         /// The maximum number of inbound HTLCs towards sender
 126         pub max_accepted_htlcs: u16,
 127         /// The sender's key controlling the funding transaction
 128         pub funding_pubkey: PublicKey,
 129         /// Used to derive a revocation key for transactions broadcast by counterparty
 130         pub revocation_basepoint: PublicKey,
 131         /// A payment key to sender for transactions broadcast by counterparty
 132         pub payment_point: PublicKey,
 133         /// Used to derive a payment key to sender for transactions broadcast by sender
 134         pub delayed_payment_basepoint: PublicKey,
 135         /// Used to derive an HTLC payment key to sender
 136         pub htlc_basepoint: PublicKey,
 137         /// The first to-be-broadcast-by-sender transaction's per commitment point
 138         pub first_per_commitment_point: PublicKey,
 139         /// Channel flags
 140         pub channel_flags: u8,
 141         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 142         pub shutdown_scriptpubkey: OptionalField<Script>,
 143 }
 144
 145 /// An accept_channel message to be sent or received from a peer
 146 #[derive(Clone)]
 147 pub struct AcceptChannel {
 148         /// A temporary channel ID, until the funding outpoint is announced
 149         pub temporary_channel_id: [u8; 32],
 150         /// The threshold below which outputs on transactions broadcast by sender will be omitted
 151         pub dust_limit_satoshis: u64,
 152         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
 153         pub max_htlc_value_in_flight_msat: u64,
 154         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
 155         pub channel_reserve_satoshis: u64,
 156         /// The minimum HTLC size incoming to sender, in milli-satoshi
 157         pub htlc_minimum_msat: u64,
 158         /// Minimum depth of the funding transaction before the channel is considered open
 159         pub minimum_depth: u32,
 160         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
 161         pub to_self_delay: u16,
 162         /// The maximum number of inbound HTLCs towards sender
 163         pub max_accepted_htlcs: u16,
 164         /// The sender's key controlling the funding transaction
 165         pub funding_pubkey: PublicKey,
 166         /// Used to derive a revocation key for transactions broadcast by counterparty
 167         pub revocation_basepoint: PublicKey,
 168         /// A payment key to sender for transactions broadcast by counterparty
 169         pub payment_point: PublicKey,
 170         /// Used to derive a payment key to sender for transactions broadcast by sender
 171         pub delayed_payment_basepoint: PublicKey,
 172         /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
 173         pub htlc_basepoint: PublicKey,
 174         /// The first to-be-broadcast-by-sender transaction's per commitment point
 175         pub first_per_commitment_point: PublicKey,
 176         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 177         pub shutdown_scriptpubkey: OptionalField<Script>,
 178 }
 179
 180 /// A funding_created message to be sent or received from a peer
 181 #[derive(Clone)]
 182 pub struct FundingCreated {
 183         /// A temporary channel ID, until the funding is established
 184         pub temporary_channel_id: [u8; 32],
 185         /// The funding transaction ID
 186         pub funding_txid: Txid,
 187         /// The specific output index funding this channel
 188         pub funding_output_index: u16,
 189         /// The signature of the channel initiator (funder) on the funding transaction
 190         pub signature: Signature,
 191 }
 192
 193 /// A funding_signed message to be sent or received from a peer
 194 #[derive(Clone)]
 195 pub struct FundingSigned {
 196         /// The channel ID
 197         pub channel_id: [u8; 32],
 198         /// The signature of the channel acceptor (fundee) on the funding transaction
 199         pub signature: Signature,
 200 }
 201
 202 /// A funding_locked message to be sent or received from a peer
 203 #[derive(Clone, PartialEq)]
 204 pub struct FundingLocked {
 205         /// The channel ID
 206         pub channel_id: [u8; 32],
 207         /// The per-commitment point of the second commitment transaction
 208         pub next_per_commitment_point: PublicKey,
 209 }
 210
 211 /// A shutdown message to be sent or received from a peer
 212 #[derive(Clone, PartialEq)]
 213 pub struct Shutdown {
 214         /// The channel ID
 215         pub channel_id: [u8; 32],
 216         /// The destination of this peer's funds on closing.
 217         /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
 218         pub scriptpubkey: Script,
 219 }
 220
 221 /// A closing_signed message to be sent or received from a peer
 222 #[derive(Clone, PartialEq)]
 223 pub struct ClosingSigned {
 224         /// The channel ID
 225         pub channel_id: [u8; 32],
 226         /// The proposed total fee for the closing transaction
 227         pub fee_satoshis: u64,
 228         /// A signature on the closing transaction
 229         pub signature: Signature,
 230 }
 231
 232 /// An update_add_htlc message to be sent or received from a peer
 233 #[derive(Clone, PartialEq)]
 234 pub struct UpdateAddHTLC {
 235         /// The channel ID
 236         pub channel_id: [u8; 32],
 237         /// The HTLC ID
 238         pub htlc_id: u64,
 239         /// The HTLC value in milli-satoshi
 240         pub amount_msat: u64,
 241         /// The payment hash, the pre-image of which controls HTLC redemption
 242         pub payment_hash: PaymentHash,
 243         /// The expiry height of the HTLC
 244         pub cltv_expiry: u32,
 245         pub(crate) onion_routing_packet: OnionPacket,
 246 }
 247
 248 /// An update_fulfill_htlc message to be sent or received from a peer
 249 #[derive(Clone, PartialEq)]
 250 pub struct UpdateFulfillHTLC {
 251         /// The channel ID
 252         pub channel_id: [u8; 32],
 253         /// The HTLC ID
 254         pub htlc_id: u64,
 255         /// The pre-image of the payment hash, allowing HTLC redemption
 256         pub payment_preimage: PaymentPreimage,
 257 }
 258
 259 /// An update_fail_htlc message to be sent or received from a peer
 260 #[derive(Clone, PartialEq)]
 261 pub struct UpdateFailHTLC {
 262         /// The channel ID
 263         pub channel_id: [u8; 32],
 264         /// The HTLC ID
 265         pub htlc_id: u64,
 266         pub(crate) reason: OnionErrorPacket,
 267 }
 268
 269 /// An update_fail_malformed_htlc message to be sent or received from a peer
 270 #[derive(Clone, PartialEq)]
 271 pub struct UpdateFailMalformedHTLC {
 272         /// The channel ID
 273         pub channel_id: [u8; 32],
 274         /// The HTLC ID
 275         pub htlc_id: u64,
 276         pub(crate) sha256_of_onion: [u8; 32],
 277         /// The failure code
 278         pub failure_code: u16,
 279 }
 280
 281 /// A commitment_signed message to be sent or received from a peer
 282 #[derive(Clone, PartialEq)]
 283 pub struct CommitmentSigned {
 284         /// The channel ID
 285         pub channel_id: [u8; 32],
 286         /// A signature on the commitment transaction
 287         pub signature: Signature,
 288         /// Signatures on the HTLC transactions
 289         pub htlc_signatures: Vec<Signature>,
 290 }
 291
 292 /// A revoke_and_ack message to be sent or received from a peer
 293 #[derive(Clone, PartialEq)]
 294 pub struct RevokeAndACK {
 295         /// The channel ID
 296         pub channel_id: [u8; 32],
 297         /// The secret corresponding to the per-commitment point
 298         pub per_commitment_secret: [u8; 32],
 299         /// The next sender-broadcast commitment transaction's per-commitment point
 300         pub next_per_commitment_point: PublicKey,
 301 }
 302
 303 /// An update_fee message to be sent or received from a peer
 304 #[derive(PartialEq, Clone)]
 305 pub struct UpdateFee {
 306         /// The channel ID
 307         pub channel_id: [u8; 32],
 308         /// Fee rate per 1000-weight of the transaction
 309         pub feerate_per_kw: u32,
 310 }
 311
 312 #[derive(PartialEq, Clone)]
 313 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
 314 /// This is used to convince the recipient that the channel is at a certain commitment
 315 /// number even if they lost that data due to a local failure.  Of course, the peer may lie
 316 /// and even later commitments may have been revoked.
 317 pub struct DataLossProtect {
 318         /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
 319         /// belonging to the recipient
 320         pub your_last_per_commitment_secret: [u8; 32],
 321         /// The sender's per-commitment point for their current commitment transaction
 322         pub my_current_per_commitment_point: PublicKey,
 323 }
 324
 325 /// A channel_reestablish message to be sent or received from a peer
 326 #[derive(PartialEq, Clone)]
 327 pub struct ChannelReestablish {
 328         /// The channel ID
 329         pub channel_id: [u8; 32],
 330         /// The next commitment number for the sender
 331         pub next_local_commitment_number: u64,
 332         /// The next commitment number for the recipient
 333         pub next_remote_commitment_number: u64,
 334         /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
 335         pub data_loss_protect: OptionalField<DataLossProtect>,
 336 }
 337
 338 /// An announcement_signatures message to be sent or received from a peer
 339 #[derive(PartialEq, Clone, Debug)]
 340 pub struct AnnouncementSignatures {
 341         /// The channel ID
 342         pub channel_id: [u8; 32],
 343         /// The short channel ID
 344         pub short_channel_id: u64,
 345         /// A signature by the node key
 346         pub node_signature: Signature,
 347         /// A signature by the funding key
 348         pub bitcoin_signature: Signature,
 349 }
 350
 351 /// An address which can be used to connect to a remote peer
 352 #[derive(Clone, PartialEq, Debug)]
 353 pub enum NetAddress {
 354         /// An IPv4 address/port on which the peer is listening.
 355         IPv4 {
 356                 /// The 4-byte IPv4 address
 357                 addr: [u8; 4],
 358                 /// The port on which the node is listening
 359                 port: u16,
 360         },
 361         /// An IPv6 address/port on which the peer is listening.
 362         IPv6 {
 363                 /// The 16-byte IPv6 address
 364                 addr: [u8; 16],
 365                 /// The port on which the node is listening
 366                 port: u16,
 367         },
 368         /// An old-style Tor onion address/port on which the peer is listening.
 369         OnionV2 {
 370                 /// The bytes (usually encoded in base32 with ".onion" appended)
 371                 addr: [u8; 10],
 372                 /// The port on which the node is listening
 373                 port: u16,
 374         },
 375         /// A new-style Tor onion address/port on which the peer is listening.
 376         /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
 377         /// wrap as base32 and append ".onion".
 378         OnionV3 {
 379                 /// The ed25519 long-term public key of the peer
 380                 ed25519_pubkey: [u8; 32],
 381                 /// The checksum of the pubkey and version, as included in the onion address
 382                 checksum: u16,
 383                 /// The version byte, as defined by the Tor Onion v3 spec.
 384                 version: u8,
 385                 /// The port on which the node is listening
 386                 port: u16,
 387         },
 388 }
 389 impl NetAddress {
 390         fn get_id(&self) -> u8 {
 391                 match self {
 392                         &NetAddress::IPv4 {..} => { 1 },
 393                         &NetAddress::IPv6 {..} => { 2 },
 394                         &NetAddress::OnionV2 {..} => { 3 },
 395                         &NetAddress::OnionV3 {..} => { 4 },
 396                 }
 397         }
 398
 399         /// Strict byte-length of address descriptor, 1-byte type not recorded
 400         fn len(&self) -> u16 {
 401                 match self {
 402                         &NetAddress::IPv4 { .. } => { 6 },
 403                         &NetAddress::IPv6 { .. } => { 18 },
 404                         &NetAddress::OnionV2 { .. } => { 12 },
 405                         &NetAddress::OnionV3 { .. } => { 37 },
 406                 }
 407         }
 408
 409         /// The maximum length of any address descriptor, not including the 1-byte type
 410         pub(crate) const MAX_LEN: u16 = 37;
 411 }
 412
 413 impl Writeable for NetAddress {
 414         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 415                 match self {
 416                         &NetAddress::IPv4 { ref addr, ref port } => {
 417                                 1u8.write(writer)?;
 418                                 addr.write(writer)?;
 419                                 port.write(writer)?;
 420                         },
 421                         &NetAddress::IPv6 { ref addr, ref port } => {
 422                                 2u8.write(writer)?;
 423                                 addr.write(writer)?;
 424                                 port.write(writer)?;
 425                         },
 426                         &NetAddress::OnionV2 { ref addr, ref port } => {
 427                                 3u8.write(writer)?;
 428                                 addr.write(writer)?;
 429                                 port.write(writer)?;
 430                         },
 431                         &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
 432                                 4u8.write(writer)?;
 433                                 ed25519_pubkey.write(writer)?;
 434                                 checksum.write(writer)?;
 435                                 version.write(writer)?;
 436                                 port.write(writer)?;
 437                         }
 438                 }
 439                 Ok(())
 440         }
 441 }
 442
 443 impl Readable for Result<NetAddress, u8> {
 444         fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
 445                 let byte = <u8 as Readable>::read(reader)?;
 446                 match byte {
 447                         1 => {
 448                                 Ok(Ok(NetAddress::IPv4 {
 449                                         addr: Readable::read(reader)?,
 450                                         port: Readable::read(reader)?,
 451                                 }))
 452                         },
 453                         2 => {
 454                                 Ok(Ok(NetAddress::IPv6 {
 455                                         addr: Readable::read(reader)?,
 456                                         port: Readable::read(reader)?,
 457                                 }))
 458                         },
 459                         3 => {
 460                                 Ok(Ok(NetAddress::OnionV2 {
 461                                         addr: Readable::read(reader)?,
 462                                         port: Readable::read(reader)?,
 463                                 }))
 464                         },
 465                         4 => {
 466                                 Ok(Ok(NetAddress::OnionV3 {
 467                                         ed25519_pubkey: Readable::read(reader)?,
 468                                         checksum: Readable::read(reader)?,
 469                                         version: Readable::read(reader)?,
 470                                         port: Readable::read(reader)?,
 471                                 }))
 472                         },
 473                         _ => return Ok(Err(byte)),
 474                 }
 475         }
 476 }
 477
 478 /// The unsigned part of a node_announcement
 479 #[derive(PartialEq, Clone, Debug)]
 480 pub struct UnsignedNodeAnnouncement {
 481         /// The advertised features
 482         pub features: NodeFeatures,
 483         /// A strictly monotonic announcement counter, with gaps allowed
 484         pub timestamp: u32,
 485         /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
 486         /// to this node).
 487         pub node_id: PublicKey,
 488         /// An RGB color for UI purposes
 489         pub rgb: [u8; 3],
 490         /// An alias, for UI purposes.  This should be sanitized before use.  There is no guarantee
 491         /// of uniqueness.
 492         pub alias: [u8; 32],
 493         /// List of addresses on which this node is reachable
 494         pub addresses: Vec<NetAddress>,
 495         pub(crate) excess_address_data: Vec<u8>,
 496         pub(crate) excess_data: Vec<u8>,
 497 }
 498 #[derive(PartialEq, Clone, Debug)]
 499 /// A node_announcement message to be sent or received from a peer
 500 pub struct NodeAnnouncement {
 501         /// The signature by the node key
 502         pub signature: Signature,
 503         /// The actual content of the announcement
 504         pub contents: UnsignedNodeAnnouncement,
 505 }
 506
 507 /// The unsigned part of a channel_announcement
 508 #[derive(PartialEq, Clone, Debug)]
 509 pub struct UnsignedChannelAnnouncement {
 510         /// The advertised channel features
 511         pub features: ChannelFeatures,
 512         /// The genesis hash of the blockchain where the channel is to be opened
 513         pub chain_hash: BlockHash,
 514         /// The short channel ID
 515         pub short_channel_id: u64,
 516         /// One of the two node_ids which are endpoints of this channel
 517         pub node_id_1: PublicKey,
 518         /// The other of the two node_ids which are endpoints of this channel
 519         pub node_id_2: PublicKey,
 520         /// The funding key for the first node
 521         pub bitcoin_key_1: PublicKey,
 522         /// The funding key for the second node
 523         pub bitcoin_key_2: PublicKey,
 524         pub(crate) excess_data: Vec<u8>,
 525 }
 526 /// A channel_announcement message to be sent or received from a peer
 527 #[derive(PartialEq, Clone, Debug)]
 528 pub struct ChannelAnnouncement {
 529         /// Authentication of the announcement by the first public node
 530         pub node_signature_1: Signature,
 531         /// Authentication of the announcement by the second public node
 532         pub node_signature_2: Signature,
 533         /// Proof of funding UTXO ownership by the first public node
 534         pub bitcoin_signature_1: Signature,
 535         /// Proof of funding UTXO ownership by the second public node
 536         pub bitcoin_signature_2: Signature,
 537         /// The actual announcement
 538         pub contents: UnsignedChannelAnnouncement,
 539 }
 540
 541 /// The unsigned part of a channel_update
 542 #[derive(PartialEq, Clone, Debug)]
 543 pub struct UnsignedChannelUpdate {
 544         /// The genesis hash of the blockchain where the channel is to be opened
 545         pub chain_hash: BlockHash,
 546         /// The short channel ID
 547         pub short_channel_id: u64,
 548         /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
 549         pub timestamp: u32,
 550         /// Channel flags
 551         pub flags: u8,
 552         /// The number of blocks to subtract from incoming HTLC cltv_expiry values
 553         pub cltv_expiry_delta: u16,
 554         /// The minimum HTLC size incoming to sender, in milli-satoshi
 555         pub htlc_minimum_msat: u64,
 556         /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
 557         pub htlc_maximum_msat: OptionalField<u64>,
 558         /// The base HTLC fee charged by sender, in milli-satoshi
 559         pub fee_base_msat: u32,
 560         /// The amount to fee multiplier, in micro-satoshi
 561         pub fee_proportional_millionths: u32,
 562         pub(crate) excess_data: Vec<u8>,
 563 }
 564 /// A channel_update message to be sent or received from a peer
 565 #[derive(PartialEq, Clone, Debug)]
 566 pub struct ChannelUpdate {
 567         /// A signature of the channel update
 568         pub signature: Signature,
 569         /// The actual channel update
 570         pub contents: UnsignedChannelUpdate,
 571 }
 572
 573 /// Used to put an error message in a LightningError
 574 #[derive(Clone)]
 575 pub enum ErrorAction {
 576         /// The peer took some action which made us think they were useless. Disconnect them.
 577         DisconnectPeer {
 578                 /// An error message which we should make an effort to send before we disconnect.
 579                 msg: Option<ErrorMessage>
 580         },
 581         /// The peer did something harmless that we weren't able to process, just log and ignore
 582         IgnoreError,
 583         /// The peer did something incorrect. Tell them.
 584         SendErrorMessage {
 585                 /// The message to send.
 586                 msg: ErrorMessage
 587         },
 588 }
 589
 590 /// An Err type for failure to process messages.
 591 pub struct LightningError {
 592         /// A human-readable message describing the error
 593         pub err: String,
 594         /// The action which should be taken against the offending peer.
 595         pub action: ErrorAction,
 596 }
 597
 598 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
 599 /// transaction updates if they were pending.
 600 #[derive(PartialEq, Clone)]
 601 pub struct CommitmentUpdate {
 602         /// update_add_htlc messages which should be sent
 603         pub update_add_htlcs: Vec<UpdateAddHTLC>,
 604         /// update_fulfill_htlc messages which should be sent
 605         pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
 606         /// update_fail_htlc messages which should be sent
 607         pub update_fail_htlcs: Vec<UpdateFailHTLC>,
 608         /// update_fail_malformed_htlc messages which should be sent
 609         pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
 610         /// An update_fee message which should be sent
 611         pub update_fee: Option<UpdateFee>,
 612         /// Finally, the commitment_signed message which should be sent
 613         pub commitment_signed: CommitmentSigned,
 614 }
 615
 616 /// The information we received from a peer along the route of a payment we originated. This is
 617 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
 618 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
 619 #[derive(Clone)]
 620 pub enum HTLCFailChannelUpdate {
 621         /// We received an error which included a full ChannelUpdate message.
 622         ChannelUpdateMessage {
 623                 /// The unwrapped message we received
 624                 msg: ChannelUpdate,
 625         },
 626         /// We received an error which indicated only that a channel has been closed
 627         ChannelClosed {
 628                 /// The short_channel_id which has now closed.
 629                 short_channel_id: u64,
 630                 /// when this true, this channel should be permanently removed from the
 631                 /// consideration. Otherwise, this channel can be restored as new channel_update is received
 632                 is_permanent: bool,
 633         },
 634         /// We received an error which indicated only that a node has failed
 635         NodeFailure {
 636                 /// The node_id that has failed.
 637                 node_id: PublicKey,
 638                 /// when this true, node should be permanently removed from the
 639                 /// consideration. Otherwise, the channels connected to this node can be
 640                 /// restored as new channel_update is received
 641                 is_permanent: bool,
 642         }
 643 }
 644
 645 /// Messages could have optional fields to use with extended features
 646 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
 647 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
 648 /// separate enum type for them.
 649 #[derive(Clone, PartialEq, Debug)]
 650 pub enum OptionalField<T> {
 651         /// Optional field is included in message
 652         Present(T),
 653         /// Optional field is absent in message
 654         Absent
 655 }
 656
 657 /// A trait to describe an object which can receive channel messages.
 658 ///
 659 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
 660 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
 661 pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
 662         //Channel init:
 663         /// Handle an incoming open_channel message from the given peer.
 664         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
 665         /// Handle an incoming accept_channel message from the given peer.
 666         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
 667         /// Handle an incoming funding_created message from the given peer.
 668         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
 669         /// Handle an incoming funding_signed message from the given peer.
 670         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
 671         /// Handle an incoming funding_locked message from the given peer.
 672         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
 673
 674         // Channl close:
 675         /// Handle an incoming shutdown message from the given peer.
 676         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
 677         /// Handle an incoming closing_signed message from the given peer.
 678         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
 679
 680         // HTLC handling:
 681         /// Handle an incoming update_add_htlc message from the given peer.
 682         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
 683         /// Handle an incoming update_fulfill_htlc message from the given peer.
 684         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
 685         /// Handle an incoming update_fail_htlc message from the given peer.
 686         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
 687         /// Handle an incoming update_fail_malformed_htlc message from the given peer.
 688         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
 689         /// Handle an incoming commitment_signed message from the given peer.
 690         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
 691         /// Handle an incoming revoke_and_ack message from the given peer.
 692         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
 693
 694         /// Handle an incoming update_fee message from the given peer.
 695         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
 696
 697         // Channel-to-announce:
 698         /// Handle an incoming announcement_signatures message from the given peer.
 699         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
 700
 701         // Connection loss/reestablish:
 702         /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
 703         /// is believed to be possible in the future (eg they're sending us messages we don't
 704         /// understand or indicate they require unknown feature bits), no_connection_possible is set
 705         /// and any outstanding channels should be failed.
 706         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
 707
 708         /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
 709         fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
 710         /// Handle an incoming channel_reestablish message from the given peer.
 711         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
 712
 713         // Error:
 714         /// Handle an incoming error message from the given peer.
 715         fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
 716 }
 717
 718 /// A trait to describe an object which can receive routing messages.
 719 pub trait RoutingMessageHandler : Send + Sync {
 720         /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
 721         /// false or returning an Err otherwise.
 722         fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
 723         /// Handle a channel_announcement message, returning true if it should be forwarded on, false
 724         /// or returning an Err otherwise.
 725         fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
 726         /// Handle an incoming channel_update message, returning true if it should be forwarded on,
 727         /// false or returning an Err otherwise.
 728         fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
 729         /// Handle some updates to the route graph that we learned due to an outbound failed payment.
 730         fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
 731         /// Gets a subset of the channel announcements and updates required to dump our routing table
 732         /// to a remote node, starting at the short_channel_id indicated by starting_point and
 733         /// including the batch_amount entries immediately higher in numerical value than starting_point.
 734         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
 735         /// Gets a subset of the node announcements required to dump our routing table to a remote node,
 736         /// starting at the node *after* the provided publickey and including batch_amount entries
 737         /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
 738         /// If None is provided for starting_point, we start at the first node.
 739         fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
 740         /// Returns whether a full sync should be requested from a peer.
 741         fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
 742 }
 743
 744 mod fuzzy_internal_msgs {
 745         use ln::channelmanager::PaymentSecret;
 746
 747         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
 748         // them from untrusted input):
 749         #[derive(Clone)]
 750         pub(crate) struct FinalOnionHopData {
 751                 pub(crate) payment_secret: PaymentSecret,
 752                 /// The total value, in msat, of the payment as received by the ultimate recipient.
 753                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
 754                 pub(crate) total_msat: u64,
 755         }
 756
 757         pub(crate) enum OnionHopDataFormat {
 758                 Legacy { // aka Realm-0
 759                         short_channel_id: u64,
 760                 },
 761                 NonFinalNode {
 762                         short_channel_id: u64,
 763                 },
 764                 FinalNode {
 765                         payment_data: Option<FinalOnionHopData>,
 766                 },
 767         }
 768
 769         pub struct OnionHopData {
 770                 pub(crate) format: OnionHopDataFormat,
 771                 /// The value, in msat, of the payment after this hop's fee is deducted.
 772                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
 773                 pub(crate) amt_to_forward: u64,
 774                 pub(crate) outgoing_cltv_value: u32,
 775                 // 12 bytes of 0-padding for Legacy format
 776         }
 777
 778         pub struct DecodedOnionErrorPacket {
 779                 pub(crate) hmac: [u8; 32],
 780                 pub(crate) failuremsg: Vec<u8>,
 781                 pub(crate) pad: Vec<u8>,
 782         }
 783 }
 784 #[cfg(feature = "fuzztarget")]
 785 pub use self::fuzzy_internal_msgs::*;
 786 #[cfg(not(feature = "fuzztarget"))]
 787 pub(crate) use self::fuzzy_internal_msgs::*;
 788
 789 #[derive(Clone)]
 790 pub(crate) struct OnionPacket {
 791         pub(crate) version: u8,
 792         /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
 793         /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
 794         /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
 795         pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
 796         pub(crate) hop_data: [u8; 20*65],
 797         pub(crate) hmac: [u8; 32],
 798 }
 799
 800 impl PartialEq for OnionPacket {
 801         fn eq(&self, other: &OnionPacket) -> bool {
 802                 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
 803                         if i != j { return false; }
 804                 }
 805                 self.version == other.version &&
 806                         self.public_key == other.public_key &&
 807                         self.hmac == other.hmac
 808         }
 809 }
 810
 811 #[derive(Clone, PartialEq)]
 812 pub(crate) struct OnionErrorPacket {
 813         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
 814         // (TODO) We limit it in decode to much lower...
 815         pub(crate) data: Vec<u8>,
 816 }
 817
 818 impl fmt::Display for DecodeError {
 819         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 820                 match *self {
 821                         DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
 822                         DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
 823                         DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
 824                         DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
 825                         DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
 826                         DecodeError::Io(ref e) => e.fmt(f),
 827                 }
 828         }
 829 }
 830
 831 impl fmt::Debug for LightningError {
 832         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 833                 f.write_str(self.err.as_str())
 834         }
 835 }
 836
 837 impl From<::std::io::Error> for DecodeError {
 838         fn from(e: ::std::io::Error) -> Self {
 839                 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
 840                         DecodeError::ShortRead
 841                 } else {
 842                         DecodeError::Io(e)
 843                 }
 844         }
 845 }
 846
 847 impl Writeable for OptionalField<Script> {
 848         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 849                 match *self {
 850                         OptionalField::Present(ref script) => {
 851                                 // Note that Writeable for script includes the 16-bit length tag for us
 852                                 script.write(w)?;
 853                         },
 854                         OptionalField::Absent => {}
 855                 }
 856                 Ok(())
 857         }
 858 }
 859
 860 impl Readable for OptionalField<Script> {
 861         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 862                 match <u16 as Readable>::read(r) {
 863                         Ok(len) => {
 864                                 let mut buf = vec![0; len as usize];
 865                                 r.read_exact(&mut buf)?;
 866                                 Ok(OptionalField::Present(Script::from(buf)))
 867                         },
 868                         Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
 869                         Err(e) => Err(e)
 870                 }
 871         }
 872 }
 873
 874 impl Writeable for OptionalField<u64> {
 875         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 876                 match *self {
 877                         OptionalField::Present(ref value) => {
 878                                 value.write(w)?;
 879                         },
 880                         OptionalField::Absent => {}
 881                 }
 882                 Ok(())
 883         }
 884 }
 885
 886 impl Readable for OptionalField<u64> {
 887         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 888                 let value: u64 = Readable::read(r)?;
 889                 Ok(OptionalField::Present(value))
 890         }
 891 }
 892
 893
 894 impl_writeable_len_match!(AcceptChannel, {
 895                 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
 896                 {_, 270}
 897         }, {
 898         temporary_channel_id,
 899         dust_limit_satoshis,
 900         max_htlc_value_in_flight_msat,
 901         channel_reserve_satoshis,
 902         htlc_minimum_msat,
 903         minimum_depth,
 904         to_self_delay,
 905         max_accepted_htlcs,
 906         funding_pubkey,
 907         revocation_basepoint,
 908         payment_point,
 909         delayed_payment_basepoint,
 910         htlc_basepoint,
 911         first_per_commitment_point,
 912         shutdown_scriptpubkey
 913 });
 914
 915 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
 916         channel_id,
 917         short_channel_id,
 918         node_signature,
 919         bitcoin_signature
 920 });
 921
 922 impl Writeable for ChannelReestablish {
 923         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 924                 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
 925                 self.channel_id.write(w)?;
 926                 self.next_local_commitment_number.write(w)?;
 927                 self.next_remote_commitment_number.write(w)?;
 928                 match self.data_loss_protect {
 929                         OptionalField::Present(ref data_loss_protect) => {
 930                                 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
 931                                 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
 932                         },
 933                         OptionalField::Absent => {}
 934                 }
 935                 Ok(())
 936         }
 937 }
 938
 939 impl Readable for ChannelReestablish{
 940         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 941                 Ok(Self {
 942                         channel_id: Readable::read(r)?,
 943                         next_local_commitment_number: Readable::read(r)?,
 944                         next_remote_commitment_number: Readable::read(r)?,
 945                         data_loss_protect: {
 946                                 match <[u8; 32] as Readable>::read(r) {
 947                                         Ok(your_last_per_commitment_secret) =>
 948                                                 OptionalField::Present(DataLossProtect {
 949                                                         your_last_per_commitment_secret,
 950                                                         my_current_per_commitment_point: Readable::read(r)?,
 951                                                 }),
 952                                         Err(DecodeError::ShortRead) => OptionalField::Absent,
 953                                         Err(e) => return Err(e)
 954                                 }
 955                         }
 956                 })
 957         }
 958 }
 959
 960 impl_writeable!(ClosingSigned, 32+8+64, {
 961         channel_id,
 962         fee_satoshis,
 963         signature
 964 });
 965
 966 impl_writeable_len_match!(CommitmentSigned, {
 967                 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
 968         }, {
 969         channel_id,
 970         signature,
 971         htlc_signatures
 972 });
 973
 974 impl_writeable_len_match!(DecodedOnionErrorPacket, {
 975                 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
 976         }, {
 977         hmac,
 978         failuremsg,
 979         pad
 980 });
 981
 982 impl_writeable!(FundingCreated, 32+32+2+64, {
 983         temporary_channel_id,
 984         funding_txid,
 985         funding_output_index,
 986         signature
 987 });
 988
 989 impl_writeable!(FundingSigned, 32+64, {
 990         channel_id,
 991         signature
 992 });
 993
 994 impl_writeable!(FundingLocked, 32+33, {
 995         channel_id,
 996         next_per_commitment_point
 997 });
 998
 999 impl Writeable for Init {
1000         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1001                 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1002                 // our relevant feature bits. This keeps us compatible with old nodes.
1003                 self.features.write_up_to_13(w)?;
1004                 self.features.write(w)
1005         }
1006 }
1007
1008 impl Readable for Init {
1009         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1010                 let global_features: InitFeatures = Readable::read(r)?;
1011                 let features: InitFeatures = Readable::read(r)?;
1012                 Ok(Init {
1013                         features: features.or(global_features),
1014                 })
1015         }
1016 }
1017
1018 impl_writeable_len_match!(OpenChannel, {
1019                 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1020                 { _, 319 }
1021         }, {
1022         chain_hash,
1023         temporary_channel_id,
1024         funding_satoshis,
1025         push_msat,
1026         dust_limit_satoshis,
1027         max_htlc_value_in_flight_msat,
1028         channel_reserve_satoshis,
1029         htlc_minimum_msat,
1030         feerate_per_kw,
1031         to_self_delay,
1032         max_accepted_htlcs,
1033         funding_pubkey,
1034         revocation_basepoint,
1035         payment_point,
1036         delayed_payment_basepoint,
1037         htlc_basepoint,
1038         first_per_commitment_point,
1039         channel_flags,
1040         shutdown_scriptpubkey
1041 });
1042
1043 impl_writeable!(RevokeAndACK, 32+32+33, {
1044         channel_id,
1045         per_commitment_secret,
1046         next_per_commitment_point
1047 });
1048
1049 impl_writeable_len_match!(Shutdown, {
1050                 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1051         }, {
1052         channel_id,
1053         scriptpubkey
1054 });
1055
1056 impl_writeable_len_match!(UpdateFailHTLC, {
1057                 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1058         }, {
1059         channel_id,
1060         htlc_id,
1061         reason
1062 });
1063
1064 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1065         channel_id,
1066         htlc_id,
1067         sha256_of_onion,
1068         failure_code
1069 });
1070
1071 impl_writeable!(UpdateFee, 32+4, {
1072         channel_id,
1073         feerate_per_kw
1074 });
1075
1076 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1077         channel_id,
1078         htlc_id,
1079         payment_preimage
1080 });
1081
1082 impl_writeable_len_match!(OnionErrorPacket, {
1083                 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1084         }, {
1085         data
1086 });
1087
1088 impl Writeable for OnionPacket {
1089         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1090                 w.size_hint(1 + 33 + 20*65 + 32);
1091                 self.version.write(w)?;
1092                 match self.public_key {
1093                         Ok(pubkey) => pubkey.write(w)?,
1094                         Err(_) => [0u8;33].write(w)?,
1095                 }
1096                 w.write_all(&self.hop_data)?;
1097                 self.hmac.write(w)?;
1098                 Ok(())
1099         }
1100 }
1101
1102 impl Readable for OnionPacket {
1103         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1104                 Ok(OnionPacket {
1105                         version: Readable::read(r)?,
1106                         public_key: {
1107                                 let mut buf = [0u8;33];
1108                                 r.read_exact(&mut buf)?;
1109                                 PublicKey::from_slice(&buf)
1110                         },
1111                         hop_data: Readable::read(r)?,
1112                         hmac: Readable::read(r)?,
1113                 })
1114         }
1115 }
1116
1117 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1118         channel_id,
1119         htlc_id,
1120         amount_msat,
1121         payment_hash,
1122         cltv_expiry,
1123         onion_routing_packet
1124 });
1125
1126 impl Writeable for FinalOnionHopData {
1127         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1128                 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1129                 self.payment_secret.0.write(w)?;
1130                 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1131         }
1132 }
1133
1134 impl Readable for FinalOnionHopData {
1135         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1136                 let secret: [u8; 32] = Readable::read(r)?;
1137                 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1138                 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1139         }
1140 }
1141
1142 impl Writeable for OnionHopData {
1143         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1144                 w.size_hint(33);
1145                 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1146                 // check values are sane long before we get here, though its possible in the future
1147                 // user-generated messages may hit this.
1148                 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1149                 match self.format {
1150                         OnionHopDataFormat::Legacy { short_channel_id } => {
1151                                 0u8.write(w)?;
1152                                 short_channel_id.write(w)?;
1153                                 self.amt_to_forward.write(w)?;
1154                                 self.outgoing_cltv_value.write(w)?;
1155                                 w.write_all(&[0;12])?;
1156                         },
1157                         OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1158                                 encode_varint_length_prefixed_tlv!(w, {
1159                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1160                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1161                                         (6, short_channel_id)
1162                                 });
1163                         },
1164                         OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1165                                 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1166                                 encode_varint_length_prefixed_tlv!(w, {
1167                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1168                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1169                                         (8, final_data)
1170                                 });
1171                         },
1172                         OnionHopDataFormat::FinalNode { payment_data: None } => {
1173                                 encode_varint_length_prefixed_tlv!(w, {
1174                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1175                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1176                                 });
1177                         },
1178                 }
1179                 Ok(())
1180         }
1181 }
1182
1183 impl Readable for OnionHopData {
1184         fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1185                 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1186                 let v: VarInt = Decodable::consensus_decode(&mut r)
1187                         .map_err(|e| match e {
1188                                 Error::Io(ioe) => DecodeError::from(ioe),
1189                                 _ => DecodeError::InvalidValue
1190                         })?;
1191                 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1192                 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1193                         let mut rd = FixedLengthReader::new(r, v.0);
1194                         let mut amt = HighZeroBytesDroppedVarInt(0u64);
1195                         let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1196                         let mut short_id: Option<u64> = None;
1197                         let mut payment_data: Option<FinalOnionHopData> = None;
1198                         decode_tlv!(&mut rd, {
1199                                 (2, amt),
1200                                 (4, cltv_value)
1201                         }, {
1202                                 (6, short_id),
1203                                 (8, payment_data)
1204                         });
1205                         rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1206                         let format = if let Some(short_channel_id) = short_id {
1207                                 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1208                                 OnionHopDataFormat::NonFinalNode {
1209                                         short_channel_id,
1210                                 }
1211                         } else {
1212                                 if let &Some(ref data) = &payment_data {
1213                                         if data.total_msat > MAX_VALUE_MSAT {
1214                                                 return Err(DecodeError::InvalidValue);
1215                                         }
1216                                 }
1217                                 OnionHopDataFormat::FinalNode {
1218                                         payment_data
1219                                 }
1220                         };
1221                         (format, amt.0, cltv_value.0)
1222                 } else {
1223                         let format = OnionHopDataFormat::Legacy {
1224                                 short_channel_id: Readable::read(r)?,
1225                         };
1226                         let amt: u64 = Readable::read(r)?;
1227                         let cltv_value: u32 = Readable::read(r)?;
1228                         r.read_exact(&mut [0; 12])?;
1229                         (format, amt, cltv_value)
1230                 };
1231
1232                 if amt > MAX_VALUE_MSAT {
1233                         return Err(DecodeError::InvalidValue);
1234                 }
1235                 Ok(OnionHopData {
1236                         format,
1237                         amt_to_forward: amt,
1238                         outgoing_cltv_value: cltv_value,
1239                 })
1240         }
1241 }
1242
1243 impl Writeable for Ping {
1244         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1245                 w.size_hint(self.byteslen as usize + 4);
1246                 self.ponglen.write(w)?;
1247                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1248                 Ok(())
1249         }
1250 }
1251
1252 impl Readable for Ping {
1253         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1254                 Ok(Ping {
1255                         ponglen: Readable::read(r)?,
1256                         byteslen: {
1257                                 let byteslen = Readable::read(r)?;
1258                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1259                                 byteslen
1260                         }
1261                 })
1262         }
1263 }
1264
1265 impl Writeable for Pong {
1266         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1267                 w.size_hint(self.byteslen as usize + 2);
1268                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1269                 Ok(())
1270         }
1271 }
1272
1273 impl Readable for Pong {
1274         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1275                 Ok(Pong {
1276                         byteslen: {
1277                                 let byteslen = Readable::read(r)?;
1278                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1279                                 byteslen
1280                         }
1281                 })
1282         }
1283 }
1284
1285 impl Writeable for UnsignedChannelAnnouncement {
1286         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1287                 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1288                 self.features.write(w)?;
1289                 self.chain_hash.write(w)?;
1290                 self.short_channel_id.write(w)?;
1291                 self.node_id_1.write(w)?;
1292                 self.node_id_2.write(w)?;
1293                 self.bitcoin_key_1.write(w)?;
1294                 self.bitcoin_key_2.write(w)?;
1295                 w.write_all(&self.excess_data[..])?;
1296                 Ok(())
1297         }
1298 }
1299
1300 impl Readable for UnsignedChannelAnnouncement {
1301         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1302                 Ok(Self {
1303                         features: Readable::read(r)?,
1304                         chain_hash: Readable::read(r)?,
1305                         short_channel_id: Readable::read(r)?,
1306                         node_id_1: Readable::read(r)?,
1307                         node_id_2: Readable::read(r)?,
1308                         bitcoin_key_1: Readable::read(r)?,
1309                         bitcoin_key_2: Readable::read(r)?,
1310                         excess_data: {
1311                                 let mut excess_data = vec![];
1312                                 r.read_to_end(&mut excess_data)?;
1313                                 excess_data
1314                         },
1315                 })
1316         }
1317 }
1318
1319 impl_writeable_len_match!(ChannelAnnouncement, {
1320                 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1321                         2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1322         }, {
1323         node_signature_1,
1324         node_signature_2,
1325         bitcoin_signature_1,
1326         bitcoin_signature_2,
1327         contents
1328 });
1329
1330 impl Writeable for UnsignedChannelUpdate {
1331         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1332                 let mut size = 64 + self.excess_data.len();
1333                 let mut message_flags: u8 = 0;
1334                 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1335                         size += 8;
1336                         message_flags = 1;
1337                 }
1338                 w.size_hint(size);
1339                 self.chain_hash.write(w)?;
1340                 self.short_channel_id.write(w)?;
1341                 self.timestamp.write(w)?;
1342                 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1343                 all_flags.write(w)?;
1344                 self.cltv_expiry_delta.write(w)?;
1345                 self.htlc_minimum_msat.write(w)?;
1346                 self.fee_base_msat.write(w)?;
1347                 self.fee_proportional_millionths.write(w)?;
1348                 self.htlc_maximum_msat.write(w)?;
1349                 w.write_all(&self.excess_data[..])?;
1350                 Ok(())
1351         }
1352 }
1353
1354 impl Readable for UnsignedChannelUpdate {
1355         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1356                 let has_htlc_maximum_msat;
1357                 Ok(Self {
1358                         chain_hash: Readable::read(r)?,
1359                         short_channel_id: Readable::read(r)?,
1360                         timestamp: Readable::read(r)?,
1361                         flags: {
1362                                 let flags: u16 = Readable::read(r)?;
1363                                 let message_flags = flags >> 8;
1364                                 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1365                                 flags as u8
1366                         },
1367                         cltv_expiry_delta: Readable::read(r)?,
1368                         htlc_minimum_msat: Readable::read(r)?,
1369                         fee_base_msat: Readable::read(r)?,
1370                         fee_proportional_millionths: Readable::read(r)?,
1371                         htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1372                         excess_data: {
1373                                 let mut excess_data = vec![];
1374                                 r.read_to_end(&mut excess_data)?;
1375                                 excess_data
1376                         },
1377                 })
1378         }
1379 }
1380
1381 impl_writeable_len_match!(ChannelUpdate, {
1382                 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1383                         64 + excess_data.len() + 64 }
1384         }, {
1385         signature,
1386         contents
1387 });
1388
1389 impl Writeable for ErrorMessage {
1390         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1391                 w.size_hint(32 + 2 + self.data.len());
1392                 self.channel_id.write(w)?;
1393                 (self.data.len() as u16).write(w)?;
1394                 w.write_all(self.data.as_bytes())?;
1395                 Ok(())
1396         }
1397 }
1398
1399 impl Readable for ErrorMessage {
1400         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1401                 Ok(Self {
1402                         channel_id: Readable::read(r)?,
1403                         data: {
1404                                 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1405                                 let mut data = vec![];
1406                                 let data_len = r.read_to_end(&mut data)?;
1407                                 sz = cmp::min(data_len, sz);
1408                                 match String::from_utf8(data[..sz as usize].to_vec()) {
1409                                         Ok(s) => s,
1410                                         Err(_) => return Err(DecodeError::InvalidValue),
1411                                 }
1412                         }
1413                 })
1414         }
1415 }
1416
1417 impl Writeable for UnsignedNodeAnnouncement {
1418         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1419                 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1420                 self.features.write(w)?;
1421                 self.timestamp.write(w)?;
1422                 self.node_id.write(w)?;
1423                 w.write_all(&self.rgb)?;
1424                 self.alias.write(w)?;
1425
1426                 let mut addrs_to_encode = self.addresses.clone();
1427                 addrs_to_encode.sort_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1428                 let mut addr_len = 0;
1429                 for addr in &addrs_to_encode {
1430                         addr_len += 1 + addr.len();
1431                 }
1432                 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1433                 for addr in addrs_to_encode {
1434                         addr.write(w)?;
1435                 }
1436                 w.write_all(&self.excess_address_data[..])?;
1437                 w.write_all(&self.excess_data[..])?;
1438                 Ok(())
1439         }
1440 }
1441
1442 impl Readable for UnsignedNodeAnnouncement {
1443         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1444                 let features: NodeFeatures = Readable::read(r)?;
1445                 let timestamp: u32 = Readable::read(r)?;
1446                 let node_id: PublicKey = Readable::read(r)?;
1447                 let mut rgb = [0; 3];
1448                 r.read_exact(&mut rgb)?;
1449                 let alias: [u8; 32] = Readable::read(r)?;
1450
1451                 let addr_len: u16 = Readable::read(r)?;
1452                 let mut addresses: Vec<NetAddress> = Vec::new();
1453                 let mut highest_addr_type = 0;
1454                 let mut addr_readpos = 0;
1455                 let mut excess = false;
1456                 let mut excess_byte = 0;
1457                 loop {
1458                         if addr_len <= addr_readpos { break; }
1459                         match Readable::read(r) {
1460                                 Ok(Ok(addr)) => {
1461                                         if addr.get_id() < highest_addr_type {
1462                                                 // Addresses must be sorted in increasing order
1463                                                 return Err(DecodeError::InvalidValue);
1464                                         }
1465                                         highest_addr_type = addr.get_id();
1466                                         if addr_len < addr_readpos + 1 + addr.len() {
1467                                                 return Err(DecodeError::BadLengthDescriptor);
1468                                         }
1469                                         addr_readpos += (1 + addr.len()) as u16;
1470                                         addresses.push(addr);
1471                                 },
1472                                 Ok(Err(unknown_descriptor)) => {
1473                                         excess = true;
1474                                         excess_byte = unknown_descriptor;
1475                                         break;
1476                                 },
1477                                 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1478                                 Err(e) => return Err(e),
1479                         }
1480                 }
1481
1482                 let mut excess_data = vec![];
1483                 let excess_address_data = if addr_readpos < addr_len {
1484                         let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1485                         r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1486                         if excess {
1487                                 excess_address_data[0] = excess_byte;
1488                         }
1489                         excess_address_data
1490                 } else {
1491                         if excess {
1492                                 excess_data.push(excess_byte);
1493                         }
1494                         Vec::new()
1495                 };
1496                 r.read_to_end(&mut excess_data)?;
1497                 Ok(UnsignedNodeAnnouncement {
1498                         features,
1499                         timestamp,
1500                         node_id,
1501                         rgb,
1502                         alias,
1503                         addresses,
1504                         excess_address_data,
1505                         excess_data,
1506                 })
1507         }
1508 }
1509
1510 impl_writeable_len_match!(NodeAnnouncement, {
1511                 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1512                         64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1513         }, {
1514         signature,
1515         contents
1516 });
1517
1518 #[cfg(test)]
1519 mod tests {
1520         use hex;
1521         use ln::msgs;
1522         use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1523         use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
1524         use util::ser::{Writeable, Readable};
1525
1526         use bitcoin::hashes::hex::FromHex;
1527         use bitcoin::util::address::Address;
1528         use bitcoin::network::constants::Network;
1529         use bitcoin::blockdata::script::Builder;
1530         use bitcoin::blockdata::opcodes;
1531         use bitcoin::hash_types::{Txid, BlockHash};
1532
1533         use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1534         use bitcoin::secp256k1::{Secp256k1, Message};
1535
1536         use std::io::Cursor;
1537
1538         #[test]
1539         fn encoding_channel_reestablish_no_secret() {
1540                 let cr = msgs::ChannelReestablish {
1541                         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],
1542                         next_local_commitment_number: 3,
1543                         next_remote_commitment_number: 4,
1544                         data_loss_protect: OptionalField::Absent,
1545                 };
1546
1547                 let encoded_value = cr.encode();
1548                 assert_eq!(
1549                         encoded_value,
1550                         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]
1551                 );
1552         }
1553
1554         #[test]
1555         fn encoding_channel_reestablish_with_secret() {
1556                 let public_key = {
1557                         let secp_ctx = Secp256k1::new();
1558                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1559                 };
1560
1561                 let cr = msgs::ChannelReestablish {
1562                         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],
1563                         next_local_commitment_number: 3,
1564                         next_remote_commitment_number: 4,
1565                         data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1566                 };
1567
1568                 let encoded_value = cr.encode();
1569                 assert_eq!(
1570                         encoded_value,
1571                         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]
1572                 );
1573         }
1574
1575         macro_rules! get_keys_from {
1576                 ($slice: expr, $secp_ctx: expr) => {
1577                         {
1578                                 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1579                                 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1580                                 (privkey, pubkey)
1581                         }
1582                 }
1583         }
1584
1585         macro_rules! get_sig_on {
1586                 ($privkey: expr, $ctx: expr, $string: expr) => {
1587                         {
1588                                 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1589                                 $ctx.sign(&sighash, &$privkey)
1590                         }
1591                 }
1592         }
1593
1594         #[test]
1595         fn encoding_announcement_signatures() {
1596                 let secp_ctx = Secp256k1::new();
1597                 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1598                 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1599                 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1600                 let announcement_signatures = msgs::AnnouncementSignatures {
1601                         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],
1602                         short_channel_id: 2316138423780173,
1603                         node_signature: sig_1,
1604                         bitcoin_signature: sig_2,
1605                 };
1606
1607                 let encoded_value = announcement_signatures.encode();
1608                 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1609         }
1610
1611         fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1612                 let secp_ctx = Secp256k1::new();
1613                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1614                 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1615                 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1616                 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1617                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1618                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1619                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1620                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1621                 let mut features = ChannelFeatures::known();
1622                 if unknown_features_bits {
1623                         features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1624                 }
1625                 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1626                         features,
1627                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1628                         short_channel_id: 2316138423780173,
1629                         node_id_1: pubkey_1,
1630                         node_id_2: pubkey_2,
1631                         bitcoin_key_1: pubkey_3,
1632                         bitcoin_key_2: pubkey_4,
1633                         excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1634                 };
1635                 let channel_announcement = msgs::ChannelAnnouncement {
1636                         node_signature_1: sig_1,
1637                         node_signature_2: sig_2,
1638                         bitcoin_signature_1: sig_3,
1639                         bitcoin_signature_2: sig_4,
1640                         contents: unsigned_channel_announcement,
1641                 };
1642                 let encoded_value = channel_announcement.encode();
1643                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1644                 if unknown_features_bits {
1645                         target_value.append(&mut hex::decode("0002ffff").unwrap());
1646                 } else {
1647                         target_value.append(&mut hex::decode("0000").unwrap());
1648                 }
1649                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1650                 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1651                 if excess_data {
1652                         target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1653                 }
1654                 assert_eq!(encoded_value, target_value);
1655         }
1656
1657         #[test]
1658         fn encoding_channel_announcement() {
1659                 do_encoding_channel_announcement(true, false);
1660                 do_encoding_channel_announcement(false, true);
1661                 do_encoding_channel_announcement(false, false);
1662                 do_encoding_channel_announcement(true, true);
1663         }
1664
1665         fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1666                 let secp_ctx = Secp256k1::new();
1667                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1668                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1669                 let features = if unknown_features_bits {
1670                         NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1671                 } else {
1672                         // Set to some features we may support
1673                         NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1674                 };
1675                 let mut addresses = Vec::new();
1676                 if ipv4 {
1677                         addresses.push(msgs::NetAddress::IPv4 {
1678                                 addr: [255, 254, 253, 252],
1679                                 port: 9735
1680                         });
1681                 }
1682                 if ipv6 {
1683                         addresses.push(msgs::NetAddress::IPv6 {
1684                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1685                                 port: 9735
1686                         });
1687                 }
1688                 if onionv2 {
1689                         addresses.push(msgs::NetAddress::OnionV2 {
1690                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1691                                 port: 9735
1692                         });
1693                 }
1694                 if onionv3 {
1695                         addresses.push(msgs::NetAddress::OnionV3 {
1696                                 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],
1697                                 checksum: 32,
1698                                 version: 16,
1699                                 port: 9735
1700                         });
1701                 }
1702                 let mut addr_len = 0;
1703                 for addr in &addresses {
1704                         addr_len += addr.len() + 1;
1705                 }
1706                 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1707                         features,
1708                         timestamp: 20190119,
1709                         node_id: pubkey_1,
1710                         rgb: [32; 3],
1711                         alias: [16;32],
1712                         addresses,
1713                         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() },
1714                         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() },
1715                 };
1716                 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
1717                 let node_announcement = msgs::NodeAnnouncement {
1718                         signature: sig_1,
1719                         contents: unsigned_node_announcement,
1720                 };
1721                 let encoded_value = node_announcement.encode();
1722                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1723                 if unknown_features_bits {
1724                         target_value.append(&mut hex::decode("0002ffff").unwrap());
1725                 } else {
1726                         target_value.append(&mut hex::decode("000122").unwrap());
1727                 }
1728                 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
1729                 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
1730                 if ipv4 {
1731                         target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
1732                 }
1733                 if ipv6 {
1734                         target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
1735                 }
1736                 if onionv2 {
1737                         target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
1738                 }
1739                 if onionv3 {
1740                         target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
1741                 }
1742                 if excess_address_data {
1743                         target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
1744                 }
1745                 if excess_data {
1746                         target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
1747                 }
1748                 assert_eq!(encoded_value, target_value);
1749         }
1750
1751         #[test]
1752         fn encoding_node_announcement() {
1753                 do_encoding_node_announcement(true, true, true, true, true, true, true);
1754                 do_encoding_node_announcement(false, false, false, false, false, false, false);
1755                 do_encoding_node_announcement(false, true, false, false, false, false, false);
1756                 do_encoding_node_announcement(false, false, true, false, false, false, false);
1757                 do_encoding_node_announcement(false, false, false, true, false, false, false);
1758                 do_encoding_node_announcement(false, false, false, false, true, false, false);
1759                 do_encoding_node_announcement(false, false, false, false, false, true, false);
1760                 do_encoding_node_announcement(false, true, false, true, false, true, false);
1761                 do_encoding_node_announcement(false, false, true, false, true, false, false);
1762         }
1763
1764         fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
1765                 let secp_ctx = Secp256k1::new();
1766                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1767                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1768                 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
1769                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1770                         short_channel_id: 2316138423780173,
1771                         timestamp: 20190119,
1772                         flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
1773                         cltv_expiry_delta: 144,
1774                         htlc_minimum_msat: 1000000,
1775                         htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
1776                         fee_base_msat: 10000,
1777                         fee_proportional_millionths: 20,
1778                         excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
1779                 };
1780                 let channel_update = msgs::ChannelUpdate {
1781                         signature: sig_1,
1782                         contents: unsigned_channel_update
1783                 };
1784                 let encoded_value = channel_update.encode();
1785                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1786                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1787                 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
1788                 if htlc_maximum_msat {
1789                         target_value.append(&mut hex::decode("01").unwrap());
1790                 } else {
1791                         target_value.append(&mut hex::decode("00").unwrap());
1792                 }
1793                 target_value.append(&mut hex::decode("00").unwrap());
1794                 if direction {
1795                         let flag = target_value.last_mut().unwrap();
1796                         *flag = 1;
1797                 }
1798                 if disable {
1799                         let flag = target_value.last_mut().unwrap();
1800                         *flag = *flag | 1 << 1;
1801                 }
1802                 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
1803                 if htlc_maximum_msat {
1804                         target_value.append(&mut hex::decode("0000777788889999").unwrap());
1805                 }
1806                 if excess_data {
1807                         target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
1808                 }
1809                 assert_eq!(encoded_value, target_value);
1810         }
1811
1812         #[test]
1813         fn encoding_channel_update() {
1814                 do_encoding_channel_update(false, false, false, false);
1815                 do_encoding_channel_update(false, false, false, true);
1816                 do_encoding_channel_update(true, false, false, false);
1817                 do_encoding_channel_update(true, false, false, true);
1818                 do_encoding_channel_update(false, true, false, false);
1819                 do_encoding_channel_update(false, true, false, true);
1820                 do_encoding_channel_update(false, false, true, false);
1821                 do_encoding_channel_update(false, false, true, true);
1822                 do_encoding_channel_update(true, true, true, false);
1823                 do_encoding_channel_update(true, true, true, true);
1824         }
1825
1826         fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
1827                 let secp_ctx = Secp256k1::new();
1828                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1829                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1830                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1831                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1832                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1833                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1834                 let open_channel = msgs::OpenChannel {
1835                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1836                         temporary_channel_id: [2; 32],
1837                         funding_satoshis: 1311768467284833366,
1838                         push_msat: 2536655962884945560,
1839                         dust_limit_satoshis: 3608586615801332854,
1840                         max_htlc_value_in_flight_msat: 8517154655701053848,
1841                         channel_reserve_satoshis: 8665828695742877976,
1842                         htlc_minimum_msat: 2316138423780173,
1843                         feerate_per_kw: 821716,
1844                         to_self_delay: 49340,
1845                         max_accepted_htlcs: 49340,
1846                         funding_pubkey: pubkey_1,
1847                         revocation_basepoint: pubkey_2,
1848                         payment_point: pubkey_3,
1849                         delayed_payment_basepoint: pubkey_4,
1850                         htlc_basepoint: pubkey_5,
1851                         first_per_commitment_point: pubkey_6,
1852                         channel_flags: if random_bit { 1 << 5 } else { 0 },
1853                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1854                 };
1855                 let encoded_value = open_channel.encode();
1856                 let mut target_value = Vec::new();
1857                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1858                 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
1859                 if random_bit {
1860                         target_value.append(&mut hex::decode("20").unwrap());
1861                 } else {
1862                         target_value.append(&mut hex::decode("00").unwrap());
1863                 }
1864                 if shutdown {
1865                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1866                 }
1867                 assert_eq!(encoded_value, target_value);
1868         }
1869
1870         #[test]
1871         fn encoding_open_channel() {
1872                 do_encoding_open_channel(false, false);
1873                 do_encoding_open_channel(true, false);
1874                 do_encoding_open_channel(false, true);
1875                 do_encoding_open_channel(true, true);
1876         }
1877
1878         fn do_encoding_accept_channel(shutdown: bool) {
1879                 let secp_ctx = Secp256k1::new();
1880                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1881                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1882                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1883                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1884                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
1885                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
1886                 let accept_channel = msgs::AcceptChannel {
1887                         temporary_channel_id: [2; 32],
1888                         dust_limit_satoshis: 1311768467284833366,
1889                         max_htlc_value_in_flight_msat: 2536655962884945560,
1890                         channel_reserve_satoshis: 3608586615801332854,
1891                         htlc_minimum_msat: 2316138423780173,
1892                         minimum_depth: 821716,
1893                         to_self_delay: 49340,
1894                         max_accepted_htlcs: 49340,
1895                         funding_pubkey: pubkey_1,
1896                         revocation_basepoint: pubkey_2,
1897                         payment_point: pubkey_3,
1898                         delayed_payment_basepoint: pubkey_4,
1899                         htlc_basepoint: pubkey_5,
1900                         first_per_commitment_point: pubkey_6,
1901                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
1902                 };
1903                 let encoded_value = accept_channel.encode();
1904                 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
1905                 if shutdown {
1906                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1907                 }
1908                 assert_eq!(encoded_value, target_value);
1909         }
1910
1911         #[test]
1912         fn encoding_accept_channel() {
1913                 do_encoding_accept_channel(false);
1914                 do_encoding_accept_channel(true);
1915         }
1916
1917         #[test]
1918         fn encoding_funding_created() {
1919                 let secp_ctx = Secp256k1::new();
1920                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1921                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1922                 let funding_created = msgs::FundingCreated {
1923                         temporary_channel_id: [2; 32],
1924                         funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
1925                         funding_output_index: 255,
1926                         signature: sig_1,
1927                 };
1928                 let encoded_value = funding_created.encode();
1929                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1930                 assert_eq!(encoded_value, target_value);
1931         }
1932
1933         #[test]
1934         fn encoding_funding_signed() {
1935                 let secp_ctx = Secp256k1::new();
1936                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1937                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1938                 let funding_signed = msgs::FundingSigned {
1939                         channel_id: [2; 32],
1940                         signature: sig_1,
1941                 };
1942                 let encoded_value = funding_signed.encode();
1943                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
1944                 assert_eq!(encoded_value, target_value);
1945         }
1946
1947         #[test]
1948         fn encoding_funding_locked() {
1949                 let secp_ctx = Secp256k1::new();
1950                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1951                 let funding_locked = msgs::FundingLocked {
1952                         channel_id: [2; 32],
1953                         next_per_commitment_point: pubkey_1,
1954                 };
1955                 let encoded_value = funding_locked.encode();
1956                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
1957                 assert_eq!(encoded_value, target_value);
1958         }
1959
1960         fn do_encoding_shutdown(script_type: u8) {
1961                 let secp_ctx = Secp256k1::new();
1962                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1963                 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1964                 let shutdown = msgs::Shutdown {
1965                         channel_id: [2; 32],
1966                         scriptpubkey:
1967                                      if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
1968                                 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
1969                                 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
1970                                 else                     { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
1971                 };
1972                 let encoded_value = shutdown.encode();
1973                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
1974                 if script_type == 1 {
1975                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
1976                 } else if script_type == 2 {
1977                         target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
1978                 } else if script_type == 3 {
1979                         target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
1980                 } else if script_type == 4 {
1981                         target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
1982                 }
1983                 assert_eq!(encoded_value, target_value);
1984         }
1985
1986         #[test]
1987         fn encoding_shutdown() {
1988                 do_encoding_shutdown(1);
1989                 do_encoding_shutdown(2);
1990                 do_encoding_shutdown(3);
1991                 do_encoding_shutdown(4);
1992         }
1993
1994         #[test]
1995         fn encoding_closing_signed() {
1996                 let secp_ctx = Secp256k1::new();
1997                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1998                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1999                 let closing_signed = msgs::ClosingSigned {
2000                         channel_id: [2; 32],
2001                         fee_satoshis: 2316138423780173,
2002                         signature: sig_1,
2003                 };
2004                 let encoded_value = closing_signed.encode();
2005                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2006                 assert_eq!(encoded_value, target_value);
2007         }
2008
2009         #[test]
2010         fn encoding_update_add_htlc() {
2011                 let secp_ctx = Secp256k1::new();
2012                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2013                 let onion_routing_packet = msgs::OnionPacket {
2014                         version: 255,
2015                         public_key: Ok(pubkey_1),
2016                         hop_data: [1; 20*65],
2017                         hmac: [2; 32]
2018                 };
2019                 let update_add_htlc = msgs::UpdateAddHTLC {
2020                         channel_id: [2; 32],
2021                         htlc_id: 2316138423780173,
2022                         amount_msat: 3608586615801332854,
2023                         payment_hash: PaymentHash([1; 32]),
2024                         cltv_expiry: 821716,
2025                         onion_routing_packet
2026                 };
2027                 let encoded_value = update_add_htlc.encode();
2028                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2029                 assert_eq!(encoded_value, target_value);
2030         }
2031
2032         #[test]
2033         fn encoding_update_fulfill_htlc() {
2034                 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2035                         channel_id: [2; 32],
2036                         htlc_id: 2316138423780173,
2037                         payment_preimage: PaymentPreimage([1; 32]),
2038                 };
2039                 let encoded_value = update_fulfill_htlc.encode();
2040                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2041                 assert_eq!(encoded_value, target_value);
2042         }
2043
2044         #[test]
2045         fn encoding_update_fail_htlc() {
2046                 let reason = OnionErrorPacket {
2047                         data: [1; 32].to_vec(),
2048                 };
2049                 let update_fail_htlc = msgs::UpdateFailHTLC {
2050                         channel_id: [2; 32],
2051                         htlc_id: 2316138423780173,
2052                         reason
2053                 };
2054                 let encoded_value = update_fail_htlc.encode();
2055                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2056                 assert_eq!(encoded_value, target_value);
2057         }
2058
2059         #[test]
2060         fn encoding_update_fail_malformed_htlc() {
2061                 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2062                         channel_id: [2; 32],
2063                         htlc_id: 2316138423780173,
2064                         sha256_of_onion: [1; 32],
2065                         failure_code: 255
2066                 };
2067                 let encoded_value = update_fail_malformed_htlc.encode();
2068                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2069                 assert_eq!(encoded_value, target_value);
2070         }
2071
2072         fn do_encoding_commitment_signed(htlcs: bool) {
2073                 let secp_ctx = Secp256k1::new();
2074                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2075                 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2076                 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2077                 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2078                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2079                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2080                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2081                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2082                 let commitment_signed = msgs::CommitmentSigned {
2083                         channel_id: [2; 32],
2084                         signature: sig_1,
2085                         htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2086                 };
2087                 let encoded_value = commitment_signed.encode();
2088                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2089                 if htlcs {
2090                         target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2091                 } else {
2092                         target_value.append(&mut hex::decode("0000").unwrap());
2093                 }
2094                 assert_eq!(encoded_value, target_value);
2095         }
2096
2097         #[test]
2098         fn encoding_commitment_signed() {
2099                 do_encoding_commitment_signed(true);
2100                 do_encoding_commitment_signed(false);
2101         }
2102
2103         #[test]
2104         fn encoding_revoke_and_ack() {
2105                 let secp_ctx = Secp256k1::new();
2106                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2107                 let raa = msgs::RevokeAndACK {
2108                         channel_id: [2; 32],
2109                         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],
2110                         next_per_commitment_point: pubkey_1,
2111                 };
2112                 let encoded_value = raa.encode();
2113                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2114                 assert_eq!(encoded_value, target_value);
2115         }
2116
2117         #[test]
2118         fn encoding_update_fee() {
2119                 let update_fee = msgs::UpdateFee {
2120                         channel_id: [2; 32],
2121                         feerate_per_kw: 20190119,
2122                 };
2123                 let encoded_value = update_fee.encode();
2124                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2125                 assert_eq!(encoded_value, target_value);
2126         }
2127
2128         #[test]
2129         fn encoding_init() {
2130                 assert_eq!(msgs::Init {
2131                         features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2132                 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2133                 assert_eq!(msgs::Init {
2134                         features: InitFeatures::from_le_bytes(vec![0xFF]),
2135                 }.encode(), hex::decode("0001ff0001ff").unwrap());
2136                 assert_eq!(msgs::Init {
2137                         features: InitFeatures::from_le_bytes(vec![]),
2138                 }.encode(), hex::decode("00000000").unwrap());
2139         }
2140
2141         #[test]
2142         fn encoding_error() {
2143                 let error = msgs::ErrorMessage {
2144                         channel_id: [2; 32],
2145                         data: String::from("rust-lightning"),
2146                 };
2147                 let encoded_value = error.encode();
2148                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2149                 assert_eq!(encoded_value, target_value);
2150         }
2151
2152         #[test]
2153         fn encoding_ping() {
2154                 let ping = msgs::Ping {
2155                         ponglen: 64,
2156                         byteslen: 64
2157                 };
2158                 let encoded_value = ping.encode();
2159                 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2160                 assert_eq!(encoded_value, target_value);
2161         }
2162
2163         #[test]
2164         fn encoding_pong() {
2165                 let pong = msgs::Pong {
2166                         byteslen: 64
2167                 };
2168                 let encoded_value = pong.encode();
2169                 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2170                 assert_eq!(encoded_value, target_value);
2171         }
2172
2173         #[test]
2174         fn encoding_legacy_onion_hop_data() {
2175                 let msg = msgs::OnionHopData {
2176                         format: OnionHopDataFormat::Legacy {
2177                                 short_channel_id: 0xdeadbeef1bad1dea,
2178                         },
2179                         amt_to_forward: 0x0badf00d01020304,
2180                         outgoing_cltv_value: 0xffffffff,
2181                 };
2182                 let encoded_value = msg.encode();
2183                 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2184                 assert_eq!(encoded_value, target_value);
2185         }
2186
2187         #[test]
2188         fn encoding_nonfinal_onion_hop_data() {
2189                 let mut msg = msgs::OnionHopData {
2190                         format: OnionHopDataFormat::NonFinalNode {
2191                                 short_channel_id: 0xdeadbeef1bad1dea,
2192                         },
2193                         amt_to_forward: 0x0badf00d01020304,
2194                         outgoing_cltv_value: 0xffffffff,
2195                 };
2196                 let encoded_value = msg.encode();
2197                 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2198                 assert_eq!(encoded_value, target_value);
2199                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2200                 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2201                         assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2202                 } else { panic!(); }
2203                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2204                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2205         }
2206
2207         #[test]
2208         fn encoding_final_onion_hop_data() {
2209                 let mut msg = msgs::OnionHopData {
2210                         format: OnionHopDataFormat::FinalNode {
2211                                 payment_data: None,
2212                         },
2213                         amt_to_forward: 0x0badf00d01020304,
2214                         outgoing_cltv_value: 0xffffffff,
2215                 };
2216                 let encoded_value = msg.encode();
2217                 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2218                 assert_eq!(encoded_value, target_value);
2219                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2220                 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2221                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2222                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2223         }
2224
2225         #[test]
2226         fn encoding_final_onion_hop_data_with_secret() {
2227                 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2228                 let mut msg = msgs::OnionHopData {
2229                         format: OnionHopDataFormat::FinalNode {
2230                                 payment_data: Some(FinalOnionHopData {
2231                                         payment_secret: expected_payment_secret,
2232                                         total_msat: 0x1badca1f
2233                                 }),
2234                         },
2235                         amt_to_forward: 0x0badf00d01020304,
2236                         outgoing_cltv_value: 0xffffffff,
2237                 };
2238                 let encoded_value = msg.encode();
2239                 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2240                 assert_eq!(encoded_value, target_value);
2241                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2242                 if let OnionHopDataFormat::FinalNode {
2243                         payment_data: Some(FinalOnionHopData {
2244                                 payment_secret,
2245                                 total_msat: 0x1badca1f
2246                         })
2247                 } = msg.format {
2248                         assert_eq!(payment_secret, expected_payment_secret);
2249                 } else { panic!(); }
2250                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2251                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2252         }
2253 }