f: review comments

Author: joostjager

src/event.rs

@@ -5,7 +5,6 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
-use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
 use crate::types::{CustomTlvRecord, DynStore, PaymentStore, Sweeper, Wallet};
 use crate::{
 	hex_utils, BumpTransactionEventHandler, ChannelManager, Error, Graph, PeerInfo, PeerStore,
@@ -19,6 +18,7 @@ use crate::fee_estimator::ConfirmationTarget;
 use crate::liquidity::LiquiditySource;
 use crate::logger::Logger;
 
+use crate::payment::asynchronous::static_invoice_store::StaticInvoiceStore;
 use crate::payment::store::{
 	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
 };
@@ -1509,13 +1509,14 @@ where
 						.handle_persist_static_invoice(invoice, invoice_slot, recipient_id)
 						.await
 					{
-						Ok(_) => {},
+						Ok(_) => {
+							self.channel_manager.static_invoice_persisted(invoice_persisted_path);
+						},
 						Err(e) => {
 							log_error!(self.logger, "Failed to persist static invoice: {}", e);
+							return Err(ReplayEvent());
 						},
 					};
-
-					self.channel_manager.static_invoice_persisted(invoice_persisted_path);
 				}
 			},
 			LdkEvent::StaticInvoiceRequested { recipient_id, invoice_slot, reply_path } => {
@@ -1534,6 +1535,7 @@ where
 						Ok(None) => {},
 						Err(e) => {
 							log_error!(self.logger, "Failed to retrieve static invoice: {}", e);
+							return Err(ReplayEvent());
 						},
 					}
 				}

src/io/mod.rs

@@ -74,7 +74,7 @@ pub(crate) const BDK_WALLET_INDEXER_PRIMARY_NAMESPACE: &str = "bdk_wallet";
 pub(crate) const BDK_WALLET_INDEXER_SECONDARY_NAMESPACE: &str = "";
 pub(crate) const BDK_WALLET_INDEXER_KEY: &str = "indexer";
 
-// Static invoices will be persisted at "static_invoices/<sha256(recipient_id)>/<invoice_slot>".
-//
-// Example: static_invoices/039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81/001f
-pub(crate) const STATIC_INVOICES_PRIMARY_NAMESPACE: &str = "static_invoices";
+/// [`StaticInvoice`]s will be persisted under this key.
+///
+/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
+pub(crate) const STATIC_INVOICE_STORE_PRIMARY_NAMESPACE: &str = "static_invoices";

src/lib.rs

