Skip to content

Keep the default routing fee limit if none is given #1221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajaysehwal wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Keep the default routing fee limit if none is given #1221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 64 additions & 3 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use bitcoin::secp256k1::PublicKey;
use bitcoin::Network;
use lightning::ln::msgs::SocketAddress;
use lightning::routing::gossip::NodeAlias;
use lightning::routing::router::RouteParametersConfig;
use lightning::routing::router::{RouteParameters, RouteParametersConfig};
use lightning::util::config::{
ChannelConfig as LdkChannelConfig, MaxDustHTLCExposure as LdkMaxDustHTLCExposure, UserConfig,
};
Expand Down Expand Up @@ -763,6 +763,18 @@ pub(crate) fn clamp_full_scan_stop_gap(full_scan_stop_gap: u32) -> u32 {
full_scan_stop_gap.clamp(MIN_FULL_SCAN_STOP_GAP, MAX_FULL_SCAN_STOP_GAP)
}

pub(crate) fn apply_route_parameters_config(
route_params: &mut RouteParameters, config: &RouteParametersConfig,
) {
if let Some(max_total_routing_fee_msat) = config.max_total_routing_fee_msat {
route_params.max_total_routing_fee_msat = Some(max_total_routing_fee_msat);
}
route_params.payment_params.max_total_cltv_expiry_delta = config.max_total_cltv_expiry_delta;
route_params.payment_params.max_path_count = config.max_path_count;
route_params.payment_params.max_channel_saturation_power_of_half =
config.max_channel_saturation_power_of_half;
}

