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