Skip to content

Make the API async where needed, avoid block_on #926

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

Draft
tnull wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Make the API async where needed, avoid block_on #926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0628b6d
Expose async APIs for store-backed persistence
tnull Jun 8, 2026
16fd81d
Stop retaining a VSS runtime
tnull Jun 8, 2026
20f3f28
Stop retaining a PostgreSQL runtime
tnull Jun 8, 2026
2f72a98
Finish async node API migration
tnull Jun 8, 2026
f58384d
Document runtime assumptions
tnull Jun 8, 2026
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
71 changes: 33 additions & 38 deletions benches/payments.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@ fn spawn_payment(node_a: Arc<Node>, node_b: Arc<Node>, amount_msat: u64) {
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
}

let payment_id = node_a.spontaneous_payment().send_with_preimage(
let spontaneous_payment = node_a.spontaneous_payment();
let payment_id = spontaneous_payment.send_with_preimage(
amount_msat,
node_b.node_id(),
preimage,
None,
);

@benthecarman benthecarman Jun 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

await should be here


match payment_id {
match payment_id.await {
Ok(payment_id) => {
println!(
"{}: Awaiting payment with id {}",
Expand Down Expand Up @@ -93,7 +94,7 @@ async fn send_payments(node_a: Arc<Node>, node_b: Arc<Node>) -> std::time::Durat
},
}

node_a.event_handled().unwrap();
node_a.event_handled().await.unwrap();
}

let duration = start.elapsed();
Expand All @@ -110,37 +111,36 @@ async fn send_payments(node_a: Arc<Node>, node_b: Arc<Node>) -> std::time::Durat
PaymentPreimage(preimage_bytes),
None,
)
.await
.ok()
.unwrap();

duration
}

