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