-
Notifications
You must be signed in to change notification settings - Fork 122
Add LSPS5 webhook notification support #729
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,7 +65,8 @@ use crate::io::{ | |
| PENDING_PAYMENT_INFO_PERSISTENCE_SECONDARY_NAMESPACE, | ||
| }; | ||
| use crate::liquidity::{ | ||
| LSPS1ClientConfig, LSPS2ClientConfig, LSPS2ServiceConfig, LiquiditySourceBuilder, | ||
| LSPS1ClientConfig, LSPS2ClientConfig, LSPS2ServiceConfig, LSPS5ClientConfig, | ||
| LiquiditySourceBuilder, | ||
| }; | ||
| use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger}; | ||
| use crate::message_handler::NodeCustomMessageHandler; | ||
|
|
@@ -124,6 +125,12 @@ struct LiquiditySourceConfig { | |
| lsps2_client: Option<LSPS2ClientConfig>, | ||
| // Act as an LSPS2 service. | ||
| lsps2_service: Option<LSPS2ServiceConfig>, | ||
| // Act as an LSPS5 client connecting to the given service. | ||
| lsps5_client: Option<LSPS5ClientConfig>, | ||
| // Act as an LSPS5 service. | ||
| lsps5_service: Option<LSPS5ServiceConfig>, | ||
| // Optional custom HTTP client to be used by LSPS5 service. | ||
| http_client: Option<reqwest::Client>, | ||
| } | ||
|
|
||
| #[derive(Clone)] | ||
|
|
@@ -449,6 +456,44 @@ impl NodeBuilder { | |
| self | ||
| } | ||
|
|
||
| /// Configures the [`Node`] instance to source webhook notifications from the given | ||
| /// [bLIP-55 / LSPS5] service. | ||
| /// | ||
| /// This allows the client to register webhook endpoints with the LSP to receive | ||
| /// push notifications for Lightning events when the client is offline. | ||
| /// | ||
| /// [bLIP-55 / LSPS5]: https://github.com/lightning/blips/blob/master/blip-0055.md | ||
| pub fn set_liquidity_source_lsps5( | ||
| &mut self, node_id: PublicKey, address: SocketAddress, | ||
| ) -> &mut Self { | ||
| let liquidity_source_config = | ||
| self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default()); | ||
| let lsps5_client_config = LSPS5ClientConfig { node_id, address }; | ||
| liquidity_source_config.lsps5_client = Some(lsps5_client_config); | ||
| self | ||
| } | ||
|
|
||
| /// Configures the [`Node`] instance to provide an [LSPS5] service, enabling clients | ||
| /// to register webhooks for push notifications. | ||
| /// | ||
| /// [LSPS5]: https://github.com/lightning/blips/blob/master/blip-0055.md | ||
| pub fn set_liquidity_provider_lsps5( | ||
| &mut self, service_config: LSPS5ServiceConfig, | ||
| ) -> &mut Self { | ||
| let liquidity_source_config = | ||
| self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default()); | ||
| liquidity_source_config.lsps5_service = Some(service_config); | ||
| self | ||
| } | ||
|
|
||
| /// Sets a custom HTTP client to be used by the LSPS5 service. | ||
| pub fn set_liquidity_http_client(&mut self, http_client: reqwest::Client) -> &mut Self { | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No need to set a 'custom' client. Let's just use our usual client and drop this builder method.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I did this because I wanted to mock the client in the test in order to test the |
||
| let liquidity_source_config = | ||
| self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default()); | ||
| liquidity_source_config.http_client = Some(http_client); | ||
| 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; | ||
|
|
@@ -850,6 +895,30 @@ impl ArcedNodeBuilder { | |
| self.inner.write().unwrap().set_liquidity_provider_lsps2(service_config); | ||
| } | ||
|
|
||
| /// Configures the [`Node`] instance to source webhook notifications from the given | ||
| /// [bLIP-55 / LSPS5] service. | ||
| /// | ||
| /// This allows the client to register webhook endpoints with the LSP to receive | ||
| /// push notifications for Lightning events when the client is offline. | ||
| /// | ||
| /// [bLIP-55 / LSPS5]: https://github.com/lightning/blips/blob/master/blip-0055.md | ||
| pub fn set_liquidity_source_lsps5(&self, node_id: PublicKey, address: SocketAddress) { | ||
| self.inner.write().unwrap().set_liquidity_source_lsps5(node_id, address); | ||
| } | ||
|
|
||
| /// Configures the [`Node`] instance to provide an [LSPS5] service, enabling clients | ||
| /// to register webhooks for push notifications. | ||
| /// | ||
| /// [LSPS5]: https://github.com/lightning/blips/blob/master/blip-0055.md | ||
| pub fn set_liquidity_provider_lsps5(&self, service_config: LSPS5ServiceConfig) { | ||
| self.inner.write().unwrap().set_liquidity_provider_lsps5(service_config); | ||
| } | ||
|
|
||
| /// Sets a custom HTTP client to be used by the LSPS5 service. | ||
| pub fn set_liquidity_http_client(&self, http_client: reqwest::Client) { | ||
| self.inner.write().unwrap().set_liquidity_http_client(http_client); | ||
| } | ||
|
|
||
| /// 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); | ||
|
|
@@ -1626,6 +1695,15 @@ fn build_with_store_internal( | |
| liquidity_source_builder.lsps2_service(promise_secret, config.clone()) | ||
| }); | ||
|
|
||
| lsc.lsps5_client.as_ref().map(|config| { | ||
| liquidity_source_builder.lsps5_client(config.node_id, config.address.clone()) | ||
| }); | ||
|
|
||
| lsc.lsps5_service.as_ref().map(|config| { | ||
| let http_client = lsc.http_client.clone().unwrap_or_else(|| reqwest::Client::new()); | ||
| liquidity_source_builder.lsps5_service_with_http_client(config.clone(), http_client) | ||
| }); | ||
|
|
||
| let liquidity_source = runtime | ||
| .block_on(async move { liquidity_source_builder.build().await.map(Arc::new) })?; | ||
| let custom_message_handler = | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there is ~no immediate scenario where we'd like to set a different LSP for LSPS5 compared to LSPS1/LSPS2. So rather than having the user configure this explicitly, it should be automatically enabled if we detect that our LSPS1 or LSPS2 counterparty also supports LSPS5 (you can check that via
LSPS0ClientHandler::list_protocols). Note that this however poses an API design challenge as suddenly we'll have to support getting notifications from multiple LSPs.Note that for a while some users have requested multi-LSP support (cf. #529) and for the sake of simplicity we so far have punted on it. But I do wonder if it would now make sense to first make this refactor to a model where users just configure a number of LSP nodes and we lean on
list_protocolsto discover what the configured nodes are supporting. I think I'll have to think about it a bit more - what are your thoughts on this?