fn payment_benchmark(c: &mut Criterion) {
// Set up two nodes. Because this is slow, we reuse the same nodes for each sample.
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
let chain_source = random_chain_source(&bitcoind, &electrsd);

let (node_a, node_b) = setup_two_nodes_with_store(
&chain_source,
false,
true,
false,
common::TestStoreType::Sqlite,
);

let runtime =
tokio::runtime::Builder::new_multi_thread().worker_threads(4).enable_all().build().unwrap();

let node_a = Arc::new(node_a);
let node_b = Arc::new(node_b);
// Set up two nodes. Because this is slow, we reuse the same nodes for each sample.
let (setup_done, setup_result) = std::sync::mpsc::channel();
runtime.spawn(async move {
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
let chain_source = random_chain_source(&bitcoind, &electrsd);
let (node_a, node_b) = setup_two_nodes_with_store(
&chain_source,
false,
true,
false,
common::TestStoreType::Sqlite,
)
.await;

let node_a = Arc::new(node_a);
let node_b = Arc::new(node_b);

// Fund the nodes and setup a channel between them. The criterion function cannot be async, so we need to execute
// the setup using a runtime.
let node_a_cloned = Arc::clone(&node_a);
let node_b_cloned = Arc::clone(&node_b);
runtime.block_on(async move {
let address_a = node_a_cloned.onchain_payment().new_address().unwrap();
// Fund the nodes and setup a channel between them.
let address_a = node_a.onchain_payment().new_address().await.unwrap();
let premine_sat = 25_000_000;
premine_and_distribute_funds(
&bitcoind.client,
Expand All @@ -149,23 +149,18 @@ fn payment_benchmark(c: &mut Criterion) {
Amount::from_sat(premine_sat),
)
.await;
node_a_cloned.sync_wallets().unwrap();
node_b_cloned.sync_wallets().unwrap();
open_channel_push_amt(
&node_a_cloned,
&node_b_cloned,
16_000_000,
Some(1_000_000_000),
false,
&electrsd,
)
.await;
node_a.sync_wallets().await.unwrap();
node_b.sync_wallets().await.unwrap();
open_channel_push_amt(&node_a, &node_b, 16_000_000, Some(1_000_000_000), false, &electrsd)
.await;
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 6).await;
node_a_cloned.sync_wallets().unwrap();
node_b_cloned.sync_wallets().unwrap();
expect_channel_ready_event!(node_a_cloned, node_b_cloned.node_id());
expect_channel_ready_event!(node_b_cloned, node_a_cloned.node_id());
node_a.sync_wallets().await.unwrap();
node_b.sync_wallets().await.unwrap();
expect_channel_ready_event!(node_a, node_b.node_id());
expect_channel_ready_event!(node_b, node_a.node_id());
setup_done.send((node_a, node_b)).unwrap();
});
let (node_a, node_b) = setup_result.recv().unwrap();

let mut group = c.benchmark_group("payments");
group.sample_size(10);
Expand Down
57 changes: 31 additions & 26 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,34 +61,36 @@ interface Builder {
[Throws=BuildError]
void set_async_payments_role(AsyncPaymentsRole? role);
void set_wallet_recovery_mode();
[Throws=BuildError]
[Async, Throws=BuildError]
Node build(NodeEntropy node_entropy);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_postgres_store(NodeEntropy node_entropy, string connection_string, string? db_name, string? kv_table_name, string? certificate_pem);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_fs_store(NodeEntropy node_entropy);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_vss_store(NodeEntropy node_entropy, string vss_url, string store_id, record<string, string> fixed_headers);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_vss_store_and_lnurl_auth(NodeEntropy node_entropy, string vss_url, string store_id, string lnurl_auth_server_url, record<string, string> fixed_headers);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_vss_store_and_fixed_headers(NodeEntropy node_entropy, string vss_url, string store_id, record<string, string> fixed_headers);
[Throws=BuildError]
[Async, Throws=BuildError]
Node build_with_vss_store_and_header_provider(NodeEntropy node_entropy, string vss_url, string store_id, VssHeaderProvider header_provider);
};

interface Node {
[Throws=NodeError]
[Async, Throws=NodeError]
void start();
[Throws=NodeError]
[Async, Throws=NodeError]
void stop();
[Async]
NodeStatus status();
Config config();
Event? next_event();
[Async]
Event wait_next_event();
[Async]
Event next_event_async();
[Throws=NodeError]
[Async, Throws=NodeError]
void event_handled();
PublicKey node_id();
sequence<SocketAddress>? listening_addresses();
Expand All @@ -100,49 +102,52 @@ interface Node {
OnchainPayment onchain_payment();
UnifiedPayment unified_payment();
LSPS1Liquidity lsps1_liquidity();
[Throws=NodeError]
[Async, Throws=NodeError]
void lnurl_auth(string lnurl);
[Throws=NodeError]
[Async, Throws=NodeError]
void connect(PublicKey node_id, SocketAddress address, boolean persist);
[Throws=NodeError]
[Async, Throws=NodeError]
void disconnect(PublicKey node_id);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_announced_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_channel_with_all(PublicKey node_id, SocketAddress address, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_announced_channel_with_all(PublicKey node_id, SocketAddress address, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_0reserve_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
UserChannelId open_0reserve_channel_with_all(PublicKey node_id, SocketAddress address, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
void splice_in([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, u64 splice_amount_sats);
[Throws=NodeError]
[Async, Throws=NodeError]
void splice_in_with_all([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
[Throws=NodeError]
void splice_out([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, [ByRef]Address address, u64 splice_amount_sats);
[Throws=NodeError]
[Async, Throws=NodeError]
void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
[Throws=NodeError]
[Async, Throws=NodeError]
void force_close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, string? reason);
[Throws=NodeError]
void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
[Throws=NodeError]
[Async, Throws=NodeError]
void sync_wallets();
[Async]
PaymentDetails? payment([ByRef]PaymentId payment_id);
[Throws=NodeError]
[Async, Throws=NodeError]
void remove_payment([ByRef]PaymentId payment_id);
BalanceDetails list_balances();
[Async]
sequence<PaymentDetails> list_payments();
[Async]
sequence<PeerDetails> list_peers();
sequence<ChannelDetails> list_channels();
NetworkGraph network_graph();
string sign_message([ByRef]sequence<u8> msg);
boolean verify_signature([ByRef]sequence<u8> msg, [ByRef]string sig, [ByRef]PublicKey pkey);
[Throws=NodeError]
[Async, Throws=NodeError]
bytes export_pathfinding_scores();
};

Expand Down
Loading