Skip to content

Add support for liquidity mgmt. via lightning-liquidity#223

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 8 commits into from
Feb 21, 2024
Merged

Add support for liquidity mgmt. via lightning-liquidity#223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2e4936f
Minor error message fixes
tnull Jan 4, 2024
dabbb4d
Have `connect_open_channel` return a `UserChannelId`
tnull Jan 4, 2024
4d3b600
Have `close_channel` take a `UserChannelId`
tnull Jan 4, 2024
86d1a1f
Have `update_channel_config` take a `UserChannelId`
tnull Jan 4, 2024
61b2f37
Implement `LiquiditySource` CMH
tnull Dec 19, 2023
338b9c5
Implement `LiquidityManager` event handling
tnull Jan 8, 2024
49f497f
Implement LSPS2 invoice creation flow
tnull Jan 8, 2024
3c05b17
Allow for variable amount payments
tnull Jan 11, 2024
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
3 changes: 3 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down
6 changes: 3 additions & 3 deletions bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
assert(channelReadyEvent2 is Event.ChannelReady)
node2.eventHandled()

val channelId = when (channelReadyEvent2) {
is Event.ChannelReady -> channelReadyEvent2.channelId
val userChannelId = when (channelReadyEvent2) {
is Event.ChannelReady -> channelReadyEvent2.userChannelId
else -> return
}

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
assert(node1.listPayments().size == 1)
assert(node2.listPayments().size == 1)

node2.closeChannel(channelId, nodeId1)
node2.closeChannel(userChannelId, nodeId1)

val channelClosedEvent1 = node1.waitNextEvent()
println("Got event: $channelClosedEvent1")
Expand Down
32 changes: 23 additions & 9 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
void set_esplora_server(string esplora_server_url);
void set_gossip_source_p2p();
void set_gossip_source_rgs(string rgs_server_url);
void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
void set_storage_dir_path(string storage_dir_path);
void set_network(Network network);
[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
[Throws=NodeError]
void disconnect(PublicKey node_id);
[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
[Throws=NodeError]
void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
[Throws=NodeError]
void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
[Throws=NodeError]
void sync_wallets();
[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
[Throws=NodeError]
Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
[Throws=NodeError]
Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
[Throws=NodeError]
Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
PaymentDetails? payment([ByRef]PaymentHash payment_hash);
[Throws=NodeError]
void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
"MessageSigningFailed",
"TxSyncFailed",
"GossipUpdateFailed",
"LiquidityRequestFailed",
"InvalidAddress",
"InvalidSocketAddress",
"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
"InvalidNetwork",
"DuplicatePayment",
"InsufficientFunds",
"LiquiditySourceUnavailable",
"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
"Failed",
};

[NonExhaustive]
enum Network {
"Bitcoin",
"Testnet",
"Signet",
"Regtest",
dictionary LSPFeeLimits {
u64? max_total_opening_fee_msat;
u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
u64? amount_msat;
PaymentDirection direction;
PaymentStatus status;
LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
"Bitcoin",
"Testnet",
"Signet",
"Regtest",
};

dictionary OutPoint {
Expand Down
2 changes: 1 addition & 1 deletion bindings/python/src/ldk_node/test_ldk_node.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
print("EVENT:", payment_received_event_2)
node_2.event_handled()

node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

channel_closed_event_1 = node_1.wait_next_event()
assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down
114 changes: 106 additions & 8 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
// LSPS2 service's (address, node_id, token)
lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,

@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?

@tnulltnullFeb 2, 2024

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.

}

impl Default for LiquiditySourceConfig {
fn default() -> Self {
Self { lsps2_service: None }
}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
entropy_source_config: Option<EntropySourceConfig>,
chain_data_source_config: Option<ChainDataSourceConfig>,
gossip_source_config: Option<GossipSourceConfig>,
liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
/// Creates a new builder instance with the default configuration.
pub fn new() -> Self {
let config = Config::default();
let entropy_source_config = None;
let chain_data_source_config = None;
let gossip_source_config = None;
Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
Self::from_config(config)
}

/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
let entropy_source_config = None;
let chain_data_source_config = None;
let gossip_source_config = None;
Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
let liquidity_source_config = None;
Self {
config,
entropy_source_config,
chain_data_source_config,
gossip_source_config,
liquidity_source_config,
}
}

/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
self
}

/// Configures the [`Node`] instance to source its inbound liquidity from the given
/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
/// service.
///
/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
///
/// The given `token` will be used by the LSP to authenticate the user.
pub fn set_liquidity_source_lsps2(
&mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
) -> &mut Self {
// Mark the LSP as trusted for 0conf
self.config.trusted_peers_0conf.push(node_id.clone());

let liquidity_source_config =
self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
liquidity_source_config.lsps2_service = Some((address, node_id, token));
self
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
config,
self.chain_data_source_config.as_ref(),
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
seed_bytes,
logger,
vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
config,
self.chain_data_source_config.as_ref(),
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
seed_bytes,
logger,
kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
}

/// Configures the [`Node`] instance to source its inbound liquidity from the given
/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
/// service.
///
/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
///
/// The given `token` will be used by the LSP to authenticate the user.
pub fn set_liquidity_source_lsps2(
&self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
) {
self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
}

/// Sets the used storage directory path.
pub fn set_storage_dir_path(&self, storage_dir_path: String) {
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
gossip_source_config: Option<&GossipSourceConfig>,
liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
// generating the events otherwise.
user_config.manually_accept_inbound_channels = true;
}

if liquidity_source_config.is_some() {
// Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
// check that they don't take too much before claiming.
user_config.channel_config.accept_underpaying_htlcs = true;
}
let channel_manager = {
if let Ok(res) = kv_store.read(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
}
};

let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
let lsps2_client_config = Some(LSPS2ClientConfig {});
let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
let liquidity_manager = Arc::new(LiquidityManager::new(
Arc::clone(&keys_manager),
Arc::clone(&channel_manager),
Some(Arc::clone(&tx_sync)),
None,
None,
liquidity_client_config,
));
Arc::new(LiquiditySource::new_lsps2(
address.clone(),
*node_id,
token.clone(),
Arc::clone(&channel_manager),
Arc::clone(&keys_manager),
liquidity_manager,
Arc::clone(&config),
Arc::clone(&logger),
))
})
});

