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

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