/// Configuration for syncing with Bitcoin Core backend via REST.
#[derive(Debug, Clone)]
pub struct BitcoindRestClientConfig {
Expand Down Expand Up @@ -918,12 +930,61 @@ pub enum AsyncPaymentsRole {
mod tests {
use std::str::FromStr;

use lightning::routing::router::PaymentParameters;

use super::{
clamp_full_scan_stop_gap, default_user_config, may_announce_channel, AnnounceError, Config,
ElectrumSyncConfig, EsploraSyncConfig, NodeAlias, SocketAddress,
apply_route_parameters_config, clamp_full_scan_stop_gap, default_user_config,
may_announce_channel, AnnounceError, Config, ElectrumSyncConfig, EsploraSyncConfig,
NodeAlias, RouteParameters, RouteParametersConfig, SocketAddress,
DEFAULT_FULL_SCAN_STOP_GAP, MAX_FULL_SCAN_STOP_GAP, MIN_FULL_SCAN_STOP_GAP,
};

fn route_params(amount_msat: u64) -> RouteParameters {
let node_id = bitcoin::secp256k1::PublicKey::from_str(
"0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
)
.unwrap();
RouteParameters::from_payment_params_and_value(
PaymentParameters::from_node_id(node_id, 42),
amount_msat,
)
}

#[test]
fn unset_routing_fee_limit_keeps_the_default() {
let mut route_params = route_params(1_000_000);
let default_fee_limit = route_params.max_total_routing_fee_msat;
assert_eq!(default_fee_limit, Some(1_000_000 / 100 + 50_000));

let config = RouteParametersConfig {
max_total_routing_fee_msat: None,
max_total_cltv_expiry_delta: 144,
max_path_count: 3,
max_channel_saturation_power_of_half: 1,
};
apply_route_parameters_config(&mut route_params, &config);

assert_eq!(route_params.max_total_routing_fee_msat, default_fee_limit);
assert_eq!(route_params.payment_params.max_total_cltv_expiry_delta, 144);
assert_eq!(route_params.payment_params.max_path_count, 3);
assert_eq!(route_params.payment_params.max_channel_saturation_power_of_half, 1);
}

#[test]
fn explicit_routing_fee_limit_overrides_the_default() {
for limit in [0, 1_234, u64::MAX] {
let mut route_params = route_params(1_000_000);
let config = RouteParametersConfig {
max_total_routing_fee_msat: Some(limit),
max_total_cltv_expiry_delta: 1008,
max_path_count: 10,
max_channel_saturation_power_of_half: 2,
};
apply_route_parameters_config(&mut route_params, &config);
assert_eq!(route_params.max_total_routing_fee_msat, Some(limit));
}
}

#[test]
fn node_announce_channel() {
// Default configuration with node alias and listening addresses unset
Expand Down
30 changes: 5 additions & 25 deletions src/payment/bolt11.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use lightning_invoice::{
};
use lightning_types::payment::{PaymentHash, PaymentPreimage};

use crate::config::{Config, LDK_PAYMENT_RETRY_TIMEOUT};
use crate::config::{apply_route_parameters_config, Config, LDK_PAYMENT_RETRY_TIMEOUT};
use crate::connection::ConnectionManager;
use crate::data_store::DataStoreUpdateResult;
use crate::error::Error;
Expand Down Expand Up @@ -837,18 +837,8 @@ impl Bolt11Payment {
let mut route_params =
RouteParameters::from_payment_params_and_value(payment_params, amount_msat);

if let Some(RouteParametersConfig {
max_total_routing_fee_msat,
max_total_cltv_expiry_delta,
max_path_count,
max_channel_saturation_power_of_half,
}) = route_parameters.as_ref().or(self.config.route_parameters.as_ref())
{
route_params.max_total_routing_fee_msat = *max_total_routing_fee_msat;
route_params.payment_params.max_total_cltv_expiry_delta = *max_total_cltv_expiry_delta;
route_params.payment_params.max_path_count = *max_path_count;
route_params.payment_params.max_channel_saturation_power_of_half =
*max_channel_saturation_power_of_half;
if let Some(config) = route_parameters.as_ref().or(self.config.route_parameters.as_ref()) {
apply_route_parameters_config(&mut route_params, config);
}

let liquidity_limit_multiplier = Some(self.config.probing_liquidity_limit_multiplier);
Expand Down Expand Up @@ -899,18 +889,8 @@ impl Bolt11Payment {
let mut route_params =
RouteParameters::from_payment_params_and_value(payment_params, amount_msat);

if let Some(RouteParametersConfig {
max_total_routing_fee_msat,
max_total_cltv_expiry_delta,
max_path_count,
max_channel_saturation_power_of_half,
}) = route_parameters.as_ref().or(self.config.route_parameters.as_ref())
{
route_params.max_total_routing_fee_msat = *max_total_routing_fee_msat;
route_params.payment_params.max_total_cltv_expiry_delta = *max_total_cltv_expiry_delta;
route_params.payment_params.max_path_count = *max_path_count;
route_params.payment_params.max_channel_saturation_power_of_half =
*max_channel_saturation_power_of_half;
if let Some(config) = route_parameters.as_ref().or(self.config.route_parameters.as_ref()) {
apply_route_parameters_config(&mut route_params, config);
}

let liquidity_limit_multiplier = Some(self.config.probing_liquidity_limit_multiplier);
Expand Down
16 changes: 3 additions & 13 deletions src/payment/spontaneous.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use lightning::routing::router::{PaymentParameters, RouteParameters, RouteParame
use lightning::sign::EntropySource;
use lightning_types::payment::{PaymentHash, PaymentPreimage};

use crate::config::{Config, LDK_PAYMENT_RETRY_TIMEOUT};
use crate::config::{apply_route_parameters_config, Config, LDK_PAYMENT_RETRY_TIMEOUT};
use crate::error::Error;
use crate::logger::{log_error, log_info, LdkLogger, Logger};
use crate::payment::store::{PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus};
Expand Down Expand Up @@ -78,18 +78,8 @@ impl SpontaneousPayment {
amount_msat,
);

if let Some(RouteParametersConfig {
max_total_routing_fee_msat,
max_total_cltv_expiry_delta,
max_path_count,
max_channel_saturation_power_of_half,
}) = route_parameters.as_ref().or(self.config.route_parameters.as_ref())
{
route_params.max_total_routing_fee_msat = *max_total_routing_fee_msat;
route_params.payment_params.max_total_cltv_expiry_delta = *max_total_cltv_expiry_delta;
route_params.payment_params.max_path_count = *max_path_count;
route_params.payment_params.max_channel_saturation_power_of_half =
*max_channel_saturation_power_of_half;
if let Some(config) = route_parameters.as_ref().or(self.config.route_parameters.as_ref()) {
apply_route_parameters_config(&mut route_params, config);
}

let mut recipient_fields = RecipientOnionFields::spontaneous_empty(amount_msat);
Expand Down
Loading