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

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