let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
} else {
Arc::new(NodeCustomMessageHandler::new_ignoring())
};

let msg_handler = match gossip_source.as_gossip_sync() {
GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
chan_handler: Arc::clone(&channel_manager),
route_handler: Arc::clone(&p2p_gossip_sync)
as Arc<dyn RoutingMessageHandler + Sync + Send>,
onion_message_handler: onion_messenger,
custom_message_handler: IgnoringMessageHandler {},
custom_message_handler,
},
GossipSync::Rapid(_) => MessageHandler {
chan_handler: Arc::clone(&channel_manager),
route_handler: Arc::new(IgnoringMessageHandler {})
as Arc<dyn RoutingMessageHandler + Sync + Send>,
onion_message_handler: onion_messenger,
custom_message_handler: IgnoringMessageHandler {},
custom_message_handler,
},
GossipSync::None => {
unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
Arc::clone(&keys_manager),
));

liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

// Init payment info storage
let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
keys_manager,
network_graph,
gossip_source,
liquidity_source,
kv_store,
logger,
_router: router,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add support for liquidity mgmt. via `lightning-liquidity` by tnull · Pull Request #223 · lightningdevkit/ldk-node · GitHub
Skip to content
Add support for liquidity mgmt. via lightning-liquidity#223

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for liquidity mgmt. via `lightning-liquidity` by tnull · Pull Request #223 · lightningdevkit/ldk-node · GitHub
Skip to content
Add support for liquidity mgmt. via lightning-liquidity#223

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

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

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

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

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for liquidity mgmt. via `lightning-liquidity` by tnull · Pull Request #223 · lightningdevkit/ldk-node · GitHub
Skip to content
Add support for liquidity mgmt. via lightning-liquidity#223

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for liquidity mgmt. via `lightning-liquidity` by tnull · Pull Request #223 · lightningdevkit/ldk-node · GitHub
Skip to content
Add support for liquidity mgmt. via lightning-liquidity#223

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading

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

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 8 commits into

from

Feb 21, 2024
 Merged


Add support for liquidity mgmt. via lightning-liquidity#223
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
2e4936f

