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.
807 pub trait RoutingMessageHandler : Send + Sync + events::MessageSendEventsProvider {
808 /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
809 /// false or returning an Err otherwise.
810 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, LightningError>;
811 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
812 /// or returning an Err otherwise.
813 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, LightningError>;
814 /// Handle an incoming channel_update message, returning true if it should be forwarded on,
815 /// false or returning an Err otherwise.
816 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
817 /// Handle some updates to the route graph that we learned due to an outbound failed payment.
818 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
819 /// Gets a subset of the channel announcements and updates required to dump our routing table
820 /// to a remote node, starting at the short_channel_id indicated by starting_point and
821 /// including the batch_amount entries immediately higher in numerical value than starting_point.
822 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>;
823 /// Gets a subset of the node announcements required to dump our routing table to a remote node,
824 /// starting at the node *after* the provided publickey and including batch_amount entries
825 /// immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
826 /// If None is provided for starting_point, we start at the first node.
827 fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
828 /// Returns whether a full sync should be requested from a peer.
829 fn should_request_full_sync(&self, node_id: &PublicKey) -> bool;
830 /// Initiates routing gossip sync by querying a peer to discover channels
831 /// and their associated routing gossip messages. This method will use a
832 /// sync strategy defined by the implementor.
833 fn sync_routing_table(&self, their_node_id: &PublicKey);
834 /// Handles the reply of a query we initiated to learn about channels
835 /// for a given range of blocks. We can expect to receive one or more
836 /// replies to a single query.
837 fn handle_reply_channel_range(&self, their_node_id: &PublicKey, msg: &ReplyChannelRange) -> Result<(), LightningError>;
838 /// Handles the reply of a query we initiated asking for routing gossip
839 /// messages for a list of channels. We should receive this message when
840 /// a node has completed its best effort to send us the pertaining routing
842 fn handle_reply_short_channel_ids_end(&self, their_node_id: &PublicKey, msg: &ReplyShortChannelIdsEnd) -> Result<(), LightningError>;
843 /// Handles when a peer asks us to send a list of short_channel_ids
844 /// for the requested range of blocks.
845 fn handle_query_channel_range(&self, their_node_id: &PublicKey, msg: &QueryChannelRange) -> Result<(), LightningError>;
846 /// Handles when a peer asks us to send routing gossip messages for a
847 /// list of short_channel_ids.
848 fn handle_query_short_channel_ids(&self, their_node_id: &PublicKey, msg: &QueryShortChannelIds) -> Result<(), LightningError>;
851 mod fuzzy_internal_msgs {
852 use ln::channelmanager::PaymentSecret;
854 // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
855 // them from untrusted input):
857 pub(crate) struct FinalOnionHopData {
858 pub(crate) payment_secret: PaymentSecret,
859 /// The total value, in msat, of the payment as received by the ultimate recipient.
860 /// Message serialization may panic if this value is more than 21 million Bitcoin.
861 pub(crate) total_msat: u64,
864 pub(crate) enum OnionHopDataFormat {
865 Legacy { // aka Realm-0
866 short_channel_id: u64,
869 short_channel_id: u64,
872 payment_data: Option<FinalOnionHopData>,
876 pub struct OnionHopData {
877 pub(crate) format: OnionHopDataFormat,
878 /// The value, in msat, of the payment after this hop's fee is deducted.
879 /// Message serialization may panic if this value is more than 21 million Bitcoin.
880 pub(crate) amt_to_forward: u64,
881 pub(crate) outgoing_cltv_value: u32,
882 // 12 bytes of 0-padding for Legacy format
885 pub struct DecodedOnionErrorPacket {
886 pub(crate) hmac: [u8; 32],
887 pub(crate) failuremsg: Vec<u8>,
888 pub(crate) pad: Vec<u8>,
891 #[cfg(feature = "fuzztarget")]
892 pub use self::fuzzy_internal_msgs::*;
893 #[cfg(not(feature = "fuzztarget"))]
894 pub(crate) use self::fuzzy_internal_msgs::*;
897 pub(crate) struct OnionPacket {
898 pub(crate) version: u8,
899 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
900 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
901 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
902 pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
903 pub(crate) hop_data: [u8; 20*65],
904 pub(crate) hmac: [u8; 32],
907 impl PartialEq for OnionPacket {
908 fn eq(&self, other: &OnionPacket) -> bool {
909 for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
910 if i != j { return false; }
912 self.version == other.version &&
913 self.public_key == other.public_key &&
914 self.hmac == other.hmac
918 #[derive(Clone, PartialEq)]
919 pub(crate) struct OnionErrorPacket {
920 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
921 // (TODO) We limit it in decode to much lower...
922 pub(crate) data: Vec<u8>,
925 impl fmt::Display for DecodeError {
926 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
928 DecodeError::UnknownVersion => f.write_str("Unknown realm byte in Onion packet"),
929 DecodeError::UnknownRequiredFeature => f.write_str("Unknown required feature preventing decode"),
930 DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"),
931 DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"),
932 DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"),
933 DecodeError::Io(ref e) => e.fmt(f),
938 impl fmt::Debug for LightningError {
939 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
940 f.write_str(self.err.as_str())
944 impl From<::std::io::Error> for DecodeError {
945 fn from(e: ::std::io::Error) -> Self {
946 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
947 DecodeError::ShortRead
954 impl Writeable for OptionalField<Script> {
955 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
957 OptionalField::Present(ref script) => {
958 // Note that Writeable for script includes the 16-bit length tag for us
961 OptionalField::Absent => {}
967 impl Readable for OptionalField<Script> {
968 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
969 match <u16 as Readable>::read(r) {
971 let mut buf = vec![0; len as usize];
972 r.read_exact(&mut buf)?;
973 Ok(OptionalField::Present(Script::from(buf)))
975 Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
981 impl Writeable for OptionalField<u64> {
982 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
984 OptionalField::Present(ref value) => {
987 OptionalField::Absent => {}
993 impl Readable for OptionalField<u64> {
994 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
995 let value: u64 = Readable::read(r)?;
996 Ok(OptionalField::Present(value))
1001 impl_writeable_len_match!(AcceptChannel, {
1002 {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
1005 temporary_channel_id,
1006 dust_limit_satoshis,
1007 max_htlc_value_in_flight_msat,
1008 channel_reserve_satoshis,
1014 revocation_basepoint,
1016 delayed_payment_basepoint,
1018 first_per_commitment_point,
1019 shutdown_scriptpubkey
1022 impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
1029 impl Writeable for ChannelReestablish {
1030 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1031 w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
1032 self.channel_id.write(w)?;
1033 self.next_local_commitment_number.write(w)?;
1034 self.next_remote_commitment_number.write(w)?;
1035 match self.data_loss_protect {
1036 OptionalField::Present(ref data_loss_protect) => {
1037 (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
1038 (*data_loss_protect).my_current_per_commitment_point.write(w)?;
1040 OptionalField::Absent => {}
1046 impl Readable for ChannelReestablish{
1047 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1049 channel_id: Readable::read(r)?,
1050 next_local_commitment_number: Readable::read(r)?,
1051 next_remote_commitment_number: Readable::read(r)?,
1052 data_loss_protect: {
1053 match <[u8; 32] as Readable>::read(r) {
1054 Ok(your_last_per_commitment_secret) =>
1055 OptionalField::Present(DataLossProtect {
1056 your_last_per_commitment_secret,
1057 my_current_per_commitment_point: Readable::read(r)?,
1059 Err(DecodeError::ShortRead) => OptionalField::Absent,
1060 Err(e) => return Err(e)
1067 impl_writeable!(ClosingSigned, 32+8+64, {
1073 impl_writeable_len_match!(CommitmentSigned, {
1074 { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
1081 impl_writeable_len_match!(DecodedOnionErrorPacket, {
1082 { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
1089 impl_writeable!(FundingCreated, 32+32+2+64, {
1090 temporary_channel_id,
1092 funding_output_index,
1096 impl_writeable!(FundingSigned, 32+64, {
1101 impl_writeable!(FundingLocked, 32+33, {
1103 next_per_commitment_point
1106 impl Writeable for Init {
1107 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1108 // global_features gets the bottom 13 bits of our features, and local_features gets all of
1109 // our relevant feature bits. This keeps us compatible with old nodes.
1110 self.features.write_up_to_13(w)?;
1111 self.features.write(w)
1115 impl Readable for Init {
1116 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1117 let global_features: InitFeatures = Readable::read(r)?;
1118 let features: InitFeatures = Readable::read(r)?;
1120 features: features.or(global_features),
1125 impl_writeable_len_match!(OpenChannel, {
1126 { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
1130 temporary_channel_id,
1133 dust_limit_satoshis,
1134 max_htlc_value_in_flight_msat,
1135 channel_reserve_satoshis,
1141 revocation_basepoint,
1143 delayed_payment_basepoint,
1145 first_per_commitment_point,
1147 shutdown_scriptpubkey
1150 impl_writeable!(RevokeAndACK, 32+32+33, {
1152 per_commitment_secret,
1153 next_per_commitment_point
1156 impl_writeable_len_match!(Shutdown, {
1157 { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
1163 impl_writeable_len_match!(UpdateFailHTLC, {
1164 { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
1171 impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
1178 impl_writeable!(UpdateFee, 32+4, {
1183 impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
1189 impl_writeable_len_match!(OnionErrorPacket, {
1190 { OnionErrorPacket { ref data, .. }, 2 + data.len() }
1195 impl Writeable for OnionPacket {
1196 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1197 w.size_hint(1 + 33 + 20*65 + 32);
1198 self.version.write(w)?;
1199 match self.public_key {
1200 Ok(pubkey) => pubkey.write(w)?,
1201 Err(_) => [0u8;33].write(w)?,
1203 w.write_all(&self.hop_data)?;
1204 self.hmac.write(w)?;
1209 impl Readable for OnionPacket {
1210 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1212 version: Readable::read(r)?,
1214 let mut buf = [0u8;33];
1215 r.read_exact(&mut buf)?;
1216 PublicKey::from_slice(&buf)
1218 hop_data: Readable::read(r)?,
1219 hmac: Readable::read(r)?,
1224 impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
1230 onion_routing_packet
1233 impl Writeable for FinalOnionHopData {
1234 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1235 w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
1236 self.payment_secret.0.write(w)?;
1237 HighZeroBytesDroppedVarInt(self.total_msat).write(w)
1241 impl Readable for FinalOnionHopData {
1242 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1243 let secret: [u8; 32] = Readable::read(r)?;
1244 let amt: HighZeroBytesDroppedVarInt<u64> = Readable::read(r)?;
1245 Ok(Self { payment_secret: PaymentSecret(secret), total_msat: amt.0 })
1249 impl Writeable for OnionHopData {
1250 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1252 // Note that this should never be reachable if Rust-Lightning generated the message, as we
1253 // check values are sane long before we get here, though its possible in the future
1254 // user-generated messages may hit this.
1255 if self.amt_to_forward > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1257 OnionHopDataFormat::Legacy { short_channel_id } => {
1259 short_channel_id.write(w)?;
1260 self.amt_to_forward.write(w)?;
1261 self.outgoing_cltv_value.write(w)?;
1262 w.write_all(&[0;12])?;
1264 OnionHopDataFormat::NonFinalNode { short_channel_id } => {
1265 encode_varint_length_prefixed_tlv!(w, {
1266 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1267 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1268 (6, short_channel_id)
1271 OnionHopDataFormat::FinalNode { payment_data: Some(ref final_data) } => {
1272 if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
1273 encode_varint_length_prefixed_tlv!(w, {
1274 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1275 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
1279 OnionHopDataFormat::FinalNode { payment_data: None } => {
1280 encode_varint_length_prefixed_tlv!(w, {
1281 (2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
1282 (4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
1290 impl Readable for OnionHopData {
1291 fn read<R: Read>(mut r: &mut R) -> Result<Self, DecodeError> {
1292 use bitcoin::consensus::encode::{Decodable, Error, VarInt};
1293 let v: VarInt = Decodable::consensus_decode(&mut r)
1294 .map_err(|e| match e {
1295 Error::Io(ioe) => DecodeError::from(ioe),
1296 _ => DecodeError::InvalidValue
1298 const LEGACY_ONION_HOP_FLAG: u64 = 0;
1299 let (format, amt, cltv_value) = if v.0 != LEGACY_ONION_HOP_FLAG {
1300 let mut rd = FixedLengthReader::new(r, v.0);
1301 let mut amt = HighZeroBytesDroppedVarInt(0u64);
1302 let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
1303 let mut short_id: Option<u64> = None;
1304 let mut payment_data: Option<FinalOnionHopData> = None;
1305 decode_tlv!(&mut rd, {
1312 rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
1313 let format = if let Some(short_channel_id) = short_id {
1314 if payment_data.is_some() { return Err(DecodeError::InvalidValue); }
1315 OnionHopDataFormat::NonFinalNode {
1319 if let &Some(ref data) = &payment_data {
1320 if data.total_msat > MAX_VALUE_MSAT {
1321 return Err(DecodeError::InvalidValue);
1324 OnionHopDataFormat::FinalNode {
1328 (format, amt.0, cltv_value.0)
1330 let format = OnionHopDataFormat::Legacy {
1331 short_channel_id: Readable::read(r)?,
1333 let amt: u64 = Readable::read(r)?;
1334 let cltv_value: u32 = Readable::read(r)?;
1335 r.read_exact(&mut [0; 12])?;
1336 (format, amt, cltv_value)
1339 if amt > MAX_VALUE_MSAT {
1340 return Err(DecodeError::InvalidValue);
1344 amt_to_forward: amt,
1345 outgoing_cltv_value: cltv_value,
1350 impl Writeable for Ping {
1351 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1352 w.size_hint(self.byteslen as usize + 4);
1353 self.ponglen.write(w)?;
1354 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1359 impl Readable for Ping {
1360 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1362 ponglen: Readable::read(r)?,
1364 let byteslen = Readable::read(r)?;
1365 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1372 impl Writeable for Pong {
1373 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1374 w.size_hint(self.byteslen as usize + 2);
1375 vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
1380 impl Readable for Pong {
1381 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1384 let byteslen = Readable::read(r)?;
1385 r.read_exact(&mut vec![0u8; byteslen as usize][..])?;
1392 impl Writeable for UnsignedChannelAnnouncement {
1393 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1394 w.size_hint(2 + 2*32 + 4*33 + self.features.byte_count() + self.excess_data.len());
1395 self.features.write(w)?;
1396 self.chain_hash.write(w)?;
1397 self.short_channel_id.write(w)?;
1398 self.node_id_1.write(w)?;
1399 self.node_id_2.write(w)?;
1400 self.bitcoin_key_1.write(w)?;
1401 self.bitcoin_key_2.write(w)?;
1402 w.write_all(&self.excess_data[..])?;
1407 impl Readable for UnsignedChannelAnnouncement {
1408 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1410 features: Readable::read(r)?,
1411 chain_hash: Readable::read(r)?,
1412 short_channel_id: Readable::read(r)?,
1413 node_id_1: Readable::read(r)?,
1414 node_id_2: Readable::read(r)?,
1415 bitcoin_key_1: Readable::read(r)?,
1416 bitcoin_key_2: Readable::read(r)?,
1418 let mut excess_data = vec![];
1419 r.read_to_end(&mut excess_data)?;
1426 impl_writeable_len_match!(ChannelAnnouncement, {
1427 { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
1428 2 + 2*32 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
1432 bitcoin_signature_1,
1433 bitcoin_signature_2,
1437 impl Writeable for UnsignedChannelUpdate {
1438 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1439 let mut size = 64 + self.excess_data.len();
1440 let mut message_flags: u8 = 0;
1441 if let OptionalField::Present(_) = self.htlc_maximum_msat {
1446 self.chain_hash.write(w)?;
1447 self.short_channel_id.write(w)?;
1448 self.timestamp.write(w)?;
1449 let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
1450 all_flags.write(w)?;
1451 self.cltv_expiry_delta.write(w)?;
1452 self.htlc_minimum_msat.write(w)?;
1453 self.fee_base_msat.write(w)?;
1454 self.fee_proportional_millionths.write(w)?;
1455 self.htlc_maximum_msat.write(w)?;
1456 w.write_all(&self.excess_data[..])?;
1461 impl Readable for UnsignedChannelUpdate {
1462 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1463 let has_htlc_maximum_msat;
1465 chain_hash: Readable::read(r)?,
1466 short_channel_id: Readable::read(r)?,
1467 timestamp: Readable::read(r)?,
1469 let flags: u16 = Readable::read(r)?;
1470 let message_flags = flags >> 8;
1471 has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
1474 cltv_expiry_delta: Readable::read(r)?,
1475 htlc_minimum_msat: Readable::read(r)?,
1476 fee_base_msat: Readable::read(r)?,
1477 fee_proportional_millionths: Readable::read(r)?,
1478 htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
1480 let mut excess_data = vec![];
1481 r.read_to_end(&mut excess_data)?;
1488 impl_writeable_len_match!(ChannelUpdate, {
1489 { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
1490 64 + excess_data.len() + 64 }
1496 impl Writeable for ErrorMessage {
1497 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1498 w.size_hint(32 + 2 + self.data.len());
1499 self.channel_id.write(w)?;
1500 (self.data.len() as u16).write(w)?;
1501 w.write_all(self.data.as_bytes())?;
1506 impl Readable for ErrorMessage {
1507 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1509 channel_id: Readable::read(r)?,
1511 let mut sz: usize = <u16 as Readable>::read(r)? as usize;
1512 let mut data = vec![];
1513 let data_len = r.read_to_end(&mut data)?;
1514 sz = cmp::min(data_len, sz);
1515 match String::from_utf8(data[..sz as usize].to_vec()) {
1517 Err(_) => return Err(DecodeError::InvalidValue),
1524 impl Writeable for UnsignedNodeAnnouncement {
1525 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1526 w.size_hint(64 + 76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
1527 self.features.write(w)?;
1528 self.timestamp.write(w)?;
1529 self.node_id.write(w)?;
1530 w.write_all(&self.rgb)?;
1531 self.alias.write(w)?;
1533 let mut addrs_to_encode = self.addresses.clone();
1534 addrs_to_encode.sort_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1535 let mut addr_len = 0;
1536 for addr in &addrs_to_encode {
1537 addr_len += 1 + addr.len();
1539 (addr_len + self.excess_address_data.len() as u16).write(w)?;
1540 for addr in addrs_to_encode {
1543 w.write_all(&self.excess_address_data[..])?;
1544 w.write_all(&self.excess_data[..])?;
1549 impl Readable for UnsignedNodeAnnouncement {
1550 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1551 let features: NodeFeatures = Readable::read(r)?;
1552 let timestamp: u32 = Readable::read(r)?;
1553 let node_id: PublicKey = Readable::read(r)?;
1554 let mut rgb = [0; 3];
1555 r.read_exact(&mut rgb)?;
1556 let alias: [u8; 32] = Readable::read(r)?;
1558 let addr_len: u16 = Readable::read(r)?;
1559 let mut addresses: Vec<NetAddress> = Vec::new();
1560 let mut highest_addr_type = 0;
1561 let mut addr_readpos = 0;
1562 let mut excess = false;
1563 let mut excess_byte = 0;
1565 if addr_len <= addr_readpos { break; }
1566 match Readable::read(r) {
1568 if addr.get_id() < highest_addr_type {
1569 // Addresses must be sorted in increasing order
1570 return Err(DecodeError::InvalidValue);
1572 highest_addr_type = addr.get_id();
1573 if addr_len < addr_readpos + 1 + addr.len() {
1574 return Err(DecodeError::BadLengthDescriptor);
1576 addr_readpos += (1 + addr.len()) as u16;
1577 addresses.push(addr);
1579 Ok(Err(unknown_descriptor)) => {
1581 excess_byte = unknown_descriptor;
1584 Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
1585 Err(e) => return Err(e),
1589 let mut excess_data = vec![];
1590 let excess_address_data = if addr_readpos < addr_len {
1591 let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
1592 r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
1594 excess_address_data[0] = excess_byte;
1599 excess_data.push(excess_byte);
1603 r.read_to_end(&mut excess_data)?;
1604 Ok(UnsignedNodeAnnouncement {
1611 excess_address_data,
1617 impl_writeable_len_match!(NodeAnnouncement, {
1618 { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
1619 64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
1625 impl Readable for QueryShortChannelIds {
1626 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1627 let chain_hash: BlockHash = Readable::read(r)?;
1629 // We expect the encoding_len to always includes the 1-byte
1630 // encoding_type and that short_channel_ids are 8-bytes each
1631 let encoding_len: u16 = Readable::read(r)?;
1632 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1633 return Err(DecodeError::InvalidValue);
1636 // Must be encoding_type=0 uncompressed serialization. We do not
1637 // support encoding_type=1 zlib serialization.
1638 let encoding_type: u8 = Readable::read(r)?;
1639 if encoding_type != EncodingType::Uncompressed as u8 {
1640 return Err(DecodeError::InvalidValue);
1643 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1644 // less the 1-byte encoding_type
1645 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1646 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1647 for _ in 0..short_channel_id_count {
1648 short_channel_ids.push(Readable::read(r)?);
1651 Ok(QueryShortChannelIds {
1658 impl Writeable for QueryShortChannelIds {
1659 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1660 // Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
1661 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1663 w.size_hint(32 + 2 + encoding_len as usize);
1664 self.chain_hash.write(w)?;
1665 encoding_len.write(w)?;
1667 // We only support type=0 uncompressed serialization
1668 (EncodingType::Uncompressed as u8).write(w)?;
1670 for scid in self.short_channel_ids.iter() {
1678 impl Readable for ReplyShortChannelIdsEnd {
1679 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1680 let chain_hash: BlockHash = Readable::read(r)?;
1681 let full_information: bool = Readable::read(r)?;
1682 Ok(ReplyShortChannelIdsEnd {
1689 impl Writeable for ReplyShortChannelIdsEnd {
1690 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1691 w.size_hint(32 + 1);
1692 self.chain_hash.write(w)?;
1693 self.full_information.write(w)?;
1698 impl Readable for QueryChannelRange {
1699 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1700 let chain_hash: BlockHash = Readable::read(r)?;
1701 let first_blocknum: u32 = Readable::read(r)?;
1702 let number_of_blocks: u32 = Readable::read(r)?;
1703 Ok(QueryChannelRange {
1711 impl Writeable for QueryChannelRange {
1712 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1713 w.size_hint(32 + 4 + 4);
1714 self.chain_hash.write(w)?;
1715 self.first_blocknum.write(w)?;
1716 self.number_of_blocks.write(w)?;
1721 impl Readable for ReplyChannelRange {
1722 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1723 let chain_hash: BlockHash = Readable::read(r)?;
1724 let first_blocknum: u32 = Readable::read(r)?;
1725 let number_of_blocks: u32 = Readable::read(r)?;
1726 let full_information: bool = Readable::read(r)?;
1728 // We expect the encoding_len to always includes the 1-byte
1729 // encoding_type and that short_channel_ids are 8-bytes each
1730 let encoding_len: u16 = Readable::read(r)?;
1731 if encoding_len == 0 || (encoding_len - 1) % 8 != 0 {
1732 return Err(DecodeError::InvalidValue);
1735 // Must be encoding_type=0 uncompressed serialization. We do not
1736 // support encoding_type=1 zlib serialization.
1737 let encoding_type: u8 = Readable::read(r)?;
1738 if encoding_type != EncodingType::Uncompressed as u8 {
1739 return Err(DecodeError::InvalidValue);
1742 // Read short_channel_ids (8-bytes each), for the u16 encoding_len
1743 // less the 1-byte encoding_type
1744 let short_channel_id_count: u16 = (encoding_len - 1)/8;
1745 let mut short_channel_ids = Vec::with_capacity(short_channel_id_count as usize);
1746 for _ in 0..short_channel_id_count {
1747 short_channel_ids.push(Readable::read(r)?);
1750 Ok(ReplyChannelRange {
1760 impl Writeable for ReplyChannelRange {
1761 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1762 let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
1763 w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
1764 self.chain_hash.write(w)?;
1765 self.first_blocknum.write(w)?;
1766 self.number_of_blocks.write(w)?;
1767 self.full_information.write(w)?;
1769 encoding_len.write(w)?;
1770 (EncodingType::Uncompressed as u8).write(w)?;
1771 for scid in self.short_channel_ids.iter() {
1779 impl Readable for GossipTimestampFilter {
1780 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
1781 let chain_hash: BlockHash = Readable::read(r)?;
1782 let first_timestamp: u32 = Readable::read(r)?;
1783 let timestamp_range: u32 = Readable::read(r)?;
1784 Ok(GossipTimestampFilter {
1792 impl Writeable for GossipTimestampFilter {
1793 fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
1794 w.size_hint(32 + 4 + 4);
1795 self.chain_hash.write(w)?;
1796 self.first_timestamp.write(w)?;
1797 self.timestamp_range.write(w)?;
1807 use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
1808 use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret};
1809 use util::ser::{Writeable, Readable};
1811 use bitcoin::hashes::hex::FromHex;
1812 use bitcoin::util::address::Address;
1813 use bitcoin::network::constants::Network;
1814 use bitcoin::blockdata::script::Builder;
1815 use bitcoin::blockdata::opcodes;
1816 use bitcoin::hash_types::{Txid, BlockHash};
1818 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
1819 use bitcoin::secp256k1::{Secp256k1, Message};
1821 use std::io::Cursor;
1824 fn encoding_channel_reestablish_no_secret() {
1825 let cr = msgs::ChannelReestablish {
1826 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],
1827 next_local_commitment_number: 3,
1828 next_remote_commitment_number: 4,
1829 data_loss_protect: OptionalField::Absent,
1832 let encoded_value = cr.encode();
1835 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]
1840 fn encoding_channel_reestablish_with_secret() {
1842 let secp_ctx = Secp256k1::new();
1843 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1846 let cr = msgs::ChannelReestablish {
1847 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],
1848 next_local_commitment_number: 3,
1849 next_remote_commitment_number: 4,
1850 data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1853 let encoded_value = cr.encode();
1856 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]
1860 macro_rules! get_keys_from {
1861 ($slice: expr, $secp_ctx: expr) => {
1863 let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
1864 let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
1870 macro_rules! get_sig_on {
1871 ($privkey: expr, $ctx: expr, $string: expr) => {
1873 let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
1874 $ctx.sign(&sighash, &$privkey)
1880 fn encoding_announcement_signatures() {
1881 let secp_ctx = Secp256k1::new();
1882 let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1883 let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
1884 let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
1885 let announcement_signatures = msgs::AnnouncementSignatures {
1886 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],
1887 short_channel_id: 2316138423780173,
1888 node_signature: sig_1,
1889 bitcoin_signature: sig_2,
1892 let encoded_value = announcement_signatures.encode();
1893 assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
1896 fn do_encoding_channel_announcement(unknown_features_bits: bool, excess_data: bool) {
1897 let secp_ctx = Secp256k1::new();
1898 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1899 let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
1900 let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
1901 let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
1902 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1903 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
1904 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
1905 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
1906 let mut features = ChannelFeatures::known();
1907 if unknown_features_bits {
1908 features = ChannelFeatures::from_le_bytes(vec![0xFF, 0xFF]);
1910 let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
1912 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
1913 short_channel_id: 2316138423780173,
1914 node_id_1: pubkey_1,
1915 node_id_2: pubkey_2,
1916 bitcoin_key_1: pubkey_3,
1917 bitcoin_key_2: pubkey_4,
1918 excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
1920 let channel_announcement = msgs::ChannelAnnouncement {
1921 node_signature_1: sig_1,
1922 node_signature_2: sig_2,
1923 bitcoin_signature_1: sig_3,
1924 bitcoin_signature_2: sig_4,
1925 contents: unsigned_channel_announcement,
1927 let encoded_value = channel_announcement.encode();
1928 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
1929 if unknown_features_bits {
1930 target_value.append(&mut hex::decode("0002ffff").unwrap());
1932 target_value.append(&mut hex::decode("0000").unwrap());
1934 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
1935 target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
1937 target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
1939 assert_eq!(encoded_value, target_value);
1943 fn encoding_channel_announcement() {
1944 do_encoding_channel_announcement(true, false);
1945 do_encoding_channel_announcement(false, true);
1946 do_encoding_channel_announcement(false, false);
1947 do_encoding_channel_announcement(true, true);
1950 fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
1951 let secp_ctx = Secp256k1::new();
1952 let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
1953 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
1954 let features = if unknown_features_bits {
1955 NodeFeatures::from_le_bytes(vec![0xFF, 0xFF])
1957 // Set to some features we may support
1958 NodeFeatures::from_le_bytes(vec![2 | 1 << 5])
1960 let mut addresses = Vec::new();
1962 addresses.push(msgs::NetAddress::IPv4 {
1963 addr: [255, 254, 253, 252],
1968 addresses.push(msgs::NetAddress::IPv6 {
1969 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
1974 addresses.push(msgs::NetAddress::OnionV2 {
1975 addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
1980 addresses.push(msgs::NetAddress::OnionV3 {
1981 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],
1987 let mut addr_len = 0;
1988 for addr in &addresses {
1989 addr_len += addr.len() + 1;
1991 let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
1993 timestamp: 20190119,
1998 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() },
1999 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() },
2001 addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
2002 let node_announcement = msgs::NodeAnnouncement {
2004 contents: unsigned_node_announcement,
2006 let encoded_value = node_announcement.encode();
2007 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2008 if unknown_features_bits {
2009 target_value.append(&mut hex::decode("0002ffff").unwrap());
2011 target_value.append(&mut hex::decode("000122").unwrap());
2013 target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
2014 target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
2016 target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
2019 target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
2022 target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
2025 target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
2027 if excess_address_data {
2028 target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
2031 target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2033 assert_eq!(encoded_value, target_value);
2037 fn encoding_node_announcement() {
2038 do_encoding_node_announcement(true, true, true, true, true, true, true);
2039 do_encoding_node_announcement(false, false, false, false, false, false, false);
2040 do_encoding_node_announcement(false, true, false, false, false, false, false);
2041 do_encoding_node_announcement(false, false, true, false, false, false, false);
2042 do_encoding_node_announcement(false, false, false, true, false, false, false);
2043 do_encoding_node_announcement(false, false, false, false, true, false, false);
2044 do_encoding_node_announcement(false, false, false, false, false, true, false);
2045 do_encoding_node_announcement(false, true, false, true, false, true, false);
2046 do_encoding_node_announcement(false, false, true, false, true, false, false);
2049 fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: bool) {
2050 let secp_ctx = Secp256k1::new();
2051 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2052 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2053 let unsigned_channel_update = msgs::UnsignedChannelUpdate {
2054 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2055 short_channel_id: 2316138423780173,
2056 timestamp: 20190119,
2057 flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
2058 cltv_expiry_delta: 144,
2059 htlc_minimum_msat: 1000000,
2060 htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
2061 fee_base_msat: 10000,
2062 fee_proportional_millionths: 20,
2063 excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
2065 let channel_update = msgs::ChannelUpdate {
2067 contents: unsigned_channel_update
2069 let encoded_value = channel_update.encode();
2070 let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2071 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2072 target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
2073 if htlc_maximum_msat {
2074 target_value.append(&mut hex::decode("01").unwrap());
2076 target_value.append(&mut hex::decode("00").unwrap());
2078 target_value.append(&mut hex::decode("00").unwrap());
2080 let flag = target_value.last_mut().unwrap();
2084 let flag = target_value.last_mut().unwrap();
2085 *flag = *flag | 1 << 1;
2087 target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
2088 if htlc_maximum_msat {
2089 target_value.append(&mut hex::decode("0000777788889999").unwrap());
2092 target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
2094 assert_eq!(encoded_value, target_value);
2098 fn encoding_channel_update() {
2099 do_encoding_channel_update(false, false, false, false);
2100 do_encoding_channel_update(false, false, false, true);
2101 do_encoding_channel_update(true, false, false, false);
2102 do_encoding_channel_update(true, false, false, true);
2103 do_encoding_channel_update(false, true, false, false);
2104 do_encoding_channel_update(false, true, false, true);
2105 do_encoding_channel_update(false, false, true, false);
2106 do_encoding_channel_update(false, false, true, true);
2107 do_encoding_channel_update(true, true, true, false);
2108 do_encoding_channel_update(true, true, true, true);
2111 fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
2112 let secp_ctx = Secp256k1::new();
2113 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2114 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2115 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2116 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2117 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2118 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2119 let open_channel = msgs::OpenChannel {
2120 chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
2121 temporary_channel_id: [2; 32],
2122 funding_satoshis: 1311768467284833366,
2123 push_msat: 2536655962884945560,
2124 dust_limit_satoshis: 3608586615801332854,
2125 max_htlc_value_in_flight_msat: 8517154655701053848,
2126 channel_reserve_satoshis: 8665828695742877976,
2127 htlc_minimum_msat: 2316138423780173,
2128 feerate_per_kw: 821716,
2129 to_self_delay: 49340,
2130 max_accepted_htlcs: 49340,
2131 funding_pubkey: pubkey_1,
2132 revocation_basepoint: pubkey_2,
2133 payment_point: pubkey_3,
2134 delayed_payment_basepoint: pubkey_4,
2135 htlc_basepoint: pubkey_5,
2136 first_per_commitment_point: pubkey_6,
2137 channel_flags: if random_bit { 1 << 5 } else { 0 },
2138 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2140 let encoded_value = open_channel.encode();
2141 let mut target_value = Vec::new();
2142 target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
2143 target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
2145 target_value.append(&mut hex::decode("20").unwrap());
2147 target_value.append(&mut hex::decode("00").unwrap());
2150 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2152 assert_eq!(encoded_value, target_value);
2156 fn encoding_open_channel() {
2157 do_encoding_open_channel(false, false);
2158 do_encoding_open_channel(true, false);
2159 do_encoding_open_channel(false, true);
2160 do_encoding_open_channel(true, true);
2163 fn do_encoding_accept_channel(shutdown: bool) {
2164 let secp_ctx = Secp256k1::new();
2165 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2166 let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2167 let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2168 let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2169 let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
2170 let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
2171 let accept_channel = msgs::AcceptChannel {
2172 temporary_channel_id: [2; 32],
2173 dust_limit_satoshis: 1311768467284833366,
2174 max_htlc_value_in_flight_msat: 2536655962884945560,
2175 channel_reserve_satoshis: 3608586615801332854,
2176 htlc_minimum_msat: 2316138423780173,
2177 minimum_depth: 821716,
2178 to_self_delay: 49340,
2179 max_accepted_htlcs: 49340,
2180 funding_pubkey: pubkey_1,
2181 revocation_basepoint: pubkey_2,
2182 payment_point: pubkey_3,
2183 delayed_payment_basepoint: pubkey_4,
2184 htlc_basepoint: pubkey_5,
2185 first_per_commitment_point: pubkey_6,
2186 shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
2188 let encoded_value = accept_channel.encode();
2189 let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
2191 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2193 assert_eq!(encoded_value, target_value);
2197 fn encoding_accept_channel() {
2198 do_encoding_accept_channel(false);
2199 do_encoding_accept_channel(true);
2203 fn encoding_funding_created() {
2204 let secp_ctx = Secp256k1::new();
2205 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2206 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2207 let funding_created = msgs::FundingCreated {
2208 temporary_channel_id: [2; 32],
2209 funding_txid: Txid::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
2210 funding_output_index: 255,
2213 let encoded_value = funding_created.encode();
2214 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2215 assert_eq!(encoded_value, target_value);
2219 fn encoding_funding_signed() {
2220 let secp_ctx = Secp256k1::new();
2221 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2222 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2223 let funding_signed = msgs::FundingSigned {
2224 channel_id: [2; 32],
2227 let encoded_value = funding_signed.encode();
2228 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2229 assert_eq!(encoded_value, target_value);
2233 fn encoding_funding_locked() {
2234 let secp_ctx = Secp256k1::new();
2235 let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2236 let funding_locked = msgs::FundingLocked {
2237 channel_id: [2; 32],
2238 next_per_commitment_point: pubkey_1,
2240 let encoded_value = funding_locked.encode();
2241 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2242 assert_eq!(encoded_value, target_value);
2245 fn do_encoding_shutdown(script_type: u8) {
2246 let secp_ctx = Secp256k1::new();
2247 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2248 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
2249 let shutdown = msgs::Shutdown {
2250 channel_id: [2; 32],
2252 if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() }
2253 else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() }
2254 else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).unwrap().script_pubkey() }
2255 else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
2257 let encoded_value = shutdown.encode();
2258 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
2259 if script_type == 1 {
2260 target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
2261 } else if script_type == 2 {
2262 target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
2263 } else if script_type == 3 {
2264 target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
2265 } else if script_type == 4 {
2266 target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
2268 assert_eq!(encoded_value, target_value);
2272 fn encoding_shutdown() {
2273 do_encoding_shutdown(1);
2274 do_encoding_shutdown(2);
2275 do_encoding_shutdown(3);
2276 do_encoding_shutdown(4);
2280 fn encoding_closing_signed() {
2281 let secp_ctx = Secp256k1::new();
2282 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2283 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2284 let closing_signed = msgs::ClosingSigned {
2285 channel_id: [2; 32],
2286 fee_satoshis: 2316138423780173,
2289 let encoded_value = closing_signed.encode();
2290 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2291 assert_eq!(encoded_value, target_value);
2295 fn encoding_update_add_htlc() {
2296 let secp_ctx = Secp256k1::new();
2297 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2298 let onion_routing_packet = msgs::OnionPacket {
2300 public_key: Ok(pubkey_1),
2301 hop_data: [1; 20*65],
2304 let update_add_htlc = msgs::UpdateAddHTLC {
2305 channel_id: [2; 32],
2306 htlc_id: 2316138423780173,
2307 amount_msat: 3608586615801332854,
2308 payment_hash: PaymentHash([1; 32]),
2309 cltv_expiry: 821716,
2310 onion_routing_packet
2312 let encoded_value = update_add_htlc.encode();
2313 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
2314 assert_eq!(encoded_value, target_value);
2318 fn encoding_update_fulfill_htlc() {
2319 let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
2320 channel_id: [2; 32],
2321 htlc_id: 2316138423780173,
2322 payment_preimage: PaymentPreimage([1; 32]),
2324 let encoded_value = update_fulfill_htlc.encode();
2325 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
2326 assert_eq!(encoded_value, target_value);
2330 fn encoding_update_fail_htlc() {
2331 let reason = OnionErrorPacket {
2332 data: [1; 32].to_vec(),
2334 let update_fail_htlc = msgs::UpdateFailHTLC {
2335 channel_id: [2; 32],
2336 htlc_id: 2316138423780173,
2339 let encoded_value = update_fail_htlc.encode();
2340 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
2341 assert_eq!(encoded_value, target_value);
2345 fn encoding_update_fail_malformed_htlc() {
2346 let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
2347 channel_id: [2; 32],
2348 htlc_id: 2316138423780173,
2349 sha256_of_onion: [1; 32],
2352 let encoded_value = update_fail_malformed_htlc.encode();
2353 let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
2354 assert_eq!(encoded_value, target_value);
2357 fn do_encoding_commitment_signed(htlcs: bool) {
2358 let secp_ctx = Secp256k1::new();
2359 let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2360 let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
2361 let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
2362 let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
2363 let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
2364 let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
2365 let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
2366 let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
2367 let commitment_signed = msgs::CommitmentSigned {
2368 channel_id: [2; 32],
2370 htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
2372 let encoded_value = commitment_signed.encode();
2373 let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
2375 target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
2377 target_value.append(&mut hex::decode("0000").unwrap());
2379 assert_eq!(encoded_value, target_value);
2383 fn encoding_commitment_signed() {
2384 do_encoding_commitment_signed(true);
2385 do_encoding_commitment_signed(false);
2389 fn encoding_revoke_and_ack() {
2390 let secp_ctx = Secp256k1::new();
2391 let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
2392 let raa = msgs::RevokeAndACK {
2393 channel_id: [2; 32],
2394 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],
2395 next_per_commitment_point: pubkey_1,
2397 let encoded_value = raa.encode();
2398 let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
2399 assert_eq!(encoded_value, target_value);
2403 fn encoding_update_fee() {
2404 let update_fee = msgs::UpdateFee {
2405 channel_id: [2; 32],
2406 feerate_per_kw: 20190119,
2408 let encoded_value = update_fee.encode();
2409 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
2410 assert_eq!(encoded_value, target_value);
2414 fn encoding_init() {
2415 assert_eq!(msgs::Init {
2416 features: InitFeatures::from_le_bytes(vec![0xFF, 0xFF, 0xFF]),
2417 }.encode(), hex::decode("00023fff0003ffffff").unwrap());
2418 assert_eq!(msgs::Init {
2419 features: InitFeatures::from_le_bytes(vec![0xFF]),
2420 }.encode(), hex::decode("0001ff0001ff").unwrap());
2421 assert_eq!(msgs::Init {
2422 features: InitFeatures::from_le_bytes(vec![]),
2423 }.encode(), hex::decode("00000000").unwrap());
2427 fn encoding_error() {
2428 let error = msgs::ErrorMessage {
2429 channel_id: [2; 32],
2430 data: String::from("rust-lightning"),
2432 let encoded_value = error.encode();
2433 let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
2434 assert_eq!(encoded_value, target_value);
2438 fn encoding_ping() {
2439 let ping = msgs::Ping {
2443 let encoded_value = ping.encode();
2444 let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2445 assert_eq!(encoded_value, target_value);
2449 fn encoding_pong() {
2450 let pong = msgs::Pong {
2453 let encoded_value = pong.encode();
2454 let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
2455 assert_eq!(encoded_value, target_value);
2459 fn encoding_legacy_onion_hop_data() {
2460 let msg = msgs::OnionHopData {
2461 format: OnionHopDataFormat::Legacy {
2462 short_channel_id: 0xdeadbeef1bad1dea,
2464 amt_to_forward: 0x0badf00d01020304,
2465 outgoing_cltv_value: 0xffffffff,
2467 let encoded_value = msg.encode();
2468 let target_value = hex::decode("00deadbeef1bad1dea0badf00d01020304ffffffff000000000000000000000000").unwrap();
2469 assert_eq!(encoded_value, target_value);
2473 fn encoding_nonfinal_onion_hop_data() {
2474 let mut msg = msgs::OnionHopData {
2475 format: OnionHopDataFormat::NonFinalNode {
2476 short_channel_id: 0xdeadbeef1bad1dea,
2478 amt_to_forward: 0x0badf00d01020304,
2479 outgoing_cltv_value: 0xffffffff,
2481 let encoded_value = msg.encode();
2482 let target_value = hex::decode("1a02080badf00d010203040404ffffffff0608deadbeef1bad1dea").unwrap();
2483 assert_eq!(encoded_value, target_value);
2484 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2485 if let OnionHopDataFormat::NonFinalNode { short_channel_id } = msg.format {
2486 assert_eq!(short_channel_id, 0xdeadbeef1bad1dea);
2487 } else { panic!(); }
2488 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2489 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2493 fn encoding_final_onion_hop_data() {
2494 let mut msg = msgs::OnionHopData {
2495 format: OnionHopDataFormat::FinalNode {
2498 amt_to_forward: 0x0badf00d01020304,
2499 outgoing_cltv_value: 0xffffffff,
2501 let encoded_value = msg.encode();
2502 let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
2503 assert_eq!(encoded_value, target_value);
2504 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2505 if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
2506 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2507 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2511 fn encoding_final_onion_hop_data_with_secret() {
2512 let expected_payment_secret = PaymentSecret([0x42u8; 32]);
2513 let mut msg = msgs::OnionHopData {
2514 format: OnionHopDataFormat::FinalNode {
2515 payment_data: Some(FinalOnionHopData {
2516 payment_secret: expected_payment_secret,
2517 total_msat: 0x1badca1f
2520 amt_to_forward: 0x0badf00d01020304,
2521 outgoing_cltv_value: 0xffffffff,
2523 let encoded_value = msg.encode();
2524 let target_value = hex::decode("3602080badf00d010203040404ffffffff082442424242424242424242424242424242424242424242424242424242424242421badca1f").unwrap();
2525 assert_eq!(encoded_value, target_value);
2526 msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2527 if let OnionHopDataFormat::FinalNode {
2528 payment_data: Some(FinalOnionHopData {
2530 total_msat: 0x1badca1f
2533 assert_eq!(payment_secret, expected_payment_secret);
2534 } else { panic!(); }
2535 assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
2536 assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
2540 fn encoding_query_channel_range() {
2541 let mut query_channel_range = msgs::QueryChannelRange {
2542 chain_hash: BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap(),
2543 first_blocknum: 100000,
2544 number_of_blocks: 1500,
2546 let encoded_value = query_channel_range.encode();
2547 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000186a0000005dc").unwrap();
2548 assert_eq!(encoded_value, target_value);
2550 query_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2551 assert_eq!(query_channel_range.first_blocknum, 100000);
2552 assert_eq!(query_channel_range.number_of_blocks, 1500);
2556 fn encoding_reply_channel_range() {
2557 do_encoding_reply_channel_range(0);
2558 do_encoding_reply_channel_range(1);
2561 fn do_encoding_reply_channel_range(encoding_type: u8) {
2562 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206000b8a06000005dc01").unwrap();
2563 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2564 let mut reply_channel_range = msgs::ReplyChannelRange {
2565 chain_hash: expected_chain_hash,
2566 first_blocknum: 756230,
2567 number_of_blocks: 1500,
2568 full_information: true,
2569 short_channel_ids: vec![0x000000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2572 if encoding_type == 0 {
2573 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2574 let encoded_value = reply_channel_range.encode();
2575 assert_eq!(encoded_value, target_value);
2577 reply_channel_range = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2578 assert_eq!(reply_channel_range.chain_hash, expected_chain_hash);
2579 assert_eq!(reply_channel_range.first_blocknum, 756230);
2580 assert_eq!(reply_channel_range.number_of_blocks, 1500);
2581 assert_eq!(reply_channel_range.full_information, true);
2582 assert_eq!(reply_channel_range.short_channel_ids[0], 0x000000000000008e);
2583 assert_eq!(reply_channel_range.short_channel_ids[1], 0x0000000000003c69);
2584 assert_eq!(reply_channel_range.short_channel_ids[2], 0x000000000045a6c4);
2586 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2587 let result: Result<msgs::ReplyChannelRange, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2588 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2593 fn encoding_query_short_channel_ids() {
2594 do_encoding_query_short_channel_ids(0);
2595 do_encoding_query_short_channel_ids(1);
2598 fn do_encoding_query_short_channel_ids(encoding_type: u8) {
2599 let mut target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206").unwrap();
2600 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2601 let mut query_short_channel_ids = msgs::QueryShortChannelIds {
2602 chain_hash: expected_chain_hash,
2603 short_channel_ids: vec![0x0000000000008e, 0x0000000000003c69, 0x000000000045a6c4],
2606 if encoding_type == 0 {
2607 target_value.append(&mut hex::decode("001900000000000000008e0000000000003c69000000000045a6c4").unwrap());
2608 let encoded_value = query_short_channel_ids.encode();
2609 assert_eq!(encoded_value, target_value);
2611 query_short_channel_ids = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2612 assert_eq!(query_short_channel_ids.chain_hash, expected_chain_hash);
2613 assert_eq!(query_short_channel_ids.short_channel_ids[0], 0x000000000000008e);
2614 assert_eq!(query_short_channel_ids.short_channel_ids[1], 0x0000000000003c69);
2615 assert_eq!(query_short_channel_ids.short_channel_ids[2], 0x000000000045a6c4);
2617 target_value.append(&mut hex::decode("001601789c636000833e08659309a65878be010010a9023a").unwrap());
2618 let result: Result<msgs::QueryShortChannelIds, msgs::DecodeError> = Readable::read(&mut Cursor::new(&target_value[..]));
2619 assert!(result.is_err(), "Expected decode failure with unsupported zlib encoding");
2624 fn encoding_reply_short_channel_ids_end() {
2625 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2626 let mut reply_short_channel_ids_end = msgs::ReplyShortChannelIdsEnd {
2627 chain_hash: expected_chain_hash,
2628 full_information: true,
2630 let encoded_value = reply_short_channel_ids_end.encode();
2631 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e220601").unwrap();
2632 assert_eq!(encoded_value, target_value);
2634 reply_short_channel_ids_end = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2635 assert_eq!(reply_short_channel_ids_end.chain_hash, expected_chain_hash);
2636 assert_eq!(reply_short_channel_ids_end.full_information, true);
2640 fn encoding_gossip_timestamp_filter(){
2641 let expected_chain_hash = BlockHash::from_hex("06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f").unwrap();
2642 let mut gossip_timestamp_filter = msgs::GossipTimestampFilter {
2643 chain_hash: expected_chain_hash,
2644 first_timestamp: 1590000000,
2645 timestamp_range: 0xffff_ffff,
2647 let encoded_value = gossip_timestamp_filter.encode();
2648 let target_value = hex::decode("0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e22065ec57980ffffffff").unwrap();
2649 assert_eq!(encoded_value, target_value);
2651 gossip_timestamp_filter = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
2652 assert_eq!(gossip_timestamp_filter.chain_hash, expected_chain_hash);
2653 assert_eq!(gossip_timestamp_filter.first_timestamp, 1590000000);
2654 assert_eq!(gossip_timestamp_filter.timestamp_range, 0xffff_ffff);