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