_ Git - rust-lightning/blob - 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 mssage, however this does allow you to significantly reduce bandwidth
  12 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
  13 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
  14 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
  15 //! raw socket events into your non-internet-facing system and then send routing events back to
  16 //! track the network on the less-secure system.
  17
  18 use secp256k1::key::PublicKey;
  19 use secp256k1::{Secp256k1, Signature};
  20 use secp256k1;
  21 use bitcoin::util::hash::Sha256dHash;
  22 use bitcoin::blockdata::script::Script;
  23
  24 use std::error::Error;
  25 use std::{cmp, fmt};
  26 use std::io::Read;
  27 use std::result::Result;
  28
  29 use util::{byte_utils, events};
  30 use util::ser::{Readable, Writeable, Writer};
  31
  32 /// An error in decoding a message or struct.
  33 #[derive(Debug)]
  34 pub enum DecodeError {
  35         /// A version byte specified something we don't know how to handle.
  36         /// Includes unknown realm byte in an OnionHopData packet
  37         UnknownVersion,
  38         /// Unknown feature mandating we fail to parse message
  39         UnknownRequiredFeature,
  40         /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
  41         /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc
  42         InvalidValue,
  43         /// Buffer too short
  44         ShortRead,
  45         /// node_announcement included more than one address of a given type!
  46         ExtraAddressesPerType,
  47         /// A length descriptor in the packet didn't describe the later data correctly
  48         /// (currently only generated in node_announcement)
  49         BadLengthDescriptor,
  50         /// Error from std::io
  51         Io(::std::io::Error),
  52 }
  53
  54 /// Tracks localfeatures which are only in init messages
  55 #[derive(Clone, PartialEq)]
  56 pub struct LocalFeatures {
  57         flags: Vec<u8>,
  58 }
  59
  60 impl LocalFeatures {
  61         pub(crate) fn new() -> LocalFeatures {
  62                 LocalFeatures {
  63                         flags: Vec::new(),
  64                 }
  65         }
  66
  67         pub(crate) fn supports_data_loss_protect(&self) -> bool {
  68                 self.flags.len() > 0 && (self.flags[0] & 3) != 0
  69         }
  70         pub(crate) fn requires_data_loss_protect(&self) -> bool {
  71                 self.flags.len() > 0 && (self.flags[0] & 1) != 0
  72         }
  73
  74         pub(crate) fn initial_routing_sync(&self) -> bool {
  75                 self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0
  76         }
  77         pub(crate) fn set_initial_routing_sync(&mut self) {
  78                 if self.flags.len() == 0 {
  79                         self.flags.resize(1, 1 << 3);
  80                 } else {
  81                         self.flags[0] |= 1 << 3;
  82                 }
  83         }
  84
  85         pub(crate) fn supports_upfront_shutdown_script(&self) -> bool {
  86                 self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0
  87         }
  88         pub(crate) fn requires_upfront_shutdown_script(&self) -> bool {
  89                 self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0
  90         }
  91
  92         pub(crate) fn requires_unknown_bits(&self) -> bool {
  93                 for (idx, &byte) in self.flags.iter().enumerate() {
  94                         if idx != 0 && (byte & 0x55) != 0 {
  95                                 return true;
  96                         } else if idx == 0 && (byte & 0x14) != 0 {
  97                                 return true;
  98                         }
  99                 }
 100                 return false;
 101         }
 102
 103         pub(crate) fn supports_unknown_bits(&self) -> bool {
 104                 for (idx, &byte) in self.flags.iter().enumerate() {
 105                         if idx != 0 && byte != 0 {
 106                                 return true;
 107                         } else if idx == 0 && (byte & 0xc4) != 0 {
 108                                 return true;
 109                         }
 110                 }
 111                 return false;
 112         }
 113 }
 114
 115 /// Tracks globalfeatures which are in init messages and routing announcements
 116 #[derive(Clone, PartialEq)]
 117 pub struct GlobalFeatures {
 118         flags: Vec<u8>,
 119 }
 120
 121 impl GlobalFeatures {
 122         pub(crate) fn new() -> GlobalFeatures {
 123                 GlobalFeatures {
 124                         flags: Vec::new(),
 125                 }
 126         }
 127
 128         pub(crate) fn requires_unknown_bits(&self) -> bool {
 129                 for &byte in self.flags.iter() {
 130                         if (byte & 0x55) != 0 {
 131                                 return true;
 132                         }
 133                 }
 134                 return false;
 135         }
 136
 137         pub(crate) fn supports_unknown_bits(&self) -> bool {
 138                 for &byte in self.flags.iter() {
 139                         if byte != 0 {
 140                                 return true;
 141                         }
 142                 }
 143                 return false;
 144         }
 145 }
 146
 147 /// An init message to be sent or received from a peer
 148 pub struct Init {
 149         pub(crate) global_features: GlobalFeatures,
 150         pub(crate) local_features: LocalFeatures,
 151 }
 152
 153 /// An error message to be sent or received from a peer
 154 pub struct ErrorMessage {
 155         pub(crate) channel_id: [u8; 32],
 156         pub(crate) data: String,
 157 }
 158
 159 /// A ping message to be sent or received from a peer
 160 pub struct Ping {
 161         pub(crate) ponglen: u16,
 162         pub(crate) byteslen: u16,
 163 }
 164
 165 /// A pong message to be sent or received from a peer
 166 pub struct Pong {
 167         pub(crate) byteslen: u16,
 168 }
 169
 170 /// An open_channel message to be sent or received from a peer
 171 pub struct OpenChannel {
 172         pub(crate) chain_hash: Sha256dHash,
 173         pub(crate) temporary_channel_id: [u8; 32],
 174         pub(crate) funding_satoshis: u64,
 175         pub(crate) push_msat: u64,
 176         pub(crate) dust_limit_satoshis: u64,
 177         pub(crate) max_htlc_value_in_flight_msat: u64,
 178         pub(crate) channel_reserve_satoshis: u64,
 179         pub(crate) htlc_minimum_msat: u64,
 180         pub(crate) feerate_per_kw: u32,
 181         pub(crate) to_self_delay: u16,
 182         pub(crate) max_accepted_htlcs: u16,
 183         pub(crate) funding_pubkey: PublicKey,
 184         pub(crate) revocation_basepoint: PublicKey,
 185         pub(crate) payment_basepoint: PublicKey,
 186         pub(crate) delayed_payment_basepoint: PublicKey,
 187         pub(crate) htlc_basepoint: PublicKey,
 188         pub(crate) first_per_commitment_point: PublicKey,
 189         pub(crate) channel_flags: u8,
 190         pub(crate) shutdown_scriptpubkey: Option<Script>,
 191 }
 192
 193 /// An accept_channel message to be sent or received from a peer
 194 pub struct AcceptChannel {
 195         pub(crate) temporary_channel_id: [u8; 32],
 196         pub(crate) dust_limit_satoshis: u64,
 197         pub(crate) max_htlc_value_in_flight_msat: u64,
 198         pub(crate) channel_reserve_satoshis: u64,
 199         pub(crate) htlc_minimum_msat: u64,
 200         pub(crate) minimum_depth: u32,
 201         pub(crate) to_self_delay: u16,
 202         pub(crate) max_accepted_htlcs: u16,
 203         pub(crate) funding_pubkey: PublicKey,
 204         pub(crate) revocation_basepoint: PublicKey,
 205         pub(crate) payment_basepoint: PublicKey,
 206         pub(crate) delayed_payment_basepoint: PublicKey,
 207         pub(crate) htlc_basepoint: PublicKey,
 208         pub(crate) first_per_commitment_point: PublicKey,
 209         pub(crate) shutdown_scriptpubkey: Option<Script>,
 210 }
 211
 212 /// A funding_created message to be sent or received from a peer
 213 pub struct FundingCreated {
 214         pub(crate) temporary_channel_id: [u8; 32],
 215         pub(crate) funding_txid: Sha256dHash,
 216         pub(crate) funding_output_index: u16,
 217         pub(crate) signature: Signature,
 218 }
 219
 220 /// A funding_signed message to be sent or received from a peer
 221 pub struct FundingSigned {
 222         pub(crate) channel_id: [u8; 32],
 223         pub(crate) signature: Signature,
 224 }
 225
 226 /// A funding_locked message to be sent or received from a peer
 227 #[derive(Clone)]
 228 pub struct FundingLocked {
 229         pub(crate) channel_id: [u8; 32],
 230         pub(crate) next_per_commitment_point: PublicKey,
 231 }
 232
 233 /// A shutdown message to be sent or received from a peer
 234 pub struct Shutdown {
 235         pub(crate) channel_id: [u8; 32],
 236         pub(crate) scriptpubkey: Script,
 237 }
 238
 239 /// A closing_signed message to be sent or received from a peer
 240 pub struct ClosingSigned {
 241         pub(crate) channel_id: [u8; 32],
 242         pub(crate) fee_satoshis: u64,
 243         pub(crate) signature: Signature,
 244 }
 245
 246 /// An update_add_htlc message to be sent or received from a peer
 247 #[derive(Clone)]
 248 pub struct UpdateAddHTLC {
 249         pub(crate) channel_id: [u8; 32],
 250         pub(crate) htlc_id: u64,
 251         pub(crate) amount_msat: u64,
 252         pub(crate) payment_hash: [u8; 32],
 253         pub(crate) cltv_expiry: u32,
 254         pub(crate) onion_routing_packet: OnionPacket,
 255 }
 256
 257 /// An update_fulfill_htlc message to be sent or received from a peer
 258 #[derive(Clone)]
 259 pub struct UpdateFulfillHTLC {
 260         pub(crate) channel_id: [u8; 32],
 261         pub(crate) htlc_id: u64,
 262         pub(crate) payment_preimage: [u8; 32],
 263 }
 264
 265 /// An update_fail_htlc message to be sent or received from a peer
 266 #[derive(Clone)]
 267 pub struct UpdateFailHTLC {
 268         pub(crate) channel_id: [u8; 32],
 269         pub(crate) htlc_id: u64,
 270         pub(crate) reason: OnionErrorPacket,
 271 }
 272
 273 /// An update_fail_malformed_htlc message to be sent or received from a peer
 274 #[derive(Clone)]
 275 pub struct UpdateFailMalformedHTLC {
 276         pub(crate) channel_id: [u8; 32],
 277         pub(crate) htlc_id: u64,
 278         pub(crate) sha256_of_onion: [u8; 32],
 279         pub(crate) failure_code: u16,
 280 }
 281
 282 /// A commitment_signed message to be sent or received from a peer
 283 #[derive(Clone)]
 284 pub struct CommitmentSigned {
 285         pub(crate) channel_id: [u8; 32],
 286         pub(crate) signature: Signature,
 287         pub(crate) htlc_signatures: Vec<Signature>,
 288 }
 289
 290 /// A revoke_and_ack message to be sent or received from a peer
 291 pub struct RevokeAndACK {
 292         pub(crate) channel_id: [u8; 32],
 293         pub(crate) per_commitment_secret: [u8; 32],
 294         pub(crate) next_per_commitment_point: PublicKey,
 295 }
 296
 297 /// An update_fee message to be sent or received from a peer
 298 pub struct UpdateFee {
 299         pub(crate) channel_id: [u8; 32],
 300         pub(crate) feerate_per_kw: u32,
 301 }
 302
 303 pub(crate) struct DataLossProtect {
 304         pub(crate) your_last_per_commitment_secret: [u8; 32],
 305         pub(crate) my_current_per_commitment_point: PublicKey,
 306 }
 307
 308 /// A channel_reestablish message to be sent or received from a peer
 309 pub struct ChannelReestablish {
 310         pub(crate) channel_id: [u8; 32],
 311         pub(crate) next_local_commitment_number: u64,
 312         pub(crate) next_remote_commitment_number: u64,
 313         pub(crate) data_loss_protect: Option<DataLossProtect>,
 314 }
 315
 316 /// An announcement_signatures message to be sent or received from a peer
 317 #[derive(Clone)]
 318 pub struct AnnouncementSignatures {
 319         pub(crate) channel_id: [u8; 32],
 320         pub(crate) short_channel_id: u64,
 321         pub(crate) node_signature: Signature,
 322         pub(crate) bitcoin_signature: Signature,
 323 }
 324
 325 /// An address which can be used to connect to a remote peer
 326 #[derive(Clone)]
 327 pub enum NetAddress {
 328         /// An IPv4 address/port on which the peer is listenting.
 329         IPv4 {
 330                 /// The 4-byte IPv4 address
 331                 addr: [u8; 4],
 332                 /// The port on which the node is listenting
 333                 port: u16,
 334         },
 335         /// An IPv6 address/port on which the peer is listenting.
 336         IPv6 {
 337                 /// The 16-byte IPv6 address
 338                 addr: [u8; 16],
 339                 /// The port on which the node is listenting
 340                 port: u16,
 341         },
 342         /// An old-style Tor onion address/port on which the peer is listening.
 343         OnionV2 {
 344                 /// The bytes (usually encoded in base32 with ".onion" appended)
 345                 addr: [u8; 10],
 346                 /// The port on which the node is listenting
 347                 port: u16,
 348         },
 349         /// A new-style Tor onion address/port on which the peer is listening.
 350         /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
 351         /// wrap as base32 and append ".onion".
 352         OnionV3 {
 353                 /// The ed25519 long-term public key of the peer
 354                 ed25519_pubkey: [u8; 32],
 355                 /// The checksum of the pubkey and version, as included in the onion address
 356                 checksum: u16,
 357                 /// The version byte, as defined by the Tor Onion v3 spec.
 358                 version: u8,
 359                 /// The port on which the node is listenting
 360                 port: u16,
 361         },
 362 }
 363 impl NetAddress {
 364         fn get_id(&self) -> u8 {
 365                 match self {
 366                         &NetAddress::IPv4 {..} => { 1 },
 367                         &NetAddress::IPv6 {..} => { 2 },
 368                         &NetAddress::OnionV2 {..} => { 3 },
 369                         &NetAddress::OnionV3 {..} => { 4 },
 370                 }
 371         }
 372 }
 373
 374 // Only exposed as broadcast of node_announcement should be filtered by node_id
 375 /// The unsigned part of a node_announcement
 376 pub struct UnsignedNodeAnnouncement {
 377         pub(crate) features: GlobalFeatures,
 378         pub(crate) timestamp: u32,
 379         /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
 380         /// to this node).
 381         pub        node_id: PublicKey,
 382         pub(crate) rgb: [u8; 3],
 383         pub(crate) alias: [u8; 32],
 384         /// List of addresses on which this node is reachable. Note that you may only have up to one
 385         /// address of each type, if you have more, they may be silently discarded or we may panic!
 386         pub(crate) addresses: Vec<NetAddress>,
 387         pub(crate) excess_address_data: Vec<u8>,
 388         pub(crate) excess_data: Vec<u8>,
 389 }
 390 /// A node_announcement message to be sent or received from a peer
 391 pub struct NodeAnnouncement {
 392         pub(crate) signature: Signature,
 393         pub(crate) contents: UnsignedNodeAnnouncement,
 394 }
 395
 396 // Only exposed as broadcast of channel_announcement should be filtered by node_id
 397 /// The unsigned part of a channel_announcement
 398 #[derive(PartialEq, Clone)]
 399 pub struct UnsignedChannelAnnouncement {
 400         pub(crate) features: GlobalFeatures,
 401         pub(crate) chain_hash: Sha256dHash,
 402         pub(crate) short_channel_id: u64,
 403         /// One of the two node_ids which are endpoints of this channel
 404         pub        node_id_1: PublicKey,
 405         /// The other of the two node_ids which are endpoints of this channel
 406         pub        node_id_2: PublicKey,
 407         pub(crate) bitcoin_key_1: PublicKey,
 408         pub(crate) bitcoin_key_2: PublicKey,
 409         pub(crate) excess_data: Vec<u8>,
 410 }
 411 /// A channel_announcement message to be sent or received from a peer
 412 #[derive(PartialEq, Clone)]
 413 pub struct ChannelAnnouncement {
 414         pub(crate) node_signature_1: Signature,
 415         pub(crate) node_signature_2: Signature,
 416         pub(crate) bitcoin_signature_1: Signature,
 417         pub(crate) bitcoin_signature_2: Signature,
 418         pub(crate) contents: UnsignedChannelAnnouncement,
 419 }
 420
 421 #[derive(PartialEq, Clone)]
 422 pub(crate) struct UnsignedChannelUpdate {
 423         pub(crate) chain_hash: Sha256dHash,
 424         pub(crate) short_channel_id: u64,
 425         pub(crate) timestamp: u32,
 426         pub(crate) flags: u16,
 427         pub(crate) cltv_expiry_delta: u16,
 428         pub(crate) htlc_minimum_msat: u64,
 429         pub(crate) fee_base_msat: u32,
 430         pub(crate) fee_proportional_millionths: u32,
 431         pub(crate) excess_data: Vec<u8>,
 432 }
 433 /// A channel_update message to be sent or received from a peer
 434 #[derive(PartialEq, Clone)]
 435 pub struct ChannelUpdate {
 436         pub(crate) signature: Signature,
 437         pub(crate) contents: UnsignedChannelUpdate,
 438 }
 439
 440 /// Used to put an error message in a HandleError
 441 pub enum ErrorAction {
 442         /// The peer took some action which made us think they were useless. Disconnect them.
 443         DisconnectPeer {
 444                 /// An error message which we should make an effort to send before we disconnect.
 445                 msg: Option<ErrorMessage>
 446         },
 447         /// The peer did something harmless that we weren't able to process, just log and ignore
 448         IgnoreError,
 449         /// The peer did something incorrect. Tell them.
 450         SendErrorMessage {
 451                 /// The message to send.
 452                 msg: ErrorMessage
 453         },
 454 }
 455
 456 /// An Err type for failure to process messages.
 457 pub struct HandleError { //TODO: rename me
 458         /// A human-readable message describing the error
 459         pub err: &'static str,
 460         /// The action which should be taken against the offending peer.
 461         pub action: Option<ErrorAction>, //TODO: Make this required
 462 }
 463
 464 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
 465 /// transaction updates if they were pending.
 466 pub struct CommitmentUpdate {
 467         pub(crate) update_add_htlcs: Vec<UpdateAddHTLC>,
 468         pub(crate) update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
 469         pub(crate) update_fail_htlcs: Vec<UpdateFailHTLC>,
 470         pub(crate) update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
 471         pub(crate) update_fee: Option<UpdateFee>,
 472         pub(crate) commitment_signed: CommitmentSigned,
 473 }
 474
 475 /// The information we received from a peer along the route of a payment we originated. This is
 476 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
 477 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
 478 pub enum HTLCFailChannelUpdate {
 479         /// We received an error which included a full ChannelUpdate message.
 480         ChannelUpdateMessage {
 481                 /// The unwrapped message we received
 482                 msg: ChannelUpdate,
 483         },
 484         /// We received an error which indicated only that a channel has been closed
 485         ChannelClosed {
 486                 /// The short_channel_id which has now closed.
 487                 short_channel_id: u64,
 488                 /// when this true, this channel should be permanently removed from the
 489                 /// consideration. Otherwise, this channel can be restored as new channel_update is received
 490                 is_permanent: bool,
 491         },
 492         /// We received an error which indicated only that a node has failed
 493         NodeFailure {
 494                 /// The node_id that has failed.
 495                 node_id: PublicKey,
 496                 /// when this true, node should be permanently removed from the
 497                 /// consideration. Otherwise, the channels connected to this node can be
 498                 /// restored as new channel_update is received
 499                 is_permanent: bool,
 500         }
 501 }
 502
 503 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
 504 /// be sent in the order they appear in the return value, however sometimes the order needs to be
 505 /// variable at runtime (eg handle_channel_reestablish needs to re-send messages in the order they
 506 /// were originally sent). In those cases, this enum is also returned.
 507 #[derive(Clone, PartialEq)]
 508 pub enum RAACommitmentOrder {
 509         /// Send the CommitmentUpdate messages first
 510         CommitmentFirst,
 511         /// Send the RevokeAndACK message first
 512         RevokeAndACKFirst,
 513 }
 514
 515 /// A trait to describe an object which can receive channel messages.
 516 ///
 517 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
 518 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
 519 pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
 520         //Channel init:
 521         /// Handle an incoming open_channel message from the given peer.
 522         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<AcceptChannel, HandleError>;
 523         /// Handle an incoming accept_channel message from the given peer.
 524         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
 525         /// Handle an incoming funding_created message from the given peer.
 526         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<FundingSigned, HandleError>;
 527         /// Handle an incoming funding_signed message from the given peer.
 528         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned) -> Result<(), HandleError>;
 529         /// Handle an incoming funding_locked message from the given peer.
 530         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<Option<AnnouncementSignatures>, HandleError>;
 531
 532         // Channl close:
 533         /// Handle an incoming shutdown message from the given peer.
 534         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(Option<Shutdown>, Option<ClosingSigned>), HandleError>;
 535         /// Handle an incoming closing_signed message from the given peer.
 536         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<Option<ClosingSigned>, HandleError>;
 537
 538         // HTLC handling:
 539         /// Handle an incoming update_add_htlc message from the given peer.
 540         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
 541         /// Handle an incoming update_fulfill_htlc message from the given peer.
 542         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
 543         /// Handle an incoming update_fail_htlc message from the given peer.
 544         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<(), HandleError>;
 545         /// Handle an incoming update_fail_malformed_htlc message from the given peer.
 546         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
 547         /// Handle an incoming commitment_signed message from the given peer.
 548         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(RevokeAndACK, Option<CommitmentSigned>), HandleError>;
 549         /// Handle an incoming revoke_and_ack message from the given peer.
 550         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<CommitmentUpdate>, HandleError>;
 551
 552         /// Handle an incoming update_fee message from the given peer.
 553         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
 554
 555         // Channel-to-announce:
 556         /// Handle an incoming announcement_signatures message from the given peer.
 557         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>;
 558
 559         // Connection loss/reestablish:
 560         /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
 561         /// is believed to be possible in the future (eg they're sending us messages we don't
 562         /// understand or indicate they require unknown feature bits), no_connection_possible is set
 563         /// and any outstanding channels should be failed.
 564         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
 565
 566         /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
 567         fn peer_connected(&self, their_node_id: &PublicKey) -> Vec<ChannelReestablish>;
 568         /// Handle an incoming channel_reestablish message from the given peer.
 569         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish) -> Result<(Option<FundingLocked>, Option<RevokeAndACK>, Option<CommitmentUpdate>, RAACommitmentOrder), HandleError>;
 570
 571         // Error:
 572         /// Handle an incoming error message from the given peer.
 573         fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
 574 }
 575
 576 /// A trait to describe an object which can receive routing messages.
 577 pub trait RoutingMessageHandler : Send + Sync {
 578         /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
 579         /// false or returning an Err otherwise.
 580         fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, HandleError>;
 581         /// Handle a channel_announcement message, returning true if it should be forwarded on, false
 582         /// or returning an Err otherwise.
 583         fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
 584         /// Handle an incoming channel_update message, returning true if it should be forwarded on,
 585         /// false or returning an Err otherwise.
 586         fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, HandleError>;
 587         /// Handle some updates to the route graph that we learned due to an outbound failed payment.
 588         fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
 589 }
 590
 591 pub(crate) struct OnionRealm0HopData {
 592         pub(crate) short_channel_id: u64,
 593         pub(crate) amt_to_forward: u64,
 594         pub(crate) outgoing_cltv_value: u32,
 595         // 12 bytes of 0-padding
 596 }
 597
 598 mod fuzzy_internal_msgs {
 599         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
 600         // them from untrusted input):
 601
 602         use super::OnionRealm0HopData;
 603         pub struct OnionHopData {
 604                 pub(crate) realm: u8,
 605                 pub(crate) data: OnionRealm0HopData,
 606                 pub(crate) hmac: [u8; 32],
 607         }
 608         unsafe impl ::util::internal_traits::NoDealloc for OnionHopData{}
 609
 610         pub struct DecodedOnionErrorPacket {
 611                 pub(crate) hmac: [u8; 32],
 612                 pub(crate) failuremsg: Vec<u8>,
 613                 pub(crate) pad: Vec<u8>,
 614         }
 615 }
 616 #[cfg(feature = "fuzztarget")]
 617 pub use self::fuzzy_internal_msgs::*;
 618 #[cfg(not(feature = "fuzztarget"))]
 619 pub(crate) use self::fuzzy_internal_msgs::*;
 620
 621 #[derive(Clone)]
 622 pub(crate) struct OnionPacket {
 623         pub(crate) version: u8,
 624         /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
 625         /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
 626         /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
 627         pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
 628         pub(crate) hop_data: [u8; 20*65],
 629         pub(crate) hmac: [u8; 32],
 630 }
 631
 632 #[derive(Clone)]
 633 pub(crate) struct OnionErrorPacket {
 634         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
 635         // (TODO) We limit it in decode to much lower...
 636         pub(crate) data: Vec<u8>,
 637 }
 638
 639 impl Error for DecodeError {
 640         fn description(&self) -> &str {
 641                 match *self {
 642                         DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
 643                         DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
 644                         DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
 645                         DecodeError::ShortRead => "Packet extended beyond the provided bytes",
 646                         DecodeError::ExtraAddressesPerType => "More than one address of a single type",
 647                         DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
 648                         DecodeError::Io(ref e) => e.description(),
 649                 }
 650         }
 651 }
 652 impl fmt::Display for DecodeError {
 653         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 654                 f.write_str(self.description())
 655         }
 656 }
 657
 658 impl fmt::Debug for HandleError {
 659         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 660                 f.write_str(self.err)
 661         }
 662 }
 663
 664 impl From<::std::io::Error> for DecodeError {
 665         fn from(e: ::std::io::Error) -> Self {
 666                 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
 667                         DecodeError::ShortRead
 668                 } else {
 669                         DecodeError::Io(e)
 670                 }
 671         }
 672 }
 673
 674 impl_writeable_len_match!(AcceptChannel, {
 675                 {AcceptChannel{ shutdown_scriptpubkey: Some(ref script), ..}, 270 + 2 + script.len()},
 676                 {_, 270}
 677         }, {
 678         temporary_channel_id,
 679         dust_limit_satoshis,
 680         max_htlc_value_in_flight_msat,
 681         channel_reserve_satoshis,
 682         htlc_minimum_msat,
 683         minimum_depth,
 684         to_self_delay,
 685         max_accepted_htlcs,
 686         funding_pubkey,
 687         revocation_basepoint,
 688         payment_basepoint,
 689         delayed_payment_basepoint,
 690         htlc_basepoint,
 691         first_per_commitment_point,
 692         shutdown_scriptpubkey
 693 });
 694
 695 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
 696         channel_id,
 697         short_channel_id,
 698         node_signature,
 699         bitcoin_signature
 700 });
 701
 702 impl Writeable for ChannelReestablish {
 703         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 704                 w.size_hint(if self.data_loss_protect.is_some() { 32+2*8+33+32 } else { 32+2*8 });
 705                 self.channel_id.write(w)?;
 706                 self.next_local_commitment_number.write(w)?;
 707                 self.next_remote_commitment_number.write(w)?;
 708                 if let Some(ref data_loss_protect) = self.data_loss_protect {
 709                         data_loss_protect.your_last_per_commitment_secret.write(w)?;
 710                         data_loss_protect.my_current_per_commitment_point.write(w)?;
 711                 }
 712                 Ok(())
 713         }
 714 }
 715
 716 impl<R: Read> Readable<R> for ChannelReestablish{
 717         fn read(r: &mut R) -> Result<Self, DecodeError> {
 718                 Ok(Self {
 719                         channel_id: Readable::read(r)?,
 720                         next_local_commitment_number: Readable::read(r)?,
 721                         next_remote_commitment_number: Readable::read(r)?,
 722                         data_loss_protect: {
 723                                 match <[u8; 32] as Readable<R>>::read(r) {
 724                                         Ok(your_last_per_commitment_secret) =>
 725                                                 Some(DataLossProtect {
 726                                                         your_last_per_commitment_secret,
 727                                                         my_current_per_commitment_point: Readable::read(r)?,
 728                                                 }),
 729                                         Err(DecodeError::ShortRead) => None,
 730                                         Err(e) => return Err(e)
 731                                 }
 732                         }
 733                 })
 734         }
 735 }
 736
 737 impl_writeable!(ClosingSigned, 32+8+64, {
 738         channel_id,
 739         fee_satoshis,
 740         signature
 741 });
 742
 743 impl_writeable_len_match!(CommitmentSigned, {
 744                 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
 745         }, {
 746         channel_id,
 747         signature,
 748         htlc_signatures
 749 });
 750
 751 impl_writeable_len_match!(DecodedOnionErrorPacket, {
 752                 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
 753         }, {
 754         hmac,
 755         failuremsg,
 756         pad
 757 });
 758
 759 impl_writeable!(FundingCreated, 32+32+2+64, {
 760         temporary_channel_id,
 761         funding_txid,
 762         funding_output_index,
 763         signature
 764 });
 765
 766 impl_writeable!(FundingSigned, 32+64, {
 767         channel_id,
 768         signature
 769 });
 770
 771 impl_writeable!(FundingLocked, 32+33, {
 772         channel_id,
 773         next_per_commitment_point
 774 });
 775
 776 impl_writeable_len_match!(GlobalFeatures, {
 777                 { GlobalFeatures { ref flags }, flags.len() + 2 }
 778         }, {
 779         flags
 780 });
 781
 782 impl_writeable_len_match!(LocalFeatures, {
 783                 { LocalFeatures { ref flags }, flags.len() + 2 }
 784         }, {
 785         flags
 786 });
 787
 788 impl_writeable_len_match!(Init, {
 789                 { Init { ref global_features, ref local_features }, global_features.flags.len() + local_features.flags.len() + 4 }
 790         }, {
 791         global_features,
 792         local_features
 793 });
 794
 795 impl_writeable_len_match!(OpenChannel, {
 796                 { OpenChannel { shutdown_scriptpubkey: Some(ref script), .. }, 319 + 2 + script.len() },
 797                 { OpenChannel { shutdown_scriptpubkey: None, .. }, 319 }
 798         }, {
 799         chain_hash,
 800         temporary_channel_id,
 801         funding_satoshis,
 802         push_msat,
 803         dust_limit_satoshis,
 804         max_htlc_value_in_flight_msat,
 805         channel_reserve_satoshis,
 806         htlc_minimum_msat,
 807         feerate_per_kw,
 808         to_self_delay,
 809         max_accepted_htlcs,
 810         funding_pubkey,
 811         revocation_basepoint,
 812         payment_basepoint,
 813         delayed_payment_basepoint,
 814         htlc_basepoint,
 815         first_per_commitment_point,
 816         channel_flags,
 817         shutdown_scriptpubkey
 818 });
 819
 820 impl_writeable!(RevokeAndACK, 32+32+33, {
 821         channel_id,
 822         per_commitment_secret,
 823         next_per_commitment_point
 824 });
 825
 826 impl_writeable_len_match!(Shutdown, {
 827                 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
 828         }, {
 829         channel_id,
 830         scriptpubkey
 831 });
 832
 833 impl_writeable_len_match!(UpdateFailHTLC, {
 834                 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
 835         }, {
 836         channel_id,
 837         htlc_id,
 838         reason
 839 });
 840
 841 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
 842         channel_id,
 843         htlc_id,
 844         sha256_of_onion,
 845         failure_code
 846 });
 847
 848 impl_writeable!(UpdateFee, 32+4, {
 849         channel_id,
 850         feerate_per_kw
 851 });
 852
 853 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
 854         channel_id,
 855         htlc_id,
 856         payment_preimage
 857 });
 858
 859 impl_writeable_len_match!(OnionErrorPacket, {
 860                 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
 861         }, {
 862         data
 863 });
 864
 865 impl Writeable for OnionPacket {
 866         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 867                 w.size_hint(1 + 33 + 20*65 + 32);
 868                 self.version.write(w)?;
 869                 match self.public_key {
 870                         Ok(pubkey) => pubkey.write(w)?,
 871                         Err(_) => [0u8;33].write(w)?,
 872                 }
 873                 w.write_all(&self.hop_data)?;
 874                 self.hmac.write(w)?;
 875                 Ok(())
 876         }
 877 }
 878
 879 impl<R: Read> Readable<R> for OnionPacket {
 880         fn read(r: &mut R) -> Result<Self, DecodeError> {
 881                 Ok(OnionPacket {
 882                         version: Readable::read(r)?,
 883                         public_key: {
 884                                 let mut buf = [0u8;33];
 885                                 r.read_exact(&mut buf)?;
 886                                 PublicKey::from_slice(&Secp256k1::without_caps(), &buf)
 887                         },
 888                         hop_data: Readable::read(r)?,
 889                         hmac: Readable::read(r)?,
 890                 })
 891         }
 892 }
 893
 894 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
 895         channel_id,
 896         htlc_id,
 897         amount_msat,
 898         payment_hash,
 899         cltv_expiry,
 900         onion_routing_packet
 901 });
 902
 903 impl Writeable for OnionRealm0HopData {
 904         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 905                 w.size_hint(32);
 906                 self.short_channel_id.write(w)?;
 907                 self.amt_to_forward.write(w)?;
 908                 self.outgoing_cltv_value.write(w)?;
 909                 w.write_all(&[0;12])?;
 910                 Ok(())
 911         }
 912 }
 913
 914 impl<R: Read> Readable<R> for OnionRealm0HopData {
 915         fn read(r: &mut R) -> Result<Self, DecodeError> {
 916                 Ok(OnionRealm0HopData {
 917                         short_channel_id: Readable::read(r)?,
 918                         amt_to_forward: Readable::read(r)?,
 919                         outgoing_cltv_value: {
 920                                 let v: u32 = Readable::read(r)?;
 921                                 r.read_exact(&mut [0; 12])?;
 922                                 v
 923                         }
 924                 })
 925         }
 926 }
 927
 928 impl Writeable for OnionHopData {
 929         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 930                 w.size_hint(65);
 931                 self.realm.write(w)?;
 932                 self.data.write(w)?;
 933                 self.hmac.write(w)?;
 934                 Ok(())
 935         }
 936 }
 937
 938 impl<R: Read> Readable<R> for OnionHopData {
 939         fn read(r: &mut R) -> Result<Self, DecodeError> {
 940                 Ok(OnionHopData {
 941                         realm: {
 942                                 let r: u8 = Readable::read(r)?;
 943                                 if r != 0 {
 944                                         return Err(DecodeError::UnknownVersion);
 945                                 }
 946                                 r
 947                         },
 948                         data: Readable::read(r)?,
 949                         hmac: Readable::read(r)?,
 950                 })
 951         }
 952 }
 953
 954 impl Writeable for Ping {
 955         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 956                 w.size_hint(self.byteslen as usize + 4);
 957                 self.ponglen.write(w)?;
 958                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
 959                 Ok(())
 960         }
 961 }
 962
 963 impl<R: Read> Readable<R> for Ping {
 964         fn read(r: &mut R) -> Result<Self, DecodeError> {
 965                 Ok(Ping {
 966                         ponglen: Readable::read(r)?,
 967                         byteslen: {
 968                                 let byteslen = Readable::read(r)?;
 969                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
 970                                 byteslen
 971                         }
 972                 })
 973         }
 974 }
 975
 976 impl Writeable for Pong {
 977         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 978                 w.size_hint(self.byteslen as usize + 2);
 979                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
 980                 Ok(())
 981         }
 982 }
 983
 984 impl<R: Read> Readable<R> for Pong {
 985         fn read(r: &mut R) -> Result<Self, DecodeError> {
 986                 Ok(Pong {
 987                         byteslen: {
 988                                 let byteslen = Readable::read(r)?;
 989                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
 990                                 byteslen
 991                         }
 992                 })
 993         }
 994 }
 995
 996 impl Writeable for UnsignedChannelAnnouncement {
 997         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
 998                 w.size_hint(2 + 2*32 + 4*33 + self.features.flags.len() + self.excess_data.len());
 999                 self.features.write(w)?;
1000                 self.chain_hash.write(w)?;
1001                 self.short_channel_id.write(w)?;
1002                 self.node_id_1.write(w)?;
1003                 self.node_id_2.write(w)?;
1004                 self.bitcoin_key_1.write(w)?;
1005                 self.bitcoin_key_2.write(w)?;
1006                 w.write_all(&self.excess_data[..])?;
1007                 Ok(())
1008         }
1009 }
1010
1011 impl<R: Read> Readable<R> for UnsignedChannelAnnouncement {
1012         fn read(r: &mut R) -> Result<Self, DecodeError> {
1013                 Ok(Self {
1014                         features: {
1015                                 let f: GlobalFeatures = Readable::read(r)?;
1016                                 if f.requires_unknown_bits() {
1017                                         return Err(DecodeError::UnknownRequiredFeature);
1018                                 }
1019                                 f
1020                         },
1021                         chain_hash: Readable::read(r)?,
1022                         short_channel_id: Readable::read(r)?,
1023                         node_id_1: Readable::read(r)?,
1024                         node_id_2: Readable::read(r)?,
1025                         bitcoin_key_1: Readable::read(r)?,
1026                         bitcoin_key_2: Readable::read(r)?,
1027                         excess_data: {
1028                                 let mut excess_data = vec![];
1029                                 r.read_to_end(&mut excess_data)?;
1030                                 excess_data
1031                         },
1032                 })
1033         }
1034 }
1035
1036 impl_writeable_len_match!(ChannelAnnouncement, {
1037                 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1038                         2 + 2*32 + 4*33 + features.flags.len() + excess_data.len() + 4*64 }
1039         }, {
1040         node_signature_1,
1041         node_signature_2,
1042         bitcoin_signature_1,
1043         bitcoin_signature_2,
1044         contents
1045 });
1046
1047 impl Writeable for UnsignedChannelUpdate {
1048         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1049                 w.size_hint(64 + self.excess_data.len());
1050                 self.chain_hash.write(w)?;
1051                 self.short_channel_id.write(w)?;
1052                 self.timestamp.write(w)?;
1053                 self.flags.write(w)?;
1054                 self.cltv_expiry_delta.write(w)?;
1055                 self.htlc_minimum_msat.write(w)?;
1056                 self.fee_base_msat.write(w)?;
1057                 self.fee_proportional_millionths.write(w)?;
1058                 w.write_all(&self.excess_data[..])?;
1059                 Ok(())
1060         }
1061 }
1062
1063 impl<R: Read> Readable<R> for UnsignedChannelUpdate {
1064         fn read(r: &mut R) -> Result<Self, DecodeError> {
1065                 Ok(Self {
1066                         chain_hash: Readable::read(r)?,
1067                         short_channel_id: Readable::read(r)?,
1068                         timestamp: Readable::read(r)?,
1069                         flags: Readable::read(r)?,
1070                         cltv_expiry_delta: Readable::read(r)?,
1071                         htlc_minimum_msat: Readable::read(r)?,
1072                         fee_base_msat: Readable::read(r)?,
1073                         fee_proportional_millionths: Readable::read(r)?,
1074                         excess_data: {
1075                                 let mut excess_data = vec![];
1076                                 r.read_to_end(&mut excess_data)?;
1077                                 excess_data
1078                         },
1079                 })
1080         }
1081 }
1082
1083 impl_writeable_len_match!(ChannelUpdate, {
1084                 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1085                         64 + excess_data.len() + 64 }
1086         }, {
1087         signature,
1088         contents
1089 });
1090
1091 impl Writeable for ErrorMessage {
1092         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1093                 w.size_hint(32 + 2 + self.data.len());
1094                 self.channel_id.write(w)?;
1095                 (self.data.len() as u16).write(w)?;
1096                 w.write_all(self.data.as_bytes())?;
1097                 Ok(())
1098         }
1099 }
1100
1101 impl<R: Read> Readable<R> for ErrorMessage {
1102         fn read(r: &mut R) -> Result<Self, DecodeError> {
1103                 Ok(Self {
1104                         channel_id: Readable::read(r)?,
1105                         data: {
1106                                 let mut sz: usize = <u16 as Readable<R>>::read(r)? as usize;
1107                                 let mut data = vec![];
1108                                 let data_len = r.read_to_end(&mut data)?;
1109                                 sz = cmp::min(data_len, sz);
1110                                 match String::from_utf8(data[..sz as usize].to_vec()) {
1111                                         Ok(s) => s,
1112                                         Err(_) => return Err(DecodeError::InvalidValue),
1113                                 }
1114                         }
1115                 })
1116         }
1117 }
1118
1119 impl Writeable for UnsignedNodeAnnouncement {
1120         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1121                 w.size_hint(64 + 76 + self.features.flags.len() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1122                 self.features.write(w)?;
1123                 self.timestamp.write(w)?;
1124                 self.node_id.write(w)?;
1125                 w.write_all(&self.rgb)?;
1126                 self.alias.write(w)?;
1127
1128                 let mut addr_slice = Vec::with_capacity(self.addresses.len() * 18);
1129                 let mut addrs_to_encode = self.addresses.clone();
1130                 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1131                 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1132                 for addr in addrs_to_encode.iter() {
1133                         match addr {
1134                                 &NetAddress::IPv4{addr, port} => {
1135                                         addr_slice.push(1);
1136                                         addr_slice.extend_from_slice(&addr);
1137                                         addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1138                                 },
1139                                 &NetAddress::IPv6{addr, port} => {
1140                                         addr_slice.push(2);
1141                                         addr_slice.extend_from_slice(&addr);
1142                                         addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1143                                 },
1144                                 &NetAddress::OnionV2{addr, port} => {
1145                                         addr_slice.push(3);
1146                                         addr_slice.extend_from_slice(&addr);
1147                                         addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1148                                 },
1149                                 &NetAddress::OnionV3{ed25519_pubkey, checksum, version, port} => {
1150                                         addr_slice.push(4);
1151                                         addr_slice.extend_from_slice(&ed25519_pubkey);
1152                                         addr_slice.extend_from_slice(&byte_utils::be16_to_array(checksum));
1153                                         addr_slice.push(version);
1154                                         addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1155                                 },
1156                         }
1157                 }
1158                 ((addr_slice.len() + self.excess_address_data.len()) as u16).write(w)?;
1159                 w.write_all(&addr_slice[..])?;
1160                 w.write_all(&self.excess_address_data[..])?;
1161                 w.write_all(&self.excess_data[..])?;
1162                 Ok(())
1163         }
1164 }
1165
1166 impl<R: Read> Readable<R> for UnsignedNodeAnnouncement {
1167         fn read(r: &mut R) -> Result<Self, DecodeError> {
1168                 let features: GlobalFeatures = Readable::read(r)?;
1169                 if features.requires_unknown_bits() {
1170                         return Err(DecodeError::UnknownRequiredFeature);
1171                 }
1172                 let timestamp: u32 = Readable::read(r)?;
1173                 let node_id: PublicKey = Readable::read(r)?;
1174                 let mut rgb = [0; 3];
1175                 r.read_exact(&mut rgb)?;
1176                 let alias: [u8; 32] = Readable::read(r)?;
1177
1178                 let addrlen: u16 = Readable::read(r)?;
1179                 let mut addr_readpos = 0;
1180                 let mut addresses = Vec::with_capacity(4);
1181                 let mut f: u8 = 0;
1182                 let mut excess = 0;
1183                 loop {
1184                         if addrlen <= addr_readpos { break; }
1185                         f = Readable::read(r)?;
1186                         match f {
1187                                 1 => {
1188                                         if addresses.len() > 0 {
1189                                                 return Err(DecodeError::ExtraAddressesPerType);
1190                                         }
1191                                         if addrlen < addr_readpos + 1 + 6 {
1192                                                 return Err(DecodeError::BadLengthDescriptor);
1193                                         }
1194                                         addresses.push(NetAddress::IPv4 {
1195                                                 addr: {
1196                                                         let mut addr = [0; 4];
1197                                                         r.read_exact(&mut addr)?;
1198                                                         addr
1199                                                 },
1200                                                 port: Readable::read(r)?,
1201                                         });
1202                                         addr_readpos += 1 + 6
1203                                 },
1204                                 2 => {
1205                                         if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1206                                                 return Err(DecodeError::ExtraAddressesPerType);
1207                                         }
1208                                         if addrlen < addr_readpos + 1 + 18 {
1209                                                 return Err(DecodeError::BadLengthDescriptor);
1210                                         }
1211                                         addresses.push(NetAddress::IPv6 {
1212                                                 addr: {
1213                                                         let mut addr = [0; 16];
1214                                                         r.read_exact(&mut addr)?;
1215                                                         addr
1216                                                 },
1217                                                 port: Readable::read(r)?,
1218                                         });
1219                                         addr_readpos += 1 + 18
1220                                 },
1221                                 3 => {
1222                                         if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1223                                                 return Err(DecodeError::ExtraAddressesPerType);
1224                                         }
1225                                         if addrlen < addr_readpos + 1 + 12 {
1226                                                 return Err(DecodeError::BadLengthDescriptor);
1227                                         }
1228                                         addresses.push(NetAddress::OnionV2 {
1229                                                 addr: {
1230                                                         let mut addr = [0; 10];
1231                                                         r.read_exact(&mut addr)?;
1232                                                         addr
1233                                                 },
1234                                                 port: Readable::read(r)?,
1235                                         });
1236                                         addr_readpos += 1 + 12
1237                                 },
1238                                 4 => {
1239                                         if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1240                                                 return Err(DecodeError::ExtraAddressesPerType);
1241                                         }
1242                                         if addrlen < addr_readpos + 1 + 37 {
1243                                                 return Err(DecodeError::BadLengthDescriptor);
1244                                         }
1245                                         addresses.push(NetAddress::OnionV3 {
1246                                                 ed25519_pubkey: Readable::read(r)?,
1247                                                 checksum: Readable::read(r)?,
1248                                                 version: Readable::read(r)?,
1249                                                 port: Readable::read(r)?,
1250                                         });
1251                                         addr_readpos += 1 + 37
1252                                 },
1253                                 _ => { excess = 1; break; }
1254                         }
1255                 }
1256
1257                 let mut excess_data = vec![];
1258                 let excess_address_data = if addr_readpos < addrlen {
1259                         let mut excess_address_data = vec![0; (addrlen - addr_readpos) as usize];
1260                         r.read_exact(&mut excess_address_data[excess..])?;
1261                         if excess == 1 {
1262                                 excess_address_data[0] = f;
1263                         }
1264                         excess_address_data
1265                 } else {
1266                         if excess == 1 {
1267                                 excess_data.push(f);
1268                         }
1269                         Vec::new()
1270                 };
1271
1272                 Ok(UnsignedNodeAnnouncement {
1273                         features: features,
1274                         timestamp: timestamp,
1275                         node_id: node_id,
1276                         rgb: rgb,
1277                         alias: alias,
1278                         addresses: addresses,
1279                         excess_address_data: excess_address_data,
1280                         excess_data: {
1281                                 r.read_to_end(&mut excess_data)?;
1282                                 excess_data
1283                         },
1284                 })
1285         }
1286 }
1287
1288 impl_writeable_len_match!(NodeAnnouncement, {
1289                 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1290                         64 + 76 + features.flags.len() + addresses.len()*38 + excess_address_data.len() + excess_data.len() }
1291         }, {
1292         signature,
1293         contents
1294 });
1295
1296 #[cfg(test)]
1297 mod tests {
1298         use hex;
1299         use ln::msgs;
1300         use util::ser::Writeable;
1301         use secp256k1::key::{PublicKey,SecretKey};
1302         use secp256k1::Secp256k1;
1303
1304         #[test]
1305         fn encoding_channel_reestablish_no_secret() {
1306                 let cr = msgs::ChannelReestablish {
1307                         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],
1308                         next_local_commitment_number: 3,
1309                         next_remote_commitment_number: 4,
1310                         data_loss_protect: None,
1311                 };
1312
1313                 let encoded_value = cr.encode();
1314                 assert_eq!(
1315                         encoded_value,
1316                         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]
1317                 );
1318         }
1319
1320         #[test]
1321         fn encoding_channel_reestablish_with_secret() {
1322                 let public_key = {
1323                         let secp_ctx = Secp256k1::new();
1324                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1325                 };
1326
1327                 let cr = msgs::ChannelReestablish {
1328                         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],
1329                         next_local_commitment_number: 3,
1330                         next_remote_commitment_number: 4,
1331                         data_loss_protect: Some(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1332                 };
1333
1334                 let encoded_value = cr.encode();
1335                 assert_eq!(
1336                         encoded_value,
1337                         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]
1338                 );
1339         }
1340 }