Add invoice constructor with custom payment hash

Author: ssbright

lightning-invoice/src/utils.rs

@@ -294,12 +294,12 @@ pub fn create_invoice_from_channelmanager_with_description_hash_and_duration_sin
 	network: Currency, amt_msat: Option<u64>, description_hash: Sha256,
 	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
 ) -> Result<Invoice, SignOrCreationError<()>>
-	where
-		M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
-		T::Target: BroadcasterInterface,
-		K::Target: KeysInterface,
-		F::Target: FeeEstimator,
-		L::Target: Logger,
+		where
+			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
+			T::Target: BroadcasterInterface,
+			K::Target: KeysInterface,
+			F::Target: FeeEstimator,
+			L::Target: Logger,
 {
 	_create_invoice_from_channelmanager_and_duration_since_epoch(
 		channelmanager, keys_manager, logger, network, amt_msat,
@@ -316,12 +316,12 @@ pub fn create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T:
 	network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
 	invoice_expiry_delta_secs: u32
 ) -> Result<Invoice, SignOrCreationError<()>>
-	where
-		M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
-		T::Target: BroadcasterInterface,
-		K::Target: KeysInterface,
-		F::Target: FeeEstimator,
-		L::Target: Logger,
+		where
+			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
+			T::Target: BroadcasterInterface,
+			K::Target: KeysInterface,
+			F::Target: FeeEstimator,
+			L::Target: Logger,
 {
 	_create_invoice_from_channelmanager_and_duration_since_epoch(
 		channelmanager, keys_manager, logger, network, amt_msat,
@@ -337,12 +337,12 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Der
 	network: Currency, amt_msat: Option<u64>, description: InvoiceDescription,
 	duration_since_epoch: Duration, invoice_expiry_delta_secs: u32
 ) -> Result<Invoice, SignOrCreationError<()>>
-	where
-		M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
-		T::Target: BroadcasterInterface,
-		K::Target: KeysInterface,
-		F::Target: FeeEstimator,
-		L::Target: Logger,
+		where
+			M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
+			T::Target: BroadcasterInterface,
+			K::Target: KeysInterface,
+			F::Target: FeeEstimator,
+			L::Target: Logger,
 {
 	// `create_inbound_payment` only returns an error if the amount is greater than the total bitcoin
 	// supply.
@@ -354,8 +354,9 @@ fn _create_invoice_from_channelmanager_and_duration_since_epoch<M: Deref, T: Der
 }
 
 /// See [`create_invoice_from_channelmanager_and_duration_since_epoch`]
-///Function that allows to construct invoices with the given payment hash.
-///This may be useful if you're building an on-chain swap or integrating with another protocol where the payment hash is fixed outside of lightning.
+/// This version allows for providing a custom [`PaymentHash`] for the invoice.
+/// This may be useful if you're building an on-chain swap or involving another protocol where
+/// the payment hash is also involved outside the scope of lightning.
 pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 	channelmanager: &ChannelManager<M, T, K, F, L>, keys_manager: K, logger: L,
 	network: Currency, amt_msat: Option<u64>, description: String, duration_since_epoch: Duration,
@@ -369,7 +370,7 @@ pub fn create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_
 		L::Target: Logger,
 {
 	let payment_secret = channelmanager
-		.create_inbound_payment_for_hash(payment_hash,amt_msat,invoice_expiry_delta_secs)
+		.create_inbound_payment_for_hash(payment_hash,amt_msat, invoice_expiry_delta_secs)
 		.map_err(|()| SignOrCreationError::CreationError(CreationError::InvalidAmount))?;
 	_create_invoice_from_channelmanager_and_duration_since_epoch_with_payment_hash(
 		channelmanager, keys_manager, logger, network, amt_msat,