rename UnifiedQRPayment to UnifiedPayment, rename QRPaymentResult to UnifiedPaymentResult

These renamings are necessary to reflect the expanded responsibilities for this module.

Author: chuksys

bindings/ldk_node.udl

@@ -130,7 +130,7 @@ interface Node {
 	Bolt12Payment bolt12_payment();
 	SpontaneousPayment spontaneous_payment();
 	OnchainPayment onchain_payment();
-	UnifiedQrPayment unified_qr_payment();
+	UnifiedPayment unified_payment();
 	LSPS1Liquidity lsps1_liquidity();
 	[Throws=NodeError]
 	void connect(PublicKey node_id, SocketAddress address, boolean persist);
@@ -252,11 +252,11 @@ interface FeeRate {
 	u64 to_sat_per_vb_ceil();
 };
 
-interface UnifiedQrPayment {
+interface UnifiedPayment {
 	[Throws=NodeError]
 	string receive(u64 amount_sats, [ByRef]string message, u32 expiry_sec);
 	[Throws=NodeError]
-	QrPaymentResult send([ByRef]string uri_str);
+	UnifiedPaymentResult send([ByRef]string uri_str);
 };
 
 interface LSPS1Liquidity {
@@ -431,7 +431,7 @@ interface PaymentKind {
 };
 
 [Enum]
-interface QrPaymentResult {
+interface UnifiedPaymentResult {
 	Onchain(Txid txid);
 	Bolt11(PaymentId payment_id);
 	Bolt12(PaymentId payment_id);

src/ffi/types.rs

@@ -54,9 +54,51 @@ pub use crate::logger::{LogLevel, LogRecord, LogWriter};
 pub use crate::payment::store::{
 	ConfirmationStatus, LSPFeeLimits, PaymentDirection, PaymentKind, PaymentStatus,
 };
-pub use crate::payment::QrPaymentResult;
+pub use crate::payment::UnifiedPaymentResult;
+
+pub use lightning::chain::channelmonitor::BalanceSource;
+pub use lightning::events::{ClosureReason, PaymentFailureReason};
+pub use lightning::ln::types::ChannelId;
+pub use lightning::offers::offer::OfferId;
+pub use lightning::routing::gossip::{NodeAlias, NodeId, RoutingFees};
+pub use lightning::routing::router::RouteParametersConfig;
+pub use lightning_types::string::UntrustedString;
+
+pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
+
+pub use lightning_invoice::{Description, SignedRawBolt11Invoice};
+
+pub use lightning_liquidity::lsps0::ser::LSPSDateTime;
+pub use lightning_liquidity::lsps1::msgs::{
+	LSPS1ChannelInfo, LSPS1OrderId, LSPS1OrderParams, LSPS1PaymentState,
+};
+
+pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};
+
+pub use bip39::Mnemonic;
+
+pub use vss_client::headers::{VssHeaderProvider, VssHeaderProviderError};
+
+use crate::builder::sanitize_alias;
+use crate::error::Error;
 use crate::{hex_utils, SocketAddress, UniffiCustomTypeConverter, UserChannelId};
 
+use bitcoin::hashes::sha256::Hash as Sha256;
+use bitcoin::hashes::Hash;
+use bitcoin::secp256k1::PublicKey;
+use lightning::ln::channelmanager::PaymentId;
+use lightning::offers::invoice::Bolt12Invoice as LdkBolt12Invoice;
+use lightning::offers::offer::{Amount as LdkAmount, Offer as LdkOffer};
+use lightning::offers::refund::Refund as LdkRefund;
+use lightning::util::ser::Writeable;
+use lightning_invoice::{Bolt11Invoice as LdkBolt11Invoice, Bolt11InvoiceDescriptionRef};
+
+use std::convert::TryInto;
+use std::ops::Deref;
+use std::str::FromStr;
+use std::sync::Arc;
+use std::time::Duration;
+
 impl UniffiCustomTypeConverter for PublicKey {
 	type Builtin = String;
 

src/lib.rs

@@ -131,25 +131,13 @@ use gossip::GossipSource;
 use graph::NetworkGraph;
 pub use io::utils::generate_entropy_mnemonic;
 use io::utils::write_node_metrics;
-use lightning::chain::BestBlock;
-use lightning::events::bump_transaction::Wallet as LdkWallet;
-use lightning::impl_writeable_tlv_based;
-use lightning::ln::channel_state::ChannelShutdownState;
-use lightning::ln::channelmanager::PaymentId;
-use lightning::ln::msgs::SocketAddress;
-use lightning::routing::gossip::NodeAlias;
-use lightning::util::persist::KVStoreSync;
-use lightning_background_processor::process_events_async;
 use liquidity::{LSPS1Liquidity, LiquiditySource};
-use logger::{log_debug, log_error, log_info, log_trace, LdkLogger, Logger};
-use payment::asynchronous::om_mailbox::OnionMessageMailbox;
 use payment::asynchronous::static_invoice_store::StaticInvoiceStore;
 use payment::{
 	Bolt11Payment, Bolt12Payment, OnchainPayment, PaymentDetails, SpontaneousPayment,
-	UnifiedQrPayment,
+	UnifiedPayment,
 };
 use peer_store::{PeerInfo, PeerStore};
-use rand::Rng;
 use runtime::Runtime;
 use types::{
 	Broadcaster, BumpTransactionEventHandler, ChainMonitor, ChannelManager, Graph, KeysManager,
@@ -159,6 +147,18 @@ pub use types::{
 	ChannelDetails, CustomTlvRecord, DynStore, PeerDetails, SyncAndAsyncKVStore, UserChannelId,
 };
 
+use lightning::chain::BestBlock;
+use lightning::events::bump_transaction::Wallet as LdkWallet;
+use lightning::impl_writeable_tlv_based;
+use lightning::ln::channel_state::ChannelShutdownState;
+use lightning::ln::channelmanager::PaymentId;
+use lightning::ln::msgs::SocketAddress;
+use lightning::routing::gossip::NodeAlias;
+use lightning::util::persist::KVStoreSync;
+use lightning_background_processor::process_events_async;
+use logger::{log_debug, log_error, log_info, log_trace, LdkLogger, Logger};
+use payment::asynchronous::om_mailbox::OnionMessageMailbox;
+use rand::Rng;
 pub use {
 	bip39, bitcoin, lightning, lightning_invoice, lightning_liquidity, lightning_types, tokio,
 	vss_client,
@@ -927,12 +927,15 @@ impl Node {
 	/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
 	/// and [BOLT 12] payment options.
 	///
+	/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
+	///
 	/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 	/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
 	/// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
+	/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
 	#[cfg(not(feature = "uniffi"))]
-	pub fn unified_qr_payment(&self) -> UnifiedQrPayment {
-		UnifiedQrPayment::new(
+	pub fn unified_payment(&self) -> UnifiedPayment {
+		UnifiedPayment::new(
 			self.onchain_payment().into(),
 			self.bolt11_payment().into(),
 			self.bolt12_payment().into(),
@@ -944,12 +947,15 @@ impl Node {
 	/// Returns a payment handler allowing to create [BIP 21] URIs with an on-chain, [BOLT 11],
 	/// and [BOLT 12] payment options.
 	///
+	/// This handler allows you to send payments to these URIs as well as [BIP 353] HRNs.
+	///
 	/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 	/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
 	/// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
+	/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
 	#[cfg(feature = "uniffi")]
-	pub fn unified_qr_payment(&self) -> Arc<UnifiedQrPayment> {
-		Arc::new(UnifiedQrPayment::new(
+	pub fn unified_payment(&self) -> Arc<UnifiedPayment> {
+		Arc::new(UnifiedPayment::new(
 			self.onchain_payment(),
 			self.bolt11_payment(),
 			self.bolt12_payment(),

src/payment/mod.rs

@@ -22,4 +22,4 @@ pub use spontaneous::SpontaneousPayment;
 pub use store::{
 	ConfirmationStatus, LSPFeeLimits, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
 };
-pub use unified::{QrPaymentResult, UnifiedQrPayment};
+pub use unified::{UnifiedPayment, UnifiedPaymentResult};

src/payment/unified.rs

@@ -45,15 +45,15 @@ struct Extras {
 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 /// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
 /// [`Node::unified_qr_payment`]: crate::Node::unified_qr_payment
-pub struct UnifiedQrPayment {
+pub struct UnifiedPayment {
 	onchain_payment: Arc<OnchainPayment>,
 	bolt11_invoice: Arc<Bolt11Payment>,
 	bolt12_payment: Arc<Bolt12Payment>,
 	config: Arc<Config>,
 	logger: Arc<Logger>,
 }
 
-impl UnifiedQrPayment {
+impl UnifiedPayment {
 	pub(crate) fn new(
 		onchain_payment: Arc<OnchainPayment>, bolt11_invoice: Arc<Bolt11Payment>,
 		bolt12_payment: Arc<Bolt12Payment>, config: Arc<Config>, logger: Arc<Logger>,
@@ -138,7 +138,7 @@ impl UnifiedQrPayment {
 	/// occurs, an `Error` is returned detailing the issue encountered.
 	///
 	/// [BIP 21]: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki
-	pub fn send(&self, uri_str: &str) -> Result<QrPaymentResult, Error> {
+	pub fn send(&self, uri_str: &str) -> Result<UnifiedPaymentResult, Error> {
 		let uri: bip21::Uri<NetworkUnchecked, Extras> =
 			uri_str.parse().map_err(|_| Error::InvalidUri)?;
 
@@ -148,15 +148,15 @@ impl UnifiedQrPayment {
 		if let Some(offer) = uri_network_checked.extras.bolt12_offer {
 			let offer = maybe_wrap(offer);
 			match self.bolt12_payment.send(&offer, None, None) {
-				Ok(payment_id) => return Ok(QrPaymentResult::Bolt12 { payment_id }),
+				Ok(payment_id) => return Ok(UnifiedPaymentResult::Bolt12 { payment_id }),
 				Err(e) => log_error!(self.logger, "Failed to send BOLT12 offer: {:?}. This is part of a unified QR code payment. Falling back to the BOLT11 invoice.", e),
 			}
 		}
 
 		if let Some(invoice) = uri_network_checked.extras.bolt11_invoice {
 			let invoice = maybe_wrap(invoice);
 			match self.bolt11_invoice.send(&invoice, None) {
-				Ok(payment_id) => return Ok(QrPaymentResult::Bolt11 { payment_id }),
+				Ok(payment_id) => return Ok(UnifiedPaymentResult::Bolt11 { payment_id }),
 				Err(e) => log_error!(self.logger, "Failed to send BOLT11 invoice: {:?}. This is part of a unified QR code payment. Falling back to the on-chain transaction.", e),
 			}
 		}
@@ -175,7 +175,7 @@ impl UnifiedQrPayment {
 			None,
 		)?;
 
-		Ok(QrPaymentResult::Onchain { txid })
+		Ok(UnifiedPaymentResult::Onchain { txid })
 	}
 }
 
@@ -188,7 +188,7 @@ impl UnifiedQrPayment {
 /// [`PaymentId`]: lightning::ln::channelmanager::PaymentId
 /// [`Txid`]: bitcoin::hash_types::Txid
 #[derive(Debug)]
-pub enum QrPaymentResult {
+pub enum UnifiedPaymentResult {
 	/// An on-chain payment.
 	Onchain {
 		/// The transaction ID (txid) of the on-chain payment.
@@ -302,9 +302,8 @@ impl DeserializationError for Extras {
 
 #[cfg(test)]
 mod tests {
-	use super::*;
-	use crate::payment::unified::Extras;
-	use bitcoin::{Address, Network};
+	use super::{Amount, Bolt11Invoice, Extras, Offer};
+	use bitcoin::{address::NetworkUnchecked, Address, Network};
 	use std::str::FromStr;
 
 	#[test]

tests/integration_tests_rust.rs

@@ -6,7 +6,7 @@
 // accordance with one or both of these licenses.
 
 mod common;
-
+use lightning::util::persist::KVStoreSync;
 use std::collections::HashSet;
 use std::str::FromStr;
 use std::sync::Arc;
@@ -29,7 +29,7 @@ use ldk_node::config::{AsyncPaymentsRole, EsploraSyncConfig};
 use ldk_node::liquidity::LSPS2ServiceConfig;
 use ldk_node::payment::{
 	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
-	QrPaymentResult,
+	UnifiedPaymentResult,
 };
 use ldk_node::{Builder, DynStore, Event, NodeError};
 use lightning::ln::channelmanager::PaymentId;
@@ -1392,15 +1392,15 @@ async fn generate_bip21_uri() {
 
 	// Test 1: Verify URI generation (on-chain + BOLT11) works
 	// even before any channels are opened. This checks the graceful fallback behavior.
-	let initial_uqr_payment = node_b
-		.unified_qr_payment()
+	let initial_uni_payment = node_b
+		.unified_payment()
 		.receive(expected_amount_sats, "asdf", expiry_sec)
 		.expect("Failed to generate URI");
-	println!("Initial URI (no channels): {}", initial_uqr_payment);
+	println!("Initial URI (no channels): {}", initial_uni_payment);
 
-	assert!(initial_uqr_payment.contains("bitcoin:"));
-	assert!(initial_uqr_payment.contains("lightning="));
-	assert!(!initial_uqr_payment.contains("lno=")); // BOLT12 requires channels
+	assert!(initial_uni_payment.contains("bitcoin:"));
+	assert!(initial_uni_payment.contains("lightning="));
+	assert!(!initial_uni_payment.contains("lno=")); // BOLT12 requires channels
 
 	premine_and_distribute_funds(
 		&bitcoind.client,
@@ -1421,15 +1421,15 @@ async fn generate_bip21_uri() {
 	expect_channel_ready_event!(node_b, node_a.node_id());
 
 	// Test 2: Verify URI generation (on-chain + BOLT11 + BOLT12) works after channels are established.
-	let uqr_payment = node_b
-		.unified_qr_payment()
+	let uni_payment = node_b
+		.unified_payment()
 		.receive(expected_amount_sats, "asdf", expiry_sec)
 		.expect("Failed to generate URI");
 
-	println!("Generated URI: {}", uqr_payment);
-	assert!(uqr_payment.contains("bitcoin:"));
-	assert!(uqr_payment.contains("lightning="));
-	assert!(uqr_payment.contains("lno="));
+	println!("Generated URI: {}", uni_payment);
+	assert!(uni_payment.contains("bitcoin:"));
+	assert!(uni_payment.contains("lightning="));
+	assert!(uni_payment.contains("lno="));
 }
 
 #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
@@ -1471,17 +1471,17 @@ async fn unified_qr_send_receive() {
 	let expected_amount_sats = 100_000;
 	let expiry_sec = 4_000;
 
-	let uqr_payment = node_b.unified_qr_payment().receive(expected_amount_sats, "asdf", expiry_sec);
-	let uri_str = uqr_payment.clone().unwrap();
-	let offer_payment_id: PaymentId = match node_a.unified_qr_payment().send(&uri_str) {
-		Ok(QrPaymentResult::Bolt12 { payment_id }) => {
+	let uni_payment = node_b.unified_payment().receive(expected_amount_sats, "asdf", expiry_sec);
+	let uri_str = uni_payment.clone().unwrap();
+	let offer_payment_id: PaymentId = match node_a.unified_payment().send(&uri_str) {
+		Ok(UnifiedPaymentResult::Bolt12 { payment_id }) => {
 			println!("\nBolt12 payment sent successfully with PaymentID: {:?}", payment_id);
 			payment_id
 		},
-		Ok(QrPaymentResult::Bolt11 { payment_id: _ }) => {
+		Ok(UnifiedPaymentResult::Bolt11 { payment_id: _ }) => {
 			panic!("Expected Bolt12 payment but got Bolt11");
 		},
-		Ok(QrPaymentResult::Onchain { txid: _ }) => {
+		Ok(UnifiedPaymentResult::Onchain { txid: _ }) => {
 			panic!("Expected Bolt12 payment but get On-chain transaction");
 		},
 		Err(e) => {
@@ -1493,38 +1493,37 @@ async fn unified_qr_send_receive() {
 
 	// Cut off the BOLT12 part to fallback to BOLT11.
 	let uri_str_without_offer = uri_str.split("&lno=").next().unwrap();
-	let invoice_payment_id: PaymentId =
-		match node_a.unified_qr_payment().send(uri_str_without_offer) {
-			Ok(QrPaymentResult::Bolt12 { payment_id: _ }) => {
-				panic!("Expected Bolt11 payment but got Bolt12");
-			},
-			Ok(QrPaymentResult::Bolt11 { payment_id }) => {
-				println!("\nBolt11 payment sent successfully with PaymentID: {:?}", payment_id);
-				payment_id
-			},
-			Ok(QrPaymentResult::Onchain { txid: _ }) => {
-				panic!("Expected Bolt11 payment but got on-chain transaction");
-			},
-			Err(e) => {
-				panic!("Expected Bolt11 payment but got error: {:?}", e);
-			},
-		};
+	let invoice_payment_id: PaymentId = match node_a.unified_payment().send(uri_str_without_offer) {
+		Ok(UnifiedPaymentResult::Bolt12 { payment_id: _ }) => {
+			panic!("Expected Bolt11 payment but got Bolt12");
+		},
+		Ok(UnifiedPaymentResult::Bolt11 { payment_id }) => {
+			println!("\nBolt11 payment sent successfully with PaymentID: {:?}", payment_id);
+			payment_id
+		},
+		Ok(UnifiedPaymentResult::Onchain { txid: _ }) => {
+			panic!("Expected Bolt11 payment but got on-chain transaction");
+		},
+		Err(e) => {
+			panic!("Expected Bolt11 payment but got error: {:?}", e);
+		},
+	};
 	expect_payment_successful_event!(node_a, Some(invoice_payment_id), None);
 
 	let expect_onchain_amount_sats = 800_000;
-	let onchain_uqr_payment =
-		node_b.unified_qr_payment().receive(expect_onchain_amount_sats, "asdf", 4_000).unwrap();
+	let onchain_uni_payment =
+		node_b.unified_payment().receive(expect_onchain_amount_sats, "asdf", 4_000).unwrap();
 
 	// Cut off any lightning part to fallback to on-chain only.
-	let uri_str_without_lightning = onchain_uqr_payment.split("&lightning=").next().unwrap();
-	let txid = match node_a.unified_qr_payment().send(&uri_str_without_lightning) {
-		Ok(QrPaymentResult::Bolt12 { payment_id: _ }) => {
+	let uri_str_without_lightning = onchain_uni_payment.split("&lightning=").next().unwrap();
+	let txid = match node_a.unified_payment().send(&uri_str_without_lightning) {
+		Ok(UnifiedPaymentResult::Bolt12 { payment_id: _ }) => {
 			panic!("Expected on-chain payment but got Bolt12")
 		},
-		Ok(QrPaymentResult::Bolt11 { payment_id: _ }) => {
+		Ok(UnifiedPaymentResult::Bolt11 { payment_id: _ }) => {
 			panic!("Expected on-chain payment but got Bolt11");
 		},
-		Ok(QrPaymentResult::Onchain { txid }) => {
+		Ok(UnifiedPaymentResult::Onchain { txid }) => {
 			println!("\nOn-chain transaction successful with Txid: {}", txid);
 			txid
 		},