@@ -826,7 +826,7 @@ impl Node {
 		Bolt12Payment::new(
 			Arc::clone(&self.channel_manager),
 			Arc::clone(&self.payment_store),
-			self.config.async_payment_services_enabled,
+			Arc::clone(&self.config),
 			Arc::clone(&self.is_running),
 			Arc::clone(&self.logger),
 		)
@@ -840,7 +840,7 @@ impl Node {
 		Arc::new(Bolt12Payment::new(
 			Arc::clone(&self.channel_manager),
 			Arc::clone(&self.payment_store),
-			self.config.async_payment_services_enabled,
+			Arc::clone(&self.config),
 			Arc::clone(&self.is_running),
 			Arc::clone(&self.logger),
 		))

src/payment/asynchronous/mod.rs

@@ -1,2 +1,9 @@
+// This file is Copyright its original authors, visible in version control history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
+// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
+// accordance with one or both of these licenses.
+
 mod rate_limiter;
 pub(crate) mod static_invoice_store;

src/payment/asynchronous/rate_limiter.rs

@@ -1,3 +1,12 @@
+// This file is Copyright its original authors, visible in version control history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
+// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
+// accordance with one or both of these licenses.
+
+//! [`RateLimiter`] to control the rate of requests from users.
+
 use std::collections::HashMap;
 use std::time::{Duration, Instant};
 

src/payment/asynchronous/static_invoice_store.rs

@@ -1,5 +1,14 @@
+// This file is Copyright its original authors, visible in version control history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
+// http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
+// accordance with one or both of these licenses.
+
+//! Store implementation for [`StaticInvoice`]s.
+
 use crate::hex_utils;
-use crate::io::STATIC_INVOICES_PRIMARY_NAMESPACE;
+use crate::io::STATIC_INVOICE_STORE_PRIMARY_NAMESPACE;
 use crate::payment::asynchronous::rate_limiter::RateLimiter;
 use crate::types::DynStore;
 
@@ -57,7 +66,7 @@ impl StaticInvoiceStore {
 		let (secondary_namespace, key) = Self::get_storage_location(invoice_slot, recipient_id);
 
 		self.kv_store
-			.read(STATIC_INVOICES_PRIMARY_NAMESPACE, &secondary_namespace, &key)
+			.read(STATIC_INVOICE_STORE_PRIMARY_NAMESPACE, &secondary_namespace, &key)
 			.and_then(|data| {
 				data.try_into().map(Some).map_err(|e| {
 					lightning::io::Error::new(
@@ -87,7 +96,10 @@ impl StaticInvoiceStore {
 		let mut buf = Vec::new();
 		invoice.write(&mut buf)?;
 
-		self.kv_store.write(STATIC_INVOICES_PRIMARY_NAMESPACE, &secondary_namespace, &key, buf)
+		// Static invoices will be persisted at "static_invoices/<sha256(recipient_id)>/<invoice_slot>".
+		//
+		// Example: static_invoices/039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81/00001
+		self.kv_store.write(STATIC_INVOICE_STORE_PRIMARY_NAMESPACE, &secondary_namespace, &key, buf)
 	}
 
 	fn get_storage_location(invoice_slot: u16, recipient_id: &[u8]) -> (String, String) {

src/payment/bolt12.rs

@@ -9,7 +9,7 @@
 //!
 //! [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
 
-use crate::config::LDK_PAYMENT_RETRY_TIMEOUT;
+use crate::config::{Config, LDK_PAYMENT_RETRY_TIMEOUT};
 use crate::error::Error;
 use crate::ffi::{maybe_deref, maybe_wrap};
 use crate::logger::{log_error, log_info, LdkLogger, Logger};
@@ -57,16 +57,16 @@ pub struct Bolt12Payment {
 	channel_manager: Arc<ChannelManager>,
 	payment_store: Arc<PaymentStore>,
 	is_running: Arc<RwLock<bool>>,
-	async_payment_services_enabled: bool,
+	config: Arc<Config>,
 	logger: Arc<Logger>,
 }
 
 impl Bolt12Payment {
 	pub(crate) fn new(
 		channel_manager: Arc<ChannelManager>, payment_store: Arc<PaymentStore>,
-		async_payment_services_enabled: bool, is_running: Arc<RwLock<bool>>, logger: Arc<Logger>,
+		config: Arc<Config>, is_running: Arc<RwLock<bool>>, logger: Arc<Logger>,
 	) -> Self {
-		Self { channel_manager, payment_store, async_payment_services_enabled, is_running, logger }
+		Self { channel_manager, payment_store, config, is_running, logger }
 	}
 
 	/// Send a payment given an offer.
@@ -462,6 +462,8 @@ impl Bolt12Payment {
 	///
 	/// Useful for posting offers to receive payments later, such as posting an offer on a website.
 	///
+	/// **Caution**: Async payments support is considered experimental.
+	///
 	/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
 	/// [`Offer`]: lightning::offers::offer::Offer
 	pub fn receive_async(&self) -> Result<Offer, Error> {
@@ -474,6 +476,8 @@ impl Bolt12Payment {
 	/// Sets the [`BlindedMessagePath`]s that we will use as an async recipient to interactively build [`Offer`]s with a
 	/// static invoice server, so the server can serve [`StaticInvoice`]s to payers on our behalf when we're offline.
 	///
+	/// **Caution**: Async payments support is considered experimental.
+	///
 	/// [`Offer`]: lightning::offers::offer::Offer
 	/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
 	#[cfg(not(feature = "uniffi"))]
@@ -488,6 +492,8 @@ impl Bolt12Payment {
 	/// Sets the [`BlindedMessagePath`]s that we will use as an async recipient to interactively build [`Offer`]s with a
 	/// static invoice server, so the server can serve [`StaticInvoice`]s to payers on our behalf when we're offline.
 	///
+	/// **Caution**: Async payments support is considered experimental.
+	///
 	/// [`Offer`]: lightning::offers::offer::Offer
 	/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
 	#[cfg(feature = "uniffi")]
@@ -503,6 +509,8 @@ impl Bolt12Payment {
 	/// [`BlindedMessagePath`]s for an async recipient to communicate with this node and interactively
 	/// build [`Offer`]s and [`StaticInvoice`]s for receiving async payments.
 	///
+	/// **Caution**: Async payments support is considered experimental.
+	///
 	/// [`Offer`]: lightning::offers::offer::Offer
 	/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
 	#[cfg(not(feature = "uniffi"))]
@@ -515,6 +523,8 @@ impl Bolt12Payment {
 	/// [`BlindedMessagePath`]s for an async recipient to communicate with this node and interactively
 	/// build [`Offer`]s and [`StaticInvoice`]s for receiving async payments.
 	///
+	/// **Caution**: Async payments support is considered experimental.
+	///
 	/// [`Offer`]: lightning::offers::offer::Offer
 	/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
 	#[cfg(feature = "uniffi")]
@@ -531,7 +541,7 @@ impl Bolt12Payment {
 	fn blinded_paths_for_async_recipient_internal(
 		&self, recipient_id: Vec<u8>,
 	) -> Result<Vec<BlindedMessagePath>, Error> {
-		if !self.async_payment_services_enabled {
+		if !self.config.async_payment_services_enabled {
 			return Err(Error::AsyncPaymentServicesDisabled);
 		}
 

tests/integration_tests_rust.rs

@@ -1135,17 +1135,17 @@ fn static_invoice_server() {
 	let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
 	let chain_source = TestChainSource::Esplora(&electrsd);
 
-	let mut config_sender = random_config(true);
+	let config_sender = random_config(true);
 	let node_sender = setup_node(&chain_source, config_sender, None);
 
-	let mut config_sender_lsp = random_config(true);
+	let config_sender_lsp = random_config(true);
 	let node_sender_lsp = setup_node(&chain_source, config_sender_lsp, None);
 
 	let mut config_receiver_lsp = random_config(true);
 	config_receiver_lsp.node_config.async_payment_services_enabled = true;
 	let node_receiver_lsp = setup_node(&chain_source, config_receiver_lsp, None);
 
-	let mut config_receiver = random_config(true);
+	let config_receiver = random_config(true);
 	let node_receiver = setup_node(&chain_source, config_receiver, None);
 
 	let address_sender = node_sender.onchain_payment().new_address().unwrap();