X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fblinded_path%2Fpayment.rs;h=39f16a91692cb30fb1be087191b4c32a506de830;hb=24db35eeea7049a3abde9766baf8dda69b462c3f;hp=8caf8443eee81888401d42856da1a1bbe2a26319;hpb=aee7bb4acde387983c428fddcfc5b1a173cdcee7;p=rust-lightning diff --git a/lightning/src/blinded_path/payment.rs b/lightning/src/blinded_path/payment.rs index 8caf8443..39f16a91 100644 --- a/lightning/src/blinded_path/payment.rs +++ b/lightning/src/blinded_path/payment.rs @@ -16,7 +16,20 @@ use crate::util::ser::{Readable, Writeable, Writer}; use core::convert::TryFrom; +/// An intermediate node, its outbound channel, and relay parameters. +#[derive(Clone, Debug)] +pub struct ForwardNode { + /// The TLVs for this node's [`BlindedHop`], where the fee parameters contained within are also + /// used for [`BlindedPayInfo`] construction. + pub tlvs: ForwardTlvs, + /// This node's pubkey. + pub node_id: PublicKey, + /// The maximum value, in msat, that may be accepted by this node. + pub htlc_maximum_msat: u64, +} + /// Data to construct a [`BlindedHop`] for forwarding a payment. +#[derive(Clone, Debug)] pub struct ForwardTlvs { /// The short channel id this payment should be forwarded out over. pub short_channel_id: u64, @@ -33,6 +46,7 @@ pub struct ForwardTlvs { /// Data to construct a [`BlindedHop`] for receiving a payment. This payload is custom to LDK and /// may not be valid if received by another lightning implementation. +#[derive(Clone, Debug)] pub struct ReceiveTlvs { /// Used to authenticate the sender of a payment to the receiver and tie MPP HTLCs together. pub payment_secret: PaymentSecret, @@ -59,47 +73,66 @@ enum BlindedPaymentTlvsRef<'a> { /// Parameters for relaying over a given [`BlindedHop`]. /// /// [`BlindedHop`]: crate::blinded_path::BlindedHop +#[derive(Clone, Debug)] pub struct PaymentRelay { /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for this [`BlindedHop`]. - /// - ///[`BlindedHop`]: crate::blinded_path::BlindedHop pub cltv_expiry_delta: u16, /// Liquidity fee charged (in millionths of the amount transferred) for relaying a payment over /// this [`BlindedHop`], (i.e., 10,000 is 1%). - /// - ///[`BlindedHop`]: crate::blinded_path::BlindedHop pub fee_proportional_millionths: u32, /// Base fee charged (in millisatoshi) for relaying a payment over this [`BlindedHop`]. - /// - ///[`BlindedHop`]: crate::blinded_path::BlindedHop pub fee_base_msat: u32, } /// Constraints for relaying over a given [`BlindedHop`]. /// /// [`BlindedHop`]: crate::blinded_path::BlindedHop +#[derive(Clone, Debug)] pub struct PaymentConstraints { /// The maximum total CLTV delta that is acceptable when relaying a payment over this /// [`BlindedHop`]. - /// - ///[`BlindedHop`]: crate::blinded_path::BlindedHop pub max_cltv_expiry: u32, /// The minimum value, in msat, that may be accepted by the node corresponding to this /// [`BlindedHop`]. pub htlc_minimum_msat: u64, } -impl_writeable_tlv_based!(ForwardTlvs, { - (2, short_channel_id, required), - (10, payment_relay, required), - (12, payment_constraints, required), - (14, features, required), -}); +impl Writeable for ForwardTlvs { + fn write(&self, w: &mut W) -> Result<(), io::Error> { + encode_tlv_stream!(w, { + (2, self.short_channel_id, required), + (10, self.payment_relay, required), + (12, self.payment_constraints, required), + (14, self.features, required) + }); + Ok(()) + } +} -impl_writeable_tlv_based!(ReceiveTlvs, { - (12, payment_constraints, required), - (65536, payment_secret, required), -}); +impl Writeable for ReceiveTlvs { + fn write(&self, w: &mut W) -> Result<(), io::Error> { + encode_tlv_stream!(w, { + (12, self.payment_constraints, required), + (65536, self.payment_secret, required) + }); + Ok(()) + } +} + +// This will be removed once we support forwarding blinded HTLCs, because we'll always read a +// `BlindedPaymentTlvs` instead. +impl Readable for ReceiveTlvs { + fn read(r: &mut R) -> Result { + _init_and_read_tlv_stream!(r, { + (12, payment_constraints, required), + (65536, payment_secret, required), + }); + Ok(Self { + payment_secret: payment_secret.0.unwrap(), + payment_constraints: payment_constraints.0.unwrap() + }) + } +} impl<'a> Writeable for BlindedPaymentTlvsRef<'a> { fn write(&self, w: &mut W) -> Result<(), io::Error> { @@ -144,12 +177,12 @@ impl Readable for BlindedPaymentTlvs { /// Construct blinded payment hops for the given `intermediate_nodes` and payee info. pub(super) fn blinded_hops( - secp_ctx: &Secp256k1, intermediate_nodes: &[(PublicKey, ForwardTlvs, u64)], + secp_ctx: &Secp256k1, intermediate_nodes: &[ForwardNode], payee_node_id: PublicKey, payee_tlvs: ReceiveTlvs, session_priv: &SecretKey ) -> Result, secp256k1::Error> { - let pks = intermediate_nodes.iter().map(|(pk, _, _)| pk) + let pks = intermediate_nodes.iter().map(|node| &node.node_id) .chain(core::iter::once(&payee_node_id)); - let tlvs = intermediate_nodes.iter().map(|(_, tlvs, _)| BlindedPaymentTlvsRef::Forward(tlvs)) + let tlvs = intermediate_nodes.iter().map(|node| BlindedPaymentTlvsRef::Forward(&node.tlvs)) .chain(core::iter::once(BlindedPaymentTlvsRef::Receive(&payee_tlvs))); utils::construct_blinded_hops(secp_ctx, pks, tlvs, session_priv) } @@ -176,13 +209,12 @@ fn amt_to_forward_msat(inbound_amt_msat: u64, payment_relay: &PaymentRelay) -> O } pub(super) fn compute_payinfo( - intermediate_nodes: &[(PublicKey, ForwardTlvs, u64)], payee_tlvs: &ReceiveTlvs, - payee_htlc_maximum_msat: u64 + intermediate_nodes: &[ForwardNode], payee_tlvs: &ReceiveTlvs, payee_htlc_maximum_msat: u64 ) -> Result { let mut curr_base_fee: u64 = 0; let mut curr_prop_mil: u64 = 0; let mut cltv_expiry_delta: u16 = 0; - for (_, tlvs, _) in intermediate_nodes.iter().rev() { + for tlvs in intermediate_nodes.iter().rev().map(|n| &n.tlvs) { // In the future, we'll want to take the intersection of all supported features for the // `BlindedPayInfo`, but there are no features in that context right now. if tlvs.features.requires_unknown_bits_from(&BlindedHopFeatures::empty()) { return Err(()) } @@ -209,16 +241,16 @@ pub(super) fn compute_payinfo( let mut htlc_minimum_msat: u64 = 1; let mut htlc_maximum_msat: u64 = 21_000_000 * 100_000_000 * 1_000; // Total bitcoin supply - for (_, tlvs, max_htlc_candidate) in intermediate_nodes.iter() { + for node in intermediate_nodes.iter() { // The min htlc for an intermediate node is that node's min minus the fees charged by all of the // following hops for forwarding that min, since that fee amount will automatically be included // in the amount that this node receives and contribute towards reaching its min. htlc_minimum_msat = amt_to_forward_msat( - core::cmp::max(tlvs.payment_constraints.htlc_minimum_msat, htlc_minimum_msat), - &tlvs.payment_relay + core::cmp::max(node.tlvs.payment_constraints.htlc_minimum_msat, htlc_minimum_msat), + &node.tlvs.payment_relay ).unwrap_or(1); // If underflow occurs, we definitely reached this node's min htlc_maximum_msat = amt_to_forward_msat( - core::cmp::min(*max_htlc_candidate, htlc_maximum_msat), &tlvs.payment_relay + core::cmp::min(node.htlc_maximum_msat, htlc_maximum_msat), &node.tlvs.payment_relay ).ok_or(())?; // If underflow occurs, we cannot send to this hop without exceeding their max } htlc_minimum_msat = core::cmp::max( @@ -251,7 +283,7 @@ impl_writeable_msg!(PaymentConstraints, { #[cfg(test)] mod tests { use bitcoin::secp256k1::PublicKey; - use crate::blinded_path::payment::{ForwardTlvs, ReceiveTlvs, PaymentConstraints, PaymentRelay}; + use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, ReceiveTlvs, PaymentConstraints, PaymentRelay}; use crate::ln::PaymentSecret; use crate::ln::features::BlindedHopFeatures; @@ -260,31 +292,39 @@ mod tests { // Taken from the spec example for aggregating blinded payment info. See // https://github.com/lightning/bolts/blob/master/proposals/route-blinding.md#blinded-payments let dummy_pk = PublicKey::from_slice(&[2; 33]).unwrap(); - let intermediate_nodes = vec![(dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 144, - fee_proportional_millionths: 500, - fee_base_msat: 100, - }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 100, - }, - features: BlindedHopFeatures::empty(), - }, u64::max_value()), (dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 144, - fee_proportional_millionths: 500, - fee_base_msat: 100, + let intermediate_nodes = vec![ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 144, + fee_proportional_millionths: 500, + fee_base_msat: 100, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 100, + }, + features: BlindedHopFeatures::empty(), }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 1_000, + htlc_maximum_msat: u64::max_value(), + }, ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 144, + fee_proportional_millionths: 500, + fee_base_msat: 100, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 1_000, + }, + features: BlindedHopFeatures::empty(), }, - features: BlindedHopFeatures::empty(), - }, u64::max_value())]; + htlc_maximum_msat: u64::max_value(), + }]; let recv_tlvs = ReceiveTlvs { payment_secret: PaymentSecret([0; 32]), payment_constraints: PaymentConstraints { @@ -323,31 +363,39 @@ mod tests { // If no hops charge fees, the htlc_minimum_msat should just be the maximum htlc_minimum_msat // along the path. let dummy_pk = PublicKey::from_slice(&[2; 33]).unwrap(); - let intermediate_nodes = vec![(dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 0, - fee_base_msat: 0, + let intermediate_nodes = vec![ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 0, + fee_base_msat: 0, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 1, + }, + features: BlindedHopFeatures::empty(), }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 1, + htlc_maximum_msat: u64::max_value() + }, ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 0, + fee_base_msat: 0, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 2_000, + }, + features: BlindedHopFeatures::empty(), }, - features: BlindedHopFeatures::empty(), - }, u64::max_value()), (dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 0, - fee_base_msat: 0, - }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 2_000, - }, - features: BlindedHopFeatures::empty(), - }, u64::max_value())]; + htlc_maximum_msat: u64::max_value() + }]; let recv_tlvs = ReceiveTlvs { payment_secret: PaymentSecret([0; 32]), payment_constraints: PaymentConstraints { @@ -365,31 +413,39 @@ mod tests { // Create a path with varying fees and htlc_mins, and make sure htlc_minimum_msat ends up as the // max (htlc_min - following_fees) along the path. let dummy_pk = PublicKey::from_slice(&[2; 33]).unwrap(); - let intermediate_nodes = vec![(dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 500, - fee_base_msat: 1_000, + let intermediate_nodes = vec![ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 500, + fee_base_msat: 1_000, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 5_000, + }, + features: BlindedHopFeatures::empty(), }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 5_000, + htlc_maximum_msat: u64::max_value() + }, ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 500, + fee_base_msat: 200, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 2_000, + }, + features: BlindedHopFeatures::empty(), }, - features: BlindedHopFeatures::empty(), - }, u64::max_value()), (dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 500, - fee_base_msat: 200, - }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 2_000, - }, - features: BlindedHopFeatures::empty(), - }, u64::max_value())]; + htlc_maximum_msat: u64::max_value() + }]; let recv_tlvs = ReceiveTlvs { payment_secret: PaymentSecret([0; 32]), payment_constraints: PaymentConstraints { @@ -411,31 +467,39 @@ mod tests { // Create a path with varying fees and `htlc_maximum_msat`s, and make sure the aggregated max // htlc ends up as the min (htlc_max - following_fees) along the path. let dummy_pk = PublicKey::from_slice(&[2; 33]).unwrap(); - let intermediate_nodes = vec![(dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 500, - fee_base_msat: 1_000, - }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 1, - }, - features: BlindedHopFeatures::empty(), - }, 5_000), (dummy_pk, ForwardTlvs { - short_channel_id: 0, - payment_relay: PaymentRelay { - cltv_expiry_delta: 0, - fee_proportional_millionths: 500, - fee_base_msat: 1, + let intermediate_nodes = vec![ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 500, + fee_base_msat: 1_000, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 1, + }, + features: BlindedHopFeatures::empty(), }, - payment_constraints: PaymentConstraints { - max_cltv_expiry: 0, - htlc_minimum_msat: 1, + htlc_maximum_msat: 5_000, + }, ForwardNode { + node_id: dummy_pk, + tlvs: ForwardTlvs { + short_channel_id: 0, + payment_relay: PaymentRelay { + cltv_expiry_delta: 0, + fee_proportional_millionths: 500, + fee_base_msat: 1, + }, + payment_constraints: PaymentConstraints { + max_cltv_expiry: 0, + htlc_minimum_msat: 1, + }, + features: BlindedHopFeatures::empty(), }, - features: BlindedHopFeatures::empty(), - }, 10_000)]; + htlc_maximum_msat: 10_000 + }]; let recv_tlvs = ReceiveTlvs { payment_secret: PaymentSecret([0; 32]), payment_constraints: PaymentConstraints {