Allow to override fee rates for onchain payments#434

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

Merged
tnull merged 1 commit into from
Jan 27, 2025
Merged

Allow to override fee rates for onchain payments #434

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
14 changes: 12 additions & 2 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
[Throws=NodeError]
Address new_address();
[Throws=NodeError]
Txid send_to_address([ByRef]Address address, u64 amount_sats);
Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
[Throws=NodeError]
Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
[Name=from_sat_per_kwu]
constructor(u64 sat_kwu);
[Name=from_sat_per_vb_unchecked]
constructor(u64 sat_vb);
u64 to_sat_per_kwu();
u64 to_sat_per_vb_floor();
u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down
34 changes: 30 additions & 4 deletions src/payment/onchain.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
($fee_rate_opt: expr) => {{
#[cfg(not(feature = "uniffi"))]
{
$fee_rate_opt
}
#[cfg(feature = "uniffi")]
{
$fee_rate_opt.map(|f| *f)
}
}};
}
Comment thread
tnull marked this conversation as resolved.

/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
///
/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
/// a reasonable estimate from the configured chain source.
///
/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
pub fn send_to_address(
&self, address: &bitcoin::Address, amount_sats: u64,
&self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
) -> Result<Txid, Error> {
let rt_lock = self.runtime.read().unwrap();
if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
let send_amount =
OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
self.wallet.send_to_address(address, send_amount)
let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
self.wallet.send_to_address(address, send_amount, fee_rate_opt)
}

/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
/// will try to send all spendable onchain funds, i.e.,
/// [`BalanceDetails::spendable_onchain_balance_sats`].
///
/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.
/// we'll retrieve an estimate from the configured chain source.
///
/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
pub fn send_all_to_address(
&self, address: &bitcoin::Address, retain_reserves: bool,
&self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
) -> Result<Txid, Error> {
let rt_lock = self.runtime.read().unwrap();
if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
OnchainSendAmount::AllDrainingReserve
};

self.wallet.send_to_address(address, send_amount)
let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
self.wallet.send_to_address(address, send_amount, fee_rate_opt)
}
}
7 changes: 5 additions & 2 deletions src/payment/unified_qr.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
},
};

let txid =
self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
let txid = self.onchain_payment.send_to_address(
&uri_network_checked.address,
amount.to_sat(),
None,
)?;

Ok(QrPaymentResult::Onchain { txid })
}
Expand Down
2 changes: 1 addition & 1 deletion src/uniffi_types.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down
8 changes: 6 additions & 2 deletions src/wallet/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

