//! imply it needs to fail HTLCs/payments/channels it manages).
//!
-use bitcoin::blockdata::block::{Block, BlockHeader};
+use bitcoin::blockdata::block::BlockHeader;
use bitcoin::blockdata::transaction::Transaction;
use bitcoin::blockdata::constants::genesis_block;
use bitcoin::network::constants::Network;
use chain::transaction::{OutPoint, TransactionData};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
-use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
+use ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
use ln::features::{ChannelTypeFeatures, InitFeatures, NodeFeatures};
use routing::router::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
use std::time::Instant;
use util::crypto::sign;
-mod inbound_payment {
- use alloc::string::ToString;
- use bitcoin::hashes::{Hash, HashEngine};
- use bitcoin::hashes::cmp::fixed_time_eq;
- use bitcoin::hashes::hmac::{Hmac, HmacEngine};
- use bitcoin::hashes::sha256::Hash as Sha256;
- use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
- use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
- use ln::channelmanager::APIError;
- use ln::msgs;
- use ln::msgs::MAX_VALUE_MSAT;
- use util::chacha20::ChaCha20;
- use util::crypto::hkdf_extract_expand_thrice;
- use util::logger::Logger;
-
- use core::convert::TryInto;
- use core::ops::Deref;
-
- const IV_LEN: usize = 16;
- const METADATA_LEN: usize = 16;
- const METADATA_KEY_LEN: usize = 32;
- const AMT_MSAT_LEN: usize = 8;
- // Used to shift the payment type bits to take up the top 3 bits of the metadata bytes, or to
- // retrieve said payment type bits.
- const METHOD_TYPE_OFFSET: usize = 5;
-
- /// A set of keys that were HKDF-expanded from an initial call to
- /// [`KeysInterface::get_inbound_payment_key_material`].
- ///
- /// [`KeysInterface::get_inbound_payment_key_material`]: crate::chain::keysinterface::KeysInterface::get_inbound_payment_key_material
- pub(super) struct ExpandedKey {
- /// The key used to encrypt the bytes containing the payment metadata (i.e. the amount and
- /// expiry, included for payment verification on decryption).
- metadata_key: [u8; 32],
- /// The key used to authenticate an LDK-provided payment hash and metadata as previously
- /// registered with LDK.
- ldk_pmt_hash_key: [u8; 32],
- /// The key used to authenticate a user-provided payment hash and metadata as previously
- /// registered with LDK.
- user_pmt_hash_key: [u8; 32],
- }
-
- impl ExpandedKey {
- pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
- let (metadata_key, ldk_pmt_hash_key, user_pmt_hash_key) =
- hkdf_extract_expand_thrice(b"LDK Inbound Payment Key Expansion", &key_material.0);
- Self {
- metadata_key,
- ldk_pmt_hash_key,
- user_pmt_hash_key,
- }
- }
- }
-
- enum Method {
- LdkPaymentHash = 0,
- UserPaymentHash = 1,
- }
-
- impl Method {
- fn from_bits(bits: u8) -> Result<Method, u8> {
- match bits {
- bits if bits == Method::LdkPaymentHash as u8 => Ok(Method::LdkPaymentHash),
- bits if bits == Method::UserPaymentHash as u8 => Ok(Method::UserPaymentHash),
- unknown => Err(unknown),
- }
- }
- }
-
- pub(super) fn create<Signer: Sign, K: Deref>(keys: &ExpandedKey, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, keys_manager: &K, highest_seen_timestamp: u64) -> Result<(PaymentHash, PaymentSecret), ()>
- where K::Target: KeysInterface<Signer = Signer>
- {
- let metadata_bytes = construct_metadata_bytes(min_value_msat, Method::LdkPaymentHash, invoice_expiry_delta_secs, highest_seen_timestamp)?;
-
- let mut iv_bytes = [0 as u8; IV_LEN];
- let rand_bytes = keys_manager.get_secure_random_bytes();
- iv_bytes.copy_from_slice(&rand_bytes[..IV_LEN]);
-
- let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
- hmac.input(&iv_bytes);
- hmac.input(&metadata_bytes);
- let payment_preimage_bytes = Hmac::from_engine(hmac).into_inner();
-
- let ldk_pmt_hash = PaymentHash(Sha256::hash(&payment_preimage_bytes).into_inner());
- let payment_secret = construct_payment_secret(&iv_bytes, &metadata_bytes, &keys.metadata_key);
- Ok((ldk_pmt_hash, payment_secret))
- }
-
- pub(super) fn create_from_hash(keys: &ExpandedKey, min_value_msat: Option<u64>, payment_hash: PaymentHash, invoice_expiry_delta_secs: u32, highest_seen_timestamp: u64) -> Result<PaymentSecret, ()> {
- let metadata_bytes = construct_metadata_bytes(min_value_msat, Method::UserPaymentHash, invoice_expiry_delta_secs, highest_seen_timestamp)?;
-
- let mut hmac = HmacEngine::<Sha256>::new(&keys.user_pmt_hash_key);
- hmac.input(&metadata_bytes);
- hmac.input(&payment_hash.0);
- let hmac_bytes = Hmac::from_engine(hmac).into_inner();
-
- let mut iv_bytes = [0 as u8; IV_LEN];
- iv_bytes.copy_from_slice(&hmac_bytes[..IV_LEN]);
-
- Ok(construct_payment_secret(&iv_bytes, &metadata_bytes, &keys.metadata_key))
- }
-
- fn construct_metadata_bytes(min_value_msat: Option<u64>, payment_type: Method, invoice_expiry_delta_secs: u32, highest_seen_timestamp: u64) -> Result<[u8; METADATA_LEN], ()> {
- if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
- return Err(());
- }
-
- let mut min_amt_msat_bytes: [u8; AMT_MSAT_LEN] = match min_value_msat {
- Some(amt) => amt.to_be_bytes(),
- None => [0; AMT_MSAT_LEN],
- };
- min_amt_msat_bytes[0] |= (payment_type as u8) << METHOD_TYPE_OFFSET;
-
- // We assume that highest_seen_timestamp is pretty close to the current time - it's updated when
- // we receive a new block with the maximum time we've seen in a header. It should never be more
- // than two hours in the future. Thus, we add two hours here as a buffer to ensure we
- // absolutely never fail a payment too early.
- // Note that we assume that received blocks have reasonably up-to-date timestamps.
- let expiry_bytes = (highest_seen_timestamp + invoice_expiry_delta_secs as u64 + 7200).to_be_bytes();
-
- let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
- metadata_bytes[..AMT_MSAT_LEN].copy_from_slice(&min_amt_msat_bytes);
- metadata_bytes[AMT_MSAT_LEN..].copy_from_slice(&expiry_bytes);
-
- Ok(metadata_bytes)
- }
-
- fn construct_payment_secret(iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], metadata_key: &[u8; METADATA_KEY_LEN]) -> PaymentSecret {
- let mut payment_secret_bytes: [u8; 32] = [0; 32];
- let (iv_slice, encrypted_metadata_slice) = payment_secret_bytes.split_at_mut(IV_LEN);
- iv_slice.copy_from_slice(iv_bytes);
-
- let chacha_block = ChaCha20::get_single_block(metadata_key, iv_bytes);
- for i in 0..METADATA_LEN {
- encrypted_metadata_slice[i] = chacha_block[i] ^ metadata_bytes[i];
- }
- PaymentSecret(payment_secret_bytes)
- }
-
- /// Check that an inbound payment's `payment_data` field is sane.
- ///
- /// LDK does not store any data for pending inbound payments. Instead, we construct our payment
- /// secret (and, if supplied by LDK, our payment preimage) to include encrypted metadata about the
- /// payment.
- ///
- /// The metadata is constructed as:
- /// payment method (3 bits) || payment amount (8 bytes - 3 bits) || expiry (8 bytes)
- /// and encrypted using a key derived from [`KeysInterface::get_inbound_payment_key_material`].
- ///
- /// Then on payment receipt, we verify in this method that the payment preimage and payment secret
- /// match what was constructed.
- ///
- /// [`create_inbound_payment`] and [`create_inbound_payment_for_hash`] are called by the user to
- /// construct the payment secret and/or payment hash that this method is verifying. If the former
- /// method is called, then the payment method bits mentioned above are represented internally as
- /// [`Method::LdkPaymentHash`]. If the latter, [`Method::UserPaymentHash`].
- ///
- /// For the former method, the payment preimage is constructed as an HMAC of payment metadata and
- /// random bytes. Because the payment secret is also encoded with these random bytes and metadata
- /// (with the metadata encrypted with a block cipher), we're able to authenticate the preimage on
- /// payment receipt.
- ///
- /// For the latter, the payment secret instead contains an HMAC of the user-provided payment hash
- /// and payment metadata (encrypted with a block cipher), allowing us to authenticate the payment
- /// hash and metadata on payment receipt.
- ///
- /// See [`ExpandedKey`] docs for more info on the individual keys used.
- ///
- /// [`KeysInterface::get_inbound_payment_key_material`]: crate::chain::keysinterface::KeysInterface::get_inbound_payment_key_material
- /// [`create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
- /// [`create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
- pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
- where L::Target: Logger
- {
- let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);
-
- let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
- let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
- amt_msat_bytes.copy_from_slice(&metadata_bytes[..AMT_MSAT_LEN]);
- // Zero out the bits reserved to indicate the payment type.
- amt_msat_bytes[0] &= 0b00011111;
- let min_amt_msat: u64 = u64::from_be_bytes(amt_msat_bytes.into());
- let expiry = u64::from_be_bytes(metadata_bytes[AMT_MSAT_LEN..].try_into().unwrap());
-
- // Make sure to check to check the HMAC before doing the other checks below, to mitigate timing
- // attacks.
- let mut payment_preimage = None;
- match payment_type_res {
- Ok(Method::UserPaymentHash) => {
- let mut hmac = HmacEngine::<Sha256>::new(&keys.user_pmt_hash_key);
- hmac.input(&metadata_bytes[..]);
- hmac.input(&payment_hash.0);
- if !fixed_time_eq(&iv_bytes, &Hmac::from_engine(hmac).into_inner().split_at_mut(IV_LEN).0) {
- log_trace!(logger, "Failing HTLC with user-generated payment_hash {}: unexpected payment_secret", log_bytes!(payment_hash.0));
- return Err(())
- }
- },
- Ok(Method::LdkPaymentHash) => {
- match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
- Ok(preimage) => payment_preimage = Some(preimage),
- Err(bad_preimage_bytes) => {
- log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
- return Err(())
- }
- }
- },
- Err(unknown_bits) => {
- log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
- return Err(());
- }
- }
-
- if payment_data.total_msat < min_amt_msat {
- log_trace!(logger, "Failing HTLC with payment_hash {} due to total_msat {} being less than the minimum amount of {} msat", log_bytes!(payment_hash.0), payment_data.total_msat, min_amt_msat);
- return Err(())
- }
-
- if expiry < highest_seen_timestamp {
- log_trace!(logger, "Failing HTLC with payment_hash {}: expired payment", log_bytes!(payment_hash.0));
- return Err(())
- }
-
- Ok(payment_preimage)
- }
-
- pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
- let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);
-
- match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
- Ok(Method::LdkPaymentHash) => {
- derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
- .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
- err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
- })
- },
- Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
- err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
- }),
- Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
- }
- }
-
- fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
- let mut iv_bytes = [0; IV_LEN];
- let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
- iv_bytes.copy_from_slice(iv_slice);
-
- let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
- let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
- for i in 0..METADATA_LEN {
- metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
- }
-
- (iv_bytes, metadata_bytes)
- }
-
- // Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
- // this case.
- fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
- let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
- hmac.input(iv_bytes);
- hmac.input(metadata_bytes);
- let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
- if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
- return Err(decoded_payment_preimage);
- }
- return Ok(PaymentPreimage(decoded_payment_preimage))
- }
-}
-
// We hold various information about HTLC relay in the HTLC objects in Channel itself:
//
// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
}
}
}
+#[cfg(not(feature = "grind_signatures"))]
#[cfg(test)]
impl HTLCSource {
pub fn dummy() -> Self {
/// Information on the fees and requirements that the counterparty requires when forwarding
/// payments to us through this channel.
pub forwarding_info: Option<CounterpartyForwardingInfo>,
+ /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
+ /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
+ /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
+ pub outbound_htlc_minimum_msat: Option<u64>,
+ /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
+ pub outbound_htlc_maximum_msat: Option<u64>,
}
/// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
/// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
/// should be able to spend nearly this amount.
pub outbound_capacity_msat: u64,
+ /// The available outbound capacity for sending a single HTLC to the remote peer. This is
+ /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
+ /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
+ /// to use a limit as close as possible to the HTLC limit we can currently send.
+ ///
+ /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
+ pub next_outbound_htlc_limit_msat: u64,
/// The available inbound capacity for the remote peer to send HTLCs to us. This does not
/// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
/// available for inclusion in new inbound HTLCs).
pub is_usable: bool,
/// True if this channel is (or will be) publicly-announced.
pub is_public: bool,
+ /// The smallest value HTLC (in msat) we will accept, for this channel. This field
+ /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
+ pub inbound_htlc_minimum_msat: Option<u64>,
+ /// The largest value HTLC (in msat) we currently will accept, for this channel.
+ pub inbound_htlc_maximum_msat: Option<u64>,
}
impl ChannelDetails {
let channel_state = self.channel_state.lock().unwrap();
res.reserve(channel_state.by_id.len());
for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
- let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
- let balance_msat = channel.get_balance_msat();
+ let balance = channel.get_available_balances();
let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
channel.get_holder_counterparty_selected_channel_reserve_satoshis();
res.push(ChannelDetails {
features: InitFeatures::empty(),
unspendable_punishment_reserve: to_remote_reserve_satoshis,
forwarding_info: channel.counterparty_forwarding_info(),
+ // Ensures that we have actually received the `htlc_minimum_msat` value
+ // from the counterparty through the `OpenChannel` or `AcceptChannel`
+ // message (as they are always the first message from the counterparty).
+ // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
+ // default `0` value set by `Channel::new_outbound`.
+ outbound_htlc_minimum_msat: if channel.have_received_message() {
+ Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
+ outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
},
funding_txo: channel.get_funding_txo(),
// Note that accept_channel (or open_channel) is always the first message, so
inbound_scid_alias: channel.latest_inbound_scid_alias(),
channel_value_satoshis: channel.get_value_satoshis(),
unspendable_punishment_reserve: to_self_reserve_satoshis,
- balance_msat,
- inbound_capacity_msat,
- outbound_capacity_msat,
+ balance_msat: balance.balance_msat,
+ inbound_capacity_msat: balance.inbound_capacity_msat,
+ outbound_capacity_msat: balance.outbound_capacity_msat,
+ next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
user_channel_id: channel.get_user_id(),
confirmations_required: channel.minimum_depth(),
force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
is_funding_locked: channel.is_usable(),
is_usable: channel.is_live(),
is_public: channel.should_announce(),
+ inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
+ inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat()
});
}
}
} else { None };
let mut pending_events = self.pending_events.lock().unwrap();
+
+ let source_channel_id = Some(prev_outpoint.to_channel_id());
pending_events.push(events::Event::PaymentForwarded {
+ source_channel_id,
fee_earned_msat,
claim_from_onchain_tx: from_onchain,
});
F::Target: FeeEstimator,
L::Target: Logger,
{
- fn block_connected(&self, block: &Block, height: u32) {
+ fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
{
let best_block = self.best_block.read().unwrap();
- assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
+ assert_eq!(best_block.block_hash(), header.prev_blockhash,
"Blocks must be connected in chain-order - the connected header must build on the last connected header");
assert_eq!(best_block.height(), height - 1,
"Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
}
- let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
- self.transactions_confirmed(&block.header, &txdata, height);
- self.best_block_updated(&block.header, height);
+ self.transactions_confirmed(header, txdata, height);
+ self.best_block_updated(header, height);
}
fn block_disconnected(&self, header: &BlockHeader, height: u32) {
(4, features, required),
(6, unspendable_punishment_reserve, required),
(8, forwarding_info, option),
+ (9, outbound_htlc_minimum_msat, option),
+ (11, outbound_htlc_maximum_msat, option),
});
impl_writeable_tlv_based!(ChannelDetails, {
(14, user_channel_id, required),
(16, balance_msat, required),
(18, outbound_capacity_msat, required),
+ // Note that by the time we get past the required read above, outbound_capacity_msat will be
+ // filled in, so we can safely unwrap it here.
+ (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap())),
(20, inbound_capacity_msat, required),
(22, confirmations_required, option),
(24, force_close_spend_delay, option),
(28, is_funding_locked, required),
(30, is_usable, required),
(32, is_public, required),
+ (33, inbound_htlc_minimum_msat, option),
+ (35, inbound_htlc_maximum_msat, option),
});
impl_writeable_tlv_based!(PhantomRouteHints, {
match inbound_payment::verify(bad_payment_hash, payment_data.clone(), nodes[0].node.highest_seen_timestamp.load(Ordering::Acquire) as u64, &nodes[0].node.inbound_payment_key, &nodes[0].logger) {
Ok(_) => panic!("Unexpected ok"),
Err(()) => {
- nodes[0].logger.assert_log_contains("lightning::ln::channelmanager::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
+ nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
}
}