Minor error message fixes


tnull Jan 4, 2024
dabbb4d

Have `connect_open_channel` return a `UserChannelId`


tnull Jan 4, 2024
4d3b600

Have `close_channel` take a `UserChannelId`


tnull Jan 4, 2024
86d1a1f

Have `update_channel_config` take a `UserChannelId`


tnull Jan 4, 2024
61b2f37

Implement `LiquiditySource` CMH


tnull Dec 19, 2023
338b9c5

Implement `LiquidityManager` event handling


tnull Jan 8, 2024
49f497f

Implement LSPS2 invoice creation flow


tnull Jan 8, 2024
3c05b17

Allow for variable amount payments


tnull Jan 11, 2024

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


3 changes: 3 additions & 0 deletions
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@ lightning-persister = { version = "0.0.121" }
lightning-background-processor = { version = "0.0.121", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.0.121" }
lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
lightning-liquidity = { version = "0.1.0-alpha", features = ["std"] }

#lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
#lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
Expand All@@ -43,6 +44,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["futures"] }
#lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
#lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["esplora-async"] }
#lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity", branch="main", features = ["std"] }

#lightning = { path = "../rust-lightning/lightning", features = ["std"] }
#lightning-invoice = { path = "../rust-lightning/lightning-invoice" }
Expand All@@ -51,6 +53,7 @@ lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-h
#lightning-background-processor = { path = "../rust-lightning/lightning-background-processor", features = ["futures"] }
#lightning-rapid-gossip-sync = { path = "../rust-lightning/lightning-rapid-gossip-sync" }
#lightning-transaction-sync = { path = "../rust-lightning/lightning-transaction-sync", features = ["esplora-async"] }
#lightning-liquidity = { path = "../lightning-liquidity", features = ["std"] }

bdk = { version = "0.29.0", default-features = false, features = ["std", "async-interface", "use-esplora-async", "sqlite-bundled", "keys-bip39"]}

Expand Down