pub(crate) fn send_to_address(
&self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
fee_rate: Option<FeeRate>,
) -> Result<Txid, Error> {
// Use the set fee_rate or default to fee estimation.
let confirmation_target = ConfirmationTarget::OnchainPayment;
let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
let fee_rate =
fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

let tx = {
let mut locked_wallet = self.inner.lock().unwrap();
Expand Down
9 changes: 5 additions & 4 deletions tests/integration_tests_rust.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

assert_eq!(
Err(NodeError::InsufficientFunds),
node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
);

let amount_to_send_sats = 1000;
let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
let txid =
node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

let addr_b = node_b.onchain_payment().new_address().unwrap();
let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

let addr_b = node_b.onchain_payment().new_address().unwrap();
let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
wait_for_tx(&electrsd.client, txid);

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Allow to override fee rates for onchain payments#434

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

 Merged

tnull
merged 1 commit into

from

Jan 27, 2025
 Merged


Allow to override fee rates for onchain payments
#434
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


14 changes: 12 additions & 2 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -161,9 +161,19 @@ interface OnchainPayment {
	[Throws=NodeError]
	Address new_address();
	[Throws=NodeError]
	Txid send_to_address([ByRef]Address address, u64 amount_sats);
	Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
	[Throws=NodeError]
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve);
	Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

interface FeeRate {
	[Name=from_sat_per_kwu]
	constructor(u64 sat_kwu);
	[Name=from_sat_per_vb_unchecked]
	constructor(u64 sat_vb);
	u64 to_sat_per_kwu();
	u64 to_sat_per_vb_floor();
	u64 to_sat_per_vb_ceil();
};

interface UnifiedQrPayment {
Expand Down

34 changes: 30 additions & 4 deletions
src/payment/onchain.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,24 @@ use bitcoin::{Address, Txid};

use std::sync::{Arc, RwLock};

#[cfg(not(feature = "uniffi"))]
type FeeRate = bitcoin::FeeRate;
#[cfg(feature = "uniffi")]
type FeeRate = Arc<bitcoin::FeeRate>;

macro_rules! maybe_map_fee_rate_opt {
	($fee_rate_opt: expr) => {{
 #[cfg(not(feature = "uniffi"))]
 {
 $fee_rate_opt
 }
 #[cfg(feature = "uniffi")]
 {
 $fee_rate_opt.map(|f| *f)
 }
	}};
}
Comment thread
tnull marked this conversation as resolved.


/// A payment handler allowing to send and receive on-chain payments.
///
/// Should be retrieved by calling [`Node::onchain_payment`].
Expand DownExpand Up@@ -50,9 +68,12 @@ impl OnchainPayment {
	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise we'll retrieve
	/// a reasonable estimate from the configured chain source.
	///
	/// [`BalanceDetails::total_anchor_channels_reserve_sats`]: crate::BalanceDetails::total_anchor_channels_reserve_sats
	pub fn send_to_address(
 &self, address: &bitcoin::Address, amount_sats: u64,
 &self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -63,7 +84,8 @@ impl OnchainPayment {
 crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
 let send_amount =
 OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}

	/// Send an on-chain payment to the given address, draining the available funds.
Expand All@@ -77,9 +99,12 @@ impl OnchainPayment {
	/// will try to send all spendable onchain funds, i.e.,
	/// [`BalanceDetails::spendable_onchain_balance_sats`].
	///
	/// If `fee_rate` is set it will be used on the resulting transaction. Otherwise a reasonable
Comment thread
tnull marked this conversation as resolved.

	/// we'll retrieve an estimate from the configured chain source.
	///
	/// [`BalanceDetails::spendable_onchain_balance_sats`]: crate::balance::BalanceDetails::spendable_onchain_balance_sats
	pub fn send_all_to_address(
 &self, address: &bitcoin::Address, retain_reserves: bool,
 &self, address: &bitcoin::Address, retain_reserves: bool, fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 let rt_lock = self.runtime.read().unwrap();
 if rt_lock.is_none() {
Expand All@@ -94,6 +119,7 @@ impl OnchainPayment {
 OnchainSendAmount::AllDrainingReserve
 };

 self.wallet.send_to_address(address, send_amount)
 let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
 self.wallet.send_to_address(address, send_amount, fee_rate_opt)
	}
}

7 changes: 5 additions & 2 deletions
src/payment/unified_qr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,8 +156,11 @@ impl UnifiedQrPayment {
 },
 };

 let txid =
 self.onchain_payment.send_to_address(&uri_network_checked.address, amount.to_sat())?;
 let txid = self.onchain_payment.send_to_address(
 &uri_network_checked.address,
 amount.to_sat(),
 None,
 )?;

 Ok(QrPaymentResult::Onchain { txid })
	}
Expand Down

2 changes: 1 addition & 1 deletion
src/uniffi_types.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

pub use lightning_invoice::Bolt11Invoice;

pub use bitcoin::{Address, BlockHash, Network, OutPoint, Txid};
pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};

pub use bip39::Mnemonic;

Expand Down

8 changes: 6 additions & 2 deletions
src/wallet/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,8 @@ use bitcoin::secp256k1::ecdh::SharedSecret;
use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
use bitcoin::{
	Amount, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram, WitnessVersion,
	Amount, FeeRate, ScriptBuf, Transaction, TxOut, Txid, WPubkeyHash, WitnessProgram,
	WitnessVersion,
};

use std::ops::Deref;
Expand DownExpand Up@@ -239,9 +240,12 @@ where

	pub(crate) fn send_to_address(
 &self, address: &bitcoin::Address, send_amount: OnchainSendAmount,
 fee_rate: Option<FeeRate>,
	) -> Result<Txid, Error> {
 // Use the set fee_rate or default to fee estimation.
 let confirmation_target = ConfirmationTarget::OnchainPayment;
 let fee_rate = self.fee_estimator.estimate_fee_rate(confirmation_target);
 let fee_rate =
 fee_rate.unwrap_or_else(|| self.fee_estimator.estimate_fee_rate(confirmation_target));

 let tx = {
 let mut locked_wallet = self.inner.lock().unwrap();
Expand Down

9 changes: 5 additions & 4 deletions
tests/integration_tests_rust.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -315,11 +315,12 @@ fn onchain_spend_receive() {

	assert_eq!(
 Err(NodeError::InsufficientFunds),
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1)
 node_a.onchain_payment().send_to_address(&addr_b, expected_node_a_balance + 1, None)
	);

	let amount_to_send_sats = 1000;
	let txid = node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats).unwrap();
	let txid =
 node_b.onchain_payment().send_to_address(&addr_a, amount_to_send_sats, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -334,7 +335,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, true, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand All@@ -350,7 +351,7 @@ fn onchain_spend_receive() {
	assert!(node_b.list_balances().spendable_onchain_balance_sats < expected_node_b_balance_upper);

	let addr_b = node_b.onchain_payment().new_address().unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false).unwrap();
	let txid = node_a.onchain_payment().send_all_to_address(&addr_b, false, None).unwrap();
	generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6);
	wait_for_tx(&electrsd.client, txid);

Expand Down