1 use secp256k1::key::PublicKey;
2 use secp256k1::{Secp256k1, Signature};
3 use bitcoin::util::hash::Sha256dHash;
4 use bitcoin::network::serialize::{deserialize,serialize};
5 use bitcoin::blockdata::script::Script;
9 use std::result::Result;
11 use util::{byte_utils, internal_traits, events};
13 pub trait MsgEncodable {
14 fn encode(&self) -> Vec<u8>;
16 fn encoded_len(&self) -> usize { self.encode().len() }
18 fn encode_with_len(&self) -> Vec<u8> {
19 let enc = self.encode();
20 let mut res = Vec::with_capacity(enc.len() + 2);
21 res.extend_from_slice(&byte_utils::be16_to_array(enc.len() as u16));
22 res.extend_from_slice(&enc);
27 pub enum DecodeError {
28 /// Unknown realm byte in an OnionHopData packet
30 /// Failed to decode a public key (ie it's invalid)
32 /// Failed to decode a signature (ie it's invalid)
34 /// Value expected to be text wasn't decodable as text
38 /// node_announcement included more than one address of a given type!
39 ExtraAddressesPerType,
40 /// A length descriptor in the packet didn't describe the later data correctly
41 /// (currently only generated in node_announcement)
44 pub trait MsgDecodable: Sized {
45 fn decode(v: &[u8]) -> Result<Self, DecodeError>;
48 /// Tracks localfeatures which are only in init messages
49 #[derive(Clone, PartialEq)]
50 pub struct LocalFeatures {
55 pub fn new() -> LocalFeatures {
61 pub fn supports_data_loss_protect(&self) -> bool {
62 self.flags.len() > 0 && (self.flags[0] & 3) != 0
64 pub fn requires_data_loss_protect(&self) -> bool {
65 self.flags.len() > 0 && (self.flags[0] & 1) != 0
68 pub fn initial_routing_sync(&self) -> bool {
69 self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0
71 pub fn set_initial_routing_sync(&mut self) {
72 if self.flags.len() == 0 {
73 self.flags.resize(1, 1 << 3);
75 self.flags[0] |= 1 << 3;
79 pub fn supports_upfront_shutdown_script(&self) -> bool {
80 self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0
82 pub fn requires_upfront_shutdown_script(&self) -> bool {
83 self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0
86 pub fn requires_unknown_bits(&self) -> bool {
87 for (idx, &byte) in self.flags.iter().enumerate() {
88 if idx != 0 && (byte & 0x55) != 0 {
90 } else if idx == 0 && (byte & 0x14) != 0 {
97 pub fn supports_unknown_bits(&self) -> bool {
98 for (idx, &byte) in self.flags.iter().enumerate() {
99 if idx != 0 && byte != 0 {
101 } else if idx == 0 && (byte & 0xc4) != 0 {
109 /// Tracks globalfeatures which are in init messages and routing announcements
110 #[derive(Clone, PartialEq)]
111 pub struct GlobalFeatures {
115 impl GlobalFeatures {
116 pub fn new() -> GlobalFeatures {
122 pub fn requires_unknown_bits(&self) -> bool {
123 for &byte in self.flags.iter() {
124 if (byte & 0x55) != 0 {
131 pub fn supports_unknown_bits(&self) -> bool {
132 for &byte in self.flags.iter() {
142 pub global_features: GlobalFeatures,
143 pub local_features: LocalFeatures,
146 pub struct ErrorMessage {
147 pub channel_id: [u8; 32],
160 pub struct OpenChannel {
161 pub chain_hash: Sha256dHash,
162 pub temporary_channel_id: [u8; 32],
163 pub funding_satoshis: u64,
165 pub dust_limit_satoshis: u64,
166 pub max_htlc_value_in_flight_msat: u64,
167 pub channel_reserve_satoshis: u64,
168 pub htlc_minimum_msat: u64,
169 pub feerate_per_kw: u32,
170 pub to_self_delay: u16,
171 pub max_accepted_htlcs: u16,
172 pub funding_pubkey: PublicKey,
173 pub revocation_basepoint: PublicKey,
174 pub payment_basepoint: PublicKey,
175 pub delayed_payment_basepoint: PublicKey,
176 pub htlc_basepoint: PublicKey,
177 pub first_per_commitment_point: PublicKey,
178 pub channel_flags: u8,
179 pub shutdown_scriptpubkey: Option<Script>,
182 pub struct AcceptChannel {
183 pub temporary_channel_id: [u8; 32],
184 pub dust_limit_satoshis: u64,
185 pub max_htlc_value_in_flight_msat: u64,
186 pub channel_reserve_satoshis: u64,
187 pub htlc_minimum_msat: u64,
188 pub minimum_depth: u32,
189 pub to_self_delay: u16,
190 pub max_accepted_htlcs: u16,
191 pub funding_pubkey: PublicKey,
192 pub revocation_basepoint: PublicKey,
193 pub payment_basepoint: PublicKey,
194 pub delayed_payment_basepoint: PublicKey,
195 pub htlc_basepoint: PublicKey,
196 pub first_per_commitment_point: PublicKey,
197 pub shutdown_scriptpubkey: Option<Script>,
200 pub struct FundingCreated {
201 pub temporary_channel_id: [u8; 32],
202 pub funding_txid: Sha256dHash,
203 pub funding_output_index: u16,
204 pub signature: Signature,
207 pub struct FundingSigned {
208 pub channel_id: [u8; 32],
209 pub signature: Signature,
212 pub struct FundingLocked {
213 pub channel_id: [u8; 32],
214 pub next_per_commitment_point: PublicKey,
217 pub struct Shutdown {
218 pub channel_id: [u8; 32],
219 pub scriptpubkey: Script,
222 pub struct ClosingSigned {
223 pub channel_id: [u8; 32],
224 pub fee_satoshis: u64,
225 pub signature: Signature,
229 pub struct UpdateAddHTLC {
230 pub channel_id: [u8; 32],
232 pub amount_msat: u64,
233 pub payment_hash: [u8; 32],
234 pub cltv_expiry: u32,
235 pub onion_routing_packet: OnionPacket,
239 pub struct UpdateFulfillHTLC {
240 pub channel_id: [u8; 32],
242 pub payment_preimage: [u8; 32],
246 pub struct UpdateFailHTLC {
247 pub channel_id: [u8; 32],
249 pub reason: OnionErrorPacket,
253 pub struct UpdateFailMalformedHTLC {
254 pub channel_id: [u8; 32],
256 pub sha256_of_onion: [u8; 32],
257 pub failure_code: u16,
261 pub struct CommitmentSigned {
262 pub channel_id: [u8; 32],
263 pub signature: Signature,
264 pub htlc_signatures: Vec<Signature>,
267 pub struct RevokeAndACK {
268 pub channel_id: [u8; 32],
269 pub per_commitment_secret: [u8; 32],
270 pub next_per_commitment_point: PublicKey,
273 pub struct UpdateFee {
274 pub channel_id: [u8; 32],
275 pub feerate_per_kw: u32,
278 pub struct ChannelReestablish {
279 pub channel_id: [u8; 32],
280 pub next_local_commitment_number: u64,
281 pub next_remote_commitment_number: u64,
282 pub your_last_per_commitment_secret: Option<[u8; 32]>,
283 pub my_current_per_commitment_point: PublicKey,
287 pub struct AnnouncementSignatures {
288 pub channel_id: [u8; 32],
289 pub short_channel_id: u64,
290 pub node_signature: Signature,
291 pub bitcoin_signature: Signature,
295 pub enum NetAddress {
309 ed25519_pubkey: [u8; 32],
316 fn get_id(&self) -> u8 {
318 &NetAddress::IPv4 {..} => { 1 },
319 &NetAddress::IPv6 {..} => { 2 },
320 &NetAddress::OnionV2 {..} => { 3 },
321 &NetAddress::OnionV3 {..} => { 4 },
326 pub struct UnsignedNodeAnnouncement {
327 pub features: GlobalFeatures,
329 pub node_id: PublicKey,
332 /// List of addresses on which this node is reachable. Note that you may only have up to one
333 /// address of each type, if you have more, they may be silently discarded or we may panic!
334 pub addresses: Vec<NetAddress>,
336 pub struct NodeAnnouncement {
337 pub signature: Signature,
338 pub contents: UnsignedNodeAnnouncement,
341 #[derive(PartialEq, Clone)]
342 pub struct UnsignedChannelAnnouncement {
343 pub features: GlobalFeatures,
344 pub chain_hash: Sha256dHash,
345 pub short_channel_id: u64,
346 pub node_id_1: PublicKey,
347 pub node_id_2: PublicKey,
348 pub bitcoin_key_1: PublicKey,
349 pub bitcoin_key_2: PublicKey,
351 #[derive(PartialEq, Clone)]
352 pub struct ChannelAnnouncement {
353 pub node_signature_1: Signature,
354 pub node_signature_2: Signature,
355 pub bitcoin_signature_1: Signature,
356 pub bitcoin_signature_2: Signature,
357 pub contents: UnsignedChannelAnnouncement,
360 #[derive(PartialEq, Clone)]
361 pub struct UnsignedChannelUpdate {
362 pub chain_hash: Sha256dHash,
363 pub short_channel_id: u64,
366 pub cltv_expiry_delta: u16,
367 pub htlc_minimum_msat: u64,
368 pub fee_base_msat: u32,
369 pub fee_proportional_millionths: u32,
371 #[derive(PartialEq, Clone)]
372 pub struct ChannelUpdate {
373 pub signature: Signature,
374 pub contents: UnsignedChannelUpdate,
377 /// Used to put an error message in a HandleError
378 pub enum ErrorAction {
379 /// The peer took some action which made us think they were useless. Disconnect them.
381 msg: Option<ErrorMessage>
383 /// The peer did something harmless that we weren't able to process, just log and ignore
385 /// The peer did something incorrect. Tell them.
391 pub struct HandleError { //TODO: rename me
392 pub err: &'static str,
393 pub action: Option<ErrorAction>, //TODO: Make this required
396 /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
397 /// transaction updates if they were pending.
398 pub struct CommitmentUpdate {
399 pub update_add_htlcs: Vec<UpdateAddHTLC>,
400 pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
401 pub update_fail_htlcs: Vec<UpdateFailHTLC>,
402 pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
403 pub commitment_signed: CommitmentSigned,
406 pub enum HTLCFailChannelUpdate {
407 ChannelUpdateMessage {
411 short_channel_id: u64,
415 /// A trait to describe an object which can receive channel messages. Messages MAY be called in
416 /// paralell when they originate from different their_node_ids, however they MUST NOT be called in
417 /// paralell when the two calls have the same their_node_id.
418 pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
420 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<AcceptChannel, HandleError>;
421 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
422 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<FundingSigned, HandleError>;
423 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned) -> Result<(), HandleError>;
424 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<Option<AnnouncementSignatures>, HandleError>;
427 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(Option<Shutdown>, Option<ClosingSigned>), HandleError>;
428 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<Option<ClosingSigned>, HandleError>;
431 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
432 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
433 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<Option<HTLCFailChannelUpdate>, HandleError>;
434 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
435 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(RevokeAndACK, Option<CommitmentSigned>), HandleError>;
436 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<CommitmentUpdate>, HandleError>;
438 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
440 // Channel-to-announce:
441 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>;
444 /// Indicates a connection to the peer failed/an existing connection was lost. If no connection
445 /// is believed to be possible in the future (eg they're sending us messages we don't
446 /// understand or indicate they require unknown feature bits), no_connection_possible is set
447 /// and any outstanding channels should be failed.
448 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
450 fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
453 pub trait RoutingMessageHandler : Send + Sync {
454 fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<(), HandleError>;
455 /// Handle a channel_announcement message, returning true if it should be forwarded on, false
456 /// or returning an Err otherwise.
457 fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
458 fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<(), HandleError>;
459 fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
462 pub struct OnionRealm0HopData {
463 pub short_channel_id: u64,
464 pub amt_to_forward: u64,
465 pub outgoing_cltv_value: u32,
466 // 12 bytes of 0-padding
469 pub struct OnionHopData {
471 pub data: OnionRealm0HopData,
474 unsafe impl internal_traits::NoDealloc for OnionHopData{}
477 pub struct OnionPacket {
479 pub public_key: PublicKey,
480 pub hop_data: [u8; 20*65],
484 pub struct DecodedOnionErrorPacket {
486 pub failuremsg: Vec<u8>,
491 pub struct OnionErrorPacket {
492 // This really should be a constant size slice, but the spec lets these things be up to 128KB?
493 // (TODO) We limit it in decode to much lower...
497 impl Error for DecodeError {
498 fn description(&self) -> &str {
500 DecodeError::UnknownRealmByte => "Unknown realm byte in Onion packet",
501 DecodeError::BadPublicKey => "Invalid public key in packet",
502 DecodeError::BadSignature => "Invalid signature in packet",
503 DecodeError::BadText => "Invalid text in packet",
504 DecodeError::ShortRead => "Packet extended beyond the provided bytes",
505 DecodeError::ExtraAddressesPerType => "More than one address of a single type",
506 DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
510 impl fmt::Display for DecodeError {
511 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
512 f.write_str(self.description())
516 impl fmt::Debug for HandleError {
517 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
518 f.write_str(self.err)
522 macro_rules! secp_pubkey {
523 ( $ctx: expr, $slice: expr ) => {
524 match PublicKey::from_slice($ctx, $slice) {
526 Err(_) => return Err(DecodeError::BadPublicKey)
531 macro_rules! secp_signature {
532 ( $ctx: expr, $slice: expr ) => {
533 match Signature::from_compact($ctx, $slice) {
535 Err(_) => return Err(DecodeError::BadSignature)
540 impl MsgDecodable for LocalFeatures {
541 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
542 if v.len() < 2 { return Err(DecodeError::ShortRead); }
543 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
544 if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
545 let mut flags = Vec::with_capacity(len);
546 flags.extend_from_slice(&v[2..2 + len]);
552 impl MsgEncodable for LocalFeatures {
553 fn encode(&self) -> Vec<u8> {
554 let mut res = Vec::with_capacity(self.flags.len() + 2);
555 res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
556 res.extend_from_slice(&self.flags[..]);
559 fn encoded_len(&self) -> usize { self.flags.len() + 2 }
562 impl MsgDecodable for GlobalFeatures {
563 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
564 if v.len() < 2 { return Err(DecodeError::ShortRead); }
565 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
566 if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
567 let mut flags = Vec::with_capacity(len);
568 flags.extend_from_slice(&v[2..2 + len]);
574 impl MsgEncodable for GlobalFeatures {
575 fn encode(&self) -> Vec<u8> {
576 let mut res = Vec::with_capacity(self.flags.len() + 2);
577 res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
578 res.extend_from_slice(&self.flags[..]);
581 fn encoded_len(&self) -> usize { self.flags.len() + 2 }
584 impl MsgDecodable for Init {
585 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
586 let global_features = GlobalFeatures::decode(v)?;
587 if v.len() < global_features.flags.len() + 4 {
588 return Err(DecodeError::ShortRead);
590 let local_features = LocalFeatures::decode(&v[global_features.flags.len() + 2..])?;
592 global_features: global_features,
593 local_features: local_features,
597 impl MsgEncodable for Init {
598 fn encode(&self) -> Vec<u8> {
599 let mut res = Vec::with_capacity(self.global_features.flags.len() + self.local_features.flags.len());
600 res.extend_from_slice(&self.global_features.encode()[..]);
601 res.extend_from_slice(&self.local_features.encode()[..]);
606 impl MsgDecodable for Ping {
607 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
609 return Err(DecodeError::ShortRead);
611 let ponglen = byte_utils::slice_to_be16(&v[0..2]);
612 let byteslen = byte_utils::slice_to_be16(&v[2..4]);
613 if v.len() < 4 + byteslen as usize {
614 return Err(DecodeError::ShortRead);
622 impl MsgEncodable for Ping {
623 fn encode(&self) -> Vec<u8> {
624 let mut res = Vec::with_capacity(self.byteslen as usize + 2);
625 res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
626 res.resize(2 + self.byteslen as usize, 0);
631 impl MsgDecodable for Pong {
632 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
634 return Err(DecodeError::ShortRead);
636 let byteslen = byte_utils::slice_to_be16(&v[0..2]);
637 if v.len() < 2 + byteslen as usize {
638 return Err(DecodeError::ShortRead);
645 impl MsgEncodable for Pong {
646 fn encode(&self) -> Vec<u8> {
647 let mut res = Vec::with_capacity(self.byteslen as usize + 2);
648 res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
649 res.resize(2 + self.byteslen as usize, 0);
654 impl MsgDecodable for OpenChannel {
655 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
656 if v.len() < 2*32+6*8+4+2*2+6*33+1 {
657 return Err(DecodeError::ShortRead);
659 let ctx = Secp256k1::without_caps();
661 let mut shutdown_scriptpubkey = None;
663 let len = byte_utils::slice_to_be16(&v[319..321]) as usize;
664 if v.len() < 321+len {
665 return Err(DecodeError::ShortRead);
667 shutdown_scriptpubkey = Some(Script::from(v[321..321+len].to_vec()));
671 chain_hash: deserialize(&v[0..32]).unwrap(),
672 temporary_channel_id: deserialize(&v[32..64]).unwrap(),
673 funding_satoshis: byte_utils::slice_to_be64(&v[64..72]),
674 push_msat: byte_utils::slice_to_be64(&v[72..80]),
675 dust_limit_satoshis: byte_utils::slice_to_be64(&v[80..88]),
676 max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[88..96]),
677 channel_reserve_satoshis: byte_utils::slice_to_be64(&v[96..104]),
678 htlc_minimum_msat: byte_utils::slice_to_be64(&v[104..112]),
679 feerate_per_kw: byte_utils::slice_to_be32(&v[112..116]),
680 to_self_delay: byte_utils::slice_to_be16(&v[116..118]),
681 max_accepted_htlcs: byte_utils::slice_to_be16(&v[118..120]),
682 funding_pubkey: secp_pubkey!(&ctx, &v[120..153]),
683 revocation_basepoint: secp_pubkey!(&ctx, &v[153..186]),
684 payment_basepoint: secp_pubkey!(&ctx, &v[186..219]),
685 delayed_payment_basepoint: secp_pubkey!(&ctx, &v[219..252]),
686 htlc_basepoint: secp_pubkey!(&ctx, &v[252..285]),
687 first_per_commitment_point: secp_pubkey!(&ctx, &v[285..318]),
688 channel_flags: v[318],
689 shutdown_scriptpubkey: shutdown_scriptpubkey
693 impl MsgEncodable for OpenChannel {
694 fn encode(&self) -> Vec<u8> {
695 let mut res = match &self.shutdown_scriptpubkey {
696 &Some(ref script) => Vec::with_capacity(319 + 2 + script.len()),
697 &None => Vec::with_capacity(319),
699 res.extend_from_slice(&serialize(&self.chain_hash).unwrap());
700 res.extend_from_slice(&serialize(&self.temporary_channel_id).unwrap());
701 res.extend_from_slice(&byte_utils::be64_to_array(self.funding_satoshis));
702 res.extend_from_slice(&byte_utils::be64_to_array(self.push_msat));
703 res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
704 res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
705 res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
706 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
707 res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
708 res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
709 res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
710 res.extend_from_slice(&self.funding_pubkey.serialize());
711 res.extend_from_slice(&self.revocation_basepoint.serialize());
712 res.extend_from_slice(&self.payment_basepoint.serialize());
713 res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
714 res.extend_from_slice(&self.htlc_basepoint.serialize());
715 res.extend_from_slice(&self.first_per_commitment_point.serialize());
716 res.push(self.channel_flags);
717 if let &Some(ref script) = &self.shutdown_scriptpubkey {
718 res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
719 res.extend_from_slice(&script[..]);
725 impl MsgDecodable for AcceptChannel {
726 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
727 if v.len() < 32+4*8+4+2*2+6*33 {
728 return Err(DecodeError::ShortRead);
730 let ctx = Secp256k1::without_caps();
732 let mut shutdown_scriptpubkey = None;
734 let len = byte_utils::slice_to_be16(&v[270..272]) as usize;
735 if v.len() < 272+len {
736 return Err(DecodeError::ShortRead);
738 shutdown_scriptpubkey = Some(Script::from(v[272..272+len].to_vec()));
741 let mut temporary_channel_id = [0; 32];
742 temporary_channel_id[..].copy_from_slice(&v[0..32]);
744 temporary_channel_id,
745 dust_limit_satoshis: byte_utils::slice_to_be64(&v[32..40]),
746 max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[40..48]),
747 channel_reserve_satoshis: byte_utils::slice_to_be64(&v[48..56]),
748 htlc_minimum_msat: byte_utils::slice_to_be64(&v[56..64]),
749 minimum_depth: byte_utils::slice_to_be32(&v[64..68]),
750 to_self_delay: byte_utils::slice_to_be16(&v[68..70]),
751 max_accepted_htlcs: byte_utils::slice_to_be16(&v[70..72]),
752 funding_pubkey: secp_pubkey!(&ctx, &v[72..105]),
753 revocation_basepoint: secp_pubkey!(&ctx, &v[105..138]),
754 payment_basepoint: secp_pubkey!(&ctx, &v[138..171]),
755 delayed_payment_basepoint: secp_pubkey!(&ctx, &v[171..204]),
756 htlc_basepoint: secp_pubkey!(&ctx, &v[204..237]),
757 first_per_commitment_point: secp_pubkey!(&ctx, &v[237..270]),
758 shutdown_scriptpubkey: shutdown_scriptpubkey
762 impl MsgEncodable for AcceptChannel {
763 fn encode(&self) -> Vec<u8> {
764 let mut res = match &self.shutdown_scriptpubkey {
765 &Some(ref script) => Vec::with_capacity(270 + 2 + script.len()),
766 &None => Vec::with_capacity(270),
768 res.extend_from_slice(&self.temporary_channel_id);
769 res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
770 res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
771 res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
772 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
773 res.extend_from_slice(&byte_utils::be32_to_array(self.minimum_depth));
774 res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
775 res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
776 res.extend_from_slice(&self.funding_pubkey.serialize());
777 res.extend_from_slice(&self.revocation_basepoint.serialize());
778 res.extend_from_slice(&self.payment_basepoint.serialize());
779 res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
780 res.extend_from_slice(&self.htlc_basepoint.serialize());
781 res.extend_from_slice(&self.first_per_commitment_point.serialize());
782 if let &Some(ref script) = &self.shutdown_scriptpubkey {
783 res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
784 res.extend_from_slice(&script[..]);
790 impl MsgDecodable for FundingCreated {
791 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
792 if v.len() < 32+32+2+64 {
793 return Err(DecodeError::ShortRead);
795 let ctx = Secp256k1::without_caps();
796 let mut temporary_channel_id = [0; 32];
797 temporary_channel_id[..].copy_from_slice(&v[0..32]);
799 temporary_channel_id,
800 funding_txid: deserialize(&v[32..64]).unwrap(),
801 funding_output_index: byte_utils::slice_to_be16(&v[64..66]),
802 signature: secp_signature!(&ctx, &v[66..130]),
806 impl MsgEncodable for FundingCreated {
807 fn encode(&self) -> Vec<u8> {
808 let mut res = Vec::with_capacity(32+32+2+64);
809 res.extend_from_slice(&self.temporary_channel_id);
810 res.extend_from_slice(&serialize(&self.funding_txid).unwrap()[..]);
811 res.extend_from_slice(&byte_utils::be16_to_array(self.funding_output_index));
812 let secp_ctx = Secp256k1::without_caps();
813 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
818 impl MsgDecodable for FundingSigned {
819 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
821 return Err(DecodeError::ShortRead);
823 let ctx = Secp256k1::without_caps();
824 let mut channel_id = [0; 32];
825 channel_id[..].copy_from_slice(&v[0..32]);
828 signature: secp_signature!(&ctx, &v[32..96]),
832 impl MsgEncodable for FundingSigned {
833 fn encode(&self) -> Vec<u8> {
834 let mut res = Vec::with_capacity(32+64);
835 res.extend_from_slice(&self.channel_id);
836 res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps()));
841 impl MsgDecodable for FundingLocked {
842 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
844 return Err(DecodeError::ShortRead);
846 let ctx = Secp256k1::without_caps();
847 let mut channel_id = [0; 32];
848 channel_id[..].copy_from_slice(&v[0..32]);
851 next_per_commitment_point: secp_pubkey!(&ctx, &v[32..65]),
855 impl MsgEncodable for FundingLocked {
856 fn encode(&self) -> Vec<u8> {
857 let mut res = Vec::with_capacity(32+33);
858 res.extend_from_slice(&self.channel_id);
859 res.extend_from_slice(&self.next_per_commitment_point.serialize());
864 impl MsgDecodable for Shutdown {
865 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
866 if v.len() < 32 + 2 {
867 return Err(DecodeError::ShortRead);
869 let scriptlen = byte_utils::slice_to_be16(&v[32..34]) as usize;
870 if v.len() < 32 + 2 + scriptlen {
871 return Err(DecodeError::ShortRead);
873 let mut channel_id = [0; 32];
874 channel_id[..].copy_from_slice(&v[0..32]);
877 scriptpubkey: Script::from(v[34..34 + scriptlen].to_vec()),
881 impl MsgEncodable for Shutdown {
882 fn encode(&self) -> Vec<u8> {
883 let mut res = Vec::with_capacity(32 + 2 + self.scriptpubkey.len());
884 res.extend_from_slice(&self.channel_id);
885 res.extend_from_slice(&byte_utils::be16_to_array(self.scriptpubkey.len() as u16));
886 res.extend_from_slice(&self.scriptpubkey[..]);
891 impl MsgDecodable for ClosingSigned {
892 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
893 if v.len() < 32 + 8 + 64 {
894 return Err(DecodeError::ShortRead);
896 let secp_ctx = Secp256k1::without_caps();
897 let mut channel_id = [0; 32];
898 channel_id[..].copy_from_slice(&v[0..32]);
901 fee_satoshis: byte_utils::slice_to_be64(&v[32..40]),
902 signature: secp_signature!(&secp_ctx, &v[40..104]),
906 impl MsgEncodable for ClosingSigned {
907 fn encode(&self) -> Vec<u8> {
908 let mut res = Vec::with_capacity(32+8+64);
909 res.extend_from_slice(&self.channel_id);
910 res.extend_from_slice(&byte_utils::be64_to_array(self.fee_satoshis));
911 let secp_ctx = Secp256k1::without_caps();
912 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
917 impl MsgDecodable for UpdateAddHTLC {
918 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
919 if v.len() < 32+8+8+32+4+1+33+20*65+32 {
920 return Err(DecodeError::ShortRead);
922 let mut channel_id = [0; 32];
923 channel_id[..].copy_from_slice(&v[0..32]);
924 let mut payment_hash = [0; 32];
925 payment_hash.copy_from_slice(&v[48..80]);
928 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
929 amount_msat: byte_utils::slice_to_be64(&v[40..48]),
931 cltv_expiry: byte_utils::slice_to_be32(&v[80..84]),
932 onion_routing_packet: OnionPacket::decode(&v[84..84+1366])?,
936 impl MsgEncodable for UpdateAddHTLC {
937 fn encode(&self) -> Vec<u8> {
938 let mut res = Vec::with_capacity(32+8+8+32+4+1366);
939 res.extend_from_slice(&self.channel_id);
940 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
941 res.extend_from_slice(&byte_utils::be64_to_array(self.amount_msat));
942 res.extend_from_slice(&self.payment_hash);
943 res.extend_from_slice(&byte_utils::be32_to_array(self.cltv_expiry));
944 res.extend_from_slice(&self.onion_routing_packet.encode()[..]);
949 impl MsgDecodable for UpdateFulfillHTLC {
950 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
951 if v.len() < 32+8+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_preimage = [0; 32];
957 payment_preimage.copy_from_slice(&v[40..72]);
960 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
965 impl MsgEncodable for UpdateFulfillHTLC {
966 fn encode(&self) -> Vec<u8> {
967 let mut res = Vec::with_capacity(32+8+32);
968 res.extend_from_slice(&self.channel_id);
969 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
970 res.extend_from_slice(&self.payment_preimage);
975 impl MsgDecodable for UpdateFailHTLC {
976 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
978 return Err(DecodeError::ShortRead);
980 let mut channel_id = [0; 32];
981 channel_id[..].copy_from_slice(&v[0..32]);
984 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
985 reason: OnionErrorPacket::decode(&v[40..])?,
989 impl MsgEncodable for UpdateFailHTLC {
990 fn encode(&self) -> Vec<u8> {
991 let reason = self.reason.encode();
992 let mut res = Vec::with_capacity(32+8+reason.len());
993 res.extend_from_slice(&self.channel_id);
994 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
995 res.extend_from_slice(&reason[..]);
1000 impl MsgDecodable for UpdateFailMalformedHTLC {
1001 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1002 if v.len() < 32+8+32+2 {
1003 return Err(DecodeError::ShortRead);
1005 let mut channel_id = [0; 32];
1006 channel_id[..].copy_from_slice(&v[0..32]);
1007 let mut sha256_of_onion = [0; 32];
1008 sha256_of_onion.copy_from_slice(&v[40..72]);
1011 htlc_id: byte_utils::slice_to_be64(&v[32..40]),
1013 failure_code: byte_utils::slice_to_be16(&v[72..74]),
1017 impl MsgEncodable for UpdateFailMalformedHTLC {
1018 fn encode(&self) -> Vec<u8> {
1019 let mut res = Vec::with_capacity(32+8+32+2);
1020 res.extend_from_slice(&self.channel_id);
1021 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
1022 res.extend_from_slice(&self.sha256_of_onion);
1023 res.extend_from_slice(&byte_utils::be16_to_array(self.failure_code));
1028 impl MsgDecodable for CommitmentSigned {
1029 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1030 if v.len() < 32+64+2 {
1031 return Err(DecodeError::ShortRead);
1033 let mut channel_id = [0; 32];
1034 channel_id[..].copy_from_slice(&v[0..32]);
1036 let htlcs = byte_utils::slice_to_be16(&v[96..98]) as usize;
1037 if v.len() < 32+64+2+htlcs*64 {
1038 return Err(DecodeError::ShortRead);
1040 let mut htlc_signatures = Vec::with_capacity(htlcs);
1041 let secp_ctx = Secp256k1::without_caps();
1043 htlc_signatures.push(secp_signature!(&secp_ctx, &v[98+i*64..98+(i+1)*64]));
1047 signature: secp_signature!(&secp_ctx, &v[32..96]),
1052 impl MsgEncodable for CommitmentSigned {
1053 fn encode(&self) -> Vec<u8> {
1054 let mut res = Vec::with_capacity(32+64+2+self.htlc_signatures.len()*64);
1055 res.extend_from_slice(&self.channel_id);
1056 let secp_ctx = Secp256k1::without_caps();
1057 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
1058 res.extend_from_slice(&byte_utils::be16_to_array(self.htlc_signatures.len() as u16));
1059 for i in 0..self.htlc_signatures.len() {
1060 res.extend_from_slice(&self.htlc_signatures[i].serialize_compact(&secp_ctx));
1066 impl MsgDecodable for RevokeAndACK {
1067 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1068 if v.len() < 32+32+33 {
1069 return Err(DecodeError::ShortRead);
1071 let mut channel_id = [0; 32];
1072 channel_id[..].copy_from_slice(&v[0..32]);
1073 let mut per_commitment_secret = [0; 32];
1074 per_commitment_secret.copy_from_slice(&v[32..64]);
1075 let secp_ctx = Secp256k1::without_caps();
1078 per_commitment_secret,
1079 next_per_commitment_point: secp_pubkey!(&secp_ctx, &v[64..97]),
1083 impl MsgEncodable for RevokeAndACK {
1084 fn encode(&self) -> Vec<u8> {
1085 let mut res = Vec::with_capacity(32+32+33);
1086 res.extend_from_slice(&self.channel_id);
1087 res.extend_from_slice(&self.per_commitment_secret);
1088 res.extend_from_slice(&self.next_per_commitment_point.serialize());
1093 impl MsgDecodable for UpdateFee {
1094 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1096 return Err(DecodeError::ShortRead);
1098 let mut channel_id = [0; 32];
1099 channel_id[..].copy_from_slice(&v[0..32]);
1102 feerate_per_kw: byte_utils::slice_to_be32(&v[32..36]),
1106 impl MsgEncodable for UpdateFee {
1107 fn encode(&self) -> Vec<u8> {
1108 let mut res = Vec::with_capacity(32+4);
1109 res.extend_from_slice(&self.channel_id);
1110 res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
1115 impl MsgDecodable for ChannelReestablish {
1116 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1117 if v.len() < 32+2*8+33 {
1118 return Err(DecodeError::ShortRead);
1121 let your_last_per_commitment_secret = if v.len() > 32+2*8+33 {
1122 if v.len() < 32+2*8+33 + 32 {
1123 return Err(DecodeError::ShortRead);
1125 let mut inner_array = [0; 32];
1126 inner_array.copy_from_slice(&v[48..48+32]);
1130 let option_size = match &your_last_per_commitment_secret {
1131 &Some(ref _ary) => 32,
1135 channel_id: deserialize(&v[0..32]).unwrap(),
1136 next_local_commitment_number: byte_utils::slice_to_be64(&v[32..40]),
1137 next_remote_commitment_number: byte_utils::slice_to_be64(&v[40..48]),
1138 your_last_per_commitment_secret: your_last_per_commitment_secret,
1139 my_current_per_commitment_point: {
1140 let ctx = Secp256k1::without_caps();
1141 secp_pubkey!(&ctx, &v[48+option_size..48+option_size+33])
1146 impl MsgEncodable for ChannelReestablish {
1147 fn encode(&self) -> Vec<u8> {
1148 let mut res = Vec::with_capacity(if self.your_last_per_commitment_secret.is_some() { 32+2*3+33 + 32 } else { 32+2*8+33 });
1150 res.extend_from_slice(&serialize(&self.channel_id).unwrap()[..]);
1151 res.extend_from_slice(&byte_utils::be64_to_array(self.next_local_commitment_number));
1152 res.extend_from_slice(&byte_utils::be64_to_array(self.next_remote_commitment_number));
1154 if let &Some(ref ary) = &self.your_last_per_commitment_secret {
1155 res.extend_from_slice(&ary[..]);
1158 res.extend_from_slice(&self.my_current_per_commitment_point.serialize());
1163 impl MsgDecodable for AnnouncementSignatures {
1164 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1165 if v.len() < 32+8+64*2 {
1166 return Err(DecodeError::ShortRead);
1168 let secp_ctx = Secp256k1::without_caps();
1169 let mut channel_id = [0; 32];
1170 channel_id[..].copy_from_slice(&v[0..32]);
1173 short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
1174 node_signature: secp_signature!(&secp_ctx, &v[40..104]),
1175 bitcoin_signature: secp_signature!(&secp_ctx, &v[104..168]),
1179 impl MsgEncodable for AnnouncementSignatures {
1180 fn encode(&self) -> Vec<u8> {
1181 let mut res = Vec::with_capacity(32+8+64*2);
1182 res.extend_from_slice(&self.channel_id);
1183 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1184 let secp_ctx = Secp256k1::without_caps();
1185 res.extend_from_slice(&self.node_signature.serialize_compact(&secp_ctx));
1186 res.extend_from_slice(&self.bitcoin_signature.serialize_compact(&secp_ctx));
1191 impl MsgDecodable for UnsignedNodeAnnouncement {
1192 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1193 let features = GlobalFeatures::decode(&v[..])?;
1194 if v.len() < features.encoded_len() + 4 + 33 + 3 + 32 + 2 {
1195 return Err(DecodeError::ShortRead);
1197 let start = features.encoded_len();
1199 let mut rgb = [0; 3];
1200 rgb.copy_from_slice(&v[start + 37..start + 40]);
1202 let mut alias = [0; 32];
1203 alias.copy_from_slice(&v[start + 40..start + 72]);
1205 let addrlen = byte_utils::slice_to_be16(&v[start + 72..start + 74]) as usize;
1206 if v.len() < start + 74 + addrlen {
1207 return Err(DecodeError::ShortRead);
1209 let addr_read_limit = start + 74 + addrlen;
1211 let mut addresses = Vec::with_capacity(4);
1212 let mut read_pos = start + 74;
1214 if addr_read_limit <= read_pos { break; }
1216 0 => { read_pos += 1; },
1218 if addresses.len() > 0 {
1219 return Err(DecodeError::ExtraAddressesPerType);
1221 if addr_read_limit < read_pos + 1 + 6 {
1222 return Err(DecodeError::BadLengthDescriptor);
1224 let mut addr = [0; 4];
1225 addr.copy_from_slice(&v[read_pos + 1..read_pos + 5]);
1226 addresses.push(NetAddress::IPv4 {
1228 port: byte_utils::slice_to_be16(&v[read_pos + 5..read_pos + 7]),
1233 if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
1234 return Err(DecodeError::ExtraAddressesPerType);
1236 if addr_read_limit < read_pos + 1 + 18 {
1237 return Err(DecodeError::BadLengthDescriptor);
1239 let mut addr = [0; 16];
1240 addr.copy_from_slice(&v[read_pos + 1..read_pos + 17]);
1241 addresses.push(NetAddress::IPv6 {
1243 port: byte_utils::slice_to_be16(&v[read_pos + 17..read_pos + 19]),
1248 if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
1249 return Err(DecodeError::ExtraAddressesPerType);
1251 if addr_read_limit < read_pos + 1 + 12 {
1252 return Err(DecodeError::BadLengthDescriptor);
1254 let mut addr = [0; 10];
1255 addr.copy_from_slice(&v[read_pos + 1..read_pos + 11]);
1256 addresses.push(NetAddress::OnionV2 {
1258 port: byte_utils::slice_to_be16(&v[read_pos + 11..read_pos + 13]),
1263 if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
1264 return Err(DecodeError::ExtraAddressesPerType);
1266 if addr_read_limit < read_pos + 1 + 37 {
1267 return Err(DecodeError::BadLengthDescriptor);
1269 let mut ed25519_pubkey = [0; 32];
1270 ed25519_pubkey.copy_from_slice(&v[read_pos + 1..read_pos + 33]);
1271 addresses.push(NetAddress::OnionV3 {
1273 checksum: byte_utils::slice_to_be16(&v[read_pos + 33..read_pos + 35]),
1274 version: v[read_pos + 35],
1275 port: byte_utils::slice_to_be16(&v[read_pos + 36..read_pos + 38]),
1279 _ => { break; } // We've read all we can, we dont understand anything higher (and they're sorted)
1283 let secp_ctx = Secp256k1::without_caps();
1286 timestamp: byte_utils::slice_to_be32(&v[start..start + 4]),
1287 node_id: secp_pubkey!(&secp_ctx, &v[start + 4..start + 37]),
1294 impl MsgEncodable for UnsignedNodeAnnouncement {
1295 fn encode(&self) -> Vec<u8> {
1296 let features = self.features.encode();
1297 let mut res = Vec::with_capacity(74 + features.len() + self.addresses.len());
1298 res.extend_from_slice(&features[..]);
1299 res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
1300 res.extend_from_slice(&self.node_id.serialize());
1301 res.extend_from_slice(&self.rgb);
1302 res.extend_from_slice(&self.alias);
1303 let mut addr_slice = Vec::with_capacity(self.addresses.len() * 18);
1304 let mut addrs_to_encode = self.addresses.clone();
1305 addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
1306 addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
1307 for addr in addrs_to_encode.iter() {
1309 &NetAddress::IPv4{addr, port} => {
1311 addr_slice.extend_from_slice(&addr);
1312 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1314 &NetAddress::IPv6{addr, port} => {
1316 addr_slice.extend_from_slice(&addr);
1317 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1319 &NetAddress::OnionV2{addr, port} => {
1321 addr_slice.extend_from_slice(&addr);
1322 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1324 &NetAddress::OnionV3{ed25519_pubkey, checksum, version, port} => {
1326 addr_slice.extend_from_slice(&ed25519_pubkey);
1327 addr_slice.extend_from_slice(&byte_utils::be16_to_array(checksum));
1328 addr_slice.push(version);
1329 addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
1333 res.extend_from_slice(&byte_utils::be16_to_array(addr_slice.len() as u16));
1334 res.extend_from_slice(&addr_slice[..]);
1339 impl MsgDecodable for NodeAnnouncement {
1340 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1342 return Err(DecodeError::ShortRead);
1344 let secp_ctx = Secp256k1::without_caps();
1346 signature: secp_signature!(&secp_ctx, &v[0..64]),
1347 contents: UnsignedNodeAnnouncement::decode(&v[64..])?,
1351 impl MsgEncodable for NodeAnnouncement {
1352 fn encode(&self) -> Vec<u8> {
1353 let contents = self.contents.encode();
1354 let mut res = Vec::with_capacity(64 + contents.len());
1355 let secp_ctx = Secp256k1::without_caps();
1356 res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
1357 res.extend_from_slice(&contents);
1362 impl MsgDecodable for UnsignedChannelAnnouncement {
1363 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1364 let features = GlobalFeatures::decode(&v[..])?;
1365 if v.len() < features.encoded_len() + 32 + 8 + 33*4 {
1366 return Err(DecodeError::ShortRead);
1368 let start = features.encoded_len();
1369 let secp_ctx = Secp256k1::without_caps();
1372 chain_hash: deserialize(&v[start..start + 32]).unwrap(),
1373 short_channel_id: byte_utils::slice_to_be64(&v[start + 32..start + 40]),
1374 node_id_1: secp_pubkey!(&secp_ctx, &v[start + 40..start + 73]),
1375 node_id_2: secp_pubkey!(&secp_ctx, &v[start + 73..start + 106]),
1376 bitcoin_key_1: secp_pubkey!(&secp_ctx, &v[start + 106..start + 139]),
1377 bitcoin_key_2: secp_pubkey!(&secp_ctx, &v[start + 139..start + 172]),
1381 impl MsgEncodable for UnsignedChannelAnnouncement {
1382 fn encode(&self) -> Vec<u8> {
1383 let features = self.features.encode();
1384 let mut res = Vec::with_capacity(172 + features.len());
1385 res.extend_from_slice(&features[..]);
1386 res.extend_from_slice(&self.chain_hash[..]);
1387 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1388 res.extend_from_slice(&self.node_id_1.serialize());
1389 res.extend_from_slice(&self.node_id_2.serialize());
1390 res.extend_from_slice(&self.bitcoin_key_1.serialize());
1391 res.extend_from_slice(&self.bitcoin_key_2.serialize());
1396 impl MsgDecodable for ChannelAnnouncement {
1397 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1399 return Err(DecodeError::ShortRead);
1401 let secp_ctx = Secp256k1::without_caps();
1403 node_signature_1: secp_signature!(&secp_ctx, &v[0..64]),
1404 node_signature_2: secp_signature!(&secp_ctx, &v[64..128]),
1405 bitcoin_signature_1: secp_signature!(&secp_ctx, &v[128..192]),
1406 bitcoin_signature_2: secp_signature!(&secp_ctx, &v[192..256]),
1407 contents: UnsignedChannelAnnouncement::decode(&v[256..])?,
1411 impl MsgEncodable for ChannelAnnouncement {
1412 fn encode(&self) -> Vec<u8> {
1413 let secp_ctx = Secp256k1::without_caps();
1414 let contents = self.contents.encode();
1415 let mut res = Vec::with_capacity(64 + contents.len());
1416 res.extend_from_slice(&self.node_signature_1.serialize_compact(&secp_ctx));
1417 res.extend_from_slice(&self.node_signature_2.serialize_compact(&secp_ctx));
1418 res.extend_from_slice(&self.bitcoin_signature_1.serialize_compact(&secp_ctx));
1419 res.extend_from_slice(&self.bitcoin_signature_2.serialize_compact(&secp_ctx));
1420 res.extend_from_slice(&contents);
1425 impl MsgDecodable for UnsignedChannelUpdate {
1426 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1427 if v.len() < 32+8+4+2+2+8+4+4 {
1428 return Err(DecodeError::ShortRead);
1431 chain_hash: deserialize(&v[0..32]).unwrap(),
1432 short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
1433 timestamp: byte_utils::slice_to_be32(&v[40..44]),
1434 flags: byte_utils::slice_to_be16(&v[44..46]),
1435 cltv_expiry_delta: byte_utils::slice_to_be16(&v[46..48]),
1436 htlc_minimum_msat: byte_utils::slice_to_be64(&v[48..56]),
1437 fee_base_msat: byte_utils::slice_to_be32(&v[56..60]),
1438 fee_proportional_millionths: byte_utils::slice_to_be32(&v[60..64]),
1442 impl MsgEncodable for UnsignedChannelUpdate {
1443 fn encode(&self) -> Vec<u8> {
1444 let mut res = Vec::with_capacity(64);
1445 res.extend_from_slice(&self.chain_hash[..]);
1446 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1447 res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
1448 res.extend_from_slice(&byte_utils::be16_to_array(self.flags));
1449 res.extend_from_slice(&byte_utils::be16_to_array(self.cltv_expiry_delta));
1450 res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
1451 res.extend_from_slice(&byte_utils::be32_to_array(self.fee_base_msat));
1452 res.extend_from_slice(&byte_utils::be32_to_array(self.fee_proportional_millionths));
1457 impl MsgDecodable for ChannelUpdate {
1458 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1460 return Err(DecodeError::ShortRead);
1462 let secp_ctx = Secp256k1::without_caps();
1464 signature: secp_signature!(&secp_ctx, &v[0..64]),
1465 contents: UnsignedChannelUpdate::decode(&v[64..])?,
1469 impl MsgEncodable for ChannelUpdate {
1470 fn encode(&self) -> Vec<u8> {
1471 let mut res = Vec::with_capacity(128);
1472 res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps())[..]);
1473 res.extend_from_slice(&self.contents.encode()[..]);
1478 impl MsgDecodable for OnionRealm0HopData {
1479 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1481 return Err(DecodeError::ShortRead);
1483 Ok(OnionRealm0HopData {
1484 short_channel_id: byte_utils::slice_to_be64(&v[0..8]),
1485 amt_to_forward: byte_utils::slice_to_be64(&v[8..16]),
1486 outgoing_cltv_value: byte_utils::slice_to_be32(&v[16..20]),
1490 impl MsgEncodable for OnionRealm0HopData {
1491 fn encode(&self) -> Vec<u8> {
1492 let mut res = Vec::with_capacity(32);
1493 res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
1494 res.extend_from_slice(&byte_utils::be64_to_array(self.amt_to_forward));
1495 res.extend_from_slice(&byte_utils::be32_to_array(self.outgoing_cltv_value));
1501 impl MsgDecodable for OnionHopData {
1502 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1504 return Err(DecodeError::ShortRead);
1508 return Err(DecodeError::UnknownRealmByte);
1510 let mut hmac = [0; 32];
1511 hmac[..].copy_from_slice(&v[33..65]);
1514 data: OnionRealm0HopData::decode(&v[1..33])?,
1519 impl MsgEncodable for OnionHopData {
1520 fn encode(&self) -> Vec<u8> {
1521 let mut res = Vec::with_capacity(65);
1522 res.push(self.realm);
1523 res.extend_from_slice(&self.data.encode()[..]);
1524 res.extend_from_slice(&self.hmac);
1529 impl MsgDecodable for OnionPacket {
1530 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1531 if v.len() < 1+33+20*65+32 {
1532 return Err(DecodeError::ShortRead);
1534 let mut hop_data = [0; 20*65];
1535 hop_data.copy_from_slice(&v[34..1334]);
1536 let mut hmac = [0; 32];
1537 hmac.copy_from_slice(&v[1334..1366]);
1538 let secp_ctx = Secp256k1::without_caps();
1541 public_key: secp_pubkey!(&secp_ctx, &v[1..34]),
1547 impl MsgEncodable for OnionPacket {
1548 fn encode(&self) -> Vec<u8> {
1549 let mut res = Vec::with_capacity(1 + 33 + 20*65 + 32);
1550 res.push(self.version);
1551 res.extend_from_slice(&self.public_key.serialize());
1552 res.extend_from_slice(&self.hop_data);
1553 res.extend_from_slice(&self.hmac);
1558 impl MsgDecodable for DecodedOnionErrorPacket {
1559 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1560 if v.len() < 32 + 4 {
1561 return Err(DecodeError::ShortRead);
1563 let failuremsg_len = byte_utils::slice_to_be16(&v[32..34]) as usize;
1564 if v.len() < 32 + 4 + failuremsg_len {
1565 return Err(DecodeError::ShortRead);
1567 let padding_len = byte_utils::slice_to_be16(&v[34 + failuremsg_len..]) as usize;
1568 if v.len() < 32 + 4 + failuremsg_len + padding_len {
1569 return Err(DecodeError::ShortRead);
1572 let mut hmac = [0; 32];
1573 hmac.copy_from_slice(&v[0..32]);
1576 failuremsg: v[34..34 + failuremsg_len].to_vec(),
1577 pad: v[36 + failuremsg_len..36 + failuremsg_len + padding_len].to_vec(),
1581 impl MsgEncodable for DecodedOnionErrorPacket {
1582 fn encode(&self) -> Vec<u8> {
1583 let mut res = Vec::with_capacity(32 + 4 + self.failuremsg.len() + self.pad.len());
1584 res.extend_from_slice(&self.hmac);
1585 res.extend_from_slice(&[((self.failuremsg.len() >> 8) & 0xff) as u8, (self.failuremsg.len() & 0xff) as u8]);
1586 res.extend_from_slice(&self.failuremsg);
1587 res.extend_from_slice(&[((self.pad.len() >> 8) & 0xff) as u8, (self.pad.len() & 0xff) as u8]);
1588 res.extend_from_slice(&self.pad);
1593 impl MsgDecodable for OnionErrorPacket {
1594 fn decode(v: &[u8]) -> Result<Self, DecodeError> {
1596 return Err(DecodeError::ShortRead);
1598 let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
1599 if v.len() < 2 + len {
1600 return Err(DecodeError::ShortRead);
1603 data: v[2..len+2].to_vec(),
1607 impl MsgEncodable for OnionErrorPacket {
1608 fn encode(&self) -> Vec<u8> {
1609 let mut res = Vec::with_capacity(2 + self.data.len());
1610 res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
1611 res.extend_from_slice(&self.data);
1616 impl MsgEncodable for ErrorMessage {
1617 fn encode(&self) -> Vec<u8> {
1618 let mut res = Vec::with_capacity(34 + self.data.len());
1619 res.extend_from_slice(&self.channel_id);
1620 res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
1621 res.extend_from_slice(&self.data.as_bytes());
1625 impl MsgDecodable for ErrorMessage {
1626 fn decode(v: &[u8]) -> Result<Self,DecodeError> {
1628 return Err(DecodeError::ShortRead);
1630 // Unlike most messages, BOLT 1 requires we truncate our read if the value is out of range
1631 let len = cmp::min(byte_utils::slice_to_be16(&v[32..34]) as usize, v.len() - 34);
1632 let data = match String::from_utf8(v[34..34 + len].to_vec()) {
1634 Err(_) => return Err(DecodeError::BadText),
1636 let mut channel_id = [0; 32];
1637 channel_id[..].copy_from_slice(&v[0..32]);
1648 use ln::msgs::MsgEncodable;
1650 use secp256k1::key::{PublicKey,SecretKey};
1651 use secp256k1::Secp256k1;
1654 fn encoding_channel_reestablish_no_secret() {
1656 let secp_ctx = Secp256k1::new();
1657 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1660 let cr = msgs::ChannelReestablish {
1661 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],
1662 next_local_commitment_number: 3,
1663 next_remote_commitment_number: 4,
1664 your_last_per_commitment_secret: None,
1665 my_current_per_commitment_point: public_key,
1668 let encoded_value = cr.encode();
1671 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, 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]
1676 fn encoding_channel_reestablish_with_secret() {
1678 let secp_ctx = Secp256k1::new();
1679 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
1682 let cr = msgs::ChannelReestablish {
1683 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],
1684 next_local_commitment_number: 3,
1685 next_remote_commitment_number: 4,
1686 your_last_per_commitment_secret: Some([9; 32]),
1687 my_current_per_commitment_point: public_key,
1690 let encoded_value = cr.encode();
1693 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]