6 changes: 3 additions & 3 deletions
bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,8 +217,8 @@ class LibraryTest {
 assert(channelReadyEvent2 is Event.ChannelReady)
 node2.eventHandled()

 val channelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.channelId
 val userChannelId = when (channelReadyEvent2) {
 is Event.ChannelReady -> channelReadyEvent2.userChannelId
 else -> return
 }

Expand All@@ -239,7 +239,7 @@ class LibraryTest {
 assert(node1.listPayments().size == 1)
 assert(node2.listPayments().size == 1)

 node2.closeChannel(channelId, nodeId1)
 node2.closeChannel(userChannelId, nodeId1)

 val channelClosedEvent1 = node1.waitNextEvent()
 println("Got event: $channelClosedEvent1")
Expand Down

32 changes: 23 additions & 9 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ interface Builder {
	void set_esplora_server(string esplora_server_url);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps2(SocketAddress address, PublicKey node_id, string? token);
	void set_storage_dir_path(string storage_dir_path);
	void set_network(Network network);
	[Throws=BuildError]
Expand DownExpand Up@@ -63,11 +64,11 @@ interface LDKNode {
	[Throws=NodeError]
	void disconnect(PublicKey node_id);
	[Throws=NodeError]
void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
UserChannelId connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
	[Throws=NodeError]
	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
	void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
	[Throws=NodeError]
	void update_channel_config([ByRef]ChannelId channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
	[Throws=NodeError]
	void sync_wallets();
	[Throws=NodeError]
Expand All@@ -86,6 +87,10 @@ interface LDKNode {
	Bolt11Invoice receive_payment(u64 amount_msat, [ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment([ByRef]string description, u32 expiry_secs);
	[Throws=NodeError]
	Bolt11Invoice receive_payment_via_jit_channel(u64 amount_msat, [ByRef]string description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
	[Throws=NodeError]
	Bolt11Invoice receive_variable_amount_payment_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
	PaymentDetails? payment([ByRef]PaymentHash payment_hash);
	[Throws=NodeError]
	void remove_payment([ByRef]PaymentHash payment_hash);
Expand DownExpand Up@@ -117,6 +122,7 @@ enum NodeError {
	"MessageSigningFailed",
	"TxSyncFailed",
	"GossipUpdateFailed",
	"LiquidityRequestFailed",
	"InvalidAddress",
	"InvalidSocketAddress",
	"InvalidPublicKey",
Expand All@@ -130,6 +136,8 @@ enum NodeError {
	"InvalidNetwork",
	"DuplicatePayment",
	"InsufficientFunds",
	"LiquiditySourceUnavailable",
	"LiquidityFeeTooHigh",
};

[Error]
Expand DownExpand Up@@ -168,12 +176,9 @@ enum PaymentStatus {
	"Failed",
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
dictionary LSPFeeLimits {
	u64? max_total_opening_fee_msat;
	u64? max_proportional_opening_fee_ppm_msat;
};

dictionary PaymentDetails {
Expand All@@ -183,6 +188,15 @@ dictionary PaymentDetails {
	u64? amount_msat;
	PaymentDirection direction;
	PaymentStatus status;
	LSPFeeLimits? lsp_fee_limits;
};

[NonExhaustive]
enum Network {
	"Bitcoin",
	"Testnet",
	"Signet",
	"Regtest",
};

dictionary OutPoint {
Expand Down

2 changes: 1 addition & 1 deletion
bindings/python/src/ldk_node/test_ldk_node.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,7 +198,7 @@ def test_channel_full_cycle(self):
 print("EVENT:", payment_received_event_2)
 node_2.event_handled()

 node_2.close_channel(channel_ready_event_2.channel_id, node_id_1)
 node_2.close_channel(channel_ready_event_2.user_channel_id, node_id_1)

 channel_closed_event_1 = node_1.wait_next_event()
 assert isinstance(channel_closed_event_1, Event.CHANNEL_CLOSED)
Expand Down

114 changes: 106 additions & 8 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@ use crate::fee_estimator::OnchainFeeEstimator;
use crate::gossip::GossipSource;
use crate::io;
use crate::io::sqlite_store::SqliteStore;
use crate::liquidity::LiquiditySource;
use crate::logger::{log_error, FilesystemLogger, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::payment_store::PaymentStore;
use crate::peer_store::PeerStore;
use crate::sweep::OutputSweeper;
Expand DownExpand Up@@ -40,6 +42,9 @@ use lightning_persister::fs_store::FilesystemStore;

use lightning_transaction_sync::EsploraSyncClient;

use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};

#[cfg(any(vss, vss_test))]
use crate::io::vss_store::VssStore;
use bdk::bitcoin::secp256k1::Secp256k1;
Expand All@@ -49,6 +54,7 @@ use bdk::template::Bip84;

use bip39::Mnemonic;

use bitcoin::secp256k1::PublicKey;
use bitcoin::{BlockHash, Network};

#[cfg(any(vss, vss_test))]
Expand DownExpand Up@@ -80,6 +86,18 @@ enum GossipSourceConfig {
	RapidGossipSync(String),
}

#[derive(Debug, Clone)]
struct LiquiditySourceConfig {
	// LSPS2 service's (address, node_id, token)
	lsps2_service: Option<(SocketAddress, PublicKey, Option<String>)>,
@jkczyzjkczyzJan 30, 2024

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.

Why make this an Option?
@tnulltnullFeb 2, 2024

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

Currently, we only provide LSPS2 support, however, in the future we will also add support for further protocols, e.g., LSPS1 will be likely next. This means that at that point either one of them or both might be configured. We will then have to figure out if we want to allow to support entirely different providers for different protocols, but for now having the optional fields here is a first step in that direction.
}

impl Default for LiquiditySourceConfig {
	fn default() -> Self {
 Self { lsps2_service: None }
	}
}

/// An error encountered during building a [`Node`].
///
/// [`Node`]: crate::Node
Expand DownExpand Up@@ -146,16 +164,14 @@ pub struct NodeBuilder {
	entropy_source_config: Option<EntropySourceConfig>,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
}

impl NodeBuilder {
	/// Creates a new builder instance with the default configuration.
	pub fn new() -> Self {
 let config = Config::default();
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 Self::from_config(config)
	}

	/// Creates a new builder instance from an [`Config`].
Expand All@@ -164,7 +180,14 @@ impl NodeBuilder {
 let entropy_source_config = None;
 let chain_data_source_config = None;
 let gossip_source_config = None;
 Self { config, entropy_source_config, chain_data_source_config, gossip_source_config }
 let liquidity_source_config = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 }
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
Expand DownExpand Up@@ -218,6 +241,25 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &mut self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) -> &mut Self {
 // Mark the LSP as trusted for 0conf
 self.config.trusted_peers_0conf.push(node_id.clone());

 let liquidity_source_config =
 self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
 liquidity_source_config.lsps2_service = Some((address, node_id, token));
 self
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 self.config.storage_dir_path = storage_dir_path;
Expand DownExpand Up@@ -318,6 +360,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 vss_store,
Expand All@@ -340,6 +383,7 @@ impl NodeBuilder {
 config,
 self.chain_data_source_config.as_ref(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 logger,
 kv_store,
Expand DownExpand Up@@ -413,6 +457,19 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
	}

	/// Configures the [`Node`] instance to source its inbound liquidity from the given
	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
	/// service.
	///
	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
	///
	/// The given `token` will be used by the LSP to authenticate the user.
	pub fn set_liquidity_source_lsps2(
 &self, address: SocketAddress, node_id: PublicKey, token: Option<String>,
	) {
 self.inner.write().unwrap().set_liquidity_source_lsps2(address, node_id, token);
	}

	/// Sets the used storage directory path.
	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
Expand DownExpand Up@@ -463,7 +520,8 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>, seed_bytes: [u8; 64],
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<FilesystemLogger>, kv_store: Arc<K>,
) -> Result<Node<K>, BuildError> {
	// Initialize the on-chain wallet and chain access
Expand DownExpand Up@@ -636,6 +694,12 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 // generating the events otherwise.
 user_config.manually_accept_inbound_channels = true;
	}

	if liquidity_source_config.is_some() {
 // Generally allow claiming underpaying HTLCs as the LSP will skim off some fee. We'll
 // check that they don't take too much before claiming.
 user_config.channel_config.accept_underpaying_htlcs = true;
	}
	let channel_manager = {
 if let Ok(res) = kv_store.read(
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
Expand DownExpand Up@@ -746,20 +810,51 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 }
	};

	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
 lsc.lsps2_service.as_ref().map(|(address, node_id, token)| {
 let lsps2_client_config = Some(LSPS2ClientConfig {});
 let liquidity_client_config = Some(LiquidityClientConfig { lsps2_client_config });
 let liquidity_manager = Arc::new(LiquidityManager::new(
 Arc::clone(&keys_manager),
 Arc::clone(&channel_manager),
 Some(Arc::clone(&tx_sync)),
 None,
 None,
 liquidity_client_config,
 ));
 Arc::new(LiquiditySource::new_lsps2(
 address.clone(),
 *node_id,
 token.clone(),
 Arc::clone(&channel_manager),
 Arc::clone(&keys_manager),
 liquidity_manager,
 Arc::clone(&config),
 Arc::clone(&logger),
 ))
 })
	});

	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
 Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
	} else {
 Arc::new(NodeCustomMessageHandler::new_ignoring())
	};

	let msg_handler = match gossip_source.as_gossip_sync() {
 GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::clone(&p2p_gossip_sync)
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::Rapid(_) => MessageHandler {
 chan_handler: Arc::clone(&channel_manager),
 route_handler: Arc::new(IgnoringMessageHandler {})
 as Arc<dyn RoutingMessageHandler + Sync + Send>,
 onion_message_handler: onion_messenger,
 custom_message_handler: IgnoringMessageHandler {},
 custom_message_handler,
 },
 GossipSync::None => {
 unreachable!("We must always have a gossip sync!");
Expand All@@ -782,6 +877,8 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 Arc::clone(&keys_manager),
	));

	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::clone(&peer_manager)));

	// Init payment info storage
	let payment_store = match io::utils::read_payments(Arc::clone(&kv_store), Arc::clone(&logger)) {
 Ok(payments) => {
Expand DownExpand Up@@ -853,6 +950,7 @@ fn build_with_store_internal<K: KVStore + Sync + Send + 'static>(
 keys_manager,
 network_graph,
 gossip_source,
 liquidity_source,
 kv_store,
 logger,
 _router: router,
Expand Down
Loading