1 use secp256k1::key::PublicKey;
2 use secp256k1::{Secp256k1, Signature};
4 use bitcoin::util::hash::Sha256dHash;
5 use bitcoin::network::serialize::{deserialize,serialize};
6 use bitcoin::blockdata::script::Script;
10 use std::result::Result;
12 use util::{byte_utils, internal_traits, events};
14 pub trait MsgEncodable {
15 fn encode(&self) -> Vec<u8>;
17 fn encoded_len(&self) -> usize { self.encode().len() }
19 fn encode_with_len(&self) -> Vec<u8> {
20 let enc = self.encode();
21 let mut res = Vec::with_capacity(enc.len() + 2);
22 res.extend_from_slice(&byte_utils::be16_to_array(enc.len() as u16));
23 res.extend_from_slice(&enc);
28 pub enum DecodeError {
29 /// Unknown realm byte in an OnionHopData packet
31 /// Unknown feature mandating we fail to parse message
32 UnknownRequiredFeature,
33 /// Failed to decode a public key (ie it's invalid)
35 /// Failed to decode a signature (ie it's invalid)
37 /// Value expected to be text wasn't decodable as text
41 /// node_announcement included more than one address of a given type!
42 ExtraAddressesPerType,
43 /// A length descriptor in the packet didn't describe the later data correctly
44 /// (currently only generated in node_announcement)
46 /// Error from std::io
48 /// Invalid value found when decoding
51 pub trait MsgDecodable: Sized {
52 fn decode(v: &[u8]) -> Result<Self, DecodeError>;
55 /// Tracks localfeatures which are only in init messages
56 #[derive(Clone, PartialEq)]
57 pub struct LocalFeatures {
62 pub fn new() -> LocalFeatures {
68 pub fn supports_data_loss_protect(&self) -> bool {
69 self.flags.len() > 0 && (self.flags[0] & 3) != 0
71 pub fn requires_data_loss_protect(&self) -> bool {
72 self.flags.len() > 0 && (self.flags[0] & 1) != 0
75 pub fn initial_routing_sync(&self) -> bool {
76 self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0
78 pub fn set_initial_routing_sync(&mut self) {
79 if self.flags.len() == 0 {
80 self.flags.resize(1, 1 << 3);
82 self.flags[0] |= 1 << 3;
86 pub fn supports_upfront_shutdown_script(&self) -> bool {
87 self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0
89 pub fn requires_upfront_shutdown_script(&self) -> bool {
90 self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0
93 pub fn requires_unknown_bits(&self) -> bool {
94 for (idx, &byte) in self.flags.iter().enumerate() {
95 if idx != 0 && (byte & 0x55) != 0 {
97 } else if idx == 0 && (byte & 0x14) != 0 {
104 pub fn supports_unknown_bits(&self) -> bool {
105 for (idx, &byte) in self.flags.iter().enumerate() {
106 if idx != 0 && byte != 0 {
108 } else if idx == 0 && (byte & 0xc4) != 0 {
116 /// Tracks globalfeatures which are in init messages and routing announcements
117 #[derive(Clone, PartialEq)]
118 pub struct GlobalFeatures {
122 impl GlobalFeatures {
123 pub fn new() -> GlobalFeatures {
129 pub fn requires_unknown_bits(&self) -> bool {
130 for &byte in self.flags.iter() {
131 if (byte & 0x55) != 0 {
138 pub fn supports_unknown_bits(&self) -> bool {
139 for &byte in self.flags.iter() {
149 pub global_features: GlobalFeatures,
150 pub local_features: LocalFeatures,
153 pub struct ErrorMessage {
154 pub channel_id: [u8; 32],
167 pub struct OpenChannel {
168 pub chain_hash: Sha256dHash,
169 pub temporary_channel_id: [u8; 32],
170 pub funding_satoshis: u64,
172 pub dust_limit_satoshis: u64,
173 pub max_htlc_value_in_flight_msat: u64,
174 pub channel_reserve_satoshis: u64,
175 pub htlc_minimum_msat: u64,
176 pub feerate_per_kw: u32,
177 pub to_self_delay: u16,
178 pub max_accepted_htlcs: u16,
179 pub funding_pubkey: PublicKey,
180 pub revocation_basepoint: PublicKey,
181 pub payment_basepoint: PublicKey,
182 pub delayed_payment_basepoint: PublicKey,
183 pub htlc_basepoint: PublicKey,
184 pub first_per_commitment_point: PublicKey,
185 pub channel_flags: u8,
186 pub shutdown_scriptpubkey: Option<Script>,
189 pub struct AcceptChannel {
190 pub temporary_channel_id: [u8; 32],
191 pub dust_limit_satoshis: u64,
192 pub max_htlc_value_in_flight_msat: u64,
193 pub channel_reserve_satoshis: u64,
194 pub htlc_minimum_msat: u64,
195 pub minimum_depth: u32,
196 pub to_self_delay: u16,
197 pub max_accepted_htlcs: u16,
198 pub funding_pubkey: PublicKey,
199 pub revocation_basepoint: PublicKey,
200 pub payment_basepoint: PublicKey,
201 pub delayed_payment_basepoint: PublicKey,
202 pub htlc_basepoint: PublicKey,
203 pub first_per_commitment_point: PublicKey,
204 pub shutdown_scriptpubkey: Option<Script>,
207 pub struct FundingCreated {
208 pub temporary_channel_id: [u8; 32],
209 pub funding_txid: Sha256dHash,
210 pub funding_output_index: u16,
211 pub signature: Signature,
214 pub struct FundingSigned {
215 pub channel_id: [u8; 32],
216 pub signature: Signature,
219 pub struct FundingLocked {
220 pub channel_id: [u8; 32],
221 pub next_per_commitment_point: PublicKey,
224 pub struct Shutdown {
225 pub channel_id: [u8; 32],
226 pub scriptpubkey: Script,
229 pub struct ClosingSigned {
230 pub channel_id: [u8; 32],
231 pub fee_satoshis: u64,
232 pub signature: Signature,
236 pub struct UpdateAddHTLC {
237 pub channel_id: [u8; 32],
239 pub amount_msat: u64,
240 pub payment_hash: [u8; 32],
241 pub cltv_expiry: u32,
242 pub onion_routing_packet: OnionPacket,
246 pub struct UpdateFulfillHTLC {
247 pub channel_id: [u8; 32],
249 pub payment_preimage: [u8; 32],
253 pub struct UpdateFailHTLC {
254 pub channel_id: [u8; 32],
256 pub reason: OnionErrorPacket,
260 pub struct UpdateFailMalformedHTLC {
261 pub channel_id: [u8; 32],
263 pub sha256_of_onion: [u8; 32],
264 pub failure_code: u16,
268 pub struct CommitmentSigned {
269 pub channel_id: [u8; 32],
270 pub signature: Signature,
271 pub htlc_signatures: Vec<Signature>,
274 pub struct RevokeAndACK {
275 pub channel_id: [u8; 32],
276 pub per_commitment_secret: [u8; 32],
277 pub next_per_commitment_point: PublicKey,
280 pub struct UpdateFee {
281 pub channel_id: [u8; 32],
282 pub feerate_per_kw: u32,
285 pub struct DataLossProtect {
286 pub your_last_per_commitment_secret: [u8; 32],
287 pub my_current_per_commitment_point: PublicKey,
290 pub struct ChannelReestablish {
291 pub channel_id: [u8; 32],
292 pub next_local_commitment_number: u64,
293 pub next_remote_commitment_number: u64,
294 pub data_loss_protect: Option<DataLossProtect>,
298 pub struct AnnouncementSignatures {
299 pub channel_id: [u8; 32],
300 pub short_channel_id: u64,
301 pub node_signature: Signature,
302 pub bitcoin_signature: Signature,
306 pub enum NetAddress {
320 ed25519_pubkey: [u8; 32],
327 fn get_id(&self) -> u8 {
329 &NetAddress::IPv4 {..} => { 1 },
330 &NetAddress::IPv6 {..} => { 2 },
331 &NetAddress::OnionV2 {..} => { 3 },
332 &NetAddress::OnionV3 {..} => { 4 },
337 pub struct UnsignedNodeAnnouncement {
338 pub features: GlobalFeatures,
340 pub node_id: PublicKey,
343 /// List of addresses on which this node is reachable. Note that you may only have up to one
344 /// address of each type, if you have more, they may be silently discarded or we may panic!
345 pub addresses: Vec<NetAddress>,
346 pub excess_address_data: Vec<u8>,
347 pub excess_data: Vec<u8>,
349 pub struct NodeAnnouncement {
350 pub signature: Signature,
351 pub contents: UnsignedNodeAnnouncement,
354 #[derive(PartialEq, Clone)]
355 pub struct UnsignedChannelAnnouncement {
356 pub features: GlobalFeatures,
357 pub chain_hash: Sha256dHash,
358 pub short_channel_id: u64,
359 pub node_id_1: PublicKey,
360 pub node_id_2: PublicKey,
361 pub bitcoin_key_1: PublicKey,
362 pub bitcoin_key_2: PublicKey,
363 pub excess_data: Vec<u8>,
365 #[derive(PartialEq, Clone)]
366 pub struct ChannelAnnouncement {
367 pub node_signature_1: Signature,
368 pub node_signature_2: Signature,
369 pub bitcoin_signature_1: Signature,
370 pub bitcoin_signature_2: Signature,
371 pub contents: UnsignedChannelAnnouncement,
374 #[derive(PartialEq, Clone)]
375 pub struct UnsignedChannelUpdate {
376 pub chain_hash: Sha256dHash,
377 pub short_channel_id: u64,
380 pub cltv_expiry_delta: u16,
381 pub htlc_minimum_msat: u64,
382 pub fee_base_msat: u32,
383 pub fee_proportional_millionths: u32,
384 pub excess_data: Vec<u8>,
386 #[derive(PartialEq, Clone)]
387 pub struct ChannelUpdate {
388 pub signature: Signature,
389 pub contents: UnsignedChannelUpdate,
392 /// Used to put an error message in a HandleError
393 pub enum ErrorAction {
394 /// The peer took some action which made us think they were useless. Disconnect them.
396 msg: Option<ErrorMessage>
398 /// The peer did something harmless that we weren't able to process, just log and ignore
400 /// The peer did something incorrect. Tell them.
406 pub struct HandleError { //TODO: rename me
407 pub err: &'static str,
408 pub action: Option<ErrorAction>, //TODO: Make this required
411 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
412 /// transaction updates if they were pending.
413 pub struct CommitmentUpdate {
414 pub update_add_htlcs: Vec<UpdateAddHTLC>,
415 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
416 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
417 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
418 pub commitment_signed: CommitmentSigned,
421 pub enum HTLCFailChannelUpdate {
422 ChannelUpdateMessage {
426 short_channel_id: u64,
430 /// A trait to describe an object which can receive channel messages. Messages MAY be called in
431 /// paralell when they originate from different their_node_ids, however they MUST NOT be called in
432 /// paralell when the two calls have the same their_node_id.
433 pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
435 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<AcceptChannel, HandleError>;
436 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
437 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<FundingSigned, HandleError>;
438 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned) -> Result<(), HandleError>;
439 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<Option<AnnouncementSignatures>, HandleError>;
442 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(Option<Shutdown>, Option<ClosingSigned>), HandleError>;
443 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<Option<ClosingSigned>, HandleError>;
446 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
447 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
448 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<Option<HTLCFailChannelUpdate>, HandleError>;
449 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
450 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(RevokeAndACK, Option<CommitmentSigned>), HandleError>;
451 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<CommitmentUpdate>, HandleError>;
453 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
455 // Channel-to-announce:
456 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>;
459 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
460 /// is believed to be possible in the future (eg they're sending us messages we don't
461 /// understand or indicate they require unknown feature bits), no_connection_possible is set
462 /// and any outstanding channels should be failed.
463 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
465 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
468 pub trait RoutingMessageHandler : Send + Sync {
469 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, HandleError>;
470 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
471 /// or returning an Err otherwise.
472 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
473 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, HandleError>;
474 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
477 pub struct OnionRealm0HopData {
478 pub short_channel_id: u64,
479 pub amt_to_forward: u64,
480 pub outgoing_cltv_value: u32,
481 // 12 bytes of 0-padding
484 pub struct OnionHopData {
486 pub data: OnionRealm0HopData,
489 unsafe impl internal_traits::NoDealloc for OnionHopData{}
492 pub struct OnionPacket {
494 /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
495 /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
496 /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
497 pub public_key: Result<PublicKey, secp256k1::Error>,
498 pub hop_data: [u8; 20*65],
502 pub struct DecodedOnionErrorPacket {
504 pub failuremsg: Vec<u8>,
509 pub struct OnionErrorPacket {
510 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
511 // (TODO) We limit it in decode to much lower...
515 impl Error for DecodeError {
516 fn description(&self) -> &str {
518 DecodeError::UnknownRealmByte => "Unknown realm byte in Onion packet",
519 DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
520 DecodeError::BadPublicKey => "Invalid public key in packet",
521 DecodeError::BadSignature => "Invalid signature in packet",
522 DecodeError::BadText => "Invalid text in packet",
523 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
524 DecodeError::ExtraAddressesPerType => "More than one address of a single type",
525 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
526 DecodeError::Io(ref e) => e.description(),
527 DecodeError::InvalidValue => "Invalid value in the bytes",
531 impl fmt::Display for DecodeError {
532 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
533 f.write_str(self.description())
537 impl fmt::Debug for HandleError {
538 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
539 f.write_str(self.err)
543 impl From<::std::io::Error> for DecodeError {
544 fn from(e: ::std::io::Error) -> Self {
545 if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
546 DecodeError::ShortRead
553 macro_rules! secp_pubkey {
554 ( $ctx: expr, $slice: expr ) => {
555 match PublicKey::from_slice($ctx, $slice) {
557 Err(_) => return Err(DecodeError::BadPublicKey)
562 macro_rules! secp_signature {
563 ( $ctx: expr, $slice: expr ) => {
564 match Signature::from_compact($ctx, $slice) {
566 Err(_) => return Err(DecodeError::BadSignature)
571 impl MsgDecodable for LocalFeatures {
572 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
573 if v.len() < 2 { return Err(DecodeError::ShortRead); }
574 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
575 if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
576 let mut flags = Vec::with_capacity(len);
577 flags.extend_from_slice(&v[2..2 + len]);
583 impl MsgEncodable for LocalFeatures {
584 fn encode(&self) -> Vec<u8> {
585 let mut res = Vec::with_capacity(self.flags.len() + 2);
586 res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
587 res.extend_from_slice(&self.flags[..]);
590 fn encoded_len(&self) -> usize { self.flags.len() + 2 }
593 impl MsgDecodable for GlobalFeatures {
594 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
595 if v.len() < 2 { return Err(DecodeError::ShortRead); }
596 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
597 if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
598 let mut flags = Vec::with_capacity(len);
599 flags.extend_from_slice(&v[2..2 + len]);
605 impl MsgEncodable for GlobalFeatures {
606 fn encode(&self) -> Vec<u8> {
607 let mut res = Vec::with_capacity(self.flags.len() + 2);
608 res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
609 res.extend_from_slice(&self.flags[..]);
612 fn encoded_len(&self) -> usize { self.flags.len() + 2 }
615 impl MsgDecodable for Init {
616 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
617 let global_features = GlobalFeatures::decode(v)?;
618 if v.len() < global_features.flags.len() + 4 {
619 return Err(DecodeError::ShortRead);
621 let local_features = LocalFeatures::decode(&v[global_features.flags.len() + 2..])?;
623 global_features: global_features,
624 local_features: local_features,
628 impl MsgEncodable for Init {
629 fn encode(&self) -> Vec<u8> {
630 let mut res = Vec::with_capacity(self.global_features.flags.len() + self.local_features.flags.len());
631 res.extend_from_slice(&self.global_features.encode()[..]);
632 res.extend_from_slice(&self.local_features.encode()[..]);
637 impl MsgDecodable for Ping {
638 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
640 return Err(DecodeError::ShortRead);
642 let ponglen = byte_utils::slice_to_be16(&v[0..2]);
643 let byteslen = byte_utils::slice_to_be16(&v[2..4]);
644 if v.len() < 4 + byteslen as usize {
645 return Err(DecodeError::ShortRead);
653 impl MsgEncodable for Ping {
654 fn encode(&self) -> Vec<u8> {
655 let mut res = Vec::with_capacity(self.byteslen as usize + 2);
656 res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
657 res.resize(2 + self.byteslen as usize, 0);
662 impl MsgDecodable for Pong {
663 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
665 return Err(DecodeError::ShortRead);
667 let byteslen = byte_utils::slice_to_be16(&v[0..2]);
668 if v.len() < 2 + byteslen as usize {
669 return Err(DecodeError::ShortRead);
676 impl MsgEncodable for Pong {
677 fn encode(&self) -> Vec<u8> {
678 let mut res = Vec::with_capacity(self.byteslen as usize + 2);
679 res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
680 res.resize(2 + self.byteslen as usize, 0);
685 impl MsgDecodable for OpenChannel {
686 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
687 if v.len() < 2*32+6*8+4+2*2+6*33+1 {
688 return Err(DecodeError::ShortRead);
690 let ctx = Secp256k1::without_caps();
692 let mut shutdown_scriptpubkey = None;
694 let len = byte_utils::slice_to_be16(&v[319..321]) as usize;
695 if v.len() < 321+len {
696 return Err(DecodeError::ShortRead);
698 shutdown_scriptpubkey = Some(Script::from(v[321..321+len].to_vec()));
700 let mut temp_channel_id = [0; 32];
701 temp_channel_id[..].copy_from_slice(&v[32..64]);
703 chain_hash: deserialize(&v[0..32]).unwrap(),
704 temporary_channel_id: temp_channel_id,
705 funding_satoshis: byte_utils::slice_to_be64(&v[64..72]),
706 push_msat: byte_utils::slice_to_be64(&v[72..80]),
707 dust_limit_satoshis: byte_utils::slice_to_be64(&v[80..88]),
708 max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[88..96]),
709 channel_reserve_satoshis: byte_utils::slice_to_be64(&v[96..104]),
710 htlc_minimum_msat: byte_utils::slice_to_be64(&v[104..112]),
711 feerate_per_kw: byte_utils::slice_to_be32(&v[112..116]),
712 to_self_delay: byte_utils::slice_to_be16(&v[116..118]),
713 max_accepted_htlcs: byte_utils::slice_to_be16(&v[118..120]),
714 funding_pubkey: secp_pubkey!(&ctx, &v[120..153]),
715 revocation_basepoint: secp_pubkey!(&ctx, &v[153..186]),
716 payment_basepoint: secp_pubkey!(&ctx, &v[186..219]),
717 delayed_payment_basepoint: secp_pubkey!(&ctx, &v[219..252]),
718 htlc_basepoint: secp_pubkey!(&ctx, &v[252..285]),
719 first_per_commitment_point: secp_pubkey!(&ctx, &v[285..318]),
720 channel_flags: v[318],
721 shutdown_scriptpubkey: shutdown_scriptpubkey
725 impl MsgEncodable for OpenChannel {
726 fn encode(&self) -> Vec<u8> {
727 let mut res = match &self.shutdown_scriptpubkey {
728 &Some(ref script) => Vec::with_capacity(319 + 2 + script.len()),
729 &None => Vec::with_capacity(319),
731 res.extend_from_slice(&serialize(&self.chain_hash).unwrap());
732 res.extend_from_slice(&serialize(&self.temporary_channel_id).unwrap());
733 res.extend_from_slice(&byte_utils::be64_to_array(self.funding_satoshis));
734 res.extend_from_slice(&byte_utils::be64_to_array(self.push_msat));
735 res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
736 res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
737 res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
738 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
739 res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
740 res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
741 res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
742 res.extend_from_slice(&self.funding_pubkey.serialize());
743 res.extend_from_slice(&self.revocation_basepoint.serialize());
744 res.extend_from_slice(&self.payment_basepoint.serialize());
745 res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
746 res.extend_from_slice(&self.htlc_basepoint.serialize());
747 res.extend_from_slice(&self.first_per_commitment_point.serialize());
748 res.push(self.channel_flags);
749 if let &Some(ref script) = &self.shutdown_scriptpubkey {
750 res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
751 res.extend_from_slice(&script[..]);
757 impl MsgDecodable for AcceptChannel {
758 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
759 if v.len() < 32+4*8+4+2*2+6*33 {
760 return Err(DecodeError::ShortRead);
762 let ctx = Secp256k1::without_caps();
764 let mut shutdown_scriptpubkey = None;
766 let len = byte_utils::slice_to_be16(&v[270..272]) as usize;
767 if v.len() < 272+len {
768 return Err(DecodeError::ShortRead);
770 shutdown_scriptpubkey = Some(Script::from(v[272..272+len].to_vec()));
773 let mut temporary_channel_id = [0; 32];
774 temporary_channel_id[..].copy_from_slice(&v[0..32]);
776 temporary_channel_id,
777 dust_limit_satoshis: byte_utils::slice_to_be64(&v[32..40]),
778 max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[40..48]),
779 channel_reserve_satoshis: byte_utils::slice_to_be64(&v[48..56]),
780 htlc_minimum_msat: byte_utils::slice_to_be64(&v[56..64]),
781 minimum_depth: byte_utils::slice_to_be32(&v[64..68]),
782 to_self_delay: byte_utils::slice_to_be16(&v[68..70]),
783 max_accepted_htlcs: byte_utils::slice_to_be16(&v[70..72]),
784 funding_pubkey: secp_pubkey!(&ctx, &v[72..105]),
785 revocation_basepoint: secp_pubkey!(&ctx, &v[105..138]),
786 payment_basepoint: secp_pubkey!(&ctx, &v[138..171]),
787 delayed_payment_basepoint: secp_pubkey!(&ctx, &v[171..204]),
788 htlc_basepoint: secp_pubkey!(&ctx, &v[204..237]),
789 first_per_commitment_point: secp_pubkey!(&ctx, &v[237..270]),
790 shutdown_scriptpubkey: shutdown_scriptpubkey
794 impl MsgEncodable for AcceptChannel {
795 fn encode(&self) -> Vec<u8> {
796 let mut res = match &self.shutdown_scriptpubkey {
797 &Some(ref script) => Vec::with_capacity(270 + 2 + script.len()),
798 &None => Vec::with_capacity(270),
800 res.extend_from_slice(&self.temporary_channel_id);
801 res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
802 res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
803 res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
804 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
805 res.extend_from_slice(&byte_utils::be32_to_array(self.minimum_depth));
806 res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
807 res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
808 res.extend_from_slice(&self.funding_pubkey.serialize());
809 res.extend_from_slice(&self.revocation_basepoint.serialize());
810 res.extend_from_slice(&self.payment_basepoint.serialize());
811 res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
812 res.extend_from_slice(&self.htlc_basepoint.serialize());
813 res.extend_from_slice(&self.first_per_commitment_point.serialize());
814 if let &Some(ref script) = &self.shutdown_scriptpubkey {
815 res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
816 res.extend_from_slice(&script[..]);
822 impl MsgDecodable for FundingCreated {
823 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
824 if v.len() < 32+32+2+64 {
825 return Err(DecodeError::ShortRead);
827 let ctx = Secp256k1::without_caps();
828 let mut temporary_channel_id = [0; 32];
829 temporary_channel_id[..].copy_from_slice(&v[0..32]);
831 temporary_channel_id,
832 funding_txid: deserialize(&v[32..64]).unwrap(),
833 funding_output_index: byte_utils::slice_to_be16(&v[64..66]),
834 signature: secp_signature!(&ctx, &v[66..130]),
838 impl MsgEncodable for FundingCreated {
839 fn encode(&self) -> Vec<u8> {
840 let mut res = Vec::with_capacity(32+32+2+64);
841 res.extend_from_slice(&self.temporary_channel_id);
842 res.extend_from_slice(&serialize(&self.funding_txid).unwrap()[..]);
843 res.extend_from_slice(&byte_utils::be16_to_array(self.funding_output_index));
844 let secp_ctx = Secp256k1::without_caps();
845 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
850 impl MsgDecodable for FundingSigned {
851 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
853 return Err(DecodeError::ShortRead);
855 let ctx = Secp256k1::without_caps();
856 let mut channel_id = [0; 32];
857 channel_id[..].copy_from_slice(&v[0..32]);
860 signature: secp_signature!(&ctx, &v[32..96]),
864 impl MsgEncodable for FundingSigned {
865 fn encode(&self) -> Vec<u8> {
866 let mut res = Vec::with_capacity(32+64);
867 res.extend_from_slice(&self.channel_id);
868 res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps()));
873 impl MsgDecodable for FundingLocked {
874 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
876 return Err(DecodeError::ShortRead);
878 let ctx = Secp256k1::without_caps();
879 let mut channel_id = [0; 32];
880 channel_id[..].copy_from_slice(&v[0..32]);
883 next_per_commitment_point: secp_pubkey!(&ctx, &v[32..65]),
887 impl MsgEncodable for FundingLocked {
888 fn encode(&self) -> Vec<u8> {
889 let mut res = Vec::with_capacity(32+33);
890 res.extend_from_slice(&self.channel_id);
891 res.extend_from_slice(&self.next_per_commitment_point.serialize());
896 impl MsgDecodable for Shutdown {
897 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
898 if v.len() < 32 + 2 {
899 return Err(DecodeError::ShortRead);
901 let scriptlen = byte_utils::slice_to_be16(&v[32..34]) as usize;
902 if v.len() < 32 + 2 + scriptlen {
903 return Err(DecodeError::ShortRead);
905 let mut channel_id = [0; 32];
906 channel_id[..].copy_from_slice(&v[0..32]);
909 scriptpubkey: Script::from(v[34..34 + scriptlen].to_vec()),
913 impl MsgEncodable for Shutdown {
914 fn encode(&self) -> Vec<u8> {
915 let mut res = Vec::with_capacity(32 + 2 + self.scriptpubkey.len());
916 res.extend_from_slice(&self.channel_id);
917 res.extend_from_slice(&byte_utils::be16_to_array(self.scriptpubkey.len() as u16));
918 res.extend_from_slice(&self.scriptpubkey[..]);
923 impl MsgDecodable for ClosingSigned {
924 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
925 if v.len() < 32 + 8 + 64 {
926 return Err(DecodeError::ShortRead);
928 let secp_ctx = Secp256k1::without_caps();
929 let mut channel_id = [0; 32];
930 channel_id[..].copy_from_slice(&v[0..32]);
933 fee_satoshis: byte_utils::slice_to_be64(&v[32..40]),
934 signature: secp_signature!(&secp_ctx, &v[40..104]),
938 impl MsgEncodable for ClosingSigned {
939 fn encode(&self) -> Vec<u8> {
940 let mut res = Vec::with_capacity(32+8+64);
941 res.extend_from_slice(&self.channel_id);
942 res.extend_from_slice(&byte_utils::be64_to_array(self.fee_satoshis));
943 let secp_ctx = Secp256k1::without_caps();
944 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
949 impl MsgDecodable for UpdateAddHTLC {
950 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
951 if v.len() < 32+8+8+32+4+1+33+20*65+32 {
952 return Err(DecodeError::ShortRead);
954 let mut channel_id = [0; 32];
955 channel_id[..].copy_from_slice(&v[0..32]);
956 let mut payment_hash = [0; 32];
957 payment_hash.copy_from_slice(&v[48..80]);
960 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
961 amount_msat: byte_utils::slice_to_be64(&v[40..48]),
963 cltv_expiry: byte_utils::slice_to_be32(&v[80..84]),
964 onion_routing_packet: OnionPacket::decode(&v[84..84+1366])?,
968 impl MsgEncodable for UpdateAddHTLC {
969 fn encode(&self) -> Vec<u8> {
970 let mut res = Vec::with_capacity(32+8+8+32+4+1366);
971 res.extend_from_slice(&self.channel_id);
972 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
973 res.extend_from_slice(&byte_utils::be64_to_array(self.amount_msat));
974 res.extend_from_slice(&self.payment_hash);
975 res.extend_from_slice(&byte_utils::be32_to_array(self.cltv_expiry));
976 res.extend_from_slice(&self.onion_routing_packet.encode()[..]);
981 impl MsgDecodable for UpdateFulfillHTLC {
982 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
983 if v.len() < 32+8+32 {
984 return Err(DecodeError::ShortRead);
986 let mut channel_id = [0; 32];
987 channel_id[..].copy_from_slice(&v[0..32]);
988 let mut payment_preimage = [0; 32];
989 payment_preimage.copy_from_slice(&v[40..72]);
992 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
997 impl MsgEncodable for UpdateFulfillHTLC {
998 fn encode(&self) -> Vec<u8> {
999 let mut res = Vec::with_capacity(32+8+32);
1000 res.extend_from_slice(&self.channel_id);
1001 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
1002 res.extend_from_slice(&self.payment_preimage);
1007 impl MsgDecodable for UpdateFailHTLC {
1008 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1010 return Err(DecodeError::ShortRead);
1012 let mut channel_id = [0; 32];
1013 channel_id[..].copy_from_slice(&v[0..32]);
1016 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
1017 reason: OnionErrorPacket::decode(&v[40..])?,
1021 impl MsgEncodable for UpdateFailHTLC {
1022 fn encode(&self) -> Vec<u8> {
1023 let reason = self.reason.encode();
1024 let mut res = Vec::with_capacity(32+8+reason.len());
1025 res.extend_from_slice(&self.channel_id);
1026 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
1027 res.extend_from_slice(&reason[..]);
1032 impl MsgDecodable for UpdateFailMalformedHTLC {
1033 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1034 if v.len() < 32+8+32+2 {
1035 return Err(DecodeError::ShortRead);
1037 let mut channel_id = [0; 32];
1038 channel_id[..].copy_from_slice(&v[0..32]);
1039 let mut sha256_of_onion = [0; 32];
1040 sha256_of_onion.copy_from_slice(&v[40..72]);
1043 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
1045 failure_code: byte_utils::slice_to_be16(&v[72..74]),
1049 impl MsgEncodable for UpdateFailMalformedHTLC {
1050 fn encode(&self) -> Vec<u8> {
1051 let mut res = Vec::with_capacity(32+8+32+2);
1052 res.extend_from_slice(&self.channel_id);
1053 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
1054 res.extend_from_slice(&self.sha256_of_onion);
1055 res.extend_from_slice(&byte_utils::be16_to_array(self.failure_code));
1060 impl MsgDecodable for CommitmentSigned {
1061 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1062 if v.len() < 32+64+2 {
1063 return Err(DecodeError::ShortRead);
1065 let mut channel_id = [0; 32];
1066 channel_id[..].copy_from_slice(&v[0..32]);
1068 let htlcs = byte_utils::slice_to_be16(&v[96..98]) as usize;
1069 if v.len() < 32+64+2+htlcs*64 {
1070 return Err(DecodeError::ShortRead);
1072 let mut htlc_signatures = Vec::with_capacity(htlcs);
1073 let secp_ctx = Secp256k1::without_caps();
1075 htlc_signatures.push(secp_signature!(&secp_ctx, &v[98+i*64..98+(i+1)*64]));
1079 signature: secp_signature!(&secp_ctx, &v[32..96]),
1084 impl MsgEncodable for CommitmentSigned {
1085 fn encode(&self) -> Vec<u8> {
1086 let mut res = Vec::with_capacity(32+64+2+self.htlc_signatures.len()*64);
1087 res.extend_from_slice(&self.channel_id);
1088 let secp_ctx = Secp256k1::without_caps();
1089 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
1090 res.extend_from_slice(&byte_utils::be16_to_array(self.htlc_signatures.len() as u16));
1091 for i in 0..self.htlc_signatures.len() {
1092 res.extend_from_slice(&self.htlc_signatures[i].serialize_compact(&secp_ctx));
1098 impl MsgDecodable for RevokeAndACK {
1099 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1100 if v.len() < 32+32+33 {
1101 return Err(DecodeError::ShortRead);
1103 let mut channel_id = [0; 32];
1104 channel_id[..].copy_from_slice(&v[0..32]);
1105 let mut per_commitment_secret = [0; 32];
1106 per_commitment_secret.copy_from_slice(&v[32..64]);
1107 let secp_ctx = Secp256k1::without_caps();
1110 per_commitment_secret,
1111 next_per_commitment_point: secp_pubkey!(&secp_ctx, &v[64..97]),
1115 impl MsgEncodable for RevokeAndACK {
1116 fn encode(&self) -> Vec<u8> {
1117 let mut res = Vec::with_capacity(32+32+33);
1118 res.extend_from_slice(&self.channel_id);
1119 res.extend_from_slice(&self.per_commitment_secret);
1120 res.extend_from_slice(&self.next_per_commitment_point.serialize());
1125 impl MsgDecodable for UpdateFee {
1126 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1128 return Err(DecodeError::ShortRead);
1130 let mut channel_id = [0; 32];
1131 channel_id[..].copy_from_slice(&v[0..32]);
1134 feerate_per_kw: byte_utils::slice_to_be32(&v[32..36]),
1138 impl MsgEncodable for UpdateFee {
1139 fn encode(&self) -> Vec<u8> {
1140 let mut res = Vec::with_capacity(32+4);
1141 res.extend_from_slice(&self.channel_id);
1142 res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
1147 impl MsgDecodable for ChannelReestablish {
1148 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1149 if v.len() < 32+2*8 {
1150 return Err(DecodeError::ShortRead);
1153 let data_loss_protect = if v.len() > 32+2*8 {
1154 if v.len() < 32+2*8 + 33+32 {
1155 return Err(DecodeError::ShortRead);
1157 let mut inner_array = [0; 32];
1158 inner_array.copy_from_slice(&v[48..48+32]);
1159 Some(DataLossProtect {
1160 your_last_per_commitment_secret: inner_array,
1161 my_current_per_commitment_point: secp_pubkey!(&Secp256k1::without_caps(), &v[48+32..48+32+33]),
1166 channel_id: deserialize(&v[0..32]).unwrap(),
1167 next_local_commitment_number: byte_utils::slice_to_be64(&v[32..40]),
1168 next_remote_commitment_number: byte_utils::slice_to_be64(&v[40..48]),
1169 data_loss_protect: data_loss_protect,
1173 impl MsgEncodable for ChannelReestablish {
1174 fn encode(&self) -> Vec<u8> {
1175 let mut res = Vec::with_capacity(if self.data_loss_protect.is_some() { 32+2*8+33+32 } else { 32+2*8 });
1177 res.extend_from_slice(&serialize(&self.channel_id).unwrap()[..]);
1178 res.extend_from_slice(&byte_utils::be64_to_array(self.next_local_commitment_number));
1179 res.extend_from_slice(&byte_utils::be64_to_array(self.next_remote_commitment_number));
1181 if let &Some(ref data_loss_protect) = &self.data_loss_protect {
1182 res.extend_from_slice(&data_loss_protect.your_last_per_commitment_secret[..]);
1183 res.extend_from_slice(&data_loss_protect.my_current_per_commitment_point.serialize());
1189 impl MsgDecodable for AnnouncementSignatures {
1190 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1191 if v.len() < 32+8+64*2 {
1192 return Err(DecodeError::ShortRead);
1194 let secp_ctx = Secp256k1::without_caps();
1195 let mut channel_id = [0; 32];
1196 channel_id[..].copy_from_slice(&v[0..32]);
1199 short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
1200 node_signature: secp_signature!(&secp_ctx, &v[40..104]),
1201 bitcoin_signature: secp_signature!(&secp_ctx, &v[104..168]),
1205 impl MsgEncodable for AnnouncementSignatures {
1206 fn encode(&self) -> Vec<u8> {
1207 let mut res = Vec::with_capacity(32+8+64*2);
1208 res.extend_from_slice(&self.channel_id);
1209 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1210 let secp_ctx = Secp256k1::without_caps();
1211 res.extend_from_slice(&self.node_signature.serialize_compact(&secp_ctx));
1212 res.extend_from_slice(&self.bitcoin_signature.serialize_compact(&secp_ctx));
1217 impl MsgDecodable for UnsignedNodeAnnouncement {
1218 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1219 let features = GlobalFeatures::decode(&v[..])?;
1220 if features.requires_unknown_bits() {
1221 return Err(DecodeError::UnknownRequiredFeature);
1224 if v.len() < features.encoded_len() + 4 + 33 + 3 + 32 + 2 {
1225 return Err(DecodeError::ShortRead);
1227 let start = features.encoded_len();
1229 let mut rgb = [0; 3];
1230 rgb.copy_from_slice(&v[start + 37..start + 40]);
1232 let mut alias = [0; 32];
1233 alias.copy_from_slice(&v[start + 40..start + 72]);
1235 let addrlen = byte_utils::slice_to_be16(&v[start + 72..start + 74]) as usize;
1236 if v.len() < start + 74 + addrlen {
1237 return Err(DecodeError::ShortRead);
1239 let addr_read_limit = start + 74 + addrlen;
1241 let mut addresses = Vec::with_capacity(4);
1242 let mut read_pos = start + 74;
1244 if addr_read_limit <= read_pos { break; }
1247 if addresses.len() > 0 {
1248 return Err(DecodeError::ExtraAddressesPerType);
1250 if addr_read_limit < read_pos + 1 + 6 {
1251 return Err(DecodeError::BadLengthDescriptor);
1253 let mut addr = [0; 4];
1254 addr.copy_from_slice(&v[read_pos + 1..read_pos + 5]);
1255 addresses.push(NetAddress::IPv4 {
1257 port: byte_utils::slice_to_be16(&v[read_pos + 5..read_pos + 7]),
1262 if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1263 return Err(DecodeError::ExtraAddressesPerType);
1265 if addr_read_limit < read_pos + 1 + 18 {
1266 return Err(DecodeError::BadLengthDescriptor);
1268 let mut addr = [0; 16];
1269 addr.copy_from_slice(&v[read_pos + 1..read_pos + 17]);
1270 addresses.push(NetAddress::IPv6 {
1272 port: byte_utils::slice_to_be16(&v[read_pos + 17..read_pos + 19]),
1277 if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1278 return Err(DecodeError::ExtraAddressesPerType);
1280 if addr_read_limit < read_pos + 1 + 12 {
1281 return Err(DecodeError::BadLengthDescriptor);
1283 let mut addr = [0; 10];
1284 addr.copy_from_slice(&v[read_pos + 1..read_pos + 11]);
1285 addresses.push(NetAddress::OnionV2 {
1287 port: byte_utils::slice_to_be16(&v[read_pos + 11..read_pos + 13]),
1292 if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1293 return Err(DecodeError::ExtraAddressesPerType);
1295 if addr_read_limit < read_pos + 1 + 37 {
1296 return Err(DecodeError::BadLengthDescriptor);
1298 let mut ed25519_pubkey = [0; 32];
1299 ed25519_pubkey.copy_from_slice(&v[read_pos + 1..read_pos + 33]);
1300 addresses.push(NetAddress::OnionV3 {
1302 checksum: byte_utils::slice_to_be16(&v[read_pos + 33..read_pos + 35]),
1303 version: v[read_pos + 35],
1304 port: byte_utils::slice_to_be16(&v[read_pos + 36..read_pos + 38]),
1308 _ => { break; } // We've read all we can, we dont understand anything higher (and they're sorted)
1312 let excess_address_data = if read_pos < addr_read_limit {
1313 let mut excess_address_data = Vec::with_capacity(addr_read_limit - read_pos);
1314 excess_address_data.extend_from_slice(&v[read_pos..addr_read_limit]);
1316 } else { Vec::new() };
1318 let mut excess_data = Vec::with_capacity(v.len() - addr_read_limit);
1319 excess_data.extend_from_slice(&v[addr_read_limit..]);
1321 let secp_ctx = Secp256k1::without_caps();
1324 timestamp: byte_utils::slice_to_be32(&v[start..start + 4]),
1325 node_id: secp_pubkey!(&secp_ctx, &v[start + 4..start + 37]),
1329 excess_address_data,
1334 impl MsgEncodable for UnsignedNodeAnnouncement {
1335 fn encode(&self) -> Vec<u8> {
1336 let features = self.features.encode();
1337 let mut res = Vec::with_capacity(74 + features.len() + self.addresses.len()*7 + self.excess_address_data.len() + self.excess_data.len());
1338 res.extend_from_slice(&features[..]);
1339 res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
1340 res.extend_from_slice(&self.node_id.serialize());
1341 res.extend_from_slice(&self.rgb);
1342 res.extend_from_slice(&self.alias);
1343 let mut addr_slice = Vec::with_capacity(self.addresses.len() * 18);
1344 let mut addrs_to_encode = self.addresses.clone();
1345 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1346 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1347 for addr in addrs_to_encode.iter() {
1349 &NetAddress::IPv4{addr, port} => {
1351 addr_slice.extend_from_slice(&addr);
1352 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1354 &NetAddress::IPv6{addr, port} => {
1356 addr_slice.extend_from_slice(&addr);
1357 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1359 &NetAddress::OnionV2{addr, port} => {
1361 addr_slice.extend_from_slice(&addr);
1362 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1364 &NetAddress::OnionV3{ed25519_pubkey, checksum, version, port} => {
1366 addr_slice.extend_from_slice(&ed25519_pubkey);
1367 addr_slice.extend_from_slice(&byte_utils::be16_to_array(checksum));
1368 addr_slice.push(version);
1369 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1373 res.extend_from_slice(&byte_utils::be16_to_array((addr_slice.len() + self.excess_address_data.len()) as u16));
1374 res.extend_from_slice(&addr_slice[..]);
1375 res.extend_from_slice(&self.excess_address_data[..]);
1376 res.extend_from_slice(&self.excess_data[..]);
1381 impl MsgDecodable for NodeAnnouncement {
1382 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1384 return Err(DecodeError::ShortRead);
1386 let secp_ctx = Secp256k1::without_caps();
1388 signature: secp_signature!(&secp_ctx, &v[0..64]),
1389 contents: UnsignedNodeAnnouncement::decode(&v[64..])?,
1393 impl MsgEncodable for NodeAnnouncement {
1394 fn encode(&self) -> Vec<u8> {
1395 let contents = self.contents.encode();
1396 let mut res = Vec::with_capacity(64 + contents.len());
1397 let secp_ctx = Secp256k1::without_caps();
1398 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
1399 res.extend_from_slice(&contents);
1404 impl MsgDecodable for UnsignedChannelAnnouncement {
1405 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1406 let features = GlobalFeatures::decode(&v[..])?;
1407 if features.requires_unknown_bits() {
1408 return Err(DecodeError::UnknownRequiredFeature);
1410 if v.len() < features.encoded_len() + 32 + 8 + 33*4 {
1411 return Err(DecodeError::ShortRead);
1413 let start = features.encoded_len();
1414 let secp_ctx = Secp256k1::without_caps();
1415 let mut excess_data = Vec::with_capacity(v.len() - start - 172);
1416 excess_data.extend_from_slice(&v[start + 172..]);
1419 chain_hash: deserialize(&v[start..start + 32]).unwrap(),
1420 short_channel_id: byte_utils::slice_to_be64(&v[start + 32..start + 40]),
1421 node_id_1: secp_pubkey!(&secp_ctx, &v[start + 40..start + 73]),
1422 node_id_2: secp_pubkey!(&secp_ctx, &v[start + 73..start + 106]),
1423 bitcoin_key_1: secp_pubkey!(&secp_ctx, &v[start + 106..start + 139]),
1424 bitcoin_key_2: secp_pubkey!(&secp_ctx, &v[start + 139..start + 172]),
1429 impl MsgEncodable for UnsignedChannelAnnouncement {
1430 fn encode(&self) -> Vec<u8> {
1431 let features = self.features.encode();
1432 let mut res = Vec::with_capacity(172 + features.len() + self.excess_data.len());
1433 res.extend_from_slice(&features[..]);
1434 res.extend_from_slice(&self.chain_hash[..]);
1435 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1436 res.extend_from_slice(&self.node_id_1.serialize());
1437 res.extend_from_slice(&self.node_id_2.serialize());
1438 res.extend_from_slice(&self.bitcoin_key_1.serialize());
1439 res.extend_from_slice(&self.bitcoin_key_2.serialize());
1440 res.extend_from_slice(&self.excess_data[..]);
1445 impl MsgDecodable for ChannelAnnouncement {
1446 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1448 return Err(DecodeError::ShortRead);
1450 let secp_ctx = Secp256k1::without_caps();
1452 node_signature_1: secp_signature!(&secp_ctx, &v[0..64]),
1453 node_signature_2: secp_signature!(&secp_ctx, &v[64..128]),
1454 bitcoin_signature_1: secp_signature!(&secp_ctx, &v[128..192]),
1455 bitcoin_signature_2: secp_signature!(&secp_ctx, &v[192..256]),
1456 contents: UnsignedChannelAnnouncement::decode(&v[256..])?,
1460 impl MsgEncodable for ChannelAnnouncement {
1461 fn encode(&self) -> Vec<u8> {
1462 let secp_ctx = Secp256k1::without_caps();
1463 let contents = self.contents.encode();
1464 let mut res = Vec::with_capacity(64 + contents.len());
1465 res.extend_from_slice(&self.node_signature_1.serialize_compact(&secp_ctx));
1466 res.extend_from_slice(&self.node_signature_2.serialize_compact(&secp_ctx));
1467 res.extend_from_slice(&self.bitcoin_signature_1.serialize_compact(&secp_ctx));
1468 res.extend_from_slice(&self.bitcoin_signature_2.serialize_compact(&secp_ctx));
1469 res.extend_from_slice(&contents);
1474 impl MsgDecodable for UnsignedChannelUpdate {
1475 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1476 if v.len() < 32+8+4+2+2+8+4+4 {
1477 return Err(DecodeError::ShortRead);
1479 let mut excess_data = Vec::with_capacity(v.len() - 64);
1480 excess_data.extend_from_slice(&v[64..]);
1482 chain_hash: deserialize(&v[0..32]).unwrap(),
1483 short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
1484 timestamp: byte_utils::slice_to_be32(&v[40..44]),
1485 flags: byte_utils::slice_to_be16(&v[44..46]),
1486 cltv_expiry_delta: byte_utils::slice_to_be16(&v[46..48]),
1487 htlc_minimum_msat: byte_utils::slice_to_be64(&v[48..56]),
1488 fee_base_msat: byte_utils::slice_to_be32(&v[56..60]),
1489 fee_proportional_millionths: byte_utils::slice_to_be32(&v[60..64]),
1494 impl MsgEncodable for UnsignedChannelUpdate {
1495 fn encode(&self) -> Vec<u8> {
1496 let mut res = Vec::with_capacity(64 + self.excess_data.len());
1497 res.extend_from_slice(&self.chain_hash[..]);
1498 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1499 res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
1500 res.extend_from_slice(&byte_utils::be16_to_array(self.flags));
1501 res.extend_from_slice(&byte_utils::be16_to_array(self.cltv_expiry_delta));
1502 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
1503 res.extend_from_slice(&byte_utils::be32_to_array(self.fee_base_msat));
1504 res.extend_from_slice(&byte_utils::be32_to_array(self.fee_proportional_millionths));
1505 res.extend_from_slice(&self.excess_data[..]);
1510 impl MsgDecodable for ChannelUpdate {
1511 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1513 return Err(DecodeError::ShortRead);
1515 let secp_ctx = Secp256k1::without_caps();
1517 signature: secp_signature!(&secp_ctx, &v[0..64]),
1518 contents: UnsignedChannelUpdate::decode(&v[64..])?,
1522 impl MsgEncodable for ChannelUpdate {
1523 fn encode(&self) -> Vec<u8> {
1524 let mut res = Vec::with_capacity(128);
1525 res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps())[..]);
1526 res.extend_from_slice(&self.contents.encode()[..]);
1531 impl MsgDecodable for OnionRealm0HopData {
1532 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1534 return Err(DecodeError::ShortRead);
1536 Ok(OnionRealm0HopData {
1537 short_channel_id: byte_utils::slice_to_be64(&v[0..8]),
1538 amt_to_forward: byte_utils::slice_to_be64(&v[8..16]),
1539 outgoing_cltv_value: byte_utils::slice_to_be32(&v[16..20]),
1543 impl MsgEncodable for OnionRealm0HopData {
1544 fn encode(&self) -> Vec<u8> {
1545 let mut res = Vec::with_capacity(32);
1546 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1547 res.extend_from_slice(&byte_utils::be64_to_array(self.amt_to_forward));
1548 res.extend_from_slice(&byte_utils::be32_to_array(self.outgoing_cltv_value));
1554 impl MsgDecodable for OnionHopData {
1555 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1557 return Err(DecodeError::ShortRead);
1561 return Err(DecodeError::UnknownRealmByte);
1563 let mut hmac = [0; 32];
1564 hmac[..].copy_from_slice(&v[33..65]);
1567 data: OnionRealm0HopData::decode(&v[1..33])?,
1572 impl MsgEncodable for OnionHopData {
1573 fn encode(&self) -> Vec<u8> {
1574 let mut res = Vec::with_capacity(65);
1575 res.push(self.realm);
1576 res.extend_from_slice(&self.data.encode()[..]);
1577 res.extend_from_slice(&self.hmac);
1582 impl MsgDecodable for OnionPacket {
1583 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1584 if v.len() < 1+33+20*65+32 {
1585 return Err(DecodeError::ShortRead);
1587 let mut hop_data = [0; 20*65];
1588 hop_data.copy_from_slice(&v[34..1334]);
1589 let mut hmac = [0; 32];
1590 hmac.copy_from_slice(&v[1334..1366]);
1591 let secp_ctx = Secp256k1::without_caps();
1594 public_key: PublicKey::from_slice(&secp_ctx, &v[1..34]),
1600 impl MsgEncodable for OnionPacket {
1601 fn encode(&self) -> Vec<u8> {
1602 let mut res = Vec::with_capacity(1 + 33 + 20*65 + 32);
1603 res.push(self.version);
1604 match self.public_key {
1605 Ok(pubkey) => res.extend_from_slice(&pubkey.serialize()),
1606 Err(_) => res.extend_from_slice(&[0; 33]),
1608 res.extend_from_slice(&self.hop_data);
1609 res.extend_from_slice(&self.hmac);
1614 impl MsgDecodable for DecodedOnionErrorPacket {
1615 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1616 if v.len() < 32 + 4 {
1617 return Err(DecodeError::ShortRead);
1619 let failuremsg_len = byte_utils::slice_to_be16(&v[32..34]) as usize;
1620 if v.len() < 32 + 4 + failuremsg_len {
1621 return Err(DecodeError::ShortRead);
1623 let padding_len = byte_utils::slice_to_be16(&v[34 + failuremsg_len..]) as usize;
1624 if v.len() < 32 + 4 + failuremsg_len + padding_len {
1625 return Err(DecodeError::ShortRead);
1628 let mut hmac = [0; 32];
1629 hmac.copy_from_slice(&v[0..32]);
1632 failuremsg: v[34..34 + failuremsg_len].to_vec(),
1633 pad: v[36 + failuremsg_len..36 + failuremsg_len + padding_len].to_vec(),
1637 impl MsgEncodable for DecodedOnionErrorPacket {
1638 fn encode(&self) -> Vec<u8> {
1639 let mut res = Vec::with_capacity(32 + 4 + self.failuremsg.len() + self.pad.len());
1640 res.extend_from_slice(&self.hmac);
1641 res.extend_from_slice(&[((self.failuremsg.len() >> 8) & 0xff) as u8, (self.failuremsg.len() & 0xff) as u8]);
1642 res.extend_from_slice(&self.failuremsg);
1643 res.extend_from_slice(&[((self.pad.len() >> 8) & 0xff) as u8, (self.pad.len() & 0xff) as u8]);
1644 res.extend_from_slice(&self.pad);
1649 impl MsgDecodable for OnionErrorPacket {
1650 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1652 return Err(DecodeError::ShortRead);
1654 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
1655 if v.len() < 2 + len {
1656 return Err(DecodeError::ShortRead);
1659 data: v[2..len+2].to_vec(),
1663 impl MsgEncodable for OnionErrorPacket {
1664 fn encode(&self) -> Vec<u8> {
1665 let mut res = Vec::with_capacity(2 + self.data.len());
1666 res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
1667 res.extend_from_slice(&self.data);
1672 impl MsgEncodable for ErrorMessage {
1673 fn encode(&self) -> Vec<u8> {
1674 let mut res = Vec::with_capacity(34 + self.data.len());
1675 res.extend_from_slice(&self.channel_id);
1676 res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
1677 res.extend_from_slice(&self.data.as_bytes());
1681 impl MsgDecodable for ErrorMessage {
1682 fn decode(v: &[u8]) -> Result<Self,DecodeError> {
1684 return Err(DecodeError::ShortRead);
1686 // Unlike most messages, BOLT 1 requires we truncate our read if the value is out of range
1687 let len = cmp::min(byte_utils::slice_to_be16(&v[32..34]) as usize, v.len() - 34);
1688 let data = match String::from_utf8(v[34..34 + len].to_vec()) {
1690 Err(_) => return Err(DecodeError::BadText),
1692 let mut channel_id = [0; 32];
1693 channel_id[..].copy_from_slice(&v[0..32]);
1704 use ln::msgs::MsgEncodable;
1706 use secp256k1::key::{PublicKey,SecretKey};
1707 use secp256k1::Secp256k1;
1710 fn encoding_channel_reestablish_no_secret() {
1711 let cr = msgs::ChannelReestablish {
1712 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],
1713 next_local_commitment_number: 3,
1714 next_remote_commitment_number: 4,
1715 data_loss_protect: None,
1718 let encoded_value = cr.encode();
1721 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]
1726 fn encoding_channel_reestablish_with_secret() {
1728 let secp_ctx = Secp256k1::new();
1729 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1732 let cr = msgs::ChannelReestablish {
1733 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],
1734 next_local_commitment_number: 3,
1735 next_remote_commitment_number: 4,
1736 data_loss_protect: Some(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
1739 let encoded_value = cr.encode();
1742 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]