+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// You may not use this file except in accordance with one or both of these
+// licenses.
+
//! 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
use std::{cmp, fmt};
use std::io::Read;
-use std::result::Result;
use util::events;
use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
/// An error message to be sent or received from a peer
#[derive(Clone)]
pub struct ErrorMessage {
- pub(crate) channel_id: [u8; 32],
- pub(crate) data: String,
+ /// The channel ID involved in the error
+ pub channel_id: [u8; 32],
+ /// A possibly human-readable error description.
+ /// The string should be sanitized before it is used (e.g. emitted to logs
+ /// or printed to stdout). Otherwise, a well crafted error message may trigger a security
+ /// vulnerability in the terminal emulator or the logging subsystem.
+ pub data: String,
}
/// A ping message to be sent or received from a peer
pub struct Ping {
- pub(crate) ponglen: u16,
- pub(crate) byteslen: u16,
+ /// The desired response length
+ pub ponglen: u16,
+ /// The ping packet size.
+ /// This field is not sent on the wire. byteslen zeros are sent.
+ pub byteslen: u16,
}
/// A pong message to be sent or received from a peer
pub struct Pong {
- pub(crate) byteslen: u16,
+ /// The pong packet size.
+ /// This field is not sent on the wire. byteslen zeros are sent.
+ pub byteslen: u16,
}
/// An open_channel message to be sent or received from a peer
#[derive(Clone)]
pub struct OpenChannel {
- pub(crate) chain_hash: BlockHash,
- 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_point: 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>,
+ /// The genesis hash of the blockchain where the channel is to be opened
+ pub chain_hash: BlockHash,
+ /// A temporary channel ID, until the funding outpoint is announced
+ pub temporary_channel_id: [u8; 32],
+ /// The channel value
+ pub funding_satoshis: u64,
+ /// The amount to push to the counterparty as part of the open, in milli-satoshi
+ pub push_msat: u64,
+ /// The threshold below which outputs on transactions broadcast by sender will be omitted
+ pub dust_limit_satoshis: u64,
+ /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+ pub max_htlc_value_in_flight_msat: u64,
+ /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+ pub channel_reserve_satoshis: u64,
+ /// The minimum HTLC size incoming to sender, in milli-satoshi
+ pub htlc_minimum_msat: u64,
+ /// The feerate per 1000-weight of sender generated transactions, until updated by update_fee
+ pub feerate_per_kw: u32,
+ /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+ pub to_self_delay: u16,
+ /// The maximum number of inbound HTLCs towards sender
+ pub max_accepted_htlcs: u16,
+ /// The sender's key controlling the funding transaction
+ pub funding_pubkey: PublicKey,
+ /// Used to derive a revocation key for transactions broadcast by counterparty
+ pub revocation_basepoint: PublicKey,
+ /// A payment key to sender for transactions broadcast by counterparty
+ pub payment_point: PublicKey,
+ /// Used to derive a payment key to sender for transactions broadcast by sender
+ pub delayed_payment_basepoint: PublicKey,
+ /// Used to derive an HTLC payment key to sender
+ pub htlc_basepoint: PublicKey,
+ /// The first to-be-broadcast-by-sender transaction's per commitment point
+ pub first_per_commitment_point: PublicKey,
+ /// Channel flags
+ pub channel_flags: u8,
+ /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
+ pub shutdown_scriptpubkey: OptionalField<Script>,
}
/// An accept_channel message to be sent or received from a peer
#[derive(Clone)]
pub struct AcceptChannel {
- 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_point: 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 temporary channel ID, until the funding outpoint is announced
+ pub temporary_channel_id: [u8; 32],
+ /// The threshold below which outputs on transactions broadcast by sender will be omitted
+ pub dust_limit_satoshis: u64,
+ /// The maximum inbound HTLC value in flight towards sender, in milli-satoshi
+ pub max_htlc_value_in_flight_msat: u64,
+ /// The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
+ pub channel_reserve_satoshis: u64,
+ /// The minimum HTLC size incoming to sender, in milli-satoshi
+ pub htlc_minimum_msat: u64,
+ /// Minimum depth of the funding transaction before the channel is considered open
+ pub minimum_depth: u32,
+ /// The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
+ pub to_self_delay: u16,
+ /// The maximum number of inbound HTLCs towards sender
+ pub max_accepted_htlcs: u16,
+ /// The sender's key controlling the funding transaction
+ pub funding_pubkey: PublicKey,
+ /// Used to derive a revocation key for transactions broadcast by counterparty
+ pub revocation_basepoint: PublicKey,
+ /// A payment key to sender for transactions broadcast by counterparty
+ pub payment_point: PublicKey,
+ /// Used to derive a payment key to sender for transactions broadcast by sender
+ pub delayed_payment_basepoint: PublicKey,
+ /// Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
+ pub htlc_basepoint: PublicKey,
+ /// The first to-be-broadcast-by-sender transaction's per commitment point
+ pub first_per_commitment_point: PublicKey,
+ /// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
+ pub shutdown_scriptpubkey: OptionalField<Script>,
}
/// A funding_created message to be sent or received from a peer
#[derive(Clone)]
pub struct FundingCreated {
- pub(crate) temporary_channel_id: [u8; 32],
- pub(crate) funding_txid: Txid,
- pub(crate) funding_output_index: u16,
- pub(crate) signature: Signature,
+ /// A temporary channel ID, until the funding is established
+ pub temporary_channel_id: [u8; 32],
+ /// The funding transaction ID
+ pub funding_txid: Txid,
+ /// The specific output index funding this channel
+ pub funding_output_index: u16,
+ /// The signature of the channel initiator (funder) on the funding transaction
+ pub signature: Signature,
}
/// A funding_signed message to be sent or received from a peer
#[derive(Clone)]
pub struct FundingSigned {
- pub(crate) channel_id: [u8; 32],
- pub(crate) signature: Signature,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The signature of the channel acceptor (fundee) on the funding transaction
+ pub signature: Signature,
}
/// A funding_locked message to be sent or received from a peer
#[derive(Clone, PartialEq)]
-#[allow(missing_docs)]
pub struct FundingLocked {
+ /// The channel ID
pub channel_id: [u8; 32],
+ /// The per-commitment point of the second commitment transaction
pub next_per_commitment_point: PublicKey,
}
/// A shutdown message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct Shutdown {
- pub(crate) channel_id: [u8; 32],
- pub(crate) scriptpubkey: Script,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The destination of this peer's funds on closing.
+ /// Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
+ pub scriptpubkey: Script,
}
/// A closing_signed message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct ClosingSigned {
- pub(crate) channel_id: [u8; 32],
- pub(crate) fee_satoshis: u64,
- pub(crate) signature: Signature,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The proposed total fee for the closing transaction
+ pub fee_satoshis: u64,
+ /// A signature on the closing transaction
+ pub signature: Signature,
}
/// An update_add_htlc message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct UpdateAddHTLC {
- 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,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The HTLC ID
+ pub htlc_id: u64,
+ /// The HTLC value in milli-satoshi
+ pub amount_msat: u64,
+ /// The payment hash, the pre-image of which controls HTLC redemption
+ pub payment_hash: PaymentHash,
+ /// The expiry height of the HTLC
+ pub cltv_expiry: u32,
pub(crate) onion_routing_packet: OnionPacket,
}
/// An update_fulfill_htlc message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct UpdateFulfillHTLC {
- pub(crate) channel_id: [u8; 32],
- pub(crate) htlc_id: u64,
- pub(crate) payment_preimage: PaymentPreimage,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The HTLC ID
+ pub htlc_id: u64,
+ /// The pre-image of the payment hash, allowing HTLC redemption
+ pub payment_preimage: PaymentPreimage,
}
/// An update_fail_htlc message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct UpdateFailHTLC {
- pub(crate) channel_id: [u8; 32],
- pub(crate) htlc_id: u64,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The HTLC ID
+ pub htlc_id: u64,
pub(crate) reason: OnionErrorPacket,
}
/// An update_fail_malformed_htlc message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct UpdateFailMalformedHTLC {
- pub(crate) channel_id: [u8; 32],
- pub(crate) htlc_id: u64,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The HTLC ID
+ pub htlc_id: u64,
pub(crate) sha256_of_onion: [u8; 32],
- pub(crate) failure_code: u16,
+ /// The failure code
+ pub failure_code: u16,
}
/// A commitment_signed message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct CommitmentSigned {
- pub(crate) channel_id: [u8; 32],
- pub(crate) signature: Signature,
- pub(crate) htlc_signatures: Vec<Signature>,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// A signature on the commitment transaction
+ pub signature: Signature,
+ /// Signatures on the HTLC transactions
+ pub htlc_signatures: Vec<Signature>,
}
/// A revoke_and_ack message to be sent or received from a peer
#[derive(Clone, PartialEq)]
pub struct RevokeAndACK {
- pub(crate) channel_id: [u8; 32],
- pub(crate) per_commitment_secret: [u8; 32],
- pub(crate) next_per_commitment_point: PublicKey,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The secret corresponding to the per-commitment point
+ pub per_commitment_secret: [u8; 32],
+ /// The next sender-broadcast commitment transaction's per-commitment point
+ pub next_per_commitment_point: PublicKey,
}
/// An update_fee message to be sent or received from a peer
#[derive(PartialEq, Clone)]
pub struct UpdateFee {
- pub(crate) channel_id: [u8; 32],
- pub(crate) feerate_per_kw: u32,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// Fee rate per 1000-weight of the transaction
+ pub feerate_per_kw: u32,
}
#[derive(PartialEq, Clone)]
-pub(crate) struct DataLossProtect {
- pub(crate) your_last_per_commitment_secret: [u8; 32],
- pub(crate) my_current_per_commitment_point: PublicKey,
+/// Proof that the sender knows the per-commitment secret of the previous commitment transaction.
+/// This is used to convince the recipient that the channel is at a certain commitment
+/// number even if they lost that data due to a local failure. Of course, the peer may lie
+/// and even later commitments may have been revoked.
+pub struct DataLossProtect {
+ /// Proof that the sender knows the per-commitment secret of a specific commitment transaction
+ /// belonging to the recipient
+ pub your_last_per_commitment_secret: [u8; 32],
+ /// The sender's per-commitment point for their current commitment transaction
+ pub 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(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>,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The next commitment number for the sender
+ pub next_local_commitment_number: u64,
+ /// The next commitment number for the recipient
+ pub next_remote_commitment_number: u64,
+ /// Optionally, a field proving that next_remote_commitment_number-1 has been revoked
+ pub data_loss_protect: OptionalField<DataLossProtect>,
}
/// An announcement_signatures message to be sent or received from a peer
#[derive(PartialEq, Clone, Debug)]
pub struct AnnouncementSignatures {
- pub(crate) channel_id: [u8; 32],
- pub(crate) short_channel_id: u64,
- pub(crate) node_signature: Signature,
- pub(crate) bitcoin_signature: Signature,
+ /// The channel ID
+ pub channel_id: [u8; 32],
+ /// The short channel ID
+ pub short_channel_id: u64,
+ /// A signature by the node key
+ pub node_signature: Signature,
+ /// A signature by the funding key
+ pub bitcoin_signature: Signature,
}
/// An address which can be used to connect to a remote peer
}
}
-// 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(crate) features: NodeFeatures,
- pub(crate) timestamp: u32,
+ /// The advertised features
+ pub features: NodeFeatures,
+ /// A strictly monotonic announcement counter, with gaps allowed
+ pub 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(crate) addresses: Vec<NetAddress>,
+ pub node_id: PublicKey,
+ /// An RGB color for UI purposes
+ pub rgb: [u8; 3],
+ /// An alias, for UI purposes. This should be sanitized before use. There is no guarantee
+ /// of uniqueness.
+ pub alias: [u8; 32],
+ /// List of addresses on which this node is reachable
+ pub addresses: Vec<NetAddress>,
pub(crate) excess_address_data: Vec<u8>,
pub(crate) excess_data: Vec<u8>,
}
-#[derive(PartialEq, Clone)]
+#[derive(PartialEq, Clone, Debug)]
/// A node_announcement message to be sent or received from a peer
pub struct NodeAnnouncement {
- pub(crate) signature: Signature,
- pub(crate) contents: UnsignedNodeAnnouncement,
+ /// The signature by the node key
+ pub signature: Signature,
+ /// The actual content of the announcement
+ pub contents: UnsignedNodeAnnouncement,
}
-// 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(crate) features: ChannelFeatures,
- pub(crate) chain_hash: BlockHash,
- pub(crate) short_channel_id: u64,
+ /// The advertised channel features
+ pub features: ChannelFeatures,
+ /// The genesis hash of the blockchain where the channel is to be opened
+ pub chain_hash: BlockHash,
+ /// The short channel ID
+ pub short_channel_id: u64,
/// One of the two node_ids which are endpoints of this channel
- pub node_id_1: PublicKey,
+ 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 node_id_2: PublicKey,
+ /// The funding key for the first node
+ pub bitcoin_key_1: PublicKey,
+ /// The funding key for the second node
+ pub 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(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,
-}
-
+ /// Authentication of the announcement by the first public node
+ pub node_signature_1: Signature,
+ /// Authentication of the announcement by the second public node
+ pub node_signature_2: Signature,
+ /// Proof of funding UTXO ownership by the first public node
+ pub bitcoin_signature_1: Signature,
+ /// Proof of funding UTXO ownership by the second public node
+ pub bitcoin_signature_2: Signature,
+ /// The actual announcement
+ pub contents: UnsignedChannelAnnouncement,
+}
+
+/// The unsigned part of a channel_update
#[derive(PartialEq, Clone, Debug)]
-pub(crate) struct UnsignedChannelUpdate {
- pub(crate) chain_hash: BlockHash,
- 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 struct UnsignedChannelUpdate {
+ /// The genesis hash of the blockchain where the channel is to be opened
+ pub chain_hash: BlockHash,
+ /// The short channel ID
+ pub short_channel_id: u64,
+ /// A strictly monotonic announcement counter, with gaps allowed, specific to this channel
+ pub timestamp: u32,
+ /// Channel flags
+ pub flags: u8,
+ /// The number of blocks to subtract from incoming HTLC cltv_expiry values
+ pub cltv_expiry_delta: u16,
+ /// The minimum HTLC size incoming to sender, in milli-satoshi
+ pub htlc_minimum_msat: u64,
+ /// Optionally, the maximum HTLC value incoming to sender, in milli-satoshi
+ pub htlc_maximum_msat: OptionalField<u64>,
+ /// The base HTLC fee charged by sender, in milli-satoshi
+ pub fee_base_msat: u32,
+ /// The amount to fee multiplier, in micro-satoshi
+ pub 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(crate) signature: Signature,
- pub(crate) contents: UnsignedChannelUpdate,
+ /// A signature of the channel update
+ pub signature: Signature,
+ /// The actual channel update
+ pub contents: UnsignedChannelUpdate,
}
/// Used to put an error message in a LightningError
/// An Err type for failure to process messages.
pub struct LightningError {
/// A human-readable message describing the error
- pub err: &'static str,
+ pub err: String,
/// The action which should be taken against the offending peer.
pub action: ErrorAction,
}
/// 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)]
+#[derive(Clone, PartialEq, Debug)]
pub enum OptionalField<T> {
/// Optional field is included in message
Present(T),
impl fmt::Debug for LightningError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- f.write_str(self.err)
+ f.write_str(self.err.as_str())
}
}
}
}
+impl Writeable for OptionalField<u64> {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+ match *self {
+ OptionalField::Present(ref value) => {
+ value.write(w)?;
+ },
+ OptionalField::Absent => {}
+ }
+ Ok(())
+ }
+}
+
+impl Readable for OptionalField<u64> {
+ fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
+ let value: u64 = Readable::read(r)?;
+ Ok(OptionalField::Present(value))
+ }
+}
+
+
impl_writeable_len_match!(AcceptChannel, {
{AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
{_, 270}
impl Writeable for UnsignedChannelUpdate {
fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
- w.size_hint(64 + self.excess_data.len());
+ let mut size = 64 + self.excess_data.len();
+ let mut message_flags: u8 = 0;
+ if let OptionalField::Present(_) = self.htlc_maximum_msat {
+ size += 8;
+ message_flags = 1;
+ }
+ w.size_hint(size);
self.chain_hash.write(w)?;
self.short_channel_id.write(w)?;
self.timestamp.write(w)?;
- self.flags.write(w)?;
+ let all_flags = self.flags as u16 | ((message_flags as u16) << 8);
+ all_flags.write(w)?;
self.cltv_expiry_delta.write(w)?;
self.htlc_minimum_msat.write(w)?;
self.fee_base_msat.write(w)?;
self.fee_proportional_millionths.write(w)?;
+ self.htlc_maximum_msat.write(w)?;
w.write_all(&self.excess_data[..])?;
Ok(())
}
impl Readable for UnsignedChannelUpdate {
fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
+ let has_htlc_maximum_msat;
Ok(Self {
chain_hash: Readable::read(r)?,
short_channel_id: Readable::read(r)?,
timestamp: Readable::read(r)?,
- flags: Readable::read(r)?,
+ flags: {
+ let flags: u16 = Readable::read(r)?;
+ let message_flags = flags >> 8;
+ has_htlc_maximum_msat = (message_flags as i32 & 1) == 1;
+ flags as u8
+ },
cltv_expiry_delta: Readable::read(r)?,
htlc_minimum_msat: Readable::read(r)?,
fee_base_msat: Readable::read(r)?,
fee_proportional_millionths: Readable::read(r)?,
+ htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
excess_data: {
let mut excess_data = vec![];
r.read_to_end(&mut excess_data)?;
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) {
+ fn do_encoding_channel_announcement(unknown_features_bits: 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 unsigned_channel_announcement = msgs::UnsignedChannelAnnouncement {
features,
- chain_hash: if !non_bitcoin_chain_hash { BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { BlockHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
short_channel_id: 2316138423780173,
node_id_1: pubkey_1,
node_id_2: pubkey_2,
} 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("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
target_value.append(&mut hex::decode("00083a840000034d031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b").unwrap());
if excess_data {
target_value.append(&mut hex::decode("0a00001400001e000028").unwrap());
#[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);
+ do_encoding_channel_announcement(true, false);
+ do_encoding_channel_announcement(false, true);
+ do_encoding_channel_announcement(false, false);
+ do_encoding_channel_announcement(true, 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) {
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) {
+ fn do_encoding_channel_update(direction: bool, disable: bool, htlc_maximum_msat: bool, excess_data: 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 { BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { BlockHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").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 },
+ flags: if direction { 1 } else { 0 } | if disable { 1 << 1 } else { 0 },
cltv_expiry_delta: 144,
htlc_minimum_msat: 1000000,
+ htlc_maximum_msat: if htlc_maximum_msat { OptionalField::Present(131355275467161) } else { OptionalField::Absent },
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() }
+ excess_data: if excess_data { vec![0, 0, 0, 0, 59, 154, 202, 0] } else { Vec::new() }
};
let channel_update = msgs::ChannelUpdate {
signature: sig_1,
};
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("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
target_value.append(&mut hex::decode("00083a840000034d013413a7").unwrap());
if htlc_maximum_msat {
target_value.append(&mut hex::decode("01").unwrap());
}
target_value.append(&mut hex::decode("009000000000000f42400000271000000014").unwrap());
if htlc_maximum_msat {
+ target_value.append(&mut hex::decode("0000777788889999").unwrap());
+ }
+ if excess_data {
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(false, false, false, true);
do_encoding_channel_update(true, false, false, false);
+ do_encoding_channel_update(true, false, false, true);
do_encoding_channel_update(false, true, false, false);
+ do_encoding_channel_update(false, true, false, true);
do_encoding_channel_update(false, false, true, false);
- do_encoding_channel_update(false, false, false, true);
+ do_encoding_channel_update(false, false, true, true);
+ do_encoding_channel_update(true, true, true, false);
do_encoding_channel_update(true, true, true, true);
}
- fn do_encoding_open_channel(non_bitcoin_chain_hash: bool, random_bit: bool, shutdown: bool) {
+ fn do_encoding_open_channel(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_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 { BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap() } else { BlockHash::from_hex("000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943").unwrap() },
+ chain_hash: BlockHash::from_hex("6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000").unwrap(),
temporary_channel_id: [2; 32],
funding_satoshis: 1311768467284833366,
push_msat: 2536655962884945560,
};
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("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap());
target_value.append(&mut hex::decode("02020202020202020202020202020202020202020202020202020202020202021234567890123456233403289122369832144668701144767633030896203198784335490624111800083a840000034d000c89d4c0bcc0bc031b84c5567b126440995d3ed5aaba0565d71e1834604819ff9c17f5e9d5dd078f024d4b6cd1361032ca9bd2aeb9d900aa4d45d9ead80ac9423374c451a7254d076602531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe33703462779ad4aad39514614751a71085f2f10e1c7a593e4e030efb5b8721ce55b0b0362c0a046dacce86ddd0343c6d3c7c79c2208ba0d9c9cf24a6d046d21d21f90f703f006a18d5653c4edf5391ff23a61f03ff83d237e880ee61187fa9f379a028e0a").unwrap());
if random_bit {
target_value.append(&mut hex::decode("20").unwrap());
#[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);
+ do_encoding_open_channel(false, false);
+ do_encoding_open_channel(true, false);
+ do_encoding_open_channel(false, true);
+ do_encoding_open_channel(true, true);
}
fn do_encoding_accept_channel(shutdown: bool) {
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() },
+ 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).unwrap().script_pubkey() }
+ else { Address::p2wsh(&script, Network::Testnet).script_pubkey() },
};
let encoded_value = shutdown.encode();
let mut target_value = hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap();
projects / rust-lightning / blobdiff