1 // This file is Copyright its original authors, visible in version control
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
10 //! Wire messages, traits representing wire message handlers, and a few error types live here.
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
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.
27 use bitcoin::secp256k1::key::PublicKey;
28 use bitcoin::secp256k1::Signature;
29 use bitcoin::secp256k1;
30 use bitcoin::blockdata::script::Script;
31 use bitcoin::hash_types::{Txid, BlockHash};
33 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
39 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
41 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
43 /// 21 million * 10^8 * 1000
44 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000;
46 /// An error in decoding a message or struct.
48 pub enum DecodeError {
49 /// A version byte specified something we don't know how to handle.
50 /// Includes unknown realm byte in an OnionHopData packet
52 /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type)
53 UnknownRequiredFeature,
54 /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
55 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was
56 /// syntactically incorrect, etc
60 /// A length descriptor in the packet didn't describe the later data correctly
62 /// Error from std::io
66 /// An init message to be sent or received from a peer
69 #[cfg(not(feature = "fuzztarget"))]
70 pub(crate) features: InitFeatures,
71 #[cfg(feature = "fuzztarget")]
72 pub features: InitFeatures,
75 /// An error message to be sent or received from a peer
77 pub struct ErrorMessage {
78 /// The channel ID involved in the error
79 pub channel_id: [u8; 32],
80 /// A possibly human-readable error description.
81 /// The string should be sanitized before it is used (e.g. emitted to logs
82 /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
83 /// vulnerability in the terminal emulator or the logging subsystem.
87 /// A ping message to be sent or received from a peer
90 /// The desired response length
92 /// The ping packet size.
93 /// This field is not sent on the wire. byteslen zeros are sent.
97 /// A pong message to be sent or received from a peer
100 /// The pong packet size.
101 /// This field is not sent on the wire. byteslen zeros are sent.
105 /// An open_channel message to be sent or received from a peer
107 pub struct OpenChannel {
108 /// The genesis hash of the blockchain where the channel is to be opened
109 pub chain_hash: BlockHash,
110 /// A temporary channel ID, until the funding outpoint is announced
111 pub temporary_channel_id: [u8; 32],
112 /// The channel value
113 pub funding_satoshis: u64,
114 /// The amount to push to the counterparty as part of the open, in milli-satoshi
116 /// The threshold below which outputs on transactions broadcast by sender will be omitted
117 pub dust_limit_satoshis: u64,
118 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
119 pub max_htlc_value_in_flight_msat: u64,
120 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
121 pub channel_reserve_satoshis: u64,
122 /// The minimum HTLC size incoming to sender, in milli-satoshi
123 pub htlc_minimum_msat: u64,
124 /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
125 pub feerate_per_kw: u32,
126 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
127 pub to_self_delay: u16,
128 /// The maximum number of inbound HTLCs towards sender
129 pub max_accepted_htlcs: u16,
130 /// The sender's key controlling the funding transaction
131 pub funding_pubkey: PublicKey,
132 /// Used to derive a revocation key for transactions broadcast by counterparty
133 pub revocation_basepoint: PublicKey,
134 /// A payment key to sender for transactions broadcast by counterparty
135 pub payment_point: PublicKey,
136 /// Used to derive a payment key to sender for transactions broadcast by sender
137 pub delayed_payment_basepoint: PublicKey,
138 /// Used to derive an HTLC payment key to sender
139 pub htlc_basepoint: PublicKey,
140 /// The first to-be-broadcast-by-sender transaction's per commitment point
141 pub first_per_commitment_point: PublicKey,
143 pub channel_flags: u8,
144 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
145 pub shutdown_scriptpubkey: OptionalField<Script>,
148 /// An accept_channel message to be sent or received from a peer
150 pub struct AcceptChannel {
151 /// A temporary channel ID, until the funding outpoint is announced
152 pub temporary_channel_id: [u8; 32],
153 /// The threshold below which outputs on transactions broadcast by sender will be omitted
154 pub dust_limit_satoshis: u64,
155 /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
156 pub max_htlc_value_in_flight_msat: u64,
157 /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
158 pub channel_reserve_satoshis: u64,
159 /// The minimum HTLC size incoming to sender, in milli-satoshi
160 pub htlc_minimum_msat: u64,
161 /// Minimum depth of the funding transaction before the channel is considered open
162 pub minimum_depth: u32,
163 /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
164 pub to_self_delay: u16,
165 /// The maximum number of inbound HTLCs towards sender
166 pub max_accepted_htlcs: u16,
167 /// The sender's key controlling the funding transaction
168 pub funding_pubkey: PublicKey,
169 /// Used to derive a revocation key for transactions broadcast by counterparty
170 pub revocation_basepoint: PublicKey,
171 /// A payment key to sender for transactions broadcast by counterparty
172 pub payment_point: PublicKey,
173 /// Used to derive a payment key to sender for transactions broadcast by sender
174 pub delayed_payment_basepoint: PublicKey,
175 /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
176 pub htlc_basepoint: PublicKey,
177 /// The first to-be-broadcast-by-sender transaction's per commitment point
178 pub first_per_commitment_point: PublicKey,
179 /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
180 pub shutdown_scriptpubkey: OptionalField<Script>,
183 /// A funding_created message to be sent or received from a peer
185 pub struct FundingCreated {
186 /// A temporary channel ID, until the funding is established
187 pub temporary_channel_id: [u8; 32],
188 /// The funding transaction ID
189 pub funding_txid: Txid,
190 /// The specific output index funding this channel
191 pub funding_output_index: u16,
192 /// The signature of the channel initiator (funder) on the funding transaction
193 pub signature: Signature,
196 /// A funding_signed message to be sent or received from a peer
198 pub struct FundingSigned {
200 pub channel_id: [u8; 32],
201 /// The signature of the channel acceptor (fundee) on the funding transaction
202 pub signature: Signature,
205 /// A funding_locked message to be sent or received from a peer
206 #[derive(Clone, PartialEq)]
207 pub struct FundingLocked {
209 pub channel_id: [u8; 32],
210 /// The per-commitment point of the second commitment transaction
211 pub next_per_commitment_point: PublicKey,
214 /// A shutdown message to be sent or received from a peer
215 #[derive(Clone, PartialEq)]
216 pub struct Shutdown {
218 pub channel_id: [u8; 32],
219 /// The destination of this peer's funds on closing.
220 /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
221 pub scriptpubkey: Script,
224 /// A closing_signed message to be sent or received from a peer
225 #[derive(Clone, PartialEq)]
226 pub struct ClosingSigned {
228 pub channel_id: [u8; 32],
229 /// The proposed total fee for the closing transaction
230 pub fee_satoshis: u64,
231 /// A signature on the closing transaction
232 pub signature: Signature,
235 /// An update_add_htlc message to be sent or received from a peer
236 #[derive(Clone, PartialEq)]
237 pub struct UpdateAddHTLC {
239 pub channel_id: [u8; 32],
242 /// The HTLC value in milli-satoshi
243 pub amount_msat: u64,
244 /// The payment hash, the pre-image of which controls HTLC redemption
245 pub payment_hash: PaymentHash,
246 /// The expiry height of the HTLC
247 pub cltv_expiry: u32,
248 pub(crate) onion_routing_packet: OnionPacket,
251 /// An update_fulfill_htlc message to be sent or received from a peer
252 #[derive(Clone, PartialEq)]
253 pub struct UpdateFulfillHTLC {
255 pub channel_id: [u8; 32],
258 /// The pre-image of the payment hash, allowing HTLC redemption
259 pub payment_preimage: PaymentPreimage,
262 /// An update_fail_htlc message to be sent or received from a peer
263 #[derive(Clone, PartialEq)]
264 pub struct UpdateFailHTLC {
266 pub channel_id: [u8; 32],
269 pub(crate) reason: OnionErrorPacket,
272 /// An update_fail_malformed_htlc message to be sent or received from a peer
273 #[derive(Clone, PartialEq)]
274 pub struct UpdateFailMalformedHTLC {
276 pub channel_id: [u8; 32],
279 pub(crate) sha256_of_onion: [u8; 32],
281 pub failure_code: u16,
284 /// A commitment_signed message to be sent or received from a peer
285 #[derive(Clone, PartialEq)]
286 pub struct CommitmentSigned {
288 pub channel_id: [u8; 32],
289 /// A signature on the commitment transaction
290 pub signature: Signature,
291 /// Signatures on the HTLC transactions
292 pub htlc_signatures: Vec<Signature>,
295 /// A revoke_and_ack message to be sent or received from a peer
296 #[derive(Clone, PartialEq)]
297 pub struct RevokeAndACK {
299 pub channel_id: [u8; 32],
300 /// The secret corresponding to the per-commitment point
301 pub per_commitment_secret: [u8; 32],
302 /// The next sender-broadcast commitment transaction's per-commitment point
303 pub next_per_commitment_point: PublicKey,
306 /// An update_fee message to be sent or received from a peer
307 #[derive(PartialEq, Clone)]
308 pub struct UpdateFee {
310 pub channel_id: [u8; 32],
311 /// Fee rate per 1000-weight of the transaction
312 pub feerate_per_kw: u32,
315 #[derive(PartialEq, Clone)]
316 /// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
317 /// This is used to convince the recipient that the channel is at a certain commitment
318 /// number even if they lost that data due to a local failure. Of course, the peer may lie
319 /// and even later commitments may have been revoked.
320 pub struct DataLossProtect {
321 /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
322 /// belonging to the recipient
323 pub your_last_per_commitment_secret: [u8; 32],
324 /// The sender's per-commitment point for their current commitment transaction
325 pub my_current_per_commitment_point: PublicKey,
328 /// A channel_reestablish message to be sent or received from a peer
329 #[derive(PartialEq, Clone)]
330 pub struct ChannelReestablish {
332 pub channel_id: [u8; 32],
333 /// The next commitment number for the sender
334 pub next_local_commitment_number: u64,
335 /// The next commitment number for the recipient
336 pub next_remote_commitment_number: u64,
337 /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
338 pub data_loss_protect: OptionalField<DataLossProtect>,
341 /// An announcement_signatures message to be sent or received from a peer
342 #[derive(PartialEq, Clone, Debug)]
343 pub struct AnnouncementSignatures {
345 pub channel_id: [u8; 32],
346 /// The short channel ID
347 pub short_channel_id: u64,
348 /// A signature by the node key
349 pub node_signature: Signature,
350 /// A signature by the funding key
351 pub bitcoin_signature: Signature,
354 /// An address which can be used to connect to a remote peer
355 #[derive(Clone, PartialEq, Debug)]
356 pub enum NetAddress {
357 /// An IPv4 address/port on which the peer is listening.
359 /// The 4-byte IPv4 address
361 /// The port on which the node is listening
364 /// An IPv6 address/port on which the peer is listening.
366 /// The 16-byte IPv6 address
368 /// The port on which the node is listening
371 /// An old-style Tor onion address/port on which the peer is listening.
373 /// The bytes (usually encoded in base32 with ".onion" appended)
375 /// The port on which the node is listening
378 /// A new-style Tor onion address/port on which the peer is listening.
379 /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
380 /// wrap as base32 and append ".onion".
382 /// The ed25519 long-term public key of the peer
383 ed25519_pubkey: [u8; 32],
384 /// The checksum of the pubkey and version, as included in the onion address
386 /// The version byte, as defined by the Tor Onion v3 spec.
388 /// The port on which the node is listening
393 fn get_id(&self) -> u8 {
395 &NetAddress::IPv4 {..} => { 1 },
396 &NetAddress::IPv6 {..} => { 2 },
397 &NetAddress::OnionV2 {..} => { 3 },
398 &NetAddress::OnionV3 {..} => { 4 },
402 /// Strict byte-length of address descriptor, 1-byte type not recorded
403 fn len(&self) -> u16 {
405 &NetAddress::IPv4 { .. } => { 6 },
406 &NetAddress::IPv6 { .. } => { 18 },
407 &NetAddress::OnionV2 { .. } => { 12 },
408 &NetAddress::OnionV3 { .. } => { 37 },
412 /// The maximum length of any address descriptor, not including the 1-byte type
413 pub(crate) const MAX_LEN: u16 = 37;
416 impl Writeable for NetAddress {
417 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
419 &NetAddress::IPv4 { ref addr, ref port } => {
424 &NetAddress::IPv6 { ref addr, ref port } => {
429 &NetAddress::OnionV2 { ref addr, ref port } => {
434 &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
436 ed25519_pubkey.write(writer)?;
437 checksum.write(writer)?;
438 version.write(writer)?;
446 impl Readable for Result<NetAddress, u8> {
447 fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
448 let byte = <u8 as Readable>::read(reader)?;
451 Ok(Ok(NetAddress::IPv4 {
452 addr: Readable::read(reader)?,
453 port: Readable::read(reader)?,
457 Ok(Ok(NetAddress::IPv6 {
458 addr: Readable::read(reader)?,
459 port: Readable::read(reader)?,
463 Ok(Ok(NetAddress::OnionV2 {
464 addr: Readable::read(reader)?,
465 port: Readable::read(reader)?,
469 Ok(Ok(NetAddress::OnionV3 {
470 ed25519_pubkey: Readable::read(reader)?,
471 checksum: Readable::read(reader)?,
472 version: Readable::read(reader)?,
473 port: Readable::read(reader)?,
476 _ => return Ok(Err(byte)),
481 /// The unsigned part of a node_announcement
482 #[derive(PartialEq, Clone, Debug)]
483 pub struct UnsignedNodeAnnouncement {
484 /// The advertised features
485 pub features: NodeFeatures,
486 /// A strictly monotonic announcement counter, with gaps allowed
488 /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
490 pub node_id: PublicKey,
491 /// An RGB color for UI purposes
493 /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
496 /// List of addresses on which this node is reachable
497 pub addresses: Vec<NetAddress>,
498 pub(crate) excess_address_data: Vec<u8>,
499 pub(crate) excess_data: Vec<u8>,
501 #[derive(PartialEq, Clone, Debug)]
502 /// A node_announcement message to be sent or received from a peer
503 pub struct NodeAnnouncement {
504 /// The signature by the node key
505 pub signature: Signature,
506 /// The actual content of the announcement
507 pub contents: UnsignedNodeAnnouncement,
510 /// The unsigned part of a channel_announcement
511 #[derive(PartialEq, Clone, Debug)]
512 pub struct UnsignedChannelAnnouncement {
513 /// The advertised channel features
514 pub features: ChannelFeatures,
515 /// The genesis hash of the blockchain where the channel is to be opened
516 pub chain_hash: BlockHash,
517 /// The short channel ID
518 pub short_channel_id: u64,
519 /// One of the two node_ids which are endpoints of this channel
520 pub node_id_1: PublicKey,
521 /// The other of the two node_ids which are endpoints of this channel
522 pub node_id_2: PublicKey,
523 /// The funding key for the first node
524 pub bitcoin_key_1: PublicKey,
525 /// The funding key for the second node
526 pub bitcoin_key_2: PublicKey,
527 pub(crate) excess_data: Vec<u8>,
529 /// A channel_announcement message to be sent or received from a peer
530 #[derive(PartialEq, Clone, Debug)]
531 pub struct ChannelAnnouncement {
532 /// Authentication of the announcement by the first public node
533 pub node_signature_1: Signature,
534 /// Authentication of the announcement by the second public node
535 pub node_signature_2: Signature,
536 /// Proof of funding UTXO ownership by the first public node
537 pub bitcoin_signature_1: Signature,
538 /// Proof of funding UTXO ownership by the second public node
539 pub bitcoin_signature_2: Signature,
540 /// The actual announcement
541 pub contents: UnsignedChannelAnnouncement,
544 /// The unsigned part of a channel_update
545 #[derive(PartialEq, Clone, Debug)]
546 pub struct UnsignedChannelUpdate {
547 /// The genesis hash of the blockchain where the channel is to be opened
548 pub chain_hash: BlockHash,
549 /// The short channel ID
550 pub short_channel_id: u64,
551 /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
555 /// The number of blocks to subtract from incoming HTLC cltv_expiry values
556 pub cltv_expiry_delta: u16,
557 /// The minimum HTLC size incoming to sender, in milli-satoshi
558 pub htlc_minimum_msat: u64,
559 /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
560 pub htlc_maximum_msat: OptionalField<u64>,
561 /// The base HTLC fee charged by sender, in milli-satoshi
562 pub fee_base_msat: u32,
563 /// The amount to fee multiplier, in micro-satoshi
564 pub fee_proportional_millionths: u32,
565 pub(crate) excess_data: Vec<u8>,
567 /// A channel_update message to be sent or received from a peer
568 #[derive(PartialEq, Clone, Debug)]
569 pub struct ChannelUpdate {
570 /// A signature of the channel update
571 pub signature: Signature,
572 /// The actual channel update
573 pub contents: UnsignedChannelUpdate,
576 /// A query_channel_range message is used to query a peer for channel
577 /// UTXOs in a range of blocks. The recipient of a query makes a best
578 /// effort to reply to the query using one or more reply_channel_range
580 #[derive(Clone, Debug)]
581 pub struct QueryChannelRange {
582 /// The genesis hash of the blockchain being queried
583 pub chain_hash: BlockHash,
584 /// The height of the first block for the channel UTXOs being queried
585 pub first_blocknum: u32,
586 /// The number of blocks to include in the query results
587 pub number_of_blocks: u32,
590 /// A reply_channel_range message is a reply to a query_channel_range
591 /// message. Multiple reply_channel_range messages can be sent in reply
592 /// to a single query_channel_range message. The query recipient makes a
593 /// best effort to respond based on their local network view which may
594 /// not be a perfect view of the network. The short_channel_ids in the
595 /// reply are encoded. We only support encoding_type=0 uncompressed
596 /// serialization and do not support encoding_type=1 zlib serialization.
597 #[derive(Clone, Debug)]
598 pub struct ReplyChannelRange {
599 /// The genesis hash of the blockchain being queried
600 pub chain_hash: BlockHash,
601 /// The height of the first block in the range of the reply
602 pub first_blocknum: u32,
603 /// The number of blocks included in the range of the reply
604 pub number_of_blocks: u32,
605 /// Indicates if the query recipient maintains up-to-date channel
606 /// information for the chain_hash
607 pub full_information: bool,
608 /// The short_channel_ids in the channel range
609 pub short_channel_ids: Vec<u64>,
612 /// A query_short_channel_ids message is used to query a peer for
613 /// routing gossip messages related to one or more short_channel_ids.
614 /// The query recipient will reply with the latest, if available,
615 /// channel_announcement, channel_update and node_announcement messages
616 /// it maintains for the requested short_channel_ids followed by a
617 /// reply_short_channel_ids_end message. The short_channel_ids sent in
618 /// this query are encoded. We only support encoding_type=0 uncompressed
619 /// serialization and do not support encoding_type=1 zlib serialization.
620 #[derive(Clone, Debug)]
621 pub struct QueryShortChannelIds {
622 /// The genesis hash of the blockchain being queried
623 pub chain_hash: BlockHash,
624 /// The short_channel_ids that are being queried
625 pub short_channel_ids: Vec<u64>,
628 /// A reply_short_channel_ids_end message is sent as a reply to a
629 /// query_short_channel_ids message. The query recipient makes a best
630 /// effort to respond based on their local network view which may not be
631 /// a perfect view of the network.
632 #[derive(Clone, Debug)]
633 pub struct ReplyShortChannelIdsEnd {
634 /// The genesis hash of the blockchain that was queried
635 pub chain_hash: BlockHash,
636 /// Indicates if the query recipient maintains up-to-date channel
637 /// information for the chain_hash
638 pub full_information: bool,
641 /// A gossip_timestamp_filter message is used by a node to request
642 /// gossip relay for messages in the requested time range when the
643 /// gossip_queries feature has been negotiated.
644 #[derive(Clone, Debug)]
645 pub struct GossipTimestampFilter {
646 /// The genesis hash of the blockchain for channel and node information
647 pub chain_hash: BlockHash,
648 /// The starting unix timestamp
649 pub first_timestamp: u32,
650 /// The range of information in seconds
651 pub timestamp_range: u32,
654 /// Encoding type for data compression of collections in gossip queries.
655 /// We do not support encoding_type=1 zlib serialization defined in BOLT #7.
660 /// Used to put an error message in a LightningError
662 pub enum ErrorAction {
663 /// The peer took some action which made us think they were useless. Disconnect them.
665 /// An error message which we should make an effort to send before we disconnect.
666 msg: Option<ErrorMessage>
668 /// The peer did something harmless that we weren't able to process, just log and ignore
670 /// The peer did something incorrect. Tell them.
672 /// The message to send.
677 /// An Err type for failure to process messages.
678 pub struct LightningError {
679 /// A human-readable message describing the error
681 /// The action which should be taken against the offending peer.
682 pub action: ErrorAction,
685 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
686 /// transaction updates if they were pending.
687 #[derive(PartialEq, Clone)]
688 pub struct CommitmentUpdate {
689 /// update_add_htlc messages which should be sent
690 pub update_add_htlcs: Vec<UpdateAddHTLC>,
691 /// update_fulfill_htlc messages which should be sent
692 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
693 /// update_fail_htlc messages which should be sent
694 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
695 /// update_fail_malformed_htlc messages which should be sent
696 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
697 /// An update_fee message which should be sent
698 pub update_fee: Option<UpdateFee>,
699 /// Finally, the commitment_signed message which should be sent
700 pub commitment_signed: CommitmentSigned,
703 /// The information we received from a peer along the route of a payment we originated. This is
704 /// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
705 /// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
707 pub enum HTLCFailChannelUpdate {
708 /// We received an error which included a full ChannelUpdate message.
709 ChannelUpdateMessage {
710 /// The unwrapped message we received
713 /// We received an error which indicated only that a channel has been closed
715 /// The short_channel_id which has now closed.
716 short_channel_id: u64,
717 /// when this true, this channel should be permanently removed from the
718 /// consideration. Otherwise, this channel can be restored as new channel_update is received
721 /// We received an error which indicated only that a node has failed
723 /// The node_id that has failed.
725 /// when this true, node should be permanently removed from the
726 /// consideration. Otherwise, the channels connected to this node can be
727 /// restored as new channel_update is received
732 /// Messages could have optional fields to use with extended features
733 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
734 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
735 /// separate enum type for them.
736 /// (C-not exported) due to a free generic in T
737 #[derive(Clone, PartialEq, Debug)]
738 pub enum OptionalField<T> {
739 /// Optional field is included in message
741 /// Optional field is absent in message
745 /// A trait to describe an object which can receive channel messages.
747 /// Messages MAY be called in parallel when they originate from different their_node_ids, however
748 /// they MUST NOT be called in parallel when the two calls have the same their_node_id.
749 pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
751 /// Handle an incoming open_channel message from the given peer.
752 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &OpenChannel);
753 /// Handle an incoming accept_channel message from the given peer.
754 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &AcceptChannel);
755 /// Handle an incoming funding_created message from the given peer.
756 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated);
757 /// Handle an incoming funding_signed message from the given peer.
758 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned);
759 /// Handle an incoming funding_locked message from the given peer.
760 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked);
763 /// Handle an incoming shutdown message from the given peer.
764 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown);
765 /// Handle an incoming closing_signed message from the given peer.
766 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned);
769 /// Handle an incoming update_add_htlc message from the given peer.
770 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC);
771 /// Handle an incoming update_fulfill_htlc message from the given peer.
772 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC);
773 /// Handle an incoming update_fail_htlc message from the given peer.
774 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC);
775 /// Handle an incoming update_fail_malformed_htlc message from the given peer.
776 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC);
777 /// Handle an incoming commitment_signed message from the given peer.
778 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned);
779 /// Handle an incoming revoke_and_ack message from the given peer.
780 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK);
782 /// Handle an incoming update_fee message from the given peer.
783 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee);
785 // Channel-to-announce:
786 /// Handle an incoming announcement_signatures message from the given peer.
787 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures);
789 // Connection loss/reestablish:
790 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
791 /// is believed to be possible in the future (eg they're sending us messages we don't
792 /// understand or indicate they require unknown feature bits), no_connection_possible is set
793 /// and any outstanding channels should be failed.
794 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
796 /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
797 fn peer_connected(&self, their_node_id: &PublicKey, msg: &Init);
798 /// Handle an incoming channel_reestablish message from the given peer.
799 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish);
802 /// Handle an incoming error message from the given peer.
803 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
806 /// A trait to describe an object which can receive routing messages.
808 /// # Implementor DoS Warnings
810 /// For `gossip_queries` messages there are potential DoS vectors when handling
811 /// inbound queries. Implementors using an on-disk network graph should be aware of
812 /// repeated disk I/O for queries accessing different parts of the network graph.
813 pub trait RoutingMessageHandler : Send + Sync + events::MessageSendEventsProvider {
814 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
815 /// false or returning an Err otherwise.
816 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
817 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
818 /// or returning an Err otherwise.
819 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
820 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
821 /// false or returning an Err otherwise.
822 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
823 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
824 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
825 /// Gets a subset of the channel announcements and updates required to dump our routing table
826 /// to a remote node, starting at the short_channel_id indicated by starting_point and
827 /// including the batch_amount entries immediately higher in numerical value than starting_point.
828 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
829 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
830 /// starting at the node *after* the provided publickey and including batch_amount entries
831 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
832 /// If None is provided for starting_point, we start at the first node.
833 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
834 /// Returns whether a full sync should be requested from a peer.
835 fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
836 /// Initiates routing gossip sync by querying a peer to discover channels
837 /// and their associated routing gossip messages. This method will use a
838 /// sync strategy defined by the implementor.
839 fn sync_routing_table(&self, their_node_id: &PublicKey, init: &Init);
840 /// Handles the reply of a query we initiated to learn about channels
841 /// for a given range of blocks. We can expect to receive one or more
842 /// replies to a single query.
843 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: ReplyChannelRange) -> Result<(), LightningError>;
844 /// Handles the reply of a query we initiated asking for routing gossip
845 /// messages for a list of channels. We should receive this message when
846 /// a node has completed its best effort to send us the pertaining routing
848 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
849 /// Handles when a peer asks us to send a list of short_channel_ids
850 /// for the requested range of blocks.
851 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: QueryChannelRange) -> Result<(), LightningError>;
852 /// Handles when a peer asks us to send routing gossip messages for a
853 /// list of short_channel_ids.
854 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: QueryShortChannelIds) -> Result<(), LightningError>;
857 mod fuzzy_internal_msgs {
858 use ln::channelmanager::PaymentSecret;
860 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
861 // them from untrusted input):
863 pub(crate) struct FinalOnionHopData {
864 pub(crate) payment_secret: PaymentSecret,
865 /// The total value, in msat, of the payment as received by the ultimate recipient.
866 /// Message serialization may panic if this value is more than 21 million Bitcoin.
867 pub(crate) total_msat: u64,
870 pub(crate) enum OnionHopDataFormat {
871 Legacy { // aka Realm-0
872 short_channel_id: u64,
875 short_channel_id: u64,
878 payment_data: Option<FinalOnionHopData>,
882 pub struct OnionHopData {
883 pub(crate) format: OnionHopDataFormat,
884 /// The value, in msat, of the payment after this hop's fee is deducted.
885 /// Message serialization may panic if this value is more than 21 million Bitcoin.
886 pub(crate) amt_to_forward: u64,
887 pub(crate) outgoing_cltv_value: u32,
888 // 12 bytes of 0-padding for Legacy format
891 pub struct DecodedOnionErrorPacket {
892 pub(crate) hmac: [u8; 32],
893 pub(crate) failuremsg: Vec<u8>,
894 pub(crate) pad: Vec<u8>,
897 #[cfg(feature = "fuzztarget")]
898 pub use self::fuzzy_internal_msgs::*;
899 #[cfg(not(feature = "fuzztarget"))]
900 pub(crate) use self::fuzzy_internal_msgs::*;
903 pub(crate) struct OnionPacket {
904 pub(crate) version: u8,
905 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
906 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
907 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
908 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
909 pub(crate) hop_data: [u8; 20*65],
910 pub(crate) hmac: [u8; 32],
913 impl PartialEq for OnionPacket {
914 fn eq(&self, other: &OnionPacket) -> bool {
915 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
916 if i != j { return false; }
918 self.version == other.version &&
919 self.public_key == other.public_key &&
920 self.hmac == other.hmac
924 #[derive(Clone, PartialEq)]
925 pub(crate) struct OnionErrorPacket {
926 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
927 // (TODO) We limit it in decode to much lower...
928 pub(crate) data: Vec<u8>,
931 impl fmt::Display for DecodeError {
932 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
934 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
935 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
936 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
937 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
938 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
939 DecodeError::Io(ref e) => e.fmt(f),
944 impl fmt::Debug for LightningError {
945 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
946 f.write_str(self.err.as_str())
950 impl From<::std::io::Error> for DecodeError {
951 fn from(e: ::std::io::Error) -> Self {
952 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
953 DecodeError::ShortRead
960 impl Writeable for OptionalField<Script> {
961 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
963 OptionalField::Present(ref script) => {
964 // Note that Writeable for script includes the 16-bit length tag for us
967 OptionalField::Absent => {}
973 impl Readable for OptionalField<Script> {
974 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
975 match <u16 as Readable>::read(r) {
977 let mut buf = vec![0; len as usize];
978 r.read_exact(&mut buf)?;
979 Ok(OptionalField::Present(Script::from(buf)))
981 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
987 impl Writeable for OptionalField<u64> {
988 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
990 OptionalField::Present(ref value) => {
993 OptionalField::Absent => {}
999 impl Readable for OptionalField<u64> {
1000 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1001 let value: u64 = Readable::read(r)?;
1002 Ok(OptionalField::Present(value))
1007 impl_writeable_len_match!(AcceptChannel, {
1008 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1011 temporary_channel_id,
1012 dust_limit_satoshis,
1013 max_htlc_value_in_flight_msat,
1014 channel_reserve_satoshis,
1020 revocation_basepoint,
1022 delayed_payment_basepoint,
1024 first_per_commitment_point,
1025 shutdown_scriptpubkey
1028 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1035 impl Writeable for ChannelReestablish {
1036 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1037 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1038 self.channel_id.write(w)?;
1039 self.next_local_commitment_number.write(w)?;
1040 self.next_remote_commitment_number.write(w)?;
1041 match self.data_loss_protect {
1042 OptionalField::Present(ref data_loss_protect) => {
1043 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1044 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1046 OptionalField::Absent => {}
1052 impl Readable for ChannelReestablish{
1053 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1055 channel_id: Readable::read(r)?,
1056 next_local_commitment_number: Readable::read(r)?,
1057 next_remote_commitment_number: Readable::read(r)?,
1058 data_loss_protect: {
1059 match <[u8; 32] as Readable>::read(r) {
1060 Ok(your_last_per_commitment_secret) =>
1061 OptionalField::Present(DataLossProtect {
1062 your_last_per_commitment_secret,
1063 my_current_per_commitment_point: Readable::read(r)?,
1065 Err(DecodeError::ShortRead) => OptionalField::Absent,
1066 Err(e) => return Err(e)
1073 impl_writeable!(ClosingSigned, 32+8+64, {
1079 impl_writeable_len_match!(CommitmentSigned, {
1080 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1087 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1088 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1095 impl_writeable!(FundingCreated, 32+32+2+64, {
1096 temporary_channel_id,
1098 funding_output_index,
1102 impl_writeable!(FundingSigned, 32+64, {
1107 impl_writeable!(FundingLocked, 32+33, {
1109 next_per_commitment_point
1112 impl Writeable for Init {
1113 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1114 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1115 // our relevant feature bits. This keeps us compatible with old nodes.
1116 self.features.write_up_to_13(w)?;
1117 self.features.write(w)
1121 impl Readable for Init {
1122 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1123 let global_features: InitFeatures = Readable::read(r)?;
1124 let features: InitFeatures = Readable::read(r)?;
1126 features: features.or(global_features),
1131 impl_writeable_len_match!(OpenChannel, {
1132 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1136 temporary_channel_id,
1139 dust_limit_satoshis,
1140 max_htlc_value_in_flight_msat,
1141 channel_reserve_satoshis,
1147 revocation_basepoint,
1149 delayed_payment_basepoint,
1151 first_per_commitment_point,
1153 shutdown_scriptpubkey
1156 impl_writeable!(RevokeAndACK, 32+32+33, {
1158 per_commitment_secret,
1159 next_per_commitment_point
1162 impl_writeable_len_match!(Shutdown, {
1163 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1169 impl_writeable_len_match!(UpdateFailHTLC, {
1170 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1177 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1184 impl_writeable!(UpdateFee, 32+4, {
1189 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1195 impl_writeable_len_match!(OnionErrorPacket, {
1196 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1201 impl Writeable for OnionPacket {
1202 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1203 w.size_hint(1 + 33 + 20*65 + 32);
1204 self.version.write(w)?;
1205 match self.public_key {
1206 Ok(pubkey) => pubkey.write(w)?,
1207 Err(_) => [0u8;33].write(w)?,
1209 w.write_all(&self.hop_data)?;
1210 self.hmac.write(w)?;
1215 impl Readable for OnionPacket {
1216 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1218 version: Readable::read(r)?,
1220 let mut buf = [0u8;33];
1221 r.read_exact(&mut buf)?;
1222 PublicKey::from_slice(&buf)
1224 hop_data: Readable::read(r)?,
1225 hmac: Readable::read(r)?,
1230 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1236 onion_routing_packet
1239 impl Writeable for FinalOnionHopData {
1240 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1241 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1242 self.payment_secret.0.write(w)?;
1243 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1247 impl Readable for FinalOnionHopData {
1248 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1249 let secret: [u8; 32] = Readable::read(r)?;
1250 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1251 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1255 impl Writeable for OnionHopData {
1256 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1258 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1259 // check values are sane long before we get here, though its possible in the future
1260 // user-generated messages may hit this.
1261 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1263 OnionHopDataFormat::Legacy { short_channel_id } => {
1265 short_channel_id.write(w)?;
1266 self.amt_to_forward.write(w)?;
1267 self.outgoing_cltv_value.write(w)?;
1268 w.write_all(&[0;12])?;
1270 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1271 encode_varint_length_prefixed_tlv!(w, {
1272 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1273 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1274 (6, short_channel_id)
1277 OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1278 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1279 encode_varint_length_prefixed_tlv!(w, {
1280 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1281 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1285 OnionHopDataFormat::FinalNode { payment_data: None } => {
1286 encode_varint_length_prefixed_tlv!(w, {
1287 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1288 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1296 impl Readable for OnionHopData {
1297 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1298 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1299 let v: VarInt = Decodable::consensus_decode(&mut r)
1300 .map_err(|e| match e {
1301 Error::Io(ioe) => DecodeError::from(ioe),
1302 _ => DecodeError::InvalidValue
1304 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1305 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1306 let mut rd = FixedLengthReader::new(r, v.0);
1307 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1308 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1309 let mut short_id: Option<u64> = None;
1310 let mut payment_data: Option<FinalOnionHopData> = None;
1311 decode_tlv!(&mut rd, {
1318 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1319 let format = if let Some(short_channel_id) = short_id {
1320 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1321 OnionHopDataFormat::NonFinalNode {
1325 if let &Some(ref data) = &payment_data {
1326 if data.total_msat > MAX_VALUE_MSAT {
1327 return Err(DecodeError::InvalidValue);
1330 OnionHopDataFormat::FinalNode {
1334 (format, amt.0, cltv_value.0)
1336 let format = OnionHopDataFormat::Legacy {
1337 short_channel_id: Readable::read(r)?,
1339 let amt: u64 = Readable::read(r)?;
1340 let cltv_value: u32 = Readable::read(r)?;
1341 r.read_exact(&mut [0; 12])?;
1342 (format, amt, cltv_value)
1345 if amt > MAX_VALUE_MSAT {
1346 return Err(DecodeError::InvalidValue);
1350 amt_to_forward: amt,
1351 outgoing_cltv_value: cltv_value,
1356 impl Writeable for Ping {
1357 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1358 w.size_hint(self.byteslen as usize + 4);
1359 self.ponglen.write(w)?;
1360 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1365 impl Readable for Ping {
1366 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1368 ponglen: Readable::read(r)?,
1370 let byteslen = Readable::read(r)?;
1371 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1378 impl Writeable for Pong {
1379 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1380 w.size_hint(self.byteslen as usize + 2);
1381 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1386 impl Readable for Pong {
1387 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1390 let byteslen = Readable::read(r)?;
1391 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1398 impl Writeable for UnsignedChannelAnnouncement {
1399 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1400 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1401 self.features.write(w)?;
1402 self.chain_hash.write(w)?;
1403 self.short_channel_id.write(w)?;
1404 self.node_id_1.write(w)?;
1405 self.node_id_2.write(w)?;
1406 self.bitcoin_key_1.write(w)?;
1407 self.bitcoin_key_2.write(w)?;
1408 w.write_all(&self.excess_data[..])?;
1413 impl Readable for UnsignedChannelAnnouncement {
1414 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1416 features: Readable::read(r)?,
1417 chain_hash: Readable::read(r)?,
1418 short_channel_id: Readable::read(r)?,
1419 node_id_1: Readable::read(r)?,
1420 node_id_2: Readable::read(r)?,
1421 bitcoin_key_1: Readable::read(r)?,
1422 bitcoin_key_2: Readable::read(r)?,
1424 let mut excess_data = vec![];
1425 r.read_to_end(&mut excess_data)?;
1432 impl_writeable_len_match!(ChannelAnnouncement, {
1433 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1434 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1438 bitcoin_signature_1,
1439 bitcoin_signature_2,
1443 impl Writeable for UnsignedChannelUpdate {
1444 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1445 let mut size = 64 + self.excess_data.len();
1446 let mut message_flags: u8 = 0;
1447 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1452 self.chain_hash.write(w)?;
1453 self.short_channel_id.write(w)?;
1454 self.timestamp.write(w)?;
1455 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1456 all_flags.write(w)?;
1457 self.cltv_expiry_delta.write(w)?;
1458 self.htlc_minimum_msat.write(w)?;
1459 self.fee_base_msat.write(w)?;
1460 self.fee_proportional_millionths.write(w)?;
1461 self.htlc_maximum_msat.write(w)?;
1462 w.write_all(&self.excess_data[..])?;
1467 impl Readable for UnsignedChannelUpdate {
1468 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1469 let has_htlc_maximum_msat;
1471 chain_hash: Readable::read(r)?,
1472 short_channel_id: Readable::read(r)?,
1473 timestamp: Readable::read(r)?,
1475 let flags: u16 = Readable::read(r)?;
1476 let message_flags = flags >> 8;
1477 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1480 cltv_expiry_delta: Readable::read(r)?,
1481 htlc_minimum_msat: Readable::read(r)?,
1482 fee_base_msat: Readable::read(r)?,
1483 fee_proportional_millionths: Readable::read(r)?,
1484 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1486 let mut excess_data = vec![];
1487 r.read_to_end(&mut excess_data)?;
1494 impl_writeable_len_match!(ChannelUpdate, {
1495 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1496 64 + excess_data.len() + 64 }
1502 impl Writeable for ErrorMessage {
1503 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1504 w.size_hint(32 + 2 + self.data.len());
1505 self.channel_id.write(w)?;
1506 (self.data.len() as u16).write(w)?;
1507 w.write_all(self.data.as_bytes())?;
1512 impl Readable for ErrorMessage {
1513 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1515 channel_id: Readable::read(r)?,
1517 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1518 let mut data = vec![];
1519 let data_len = r.read_to_end(&mut data)?;
1520 sz = cmp::min(data_len, sz);
1521 match String::from_utf8(data[..sz as usize].to_vec()) {
1523 Err(_) => return Err(DecodeError::InvalidValue),
1530 impl Writeable for UnsignedNodeAnnouncement {
1531 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1532 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1533 self.features.write(w)?;
1534 self.timestamp.write(w)?;
1535 self.node_id.write(w)?;
1536 w.write_all(&self.rgb)?;
1537 self.alias.write(w)?;
1539 let mut addrs_to_encode = self.addresses.clone();
1540 addrs_to_encode.sort_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1541 let mut addr_len = 0;
1542 for addr in &addrs_to_encode {
1543 addr_len += 1 + addr.len();
1545 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1546 for addr in addrs_to_encode {
1549 w.write_all(&self.excess_address_data[..])?;
1550 w.write_all(&self.excess_data[..])?;
1555 impl Readable for UnsignedNodeAnnouncement {
1556 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1557 let features: NodeFeatures = Readable::read(r)?;
1558 let timestamp: u32 = Readable::read(r)?;
1559 let node_id: PublicKey = Readable::read(r)?;
1560 let mut rgb = [0; 3];
1561 r.read_exact(&mut rgb)?;
1562 let alias: [u8; 32] = Readable::read(r)?;
1564 let addr_len: u16 = Readable::read(r)?;
1565 let mut addresses: Vec<NetAddress> = Vec::new();
1566 let mut highest_addr_type = 0;
1567 let mut addr_readpos = 0;
1568 let mut excess = false;
1569 let mut excess_byte = 0;
1571 if addr_len <= addr_readpos { break; }
1572 match Readable::read(r) {
1574 if addr.get_id() < highest_addr_type {
1575 // Addresses must be sorted in increasing order
1576 return Err(DecodeError::InvalidValue);
1578 highest_addr_type = addr.get_id();
1579 if addr_len < addr_readpos + 1 + addr.len() {
1580 return Err(DecodeError::BadLengthDescriptor);
1582 addr_readpos += (1 + addr.len()) as u16;
1583 addresses.push(addr);
1585 Ok(Err(unknown_descriptor)) => {
1587 excess_byte = unknown_descriptor;
1590 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1591 Err(e) => return Err(e),
1595 let mut excess_data = vec![];
1596 let excess_address_data = if addr_readpos < addr_len {
1597 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1598 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1600 excess_address_data[0] = excess_byte;
1605 excess_data.push(excess_byte);
1609 r.read_to_end(&mut excess_data)?;
1610 Ok(UnsignedNodeAnnouncement {
1617 excess_address_data,
1623 impl_writeable_len_match!(NodeAnnouncement, {
1624 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1625 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1631 impl Readable for QueryShortChannelIds {
1632 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1633 let chain_hash: BlockHash = Readable::read(r)?;
1635 // We expect the encoding_len to always includes the 1-byte
1636 // encoding_type and that short_channel_ids are 8-bytes each
1637 let encoding_len: u16 = Readable::read(r)?;
1638 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1639 return Err(DecodeError::InvalidValue);
1642 // Must be encoding_type=0 uncompressed serialization. We do not
1643 // support encoding_type=1 zlib serialization.
1644 let encoding_type: u8 = Readable::read(r)?;
1645 if encoding_type != EncodingType::Uncompressed as u8 {
1646 return Err(DecodeError::InvalidValue);
1649 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1650 // less the 1-byte encoding_type
1651 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1652 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1653 for _ in 0..short_channel_id_count {
1654 short_channel_ids.push(Readable::read(r)?);
1657 Ok(QueryShortChannelIds {
1664 impl Writeable for QueryShortChannelIds {
1665 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1666 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1667 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1669 w.size_hint(32 + 2 + encoding_len as usize);
1670 self.chain_hash.write(w)?;
1671 encoding_len.write(w)?;
1673 // We only support type=0 uncompressed serialization
1674 (EncodingType::Uncompressed as u8).write(w)?;
1676 for scid in self.short_channel_ids.iter() {
1684 impl Readable for ReplyShortChannelIdsEnd {
1685 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1686 let chain_hash: BlockHash = Readable::read(r)?;
1687 let full_information: bool = Readable::read(r)?;
1688 Ok(ReplyShortChannelIdsEnd {
1695 impl Writeable for ReplyShortChannelIdsEnd {
1696 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1697 w.size_hint(32 + 1);
1698 self.chain_hash.write(w)?;
1699 self.full_information.write(w)?;
1704 impl Readable for QueryChannelRange {
1705 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1706 let chain_hash: BlockHash = Readable::read(r)?;
1707 let first_blocknum: u32 = Readable::read(r)?;
1708 let number_of_blocks: u32 = Readable::read(r)?;
1709 Ok(QueryChannelRange {
1717 impl Writeable for QueryChannelRange {
1718 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1719 w.size_hint(32 + 4 + 4);
1720 self.chain_hash.write(w)?;
1721 self.first_blocknum.write(w)?;
1722 self.number_of_blocks.write(w)?;
1727 impl Readable for ReplyChannelRange {
1728 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1729 let chain_hash: BlockHash = Readable::read(r)?;
1730 let first_blocknum: u32 = Readable::read(r)?;
1731 let number_of_blocks: u32 = Readable::read(r)?;
1732 let full_information: bool = Readable::read(r)?;
1734 // We expect the encoding_len to always includes the 1-byte
1735 // encoding_type and that short_channel_ids are 8-bytes each
1736 let encoding_len: u16 = Readable::read(r)?;
1737 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1738 return Err(DecodeError::InvalidValue);
1741 // Must be encoding_type=0 uncompressed serialization. We do not
1742 // support encoding_type=1 zlib serialization.
1743 let encoding_type: u8 = Readable::read(r)?;
1744 if encoding_type != EncodingType::Uncompressed as u8 {
1745 return Err(DecodeError::InvalidValue);
1748 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1749 // less the 1-byte encoding_type
1750 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1751 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1752 for _ in 0..short_channel_id_count {
1753 short_channel_ids.push(Readable::read(r)?);
1756 Ok(ReplyChannelRange {
1766 impl Writeable for ReplyChannelRange {
1767 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1768 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1769 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1770 self.chain_hash.write(w)?;
1771 self.first_blocknum.write(w)?;
1772 self.number_of_blocks.write(w)?;
1773 self.full_information.write(w)?;
1775 encoding_len.write(w)?;
1776 (EncodingType::Uncompressed as u8).write(w)?;
1777 for scid in self.short_channel_ids.iter() {
1785 impl Readable for GossipTimestampFilter {
1786 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1787 let chain_hash: BlockHash = Readable::read(r)?;
1788 let first_timestamp: u32 = Readable::read(r)?;
1789 let timestamp_range: u32 = Readable::read(r)?;
1790 Ok(GossipTimestampFilter {
1798 impl Writeable for GossipTimestampFilter {
1799 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1800 w.size_hint(32 + 4 + 4);
1801 self.chain_hash.write(w)?;
1802 self.first_timestamp.write(w)?;
1803 self.timestamp_range.write(w)?;
1813 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1814 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
1815 use util::ser::{Writeable, Readable};
1817 use bitcoin::hashes::hex::FromHex;
1818 use bitcoin::util::address::Address;
1819 use bitcoin::network::constants::Network;
1820 use bitcoin::blockdata::script::Builder;
1821 use bitcoin::blockdata::opcodes;
1822 use bitcoin::hash_types::{Txid, BlockHash};
1824 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1825 use bitcoin::secp256k1::{Secp256k1, Message};
1827 use std::io::Cursor;
1830 fn encoding_channel_reestablish_no_secret() {
1831 let cr = msgs::ChannelReestablish {
1832 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],
1833 next_local_commitment_number: 3,
1834 next_remote_commitment_number: 4,
1835 data_loss_protect: OptionalField::Absent,
1838 let encoded_value = cr.encode();
1841 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]
1846 fn encoding_channel_reestablish_with_secret() {
1848 let secp_ctx = Secp256k1::new();
1849 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1852 let cr = msgs::ChannelReestablish {
1853 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],
1854 next_local_commitment_number: 3,
1855 next_remote_commitment_number: 4,
1856 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1859 let encoded_value = cr.encode();
1862 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]
1866 macro_rules! get_keys_from {
1867 ($slice: expr, $secp_ctx: expr) => {
1869 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1870 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1876 macro_rules! get_sig_on {
1877 ($privkey: expr, $ctx: expr, $string: expr) => {
1879 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1880 $ctx.sign(&sighash, &$privkey)
1886 fn encoding_announcement_signatures() {
1887 let secp_ctx = Secp256k1::new();
1888 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1889 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1890 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1891 let announcement_signatures = msgs::AnnouncementSignatures {
1892 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],
1893 short_channel_id: 2316138423780173,
1894 node_signature: sig_1,
1895 bitcoin_signature: sig_2,
1898 let encoded_value = announcement_signatures.encode();
1899 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1902 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1903 let secp_ctx = Secp256k1::new();
1904 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1905 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1906 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1907 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1908 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1909 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1910 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1911 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1912 let mut features = ChannelFeatures::known();
1913 if unknown_features_bits {
1914 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1916 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1918 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1919 short_channel_id: 2316138423780173,
1920 node_id_1: pubkey_1,
1921 node_id_2: pubkey_2,
1922 bitcoin_key_1: pubkey_3,
1923 bitcoin_key_2: pubkey_4,
1924 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1926 let channel_announcement = msgs::ChannelAnnouncement {
1927 node_signature_1: sig_1,
1928 node_signature_2: sig_2,
1929 bitcoin_signature_1: sig_3,
1930 bitcoin_signature_2: sig_4,
1931 contents: unsigned_channel_announcement,
1933 let encoded_value = channel_announcement.encode();
1934 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1935 if unknown_features_bits {
1936 target_value.append(&mut hex::decode("0002ffff").unwrap());
1938 target_value.append(&mut hex::decode("0000").unwrap());
1940 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1941 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1943 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1945 assert_eq!(encoded_value, target_value);
1949 fn encoding_channel_announcement() {
1950 do_encoding_channel_announcement(true, false);
1951 do_encoding_channel_announcement(false, true);
1952 do_encoding_channel_announcement(false, false);
1953 do_encoding_channel_announcement(true, true);
1956 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1957 let secp_ctx = Secp256k1::new();
1958 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1959 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1960 let features = if unknown_features_bits {
1961 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1963 // Set to some features we may support
1964 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1966 let mut addresses = Vec::new();
1968 addresses.push(msgs::NetAddress::IPv4 {
1969 addr: [255, 254, 253, 252],
1974 addresses.push(msgs::NetAddress::IPv6 {
1975 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1980 addresses.push(msgs::NetAddress::OnionV2 {
1981 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1986 addresses.push(msgs::NetAddress::OnionV3 {
1987 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],
1993 let mut addr_len = 0;
1994 for addr in &addresses {
1995 addr_len += addr.len() + 1;
1997 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1999 timestamp: 20190119,
2004 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() },
2005 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() },
2007 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2008 let node_announcement = msgs::NodeAnnouncement {
2010 contents: unsigned_node_announcement,
2012 let encoded_value = node_announcement.encode();
2013 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2014 if unknown_features_bits {
2015 target_value.append(&mut hex::decode("0002ffff").unwrap());
2017 target_value.append(&mut hex::decode("000122").unwrap());
2019 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2020 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2022 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2025 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2028 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2031 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2033 if excess_address_data {
2034 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2037 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2039 assert_eq!(encoded_value, target_value);
2043 fn encoding_node_announcement() {
2044 do_encoding_node_announcement(true, true, true, true, true, true, true);
2045 do_encoding_node_announcement(false, false, false, false, false, false, false);
2046 do_encoding_node_announcement(false, true, false, false, false, false, false);
2047 do_encoding_node_announcement(false, false, true, false, false, false, false);
2048 do_encoding_node_announcement(false, false, false, true, false, false, false);
2049 do_encoding_node_announcement(false, false, false, false, true, false, false);
2050 do_encoding_node_announcement(false, false, false, false, false, true, false);
2051 do_encoding_node_announcement(false, true, false, true, false, true, false);
2052 do_encoding_node_announcement(false, false, true, false, true, false, false);
2055 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2056 let secp_ctx = Secp256k1::new();
2057 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2058 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2059 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2060 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2061 short_channel_id: 2316138423780173,
2062 timestamp: 20190119,
2063 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2064 cltv_expiry_delta: 144,
2065 htlc_minimum_msat: 1000000,
2066 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2067 fee_base_msat: 10000,
2068 fee_proportional_millionths: 20,
2069 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2071 let channel_update = msgs::ChannelUpdate {
2073 contents: unsigned_channel_update
2075 let encoded_value = channel_update.encode();
2076 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2077 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2078 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2079 if htlc_maximum_msat {
2080 target_value.append(&mut hex::decode("01").unwrap());
2082 target_value.append(&mut hex::decode("00").unwrap());
2084 target_value.append(&mut hex::decode("00").unwrap());
2086 let flag = target_value.last_mut().unwrap();
2090 let flag = target_value.last_mut().unwrap();
2091 *flag = *flag | 1 << 1;
2093 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2094 if htlc_maximum_msat {
2095 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2098 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2100 assert_eq!(encoded_value, target_value);
2104 fn encoding_channel_update() {
2105 do_encoding_channel_update(false, false, false, false);
2106 do_encoding_channel_update(false, false, false, true);
2107 do_encoding_channel_update(true, false, false, false);
2108 do_encoding_channel_update(true, false, false, true);
2109 do_encoding_channel_update(false, true, false, false);
2110 do_encoding_channel_update(false, true, false, true);
2111 do_encoding_channel_update(false, false, true, false);
2112 do_encoding_channel_update(false, false, true, true);
2113 do_encoding_channel_update(true, true, true, false);
2114 do_encoding_channel_update(true, true, true, true);
2117 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2118 let secp_ctx = Secp256k1::new();
2119 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2120 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2121 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2122 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2123 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2124 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2125 let open_channel = msgs::OpenChannel {
2126 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2127 temporary_channel_id: [2; 32],
2128 funding_satoshis: 1311768467284833366,
2129 push_msat: 2536655962884945560,
2130 dust_limit_satoshis: 3608586615801332854,
2131 max_htlc_value_in_flight_msat: 8517154655701053848,
2132 channel_reserve_satoshis: 8665828695742877976,
2133 htlc_minimum_msat: 2316138423780173,
2134 feerate_per_kw: 821716,
2135 to_self_delay: 49340,
2136 max_accepted_htlcs: 49340,
2137 funding_pubkey: pubkey_1,
2138 revocation_basepoint: pubkey_2,
2139 payment_point: pubkey_3,
2140 delayed_payment_basepoint: pubkey_4,
2141 htlc_basepoint: pubkey_5,
2142 first_per_commitment_point: pubkey_6,
2143 channel_flags: if random_bit { 1 << 5 } else { 0 },
2144 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2146 let encoded_value = open_channel.encode();
2147 let mut target_value = Vec::new();
2148 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2149 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2151 target_value.append(&mut hex::decode("20").unwrap());
2153 target_value.append(&mut hex::decode("00").unwrap());
2156 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2158 assert_eq!(encoded_value, target_value);
2162 fn encoding_open_channel() {
2163 do_encoding_open_channel(false, false);
2164 do_encoding_open_channel(true, false);
2165 do_encoding_open_channel(false, true);
2166 do_encoding_open_channel(true, true);
2169 fn do_encoding_accept_channel(shutdown: bool) {
2170 let secp_ctx = Secp256k1::new();
2171 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2172 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2173 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2174 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2175 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2176 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2177 let accept_channel = msgs::AcceptChannel {
2178 temporary_channel_id: [2; 32],
2179 dust_limit_satoshis: 1311768467284833366,
2180 max_htlc_value_in_flight_msat: 2536655962884945560,
2181 channel_reserve_satoshis: 3608586615801332854,
2182 htlc_minimum_msat: 2316138423780173,
2183 minimum_depth: 821716,
2184 to_self_delay: 49340,
2185 max_accepted_htlcs: 49340,
2186 funding_pubkey: pubkey_1,
2187 revocation_basepoint: pubkey_2,
2188 payment_point: pubkey_3,
2189 delayed_payment_basepoint: pubkey_4,
2190 htlc_basepoint: pubkey_5,
2191 first_per_commitment_point: pubkey_6,
2192 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2194 let encoded_value = accept_channel.encode();
2195 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2197 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2199 assert_eq!(encoded_value, target_value);
2203 fn encoding_accept_channel() {
2204 do_encoding_accept_channel(false);
2205 do_encoding_accept_channel(true);
2209 fn encoding_funding_created() {
2210 let secp_ctx = Secp256k1::new();
2211 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2212 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2213 let funding_created = msgs::FundingCreated {
2214 temporary_channel_id: [2; 32],
2215 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2216 funding_output_index: 255,
2219 let encoded_value = funding_created.encode();
2220 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2221 assert_eq!(encoded_value, target_value);
2225 fn encoding_funding_signed() {
2226 let secp_ctx = Secp256k1::new();
2227 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2228 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2229 let funding_signed = msgs::FundingSigned {
2230 channel_id: [2; 32],
2233 let encoded_value = funding_signed.encode();
2234 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2235 assert_eq!(encoded_value, target_value);
2239 fn encoding_funding_locked() {
2240 let secp_ctx = Secp256k1::new();
2241 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2242 let funding_locked = msgs::FundingLocked {
2243 channel_id: [2; 32],
2244 next_per_commitment_point: pubkey_1,
2246 let encoded_value = funding_locked.encode();
2247 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2248 assert_eq!(encoded_value, target_value);
2251 fn do_encoding_shutdown(script_type: u8) {
2252 let secp_ctx = Secp256k1::new();
2253 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2254 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2255 let shutdown = msgs::Shutdown {
2256 channel_id: [2; 32],
2258 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2259 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2260 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2261 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2263 let encoded_value = shutdown.encode();
2264 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2265 if script_type == 1 {
2266 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2267 } else if script_type == 2 {
2268 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2269 } else if script_type == 3 {
2270 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2271 } else if script_type == 4 {
2272 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2274 assert_eq!(encoded_value, target_value);
2278 fn encoding_shutdown() {
2279 do_encoding_shutdown(1);
2280 do_encoding_shutdown(2);
2281 do_encoding_shutdown(3);
2282 do_encoding_shutdown(4);
2286 fn encoding_closing_signed() {
2287 let secp_ctx = Secp256k1::new();
2288 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2289 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2290 let closing_signed = msgs::ClosingSigned {
2291 channel_id: [2; 32],
2292 fee_satoshis: 2316138423780173,
2295 let encoded_value = closing_signed.encode();
2296 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2297 assert_eq!(encoded_value, target_value);
2301 fn encoding_update_add_htlc() {
2302 let secp_ctx = Secp256k1::new();
2303 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2304 let onion_routing_packet = msgs::OnionPacket {
2306 public_key: Ok(pubkey_1),
2307 hop_data: [1; 20*65],
2310 let update_add_htlc = msgs::UpdateAddHTLC {
2311 channel_id: [2; 32],
2312 htlc_id: 2316138423780173,
2313 amount_msat: 3608586615801332854,
2314 payment_hash: PaymentHash([1; 32]),
2315 cltv_expiry: 821716,
2316 onion_routing_packet
2318 let encoded_value = update_add_htlc.encode();
2319 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2320 assert_eq!(encoded_value, target_value);
2324 fn encoding_update_fulfill_htlc() {
2325 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2326 channel_id: [2; 32],
2327 htlc_id: 2316138423780173,
2328 payment_preimage: PaymentPreimage([1; 32]),
2330 let encoded_value = update_fulfill_htlc.encode();
2331 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2332 assert_eq!(encoded_value, target_value);
2336 fn encoding_update_fail_htlc() {
2337 let reason = OnionErrorPacket {
2338 data: [1; 32].to_vec(),
2340 let update_fail_htlc = msgs::UpdateFailHTLC {
2341 channel_id: [2; 32],
2342 htlc_id: 2316138423780173,
2345 let encoded_value = update_fail_htlc.encode();
2346 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2347 assert_eq!(encoded_value, target_value);
2351 fn encoding_update_fail_malformed_htlc() {
2352 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2353 channel_id: [2; 32],
2354 htlc_id: 2316138423780173,
2355 sha256_of_onion: [1; 32],
2358 let encoded_value = update_fail_malformed_htlc.encode();
2359 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2360 assert_eq!(encoded_value, target_value);
2363 fn do_encoding_commitment_signed(htlcs: bool) {
2364 let secp_ctx = Secp256k1::new();
2365 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2366 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2367 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2368 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2369 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2370 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2371 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2372 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2373 let commitment_signed = msgs::CommitmentSigned {
2374 channel_id: [2; 32],
2376 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2378 let encoded_value = commitment_signed.encode();
2379 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2381 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2383 target_value.append(&mut hex::decode("0000").unwrap());
2385 assert_eq!(encoded_value, target_value);
2389 fn encoding_commitment_signed() {
2390 do_encoding_commitment_signed(true);
2391 do_encoding_commitment_signed(false);
2395 fn encoding_revoke_and_ack() {
2396 let secp_ctx = Secp256k1::new();
2397 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2398 let raa = msgs::RevokeAndACK {
2399 channel_id: [2; 32],
2400 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],
2401 next_per_commitment_point: pubkey_1,
2403 let encoded_value = raa.encode();
2404 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2405 assert_eq!(encoded_value, target_value);
2409 fn encoding_update_fee() {
2410 let update_fee = msgs::UpdateFee {
2411 channel_id: [2; 32],
2412 feerate_per_kw: 20190119,
2414 let encoded_value = update_fee.encode();
2415 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2416 assert_eq!(encoded_value, target_value);
2420 fn encoding_init() {
2421 assert_eq!(msgs::Init {
2422 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2423 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2424 assert_eq!(msgs::Init {
2425 features: InitFeatures::from_le_bytes(vec![0xFF]),
2426 }.encode(), hex::decode("0001ff0001ff").unwrap());
2427 assert_eq!(msgs::Init {
2428 features: InitFeatures::from_le_bytes(vec![]),
2429 }.encode(), hex::decode("00000000").unwrap());
2433 fn encoding_error() {
2434 let error = msgs::ErrorMessage {
2435 channel_id: [2; 32],
2436 data: String::from("rust-lightning"),
2438 let encoded_value = error.encode();
2439 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2440 assert_eq!(encoded_value, target_value);
2444 fn encoding_ping() {
2445 let ping = msgs::Ping {
2449 let encoded_value = ping.encode();
2450 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2451 assert_eq!(encoded_value, target_value);
2455 fn encoding_pong() {
2456 let pong = msgs::Pong {
2459 let encoded_value = pong.encode();
2460 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2461 assert_eq!(encoded_value, target_value);
2465 fn encoding_legacy_onion_hop_data() {
2466 let msg = msgs::OnionHopData {
2467 format: OnionHopDataFormat::Legacy {
2468 short_channel_id: 0xdeadbeef1bad1dea,
2470 amt_to_forward: 0x0badf00d01020304,
2471 outgoing_cltv_value: 0xffffffff,
2473 let encoded_value = msg.encode();
2474 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2475 assert_eq!(encoded_value, target_value);
2479 fn encoding_nonfinal_onion_hop_data() {
2480 let mut msg = msgs::OnionHopData {
2481 format: OnionHopDataFormat::NonFinalNode {
2482 short_channel_id: 0xdeadbeef1bad1dea,
2484 amt_to_forward: 0x0badf00d01020304,
2485 outgoing_cltv_value: 0xffffffff,
2487 let encoded_value = msg.encode();
2488 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2489 assert_eq!(encoded_value, target_value);
2490 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2491 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2492 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2493 } else { panic!(); }
2494 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2495 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2499 fn encoding_final_onion_hop_data() {
2500 let mut msg = msgs::OnionHopData {
2501 format: OnionHopDataFormat::FinalNode {
2504 amt_to_forward: 0x0badf00d01020304,
2505 outgoing_cltv_value: 0xffffffff,
2507 let encoded_value = msg.encode();
2508 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2509 assert_eq!(encoded_value, target_value);
2510 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2511 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2512 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2513 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2517 fn encoding_final_onion_hop_data_with_secret() {
2518 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2519 let mut msg = msgs::OnionHopData {
2520 format: OnionHopDataFormat::FinalNode {
2521 payment_data: Some(FinalOnionHopData {
2522 payment_secret: expected_payment_secret,
2523 total_msat: 0x1badca1f
2526 amt_to_forward: 0x0badf00d01020304,
2527 outgoing_cltv_value: 0xffffffff,
2529 let encoded_value = msg.encode();
2530 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2531 assert_eq!(encoded_value, target_value);
2532 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2533 if let OnionHopDataFormat::FinalNode {
2534 payment_data: Some(FinalOnionHopData {
2536 total_msat: 0x1badca1f
2539 assert_eq!(payment_secret, expected_payment_secret);
2540 } else { panic!(); }
2541 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2542 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2546 fn encoding_query_channel_range() {
2547 let mut query_channel_range = msgs::QueryChannelRange {
2548 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2549 first_blocknum: 100000,
2550 number_of_blocks: 1500,
2552 let encoded_value = query_channel_range.encode();
2553 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2554 assert_eq!(encoded_value, target_value);
2556 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2557 assert_eq!(query_channel_range.first_blocknum, 100000);
2558 assert_eq!(query_channel_range.number_of_blocks, 1500);
2562 fn encoding_reply_channel_range() {
2563 do_encoding_reply_channel_range(0);
2564 do_encoding_reply_channel_range(1);
2567 fn do_encoding_reply_channel_range(encoding_type: u8) {
2568 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2569 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2570 let mut reply_channel_range = msgs::ReplyChannelRange {
2571 chain_hash: expected_chain_hash,
2572 first_blocknum: 756230,
2573 number_of_blocks: 1500,
2574 full_information: true,
2575 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2578 if encoding_type == 0 {
2579 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2580 let encoded_value = reply_channel_range.encode();
2581 assert_eq!(encoded_value, target_value);
2583 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2584 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2585 assert_eq!(reply_channel_range.first_blocknum, 756230);
2586 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2587 assert_eq!(reply_channel_range.full_information, true);
2588 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2589 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2590 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2592 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2593 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2594 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2599 fn encoding_query_short_channel_ids() {
2600 do_encoding_query_short_channel_ids(0);
2601 do_encoding_query_short_channel_ids(1);
2604 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2605 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2606 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2607 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2608 chain_hash: expected_chain_hash,
2609 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2612 if encoding_type == 0 {
2613 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2614 let encoded_value = query_short_channel_ids.encode();
2615 assert_eq!(encoded_value, target_value);
2617 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2618 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2619 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2620 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2621 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2623 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2624 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2625 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2630 fn encoding_reply_short_channel_ids_end() {
2631 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2632 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2633 chain_hash: expected_chain_hash,
2634 full_information: true,
2636 let encoded_value = reply_short_channel_ids_end.encode();
2637 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2638 assert_eq!(encoded_value, target_value);
2640 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2641 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2642 assert_eq!(reply_short_channel_ids_end.full_information, true);
2646 fn encoding_gossip_timestamp_filter(){
2647 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2648 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2649 chain_hash: expected_chain_hash,
2650 first_timestamp: 1590000000,
2651 timestamp_range: 0xffff_ffff,
2653 let encoded_value = gossip_timestamp_filter.encode();
2654 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2655 assert_eq!(encoded_value, target_value);
2657 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2658 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2659 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2660 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);