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