+//! Wire messages, traits representing wire message handlers, and a few error types live here.
+//!
+//! For a normal node you probably don't need to use anything here, however, if you wish to split a
+//! node into an internet-facing route/message socket handling daemon and a separate daemon (or
+//! server entirely) which handles only channel-related messages you may wish to implement
+//! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
+//! daemons/servers.
+//!
+//! Note that if you go with such an architecture (instead of passing raw socket events to a
+//! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
+//! source node_id of the message, however this does allow you to significantly reduce bandwidth
+//! between the systems as routing messages can represent a significant chunk of bandwidth usage
+//! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids
+//! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send
+//! raw socket events into your non-internet-facing system and then send routing events back to
+//! track the network on the less-secure system.
+
use secp256k1::key::PublicKey;
-use secp256k1::{Secp256k1, Signature};
+use secp256k1::Signature;
use secp256k1;
-use bitcoin::util::hash::Sha256dHash;
-use bitcoin::network::serialize::{deserialize,serialize};
+use bitcoin_hashes::sha256d::Hash as Sha256dHash;
use bitcoin::blockdata::script::Script;
use std::error::Error;
use std::{cmp, fmt};
+use std::io::Read;
use std::result::Result;
-use util::{byte_utils, internal_traits, events};
-use util::ser::{Readable, Reader, Writeable, Writer};
+use util::events;
+use util::ser::{Readable, Writeable, Writer};
-pub trait MsgEncodable {
- fn encode(&self) -> Vec<u8>;
- #[inline]
- fn encoded_len(&self) -> usize { self.encode().len() }
- #[inline]
- fn encode_with_len(&self) -> Vec<u8> {
- let enc = self.encode();
- let mut res = Vec::with_capacity(enc.len() + 2);
- res.extend_from_slice(&byte_utils::be16_to_array(enc.len() as u16));
- res.extend_from_slice(&enc);
- res
- }
-}
+use ln::channelmanager::{PaymentPreimage, PaymentHash};
+
+/// An error in decoding a message or struct.
#[derive(Debug)]
pub enum DecodeError {
- /// Unknown realm byte in an OnionHopData packet
- UnknownRealmByte,
+ /// A version byte specified something we don't know how to handle.
+ /// Includes unknown realm byte in an OnionHopData packet
+ UnknownVersion,
/// Unknown feature mandating we fail to parse message
UnknownRequiredFeature,
- /// Failed to decode a public key (ie it's invalid)
- BadPublicKey,
- /// Failed to decode a signature (ie it's invalid)
- BadSignature,
- /// Value expected to be text wasn't decodable as text
- BadText,
+ /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
+ /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc
+ InvalidValue,
/// Buffer too short
ShortRead,
/// node_announcement included more than one address of a given type!
ExtraAddressesPerType,
/// A length descriptor in the packet didn't describe the later data correctly
- /// (currently only generated in node_announcement)
BadLengthDescriptor,
/// Error from std::io
Io(::std::io::Error),
- /// 1 or 0 is not found for boolean value
- InvalidValue,
-}
-pub trait MsgDecodable: Sized {
- fn decode(v: &[u8]) -> Result<Self, DecodeError>;
}
/// Tracks localfeatures which are only in init messages
}
impl LocalFeatures {
+ /// Create a blank LocalFeatures flags (visibility extended for fuzz tests)
+ #[cfg(not(feature = "fuzztarget"))]
+ pub(crate) fn new() -> LocalFeatures {
+ LocalFeatures {
+ flags: vec![2 | 1 << 5],
+ }
+ }
+ #[cfg(feature = "fuzztarget")]
pub fn new() -> LocalFeatures {
LocalFeatures {
- flags: Vec::new(),
+ flags: vec![2 | 1 << 5],
}
}
- pub fn supports_data_loss_protect(&self) -> bool {
+ pub(crate) fn supports_data_loss_protect(&self) -> bool {
self.flags.len() > 0 && (self.flags[0] & 3) != 0
}
- pub fn requires_data_loss_protect(&self) -> bool {
- self.flags.len() > 0 && (self.flags[0] & 1) != 0
- }
-
- pub fn initial_routing_sync(&self) -> bool {
+ pub(crate) fn initial_routing_sync(&self) -> bool {
self.flags.len() > 0 && (self.flags[0] & (1 << 3)) != 0
}
- pub fn set_initial_routing_sync(&mut self) {
+ pub(crate) fn set_initial_routing_sync(&mut self) {
if self.flags.len() == 0 {
self.flags.resize(1, 1 << 3);
} else {
}
}
- pub fn supports_upfront_shutdown_script(&self) -> bool {
+ pub(crate) fn supports_upfront_shutdown_script(&self) -> bool {
self.flags.len() > 0 && (self.flags[0] & (3 << 4)) != 0
}
- pub fn requires_upfront_shutdown_script(&self) -> bool {
- self.flags.len() > 0 && (self.flags[0] & (1 << 4)) != 0
+ #[cfg(test)]
+ pub(crate) fn unset_upfront_shutdown_script(&mut self) {
+ self.flags[0] ^= 1 << 5;
}
- pub fn requires_unknown_bits(&self) -> bool {
- for (idx, &byte) in self.flags.iter().enumerate() {
- if idx != 0 && (byte & 0x55) != 0 {
- return true;
- } else if idx == 0 && (byte & 0x14) != 0 {
- return true;
- }
- }
- return false;
+ pub(crate) fn requires_unknown_bits(&self) -> bool {
+ self.flags.iter().enumerate().any(|(idx, &byte)| {
+ ( idx != 0 && (byte & 0x55) != 0 ) || ( idx == 0 && (byte & 0x14) != 0 )
+ })
}
- pub fn supports_unknown_bits(&self) -> bool {
- for (idx, &byte) in self.flags.iter().enumerate() {
- if idx != 0 && byte != 0 {
- return true;
- } else if idx == 0 && (byte & 0xc4) != 0 {
- return true;
- }
- }
- return false;
+ pub(crate) fn supports_unknown_bits(&self) -> bool {
+ self.flags.iter().enumerate().any(|(idx, &byte)| {
+ ( idx != 0 && byte != 0 ) || ( idx == 0 && (byte & 0xc4) != 0 )
+ })
}
}
/// Tracks globalfeatures which are in init messages and routing announcements
-#[derive(Clone, PartialEq)]
+#[derive(Clone, PartialEq, Debug)]
pub struct GlobalFeatures {
+ #[cfg(not(test))]
flags: Vec<u8>,
+ // Used to test encoding of diverse msgs
+ #[cfg(test)]
+ pub flags: Vec<u8>
}
impl GlobalFeatures {
- pub fn new() -> GlobalFeatures {
+ pub(crate) fn new() -> GlobalFeatures {
GlobalFeatures {
flags: Vec::new(),
}
}
- pub fn requires_unknown_bits(&self) -> bool {
+ pub(crate) fn requires_unknown_bits(&self) -> bool {
for &byte in self.flags.iter() {
if (byte & 0x55) != 0 {
return true;
return false;
}
- pub fn supports_unknown_bits(&self) -> bool {
+ pub(crate) fn supports_unknown_bits(&self) -> bool {
for &byte in self.flags.iter() {
if byte != 0 {
return true;
}
}
+/// An init message to be sent or received from a peer
pub struct Init {
- pub global_features: GlobalFeatures,
- pub local_features: LocalFeatures,
+ pub(crate) global_features: GlobalFeatures,
+ pub(crate) local_features: LocalFeatures,
}
+/// An error message to be sent or received from a peer
+#[derive(Clone)]
pub struct ErrorMessage {
- pub channel_id: [u8; 32],
- pub data: String,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) data: String,
}
+/// A ping message to be sent or received from a peer
pub struct Ping {
- pub ponglen: u16,
- pub byteslen: u16,
+ pub(crate) ponglen: u16,
+ pub(crate) byteslen: u16,
}
+/// A pong message to be sent or received from a peer
pub struct Pong {
- pub byteslen: u16,
+ pub(crate) byteslen: u16,
}
+/// An open_channel message to be sent or received from a peer
+#[derive(Clone)]
pub struct OpenChannel {
- pub chain_hash: Sha256dHash,
- pub temporary_channel_id: [u8; 32],
- pub funding_satoshis: u64,
- pub push_msat: u64,
- pub dust_limit_satoshis: u64,
- pub max_htlc_value_in_flight_msat: u64,
- pub channel_reserve_satoshis: u64,
- pub htlc_minimum_msat: u64,
- pub feerate_per_kw: u32,
- pub to_self_delay: u16,
- pub max_accepted_htlcs: u16,
- pub funding_pubkey: PublicKey,
- pub revocation_basepoint: PublicKey,
- pub payment_basepoint: PublicKey,
- pub delayed_payment_basepoint: PublicKey,
- pub htlc_basepoint: PublicKey,
- pub first_per_commitment_point: PublicKey,
- pub channel_flags: u8,
- pub shutdown_scriptpubkey: Option<Script>,
-}
-
+ pub(crate) chain_hash: Sha256dHash,
+ pub(crate) temporary_channel_id: [u8; 32],
+ pub(crate) funding_satoshis: u64,
+ pub(crate) push_msat: u64,
+ pub(crate) dust_limit_satoshis: u64,
+ pub(crate) max_htlc_value_in_flight_msat: u64,
+ pub(crate) channel_reserve_satoshis: u64,
+ pub(crate) htlc_minimum_msat: u64,
+ pub(crate) feerate_per_kw: u32,
+ pub(crate) to_self_delay: u16,
+ pub(crate) max_accepted_htlcs: u16,
+ pub(crate) funding_pubkey: PublicKey,
+ pub(crate) revocation_basepoint: PublicKey,
+ pub(crate) payment_basepoint: PublicKey,
+ pub(crate) delayed_payment_basepoint: PublicKey,
+ pub(crate) htlc_basepoint: PublicKey,
+ pub(crate) first_per_commitment_point: PublicKey,
+ pub(crate) channel_flags: u8,
+ pub(crate) shutdown_scriptpubkey: OptionalField<Script>,
+}
+
+/// An accept_channel message to be sent or received from a peer
+#[derive(Clone)]
pub struct AcceptChannel {
- pub temporary_channel_id: [u8; 32],
- pub dust_limit_satoshis: u64,
- pub max_htlc_value_in_flight_msat: u64,
- pub channel_reserve_satoshis: u64,
- pub htlc_minimum_msat: u64,
- pub minimum_depth: u32,
- pub to_self_delay: u16,
- pub max_accepted_htlcs: u16,
- pub funding_pubkey: PublicKey,
- pub revocation_basepoint: PublicKey,
- pub payment_basepoint: PublicKey,
- pub delayed_payment_basepoint: PublicKey,
- pub htlc_basepoint: PublicKey,
- pub first_per_commitment_point: PublicKey,
- pub shutdown_scriptpubkey: Option<Script>,
-}
-
+ pub(crate) temporary_channel_id: [u8; 32],
+ pub(crate) dust_limit_satoshis: u64,
+ pub(crate) max_htlc_value_in_flight_msat: u64,
+ pub(crate) channel_reserve_satoshis: u64,
+ pub(crate) htlc_minimum_msat: u64,
+ pub(crate) minimum_depth: u32,
+ pub(crate) to_self_delay: u16,
+ pub(crate) max_accepted_htlcs: u16,
+ pub(crate) funding_pubkey: PublicKey,
+ pub(crate) revocation_basepoint: PublicKey,
+ pub(crate) payment_basepoint: PublicKey,
+ pub(crate) delayed_payment_basepoint: PublicKey,
+ pub(crate) htlc_basepoint: PublicKey,
+ pub(crate) first_per_commitment_point: PublicKey,
+ pub(crate) shutdown_scriptpubkey: OptionalField<Script>
+}
+
+/// A funding_created message to be sent or received from a peer
+#[derive(Clone)]
pub struct FundingCreated {
- pub temporary_channel_id: [u8; 32],
- pub funding_txid: Sha256dHash,
- pub funding_output_index: u16,
- pub signature: Signature,
+ pub(crate) temporary_channel_id: [u8; 32],
+ pub(crate) funding_txid: Sha256dHash,
+ pub(crate) funding_output_index: u16,
+ pub(crate) signature: Signature,
}
+/// A funding_signed message to be sent or received from a peer
+#[derive(Clone)]
pub struct FundingSigned {
- pub channel_id: [u8; 32],
- pub signature: Signature,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) signature: Signature,
}
+/// A funding_locked message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct FundingLocked {
- pub channel_id: [u8; 32],
- pub next_per_commitment_point: PublicKey,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) next_per_commitment_point: PublicKey,
}
+/// A shutdown message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct Shutdown {
- pub channel_id: [u8; 32],
- pub scriptpubkey: Script,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) scriptpubkey: Script,
}
+/// A closing_signed message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct ClosingSigned {
- pub channel_id: [u8; 32],
- pub fee_satoshis: u64,
- pub signature: Signature,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) fee_satoshis: u64,
+ pub(crate) signature: Signature,
}
-#[derive(Clone)]
+/// An update_add_htlc message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct UpdateAddHTLC {
- pub channel_id: [u8; 32],
- pub htlc_id: u64,
- pub amount_msat: u64,
- pub payment_hash: [u8; 32],
- pub cltv_expiry: u32,
- pub onion_routing_packet: OnionPacket,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) htlc_id: u64,
+ pub(crate) amount_msat: u64,
+ pub(crate) payment_hash: PaymentHash,
+ pub(crate) cltv_expiry: u32,
+ pub(crate) onion_routing_packet: OnionPacket,
}
-#[derive(Clone)]
+/// An update_fulfill_htlc message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct UpdateFulfillHTLC {
- pub channel_id: [u8; 32],
- pub htlc_id: u64,
- pub payment_preimage: [u8; 32],
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) htlc_id: u64,
+ pub(crate) payment_preimage: PaymentPreimage,
}
-#[derive(Clone)]
+/// An update_fail_htlc message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct UpdateFailHTLC {
- pub channel_id: [u8; 32],
- pub htlc_id: u64,
- pub reason: OnionErrorPacket,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) htlc_id: u64,
+ pub(crate) reason: OnionErrorPacket,
}
-#[derive(Clone)]
+/// An update_fail_malformed_htlc message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct UpdateFailMalformedHTLC {
- pub channel_id: [u8; 32],
- pub htlc_id: u64,
- pub sha256_of_onion: [u8; 32],
- pub failure_code: u16,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) htlc_id: u64,
+ pub(crate) sha256_of_onion: [u8; 32],
+ pub(crate) failure_code: u16,
}
-#[derive(Clone)]
+/// A commitment_signed message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct CommitmentSigned {
- pub channel_id: [u8; 32],
- pub signature: Signature,
- pub htlc_signatures: Vec<Signature>,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) signature: Signature,
+ pub(crate) htlc_signatures: Vec<Signature>,
}
+/// A revoke_and_ack message to be sent or received from a peer
+#[derive(Clone, PartialEq)]
pub struct RevokeAndACK {
- pub channel_id: [u8; 32],
- pub per_commitment_secret: [u8; 32],
- pub next_per_commitment_point: PublicKey,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) per_commitment_secret: [u8; 32],
+ pub(crate) next_per_commitment_point: PublicKey,
}
+/// An update_fee message to be sent or received from a peer
+#[derive(PartialEq, Clone)]
pub struct UpdateFee {
- pub channel_id: [u8; 32],
- pub feerate_per_kw: u32,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) feerate_per_kw: u32,
}
-pub struct DataLossProtect {
- pub your_last_per_commitment_secret: [u8; 32],
- pub my_current_per_commitment_point: PublicKey,
+#[derive(PartialEq, Clone)]
+pub(crate) struct DataLossProtect {
+ pub(crate) your_last_per_commitment_secret: [u8; 32],
+ pub(crate) my_current_per_commitment_point: PublicKey,
}
+/// A channel_reestablish message to be sent or received from a peer
+#[derive(PartialEq, Clone)]
pub struct ChannelReestablish {
- pub channel_id: [u8; 32],
- pub next_local_commitment_number: u64,
- pub next_remote_commitment_number: u64,
- pub data_loss_protect: Option<DataLossProtect>,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) next_local_commitment_number: u64,
+ pub(crate) next_remote_commitment_number: u64,
+ pub(crate) data_loss_protect: OptionalField<DataLossProtect>,
}
-#[derive(Clone)]
+/// An announcement_signatures message to be sent or received from a peer
+#[derive(PartialEq, Clone, Debug)]
pub struct AnnouncementSignatures {
- pub channel_id: [u8; 32],
- pub short_channel_id: u64,
- pub node_signature: Signature,
- pub bitcoin_signature: Signature,
+ pub(crate) channel_id: [u8; 32],
+ pub(crate) short_channel_id: u64,
+ pub(crate) node_signature: Signature,
+ pub(crate) bitcoin_signature: Signature,
}
-#[derive(Clone)]
+/// An address which can be used to connect to a remote peer
+#[derive(Clone, PartialEq, Debug)]
pub enum NetAddress {
+ /// An IPv4 address/port on which the peer is listening.
IPv4 {
+ /// The 4-byte IPv4 address
addr: [u8; 4],
+ /// The port on which the node is listening
port: u16,
},
+ /// An IPv6 address/port on which the peer is listening.
IPv6 {
+ /// The 16-byte IPv6 address
addr: [u8; 16],
+ /// The port on which the node is listening
port: u16,
},
+ /// An old-style Tor onion address/port on which the peer is listening.
OnionV2 {
+ /// The bytes (usually encoded in base32 with ".onion" appended)
addr: [u8; 10],
+ /// The port on which the node is listening
port: u16,
},
+ /// A new-style Tor onion address/port on which the peer is listening.
+ /// To create the human-readable "hostname", concatenate ed25519_pubkey, checksum, and version,
+ /// wrap as base32 and append ".onion".
OnionV3 {
+ /// The ed25519 long-term public key of the peer
ed25519_pubkey: [u8; 32],
+ /// The checksum of the pubkey and version, as included in the onion address
checksum: u16,
+ /// The version byte, as defined by the Tor Onion v3 spec.
version: u8,
+ /// The port on which the node is listening
port: u16,
},
}
&NetAddress::OnionV3 {..} => { 4 },
}
}
+
+ /// Strict byte-length of address descriptor, 1-byte type not recorded
+ fn len(&self) -> u16 {
+ match self {
+ &NetAddress::IPv4 { .. } => { 6 },
+ &NetAddress::IPv6 { .. } => { 18 },
+ &NetAddress::OnionV2 { .. } => { 12 },
+ &NetAddress::OnionV3 { .. } => { 37 },
+ }
+ }
}
+impl Writeable for NetAddress {
+ fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+ match self {
+ &NetAddress::IPv4 { ref addr, ref port } => {
+ 1u8.write(writer)?;
+ addr.write(writer)?;
+ port.write(writer)?;
+ },
+ &NetAddress::IPv6 { ref addr, ref port } => {
+ 2u8.write(writer)?;
+ addr.write(writer)?;
+ port.write(writer)?;
+ },
+ &NetAddress::OnionV2 { ref addr, ref port } => {
+ 3u8.write(writer)?;
+ addr.write(writer)?;
+ port.write(writer)?;
+ },
+ &NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
+ 4u8.write(writer)?;
+ ed25519_pubkey.write(writer)?;
+ checksum.write(writer)?;
+ version.write(writer)?;
+ port.write(writer)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+impl<R: ::std::io::Read> Readable<R> for Result<NetAddress, u8> {
+ fn read(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
+ let byte = <u8 as Readable<R>>::read(reader)?;
+ match byte {
+ 1 => {
+ Ok(Ok(NetAddress::IPv4 {
+ addr: Readable::read(reader)?,
+ port: Readable::read(reader)?,
+ }))
+ },
+ 2 => {
+ Ok(Ok(NetAddress::IPv6 {
+ addr: Readable::read(reader)?,
+ port: Readable::read(reader)?,
+ }))
+ },
+ 3 => {
+ Ok(Ok(NetAddress::OnionV2 {
+ addr: Readable::read(reader)?,
+ port: Readable::read(reader)?,
+ }))
+ },
+ 4 => {
+ Ok(Ok(NetAddress::OnionV3 {
+ ed25519_pubkey: Readable::read(reader)?,
+ checksum: Readable::read(reader)?,
+ version: Readable::read(reader)?,
+ port: Readable::read(reader)?,
+ }))
+ },
+ _ => return Ok(Err(byte)),
+ }
+ }
+}
+
+// Only exposed as broadcast of node_announcement should be filtered by node_id
+/// The unsigned part of a node_announcement
+#[derive(PartialEq, Clone, Debug)]
pub struct UnsignedNodeAnnouncement {
- pub features: GlobalFeatures,
- pub timestamp: u32,
- pub node_id: PublicKey,
- pub rgb: [u8; 3],
- pub alias: [u8; 32],
+ pub(crate) features: GlobalFeatures,
+ pub(crate) timestamp: u32,
+ /// The node_id this announcement originated from (don't rebroadcast the node_announcement back
+ /// to this node).
+ pub node_id: PublicKey,
+ pub(crate) rgb: [u8; 3],
+ pub(crate) alias: [u8; 32],
/// List of addresses on which this node is reachable. Note that you may only have up to one
/// address of each type, if you have more, they may be silently discarded or we may panic!
- pub addresses: Vec<NetAddress>,
- pub excess_address_data: Vec<u8>,
- pub excess_data: Vec<u8>,
+ pub(crate) addresses: Vec<NetAddress>,
+ pub(crate) excess_address_data: Vec<u8>,
+ pub(crate) excess_data: Vec<u8>,
}
+#[derive(PartialEq, Clone)]
+/// A node_announcement message to be sent or received from a peer
pub struct NodeAnnouncement {
- pub signature: Signature,
- pub contents: UnsignedNodeAnnouncement,
+ pub(crate) signature: Signature,
+ pub(crate) contents: UnsignedNodeAnnouncement,
}
-#[derive(PartialEq, Clone)]
+// Only exposed as broadcast of channel_announcement should be filtered by node_id
+/// The unsigned part of a channel_announcement
+#[derive(PartialEq, Clone, Debug)]
pub struct UnsignedChannelAnnouncement {
- pub features: GlobalFeatures,
- pub chain_hash: Sha256dHash,
- pub short_channel_id: u64,
- pub node_id_1: PublicKey,
- pub node_id_2: PublicKey,
- pub bitcoin_key_1: PublicKey,
- pub bitcoin_key_2: PublicKey,
- pub excess_data: Vec<u8>,
-}
-#[derive(PartialEq, Clone)]
+ pub(crate) features: GlobalFeatures,
+ pub(crate) chain_hash: Sha256dHash,
+ pub(crate) short_channel_id: u64,
+ /// One of the two node_ids which are endpoints of this channel
+ pub node_id_1: PublicKey,
+ /// The other of the two node_ids which are endpoints of this channel
+ pub node_id_2: PublicKey,
+ pub(crate) bitcoin_key_1: PublicKey,
+ pub(crate) bitcoin_key_2: PublicKey,
+ pub(crate) excess_data: Vec<u8>,
+}
+/// A channel_announcement message to be sent or received from a peer
+#[derive(PartialEq, Clone, Debug)]
pub struct ChannelAnnouncement {
- pub node_signature_1: Signature,
- pub node_signature_2: Signature,
- pub bitcoin_signature_1: Signature,
- pub bitcoin_signature_2: Signature,
- pub contents: UnsignedChannelAnnouncement,
-}
-
-#[derive(PartialEq, Clone)]
-pub struct UnsignedChannelUpdate {
- pub chain_hash: Sha256dHash,
- pub short_channel_id: u64,
- pub timestamp: u32,
- pub flags: u16,
- pub cltv_expiry_delta: u16,
- pub htlc_minimum_msat: u64,
- pub fee_base_msat: u32,
- pub fee_proportional_millionths: u32,
- pub excess_data: Vec<u8>,
-}
-#[derive(PartialEq, Clone)]
+ pub(crate) node_signature_1: Signature,
+ pub(crate) node_signature_2: Signature,
+ pub(crate) bitcoin_signature_1: Signature,
+ pub(crate) bitcoin_signature_2: Signature,
+ pub(crate) contents: UnsignedChannelAnnouncement,
+}
+
+#[derive(PartialEq, Clone, Debug)]
+pub(crate) struct UnsignedChannelUpdate {
+ pub(crate) chain_hash: Sha256dHash,
+ pub(crate) short_channel_id: u64,
+ pub(crate) timestamp: u32,
+ pub(crate) flags: u16,
+ pub(crate) cltv_expiry_delta: u16,
+ pub(crate) htlc_minimum_msat: u64,
+ pub(crate) fee_base_msat: u32,
+ pub(crate) fee_proportional_millionths: u32,
+ pub(crate) excess_data: Vec<u8>,
+}
+/// A channel_update message to be sent or received from a peer
+#[derive(PartialEq, Clone, Debug)]
pub struct ChannelUpdate {
- pub signature: Signature,
- pub contents: UnsignedChannelUpdate,
+ pub(crate) signature: Signature,
+ pub(crate) contents: UnsignedChannelUpdate,
}
/// Used to put an error message in a HandleError
+#[derive(Clone)]
pub enum ErrorAction {
/// The peer took some action which made us think they were useless. Disconnect them.
DisconnectPeer {
+ /// An error message which we should make an effort to send before we disconnect.
msg: Option<ErrorMessage>
},
/// The peer did something harmless that we weren't able to process, just log and ignore
IgnoreError,
/// The peer did something incorrect. Tell them.
SendErrorMessage {
+ /// The message to send.
msg: ErrorMessage
},
}
+/// An Err type for failure to process messages.
pub struct HandleError { //TODO: rename me
+ /// A human-readable message describing the error
pub err: &'static str,
+ /// The action which should be taken against the offending peer.
pub action: Option<ErrorAction>, //TODO: Make this required
}
/// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
/// transaction updates if they were pending.
+#[derive(PartialEq, Clone)]
pub struct CommitmentUpdate {
+ /// update_add_htlc messages which should be sent
pub update_add_htlcs: Vec<UpdateAddHTLC>,
+ /// update_fulfill_htlc messages which should be sent
pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
+ /// update_fail_htlc messages which should be sent
pub update_fail_htlcs: Vec<UpdateFailHTLC>,
+ /// update_fail_malformed_htlc messages which should be sent
pub update_fail_malformed_htlcs: Vec<UpdateFailMalformedHTLC>,
+ /// An update_fee message which should be sent
+ pub update_fee: Option<UpdateFee>,
+ /// Finally, the commitment_signed message which should be sent
pub commitment_signed: CommitmentSigned,
}
+/// The information we received from a peer along the route of a payment we originated. This is
+/// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
+/// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
+#[derive(Clone)]
pub enum HTLCFailChannelUpdate {
+ /// We received an error which included a full ChannelUpdate message.
ChannelUpdateMessage {
+ /// The unwrapped message we received
msg: ChannelUpdate,
},
+ /// We received an error which indicated only that a channel has been closed
ChannelClosed {
+ /// The short_channel_id which has now closed.
short_channel_id: u64,
+ /// when this true, this channel should be permanently removed from the
+ /// consideration. Otherwise, this channel can be restored as new channel_update is received
+ is_permanent: bool,
},
+ /// We received an error which indicated only that a node has failed
+ NodeFailure {
+ /// The node_id that has failed.
+ node_id: PublicKey,
+ /// when this true, node should be permanently removed from the
+ /// consideration. Otherwise, the channels connected to this node can be
+ /// restored as new channel_update is received
+ is_permanent: bool,
+ }
}
-/// A trait to describe an object which can receive channel messages. Messages MAY be called in
-/// paralell when they originate from different their_node_ids, however they MUST NOT be called in
-/// paralell when the two calls have the same their_node_id.
-pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
+/// Messages could have optional fields to use with extended features
+/// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
+/// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
+/// separate enum type for them.
+#[derive(Clone, PartialEq)]
+pub enum OptionalField<T> {
+ /// Optional field is included in message
+ Present(T),
+ /// Optional field is absent in message
+ Absent
+}
+
+/// A trait to describe an object which can receive channel messages.
+///
+/// Messages MAY be called in parallel when they originate from different their_node_ids, however
+/// they MUST NOT be called in parallel when the two calls have the same their_node_id.
+pub trait ChannelMessageHandler : events::MessageSendEventsProvider + Send + Sync {
//Channel init:
- fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<AcceptChannel, HandleError>;
- fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
- fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<FundingSigned, HandleError>;
+ /// Handle an incoming open_channel message from the given peer.
+ fn handle_open_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &OpenChannel) -> Result<(), HandleError>;
+ /// Handle an incoming accept_channel message from the given peer.
+ fn handle_accept_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &AcceptChannel) -> Result<(), HandleError>;
+ /// Handle an incoming funding_created message from the given peer.
+ fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &FundingCreated) -> Result<(), HandleError>;
+ /// Handle an incoming funding_signed message from the given peer.
fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &FundingSigned) -> Result<(), HandleError>;
- fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<Option<AnnouncementSignatures>, HandleError>;
+ /// Handle an incoming funding_locked message from the given peer.
+ fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &FundingLocked) -> Result<(), HandleError>;
// Channl close:
- fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(Option<Shutdown>, Option<ClosingSigned>), HandleError>;
- fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<Option<ClosingSigned>, HandleError>;
+ /// Handle an incoming shutdown message from the given peer.
+ fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &Shutdown) -> Result<(), HandleError>;
+ /// Handle an incoming closing_signed message from the given peer.
+ fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &ClosingSigned) -> Result<(), HandleError>;
// HTLC handling:
+ /// Handle an incoming update_add_htlc message from the given peer.
fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
+ /// Handle an incoming update_fulfill_htlc message from the given peer.
fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
- fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<Option<HTLCFailChannelUpdate>, HandleError>;
+ /// Handle an incoming update_fail_htlc message from the given peer.
+ fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<(), HandleError>;
+ /// Handle an incoming update_fail_malformed_htlc message from the given peer.
fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
- fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(RevokeAndACK, Option<CommitmentSigned>), HandleError>;
- fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<CommitmentUpdate>, HandleError>;
+ /// Handle an incoming commitment_signed message from the given peer.
+ fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(), HandleError>;
+ /// Handle an incoming revoke_and_ack message from the given peer.
+ fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<(), HandleError>;
+ /// Handle an incoming update_fee message from the given peer.
fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
// Channel-to-announce:
+ /// Handle an incoming announcement_signatures message from the given peer.
fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>;
- // Error conditions:
+ // Connection loss/reestablish:
/// Indicates a connection to the peer failed/an existing connection was lost. If no connection
/// is believed to be possible in the future (eg they're sending us messages we don't
/// understand or indicate they require unknown feature bits), no_connection_possible is set
/// and any outstanding channels should be failed.
fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
+ /// Handle a peer reconnecting, possibly generating channel_reestablish message(s).
+ fn peer_connected(&self, their_node_id: &PublicKey);
+ /// Handle an incoming channel_reestablish message from the given peer.
+ fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &ChannelReestablish) -> Result<(), HandleError>;
+
+ // Error:
+ /// Handle an incoming error message from the given peer.
fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage);
}
+/// A trait to describe an object which can receive routing messages.
pub trait RoutingMessageHandler : Send + Sync {
+ /// Handle an incoming node_announcement message, returning true if it should be forwarded on,
+ /// false or returning an Err otherwise.
fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<bool, HandleError>;
/// Handle a channel_announcement message, returning true if it should be forwarded on, false
/// or returning an Err otherwise.
- fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
- fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, HandleError>;
- fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
-}
-
-pub struct OnionRealm0HopData {
- pub short_channel_id: u64,
- pub amt_to_forward: u64,
- pub outgoing_cltv_value: u32,
- // 12 bytes of 0-padding
-}
-
-pub struct OnionHopData {
- pub realm: u8,
- pub data: OnionRealm0HopData,
- pub hmac: [u8; 32],
-}
-unsafe impl internal_traits::NoDealloc for OnionHopData{}
-
-#[derive(Clone)]
-pub struct OnionPacket {
- pub version: u8,
- /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
- /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
- /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
- pub public_key: Result<PublicKey, secp256k1::Error>,
- pub hop_data: [u8; 20*65],
- pub hmac: [u8; 32],
-}
-
-pub struct DecodedOnionErrorPacket {
- pub hmac: [u8; 32],
- pub failuremsg: Vec<u8>,
- pub pad: Vec<u8>,
-}
-
-#[derive(Clone)]
-pub struct OnionErrorPacket {
- // This really should be a constant size slice, but the spec lets these things be up to 128KB?
- // (TODO) We limit it in decode to much lower...
- pub data: Vec<u8>,
-}
-
-impl Error for DecodeError {
- fn description(&self) -> &str {
- match *self {
- DecodeError::UnknownRealmByte => "Unknown realm byte in Onion packet",
- DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
- DecodeError::BadPublicKey => "Invalid public key in packet",
- DecodeError::BadSignature => "Invalid signature in packet",
- DecodeError::BadText => "Invalid text in packet",
- DecodeError::ShortRead => "Packet extended beyond the provided bytes",
- DecodeError::ExtraAddressesPerType => "More than one address of a single type",
- DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
- DecodeError::Io(ref e) => e.description(),
- DecodeError::InvalidValue => "0 or 1 is not found for boolean",
- }
- }
-}
-impl fmt::Display for DecodeError {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- f.write_str(self.description())
- }
-}
-
-impl fmt::Debug for HandleError {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- f.write_str(self.err)
- }
-}
-
-impl From<::std::io::Error> for DecodeError {
- fn from(e: ::std::io::Error) -> Self {
- if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
- DecodeError::ShortRead
- } else {
- DecodeError::Io(e)
- }
- }
-}
-
-macro_rules! secp_pubkey {
- ( $ctx: expr, $slice: expr ) => {
- match PublicKey::from_slice($ctx, $slice) {
- Ok(key) => key,
- Err(_) => return Err(DecodeError::BadPublicKey)
- }
- };
-}
-
-macro_rules! secp_signature {
- ( $ctx: expr, $slice: expr ) => {
- match Signature::from_compact($ctx, $slice) {
- Ok(sig) => sig,
- Err(_) => return Err(DecodeError::BadSignature)
- }
- };
-}
-
-impl MsgDecodable for LocalFeatures {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 2 { return Err(DecodeError::ShortRead); }
- let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
- if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
- let mut flags = Vec::with_capacity(len);
- flags.extend_from_slice(&v[2..2 + len]);
- Ok(Self {
- flags: flags
- })
- }
-}
-impl MsgEncodable for LocalFeatures {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(self.flags.len() + 2);
- res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
- res.extend_from_slice(&self.flags[..]);
- res
- }
- fn encoded_len(&self) -> usize { self.flags.len() + 2 }
-}
-
-impl MsgDecodable for GlobalFeatures {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 2 { return Err(DecodeError::ShortRead); }
- let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
- if v.len() < len + 2 { return Err(DecodeError::ShortRead); }
- let mut flags = Vec::with_capacity(len);
- flags.extend_from_slice(&v[2..2 + len]);
- Ok(Self {
- flags: flags
- })
- }
-}
-impl MsgEncodable for GlobalFeatures {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(self.flags.len() + 2);
- res.extend_from_slice(&byte_utils::be16_to_array(self.flags.len() as u16));
- res.extend_from_slice(&self.flags[..]);
- res
- }
- fn encoded_len(&self) -> usize { self.flags.len() + 2 }
-}
-
-impl MsgDecodable for Init {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- let global_features = GlobalFeatures::decode(v)?;
- if v.len() < global_features.flags.len() + 4 {
- return Err(DecodeError::ShortRead);
- }
- let local_features = LocalFeatures::decode(&v[global_features.flags.len() + 2..])?;
- Ok(Self {
- global_features: global_features,
- local_features: local_features,
- })
- }
-}
-impl MsgEncodable for Init {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(self.global_features.flags.len() + self.local_features.flags.len());
- res.extend_from_slice(&self.global_features.encode()[..]);
- res.extend_from_slice(&self.local_features.encode()[..]);
- res
- }
-}
-
-impl MsgDecodable for Ping {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 4 {
- return Err(DecodeError::ShortRead);
- }
- let ponglen = byte_utils::slice_to_be16(&v[0..2]);
- let byteslen = byte_utils::slice_to_be16(&v[2..4]);
- if v.len() < 4 + byteslen as usize {
- return Err(DecodeError::ShortRead);
- }
- Ok(Self {
- ponglen,
- byteslen,
- })
- }
-}
-impl MsgEncodable for Ping {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(self.byteslen as usize + 2);
- res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
- res.resize(2 + self.byteslen as usize, 0);
- res
- }
-}
-
-impl MsgDecodable for Pong {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 2 {
- return Err(DecodeError::ShortRead);
- }
- let byteslen = byte_utils::slice_to_be16(&v[0..2]);
- if v.len() < 2 + byteslen as usize {
- return Err(DecodeError::ShortRead);
- }
- Ok(Self {
- byteslen
- })
- }
-}
-impl MsgEncodable for Pong {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(self.byteslen as usize + 2);
- res.extend_from_slice(&byte_utils::be16_to_array(self.byteslen));
- res.resize(2 + self.byteslen as usize, 0);
- res
- }
-}
-
-impl MsgDecodable for OpenChannel {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 2*32+6*8+4+2*2+6*33+1 {
- return Err(DecodeError::ShortRead);
- }
- let ctx = Secp256k1::without_caps();
-
- let mut shutdown_scriptpubkey = None;
- if v.len() >= 321 {
- let len = byte_utils::slice_to_be16(&v[319..321]) as usize;
- if v.len() < 321+len {
- return Err(DecodeError::ShortRead);
- }
- shutdown_scriptpubkey = Some(Script::from(v[321..321+len].to_vec()));
- }
- let mut temp_channel_id = [0; 32];
- temp_channel_id[..].copy_from_slice(&v[32..64]);
- Ok(OpenChannel {
- chain_hash: deserialize(&v[0..32]).unwrap(),
- temporary_channel_id: temp_channel_id,
- funding_satoshis: byte_utils::slice_to_be64(&v[64..72]),
- push_msat: byte_utils::slice_to_be64(&v[72..80]),
- dust_limit_satoshis: byte_utils::slice_to_be64(&v[80..88]),
- max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[88..96]),
- channel_reserve_satoshis: byte_utils::slice_to_be64(&v[96..104]),
- htlc_minimum_msat: byte_utils::slice_to_be64(&v[104..112]),
- feerate_per_kw: byte_utils::slice_to_be32(&v[112..116]),
- to_self_delay: byte_utils::slice_to_be16(&v[116..118]),
- max_accepted_htlcs: byte_utils::slice_to_be16(&v[118..120]),
- funding_pubkey: secp_pubkey!(&ctx, &v[120..153]),
- revocation_basepoint: secp_pubkey!(&ctx, &v[153..186]),
- payment_basepoint: secp_pubkey!(&ctx, &v[186..219]),
- delayed_payment_basepoint: secp_pubkey!(&ctx, &v[219..252]),
- htlc_basepoint: secp_pubkey!(&ctx, &v[252..285]),
- first_per_commitment_point: secp_pubkey!(&ctx, &v[285..318]),
- channel_flags: v[318],
- shutdown_scriptpubkey: shutdown_scriptpubkey
- })
- }
-}
-impl MsgEncodable for OpenChannel {
- fn encode(&self) -> Vec<u8> {
- let mut res = match &self.shutdown_scriptpubkey {
- &Some(ref script) => Vec::with_capacity(319 + 2 + script.len()),
- &None => Vec::with_capacity(319),
- };
- res.extend_from_slice(&serialize(&self.chain_hash).unwrap());
- res.extend_from_slice(&serialize(&self.temporary_channel_id).unwrap());
- res.extend_from_slice(&byte_utils::be64_to_array(self.funding_satoshis));
- res.extend_from_slice(&byte_utils::be64_to_array(self.push_msat));
- res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
- res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
- res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
- res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
- res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
- res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
- res.extend_from_slice(&self.funding_pubkey.serialize());
- res.extend_from_slice(&self.revocation_basepoint.serialize());
- res.extend_from_slice(&self.payment_basepoint.serialize());
- res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
- res.extend_from_slice(&self.htlc_basepoint.serialize());
- res.extend_from_slice(&self.first_per_commitment_point.serialize());
- res.push(self.channel_flags);
- if let &Some(ref script) = &self.shutdown_scriptpubkey {
- res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
- res.extend_from_slice(&script[..]);
- }
- res
- }
-}
-
-impl MsgDecodable for AcceptChannel {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+4*8+4+2*2+6*33 {
- return Err(DecodeError::ShortRead);
- }
- let ctx = Secp256k1::without_caps();
-
- let mut shutdown_scriptpubkey = None;
- if v.len() >= 272 {
- let len = byte_utils::slice_to_be16(&v[270..272]) as usize;
- if v.len() < 272+len {
- return Err(DecodeError::ShortRead);
- }
- shutdown_scriptpubkey = Some(Script::from(v[272..272+len].to_vec()));
- }
-
- let mut temporary_channel_id = [0; 32];
- temporary_channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- temporary_channel_id,
- dust_limit_satoshis: byte_utils::slice_to_be64(&v[32..40]),
- max_htlc_value_in_flight_msat: byte_utils::slice_to_be64(&v[40..48]),
- channel_reserve_satoshis: byte_utils::slice_to_be64(&v[48..56]),
- htlc_minimum_msat: byte_utils::slice_to_be64(&v[56..64]),
- minimum_depth: byte_utils::slice_to_be32(&v[64..68]),
- to_self_delay: byte_utils::slice_to_be16(&v[68..70]),
- max_accepted_htlcs: byte_utils::slice_to_be16(&v[70..72]),
- funding_pubkey: secp_pubkey!(&ctx, &v[72..105]),
- revocation_basepoint: secp_pubkey!(&ctx, &v[105..138]),
- payment_basepoint: secp_pubkey!(&ctx, &v[138..171]),
- delayed_payment_basepoint: secp_pubkey!(&ctx, &v[171..204]),
- htlc_basepoint: secp_pubkey!(&ctx, &v[204..237]),
- first_per_commitment_point: secp_pubkey!(&ctx, &v[237..270]),
- shutdown_scriptpubkey: shutdown_scriptpubkey
- })
- }
-}
-impl MsgEncodable for AcceptChannel {
- fn encode(&self) -> Vec<u8> {
- let mut res = match &self.shutdown_scriptpubkey {
- &Some(ref script) => Vec::with_capacity(270 + 2 + script.len()),
- &None => Vec::with_capacity(270),
- };
- res.extend_from_slice(&self.temporary_channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
- res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
- res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
- res.extend_from_slice(&byte_utils::be32_to_array(self.minimum_depth));
- res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
- res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
- res.extend_from_slice(&self.funding_pubkey.serialize());
- res.extend_from_slice(&self.revocation_basepoint.serialize());
- res.extend_from_slice(&self.payment_basepoint.serialize());
- res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
- res.extend_from_slice(&self.htlc_basepoint.serialize());
- res.extend_from_slice(&self.first_per_commitment_point.serialize());
- if let &Some(ref script) = &self.shutdown_scriptpubkey {
- res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
- res.extend_from_slice(&script[..]);
- }
- res
- }
-}
-
-impl MsgDecodable for FundingCreated {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+32+2+64 {
- return Err(DecodeError::ShortRead);
- }
- let ctx = Secp256k1::without_caps();
- let mut temporary_channel_id = [0; 32];
- temporary_channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- temporary_channel_id,
- funding_txid: deserialize(&v[32..64]).unwrap(),
- funding_output_index: byte_utils::slice_to_be16(&v[64..66]),
- signature: secp_signature!(&ctx, &v[66..130]),
- })
- }
-}
-impl MsgEncodable for FundingCreated {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+32+2+64);
- res.extend_from_slice(&self.temporary_channel_id);
- res.extend_from_slice(&serialize(&self.funding_txid).unwrap()[..]);
- res.extend_from_slice(&byte_utils::be16_to_array(self.funding_output_index));
- let secp_ctx = Secp256k1::without_caps();
- res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
- res
- }
-}
-
-impl MsgDecodable for FundingSigned {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+64 {
- return Err(DecodeError::ShortRead);
- }
- let ctx = Secp256k1::without_caps();
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- signature: secp_signature!(&ctx, &v[32..96]),
- })
- }
-}
-impl MsgEncodable for FundingSigned {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+64);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps()));
- res
- }
-}
-
-impl MsgDecodable for FundingLocked {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+33 {
- return Err(DecodeError::ShortRead);
- }
- let ctx = Secp256k1::without_caps();
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- next_per_commitment_point: secp_pubkey!(&ctx, &v[32..65]),
- })
- }
-}
-impl MsgEncodable for FundingLocked {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+33);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&self.next_per_commitment_point.serialize());
- res
- }
-}
-
-impl MsgDecodable for Shutdown {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32 + 2 {
- return Err(DecodeError::ShortRead);
- }
- let scriptlen = byte_utils::slice_to_be16(&v[32..34]) as usize;
- if v.len() < 32 + 2 + scriptlen {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- scriptpubkey: Script::from(v[34..34 + scriptlen].to_vec()),
- })
- }
-}
-impl MsgEncodable for Shutdown {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32 + 2 + self.scriptpubkey.len());
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be16_to_array(self.scriptpubkey.len() as u16));
- res.extend_from_slice(&self.scriptpubkey[..]);
- res
- }
-}
-
-impl MsgDecodable for ClosingSigned {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32 + 8 + 64 {
- return Err(DecodeError::ShortRead);
- }
- let secp_ctx = Secp256k1::without_caps();
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- fee_satoshis: byte_utils::slice_to_be64(&v[32..40]),
- signature: secp_signature!(&secp_ctx, &v[40..104]),
- })
- }
-}
-impl MsgEncodable for ClosingSigned {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+8+64);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.fee_satoshis));
- let secp_ctx = Secp256k1::without_caps();
- res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
- res
- }
-}
-
-impl MsgDecodable for UpdateAddHTLC {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8+8+32+4+1+33+20*65+32 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- let mut payment_hash = [0; 32];
- payment_hash.copy_from_slice(&v[48..80]);
- Ok(Self{
- channel_id,
- htlc_id: byte_utils::slice_to_be64(&v[32..40]),
- amount_msat: byte_utils::slice_to_be64(&v[40..48]),
- payment_hash,
- cltv_expiry: byte_utils::slice_to_be32(&v[80..84]),
- onion_routing_packet: OnionPacket::decode(&v[84..84+1366])?,
- })
- }
-}
-impl MsgEncodable for UpdateAddHTLC {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+8+8+32+4+1366);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
- res.extend_from_slice(&byte_utils::be64_to_array(self.amount_msat));
- res.extend_from_slice(&self.payment_hash);
- res.extend_from_slice(&byte_utils::be32_to_array(self.cltv_expiry));
- res.extend_from_slice(&self.onion_routing_packet.encode()[..]);
- res
- }
-}
-
-impl MsgDecodable for UpdateFulfillHTLC {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8+32 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- let mut payment_preimage = [0; 32];
- payment_preimage.copy_from_slice(&v[40..72]);
- Ok(Self{
- channel_id,
- htlc_id: byte_utils::slice_to_be64(&v[32..40]),
- payment_preimage,
- })
- }
-}
-impl MsgEncodable for UpdateFulfillHTLC {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+8+32);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
- res.extend_from_slice(&self.payment_preimage);
- res
- }
-}
-
-impl MsgDecodable for UpdateFailHTLC {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self{
- channel_id,
- htlc_id: byte_utils::slice_to_be64(&v[32..40]),
- reason: OnionErrorPacket::decode(&v[40..])?,
- })
- }
-}
-impl MsgEncodable for UpdateFailHTLC {
- fn encode(&self) -> Vec<u8> {
- let reason = self.reason.encode();
- let mut res = Vec::with_capacity(32+8+reason.len());
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
- res.extend_from_slice(&reason[..]);
- res
- }
-}
-
-impl MsgDecodable for UpdateFailMalformedHTLC {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8+32+2 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- let mut sha256_of_onion = [0; 32];
- sha256_of_onion.copy_from_slice(&v[40..72]);
- Ok(Self{
- channel_id,
- htlc_id: byte_utils::slice_to_be64(&v[32..40]),
- sha256_of_onion,
- failure_code: byte_utils::slice_to_be16(&v[72..74]),
- })
- }
-}
-impl MsgEncodable for UpdateFailMalformedHTLC {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+8+32+2);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
- res.extend_from_slice(&self.sha256_of_onion);
- res.extend_from_slice(&byte_utils::be16_to_array(self.failure_code));
- res
- }
-}
-
-impl MsgDecodable for CommitmentSigned {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+64+2 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
-
- let htlcs = byte_utils::slice_to_be16(&v[96..98]) as usize;
- if v.len() < 32+64+2+htlcs*64 {
- return Err(DecodeError::ShortRead);
- }
- let mut htlc_signatures = Vec::with_capacity(htlcs);
- let secp_ctx = Secp256k1::without_caps();
- for i in 0..htlcs {
- htlc_signatures.push(secp_signature!(&secp_ctx, &v[98+i*64..98+(i+1)*64]));
- }
- Ok(Self {
- channel_id,
- signature: secp_signature!(&secp_ctx, &v[32..96]),
- htlc_signatures,
- })
- }
-}
-impl MsgEncodable for CommitmentSigned {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+64+2+self.htlc_signatures.len()*64);
- res.extend_from_slice(&self.channel_id);
- let secp_ctx = Secp256k1::without_caps();
- res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
- res.extend_from_slice(&byte_utils::be16_to_array(self.htlc_signatures.len() as u16));
- for i in 0..self.htlc_signatures.len() {
- res.extend_from_slice(&self.htlc_signatures[i].serialize_compact(&secp_ctx));
- }
- res
- }
-}
-
-impl MsgDecodable for RevokeAndACK {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+32+33 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- let mut per_commitment_secret = [0; 32];
- per_commitment_secret.copy_from_slice(&v[32..64]);
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- channel_id,
- per_commitment_secret,
- next_per_commitment_point: secp_pubkey!(&secp_ctx, &v[64..97]),
- })
- }
-}
-impl MsgEncodable for RevokeAndACK {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+32+33);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&self.per_commitment_secret);
- res.extend_from_slice(&self.next_per_commitment_point.serialize());
- res
- }
-}
-
-impl MsgDecodable for UpdateFee {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+4 {
- return Err(DecodeError::ShortRead);
- }
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- feerate_per_kw: byte_utils::slice_to_be32(&v[32..36]),
- })
- }
-}
-impl MsgEncodable for UpdateFee {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+4);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
- res
- }
-}
-
-impl MsgDecodable for ChannelReestablish {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+2*8 {
- return Err(DecodeError::ShortRead);
- }
-
- let data_loss_protect = if v.len() > 32+2*8 {
- if v.len() < 32+2*8 + 33+32 {
- return Err(DecodeError::ShortRead);
- }
- let mut inner_array = [0; 32];
- inner_array.copy_from_slice(&v[48..48+32]);
- Some(DataLossProtect {
- your_last_per_commitment_secret: inner_array,
- my_current_per_commitment_point: secp_pubkey!(&Secp256k1::without_caps(), &v[48+32..48+32+33]),
- })
- } else { None };
-
- Ok(Self {
- channel_id: deserialize(&v[0..32]).unwrap(),
- next_local_commitment_number: byte_utils::slice_to_be64(&v[32..40]),
- next_remote_commitment_number: byte_utils::slice_to_be64(&v[40..48]),
- data_loss_protect: data_loss_protect,
- })
- }
-}
-impl MsgEncodable for ChannelReestablish {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(if self.data_loss_protect.is_some() { 32+2*8+33+32 } else { 32+2*8 });
-
- res.extend_from_slice(&serialize(&self.channel_id).unwrap()[..]);
- res.extend_from_slice(&byte_utils::be64_to_array(self.next_local_commitment_number));
- res.extend_from_slice(&byte_utils::be64_to_array(self.next_remote_commitment_number));
-
- if let &Some(ref data_loss_protect) = &self.data_loss_protect {
- res.extend_from_slice(&data_loss_protect.your_last_per_commitment_secret[..]);
- res.extend_from_slice(&data_loss_protect.my_current_per_commitment_point.serialize());
- }
- res
- }
-}
-
-impl MsgDecodable for AnnouncementSignatures {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8+64*2 {
- return Err(DecodeError::ShortRead);
- }
- let secp_ctx = Secp256k1::without_caps();
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
- node_signature: secp_signature!(&secp_ctx, &v[40..104]),
- bitcoin_signature: secp_signature!(&secp_ctx, &v[104..168]),
- })
- }
-}
-impl MsgEncodable for AnnouncementSignatures {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32+8+64*2);
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
- let secp_ctx = Secp256k1::without_caps();
- res.extend_from_slice(&self.node_signature.serialize_compact(&secp_ctx));
- res.extend_from_slice(&self.bitcoin_signature.serialize_compact(&secp_ctx));
- res
- }
-}
-
-impl MsgDecodable for UnsignedNodeAnnouncement {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- let features = GlobalFeatures::decode(&v[..])?;
- if features.requires_unknown_bits() {
- return Err(DecodeError::UnknownRequiredFeature);
- }
-
- if v.len() < features.encoded_len() + 4 + 33 + 3 + 32 + 2 {
- return Err(DecodeError::ShortRead);
- }
- let start = features.encoded_len();
-
- let mut rgb = [0; 3];
- rgb.copy_from_slice(&v[start + 37..start + 40]);
-
- let mut alias = [0; 32];
- alias.copy_from_slice(&v[start + 40..start + 72]);
-
- let addrlen = byte_utils::slice_to_be16(&v[start + 72..start + 74]) as usize;
- if v.len() < start + 74 + addrlen {
- return Err(DecodeError::ShortRead);
- }
- let addr_read_limit = start + 74 + addrlen;
-
- let mut addresses = Vec::with_capacity(4);
- let mut read_pos = start + 74;
- loop {
- if addr_read_limit <= read_pos { break; }
- match v[read_pos] {
- 1 => {
- if addresses.len() > 0 {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addr_read_limit < read_pos + 1 + 6 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- let mut addr = [0; 4];
- addr.copy_from_slice(&v[read_pos + 1..read_pos + 5]);
- addresses.push(NetAddress::IPv4 {
- addr,
- port: byte_utils::slice_to_be16(&v[read_pos + 5..read_pos + 7]),
- });
- read_pos += 1 + 6;
- },
- 2 => {
- if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addr_read_limit < read_pos + 1 + 18 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- let mut addr = [0; 16];
- addr.copy_from_slice(&v[read_pos + 1..read_pos + 17]);
- addresses.push(NetAddress::IPv6 {
- addr,
- port: byte_utils::slice_to_be16(&v[read_pos + 17..read_pos + 19]),
- });
- read_pos += 1 + 18;
- },
- 3 => {
- if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addr_read_limit < read_pos + 1 + 12 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- let mut addr = [0; 10];
- addr.copy_from_slice(&v[read_pos + 1..read_pos + 11]);
- addresses.push(NetAddress::OnionV2 {
- addr,
- port: byte_utils::slice_to_be16(&v[read_pos + 11..read_pos + 13]),
- });
- read_pos += 1 + 12;
- },
- 4 => {
- if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addr_read_limit < read_pos + 1 + 37 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- let mut ed25519_pubkey = [0; 32];
- ed25519_pubkey.copy_from_slice(&v[read_pos + 1..read_pos + 33]);
- addresses.push(NetAddress::OnionV3 {
- ed25519_pubkey,
- checksum: byte_utils::slice_to_be16(&v[read_pos + 33..read_pos + 35]),
- version: v[read_pos + 35],
- port: byte_utils::slice_to_be16(&v[read_pos + 36..read_pos + 38]),
- });
- read_pos += 1 + 37;
- },
- _ => { break; } // We've read all we can, we dont understand anything higher (and they're sorted)
- }
- }
-
- let excess_address_data = if read_pos < addr_read_limit {
- let mut excess_address_data = Vec::with_capacity(addr_read_limit - read_pos);
- excess_address_data.extend_from_slice(&v[read_pos..addr_read_limit]);
- excess_address_data
- } else { Vec::new() };
-
- let mut excess_data = Vec::with_capacity(v.len() - addr_read_limit);
- excess_data.extend_from_slice(&v[addr_read_limit..]);
-
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- features,
- timestamp: byte_utils::slice_to_be32(&v[start..start + 4]),
- node_id: secp_pubkey!(&secp_ctx, &v[start + 4..start + 37]),
- rgb,
- alias,
- addresses,
- excess_address_data,
- excess_data,
- })
- }
-}
-impl MsgEncodable for UnsignedNodeAnnouncement {
- fn encode(&self) -> Vec<u8> {
- let features = self.features.encode();
- let mut res = Vec::with_capacity(74 + features.len() + self.addresses.len()*7 + self.excess_address_data.len() + self.excess_data.len());
- res.extend_from_slice(&features[..]);
- res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
- res.extend_from_slice(&self.node_id.serialize());
- res.extend_from_slice(&self.rgb);
- res.extend_from_slice(&self.alias);
- let mut addr_slice = Vec::with_capacity(self.addresses.len() * 18);
- let mut addrs_to_encode = self.addresses.clone();
- addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
- addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
- for addr in addrs_to_encode.iter() {
- match addr {
- &NetAddress::IPv4{addr, port} => {
- addr_slice.push(1);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::IPv6{addr, port} => {
- addr_slice.push(2);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::OnionV2{addr, port} => {
- addr_slice.push(3);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::OnionV3{ed25519_pubkey, checksum, version, port} => {
- addr_slice.push(4);
- addr_slice.extend_from_slice(&ed25519_pubkey);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(checksum));
- addr_slice.push(version);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- }
- }
- res.extend_from_slice(&byte_utils::be16_to_array((addr_slice.len() + self.excess_address_data.len()) as u16));
- res.extend_from_slice(&addr_slice[..]);
- res.extend_from_slice(&self.excess_address_data[..]);
- res.extend_from_slice(&self.excess_data[..]);
- res
- }
-}
-
-impl MsgDecodable for NodeAnnouncement {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 64 {
- return Err(DecodeError::ShortRead);
- }
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- signature: secp_signature!(&secp_ctx, &v[0..64]),
- contents: UnsignedNodeAnnouncement::decode(&v[64..])?,
- })
- }
-}
-impl MsgEncodable for NodeAnnouncement {
- fn encode(&self) -> Vec<u8> {
- let contents = self.contents.encode();
- let mut res = Vec::with_capacity(64 + contents.len());
- let secp_ctx = Secp256k1::without_caps();
- res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
- res.extend_from_slice(&contents);
- res
- }
-}
-
-impl MsgDecodable for UnsignedChannelAnnouncement {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- let features = GlobalFeatures::decode(&v[..])?;
- if features.requires_unknown_bits() {
- return Err(DecodeError::UnknownRequiredFeature);
- }
- if v.len() < features.encoded_len() + 32 + 8 + 33*4 {
- return Err(DecodeError::ShortRead);
- }
- let start = features.encoded_len();
- let secp_ctx = Secp256k1::without_caps();
- let mut excess_data = Vec::with_capacity(v.len() - start - 172);
- excess_data.extend_from_slice(&v[start + 172..]);
- Ok(Self {
- features,
- chain_hash: deserialize(&v[start..start + 32]).unwrap(),
- short_channel_id: byte_utils::slice_to_be64(&v[start + 32..start + 40]),
- node_id_1: secp_pubkey!(&secp_ctx, &v[start + 40..start + 73]),
- node_id_2: secp_pubkey!(&secp_ctx, &v[start + 73..start + 106]),
- bitcoin_key_1: secp_pubkey!(&secp_ctx, &v[start + 106..start + 139]),
- bitcoin_key_2: secp_pubkey!(&secp_ctx, &v[start + 139..start + 172]),
- excess_data,
- })
- }
-}
-impl MsgEncodable for UnsignedChannelAnnouncement {
- fn encode(&self) -> Vec<u8> {
- let features = self.features.encode();
- let mut res = Vec::with_capacity(172 + features.len() + self.excess_data.len());
- res.extend_from_slice(&features[..]);
- res.extend_from_slice(&self.chain_hash[..]);
- res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
- res.extend_from_slice(&self.node_id_1.serialize());
- res.extend_from_slice(&self.node_id_2.serialize());
- res.extend_from_slice(&self.bitcoin_key_1.serialize());
- res.extend_from_slice(&self.bitcoin_key_2.serialize());
- res.extend_from_slice(&self.excess_data[..]);
- res
- }
-}
-
-impl MsgDecodable for ChannelAnnouncement {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 64*4 {
- return Err(DecodeError::ShortRead);
- }
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- node_signature_1: secp_signature!(&secp_ctx, &v[0..64]),
- node_signature_2: secp_signature!(&secp_ctx, &v[64..128]),
- bitcoin_signature_1: secp_signature!(&secp_ctx, &v[128..192]),
- bitcoin_signature_2: secp_signature!(&secp_ctx, &v[192..256]),
- contents: UnsignedChannelAnnouncement::decode(&v[256..])?,
- })
- }
-}
-impl MsgEncodable for ChannelAnnouncement {
- fn encode(&self) -> Vec<u8> {
- let secp_ctx = Secp256k1::without_caps();
- let contents = self.contents.encode();
- let mut res = Vec::with_capacity(64 + contents.len());
- res.extend_from_slice(&self.node_signature_1.serialize_compact(&secp_ctx));
- res.extend_from_slice(&self.node_signature_2.serialize_compact(&secp_ctx));
- res.extend_from_slice(&self.bitcoin_signature_1.serialize_compact(&secp_ctx));
- res.extend_from_slice(&self.bitcoin_signature_2.serialize_compact(&secp_ctx));
- res.extend_from_slice(&contents);
- res
- }
+ fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
+ /// Handle an incoming channel_update message, returning true if it should be forwarded on,
+ /// false or returning an Err otherwise.
+ fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, HandleError>;
+ /// Handle some updates to the route graph that we learned due to an outbound failed payment.
+ fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
+ /// Gets a subset of the channel announcements and updates required to dump our routing table
+ /// to a remote node, starting at the short_channel_id indicated by starting_point and
+ /// including batch_amount entries.
+ fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(ChannelAnnouncement, ChannelUpdate, ChannelUpdate)>;
+ /// Gets a subset of the node announcements required to dump our routing table to a remote node,
+ /// starting at the node *after* the provided publickey and including batch_amount entries.
+ /// If None is provided for starting_point, we start at the first node.
+ fn get_next_node_announcements(&self, starting_point: Option<&PublicKey>, batch_amount: u8) -> Vec<NodeAnnouncement>;
+}
+
+pub(crate) struct OnionRealm0HopData {
+ pub(crate) short_channel_id: u64,
+ pub(crate) amt_to_forward: u64,
+ pub(crate) outgoing_cltv_value: u32,
+ // 12 bytes of 0-padding
}
-impl MsgDecodable for UnsignedChannelUpdate {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32+8+4+2+2+8+4+4 {
- return Err(DecodeError::ShortRead);
- }
- let mut excess_data = Vec::with_capacity(v.len() - 64);
- excess_data.extend_from_slice(&v[64..]);
- Ok(Self {
- chain_hash: deserialize(&v[0..32]).unwrap(),
- short_channel_id: byte_utils::slice_to_be64(&v[32..40]),
- timestamp: byte_utils::slice_to_be32(&v[40..44]),
- flags: byte_utils::slice_to_be16(&v[44..46]),
- cltv_expiry_delta: byte_utils::slice_to_be16(&v[46..48]),
- htlc_minimum_msat: byte_utils::slice_to_be64(&v[48..56]),
- fee_base_msat: byte_utils::slice_to_be32(&v[56..60]),
- fee_proportional_millionths: byte_utils::slice_to_be32(&v[60..64]),
- excess_data
- })
- }
-}
-impl MsgEncodable for UnsignedChannelUpdate {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(64 + self.excess_data.len());
- res.extend_from_slice(&self.chain_hash[..]);
- res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
- res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp));
- res.extend_from_slice(&byte_utils::be16_to_array(self.flags));
- res.extend_from_slice(&byte_utils::be16_to_array(self.cltv_expiry_delta));
- res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
- res.extend_from_slice(&byte_utils::be32_to_array(self.fee_base_msat));
- res.extend_from_slice(&byte_utils::be32_to_array(self.fee_proportional_millionths));
- res.extend_from_slice(&self.excess_data[..]);
- res
+mod fuzzy_internal_msgs {
+ // These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
+ // them from untrusted input):
+
+ use super::OnionRealm0HopData;
+ pub struct OnionHopData {
+ pub(crate) realm: u8,
+ pub(crate) data: OnionRealm0HopData,
+ pub(crate) hmac: [u8; 32],
}
-}
-impl MsgDecodable for ChannelUpdate {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 128 {
- return Err(DecodeError::ShortRead);
- }
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- signature: secp_signature!(&secp_ctx, &v[0..64]),
- contents: UnsignedChannelUpdate::decode(&v[64..])?,
- })
+ pub struct DecodedOnionErrorPacket {
+ pub(crate) hmac: [u8; 32],
+ pub(crate) failuremsg: Vec<u8>,
+ pub(crate) pad: Vec<u8>,
}
}
-impl MsgEncodable for ChannelUpdate {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(128);
- res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps())[..]);
- res.extend_from_slice(&self.contents.encode()[..]);
- res
- }
+#[cfg(feature = "fuzztarget")]
+pub use self::fuzzy_internal_msgs::*;
+#[cfg(not(feature = "fuzztarget"))]
+pub(crate) use self::fuzzy_internal_msgs::*;
+
+#[derive(Clone)]
+pub(crate) struct OnionPacket {
+ pub(crate) version: u8,
+ /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we
+ /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public
+ /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like.
+ pub(crate) public_key: Result<PublicKey, secp256k1::Error>,
+ pub(crate) hop_data: [u8; 20*65],
+ pub(crate) hmac: [u8; 32],
}
-impl MsgDecodable for OnionRealm0HopData {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32 {
- return Err(DecodeError::ShortRead);
+impl PartialEq for OnionPacket {
+ fn eq(&self, other: &OnionPacket) -> bool {
+ for (i, j) in self.hop_data.iter().zip(other.hop_data.iter()) {
+ if i != j { return false; }
}
- Ok(OnionRealm0HopData {
- short_channel_id: byte_utils::slice_to_be64(&v[0..8]),
- amt_to_forward: byte_utils::slice_to_be64(&v[8..16]),
- outgoing_cltv_value: byte_utils::slice_to_be32(&v[16..20]),
- })
+ self.version == other.version &&
+ self.public_key == other.public_key &&
+ self.hmac == other.hmac
}
}
-impl MsgEncodable for OnionRealm0HopData {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32);
- res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id));
- res.extend_from_slice(&byte_utils::be64_to_array(self.amt_to_forward));
- res.extend_from_slice(&byte_utils::be32_to_array(self.outgoing_cltv_value));
- res.resize(32, 0);
- res
- }
+
+#[derive(Clone, PartialEq)]
+pub(crate) struct OnionErrorPacket {
+ // This really should be a constant size slice, but the spec lets these things be up to 128KB?
+ // (TODO) We limit it in decode to much lower...
+ pub(crate) data: Vec<u8>,
}
-impl MsgDecodable for OnionHopData {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 65 {
- return Err(DecodeError::ShortRead);
- }
- let realm = v[0];
- if realm != 0 {
- return Err(DecodeError::UnknownRealmByte);
+impl Error for DecodeError {
+ fn description(&self) -> &str {
+ match *self {
+ DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
+ DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
+ DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
+ DecodeError::ShortRead => "Packet extended beyond the provided bytes",
+ DecodeError::ExtraAddressesPerType => "More than one address of a single type",
+ DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
+ DecodeError::Io(ref e) => e.description(),
}
- let mut hmac = [0; 32];
- hmac[..].copy_from_slice(&v[33..65]);
- Ok(OnionHopData {
- realm: realm,
- data: OnionRealm0HopData::decode(&v[1..33])?,
- hmac: hmac,
- })
}
}
-impl MsgEncodable for OnionHopData {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(65);
- res.push(self.realm);
- res.extend_from_slice(&self.data.encode()[..]);
- res.extend_from_slice(&self.hmac);
- res
+impl fmt::Display for DecodeError {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str(self.description())
}
}
-impl MsgDecodable for OnionPacket {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 1+33+20*65+32 {
- return Err(DecodeError::ShortRead);
- }
- let mut hop_data = [0; 20*65];
- hop_data.copy_from_slice(&v[34..1334]);
- let mut hmac = [0; 32];
- hmac.copy_from_slice(&v[1334..1366]);
- let secp_ctx = Secp256k1::without_caps();
- Ok(Self {
- version: v[0],
- public_key: PublicKey::from_slice(&secp_ctx, &v[1..34]),
- hop_data,
- hmac,
- })
- }
-}
-impl MsgEncodable for OnionPacket {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(1 + 33 + 20*65 + 32);
- res.push(self.version);
- match self.public_key {
- Ok(pubkey) => res.extend_from_slice(&pubkey.serialize()),
- Err(_) => res.extend_from_slice(&[0; 33]),
- }
- res.extend_from_slice(&self.hop_data);
- res.extend_from_slice(&self.hmac);
- res
+impl fmt::Debug for HandleError {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str(self.err)
}
}
-impl MsgDecodable for DecodedOnionErrorPacket {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 32 + 4 {
- return Err(DecodeError::ShortRead);
- }
- let failuremsg_len = byte_utils::slice_to_be16(&v[32..34]) as usize;
- if v.len() < 32 + 4 + failuremsg_len {
- return Err(DecodeError::ShortRead);
- }
- let padding_len = byte_utils::slice_to_be16(&v[34 + failuremsg_len..]) as usize;
- if v.len() < 32 + 4 + failuremsg_len + padding_len {
- return Err(DecodeError::ShortRead);
+impl From<::std::io::Error> for DecodeError {
+ fn from(e: ::std::io::Error) -> Self {
+ if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
+ DecodeError::ShortRead
+ } else {
+ DecodeError::Io(e)
}
-
- let mut hmac = [0; 32];
- hmac.copy_from_slice(&v[0..32]);
- Ok(Self {
- hmac,
- failuremsg: v[34..34 + failuremsg_len].to_vec(),
- pad: v[36 + failuremsg_len..36 + failuremsg_len + padding_len].to_vec(),
- })
- }
-}
-impl MsgEncodable for DecodedOnionErrorPacket {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(32 + 4 + self.failuremsg.len() + self.pad.len());
- res.extend_from_slice(&self.hmac);
- res.extend_from_slice(&[((self.failuremsg.len() >> 8) & 0xff) as u8, (self.failuremsg.len() & 0xff) as u8]);
- res.extend_from_slice(&self.failuremsg);
- res.extend_from_slice(&[((self.pad.len() >> 8) & 0xff) as u8, (self.pad.len() & 0xff) as u8]);
- res.extend_from_slice(&self.pad);
- res
}
}
-impl MsgDecodable for OnionErrorPacket {
- fn decode(v: &[u8]) -> Result<Self, DecodeError> {
- if v.len() < 2 {
- return Err(DecodeError::ShortRead);
- }
- let len = byte_utils::slice_to_be16(&v[0..2]) as usize;
- if v.len() < 2 + len {
- return Err(DecodeError::ShortRead);
+impl Writeable for OptionalField<Script> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ match *self {
+ OptionalField::Present(ref script) => {
+ // Note that Writeable for script includes the 16-bit length tag for us
+ script.write(w)?;
+ },
+ OptionalField::Absent => {}
}
- Ok(Self {
- data: v[2..len+2].to_vec(),
- })
- }
-}
-impl MsgEncodable for OnionErrorPacket {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(2 + self.data.len());
- res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
- res.extend_from_slice(&self.data);
- res
+ Ok(())
}
}
-impl MsgEncodable for ErrorMessage {
- fn encode(&self) -> Vec<u8> {
- let mut res = Vec::with_capacity(34 + self.data.len());
- res.extend_from_slice(&self.channel_id);
- res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
- res.extend_from_slice(&self.data.as_bytes());
- res
- }
-}
-impl MsgDecodable for ErrorMessage {
- fn decode(v: &[u8]) -> Result<Self,DecodeError> {
- if v.len() < 34 {
- return Err(DecodeError::ShortRead);
+impl<R: Read> Readable<R> for OptionalField<Script> {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
+ match <u16 as Readable<R>>::read(r) {
+ Ok(len) => {
+ let mut buf = vec![0; len as usize];
+ r.read_exact(&mut buf)?;
+ Ok(OptionalField::Present(Script::from(buf)))
+ },
+ Err(DecodeError::ShortRead) => Ok(OptionalField::Absent),
+ Err(e) => Err(e)
}
- // Unlike most messages, BOLT 1 requires we truncate our read if the value is out of range
- let len = cmp::min(byte_utils::slice_to_be16(&v[32..34]) as usize, v.len() - 34);
- let data = match String::from_utf8(v[34..34 + len].to_vec()) {
- Ok(s) => s,
- Err(_) => return Err(DecodeError::BadText),
- };
- let mut channel_id = [0; 32];
- channel_id[..].copy_from_slice(&v[0..32]);
- Ok(Self {
- channel_id,
- data,
- })
}
}
-impl_writeable!(AcceptChannel, {
+impl_writeable_len_match!(AcceptChannel, {
+ {AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
+ {_, 270}
+ }, {
temporary_channel_id,
dust_limit_satoshis,
max_htlc_value_in_flight_msat,
shutdown_scriptpubkey
});
-impl_writeable!(AnnouncementSignatures, {
+impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
channel_id,
short_channel_id,
node_signature,
bitcoin_signature
});
-impl<W: ::std::io::Write> Writeable<W> for ChannelReestablish {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for ChannelReestablish {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
self.channel_id.write(w)?;
self.next_local_commitment_number.write(w)?;
self.next_remote_commitment_number.write(w)?;
- if let Some(ref data_loss_protect) = self.data_loss_protect {
- data_loss_protect.your_last_per_commitment_secret.write(w)?;
- data_loss_protect.my_current_per_commitment_point.write(w)?;
+ match self.data_loss_protect {
+ OptionalField::Present(ref data_loss_protect) => {
+ (*data_loss_protect).your_last_per_commitment_secret.write(w)?;
+ (*data_loss_protect).my_current_per_commitment_point.write(w)?;
+ },
+ OptionalField::Absent => {}
}
Ok(())
}
}
-impl<R: ::std::io::Read> Readable<R> for ChannelReestablish{
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for ChannelReestablish{
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Self {
channel_id: Readable::read(r)?,
next_local_commitment_number: Readable::read(r)?,
data_loss_protect: {
match <[u8; 32] as Readable<R>>::read(r) {
Ok(your_last_per_commitment_secret) =>
- Some(DataLossProtect {
+ OptionalField::Present(DataLossProtect {
your_last_per_commitment_secret,
my_current_per_commitment_point: Readable::read(r)?,
}),
- Err(DecodeError::ShortRead) => None,
+ Err(DecodeError::ShortRead) => OptionalField::Absent,
Err(e) => return Err(e)
}
}
}
}
-impl_writeable!(ClosingSigned, {
+impl_writeable!(ClosingSigned, 32+8+64, {
channel_id,
fee_satoshis,
signature
});
-impl_writeable!(CommitmentSigned, {
+impl_writeable_len_match!(CommitmentSigned, {
+ { CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
+ }, {
channel_id,
signature,
htlc_signatures
});
-impl_writeable!(DecodedOnionErrorPacket, {
+impl_writeable_len_match!(DecodedOnionErrorPacket, {
+ { DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
+ }, {
hmac,
failuremsg,
pad
});
-impl_writeable!(FundingCreated, {
+impl_writeable!(FundingCreated, 32+32+2+64, {
temporary_channel_id,
funding_txid,
funding_output_index,
signature
});
-impl_writeable!(FundingSigned, {
+impl_writeable!(FundingSigned, 32+64, {
channel_id,
signature
});
-impl_writeable!(FundingLocked, {
+impl_writeable!(FundingLocked, 32+33, {
channel_id,
next_per_commitment_point
});
-impl_writeable!(GlobalFeatures, {
+impl_writeable_len_match!(GlobalFeatures, {
+ { GlobalFeatures { ref flags }, flags.len() + 2 }
+ }, {
flags
});
-impl_writeable!(LocalFeatures, {
+impl_writeable_len_match!(LocalFeatures, {
+ { LocalFeatures { ref flags }, flags.len() + 2 }
+ }, {
flags
});
-impl_writeable!(Init, {
+impl_writeable_len_match!(Init, {
+ { Init { ref global_features, ref local_features }, global_features.flags.len() + local_features.flags.len() + 4 }
+ }, {
global_features,
local_features
});
-impl_writeable!(OpenChannel, {
+impl_writeable_len_match!(OpenChannel, {
+ { OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
+ { _, 319 }
+ }, {
chain_hash,
temporary_channel_id,
funding_satoshis,
shutdown_scriptpubkey
});
-impl_writeable!(RevokeAndACK, {
+impl_writeable!(RevokeAndACK, 32+32+33, {
channel_id,
per_commitment_secret,
next_per_commitment_point
});
-impl_writeable!(Shutdown, {
+impl_writeable_len_match!(Shutdown, {
+ { Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
+ }, {
channel_id,
scriptpubkey
});
-impl_writeable!(UpdateFailHTLC, {
+impl_writeable_len_match!(UpdateFailHTLC, {
+ { UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
+ }, {
channel_id,
htlc_id,
reason
});
-impl_writeable!(UpdateFailMalformedHTLC, {
+impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
channel_id,
htlc_id,
sha256_of_onion,
failure_code
});
-impl_writeable!(UpdateFee, {
+impl_writeable!(UpdateFee, 32+4, {
channel_id,
feerate_per_kw
});
-impl_writeable!(UpdateFulfillHTLC, {
+impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
channel_id,
htlc_id,
payment_preimage
});
-impl_writeable!(OnionErrorPacket, {
+impl_writeable_len_match!(OnionErrorPacket, {
+ { OnionErrorPacket { ref data, .. }, 2 + data.len() }
+ }, {
data
});
-impl<W: ::std::io::Write> Writeable<W> for OnionPacket {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for OnionPacket {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(1 + 33 + 20*65 + 32);
self.version.write(w)?;
match self.public_key {
Ok(pubkey) => pubkey.write(w)?,
}
}
-impl<R: ::std::io::Read> Readable<R> for OnionPacket {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for OnionPacket {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(OnionPacket {
version: Readable::read(r)?,
public_key: {
let mut buf = [0u8;33];
r.read_exact(&mut buf)?;
- PublicKey::from_slice(&Secp256k1::without_caps(), &buf)
+ PublicKey::from_slice(&buf)
},
hop_data: Readable::read(r)?,
hmac: Readable::read(r)?,
}
}
-impl_writeable!(UpdateAddHTLC, {
+impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
channel_id,
htlc_id,
amount_msat,
onion_routing_packet
});
-impl<W: ::std::io::Write> Writeable<W> for OnionRealm0HopData {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for OnionRealm0HopData {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(32);
self.short_channel_id.write(w)?;
self.amt_to_forward.write(w)?;
self.outgoing_cltv_value.write(w)?;
}
}
-impl<R: ::std::io::Read> Readable<R> for OnionRealm0HopData {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for OnionRealm0HopData {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(OnionRealm0HopData {
short_channel_id: Readable::read(r)?,
amt_to_forward: Readable::read(r)?,
}
}
-impl<W: ::std::io::Write> Writeable<W> for OnionHopData {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for OnionHopData {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(65);
self.realm.write(w)?;
self.data.write(w)?;
self.hmac.write(w)?;
}
}
-impl<R: ::std::io::Read> Readable<R> for OnionHopData {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for OnionHopData {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(OnionHopData {
realm: {
let r: u8 = Readable::read(r)?;
if r != 0 {
- return Err(DecodeError::UnknownRealmByte);
+ return Err(DecodeError::UnknownVersion);
}
r
},
}
}
-impl<W: ::std::io::Write> Writeable<W> for Ping {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for Ping {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(self.byteslen as usize + 4);
self.ponglen.write(w)?;
vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
Ok(())
}
}
-impl<R: ::std::io::Read> Readable<R> for Ping {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for Ping {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Ping {
ponglen: Readable::read(r)?,
byteslen: {
}
}
-impl<W: ::std::io::Write> Writeable<W> for Pong {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for Pong {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(self.byteslen as usize + 2);
vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
Ok(())
}
}
-impl<R: ::std::io::Read> Readable<R> for Pong {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for Pong {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Pong {
byteslen: {
let byteslen = Readable::read(r)?;
}
}
-impl<W: ::std::io::Write> Writeable<W> for UnsignedChannelAnnouncement {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for UnsignedChannelAnnouncement {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(2 + 2*32 + 4*33 + self.features.flags.len() + self.excess_data.len());
self.features.write(w)?;
self.chain_hash.write(w)?;
self.short_channel_id.write(w)?;
}
}
-impl<R: ::std::io::Read> Readable<R> for UnsignedChannelAnnouncement {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for UnsignedChannelAnnouncement {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Self {
features: {
let f: GlobalFeatures = Readable::read(r)?;
}
}
-impl_writeable!(ChannelAnnouncement,{
+impl_writeable_len_match!(ChannelAnnouncement, {
+ { ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
+ 2 + 2*32 + 4*33 + features.flags.len() + excess_data.len() + 4*64 }
+ }, {
node_signature_1,
node_signature_2,
bitcoin_signature_1,
contents
});
-impl<W: ::std::io::Write> Writeable<W> for UnsignedChannelUpdate {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for UnsignedChannelUpdate {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(64 + self.excess_data.len());
self.chain_hash.write(w)?;
self.short_channel_id.write(w)?;
self.timestamp.write(w)?;
}
}
-impl<R: ::std::io::Read> Readable<R> for UnsignedChannelUpdate {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for UnsignedChannelUpdate {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Self {
chain_hash: Readable::read(r)?,
short_channel_id: Readable::read(r)?,
}
}
-impl_writeable!(ChannelUpdate, {
+impl_writeable_len_match!(ChannelUpdate, {
+ { ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ..}, .. },
+ 64 + excess_data.len() + 64 }
+ }, {
signature,
contents
});
-impl<W: ::std::io::Write> Writeable<W> for ErrorMessage {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for ErrorMessage {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(32 + 2 + self.data.len());
self.channel_id.write(w)?;
- self.data.as_bytes().to_vec().write(w)?; // write with size prefix
+ (self.data.len() as u16).write(w)?;
+ w.write_all(self.data.as_bytes())?;
Ok(())
}
}
-impl<R: ::std::io::Read> Readable<R> for ErrorMessage {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for ErrorMessage {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
Ok(Self {
channel_id: Readable::read(r)?,
data: {
sz = cmp::min(data_len, sz);
match String::from_utf8(data[..sz as usize].to_vec()) {
Ok(s) => s,
- Err(_) => return Err(DecodeError::BadText),
+ Err(_) => return Err(DecodeError::InvalidValue),
}
}
})
}
}
-impl<W: ::std::io::Write> Writeable<W> for UnsignedNodeAnnouncement {
- fn write(&self, w: &mut Writer<W>) -> Result<(), DecodeError> {
+impl Writeable for UnsignedNodeAnnouncement {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ w.size_hint(64 + 76 + self.features.flags.len() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
self.features.write(w)?;
self.timestamp.write(w)?;
self.node_id.write(w)?;
w.write_all(&self.rgb)?;
self.alias.write(w)?;
- let mut addr_slice = Vec::with_capacity(self.addresses.len() * 18);
let mut addrs_to_encode = self.addresses.clone();
addrs_to_encode.sort_unstable_by(|a, b| { a.get_id().cmp(&b.get_id()) });
addrs_to_encode.dedup_by(|a, b| { a.get_id() == b.get_id() });
- for addr in addrs_to_encode.iter() {
- match addr {
- &NetAddress::IPv4{addr, port} => {
- addr_slice.push(1);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::IPv6{addr, port} => {
- addr_slice.push(2);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::OnionV2{addr, port} => {
- addr_slice.push(3);
- addr_slice.extend_from_slice(&addr);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- &NetAddress::OnionV3{ed25519_pubkey, checksum, version, port} => {
- addr_slice.push(4);
- addr_slice.extend_from_slice(&ed25519_pubkey);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(checksum));
- addr_slice.push(version);
- addr_slice.extend_from_slice(&byte_utils::be16_to_array(port));
- },
- }
+ let mut addr_len = 0;
+ for addr in &addrs_to_encode {
+ addr_len += 1 + addr.len();
+ }
+ (addr_len + self.excess_address_data.len() as u16).write(w)?;
+ for addr in addrs_to_encode {
+ addr.write(w)?;
}
- ((addr_slice.len() + self.excess_address_data.len()) as u16).write(w)?;
- w.write_all(&addr_slice[..])?;
w.write_all(&self.excess_address_data[..])?;
w.write_all(&self.excess_data[..])?;
Ok(())
}
}
-impl<R: ::std::io::Read> Readable<R> for UnsignedNodeAnnouncement {
- fn read(r: &mut Reader<R>) -> Result<Self, DecodeError> {
+impl<R: Read> Readable<R> for UnsignedNodeAnnouncement {
+ fn read(r: &mut R) -> Result<Self, DecodeError> {
let features: GlobalFeatures = Readable::read(r)?;
if features.requires_unknown_bits() {
return Err(DecodeError::UnknownRequiredFeature);
r.read_exact(&mut rgb)?;
let alias: [u8; 32] = Readable::read(r)?;
- let addrlen: u16 = Readable::read(r)?;
+ let addr_len: u16 = Readable::read(r)?;
+ let mut addresses: Vec<NetAddress> = Vec::with_capacity(4);
let mut addr_readpos = 0;
- let mut addresses = Vec::with_capacity(4);
- let mut f: u8 = 0;
- let mut excess = 0;
+ let mut excess = false;
+ let mut excess_byte = 0;
loop {
- if addrlen <= addr_readpos { break; }
- f = Readable::read(r)?;
- match f {
- 1 => {
- if addresses.len() > 0 {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addrlen < addr_readpos + 1 + 6 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- addresses.push(NetAddress::IPv4 {
- addr: {
- let mut addr = [0; 4];
- r.read_exact(&mut addr)?;
- addr
+ if addr_len <= addr_readpos { break; }
+ match Readable::read(r) {
+ Ok(Ok(addr)) => {
+ match addr {
+ NetAddress::IPv4 { .. } => {
+ if addresses.len() > 0 {
+ return Err(DecodeError::ExtraAddressesPerType);
+ }
},
- port: Readable::read(r)?,
- });
- addr_readpos += 1 + 6
- },
- 2 => {
- if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addrlen < addr_readpos + 1 + 18 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- addresses.push(NetAddress::IPv6 {
- addr: {
- let mut addr = [0; 16];
- r.read_exact(&mut addr)?;
- addr
+ NetAddress::IPv6 { .. } => {
+ if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) {
+ return Err(DecodeError::ExtraAddressesPerType);
+ }
},
- port: Readable::read(r)?,
- });
- addr_readpos += 1 + 18
- },
- 3 => {
- if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
- return Err(DecodeError::ExtraAddressesPerType);
- }
- if addrlen < addr_readpos + 1 + 12 {
- return Err(DecodeError::BadLengthDescriptor);
- }
- addresses.push(NetAddress::OnionV2 {
- addr: {
- let mut addr = [0; 10];
- r.read_exact(&mut addr)?;
- addr
+ NetAddress::OnionV2 { .. } => {
+ if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) {
+ return Err(DecodeError::ExtraAddressesPerType);
+ }
+ },
+ NetAddress::OnionV3 { .. } => {
+ if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
+ return Err(DecodeError::ExtraAddressesPerType);
+ }
},
- port: Readable::read(r)?,
- });
- addr_readpos += 1 + 12
- },
- 4 => {
- if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) {
- return Err(DecodeError::ExtraAddressesPerType);
}
- if addrlen < addr_readpos + 1 + 37 {
+ if addr_len < addr_readpos + 1 + addr.len() {
return Err(DecodeError::BadLengthDescriptor);
}
- addresses.push(NetAddress::OnionV3 {
- ed25519_pubkey: Readable::read(r)?,
- checksum: Readable::read(r)?,
- version: Readable::read(r)?,
- port: Readable::read(r)?,
- });
- addr_readpos += 1 + 37
+ addr_readpos += (1 + addr.len()) as u16;
+ addresses.push(addr);
+ },
+ Ok(Err(unknown_descriptor)) => {
+ excess = true;
+ excess_byte = unknown_descriptor;
+ break;
},
- _ => { excess = 1; break; }
+ Err(DecodeError::ShortRead) => return Err(DecodeError::BadLengthDescriptor),
+ Err(e) => return Err(e),
}
}
let mut excess_data = vec![];
- let excess_address_data = if addr_readpos < addrlen {
- let mut excess_address_data = vec![0; (addrlen - addr_readpos) as usize];
- r.read_exact(&mut excess_address_data[excess..])?;
- if excess == 1 {
- excess_address_data[0] = f;
+ let excess_address_data = if addr_readpos < addr_len {
+ let mut excess_address_data = vec![0; (addr_len - addr_readpos) as usize];
+ r.read_exact(&mut excess_address_data[if excess { 1 } else { 0 }..])?;
+ if excess {
+ excess_address_data[0] = excess_byte;
}
excess_address_data
} else {
- if excess == 1 {
- excess_data.push(f);
+ if excess {
+ excess_data.push(excess_byte);
}
Vec::new()
};
-
+ r.read_to_end(&mut excess_data)?;
Ok(UnsignedNodeAnnouncement {
- features: features,
- timestamp: timestamp,
- node_id: node_id,
- rgb: rgb,
- alias: alias,
- addresses: addresses,
- excess_address_data: excess_address_data,
- excess_data: {
- r.read_to_end(&mut excess_data)?;
- excess_data
- },
+ features,
+ timestamp,
+ node_id,
+ rgb,
+ alias,
+ addresses,
+ excess_address_data,
+ excess_data,
})
}
}
-impl_writeable!(NodeAnnouncement, {
+impl_writeable_len_match!(NodeAnnouncement, {
+ { NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
+ 64 + 76 + features.flags.len() + addresses.len()*38 + excess_address_data.len() + excess_data.len() }
+ }, {
signature,
contents
});
#[cfg(test)]
mod tests {
use hex;
- use ln::msgs::MsgEncodable;
use ln::msgs;
+ use ln::msgs::{GlobalFeatures, LocalFeatures, OptionalField, OnionErrorPacket};
+ use ln::channelmanager::{PaymentPreimage, PaymentHash};
+ use util::ser::Writeable;
+
+ use bitcoin_hashes::sha256d::Hash as Sha256dHash;
+ use bitcoin_hashes::hex::FromHex;
+ use bitcoin::util::address::Address;
+ use bitcoin::network::constants::Network;
+ use bitcoin::blockdata::script::Builder;
+ use bitcoin::blockdata::opcodes;
+
use secp256k1::key::{PublicKey,SecretKey};
- use secp256k1::Secp256k1;
+ use secp256k1::{Secp256k1, Message};
#[test]
fn encoding_channel_reestablish_no_secret() {
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],
next_local_commitment_number: 3,
next_remote_commitment_number: 4,
- data_loss_protect: None,
+ data_loss_protect: OptionalField::Absent,
};
let encoded_value = cr.encode();
fn encoding_channel_reestablish_with_secret() {
let public_key = {
let secp_ctx = Secp256k1::new();
- PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
+ PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap())
};
let cr = msgs::ChannelReestablish {
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],
next_local_commitment_number: 3,
next_remote_commitment_number: 4,
- data_loss_protect: Some(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
+ data_loss_protect: OptionalField::Present(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}),
};
let encoded_value = cr.encode();
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]
);
}
+
+ macro_rules! get_keys_from {
+ ($slice: expr, $secp_ctx: expr) => {
+ {
+ let privkey = SecretKey::from_slice(&hex::decode($slice).unwrap()[..]).unwrap();
+ let pubkey = PublicKey::from_secret_key(&$secp_ctx, &privkey);
+ (privkey, pubkey)
+ }
+ }
+ }
+
+ macro_rules! get_sig_on {
+ ($privkey: expr, $ctx: expr, $string: expr) => {
+ {
+ let sighash = Message::from_slice(&$string.into_bytes()[..]).unwrap();
+ $ctx.sign(&sighash, &$privkey)
+ }
+ }
+ }
+
+ #[test]
+ fn encoding_announcement_signatures() {
+ let secp_ctx = Secp256k1::new();
+ let (privkey, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_2 = get_sig_on!(privkey, secp_ctx, String::from("02020202020202020202020202020202"));
+ let announcement_signatures = msgs::AnnouncementSignatures {
+ 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],
+ short_channel_id: 2316138423780173,
+ node_signature: sig_1,
+ bitcoin_signature: sig_2,
+ };
+
+ let encoded_value = announcement_signatures.encode();
+ assert_eq!(encoded_value, hex::decode("040000000000000005000000000000000600000000000000070000000000000000083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073acf9953cef4700860f5967838eba2bae89288ad188ebf8b20bf995c3ea53a26df1876d0a3a0e13172ba286a673140190c02ba9da60a2e43a745188c8a83c7f3ef").unwrap());
+ }
+
+ fn do_encoding_channel_announcement(unknown_features_bits: bool, non_bitcoin_chain_hash: bool, excess_data: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let (privkey_2, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
+ let (privkey_3, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
+ let (privkey_4, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
+ let mut features = GlobalFeatures::new();
+ if unknown_features_bits {
+ features.flags = vec![0xFF, 0xFF];
+ }
+ let unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
+ features,
+ chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ short_channel_id: 2316138423780173,
+ node_id_1: pubkey_1,
+ node_id_2: pubkey_2,
+ bitcoin_key_1: pubkey_3,
+ bitcoin_key_2: pubkey_4,
+ excess_data: if excess_data { vec![10, 0, 0, 20, 0, 0, 30, 0, 0, 40] } else { Vec::new() },
+ };
+ let channel_announcement = msgs::ChannelAnnouncement {
+ node_signature_1: sig_1,
+ node_signature_2: sig_2,
+ bitcoin_signature_1: sig_3,
+ bitcoin_signature_2: sig_4,
+ contents: unsigned_channel_announcement,
+ };
+ let encoded_value = channel_announcement.encode();
+ let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a1735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap();
+ if unknown_features_bits {
+ target_value.append(&mut hex::decode("0002ffff").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("0000").unwrap());
+ }
+ if non_bitcoin_chain_hash {
+ target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
+ }
+ target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
+ if excess_data {
+ target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_channel_announcement() {
+ do_encoding_channel_announcement(false, false, false);
+ do_encoding_channel_announcement(true, false, false);
+ do_encoding_channel_announcement(true, true, false);
+ do_encoding_channel_announcement(true, true, true);
+ do_encoding_channel_announcement(false, true, true);
+ do_encoding_channel_announcement(false, false, true);
+ do_encoding_channel_announcement(false, true, false);
+ do_encoding_channel_announcement(true, false, true);
+ }
+
+ fn do_encoding_node_announcement(unknown_features_bits: bool, ipv4: bool, ipv6: bool, onionv2: bool, onionv3: bool, excess_address_data: bool, excess_data: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let mut features = GlobalFeatures::new();
+ if unknown_features_bits {
+ features.flags = vec![0xFF, 0xFF];
+ }
+ let mut addresses = Vec::new();
+ if ipv4 {
+ addresses.push(msgs::NetAddress::IPv4 {
+ addr: [255, 254, 253, 252],
+ port: 9735
+ });
+ }
+ if ipv6 {
+ addresses.push(msgs::NetAddress::IPv6 {
+ addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
+ port: 9735
+ });
+ }
+ if onionv2 {
+ addresses.push(msgs::NetAddress::OnionV2 {
+ addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246],
+ port: 9735
+ });
+ }
+ if onionv3 {
+ addresses.push(msgs::NetAddress::OnionV3 {
+ ed25519_pubkey: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240, 239, 238, 237, 236, 235, 234, 233, 232, 231, 230, 229, 228, 227, 226, 225, 224],
+ checksum: 32,
+ version: 16,
+ port: 9735
+ });
+ }
+ let mut addr_len = 0;
+ for addr in &addresses {
+ addr_len += addr.len() + 1;
+ }
+ let unsigned_node_announcement = msgs::UnsignedNodeAnnouncement {
+ features,
+ timestamp: 20190119,
+ node_id: pubkey_1,
+ rgb: [32; 3],
+ alias: [16;32],
+ addresses,
+ excess_address_data: if excess_address_data { vec![33, 108, 40, 11, 83, 149, 162, 84, 110, 126, 75, 38, 99, 224, 79, 129, 22, 34, 241, 90, 79, 146, 232, 58, 162, 233, 43, 162, 165, 115, 193, 57, 20, 44, 84, 174, 99, 7, 42, 30, 193, 238, 125, 192, 192, 75, 222, 92, 132, 120, 6, 23, 42, 160, 92, 146, 194, 42, 232, 227, 8, 209, 210, 105] } else { Vec::new() },
+ excess_data: if excess_data { vec![59, 18, 204, 25, 92, 224, 162, 209, 189, 166, 168, 139, 239, 161, 159, 160, 127, 81, 202, 167, 92, 232, 56, 55, 242, 137, 101, 96, 11, 138, 172, 171, 8, 85, 255, 176, 231, 65, 236, 95, 124, 65, 66, 30, 152, 41, 169, 212, 134, 17, 200, 200, 49, 247, 27, 229, 234, 115, 230, 101, 148, 151, 127, 253] } else { Vec::new() },
+ };
+ addr_len += unsigned_node_announcement.excess_address_data.len() as u16;
+ let node_announcement = msgs::NodeAnnouncement {
+ signature: sig_1,
+ contents: unsigned_node_announcement,
+ };
+ let encoded_value = node_announcement.encode();
+ let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ if unknown_features_bits {
+ target_value.append(&mut hex::decode("0002ffff").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("0000").unwrap());
+ }
+ target_value.append(&mut hex::decode("013413a7031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f2020201010101010101010101010101010101010101010101010101010101010101010").unwrap());
+ target_value.append(&mut vec![(addr_len >> 8) as u8, addr_len as u8]);
+ if ipv4 {
+ target_value.append(&mut hex::decode("01fffefdfc2607").unwrap());
+ }
+ if ipv6 {
+ target_value.append(&mut hex::decode("02fffefdfcfbfaf9f8f7f6f5f4f3f2f1f02607").unwrap());
+ }
+ if onionv2 {
+ target_value.append(&mut hex::decode("03fffefdfcfbfaf9f8f7f62607").unwrap());
+ }
+ if onionv3 {
+ target_value.append(&mut hex::decode("04fffefdfcfbfaf9f8f7f6f5f4f3f2f1f0efeeedecebeae9e8e7e6e5e4e3e2e1e00020102607").unwrap());
+ }
+ if excess_address_data {
+ target_value.append(&mut hex::decode("216c280b5395a2546e7e4b2663e04f811622f15a4f92e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d269").unwrap());
+ }
+ if excess_data {
+ target_value.append(&mut hex::decode("3b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_node_announcement() {
+ do_encoding_node_announcement(true, true, true, true, true, true, true);
+ do_encoding_node_announcement(false, false, false, false, false, false, false);
+ do_encoding_node_announcement(false, true, false, false, false, false, false);
+ do_encoding_node_announcement(false, false, true, false, false, false, false);
+ do_encoding_node_announcement(false, false, false, true, false, false, false);
+ do_encoding_node_announcement(false, false, false, false, true, false, false);
+ do_encoding_node_announcement(false, false, false, false, false, true, false);
+ do_encoding_node_announcement(false, true, false, true, false, true, false);
+ do_encoding_node_announcement(false, false, true, false, true, false, false);
+ }
+
+ fn do_encoding_channel_update(non_bitcoin_chain_hash: bool, direction: bool, disable: bool, htlc_maximum_msat: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let unsigned_channel_update = msgs::UnsignedChannelUpdate {
+ chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ short_channel_id: 2316138423780173,
+ timestamp: 20190119,
+ flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 } | if htlc_maximum_msat { 1 << 8 } else { 0 },
+ cltv_expiry_delta: 144,
+ htlc_minimum_msat: 1000000,
+ fee_base_msat: 10000,
+ fee_proportional_millionths: 20,
+ excess_data: if htlc_maximum_msat { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
+ };
+ let channel_update = msgs::ChannelUpdate {
+ signature: sig_1,
+ contents: unsigned_channel_update
+ };
+ let encoded_value = channel_update.encode();
+ let mut target_value = hex::decode("d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ if non_bitcoin_chain_hash {
+ target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
+ }
+ target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
+ if htlc_maximum_msat {
+ target_value.append(&mut hex::decode("01").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("00").unwrap());
+ }
+ target_value.append(&mut hex::decode("00").unwrap());
+ if direction {
+ let flag = target_value.last_mut().unwrap();
+ *flag = 1;
+ }
+ if disable {
+ let flag = target_value.last_mut().unwrap();
+ *flag = *flag | 1 << 1;
+ }
+ target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
+ if htlc_maximum_msat {
+ target_value.append(&mut hex::decode("000000003b9aca00").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_channel_update() {
+ do_encoding_channel_update(false, false, false, false);
+ do_encoding_channel_update(true, false, false, false);
+ do_encoding_channel_update(false, true, false, false);
+ do_encoding_channel_update(false, false, true, false);
+ do_encoding_channel_update(false, false, false, true);
+ do_encoding_channel_update(true, true, true, true);
+ }
+
+ fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
+ let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
+ let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
+ let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
+ let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
+ let open_channel = msgs::OpenChannel {
+ chain_hash: if !non_bitcoin_chain_hash { Sha256dHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { Sha256dHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ temporary_channel_id: [2; 32],
+ funding_satoshis: 1311768467284833366,
+ push_msat: 2536655962884945560,
+ dust_limit_satoshis: 3608586615801332854,
+ max_htlc_value_in_flight_msat: 8517154655701053848,
+ channel_reserve_satoshis: 8665828695742877976,
+ htlc_minimum_msat: 2316138423780173,
+ feerate_per_kw: 821716,
+ to_self_delay: 49340,
+ max_accepted_htlcs: 49340,
+ funding_pubkey: pubkey_1,
+ revocation_basepoint: pubkey_2,
+ payment_basepoint: pubkey_3,
+ delayed_payment_basepoint: pubkey_4,
+ htlc_basepoint: pubkey_5,
+ first_per_commitment_point: pubkey_6,
+ channel_flags: if random_bit { 1 << 5 } else { 0 },
+ shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
+ };
+ let encoded_value = open_channel.encode();
+ let mut target_value = Vec::new();
+ if non_bitcoin_chain_hash {
+ target_value.append(&mut hex::decode("43497fd7f826957108f4a30fd9cec3aeba79972084e90ead01ea330900000000").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
+ }
+ target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
+ if random_bit {
+ target_value.append(&mut hex::decode("20").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("00").unwrap());
+ }
+ if shutdown {
+ target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_open_channel() {
+ do_encoding_open_channel(false, false, false);
+ do_encoding_open_channel(true, false, false);
+ do_encoding_open_channel(false, true, false);
+ do_encoding_open_channel(false, false, true);
+ do_encoding_open_channel(true, true, true);
+ }
+
+ fn do_encoding_accept_channel(shutdown: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
+ let (_, pubkey_3) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
+ let (_, pubkey_4) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
+ let (_, pubkey_5) = get_keys_from!("0505050505050505050505050505050505050505050505050505050505050505", secp_ctx);
+ let (_, pubkey_6) = get_keys_from!("0606060606060606060606060606060606060606060606060606060606060606", secp_ctx);
+ let accept_channel = msgs::AcceptChannel {
+ temporary_channel_id: [2; 32],
+ dust_limit_satoshis: 1311768467284833366,
+ max_htlc_value_in_flight_msat: 2536655962884945560,
+ channel_reserve_satoshis: 3608586615801332854,
+ htlc_minimum_msat: 2316138423780173,
+ minimum_depth: 821716,
+ to_self_delay: 49340,
+ max_accepted_htlcs: 49340,
+ funding_pubkey: pubkey_1,
+ revocation_basepoint: pubkey_2,
+ payment_basepoint: pubkey_3,
+ delayed_payment_basepoint: pubkey_4,
+ htlc_basepoint: pubkey_5,
+ first_per_commitment_point: pubkey_6,
+ shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
+ };
+ let encoded_value = accept_channel.encode();
+ let mut target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020212345678901234562334032891223698321446687011447600083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap();
+ if shutdown {
+ target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_accept_channel() {
+ do_encoding_accept_channel(false);
+ do_encoding_accept_channel(true);
+ }
+
+ #[test]
+ fn encoding_funding_created() {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let funding_created = msgs::FundingCreated {
+ temporary_channel_id: [2; 32],
+ funding_txid: Sha256dHash::from_hex("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap(),
+ funding_output_index: 255,
+ signature: sig_1,
+ };
+ let encoded_value = funding_created.encode();
+ let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202026e96fe9f8b0ddcd729ba03cfafa5a27b050b39d354dd980814268dfa9a44d4c200ffd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_funding_signed() {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let funding_signed = msgs::FundingSigned {
+ channel_id: [2; 32],
+ signature: sig_1,
+ };
+ let encoded_value = funding_signed.encode();
+ let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_funding_locked() {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1,) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let funding_locked = msgs::FundingLocked {
+ channel_id: [2; 32],
+ next_per_commitment_point: pubkey_1,
+ };
+ let encoded_value = funding_locked.encode();
+ let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ fn do_encoding_shutdown(script_type: u8) {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
+ let shutdown = msgs::Shutdown {
+ channel_id: [2; 32],
+ scriptpubkey: if script_type == 1 { Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() } else if script_type == 2 { Address::p2sh(&script, Network::Testnet).script_pubkey() } else if script_type == 3 { Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey() } else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
+ };
+ let encoded_value = shutdown.encode();
+ let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
+ if script_type == 1 {
+ target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
+ } else if script_type == 2 {
+ target_value.append(&mut hex::decode("0017a914da1745e9b549bd0bfa1a569971c77eba30cd5a4b87").unwrap());
+ } else if script_type == 3 {
+ target_value.append(&mut hex::decode("0016001479b000887626b294a914501a4cd226b58b235983").unwrap());
+ } else if script_type == 4 {
+ target_value.append(&mut hex::decode("002200204ae81572f06e1b88fd5ced7a1a000945432e83e1551e6f721ee9c00b8cc33260").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_shutdown() {
+ do_encoding_shutdown(1);
+ do_encoding_shutdown(2);
+ do_encoding_shutdown(3);
+ do_encoding_shutdown(4);
+ }
+
+ #[test]
+ fn encoding_closing_signed() {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let closing_signed = msgs::ClosingSigned {
+ channel_id: [2; 32],
+ fee_satoshis: 2316138423780173,
+ signature: sig_1,
+ };
+ let encoded_value = closing_signed.encode();
+ let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034dd977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_update_add_htlc() {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let onion_routing_packet = msgs::OnionPacket {
+ version: 255,
+ public_key: Ok(pubkey_1),
+ hop_data: [1; 20*65],
+ hmac: [2; 32]
+ };
+ let update_add_htlc = msgs::UpdateAddHTLC {
+ channel_id: [2; 32],
+ htlc_id: 2316138423780173,
+ amount_msat: 3608586615801332854,
+ payment_hash: PaymentHash([1; 32]),
+ cltv_expiry: 821716,
+ onion_routing_packet
+ };
+ let encoded_value = update_add_htlc.encode();
+ let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d32144668701144760101010101010101010101010101010101010101010101010101010101010101000c89d4ff031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_update_fulfill_htlc() {
+ let update_fulfill_htlc = msgs::UpdateFulfillHTLC {
+ channel_id: [2; 32],
+ htlc_id: 2316138423780173,
+ payment_preimage: PaymentPreimage([1; 32]),
+ };
+ let encoded_value = update_fulfill_htlc.encode();
+ let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d0101010101010101010101010101010101010101010101010101010101010101").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_update_fail_htlc() {
+ let reason = OnionErrorPacket {
+ data: [1; 32].to_vec(),
+ };
+ let update_fail_htlc = msgs::UpdateFailHTLC {
+ channel_id: [2; 32],
+ htlc_id: 2316138423780173,
+ reason
+ };
+ let encoded_value = update_fail_htlc.encode();
+ let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d00200101010101010101010101010101010101010101010101010101010101010101").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_update_fail_malformed_htlc() {
+ let update_fail_malformed_htlc = msgs::UpdateFailMalformedHTLC {
+ channel_id: [2; 32],
+ htlc_id: 2316138423780173,
+ sha256_of_onion: [1; 32],
+ failure_code: 255
+ };
+ let encoded_value = update_fail_malformed_htlc.encode();
+ let target_value = hex::decode("020202020202020202020202020202020202020202020202020202020202020200083a840000034d010101010101010101010101010101010101010101010101010101010101010100ff").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ fn do_encoding_commitment_signed(htlcs: bool) {
+ let secp_ctx = Secp256k1::new();
+ let (privkey_1, _) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let (privkey_2, _) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
+ let (privkey_3, _) = get_keys_from!("0303030303030303030303030303030303030303030303030303030303030303", secp_ctx);
+ let (privkey_4, _) = get_keys_from!("0404040404040404040404040404040404040404040404040404040404040404", secp_ctx);
+ let sig_1 = get_sig_on!(privkey_1, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_2 = get_sig_on!(privkey_2, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_3 = get_sig_on!(privkey_3, secp_ctx, String::from("01010101010101010101010101010101"));
+ let sig_4 = get_sig_on!(privkey_4, secp_ctx, String::from("01010101010101010101010101010101"));
+ let commitment_signed = msgs::CommitmentSigned {
+ channel_id: [2; 32],
+ signature: sig_1,
+ htlc_signatures: if htlcs { vec![sig_2, sig_3, sig_4] } else { Vec::new() },
+ };
+ let encoded_value = commitment_signed.encode();
+ let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202d977cb9b53d93a6ff64bb5f1e158b4094b66e798fb12911168a3ccdf80a83096340a6a95da0ae8d9f776528eecdbb747eb6b545495a4319ed5378e35b21e073a").unwrap();
+ if htlcs {
+ target_value.append(&mut hex::decode("00031735b6a427e80d5fe7cd90a2f4ee08dc9c27cda7c35a4172e5d85b12c49d4232537e98f9b1f3c5e6989a8b9644e90e8918127680dbd0d4043510840fc0f1e11a216c280b5395a2546e7e4b2663e04f811622f15a4f91e83aa2e92ba2a573c139142c54ae63072a1ec1ee7dc0c04bde5c847806172aa05c92c22ae8e308d1d2692b12cc195ce0a2d1bda6a88befa19fa07f51caa75ce83837f28965600b8aacab0855ffb0e741ec5f7c41421e9829a9d48611c8c831f71be5ea73e66594977ffd").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("0000").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_commitment_signed() {
+ do_encoding_commitment_signed(true);
+ do_encoding_commitment_signed(false);
+ }
+
+ #[test]
+ fn encoding_revoke_and_ack() {
+ let secp_ctx = Secp256k1::new();
+ let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
+ let raa = msgs::RevokeAndACK {
+ channel_id: [2; 32],
+ per_commitment_secret: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+ next_per_commitment_point: pubkey_1,
+ };
+ let encoded_value = raa.encode();
+ let target_value = hex::decode("02020202020202020202020202020202020202020202020202020202020202020101010101010101010101010101010101010101010101010101010101010101031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_update_fee() {
+ let update_fee = msgs::UpdateFee {
+ channel_id: [2; 32],
+ feerate_per_kw: 20190119,
+ };
+ let encoded_value = update_fee.encode();
+ let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202013413a7").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ fn do_encoding_init(unknown_global_bits: bool, initial_routing_sync: bool) {
+ let mut global = GlobalFeatures::new();
+ if unknown_global_bits {
+ global.flags = vec![0xFF, 0xFF];
+ }
+ let mut local = LocalFeatures::new();
+ if initial_routing_sync {
+ local.set_initial_routing_sync();
+ }
+ let init = msgs::Init {
+ global_features: global,
+ local_features: local,
+ };
+ let encoded_value = init.encode();
+ let mut target_value = Vec::new();
+ if unknown_global_bits {
+ target_value.append(&mut hex::decode("0002ffff").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("0000").unwrap());
+ }
+ if initial_routing_sync {
+ target_value.append(&mut hex::decode("00012a").unwrap());
+ } else {
+ target_value.append(&mut hex::decode("000122").unwrap());
+ }
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_init() {
+ do_encoding_init(false, false);
+ do_encoding_init(true, false);
+ do_encoding_init(false, true);
+ do_encoding_init(true, true);
+ }
+
+ #[test]
+ fn encoding_error() {
+ let error = msgs::ErrorMessage {
+ channel_id: [2; 32],
+ data: String::from("rust-lightning"),
+ };
+ let encoded_value = error.encode();
+ let target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202000e727573742d6c696768746e696e67").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_ping() {
+ let ping = msgs::Ping {
+ ponglen: 64,
+ byteslen: 64
+ };
+ let encoded_value = ping.encode();
+ let target_value = hex::decode("0040004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
+
+ #[test]
+ fn encoding_pong() {
+ let pong = msgs::Pong {
+ byteslen: 64
+ };
+ let encoded_value = pong.encode();
+ let target_value = hex::decode("004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap();
+ assert_eq!(encoded_value, target_value);
+ }
}
projects / rust-lightning / blobdiff