Introduce Bolt12Payment API

Author: tnull

bindings/ldk_node.udl

@@ -54,6 +54,7 @@ interface Node {
 	PublicKey node_id();
 	sequence<SocketAddress>? listening_addresses();
 	Bolt11Payment bolt11_payment();
+	Bolt12Payment bolt12_payment();
 	SpontaneousPayment spontaneous_payment();
 	OnchainPayment onchain_payment();
 	[Throws=NodeError]
@@ -99,6 +100,17 @@ interface Bolt11Payment {
 	Bolt11Invoice receive_variable_amount_via_jit_channel([ByRef]string description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
 };
 
+interface Bolt12Payment {
+	[Throws=NodeError]
+	PaymentId send([ByRef]Offer offer, string? payer_note);
+	[Throws=NodeError]
+	PaymentId send_using_amount([ByRef]Offer offer, string? payer_note, u64 amount_msat);
+	[Throws=NodeError]
+	Offer receive(u64 amount_msat, [ByRef]string description);
+	[Throws=NodeError]
+	Offer receive_variable_amount([ByRef]string description);
+};
+
 interface SpontaneousPayment {
 	[Throws=NodeError]
 	PaymentId send(u64 amount_msat, PublicKey node_id);
@@ -122,6 +134,7 @@ enum NodeError {
 	"OnchainTxCreationFailed",
 	"ConnectionFailed",
 	"InvoiceCreationFailed",
+	"OfferCreationFailed",
 	"PaymentSendingFailed",
 	"ProbeSendingFailed",
 	"ChannelCreationFailed",
@@ -146,9 +159,11 @@ enum NodeError {
 	"InvalidPaymentSecret",
 	"InvalidAmount",
 	"InvalidInvoice",
+	"InvalidOffer",
 	"InvalidChannelId",
 	"InvalidNetwork",
 	"DuplicatePayment",
+	"UnsupportedCurrency",
 	"InsufficientFunds",
 	"LiquiditySourceUnavailable",
 	"LiquidityFeeTooHigh",
@@ -374,6 +389,9 @@ typedef string Address;
 [Custom]
 typedef string Bolt11Invoice;
 
+[Custom]
+typedef string Offer;
+
 [Custom]
 typedef string OfferId;
 

src/error.rs

@@ -13,6 +13,8 @@ pub enum Error {
 	ConnectionFailed,
 	/// Invoice creation failed.
 	InvoiceCreationFailed,
+	/// Offer creation failed.
+	OfferCreationFailed,
 	/// Sending a payment has failed.
 	PaymentSendingFailed,
 	/// Sending a payment probe has failed.
@@ -61,12 +63,16 @@ pub enum Error {
 	InvalidAmount,
 	/// The given invoice is invalid.
 	InvalidInvoice,
+	/// The given offer is invalid.
+	InvalidOffer,
 	/// The given channel ID is invalid.
 	InvalidChannelId,
 	/// The given network is invalid.
 	InvalidNetwork,
 	/// A payment with the given hash has already been initiated.
 	DuplicatePayment,
+	/// The provided offer was denonminated in an unsupported currency.
+	UnsupportedCurrency,
 	/// The available funds are insufficient to complete the given operation.
 	InsufficientFunds,
 	/// The given operation failed due to the required liquidity source being unavailable.
@@ -85,6 +91,7 @@ impl fmt::Display for Error {
 			},
 			Self::ConnectionFailed => write!(f, "Network connection closed."),
 			Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
+			Self::OfferCreationFailed => write!(f, "Failed to create offer."),
 			Self::PaymentSendingFailed => write!(f, "Failed to send the given payment."),
 			Self::ProbeSendingFailed => write!(f, "Failed to send the given payment probe."),
 			Self::ChannelCreationFailed => write!(f, "Failed to create channel."),
@@ -111,6 +118,7 @@ impl fmt::Display for Error {
 			Self::InvalidPaymentSecret => write!(f, "The given payment secret is invalid."),
 			Self::InvalidAmount => write!(f, "The given amount is invalid."),
 			Self::InvalidInvoice => write!(f, "The given invoice is invalid."),
+			Self::InvalidOffer => write!(f, "The given offer is invalid."),
 			Self::InvalidChannelId => write!(f, "The given channel ID is invalid."),
 			Self::InvalidNetwork => write!(f, "The given network is invalid."),
 			Self::DuplicatePayment => {
@@ -119,6 +127,9 @@ impl fmt::Display for Error {
 			Self::InsufficientFunds => {
 				write!(f, "The available funds are insufficient to complete the given operation.")
 			},
+			Self::UnsupportedCurrency => {
+				write!(f, "The provided offer was denonminated in an unsupported currency.")
+			},
 			Self::LiquiditySourceUnavailable => {
 				write!(f, "The given operation failed due to the required liquidity source being unavailable.")
 			},

src/lib.rs

@@ -130,7 +130,7 @@ use event::{EventHandler, EventQueue};
 use gossip::GossipSource;
 use liquidity::LiquiditySource;
 use payment::store::PaymentStore;
-use payment::{Bolt11Payment, OnchainPayment, PaymentDetails, SpontaneousPayment};
+use payment::{Bolt11Payment, Bolt12Payment, OnchainPayment, PaymentDetails, SpontaneousPayment};
 use peer_store::{PeerInfo, PeerStore};
 use types::{
 	Broadcaster, ChainMonitor, ChannelManager, DynStore, FeeEstimator, KeysManager, NetworkGraph,
@@ -846,6 +846,32 @@ impl Node {
 		))
 	}
 
+	/// Returns a payment handler allowing to create and pay [BOLT 12] offers and refunds.
+	///
+	/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
+	#[cfg(not(feature = "uniffi"))]
+	pub fn bolt12_payment(&self) -> Arc<Bolt12Payment> {
+		Arc::new(Bolt12Payment::new(
+			Arc::clone(&self.runtime),
+			Arc::clone(&self.channel_manager),
+			Arc::clone(&self.payment_store),
+			Arc::clone(&self.logger),
+		))
+	}
+
+	/// Returns a payment handler allowing to create and pay [BOLT 12] offers and refunds.
+	///
+	/// [BOLT 12]: https://github.com/lightning/bolts/blob/master/12-offer-encoding.md
+	#[cfg(feature = "uniffi")]
+	pub fn bolt12_payment(&self) -> Arc<Bolt12Payment> {
+		Arc::new(Bolt12Payment::new(
+			Arc::clone(&self.runtime),
+			Arc::clone(&self.channel_manager),
+			Arc::clone(&self.payment_store),
+			Arc::clone(&self.logger),
+		))
+	}
+
 	/// Returns a payment handler allowing to send spontaneous ("keysend") payments.
 	#[cfg(not(feature = "uniffi"))]
 	pub fn spontaneous_payment(&self) -> SpontaneousPayment {