]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/msgs.rs
Merge pull request #1037 from sr-gi/add-txid-convert
[rust-lightning] / lightning / src / ln / msgs.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
11 //!
12 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
13 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
14 //! server entirely) which handles only channel-related messages you may wish to implement
15 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
16 //! daemons/servers.
17 //!
18 //! Note that if you go with such an architecture (instead of passing raw socket events to a
19 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
20 //! source node_id of the message, however this does allow you to significantly reduce bandwidth
21 //! between the systems as routing messages can represent a significant chunk of bandwidth usage
22 //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
23 //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
24 //! raw socket events into your non-internet-facing system and then send routing events back to
25 //! track the network on the less-secure system.
26
27 use bitcoin::secp256k1::key::PublicKey;
28 use bitcoin::secp256k1::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
32
33 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
34
35 use prelude::*;
36 use core::{cmp, fmt};
37 use core::fmt::Debug;
38 use io::{self, Read};
39 use io_extras::read_to_end;
40
41 use util::events::MessageSendEventsProvider;
42 use util::logger;
43 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
44
45 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
46
47 /// 21 million * 10^8 * 1000
48 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
49
50 /// An error in decoding a message or struct.
51 #[derive(Clone, Debug, PartialEq)]
52 pub enum DecodeError {
53         /// A version byte specified something we don't know how to handle.
54         /// Includes unknown realm byte in an OnionHopData packet
55         UnknownVersion,
56         /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
57         UnknownRequiredFeature,
58         /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
59         /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
60         /// syntactically incorrect, etc
61         InvalidValue,
62         /// Buffer too short
63         ShortRead,
64         /// A length descriptor in the packet didn't describe the later data correctly
65         BadLengthDescriptor,
66         /// Error from std::io
67         Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
68         io::ErrorKind),
69         /// The message included zlib-compressed values, which we don't support.
70         UnsupportedCompression,
71 }
72
73 /// An init message to be sent or received from a peer
74 #[derive(Clone, Debug, PartialEq)]
75 pub struct Init {
76         /// The relevant features which the sender supports
77         pub features: InitFeatures,
78 }
79
80 /// An error message to be sent or received from a peer
81 #[derive(Clone, Debug, PartialEq)]
82 pub struct ErrorMessage {
83         /// The channel ID involved in the error
84         pub channel_id: [u8; 32],
85         /// A possibly human-readable error description.
86         /// The string should be sanitized before it is used (e.g. emitted to logs
87         /// or printed to stdout).  Otherwise, a well crafted error message may trigger a security
88         /// vulnerability in the terminal emulator or the logging subsystem.
89         pub data: String,
90 }
91
92 /// A ping message to be sent or received from a peer
93 #[derive(Clone, Debug, PartialEq)]
94 pub struct Ping {
95         /// The desired response length
96         pub ponglen: u16,
97         /// The ping packet size.
98         /// This field is not sent on the wire. byteslen zeros are sent.
99         pub byteslen: u16,
100 }
101
102 /// A pong message to be sent or received from a peer
103 #[derive(Clone, Debug, PartialEq)]
104 pub struct Pong {
105         /// The pong packet size.
106         /// This field is not sent on the wire. byteslen zeros are sent.
107         pub byteslen: u16,
108 }
109
110 /// An open_channel message to be sent or received from a peer
111 #[derive(Clone, Debug, PartialEq)]
112 pub struct OpenChannel {
113         /// The genesis hash of the blockchain where the channel is to be opened
114         pub chain_hash: BlockHash,
115         /// A temporary channel ID, until the funding outpoint is announced
116         pub temporary_channel_id: [u8; 32],
117         /// The channel value
118         pub funding_satoshis: u64,
119         /// The amount to push to the counterparty as part of the open, in milli-satoshi
120         pub push_msat: u64,
121         /// The threshold below which outputs on transactions broadcast by sender will be omitted
122         pub dust_limit_satoshis: u64,
123         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
124         pub max_htlc_value_in_flight_msat: u64,
125         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
126         pub channel_reserve_satoshis: u64,
127         /// The minimum HTLC size incoming to sender, in milli-satoshi
128         pub htlc_minimum_msat: u64,
129         /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
130         pub feerate_per_kw: u32,
131         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
132         pub to_self_delay: u16,
133         /// The maximum number of inbound HTLCs towards sender
134         pub max_accepted_htlcs: u16,
135         /// The sender's key controlling the funding transaction
136         pub funding_pubkey: PublicKey,
137         /// Used to derive a revocation key for transactions broadcast by counterparty
138         pub revocation_basepoint: PublicKey,
139         /// A payment key to sender for transactions broadcast by counterparty
140         pub payment_point: PublicKey,
141         /// Used to derive a payment key to sender for transactions broadcast by sender
142         pub delayed_payment_basepoint: PublicKey,
143         /// Used to derive an HTLC payment key to sender
144         pub htlc_basepoint: PublicKey,
145         /// The first to-be-broadcast-by-sender transaction's per commitment point
146         pub first_per_commitment_point: PublicKey,
147         /// Channel flags
148         pub channel_flags: u8,
149         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
150         pub shutdown_scriptpubkey: OptionalField<Script>,
151 }
152
153 /// An accept_channel message to be sent or received from a peer
154 #[derive(Clone, Debug, PartialEq)]
155 pub struct AcceptChannel {
156         /// A temporary channel ID, until the funding outpoint is announced
157         pub temporary_channel_id: [u8; 32],
158         /// The threshold below which outputs on transactions broadcast by sender will be omitted
159         pub dust_limit_satoshis: u64,
160         /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
161         pub max_htlc_value_in_flight_msat: u64,
162         /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
163         pub channel_reserve_satoshis: u64,
164         /// The minimum HTLC size incoming to sender, in milli-satoshi
165         pub htlc_minimum_msat: u64,
166         /// Minimum depth of the funding transaction before the channel is considered open
167         pub minimum_depth: u32,
168         /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
169         pub to_self_delay: u16,
170         /// The maximum number of inbound HTLCs towards sender
171         pub max_accepted_htlcs: u16,
172         /// The sender's key controlling the funding transaction
173         pub funding_pubkey: PublicKey,
174         /// Used to derive a revocation key for transactions broadcast by counterparty
175         pub revocation_basepoint: PublicKey,
176         /// A payment key to sender for transactions broadcast by counterparty
177         pub payment_point: PublicKey,
178         /// Used to derive a payment key to sender for transactions broadcast by sender
179         pub delayed_payment_basepoint: PublicKey,
180         /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
181         pub htlc_basepoint: PublicKey,
182         /// The first to-be-broadcast-by-sender transaction's per commitment point
183         pub first_per_commitment_point: PublicKey,
184         /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
185         pub shutdown_scriptpubkey: OptionalField<Script>,
186 }
187
188 /// A funding_created message to be sent or received from a peer
189 #[derive(Clone, Debug, PartialEq)]
190 pub struct FundingCreated {
191         /// A temporary channel ID, until the funding is established
192         pub temporary_channel_id: [u8; 32],
193         /// The funding transaction ID
194         pub funding_txid: Txid,
195         /// The specific output index funding this channel
196         pub funding_output_index: u16,
197         /// The signature of the channel initiator (funder) on the funding transaction
198         pub signature: Signature,
199 }
200
201 /// A funding_signed message to be sent or received from a peer
202 #[derive(Clone, Debug, PartialEq)]
203 pub struct FundingSigned {
204         /// The channel ID
205         pub channel_id: [u8; 32],
206         /// The signature of the channel acceptor (fundee) on the funding transaction
207         pub signature: Signature,
208 }
209
210 /// A funding_locked message to be sent or received from a peer
211 #[derive(Clone, Debug, PartialEq)]
212 pub struct FundingLocked {
213         /// The channel ID
214         pub channel_id: [u8; 32],
215         /// The per-commitment point of the second commitment transaction
216         pub next_per_commitment_point: PublicKey,
217 }
218
219 /// A shutdown message to be sent or received from a peer
220 #[derive(Clone, Debug, PartialEq)]
221 pub struct Shutdown {
222         /// The channel ID
223         pub channel_id: [u8; 32],
224         /// The destination of this peer's funds on closing.
225         /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
226         pub scriptpubkey: Script,
227 }
228
229 /// The minimum and maximum fees which the sender is willing to place on the closing transaction.
230 /// This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
231 /// to use.
232 #[derive(Clone, Debug, PartialEq)]
233 pub struct ClosingSignedFeeRange {
234         /// The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
235         /// transaction.
236         pub min_fee_satoshis: u64,
237         /// The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
238         /// transaction.
239         pub max_fee_satoshis: u64,
240 }
241
242 /// A closing_signed message to be sent or received from a peer
243 #[derive(Clone, Debug, PartialEq)]
244 pub struct ClosingSigned {
245         /// The channel ID
246         pub channel_id: [u8; 32],
247         /// The proposed total fee for the closing transaction
248         pub fee_satoshis: u64,
249         /// A signature on the closing transaction
250         pub signature: Signature,
251         /// The minimum and maximum fees which the sender is willing to accept, provided only by new
252         /// nodes.
253         pub fee_range: Option<ClosingSignedFeeRange>,
254 }
255
256 /// An update_add_htlc message to be sent or received from a peer
257 #[derive(Clone, Debug, PartialEq)]
258 pub struct UpdateAddHTLC {
259         /// The channel ID
260         pub channel_id: [u8; 32],
261         /// The HTLC ID
262         pub htlc_id: u64,
263         /// The HTLC value in milli-satoshi
264         pub amount_msat: u64,
265         /// The payment hash, the pre-image of which controls HTLC redemption
266         pub payment_hash: PaymentHash,
267         /// The expiry height of the HTLC
268         pub cltv_expiry: u32,
269         pub(crate) onion_routing_packet: OnionPacket,
270 }
271
272 /// An update_fulfill_htlc message to be sent or received from a peer
273 #[derive(Clone, Debug, PartialEq)]
274 pub struct UpdateFulfillHTLC {
275         /// The channel ID
276         pub channel_id: [u8; 32],
277         /// The HTLC ID
278         pub htlc_id: u64,
279         /// The pre-image of the payment hash, allowing HTLC redemption
280         pub payment_preimage: PaymentPreimage,
281 }
282
283 /// An update_fail_htlc message to be sent or received from a peer
284 #[derive(Clone, Debug, PartialEq)]
285 pub struct UpdateFailHTLC {
286         /// The channel ID
287         pub channel_id: [u8; 32],
288         /// The HTLC ID
289         pub htlc_id: u64,
290         pub(crate) reason: OnionErrorPacket,
291 }
292
293 /// An update_fail_malformed_htlc message to be sent or received from a peer
294 #[derive(Clone, Debug, PartialEq)]
295 pub struct UpdateFailMalformedHTLC {
296         /// The channel ID
297         pub channel_id: [u8; 32],
298         /// The HTLC ID
299         pub htlc_id: u64,
300         pub(crate) sha256_of_onion: [u8; 32],
301         /// The failure code
302         pub failure_code: u16,
303 }
304
305 /// A commitment_signed message to be sent or received from a peer
306 #[derive(Clone, Debug, PartialEq)]
307 pub struct CommitmentSigned {
308         /// The channel ID
309         pub channel_id: [u8; 32],
310         /// A signature on the commitment transaction
311         pub signature: Signature,
312         /// Signatures on the HTLC transactions
313         pub htlc_signatures: Vec<Signature>,
314 }
315
316 /// A revoke_and_ack message to be sent or received from a peer
317 #[derive(Clone, Debug, PartialEq)]
318 pub struct RevokeAndACK {
319         /// The channel ID
320         pub channel_id: [u8; 32],
321         /// The secret corresponding to the per-commitment point
322         pub per_commitment_secret: [u8; 32],
323         /// The next sender-broadcast commitment transaction's per-commitment point
324         pub next_per_commitment_point: PublicKey,
325 }
326
327 /// An update_fee message to be sent or received from a peer
328 #[derive(Clone, Debug, PartialEq)]
329 pub struct UpdateFee {
330         /// The channel ID
331         pub channel_id: [u8; 32],
332         /// Fee rate per 1000-weight of the transaction
333         pub feerate_per_kw: u32,
334 }
335
336 #[derive(Clone, Debug, PartialEq)]
337 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
338 /// This is used to convince the recipient that the channel is at a certain commitment
339 /// number even if they lost that data due to a local failure.  Of course, the peer may lie
340 /// and even later commitments may have been revoked.
341 pub struct DataLossProtect {
342         /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
343         /// belonging to the recipient
344         pub your_last_per_commitment_secret: [u8; 32],
345         /// The sender's per-commitment point for their current commitment transaction
346         pub my_current_per_commitment_point: PublicKey,
347 }
348
349 /// A channel_reestablish message to be sent or received from a peer
350 #[derive(Clone, Debug, PartialEq)]
351 pub struct ChannelReestablish {
352         /// The channel ID
353         pub channel_id: [u8; 32],
354         /// The next commitment number for the sender
355         pub next_local_commitment_number: u64,
356         /// The next commitment number for the recipient
357         pub next_remote_commitment_number: u64,
358         /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
359         pub data_loss_protect: OptionalField<DataLossProtect>,
360 }
361
362 /// An announcement_signatures message to be sent or received from a peer
363 #[derive(Clone, Debug, PartialEq)]
364 pub struct AnnouncementSignatures {
365         /// The channel ID
366         pub channel_id: [u8; 32],
367         /// The short channel ID
368         pub short_channel_id: u64,
369         /// A signature by the node key
370         pub node_signature: Signature,
371         /// A signature by the funding key
372         pub bitcoin_signature: Signature,
373 }
374
375 /// An address which can be used to connect to a remote peer
376 #[derive(Clone, Debug, PartialEq)]
377 pub enum NetAddress {
378         /// An IPv4 address/port on which the peer is listening.
379         IPv4 {
380                 /// The 4-byte IPv4 address
381                 addr: [u8; 4],
382                 /// The port on which the node is listening
383                 port: u16,
384         },
385         /// An IPv6 address/port on which the peer is listening.
386         IPv6 {
387                 /// The 16-byte IPv6 address
388                 addr: [u8; 16],
389                 /// The port on which the node is listening
390                 port: u16,
391         },
392         /// An old-style Tor onion address/port on which the peer is listening.
393         OnionV2 {
394                 /// The bytes (usually encoded in base32 with ".onion" appended)
395                 addr: [u8; 10],
396                 /// The port on which the node is listening
397                 port: u16,
398         },
399         /// A new-style Tor onion address/port on which the peer is listening.
400         /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
401         /// wrap as base32 and append ".onion".
402         OnionV3 {
403                 /// The ed25519 long-term public key of the peer
404                 ed25519_pubkey: [u8; 32],
405                 /// The checksum of the pubkey and version, as included in the onion address
406                 checksum: u16,
407                 /// The version byte, as defined by the Tor Onion v3 spec.
408                 version: u8,
409                 /// The port on which the node is listening
410                 port: u16,
411         },
412 }
413 impl NetAddress {
414         /// Gets the ID of this address type. Addresses in node_announcement messages should be sorted
415         /// by this.
416         pub(crate) fn get_id(&self) -> u8 {
417                 match self {
418                         &NetAddress::IPv4 {..} => { 1 },
419                         &NetAddress::IPv6 {..} => { 2 },
420                         &NetAddress::OnionV2 {..} => { 3 },
421                         &NetAddress::OnionV3 {..} => { 4 },
422                 }
423         }
424
425         /// Strict byte-length of address descriptor, 1-byte type not recorded
426         fn len(&self) -> u16 {
427                 match self {
428                         &NetAddress::IPv4 { .. } => { 6 },
429                         &NetAddress::IPv6 { .. } => { 18 },
430                         &NetAddress::OnionV2 { .. } => { 12 },
431                         &NetAddress::OnionV3 { .. } => { 37 },
432                 }
433         }
434
435         /// The maximum length of any address descriptor, not including the 1-byte type
436         pub(crate) const MAX_LEN: u16 = 37;
437 }
438
439 impl Writeable for NetAddress {
440         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
441                 match self {
442                         &NetAddress::IPv4 { ref addr, ref port } => {
443                                 1u8.write(writer)?;
444                                 addr.write(writer)?;
445                                 port.write(writer)?;
446                         },
447                         &NetAddress::IPv6 { ref addr, ref port } => {
448                                 2u8.write(writer)?;
449                                 addr.write(writer)?;
450                                 port.write(writer)?;
451                         },
452                         &NetAddress::OnionV2 { ref addr, ref port } => {
453                                 3u8.write(writer)?;
454                                 addr.write(writer)?;
455                                 port.write(writer)?;
456                         },
457                         &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
458                                 4u8.write(writer)?;
459                                 ed25519_pubkey.write(writer)?;
460                                 checksum.write(writer)?;
461                                 version.write(writer)?;
462                                 port.write(writer)?;
463                         }
464                 }
465                 Ok(())
466         }
467 }
468
469 impl Readable for Result<NetAddress, u8> {
470         fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
471                 let byte = <u8 as Readable>::read(reader)?;
472                 match byte {
473                         1 => {
474                                 Ok(Ok(NetAddress::IPv4 {
475                                         addr: Readable::read(reader)?,
476                                         port: Readable::read(reader)?,
477                                 }))
478                         },
479                         2 => {
480                                 Ok(Ok(NetAddress::IPv6 {
481                                         addr: Readable::read(reader)?,
482                                         port: Readable::read(reader)?,
483                                 }))
484                         },
485                         3 => {
486                                 Ok(Ok(NetAddress::OnionV2 {
487                                         addr: Readable::read(reader)?,
488                                         port: Readable::read(reader)?,
489                                 }))
490                         },
491                         4 => {
492                                 Ok(Ok(NetAddress::OnionV3 {
493                                         ed25519_pubkey: Readable::read(reader)?,
494                                         checksum: Readable::read(reader)?,
495                                         version: Readable::read(reader)?,
496                                         port: Readable::read(reader)?,
497                                 }))
498                         },
499                         _ => return Ok(Err(byte)),
500                 }
501         }
502 }
503
504 impl Readable for NetAddress {
505         fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
506                 match Readable::read(reader) {
507                         Ok(Ok(res)) => Ok(res),
508                         Ok(Err(_)) => Err(DecodeError::UnknownVersion),
509                         Err(e) => Err(e),
510                 }
511         }
512 }
513
514
515 /// The unsigned part of a node_announcement
516 #[derive(Clone, Debug, PartialEq)]
517 pub struct UnsignedNodeAnnouncement {
518         /// The advertised features
519         pub features: NodeFeatures,
520         /// A strictly monotonic announcement counter, with gaps allowed
521         pub timestamp: u32,
522         /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
523         /// to this node).
524         pub node_id: PublicKey,
525         /// An RGB color for UI purposes
526         pub rgb: [u8; 3],
527         /// An alias, for UI purposes.  This should be sanitized before use.  There is no guarantee
528         /// of uniqueness.
529         pub alias: [u8; 32],
530         /// List of addresses on which this node is reachable
531         pub addresses: Vec<NetAddress>,
532         pub(crate) excess_address_data: Vec<u8>,
533         pub(crate) excess_data: Vec<u8>,
534 }
535 #[derive(Clone, Debug, PartialEq)]
536 /// A node_announcement message to be sent or received from a peer
537 pub struct NodeAnnouncement {
538         /// The signature by the node key
539         pub signature: Signature,
540         /// The actual content of the announcement
541         pub contents: UnsignedNodeAnnouncement,
542 }
543
544 /// The unsigned part of a channel_announcement
545 #[derive(Clone, Debug, PartialEq)]
546 pub struct UnsignedChannelAnnouncement {
547         /// The advertised channel features
548         pub features: ChannelFeatures,
549         /// The genesis hash of the blockchain where the channel is to be opened
550         pub chain_hash: BlockHash,
551         /// The short channel ID
552         pub short_channel_id: u64,
553         /// One of the two node_ids which are endpoints of this channel
554         pub node_id_1: PublicKey,
555         /// The other of the two node_ids which are endpoints of this channel
556         pub node_id_2: PublicKey,
557         /// The funding key for the first node
558         pub bitcoin_key_1: PublicKey,
559         /// The funding key for the second node
560         pub bitcoin_key_2: PublicKey,
561         pub(crate) excess_data: Vec<u8>,
562 }
563 /// A channel_announcement message to be sent or received from a peer
564 #[derive(Clone, Debug, PartialEq)]
565 pub struct ChannelAnnouncement {
566         /// Authentication of the announcement by the first public node
567         pub node_signature_1: Signature,
568         /// Authentication of the announcement by the second public node
569         pub node_signature_2: Signature,
570         /// Proof of funding UTXO ownership by the first public node
571         pub bitcoin_signature_1: Signature,
572         /// Proof of funding UTXO ownership by the second public node
573         pub bitcoin_signature_2: Signature,
574         /// The actual announcement
575         pub contents: UnsignedChannelAnnouncement,
576 }
577
578 /// The unsigned part of a channel_update
579 #[derive(Clone, Debug, PartialEq)]
580 pub struct UnsignedChannelUpdate {
581         /// The genesis hash of the blockchain where the channel is to be opened
582         pub chain_hash: BlockHash,
583         /// The short channel ID
584         pub short_channel_id: u64,
585         /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
586         pub timestamp: u32,
587         /// Channel flags
588         pub flags: u8,
589         /// The number of blocks such that if:
590         /// `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
591         /// then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
592         /// the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
593         /// cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
594         /// then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
595         /// forwarding. Note that the HTLC sender is the one who originally sets this value when
596         /// constructing the route.
597         pub cltv_expiry_delta: u16,
598         /// The minimum HTLC size incoming to sender, in milli-satoshi
599         pub htlc_minimum_msat: u64,
600         /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
601         pub htlc_maximum_msat: OptionalField<u64>,
602         /// The base HTLC fee charged by sender, in milli-satoshi
603         pub fee_base_msat: u32,
604         /// The amount to fee multiplier, in micro-satoshi
605         pub fee_proportional_millionths: u32,
606         pub(crate) excess_data: Vec<u8>,
607 }
608 /// A channel_update message to be sent or received from a peer
609 #[derive(Clone, Debug, PartialEq)]
610 pub struct ChannelUpdate {
611         /// A signature of the channel update
612         pub signature: Signature,
613         /// The actual channel update
614         pub contents: UnsignedChannelUpdate,
615 }
616
617 /// A query_channel_range message is used to query a peer for channel
618 /// UTXOs in a range of blocks. The recipient of a query makes a best
619 /// effort to reply to the query using one or more reply_channel_range
620 /// messages.
621 #[derive(Clone, Debug, PartialEq)]
622 pub struct QueryChannelRange {
623         /// The genesis hash of the blockchain being queried
624         pub chain_hash: BlockHash,
625         /// The height of the first block for the channel UTXOs being queried
626         pub first_blocknum: u32,
627         /// The number of blocks to include in the query results
628         pub number_of_blocks: u32,
629 }
630
631 /// A reply_channel_range message is a reply to a query_channel_range
632 /// message. Multiple reply_channel_range messages can be sent in reply
633 /// to a single query_channel_range message. The query recipient makes a
634 /// best effort to respond based on their local network view which may
635 /// not be a perfect view of the network. The short_channel_ids in the
636 /// reply are encoded. We only support encoding_type=0 uncompressed
637 /// serialization and do not support encoding_type=1 zlib serialization.
638 #[derive(Clone, Debug, PartialEq)]
639 pub struct ReplyChannelRange {
640         /// The genesis hash of the blockchain being queried
641         pub chain_hash: BlockHash,
642         /// The height of the first block in the range of the reply
643         pub first_blocknum: u32,
644         /// The number of blocks included in the range of the reply
645         pub number_of_blocks: u32,
646         /// True when this is the final reply for a query
647         pub sync_complete: bool,
648         /// The short_channel_ids in the channel range
649         pub short_channel_ids: Vec<u64>,
650 }
651
652 /// A query_short_channel_ids message is used to query a peer for
653 /// routing gossip messages related to one or more short_channel_ids.
654 /// The query recipient will reply with the latest, if available,
655 /// channel_announcement, channel_update and node_announcement messages
656 /// it maintains for the requested short_channel_ids followed by a
657 /// reply_short_channel_ids_end message. The short_channel_ids sent in
658 /// this query are encoded. We only support encoding_type=0 uncompressed
659 /// serialization and do not support encoding_type=1 zlib serialization.
660 #[derive(Clone, Debug, PartialEq)]
661 pub struct QueryShortChannelIds {
662         /// The genesis hash of the blockchain being queried
663         pub chain_hash: BlockHash,
664         /// The short_channel_ids that are being queried
665         pub short_channel_ids: Vec<u64>,
666 }
667
668 /// A reply_short_channel_ids_end message is sent as a reply to a
669 /// query_short_channel_ids message. The query recipient makes a best
670 /// effort to respond based on their local network view which may not be
671 /// a perfect view of the network.
672 #[derive(Clone, Debug, PartialEq)]
673 pub struct ReplyShortChannelIdsEnd {
674         /// The genesis hash of the blockchain that was queried
675         pub chain_hash: BlockHash,
676         /// Indicates if the query recipient maintains up-to-date channel
677         /// information for the chain_hash
678         pub full_information: bool,
679 }
680
681 /// A gossip_timestamp_filter message is used by a node to request
682 /// gossip relay for messages in the requested time range when the
683 /// gossip_queries feature has been negotiated.
684 #[derive(Clone, Debug, PartialEq)]
685 pub struct GossipTimestampFilter {
686         /// The genesis hash of the blockchain for channel and node information
687         pub chain_hash: BlockHash,
688         /// The starting unix timestamp
689         pub first_timestamp: u32,
690         /// The range of information in seconds
691         pub timestamp_range: u32,
692 }
693
694 /// Encoding type for data compression of collections in gossip queries.
695 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
696 enum EncodingType {
697         Uncompressed = 0x00,
698 }
699
700 /// Used to put an error message in a LightningError
701 #[derive(Clone, Debug)]
702 pub enum ErrorAction {
703         /// The peer took some action which made us think they were useless. Disconnect them.
704         DisconnectPeer {
705                 /// An error message which we should make an effort to send before we disconnect.
706                 msg: Option<ErrorMessage>
707         },
708         /// The peer did something harmless that we weren't able to process, just log and ignore
709         // New code should *not* use this. New code must use IgnoreAndLog, below!
710         IgnoreError,
711         /// The peer did something harmless that we weren't able to meaningfully process.
712         /// If the error is logged, log it at the given level.
713         IgnoreAndLog(logger::Level),
714         /// The peer did something incorrect. Tell them.
715         SendErrorMessage {
716                 /// The message to send.
717                 msg: ErrorMessage
718         },
719 }
720
721 /// An Err type for failure to process messages.
722 #[derive(Clone, Debug)]
723 pub struct LightningError {
724         /// A human-readable message describing the error
725         pub err: String,
726         /// The action which should be taken against the offending peer.
727         pub action: ErrorAction,
728 }
729
730 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
731 /// transaction updates if they were pending.
732 #[derive(Clone, Debug, PartialEq)]
733 pub struct CommitmentUpdate {
734         /// update_add_htlc messages which should be sent
735         pub update_add_htlcs: Vec<UpdateAddHTLC>,
736         /// update_fulfill_htlc messages which should be sent
737         pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
738         /// update_fail_htlc messages which should be sent
739         pub update_fail_htlcs: Vec<UpdateFailHTLC>,
740         /// update_fail_malformed_htlc messages which should be sent
741         pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
742         /// An update_fee message which should be sent
743         pub update_fee: Option<UpdateFee>,
744         /// Finally, the commitment_signed message which should be sent
745         pub commitment_signed: CommitmentSigned,
746 }
747
748 /// The information we received from a peer along the route of a payment we originated. This is
749 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
750 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
751 #[derive(Clone, Debug, PartialEq)]
752 pub enum HTLCFailChannelUpdate {
753         /// We received an error which included a full ChannelUpdate message.
754         ChannelUpdateMessage {
755                 /// The unwrapped message we received
756                 msg: ChannelUpdate,
757         },
758         /// We received an error which indicated only that a channel has been closed
759         ChannelClosed {
760                 /// The short_channel_id which has now closed.
761                 short_channel_id: u64,
762                 /// when this true, this channel should be permanently removed from the
763                 /// consideration. Otherwise, this channel can be restored as new channel_update is received
764                 is_permanent: bool,
765         },
766         /// We received an error which indicated only that a node has failed
767         NodeFailure {
768                 /// The node_id that has failed.
769                 node_id: PublicKey,
770                 /// when this true, node should be permanently removed from the
771                 /// consideration. Otherwise, the channels connected to this node can be
772                 /// restored as new channel_update is received
773                 is_permanent: bool,
774         }
775 }
776
777 /// Messages could have optional fields to use with extended features
778 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
779 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
780 /// separate enum type for them.
781 /// (C-not exported) due to a free generic in T
782 #[derive(Clone, Debug, PartialEq)]
783 pub enum OptionalField<T> {
784         /// Optional field is included in message
785         Present(T),
786         /// Optional field is absent in message
787         Absent
788 }
789
790 /// A trait to describe an object which can receive channel messages.
791 ///
792 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
793 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
794 pub trait ChannelMessageHandler : MessageSendEventsProvider {
795         //Channel init:
796         /// Handle an incoming open_channel message from the given peer.
797         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
798         /// Handle an incoming accept_channel message from the given peer.
799         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
800         /// Handle an incoming funding_created message from the given peer.
801         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
802         /// Handle an incoming funding_signed message from the given peer.
803         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
804         /// Handle an incoming funding_locked message from the given peer.
805         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
806
807         // Channl close:
808         /// Handle an incoming shutdown message from the given peer.
809         fn handle_shutdown(&self, their_node_id: &PublicKey, their_features: &InitFeatures, msg: &Shutdown);
810         /// Handle an incoming closing_signed message from the given peer.
811         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
812
813         // HTLC handling:
814         /// Handle an incoming update_add_htlc message from the given peer.
815         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
816         /// Handle an incoming update_fulfill_htlc message from the given peer.
817         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
818         /// Handle an incoming update_fail_htlc message from the given peer.
819         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
820         /// Handle an incoming update_fail_malformed_htlc message from the given peer.
821         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
822         /// Handle an incoming commitment_signed message from the given peer.
823         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
824         /// Handle an incoming revoke_and_ack message from the given peer.
825         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
826
827         /// Handle an incoming update_fee message from the given peer.
828         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
829
830         // Channel-to-announce:
831         /// Handle an incoming announcement_signatures message from the given peer.
832         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
833
834         // Connection loss/reestablish:
835         /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
836         /// is believed to be possible in the future (eg they're sending us messages we don't
837         /// understand or indicate they require unknown feature bits), no_connection_possible is set
838         /// and any outstanding channels should be failed.
839         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
840
841         /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
842         fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
843         /// Handle an incoming channel_reestablish message from the given peer.
844         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
845
846         /// Handle an incoming channel update from the given peer.
847         fn handle_channel_update(&self, their_node_id: &PublicKey, msg: &ChannelUpdate);
848
849         // Error:
850         /// Handle an incoming error message from the given peer.
851         fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
852 }
853
854 /// A trait to describe an object which can receive routing messages.
855 ///
856 /// # Implementor DoS Warnings
857 ///
858 /// For `gossip_queries` messages there are potential DoS vectors when handling
859 /// inbound queries. Implementors using an on-disk network graph should be aware of
860 /// repeated disk I/O for queries accessing different parts of the network graph.
861 pub trait RoutingMessageHandler : MessageSendEventsProvider {
862         /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
863         /// false or returning an Err otherwise.
864         fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
865         /// Handle a channel_announcement message, returning true if it should be forwarded on, false
866         /// or returning an Err otherwise.
867         fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
868         /// Handle an incoming channel_update message, returning true if it should be forwarded on,
869         /// false or returning an Err otherwise.
870         fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
871         /// Handle some updates to the route graph that we learned due to an outbound failed payment.
872         fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
873         /// Gets a subset of the channel announcements and updates required to dump our routing table
874         /// to a remote node, starting at the short_channel_id indicated by starting_point and
875         /// including the batch_amount entries immediately higher in numerical value than starting_point.
876         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
877         /// Gets a subset of the node announcements required to dump our routing table to a remote node,
878         /// starting at the node *after* the provided publickey and including batch_amount entries
879         /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
880         /// If None is provided for starting_point, we start at the first node.
881         fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
882         /// Called when a connection is established with a peer. This can be used to
883         /// perform routing table synchronization using a strategy defined by the
884         /// implementor.
885         fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
886         /// Handles the reply of a query we initiated to learn about channels
887         /// for a given range of blocks. We can expect to receive one or more
888         /// replies to a single query.
889         fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
890         /// Handles the reply of a query we initiated asking for routing gossip
891         /// messages for a list of channels. We should receive this message when
892         /// a node has completed its best effort to send us the pertaining routing
893         /// gossip messages.
894         fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
895         /// Handles when a peer asks us to send a list of short_channel_ids
896         /// for the requested range of blocks.
897         fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
898         /// Handles when a peer asks us to send routing gossip messages for a
899         /// list of short_channel_ids.
900         fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
901 }
902
903 mod fuzzy_internal_msgs {
904         use prelude::*;
905         use ln::{PaymentPreimage, PaymentSecret};
906
907         // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
908         // them from untrusted input):
909         #[derive(Clone)]
910         pub(crate) struct FinalOnionHopData {
911                 pub(crate) payment_secret: PaymentSecret,
912                 /// The total value, in msat, of the payment as received by the ultimate recipient.
913                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
914                 pub(crate) total_msat: u64,
915         }
916
917         pub(crate) enum OnionHopDataFormat {
918                 Legacy { // aka Realm-0
919                         short_channel_id: u64,
920                 },
921                 NonFinalNode {
922                         short_channel_id: u64,
923                 },
924                 FinalNode {
925                         payment_data: Option<FinalOnionHopData>,
926                         keysend_preimage: Option<PaymentPreimage>,
927                 },
928         }
929
930         pub struct OnionHopData {
931                 pub(crate) format: OnionHopDataFormat,
932                 /// The value, in msat, of the payment after this hop's fee is deducted.
933                 /// Message serialization may panic if this value is more than 21 million Bitcoin.
934                 pub(crate) amt_to_forward: u64,
935                 pub(crate) outgoing_cltv_value: u32,
936                 // 12 bytes of 0-padding for Legacy format
937         }
938
939         pub struct DecodedOnionErrorPacket {
940                 pub(crate) hmac: [u8; 32],
941                 pub(crate) failuremsg: Vec<u8>,
942                 pub(crate) pad: Vec<u8>,
943         }
944 }
945 #[cfg(feature = "fuzztarget")]
946 pub use self::fuzzy_internal_msgs::*;
947 #[cfg(not(feature = "fuzztarget"))]
948 pub(crate) use self::fuzzy_internal_msgs::*;
949
950 #[derive(Clone)]
951 pub(crate) struct OnionPacket {
952         pub(crate) version: u8,
953         /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
954         /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
955         /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
956         pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
957         pub(crate) hop_data: [u8; 20*65],
958         pub(crate) hmac: [u8; 32],
959 }
960
961 impl PartialEq for OnionPacket {
962         fn eq(&self, other: &OnionPacket) -> bool {
963                 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
964                         if i != j { return false; }
965                 }
966                 self.version == other.version &&
967                         self.public_key == other.public_key &&
968                         self.hmac == other.hmac
969         }
970 }
971
972 impl fmt::Debug for OnionPacket {
973         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
974                 f.write_fmt(format_args!("OnionPacket version {} with hmac {:?}", self.version, &self.hmac[..]))
975         }
976 }
977
978 #[derive(Clone, Debug, PartialEq)]
979 pub(crate) struct OnionErrorPacket {
980         // This really should be a constant size slice, but the spec lets these things be up to 128KB?
981         // (TODO) We limit it in decode to much lower...
982         pub(crate) data: Vec<u8>,
983 }
984
985 impl fmt::Display for DecodeError {
986         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
987                 match *self {
988                         DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
989                         DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
990                         DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
991                         DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
992                         DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
993                         DecodeError::Io(ref e) => e.fmt(f),
994                         DecodeError::UnsupportedCompression => f.write_str("We don't support receiving messages with zlib-compressed fields"),
995                 }
996         }
997 }
998
999 impl From<io::Error> for DecodeError {
1000         fn from(e: io::Error) -> Self {
1001                 if e.kind() == io::ErrorKind::UnexpectedEof {
1002                         DecodeError::ShortRead
1003                 } else {
1004                         DecodeError::Io(e.kind())
1005                 }
1006         }
1007 }
1008
1009 impl Writeable for OptionalField<Script> {
1010         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1011                 match *self {
1012                         OptionalField::Present(ref script) => {
1013                                 // Note that Writeable for script includes the 16-bit length tag for us
1014                                 script.write(w)?;
1015                         },
1016                         OptionalField::Absent => {}
1017                 }
1018                 Ok(())
1019         }
1020 }
1021
1022 impl Readable for OptionalField<Script> {
1023         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1024                 match <u16 as Readable>::read(r) {
1025                         Ok(len) => {
1026                                 let mut buf = vec![0; len as usize];
1027                                 r.read_exact(&mut buf)?;
1028                                 Ok(OptionalField::Present(Script::from(buf)))
1029                         },
1030                         Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
1031                         Err(e) => Err(e)
1032                 }
1033         }
1034 }
1035
1036 impl Writeable for OptionalField<u64> {
1037         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1038                 match *self {
1039                         OptionalField::Present(ref value) => {
1040                                 value.write(w)?;
1041                         },
1042                         OptionalField::Absent => {}
1043                 }
1044                 Ok(())
1045         }
1046 }
1047
1048 impl Readable for OptionalField<u64> {
1049         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1050                 let value: u64 = Readable::read(r)?;
1051                 Ok(OptionalField::Present(value))
1052         }
1053 }
1054
1055
1056 impl_writeable_len_match!(AcceptChannel, {
1057                 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1058                 {_, 270}
1059         }, {
1060         temporary_channel_id,
1061         dust_limit_satoshis,
1062         max_htlc_value_in_flight_msat,
1063         channel_reserve_satoshis,
1064         htlc_minimum_msat,
1065         minimum_depth,
1066         to_self_delay,
1067         max_accepted_htlcs,
1068         funding_pubkey,
1069         revocation_basepoint,
1070         payment_point,
1071         delayed_payment_basepoint,
1072         htlc_basepoint,
1073         first_per_commitment_point,
1074         shutdown_scriptpubkey
1075 });
1076
1077 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1078         channel_id,
1079         short_channel_id,
1080         node_signature,
1081         bitcoin_signature
1082 });
1083
1084 impl Writeable for ChannelReestablish {
1085         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1086                 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1087                 self.channel_id.write(w)?;
1088                 self.next_local_commitment_number.write(w)?;
1089                 self.next_remote_commitment_number.write(w)?;
1090                 match self.data_loss_protect {
1091                         OptionalField::Present(ref data_loss_protect) => {
1092                                 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1093                                 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1094                         },
1095                         OptionalField::Absent => {}
1096                 }
1097                 Ok(())
1098         }
1099 }
1100
1101 impl Readable for ChannelReestablish{
1102         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1103                 Ok(Self {
1104                         channel_id: Readable::read(r)?,
1105                         next_local_commitment_number: Readable::read(r)?,
1106                         next_remote_commitment_number: Readable::read(r)?,
1107                         data_loss_protect: {
1108                                 match <[u8; 32] as Readable>::read(r) {
1109                                         Ok(your_last_per_commitment_secret) =>
1110                                                 OptionalField::Present(DataLossProtect {
1111                                                         your_last_per_commitment_secret,
1112                                                         my_current_per_commitment_point: Readable::read(r)?,
1113                                                 }),
1114                                         Err(DecodeError::ShortRead) => OptionalField::Absent,
1115                                         Err(e) => return Err(e)
1116                                 }
1117                         }
1118                 })
1119         }
1120 }
1121
1122 impl Writeable for ClosingSigned {
1123         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1124                 w.size_hint(32 + 8 + 64 + if self.fee_range.is_some() { 1+1+ 2*8 } else { 0 });
1125                 self.channel_id.write(w)?;
1126                 self.fee_satoshis.write(w)?;
1127                 self.signature.write(w)?;
1128                 encode_tlv_stream!(w, {
1129                         (1, self.fee_range, option),
1130                 });
1131                 Ok(())
1132         }
1133 }
1134
1135 impl Readable for ClosingSigned {
1136         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1137                 let channel_id = Readable::read(r)?;
1138                 let fee_satoshis = Readable::read(r)?;
1139                 let signature = Readable::read(r)?;
1140                 let mut fee_range = None;
1141                 decode_tlv_stream!(r, {
1142                         (1, fee_range, option),
1143                 });
1144                 Ok(Self { channel_id, fee_satoshis, signature, fee_range })
1145         }
1146 }
1147
1148 impl_writeable!(ClosingSignedFeeRange, 2*8, {
1149         min_fee_satoshis,
1150         max_fee_satoshis
1151 });
1152
1153 impl_writeable_len_match!(CommitmentSigned, {
1154                 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1155         }, {
1156         channel_id,
1157         signature,
1158         htlc_signatures
1159 });
1160
1161 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1162                 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1163         }, {
1164         hmac,
1165         failuremsg,
1166         pad
1167 });
1168
1169 impl_writeable!(FundingCreated, 32+32+2+64, {
1170         temporary_channel_id,
1171         funding_txid,
1172         funding_output_index,
1173         signature
1174 });
1175
1176 impl_writeable!(FundingSigned, 32+64, {
1177         channel_id,
1178         signature
1179 });
1180
1181 impl_writeable!(FundingLocked, 32+33, {
1182         channel_id,
1183         next_per_commitment_point
1184 });
1185
1186 impl Writeable for Init {
1187         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1188                 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1189                 // our relevant feature bits. This keeps us compatible with old nodes.
1190                 self.features.write_up_to_13(w)?;
1191                 self.features.write(w)
1192         }
1193 }
1194
1195 impl Readable for Init {
1196         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1197                 let global_features: InitFeatures = Readable::read(r)?;
1198                 let features: InitFeatures = Readable::read(r)?;
1199                 Ok(Init {
1200                         features: features.or(global_features),
1201                 })
1202         }
1203 }
1204
1205 impl_writeable_len_match!(OpenChannel, {
1206                 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1207                 { _, 319 }
1208         }, {
1209         chain_hash,
1210         temporary_channel_id,
1211         funding_satoshis,
1212         push_msat,
1213         dust_limit_satoshis,
1214         max_htlc_value_in_flight_msat,
1215         channel_reserve_satoshis,
1216         htlc_minimum_msat,
1217         feerate_per_kw,
1218         to_self_delay,
1219         max_accepted_htlcs,
1220         funding_pubkey,
1221         revocation_basepoint,
1222         payment_point,
1223         delayed_payment_basepoint,
1224         htlc_basepoint,
1225         first_per_commitment_point,
1226         channel_flags,
1227         shutdown_scriptpubkey
1228 });
1229
1230 impl_writeable!(RevokeAndACK, 32+32+33, {
1231         channel_id,
1232         per_commitment_secret,
1233         next_per_commitment_point
1234 });
1235
1236 impl_writeable_len_match!(Shutdown, {
1237                 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1238         }, {
1239         channel_id,
1240         scriptpubkey
1241 });
1242
1243 impl_writeable_len_match!(UpdateFailHTLC, {
1244                 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1245         }, {
1246         channel_id,
1247         htlc_id,
1248         reason
1249 });
1250
1251 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1252         channel_id,
1253         htlc_id,
1254         sha256_of_onion,
1255         failure_code
1256 });
1257
1258 impl_writeable!(UpdateFee, 32+4, {
1259         channel_id,
1260         feerate_per_kw
1261 });
1262
1263 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1264         channel_id,
1265         htlc_id,
1266         payment_preimage
1267 });
1268
1269 impl_writeable_len_match!(OnionErrorPacket, {
1270                 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1271         }, {
1272         data
1273 });
1274
1275 impl Writeable for OnionPacket {
1276         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1277                 w.size_hint(1 + 33 + 20*65 + 32);
1278                 self.version.write(w)?;
1279                 match self.public_key {
1280                         Ok(pubkey) => pubkey.write(w)?,
1281                         Err(_) => [0u8;33].write(w)?,
1282                 }
1283                 w.write_all(&self.hop_data)?;
1284                 self.hmac.write(w)?;
1285                 Ok(())
1286         }
1287 }
1288
1289 impl Readable for OnionPacket {
1290         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1291                 Ok(OnionPacket {
1292                         version: Readable::read(r)?,
1293                         public_key: {
1294                                 let mut buf = [0u8;33];
1295                                 r.read_exact(&mut buf)?;
1296                                 PublicKey::from_slice(&buf)
1297                         },
1298                         hop_data: Readable::read(r)?,
1299                         hmac: Readable::read(r)?,
1300                 })
1301         }
1302 }
1303
1304 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1305         channel_id,
1306         htlc_id,
1307         amount_msat,
1308         payment_hash,
1309         cltv_expiry,
1310         onion_routing_packet
1311 });
1312
1313 impl Writeable for FinalOnionHopData {
1314         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1315                 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1316                 self.payment_secret.0.write(w)?;
1317                 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1318         }
1319 }
1320
1321 impl Readable for FinalOnionHopData {
1322         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1323                 let secret: [u8; 32] = Readable::read(r)?;
1324                 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1325                 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1326         }
1327 }
1328
1329 impl Writeable for OnionHopData {
1330         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1331                 w.size_hint(33);
1332                 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1333                 // check values are sane long before we get here, though its possible in the future
1334                 // user-generated messages may hit this.
1335                 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1336                 match self.format {
1337                         OnionHopDataFormat::Legacy { short_channel_id } => {
1338                                 0u8.write(w)?;
1339                                 short_channel_id.write(w)?;
1340                                 self.amt_to_forward.write(w)?;
1341                                 self.outgoing_cltv_value.write(w)?;
1342                                 w.write_all(&[0;12])?;
1343                         },
1344                         OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1345                                 encode_varint_length_prefixed_tlv!(w, {
1346                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1347                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1348                                         (6, short_channel_id, required)
1349                                 });
1350                         },
1351                         OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
1352                                 if let Some(final_data) = payment_data {
1353                                         if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1354                                 }
1355                                 encode_varint_length_prefixed_tlv!(w, {
1356                                         (2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
1357                                         (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
1358                                         (8, payment_data, option),
1359                                         (5482373484, keysend_preimage, option)
1360                                 });
1361                         },
1362                 }
1363                 Ok(())
1364         }
1365 }
1366
1367 impl Readable for OnionHopData {
1368         fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1369                 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1370                 let v: VarInt = Decodable::consensus_decode(&mut r)
1371                         .map_err(|e| match e {
1372                                 Error::Io(ioe) => DecodeError::from(ioe),
1373                                 _ => DecodeError::InvalidValue
1374                         })?;
1375                 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1376                 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1377                         let mut rd = FixedLengthReader::new(r, v.0);
1378                         let mut amt = HighZeroBytesDroppedVarInt(0u64);
1379                         let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1380                         let mut short_id: Option<u64> = None;
1381                         let mut payment_data: Option<FinalOnionHopData> = None;
1382                         let mut keysend_preimage: Option<PaymentPreimage> = None;
1383                         // The TLV type is chosen to be compatible with lnd and c-lightning.
1384                         decode_tlv_stream!(&mut rd, {
1385                                 (2, amt, required),
1386                                 (4, cltv_value, required),
1387                                 (6, short_id, option),
1388                                 (8, payment_data, option),
1389                                 (5482373484, keysend_preimage, option)
1390                         });
1391                         rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1392                         let format = if let Some(short_channel_id) = short_id {
1393                                 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1394                                 OnionHopDataFormat::NonFinalNode {
1395                                         short_channel_id,
1396                                 }
1397                         } else {
1398                                 if let &Some(ref data) = &payment_data {
1399                                         if data.total_msat > MAX_VALUE_MSAT {
1400                                                 return Err(DecodeError::InvalidValue);
1401                                         }
1402                                 }
1403                                 OnionHopDataFormat::FinalNode {
1404                                         payment_data,
1405                                         keysend_preimage,
1406                                 }
1407                         };
1408                         (format, amt.0, cltv_value.0)
1409                 } else {
1410                         let format = OnionHopDataFormat::Legacy {
1411                                 short_channel_id: Readable::read(r)?,
1412                         };
1413                         let amt: u64 = Readable::read(r)?;
1414                         let cltv_value: u32 = Readable::read(r)?;
1415                         r.read_exact(&mut [0; 12])?;
1416                         (format, amt, cltv_value)
1417                 };
1418
1419                 if amt > MAX_VALUE_MSAT {
1420                         return Err(DecodeError::InvalidValue);
1421                 }
1422                 Ok(OnionHopData {
1423                         format,
1424                         amt_to_forward: amt,
1425                         outgoing_cltv_value: cltv_value,
1426                 })
1427         }
1428 }
1429
1430 impl Writeable for Ping {
1431         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1432                 w.size_hint(self.byteslen as usize + 4);
1433                 self.ponglen.write(w)?;
1434                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1435                 Ok(())
1436         }
1437 }
1438
1439 impl Readable for Ping {
1440         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1441                 Ok(Ping {
1442                         ponglen: Readable::read(r)?,
1443                         byteslen: {
1444                                 let byteslen = Readable::read(r)?;
1445                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1446                                 byteslen
1447                         }
1448                 })
1449         }
1450 }
1451
1452 impl Writeable for Pong {
1453         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1454                 w.size_hint(self.byteslen as usize + 2);
1455                 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1456                 Ok(())
1457         }
1458 }
1459
1460 impl Readable for Pong {
1461         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1462                 Ok(Pong {
1463                         byteslen: {
1464                                 let byteslen = Readable::read(r)?;
1465                                 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1466                                 byteslen
1467                         }
1468                 })
1469         }
1470 }
1471
1472 impl Writeable for UnsignedChannelAnnouncement {
1473         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1474                 w.size_hint(2 + 32 + 8 + 4*33 + self.features.byte_count() + self.excess_data.len());
1475                 self.features.write(w)?;
1476                 self.chain_hash.write(w)?;
1477                 self.short_channel_id.write(w)?;
1478                 self.node_id_1.write(w)?;
1479                 self.node_id_2.write(w)?;
1480                 self.bitcoin_key_1.write(w)?;
1481                 self.bitcoin_key_2.write(w)?;
1482                 w.write_all(&self.excess_data[..])?;
1483                 Ok(())
1484         }
1485 }
1486
1487 impl Readable for UnsignedChannelAnnouncement {
1488         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1489                 Ok(Self {
1490                         features: Readable::read(r)?,
1491                         chain_hash: Readable::read(r)?,
1492                         short_channel_id: Readable::read(r)?,
1493                         node_id_1: Readable::read(r)?,
1494                         node_id_2: Readable::read(r)?,
1495                         bitcoin_key_1: Readable::read(r)?,
1496                         bitcoin_key_2: Readable::read(r)?,
1497                         excess_data: read_to_end(r)?,
1498                 })
1499         }
1500 }
1501
1502 impl_writeable_len_match!(ChannelAnnouncement, {
1503                 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1504                         2 + 32 + 8 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1505         }, {
1506         node_signature_1,
1507         node_signature_2,
1508         bitcoin_signature_1,
1509         bitcoin_signature_2,
1510         contents
1511 });
1512
1513 impl Writeable for UnsignedChannelUpdate {
1514         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1515                 let mut size = 64 + self.excess_data.len();
1516                 let mut message_flags: u8 = 0;
1517                 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1518                         size += 8;
1519                         message_flags = 1;
1520                 }
1521                 w.size_hint(size);
1522                 self.chain_hash.write(w)?;
1523                 self.short_channel_id.write(w)?;
1524                 self.timestamp.write(w)?;
1525                 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1526                 all_flags.write(w)?;
1527                 self.cltv_expiry_delta.write(w)?;
1528                 self.htlc_minimum_msat.write(w)?;
1529                 self.fee_base_msat.write(w)?;
1530                 self.fee_proportional_millionths.write(w)?;
1531                 self.htlc_maximum_msat.write(w)?;
1532                 w.write_all(&self.excess_data[..])?;
1533                 Ok(())
1534         }
1535 }
1536
1537 impl Readable for UnsignedChannelUpdate {
1538         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1539                 let has_htlc_maximum_msat;
1540                 Ok(Self {
1541                         chain_hash: Readable::read(r)?,
1542                         short_channel_id: Readable::read(r)?,
1543                         timestamp: Readable::read(r)?,
1544                         flags: {
1545                                 let flags: u16 = Readable::read(r)?;
1546                                 let message_flags = flags >> 8;
1547                                 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1548                                 flags as u8
1549                         },
1550                         cltv_expiry_delta: Readable::read(r)?,
1551                         htlc_minimum_msat: Readable::read(r)?,
1552                         fee_base_msat: Readable::read(r)?,
1553                         fee_proportional_millionths: Readable::read(r)?,
1554                         htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1555                         excess_data: read_to_end(r)?,
1556                 })
1557         }
1558 }
1559
1560 impl_writeable_len_match!(ChannelUpdate, {
1561                 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ref htlc_maximum_msat, ..}, .. },
1562                         64 + 64 + excess_data.len() + if let OptionalField::Present(_) = htlc_maximum_msat { 8 } else { 0 } }
1563         }, {
1564         signature,
1565         contents
1566 });
1567
1568 impl Writeable for ErrorMessage {
1569         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1570                 w.size_hint(32 + 2 + self.data.len());
1571                 self.channel_id.write(w)?;
1572                 (self.data.len() as u16).write(w)?;
1573                 w.write_all(self.data.as_bytes())?;
1574                 Ok(())
1575         }
1576 }
1577
1578 impl Readable for ErrorMessage {
1579         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1580                 Ok(Self {
1581                         channel_id: Readable::read(r)?,
1582                         data: {
1583                                 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1584                                 let data = read_to_end(r)?;
1585                                 sz = cmp::min(data.len(), sz);
1586                                 match String::from_utf8(data[..sz as usize].to_vec()) {
1587                                         Ok(s) => s,
1588                                         Err(_) => return Err(DecodeError::InvalidValue),
1589                                 }
1590                         }
1591                 })
1592         }
1593 }
1594
1595 impl Writeable for UnsignedNodeAnnouncement {
1596         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1597                 w.size_hint(76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1598                 self.features.write(w)?;
1599                 self.timestamp.write(w)?;
1600                 self.node_id.write(w)?;
1601                 w.write_all(&self.rgb)?;
1602                 self.alias.write(w)?;
1603
1604                 let mut addr_len = 0;
1605                 for addr in self.addresses.iter() {
1606                         addr_len += 1 + addr.len();
1607                 }
1608                 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1609                 for addr in self.addresses.iter() {
1610                         addr.write(w)?;
1611                 }
1612                 w.write_all(&self.excess_address_data[..])?;
1613                 w.write_all(&self.excess_data[..])?;
1614                 Ok(())
1615         }
1616 }
1617
1618 impl Readable for UnsignedNodeAnnouncement {
1619         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1620                 let features: NodeFeatures = Readable::read(r)?;
1621                 let timestamp: u32 = Readable::read(r)?;
1622                 let node_id: PublicKey = Readable::read(r)?;
1623                 let mut rgb = [0; 3];
1624                 r.read_exact(&mut rgb)?;
1625                 let alias: [u8; 32] = Readable::read(r)?;
1626
1627                 let addr_len: u16 = Readable::read(r)?;
1628                 let mut addresses: Vec<NetAddress> = Vec::new();
1629                 let mut addr_readpos = 0;
1630                 let mut excess = false;
1631                 let mut excess_byte = 0;
1632                 loop {
1633                         if addr_len <= addr_readpos { break; }
1634                         match Readable::read(r) {
1635                                 Ok(Ok(addr)) => {
1636                                         if addr_len < addr_readpos + 1 + addr.len() {
1637                                                 return Err(DecodeError::BadLengthDescriptor);
1638                                         }
1639                                         addr_readpos += (1 + addr.len()) as u16;
1640                                         addresses.push(addr);
1641                                 },
1642                                 Ok(Err(unknown_descriptor)) => {
1643                                         excess = true;
1644                                         excess_byte = unknown_descriptor;
1645                                         break;
1646                                 },
1647                                 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1648                                 Err(e) => return Err(e),
1649                         }
1650                 }
1651
1652                 let mut excess_data = vec![];
1653                 let excess_address_data = if addr_readpos < addr_len {
1654                         let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1655                         r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1656                         if excess {
1657                                 excess_address_data[0] = excess_byte;
1658                         }
1659                         excess_address_data
1660                 } else {
1661                         if excess {
1662                                 excess_data.push(excess_byte);
1663                         }
1664                         Vec::new()
1665                 };
1666                 excess_data.extend(read_to_end(r)?.iter());
1667                 Ok(UnsignedNodeAnnouncement {
1668                         features,
1669                         timestamp,
1670                         node_id,
1671                         rgb,
1672                         alias,
1673                         addresses,
1674                         excess_address_data,
1675                         excess_data,
1676                 })
1677         }
1678 }
1679
1680 impl_writeable_len_match!(NodeAnnouncement, <=, {
1681                 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1682                         64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1683         }, {
1684         signature,
1685         contents
1686 });
1687
1688 impl Readable for QueryShortChannelIds {
1689         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1690                 let chain_hash: BlockHash = Readable::read(r)?;
1691
1692                 let encoding_len: u16 = Readable::read(r)?;
1693                 let encoding_type: u8 = Readable::read(r)?;
1694
1695                 // Must be encoding_type=0 uncompressed serialization. We do not
1696                 // support encoding_type=1 zlib serialization.
1697                 if encoding_type != EncodingType::Uncompressed as u8 {
1698                         return Err(DecodeError::UnsupportedCompression);
1699                 }
1700
1701                 // We expect the encoding_len to always includes the 1-byte
1702                 // encoding_type and that short_channel_ids are 8-bytes each
1703                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1704                         return Err(DecodeError::InvalidValue);
1705                 }
1706
1707                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1708                 // less the 1-byte encoding_type
1709                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1710                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1711                 for _ in 0..short_channel_id_count {
1712                         short_channel_ids.push(Readable::read(r)?);
1713                 }
1714
1715                 Ok(QueryShortChannelIds {
1716                         chain_hash,
1717                         short_channel_ids,
1718                 })
1719         }
1720 }
1721
1722 impl Writeable for QueryShortChannelIds {
1723         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1724                 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1725                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1726
1727                 w.size_hint(32 + 2 + encoding_len as usize);
1728                 self.chain_hash.write(w)?;
1729                 encoding_len.write(w)?;
1730
1731                 // We only support type=0 uncompressed serialization
1732                 (EncodingType::Uncompressed as u8).write(w)?;
1733
1734                 for scid in self.short_channel_ids.iter() {
1735                         scid.write(w)?;
1736                 }
1737
1738                 Ok(())
1739         }
1740 }
1741
1742 impl Readable for ReplyShortChannelIdsEnd {
1743         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1744                 let chain_hash: BlockHash = Readable::read(r)?;
1745                 let full_information: bool = Readable::read(r)?;
1746                 Ok(ReplyShortChannelIdsEnd {
1747                         chain_hash,
1748                         full_information,
1749                 })
1750         }
1751 }
1752
1753 impl Writeable for ReplyShortChannelIdsEnd {
1754         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1755                 w.size_hint(32 + 1);
1756                 self.chain_hash.write(w)?;
1757                 self.full_information.write(w)?;
1758                 Ok(())
1759         }
1760 }
1761
1762 impl QueryChannelRange {
1763         /**
1764          * Calculates the overflow safe ending block height for the query.
1765          * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`
1766          */
1767         pub fn end_blocknum(&self) -> u32 {
1768                 match self.first_blocknum.checked_add(self.number_of_blocks) {
1769                         Some(block) => block,
1770                         None => u32::max_value(),
1771                 }
1772         }
1773 }
1774
1775 impl Readable for QueryChannelRange {
1776         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1777                 let chain_hash: BlockHash = Readable::read(r)?;
1778                 let first_blocknum: u32 = Readable::read(r)?;
1779                 let number_of_blocks: u32 = Readable::read(r)?;
1780                 Ok(QueryChannelRange {
1781                         chain_hash,
1782                         first_blocknum,
1783                         number_of_blocks
1784                 })
1785         }
1786 }
1787
1788 impl Writeable for QueryChannelRange {
1789         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1790                 w.size_hint(32 + 4 + 4);
1791                 self.chain_hash.write(w)?;
1792                 self.first_blocknum.write(w)?;
1793                 self.number_of_blocks.write(w)?;
1794                 Ok(())
1795         }
1796 }
1797
1798 impl Readable for ReplyChannelRange {
1799         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1800                 let chain_hash: BlockHash = Readable::read(r)?;
1801                 let first_blocknum: u32 = Readable::read(r)?;
1802                 let number_of_blocks: u32 = Readable::read(r)?;
1803                 let sync_complete: bool = Readable::read(r)?;
1804
1805                 let encoding_len: u16 = Readable::read(r)?;
1806                 let encoding_type: u8 = Readable::read(r)?;
1807
1808                 // Must be encoding_type=0 uncompressed serialization. We do not
1809                 // support encoding_type=1 zlib serialization.
1810                 if encoding_type != EncodingType::Uncompressed as u8 {
1811                         return Err(DecodeError::UnsupportedCompression);
1812                 }
1813
1814                 // We expect the encoding_len to always includes the 1-byte
1815                 // encoding_type and that short_channel_ids are 8-bytes each
1816                 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1817                         return Err(DecodeError::InvalidValue);
1818                 }
1819
1820                 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1821                 // less the 1-byte encoding_type
1822                 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1823                 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1824                 for _ in 0..short_channel_id_count {
1825                         short_channel_ids.push(Readable::read(r)?);
1826                 }
1827
1828                 Ok(ReplyChannelRange {
1829                         chain_hash,
1830                         first_blocknum,
1831                         number_of_blocks,
1832                         sync_complete,
1833                         short_channel_ids
1834                 })
1835         }
1836 }
1837
1838 impl Writeable for ReplyChannelRange {
1839         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1840                 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1841                 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1842                 self.chain_hash.write(w)?;
1843                 self.first_blocknum.write(w)?;
1844                 self.number_of_blocks.write(w)?;
1845                 self.sync_complete.write(w)?;
1846
1847                 encoding_len.write(w)?;
1848                 (EncodingType::Uncompressed as u8).write(w)?;
1849                 for scid in self.short_channel_ids.iter() {
1850                         scid.write(w)?;
1851                 }
1852
1853                 Ok(())
1854         }
1855 }
1856
1857 impl Readable for GossipTimestampFilter {
1858         fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1859                 let chain_hash: BlockHash = Readable::read(r)?;
1860                 let first_timestamp: u32 = Readable::read(r)?;
1861                 let timestamp_range: u32 = Readable::read(r)?;
1862                 Ok(GossipTimestampFilter {
1863                         chain_hash,
1864                         first_timestamp,
1865                         timestamp_range,
1866                 })
1867         }
1868 }
1869
1870 impl Writeable for GossipTimestampFilter {
1871         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
1872                 w.size_hint(32 + 4 + 4);
1873                 self.chain_hash.write(w)?;
1874                 self.first_timestamp.write(w)?;
1875                 self.timestamp_range.write(w)?;
1876                 Ok(())
1877         }
1878 }
1879
1880
1881 #[cfg(test)]
1882 mod tests {
1883         use hex;
1884         use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
1885         use ln::msgs;
1886         use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1887         use util::ser::{Writeable, Readable};
1888
1889         use bitcoin::hashes::hex::FromHex;
1890         use bitcoin::util::address::Address;
1891         use bitcoin::network::constants::Network;
1892         use bitcoin::blockdata::script::Builder;
1893         use bitcoin::blockdata::opcodes;
1894         use bitcoin::hash_types::{Txid, BlockHash};
1895
1896         use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1897         use bitcoin::secp256k1::{Secp256k1, Message};
1898
1899         use io::Cursor;
1900         use prelude::*;
1901
1902         #[test]
1903         fn encoding_channel_reestablish_no_secret() {
1904                 let cr = msgs::ChannelReestablish {
1905                         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],
1906                         next_local_commitment_number: 3,
1907                         next_remote_commitment_number: 4,
1908                         data_loss_protect: OptionalField::Absent,
1909                 };
1910
1911                 let encoded_value = cr.encode();
1912                 assert_eq!(
1913                         encoded_value,
1914                         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]
1915                 );
1916         }
1917
1918         #[test]
1919         fn encoding_channel_reestablish_with_secret() {
1920                 let public_key = {
1921                         let secp_ctx = Secp256k1::new();
1922                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1923                 };
1924
1925                 let cr = msgs::ChannelReestablish {
1926                         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],
1927                         next_local_commitment_number: 3,
1928                         next_remote_commitment_number: 4,
1929                         data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1930                 };
1931
1932                 let encoded_value = cr.encode();
1933                 assert_eq!(
1934                         encoded_value,
1935                         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]
1936                 );
1937         }
1938
1939         macro_rules! get_keys_from {
1940                 ($slice: expr, $secp_ctx: expr) => {
1941                         {
1942                                 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1943                                 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1944                                 (privkey, pubkey)
1945                         }
1946                 }
1947         }
1948
1949         macro_rules! get_sig_on {
1950                 ($privkey: expr, $ctx: expr, $string: expr) => {
1951                         {
1952                                 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1953                                 $ctx.sign(&sighash, &$privkey)
1954                         }
1955                 }
1956         }
1957
1958         #[test]
1959         fn encoding_announcement_signatures() {
1960                 let secp_ctx = Secp256k1::new();
1961                 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1962                 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1963                 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1964                 let announcement_signatures = msgs::AnnouncementSignatures {
1965                         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],
1966                         short_channel_id: 2316138423780173,
1967                         node_signature: sig_1,
1968                         bitcoin_signature: sig_2,
1969                 };
1970
1971                 let encoded_value = announcement_signatures.encode();
1972                 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1973         }
1974
1975         fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1976                 let secp_ctx = Secp256k1::new();
1977                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1978                 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1979                 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1980                 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1981                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1982                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1983                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1984                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1985                 let mut features = ChannelFeatures::known();
1986                 if unknown_features_bits {
1987                         features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1988                 }
1989                 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1990                         features,
1991                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1992                         short_channel_id: 2316138423780173,
1993                         node_id_1: pubkey_1,
1994                         node_id_2: pubkey_2,
1995                         bitcoin_key_1: pubkey_3,
1996                         bitcoin_key_2: pubkey_4,
1997                         excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1998                 };
1999                 let channel_announcement = msgs::ChannelAnnouncement {
2000                         node_signature_1: sig_1,
2001                         node_signature_2: sig_2,
2002                         bitcoin_signature_1: sig_3,
2003                         bitcoin_signature_2: sig_4,
2004                         contents: unsigned_channel_announcement,
2005                 };
2006                 let encoded_value = channel_announcement.encode();
2007                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
2008                 if unknown_features_bits {
2009                         target_value.append(&mut hex::decode("0002ffff").unwrap());
2010                 } else {
2011                         target_value.append(&mut hex::decode("0000").unwrap());
2012                 }
2013                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2014                 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
2015                 if excess_data {
2016                         target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
2017                 }
2018                 assert_eq!(encoded_value, target_value);
2019         }
2020
2021         #[test]
2022         fn encoding_channel_announcement() {
2023                 do_encoding_channel_announcement(true, false);
2024                 do_encoding_channel_announcement(false, true);
2025                 do_encoding_channel_announcement(false, false);
2026                 do_encoding_channel_announcement(true, true);
2027         }
2028
2029         fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
2030                 let secp_ctx = Secp256k1::new();
2031                 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2032                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2033                 let features = if unknown_features_bits {
2034                         NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
2035                 } else {
2036                         // Set to some features we may support
2037                         NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
2038                 };
2039                 let mut addresses = Vec::new();
2040                 if ipv4 {
2041                         addresses.push(msgs::NetAddress::IPv4 {
2042                                 addr: [255, 254, 253, 252],
2043                                 port: 9735
2044                         });
2045                 }
2046                 if ipv6 {
2047                         addresses.push(msgs::NetAddress::IPv6 {
2048                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
2049                                 port: 9735
2050                         });
2051                 }
2052                 if onionv2 {
2053                         addresses.push(msgs::NetAddress::OnionV2 {
2054                                 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
2055                                 port: 9735
2056                         });
2057                 }
2058                 if onionv3 {
2059                         addresses.push(msgs::NetAddress::OnionV3 {
2060                                 ed25519_pubkey: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240, 239, 238, 237, 236, 235, 234, 233, 232, 231, 230, 229, 228, 227, 226, 225, 224],
2061                                 checksum: 32,
2062                                 version: 16,
2063                                 port: 9735
2064                         });
2065                 }
2066                 let mut addr_len = 0;
2067                 for addr in &addresses {
2068                         addr_len += addr.len() + 1;
2069                 }
2070                 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
2071                         features,
2072                         timestamp: 20190119,
2073                         node_id: pubkey_1,
2074                         rgb: [32; 3],
2075                         alias: [16;32],
2076                         addresses,
2077                         excess_address_data: if excess_address_data { vec![33, 108, 40, 11, 83, 149, 162, 84, 110, 126, 75, 38, 99, 224, 79, 129, 22, 34, 241, 90, 79, 146, 232, 58, 162, 233, 43, 162, 165, 115, 193, 57, 20, 44, 84, 174, 99, 7, 42, 30, 193, 238, 125, 192, 192, 75, 222, 92, 132, 120, 6, 23, 42, 160, 92, 146, 194, 42, 232, 227, 8, 209, 210, 105] } else { Vec::new() },
2078                         excess_data: if excess_data { vec![59, 18, 204, 25, 92, 224, 162, 209, 189, 166, 168, 139, 239, 161, 159, 160, 127, 81, 202, 167, 92, 232, 56, 55, 242, 137, 101, 96, 11, 138, 172, 171, 8, 85, 255, 176, 231, 65, 236, 95, 124, 65, 66, 30, 152, 41, 169, 212, 134, 17, 200, 200, 49, 247, 27, 229, 234, 115, 230, 101, 148, 151, 127, 253] } else { Vec::new() },
2079                 };
2080                 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2081                 let node_announcement = msgs::NodeAnnouncement {
2082                         signature: sig_1,
2083                         contents: unsigned_node_announcement,
2084                 };
2085                 let encoded_value = node_announcement.encode();
2086                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2087                 if unknown_features_bits {
2088                         target_value.append(&mut hex::decode("0002ffff").unwrap());
2089                 } else {
2090                         target_value.append(&mut hex::decode("000122").unwrap());
2091                 }
2092                 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2093                 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2094                 if ipv4 {
2095                         target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2096                 }
2097                 if ipv6 {
2098                         target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2099                 }
2100                 if onionv2 {
2101                         target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2102                 }
2103                 if onionv3 {
2104                         target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2105                 }
2106                 if excess_address_data {
2107                         target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2108                 }
2109                 if excess_data {
2110                         target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2111                 }
2112                 assert_eq!(encoded_value, target_value);
2113         }
2114
2115         #[test]
2116         fn encoding_node_announcement() {
2117                 do_encoding_node_announcement(true, true, true, true, true, true, true);
2118                 do_encoding_node_announcement(false, false, false, false, false, false, false);
2119                 do_encoding_node_announcement(false, true, false, false, false, false, false);
2120                 do_encoding_node_announcement(false, false, true, false, false, false, false);
2121                 do_encoding_node_announcement(false, false, false, true, false, false, false);
2122                 do_encoding_node_announcement(false, false, false, false, true, false, false);
2123                 do_encoding_node_announcement(false, false, false, false, false, true, false);
2124                 do_encoding_node_announcement(false, true, false, true, false, true, false);
2125                 do_encoding_node_announcement(false, false, true, false, true, false, false);
2126         }
2127
2128         fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2129                 let secp_ctx = Secp256k1::new();
2130                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2131                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2132                 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2133                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2134                         short_channel_id: 2316138423780173,
2135                         timestamp: 20190119,
2136                         flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2137                         cltv_expiry_delta: 144,
2138                         htlc_minimum_msat: 1000000,
2139                         htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2140                         fee_base_msat: 10000,
2141                         fee_proportional_millionths: 20,
2142                         excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2143                 };
2144                 let channel_update = msgs::ChannelUpdate {
2145                         signature: sig_1,
2146                         contents: unsigned_channel_update
2147                 };
2148                 let encoded_value = channel_update.encode();
2149                 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2150                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2151                 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2152                 if htlc_maximum_msat {
2153                         target_value.append(&mut hex::decode("01").unwrap());
2154                 } else {
2155                         target_value.append(&mut hex::decode("00").unwrap());
2156                 }
2157                 target_value.append(&mut hex::decode("00").unwrap());
2158                 if direction {
2159                         let flag = target_value.last_mut().unwrap();
2160                         *flag = 1;
2161                 }
2162                 if disable {
2163                         let flag = target_value.last_mut().unwrap();
2164                         *flag = *flag | 1 << 1;
2165                 }
2166                 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2167                 if htlc_maximum_msat {
2168                         target_value.append(&mut hex::decode("0000777788889999").unwrap());
2169                 }
2170                 if excess_data {
2171                         target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2172                 }
2173                 assert_eq!(encoded_value, target_value);
2174         }
2175
2176         #[test]
2177         fn encoding_channel_update() {
2178                 do_encoding_channel_update(false, false, false, false);
2179                 do_encoding_channel_update(false, false, false, true);
2180                 do_encoding_channel_update(true, false, false, false);
2181                 do_encoding_channel_update(true, false, false, true);
2182                 do_encoding_channel_update(false, true, false, false);
2183                 do_encoding_channel_update(false, true, false, true);
2184                 do_encoding_channel_update(false, false, true, false);
2185                 do_encoding_channel_update(false, false, true, true);
2186                 do_encoding_channel_update(true, true, true, false);
2187                 do_encoding_channel_update(true, true, true, true);
2188         }
2189
2190         fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2191                 let secp_ctx = Secp256k1::new();
2192                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2193                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2194                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2195                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2196                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2197                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2198                 let open_channel = msgs::OpenChannel {
2199                         chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2200                         temporary_channel_id: [2; 32],
2201                         funding_satoshis: 1311768467284833366,
2202                         push_msat: 2536655962884945560,
2203                         dust_limit_satoshis: 3608586615801332854,
2204                         max_htlc_value_in_flight_msat: 8517154655701053848,
2205                         channel_reserve_satoshis: 8665828695742877976,
2206                         htlc_minimum_msat: 2316138423780173,
2207                         feerate_per_kw: 821716,
2208                         to_self_delay: 49340,
2209                         max_accepted_htlcs: 49340,
2210                         funding_pubkey: pubkey_1,
2211                         revocation_basepoint: pubkey_2,
2212                         payment_point: pubkey_3,
2213                         delayed_payment_basepoint: pubkey_4,
2214                         htlc_basepoint: pubkey_5,
2215                         first_per_commitment_point: pubkey_6,
2216                         channel_flags: if random_bit { 1 << 5 } else { 0 },
2217                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2218                 };
2219                 let encoded_value = open_channel.encode();
2220                 let mut target_value = Vec::new();
2221                 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2222                 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2223                 if random_bit {
2224                         target_value.append(&mut hex::decode("20").unwrap());
2225                 } else {
2226                         target_value.append(&mut hex::decode("00").unwrap());
2227                 }
2228                 if shutdown {
2229                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2230                 }
2231                 assert_eq!(encoded_value, target_value);
2232         }
2233
2234         #[test]
2235         fn encoding_open_channel() {
2236                 do_encoding_open_channel(false, false);
2237                 do_encoding_open_channel(true, false);
2238                 do_encoding_open_channel(false, true);
2239                 do_encoding_open_channel(true, true);
2240         }
2241
2242         fn do_encoding_accept_channel(shutdown: bool) {
2243                 let secp_ctx = Secp256k1::new();
2244                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2245                 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2246                 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2247                 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2248                 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2249                 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2250                 let accept_channel = msgs::AcceptChannel {
2251                         temporary_channel_id: [2; 32],
2252                         dust_limit_satoshis: 1311768467284833366,
2253                         max_htlc_value_in_flight_msat: 2536655962884945560,
2254                         channel_reserve_satoshis: 3608586615801332854,
2255                         htlc_minimum_msat: 2316138423780173,
2256                         minimum_depth: 821716,
2257                         to_self_delay: 49340,
2258                         max_accepted_htlcs: 49340,
2259                         funding_pubkey: pubkey_1,
2260                         revocation_basepoint: pubkey_2,
2261                         payment_point: pubkey_3,
2262                         delayed_payment_basepoint: pubkey_4,
2263                         htlc_basepoint: pubkey_5,
2264                         first_per_commitment_point: pubkey_6,
2265                         shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2266                 };
2267                 let encoded_value = accept_channel.encode();
2268                 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2269                 if shutdown {
2270                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2271                 }
2272                 assert_eq!(encoded_value, target_value);
2273         }
2274
2275         #[test]
2276         fn encoding_accept_channel() {
2277                 do_encoding_accept_channel(false);
2278                 do_encoding_accept_channel(true);
2279         }
2280
2281         #[test]
2282         fn encoding_funding_created() {
2283                 let secp_ctx = Secp256k1::new();
2284                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2285                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2286                 let funding_created = msgs::FundingCreated {
2287                         temporary_channel_id: [2; 32],
2288                         funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2289                         funding_output_index: 255,
2290                         signature: sig_1,
2291                 };
2292                 let encoded_value = funding_created.encode();
2293                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2294                 assert_eq!(encoded_value, target_value);
2295         }
2296
2297         #[test]
2298         fn encoding_funding_signed() {
2299                 let secp_ctx = Secp256k1::new();
2300                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2301                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2302                 let funding_signed = msgs::FundingSigned {
2303                         channel_id: [2; 32],
2304                         signature: sig_1,
2305                 };
2306                 let encoded_value = funding_signed.encode();
2307                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2308                 assert_eq!(encoded_value, target_value);
2309         }
2310
2311         #[test]
2312         fn encoding_funding_locked() {
2313                 let secp_ctx = Secp256k1::new();
2314                 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2315                 let funding_locked = msgs::FundingLocked {
2316                         channel_id: [2; 32],
2317                         next_per_commitment_point: pubkey_1,
2318                 };
2319                 let encoded_value = funding_locked.encode();
2320                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2321                 assert_eq!(encoded_value, target_value);
2322         }
2323
2324         fn do_encoding_shutdown(script_type: u8) {
2325                 let secp_ctx = Secp256k1::new();
2326                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2327                 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2328                 let shutdown = msgs::Shutdown {
2329                         channel_id: [2; 32],
2330                         scriptpubkey:
2331                                      if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2332                                 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2333                                 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2334                                 else                     { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2335                 };
2336                 let encoded_value = shutdown.encode();
2337                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2338                 if script_type == 1 {
2339                         target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2340                 } else if script_type == 2 {
2341                         target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2342                 } else if script_type == 3 {
2343                         target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2344                 } else if script_type == 4 {
2345                         target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2346                 }
2347                 assert_eq!(encoded_value, target_value);
2348         }
2349
2350         #[test]
2351         fn encoding_shutdown() {
2352                 do_encoding_shutdown(1);
2353                 do_encoding_shutdown(2);
2354                 do_encoding_shutdown(3);
2355                 do_encoding_shutdown(4);
2356         }
2357
2358         #[test]
2359         fn encoding_closing_signed() {
2360                 let secp_ctx = Secp256k1::new();
2361                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2362                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2363                 let closing_signed = msgs::ClosingSigned {
2364                         channel_id: [2; 32],
2365                         fee_satoshis: 2316138423780173,
2366                         signature: sig_1,
2367                         fee_range: None,
2368                 };
2369                 let encoded_value = closing_signed.encode();
2370                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2371                 assert_eq!(encoded_value, target_value);
2372                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value)).unwrap(), closing_signed);
2373
2374                 let closing_signed_with_range = msgs::ClosingSigned {
2375                         channel_id: [2; 32],
2376                         fee_satoshis: 2316138423780173,
2377                         signature: sig_1,
2378                         fee_range: Some(msgs::ClosingSignedFeeRange {
2379                                 min_fee_satoshis: 0xdeadbeef,
2380                                 max_fee_satoshis: 0x1badcafe01234567,
2381                         }),
2382                 };
2383                 let encoded_value_with_range = closing_signed_with_range.encode();
2384                 let target_value_with_range = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a011000000000deadbeef1badcafe01234567").unwrap();
2385                 assert_eq!(encoded_value_with_range, target_value_with_range);
2386                 assert_eq!(msgs::ClosingSigned::read(&mut Cursor::new(&target_value_with_range)).unwrap(),
2387                         closing_signed_with_range);
2388         }
2389
2390         #[test]
2391         fn encoding_update_add_htlc() {
2392                 let secp_ctx = Secp256k1::new();
2393                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2394                 let onion_routing_packet = msgs::OnionPacket {
2395                         version: 255,
2396                         public_key: Ok(pubkey_1),
2397                         hop_data: [1; 20*65],
2398                         hmac: [2; 32]
2399                 };
2400                 let update_add_htlc = msgs::UpdateAddHTLC {
2401                         channel_id: [2; 32],
2402                         htlc_id: 2316138423780173,
2403                         amount_msat: 3608586615801332854,
2404                         payment_hash: PaymentHash([1; 32]),
2405                         cltv_expiry: 821716,
2406                         onion_routing_packet
2407                 };
2408                 let encoded_value = update_add_htlc.encode();
2409                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2410                 assert_eq!(encoded_value, target_value);
2411         }
2412
2413         #[test]
2414         fn encoding_update_fulfill_htlc() {
2415                 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2416                         channel_id: [2; 32],
2417                         htlc_id: 2316138423780173,
2418                         payment_preimage: PaymentPreimage([1; 32]),
2419                 };
2420                 let encoded_value = update_fulfill_htlc.encode();
2421                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2422                 assert_eq!(encoded_value, target_value);
2423         }
2424
2425         #[test]
2426         fn encoding_update_fail_htlc() {
2427                 let reason = OnionErrorPacket {
2428                         data: [1; 32].to_vec(),
2429                 };
2430                 let update_fail_htlc = msgs::UpdateFailHTLC {
2431                         channel_id: [2; 32],
2432                         htlc_id: 2316138423780173,
2433                         reason
2434                 };
2435                 let encoded_value = update_fail_htlc.encode();
2436                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2437                 assert_eq!(encoded_value, target_value);
2438         }
2439
2440         #[test]
2441         fn encoding_update_fail_malformed_htlc() {
2442                 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2443                         channel_id: [2; 32],
2444                         htlc_id: 2316138423780173,
2445                         sha256_of_onion: [1; 32],
2446                         failure_code: 255
2447                 };
2448                 let encoded_value = update_fail_malformed_htlc.encode();
2449                 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2450                 assert_eq!(encoded_value, target_value);
2451         }
2452
2453         fn do_encoding_commitment_signed(htlcs: bool) {
2454                 let secp_ctx = Secp256k1::new();
2455                 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2456                 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2457                 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2458                 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2459                 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2460                 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2461                 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2462                 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2463                 let commitment_signed = msgs::CommitmentSigned {
2464                         channel_id: [2; 32],
2465                         signature: sig_1,
2466                         htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2467                 };
2468                 let encoded_value = commitment_signed.encode();
2469                 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2470                 if htlcs {
2471                         target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2472                 } else {
2473                         target_value.append(&mut hex::decode("0000").unwrap());
2474                 }
2475                 assert_eq!(encoded_value, target_value);
2476         }
2477
2478         #[test]
2479         fn encoding_commitment_signed() {
2480                 do_encoding_commitment_signed(true);
2481                 do_encoding_commitment_signed(false);
2482         }
2483
2484         #[test]
2485         fn encoding_revoke_and_ack() {
2486                 let secp_ctx = Secp256k1::new();
2487                 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2488                 let raa = msgs::RevokeAndACK {
2489                         channel_id: [2; 32],
2490                         per_commitment_secret: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
2491                         next_per_commitment_point: pubkey_1,
2492                 };
2493                 let encoded_value = raa.encode();
2494                 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2495                 assert_eq!(encoded_value, target_value);
2496         }
2497
2498         #[test]
2499         fn encoding_update_fee() {
2500                 let update_fee = msgs::UpdateFee {
2501                         channel_id: [2; 32],
2502                         feerate_per_kw: 20190119,
2503                 };
2504                 let encoded_value = update_fee.encode();
2505                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2506                 assert_eq!(encoded_value, target_value);
2507         }
2508
2509         #[test]
2510         fn encoding_init() {
2511                 assert_eq!(msgs::Init {
2512                         features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2513                 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2514                 assert_eq!(msgs::Init {
2515                         features: InitFeatures::from_le_bytes(vec![0xFF]),
2516                 }.encode(), hex::decode("0001ff0001ff").unwrap());
2517                 assert_eq!(msgs::Init {
2518                         features: InitFeatures::from_le_bytes(vec![]),
2519                 }.encode(), hex::decode("00000000").unwrap());
2520         }
2521
2522         #[test]
2523         fn encoding_error() {
2524                 let error = msgs::ErrorMessage {
2525                         channel_id: [2; 32],
2526                         data: String::from("rust-lightning"),
2527                 };
2528                 let encoded_value = error.encode();
2529                 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2530                 assert_eq!(encoded_value, target_value);
2531         }
2532
2533         #[test]
2534         fn encoding_ping() {
2535                 let ping = msgs::Ping {
2536                         ponglen: 64,
2537                         byteslen: 64
2538                 };
2539                 let encoded_value = ping.encode();
2540                 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2541                 assert_eq!(encoded_value, target_value);
2542         }
2543
2544         #[test]
2545         fn encoding_pong() {
2546                 let pong = msgs::Pong {
2547                         byteslen: 64
2548                 };
2549                 let encoded_value = pong.encode();
2550                 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2551                 assert_eq!(encoded_value, target_value);
2552         }
2553
2554         #[test]
2555         fn encoding_legacy_onion_hop_data() {
2556                 let msg = msgs::OnionHopData {
2557                         format: OnionHopDataFormat::Legacy {
2558                                 short_channel_id: 0xdeadbeef1bad1dea,
2559                         },
2560                         amt_to_forward: 0x0badf00d01020304,
2561                         outgoing_cltv_value: 0xffffffff,
2562                 };
2563                 let encoded_value = msg.encode();
2564                 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2565                 assert_eq!(encoded_value, target_value);
2566         }
2567
2568         #[test]
2569         fn encoding_nonfinal_onion_hop_data() {
2570                 let mut msg = msgs::OnionHopData {
2571                         format: OnionHopDataFormat::NonFinalNode {
2572                                 short_channel_id: 0xdeadbeef1bad1dea,
2573                         },
2574                         amt_to_forward: 0x0badf00d01020304,
2575                         outgoing_cltv_value: 0xffffffff,
2576                 };
2577                 let encoded_value = msg.encode();
2578                 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2579                 assert_eq!(encoded_value, target_value);
2580                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2581                 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2582                         assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2583                 } else { panic!(); }
2584                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2585                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2586         }
2587
2588         #[test]
2589         fn encoding_final_onion_hop_data() {
2590                 let mut msg = msgs::OnionHopData {
2591                         format: OnionHopDataFormat::FinalNode {
2592                                 payment_data: None,
2593                                 keysend_preimage: None,
2594                         },
2595                         amt_to_forward: 0x0badf00d01020304,
2596                         outgoing_cltv_value: 0xffffffff,
2597                 };
2598                 let encoded_value = msg.encode();
2599                 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2600                 assert_eq!(encoded_value, target_value);
2601                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2602                 if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
2603                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2604                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2605         }
2606
2607         #[test]
2608         fn encoding_final_onion_hop_data_with_secret() {
2609                 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2610                 let mut msg = msgs::OnionHopData {
2611                         format: OnionHopDataFormat::FinalNode {
2612                                 payment_data: Some(FinalOnionHopData {
2613                                         payment_secret: expected_payment_secret,
2614                                         total_msat: 0x1badca1f
2615                                 }),
2616                                 keysend_preimage: None,
2617                         },
2618                         amt_to_forward: 0x0badf00d01020304,
2619                         outgoing_cltv_value: 0xffffffff,
2620                 };
2621                 let encoded_value = msg.encode();
2622                 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2623                 assert_eq!(encoded_value, target_value);
2624                 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2625                 if let OnionHopDataFormat::FinalNode {
2626                         payment_data: Some(FinalOnionHopData {
2627                                 payment_secret,
2628                                 total_msat: 0x1badca1f
2629                         }),
2630                         keysend_preimage: None,
2631                 } = msg.format {
2632                         assert_eq!(payment_secret, expected_payment_secret);
2633                 } else { panic!(); }
2634                 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2635                 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2636         }
2637
2638         #[test]
2639         fn query_channel_range_end_blocknum() {
2640                 let tests: Vec<(u32, u32, u32)> = vec![
2641                         (10000, 1500, 11500),
2642                         (0, 0xffffffff, 0xffffffff),
2643                         (1, 0xffffffff, 0xffffffff),
2644                 ];
2645
2646                 for (first_blocknum, number_of_blocks, expected) in tests.into_iter() {
2647                         let sut = msgs::QueryChannelRange {
2648                                 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2649                                 first_blocknum,
2650                                 number_of_blocks,
2651                         };
2652                         assert_eq!(sut.end_blocknum(), expected);
2653                 }
2654         }
2655
2656         #[test]
2657         fn encoding_query_channel_range() {
2658                 let mut query_channel_range = msgs::QueryChannelRange {
2659                         chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2660                         first_blocknum: 100000,
2661                         number_of_blocks: 1500,
2662                 };
2663                 let encoded_value = query_channel_range.encode();
2664                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2665                 assert_eq!(encoded_value, target_value);
2666
2667                 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2668                 assert_eq!(query_channel_range.first_blocknum, 100000);
2669                 assert_eq!(query_channel_range.number_of_blocks, 1500);
2670         }
2671
2672         #[test]
2673         fn encoding_reply_channel_range() {
2674                 do_encoding_reply_channel_range(0);
2675                 do_encoding_reply_channel_range(1);
2676         }
2677
2678         fn do_encoding_reply_channel_range(encoding_type: u8) {
2679                 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2680                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2681                 let mut reply_channel_range = msgs::ReplyChannelRange {
2682                         chain_hash: expected_chain_hash,
2683                         first_blocknum: 756230,
2684                         number_of_blocks: 1500,
2685                         sync_complete: true,
2686                         short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2687                 };
2688
2689                 if encoding_type == 0 {
2690                         target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2691                         let encoded_value = reply_channel_range.encode();
2692                         assert_eq!(encoded_value, target_value);
2693
2694                         reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2695                         assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2696                         assert_eq!(reply_channel_range.first_blocknum, 756230);
2697                         assert_eq!(reply_channel_range.number_of_blocks, 1500);
2698                         assert_eq!(reply_channel_range.sync_complete, true);
2699                         assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2700                         assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2701                         assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2702                 } else {
2703                         target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2704                         let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2705                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2706                 }
2707         }
2708
2709         #[test]
2710         fn encoding_query_short_channel_ids() {
2711                 do_encoding_query_short_channel_ids(0);
2712                 do_encoding_query_short_channel_ids(1);
2713         }
2714
2715         fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2716                 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2717                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2718                 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2719                         chain_hash: expected_chain_hash,
2720                         short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2721                 };
2722
2723                 if encoding_type == 0 {
2724                         target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2725                         let encoded_value = query_short_channel_ids.encode();
2726                         assert_eq!(encoded_value, target_value);
2727
2728                         query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2729                         assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2730                         assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2731                         assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2732                         assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2733                 } else {
2734                         target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2735                         let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2736                         assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2737                 }
2738         }
2739
2740         #[test]
2741         fn encoding_reply_short_channel_ids_end() {
2742                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2743                 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2744                         chain_hash: expected_chain_hash,
2745                         full_information: true,
2746                 };
2747                 let encoded_value = reply_short_channel_ids_end.encode();
2748                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2749                 assert_eq!(encoded_value, target_value);
2750
2751                 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2752                 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2753                 assert_eq!(reply_short_channel_ids_end.full_information, true);
2754         }
2755
2756         #[test]
2757         fn encoding_gossip_timestamp_filter(){
2758                 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2759                 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2760                         chain_hash: expected_chain_hash,
2761                         first_timestamp: 1590000000,
2762                         timestamp_range: 0xffff_ffff,
2763                 };
2764                 let encoded_value = gossip_timestamp_filter.encode();
2765                 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2766                 assert_eq!(encoded_value, target_value);
2767
2768                 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2769                 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2770                 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2771                 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);
2772         }
2773 }