+/// `None` if underflow occurs.
+pub(crate) fn amt_to_forward_msat(inbound_amt_msat: u64, payment_relay: &PaymentRelay) -> Option<u64> {
+ let inbound_amt = inbound_amt_msat as u128;
+ let base = payment_relay.fee_base_msat as u128;
+ let prop = payment_relay.fee_proportional_millionths as u128;
+
+ let post_base_fee_inbound_amt =
+ if let Some(amt) = inbound_amt.checked_sub(base) { amt } else { return None };
+ let mut amt_to_forward =
+ (post_base_fee_inbound_amt * 1_000_000 + 1_000_000 + prop - 1) / (prop + 1_000_000);
+
+ let fee = ((amt_to_forward * prop) / 1_000_000) + base;
+ if inbound_amt - fee < amt_to_forward {
+ // Rounding up the forwarded amount resulted in underpaying this node, so take an extra 1 msat
+ // in fee to compensate.
+ amt_to_forward -= 1;
+ }
+ debug_assert_eq!(amt_to_forward + fee, inbound_amt);
+ u64::try_from(amt_to_forward).ok()
+}
+
+pub(super) fn compute_payinfo(
+ intermediate_nodes: &[ForwardNode], payee_tlvs: &ReceiveTlvs, payee_htlc_maximum_msat: u64,
+ min_final_cltv_expiry_delta: u16
+) -> Result<BlindedPayInfo, ()> {
+ let mut curr_base_fee: u64 = 0;
+ let mut curr_prop_mil: u64 = 0;
+ let mut cltv_expiry_delta: u16 = min_final_cltv_expiry_delta;
+ 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(()) }
+
+ let next_base_fee = tlvs.payment_relay.fee_base_msat as u64;
+ let next_prop_mil = tlvs.payment_relay.fee_proportional_millionths as u64;
+ // Use integer arithmetic to compute `ceil(a/b)` as `(a+b-1)/b`
+ // ((curr_base_fee * (1_000_000 + next_prop_mil)) / 1_000_000) + next_base_fee
+ curr_base_fee = curr_base_fee.checked_mul(1_000_000 + next_prop_mil)
+ .and_then(|f| f.checked_add(1_000_000 - 1))
+ .map(|f| f / 1_000_000)
+ .and_then(|f| f.checked_add(next_base_fee))
+ .ok_or(())?;
+ // ceil(((curr_prop_mil + 1_000_000) * (next_prop_mil + 1_000_000)) / 1_000_000) - 1_000_000
+ curr_prop_mil = curr_prop_mil.checked_add(1_000_000)
+ .and_then(|f1| next_prop_mil.checked_add(1_000_000).and_then(|f2| f2.checked_mul(f1)))
+ .and_then(|f| f.checked_add(1_000_000 - 1))
+ .map(|f| f / 1_000_000)
+ .and_then(|f| f.checked_sub(1_000_000))
+ .ok_or(())?;
+
+ cltv_expiry_delta = cltv_expiry_delta.checked_add(tlvs.payment_relay.cltv_expiry_delta).ok_or(())?;
+ }
+
+ 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 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(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(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(
+ payee_tlvs.payment_constraints.htlc_minimum_msat, htlc_minimum_msat
+ );
+ htlc_maximum_msat = core::cmp::min(payee_htlc_maximum_msat, htlc_maximum_msat);
+
+ if htlc_maximum_msat < htlc_minimum_msat { return Err(()) }
+ Ok(BlindedPayInfo {
+ fee_base_msat: u32::try_from(curr_base_fee).map_err(|_| ())?,
+ fee_proportional_millionths: u32::try_from(curr_prop_mil).map_err(|_| ())?,
+ cltv_expiry_delta,
+ htlc_minimum_msat,
+ htlc_maximum_msat,
+ features: BlindedHopFeatures::empty(),
+ })
+}
+
+impl Writeable for PaymentRelay {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
+ self.cltv_expiry_delta.write(w)?;
+ self.fee_proportional_millionths.write(w)?;
+ HighZeroBytesDroppedBigSize(self.fee_base_msat).write(w)
+ }
+}
+impl Readable for PaymentRelay {
+ fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
+ let cltv_expiry_delta: u16 = Readable::read(r)?;
+ let fee_proportional_millionths: u32 = Readable::read(r)?;
+ let fee_base_msat: HighZeroBytesDroppedBigSize<u32> = Readable::read(r)?;
+ Ok(Self { cltv_expiry_delta, fee_proportional_millionths, fee_base_msat: fee_base_msat.0 })
+ }
+}
+
+impl Writeable for PaymentConstraints {
+ fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
+ self.max_cltv_expiry.write(w)?;
+ HighZeroBytesDroppedBigSize(self.htlc_minimum_msat).write(w)
+ }
+}
+impl Readable for PaymentConstraints {
+ fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
+ let max_cltv_expiry: u32 = Readable::read(r)?;
+ let htlc_minimum_msat: HighZeroBytesDroppedBigSize<u64> = Readable::read(r)?;
+ Ok(Self { max_cltv_expiry, htlc_minimum_msat: htlc_minimum_msat.0 })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use bitcoin::secp256k1::PublicKey;
+ use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, ReceiveTlvs, PaymentConstraints, PaymentRelay};
+ use crate::ln::PaymentSecret;
+ use crate::ln::features::BlindedHopFeatures;
+ use crate::ln::functional_test_utils::TEST_FINAL_CLTV;
+
+ #[test]
+ fn compute_payinfo() {
+ // 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![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(),
+ },
+ 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(),
+ },
+ htlc_maximum_msat: u64::max_value(),
+ }];
+ let recv_tlvs = ReceiveTlvs {
+ payment_secret: PaymentSecret([0; 32]),
+ payment_constraints: PaymentConstraints {
+ max_cltv_expiry: 0,
+ htlc_minimum_msat: 1,
+ },
+ };
+ let htlc_maximum_msat = 100_000;
+ let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_maximum_msat, 12).unwrap();
+ assert_eq!(blinded_payinfo.fee_base_msat, 201);
+ assert_eq!(blinded_payinfo.fee_proportional_millionths, 1001);
+ assert_eq!(blinded_payinfo.cltv_expiry_delta, 300);
+ assert_eq!(blinded_payinfo.htlc_minimum_msat, 900);
+ assert_eq!(blinded_payinfo.htlc_maximum_msat, htlc_maximum_msat);
+ }
+
+ #[test]
+ fn compute_payinfo_1_hop() {
+ let recv_tlvs = ReceiveTlvs {
+ payment_secret: PaymentSecret([0; 32]),
+ payment_constraints: PaymentConstraints {
+ max_cltv_expiry: 0,
+ htlc_minimum_msat: 1,
+ },
+ };
+ let blinded_payinfo = super::compute_payinfo(&[], &recv_tlvs, 4242, TEST_FINAL_CLTV as u16).unwrap();
+ assert_eq!(blinded_payinfo.fee_base_msat, 0);
+ assert_eq!(blinded_payinfo.fee_proportional_millionths, 0);
+ assert_eq!(blinded_payinfo.cltv_expiry_delta, TEST_FINAL_CLTV as u16);
+ assert_eq!(blinded_payinfo.htlc_minimum_msat, 1);
+ assert_eq!(blinded_payinfo.htlc_maximum_msat, 4242);
+ }
+
+ #[test]
+ fn simple_aggregated_htlc_min() {
+ // 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![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(),
+ },
+ 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(),
+ },
+ htlc_maximum_msat: u64::max_value()
+ }];
+ let recv_tlvs = ReceiveTlvs {
+ payment_secret: PaymentSecret([0; 32]),
+ payment_constraints: PaymentConstraints {
+ max_cltv_expiry: 0,
+ htlc_minimum_msat: 3,
+ },
+ };
+ let htlc_maximum_msat = 100_000;
+ let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_maximum_msat, TEST_FINAL_CLTV as u16).unwrap();
+ assert_eq!(blinded_payinfo.htlc_minimum_msat, 2_000);
+ }
+
+ #[test]
+ fn aggregated_htlc_min() {
+ // 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![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(),
+ },
+ 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(),
+ },
+ htlc_maximum_msat: u64::max_value()
+ }];
+ let recv_tlvs = ReceiveTlvs {
+ payment_secret: PaymentSecret([0; 32]),
+ payment_constraints: PaymentConstraints {
+ max_cltv_expiry: 0,
+ htlc_minimum_msat: 1,
+ },
+ };
+ let htlc_minimum_msat = 3798;
+ assert!(super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_minimum_msat - 1, TEST_FINAL_CLTV as u16).is_err());
+
+ let htlc_maximum_msat = htlc_minimum_msat + 1;
+ let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_maximum_msat, TEST_FINAL_CLTV as u16).unwrap();
+ assert_eq!(blinded_payinfo.htlc_minimum_msat, htlc_minimum_msat);
+ assert_eq!(blinded_payinfo.htlc_maximum_msat, htlc_maximum_msat);
+ }
+
+ #[test]
+ fn aggregated_htlc_max() {
+ // 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![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(),
+ },
+ 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(),
+ },
+ htlc_maximum_msat: 10_000
+ }];
+ let recv_tlvs = ReceiveTlvs {
+ payment_secret: PaymentSecret([0; 32]),
+ payment_constraints: PaymentConstraints {
+ max_cltv_expiry: 0,
+ htlc_minimum_msat: 1,
+ },
+ };