Skip to content

[develop] Upgrade to latest RL and drop BOLT 12 quantity #642

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[develop] Upgrade to latest RL and drop BOLT 12 quantity #642

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f07d15b
Drop `quantity` support from BOLT 12 logic
TheBlueMatt Sep 20, 2025
949287b
Update to latest upstream LDK
TheBlueMatt Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,17 +199,17 @@ interface Bolt11Payment {

interface Bolt12Payment {
[Throws=NodeError]
PaymentId send([ByRef]Offer offer, u64? quantity, string? payer_note);
PaymentId send([ByRef]Offer offer, string? payer_note);
[Throws=NodeError]
PaymentId send_using_amount([ByRef]Offer offer, u64 amount_msat, u64? quantity, string? payer_note);
PaymentId send_using_amount([ByRef]Offer offer, u64 amount_msat, string? payer_note);
[Throws=NodeError]
Offer receive(u64 amount_msat, [ByRef]string description, u32? expiry_secs, u64? quantity);
Offer receive(u64 amount_msat, [ByRef]string description, u32? expiry_secs);
[Throws=NodeError]
Offer receive_variable_amount([ByRef]string description, u32? expiry_secs);
[Throws=NodeError]
Bolt12Invoice request_refund_payment([ByRef]Refund refund);
[Throws=NodeError]
Refund initiate_refund(u64 amount_msat, u32 expiry_secs, u64? quantity, string? payer_note);
Refund initiate_refund(u64 amount_msat, u32 expiry_secs, string? payer_note);
[Throws=NodeError]
Offer receive_async();
[Throws=NodeError]
Expand Down Expand Up @@ -422,8 +422,8 @@ interface PaymentKind {
Onchain(Txid txid, ConfirmationStatus status);
Bolt11(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret);
Bolt11Jit(PaymentHash hash, PaymentPreimage? preimage, PaymentSecret? secret, u64? counterparty_skimmed_fee_msat, LSPFeeLimits lsp_fee_limits);
Bolt12Offer(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, OfferId offer_id, UntrustedString? payer_note, u64? quantity);
Bolt12Refund(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, UntrustedString? payer_note, u64? quantity);
Bolt12Offer(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, OfferId offer_id, UntrustedString? payer_note);
Bolt12Refund(PaymentHash? hash, PaymentPreimage? preimage, PaymentSecret? secret, UntrustedString? payer_note);
Spontaneous(PaymentHash hash, PaymentPreimage? preimage);
};

Expand Down
38 changes: 16 additions & 22 deletions bindings/swift/Sources/LDKNode/LDKNode.swift
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please drop these changes to the static Swift files. These will only be updated/regenerated during release (though here on develop it doesn't matter as much as on main, which are actually part of the SwiftPM dependency).

Original file line number Diff line number Diff line change
Expand Up @@ -1015,17 +1015,17 @@ public func FfiConverterTypeBolt11Payment_lower(_ value: Bolt11Payment) -> Unsaf

public protocol Bolt12PaymentProtocol : AnyObject {

func initiateRefund(amountMsat: UInt64, expirySecs: UInt32, quantity: UInt64?, payerNote: String?) throws -> Refund
func initiateRefund(amountMsat: UInt64, expirySecs: UInt32, payerNote: String?) throws -> Refund

func receive(amountMsat: UInt64, description: String, expirySecs: UInt32?, quantity: UInt64?) throws -> Offer
func receive(amountMsat: UInt64, description: String, expirySecs: UInt32?) throws -> Offer

func receiveVariableAmount(description: String, expirySecs: UInt32?) throws -> Offer

func requestRefundPayment(refund: Refund) throws -> Bolt12Invoice

func send(offer: Offer, quantity: UInt64?, payerNote: String?) throws -> PaymentId
func send(offer: Offer, payerNote: String?) throws -> PaymentId

func sendUsingAmount(offer: Offer, amountMsat: UInt64, quantity: UInt64?, payerNote: String?) throws -> PaymentId
func sendUsingAmount(offer: Offer, amountMsat: UInt64, payerNote: String?) throws -> PaymentId

}

Expand Down Expand Up @@ -1070,24 +1070,22 @@ open class Bolt12Payment:



open func initiateRefund(amountMsat: UInt64, expirySecs: UInt32, quantity: UInt64?, payerNote: String?)throws -> Refund {
open func initiateRefund(amountMsat: UInt64, expirySecs: UInt32, payerNote: String?)throws -> Refund {
return try FfiConverterTypeRefund.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
uniffi_ldk_node_fn_method_bolt12payment_initiate_refund(self.uniffiClonePointer(),
FfiConverterUInt64.lower(amountMsat),
FfiConverterUInt32.lower(expirySecs),
FfiConverterOptionUInt64.lower(quantity),
FfiConverterOptionString.lower(payerNote),$0
)
})
}

open func receive(amountMsat: UInt64, description: String, expirySecs: UInt32?, quantity: UInt64?)throws -> Offer {
open func receive(amountMsat: UInt64, description: String, expirySecs: UInt32?)throws -> Offer {
return try FfiConverterTypeOffer.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
uniffi_ldk_node_fn_method_bolt12payment_receive(self.uniffiClonePointer(),
FfiConverterUInt64.lower(amountMsat),
FfiConverterString.lower(description),
FfiConverterOptionUInt32.lower(expirySecs),
FfiConverterOptionUInt64.lower(quantity),$0
FfiConverterOptionUInt32.lower(expirySecs),$0
)
})
}
Expand All @@ -1109,22 +1107,20 @@ open func requestRefundPayment(refund: Refund)throws -> Bolt12Invoice {
})
}

open func send(offer: Offer, quantity: UInt64?, payerNote: String?)throws -> PaymentId {
open func send(offer: Offer, payerNote: String?)throws -> PaymentId {
return try FfiConverterTypePaymentId.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
uniffi_ldk_node_fn_method_bolt12payment_send(self.uniffiClonePointer(),
FfiConverterTypeOffer.lower(offer),
FfiConverterOptionUInt64.lower(quantity),
FfiConverterOptionString.lower(payerNote),$0
)
})
}

open func sendUsingAmount(offer: Offer, amountMsat: UInt64, quantity: UInt64?, payerNote: String?)throws -> PaymentId {
open func sendUsingAmount(offer: Offer, amountMsat: UInt64, payerNote: String?)throws -> PaymentId {
return try FfiConverterTypePaymentId.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
uniffi_ldk_node_fn_method_bolt12payment_send_using_amount(self.uniffiClonePointer(),
FfiConverterTypeOffer.lower(offer),
FfiConverterUInt64.lower(amountMsat),
FfiConverterOptionUInt64.lower(quantity),
FfiConverterOptionString.lower(payerNote),$0
)
})
Expand Down Expand Up @@ -7098,9 +7094,9 @@ public enum PaymentKind {
)
case bolt11Jit(hash: PaymentHash, preimage: PaymentPreimage?, secret: PaymentSecret?, counterpartySkimmedFeeMsat: UInt64?, lspFeeLimits: LspFeeLimits
)
case bolt12Offer(hash: PaymentHash?, preimage: PaymentPreimage?, secret: PaymentSecret?, offerId: OfferId, payerNote: UntrustedString?, quantity: UInt64?
case bolt12Offer(hash: PaymentHash?, preimage: PaymentPreimage?, secret: PaymentSecret?, offerId: OfferId, payerNote: UntrustedString?
)
case bolt12Refund(hash: PaymentHash?, preimage: PaymentPreimage?, secret: PaymentSecret?, payerNote: UntrustedString?, quantity: UInt64?
case bolt12Refund(hash: PaymentHash?, preimage: PaymentPreimage?, secret: PaymentSecret?, payerNote: UntrustedString?
)
case spontaneous(hash: PaymentHash, preimage: PaymentPreimage?
)
Expand All @@ -7123,10 +7119,10 @@ public struct FfiConverterTypePaymentKind: FfiConverterRustBuffer {
case 3: return .bolt11Jit(hash: try FfiConverterTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf), secret: try FfiConverterOptionTypePaymentSecret.read(from: &buf), counterpartySkimmedFeeMsat: try FfiConverterOptionUInt64.read(from: &buf), lspFeeLimits: try FfiConverterTypeLSPFeeLimits.read(from: &buf)
)

case 4: return .bolt12Offer(hash: try FfiConverterOptionTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf), secret: try FfiConverterOptionTypePaymentSecret.read(from: &buf), offerId: try FfiConverterTypeOfferId.read(from: &buf), payerNote: try FfiConverterOptionTypeUntrustedString.read(from: &buf), quantity: try FfiConverterOptionUInt64.read(from: &buf)
case 4: return .bolt12Offer(hash: try FfiConverterOptionTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf), secret: try FfiConverterOptionTypePaymentSecret.read(from: &buf), offerId: try FfiConverterTypeOfferId.read(from: &buf), payerNote: try FfiConverterOptionTypeUntrustedString.read(from: &buf)
)

case 5: return .bolt12Refund(hash: try FfiConverterOptionTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf), secret: try FfiConverterOptionTypePaymentSecret.read(from: &buf), payerNote: try FfiConverterOptionTypeUntrustedString.read(from: &buf), quantity: try FfiConverterOptionUInt64.read(from: &buf)
case 5: return .bolt12Refund(hash: try FfiConverterOptionTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf), secret: try FfiConverterOptionTypePaymentSecret.read(from: &buf), payerNote: try FfiConverterOptionTypeUntrustedString.read(from: &buf)
)

case 6: return .spontaneous(hash: try FfiConverterTypePaymentHash.read(from: &buf), preimage: try FfiConverterOptionTypePaymentPreimage.read(from: &buf)
Expand Down Expand Up @@ -7162,23 +7158,21 @@ public struct FfiConverterTypePaymentKind: FfiConverterRustBuffer {
FfiConverterTypeLSPFeeLimits.write(lspFeeLimits, into: &buf)


case let .bolt12Offer(hash,preimage,secret,offerId,payerNote,quantity):
case let .bolt12Offer(hash,preimage,secret,offerId,payerNote):
writeInt(&buf, Int32(4))
FfiConverterOptionTypePaymentHash.write(hash, into: &buf)
FfiConverterOptionTypePaymentPreimage.write(preimage, into: &buf)
FfiConverterOptionTypePaymentSecret.write(secret, into: &buf)
FfiConverterTypeOfferId.write(offerId, into: &buf)
FfiConverterOptionTypeUntrustedString.write(payerNote, into: &buf)
FfiConverterOptionUInt64.write(quantity, into: &buf)


case let .bolt12Refund(hash,preimage,secret,payerNote,quantity):
case let .bolt12Refund(hash,preimage,secret,payerNote):
writeInt(&buf, Int32(5))
FfiConverterOptionTypePaymentHash.write(hash, into: &buf)
FfiConverterOptionTypePaymentPreimage.write(preimage, into: &buf)
FfiConverterOptionTypePaymentSecret.write(secret, into: &buf)
FfiConverterOptionTypeUntrustedString.write(payerNote, into: &buf)
FfiConverterOptionUInt64.write(quantity, into: &buf)


case let .spontaneous(hash,preimage):
Expand Down Expand Up @@ -9840,4 +9834,4 @@ private func uniffiEnsureInitialized() {
}
}

// swiftlint:enable all
// swiftlint:enable all
2 changes: 0 additions & 2 deletions src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,14 +742,12 @@ where
} => {
let payer_note = payment_context.invoice_request.payer_note_truncated;
let offer_id = payment_context.offer_id;
let quantity = payment_context.invoice_request.quantity;
let kind = PaymentKind::Bolt12Offer {
hash: Some(payment_hash),
preimage: payment_preimage,
secret: Some(payment_secret),
offer_id,
payer_note,
quantity,
};

let payment = PaymentDetails::new(
Expand Down
46 changes: 10 additions & 36 deletions src/payment/bolt12.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::types::{ChannelManager, PaymentStore};

use lightning::blinded_path::message::BlindedMessagePath;
use lightning::ln::channelmanager::{PaymentId, Retry};
use lightning::offers::offer::{Amount, Offer as LdkOffer, Quantity};
use lightning::offers::offer::{Amount, Offer as LdkOffer};
use lightning::offers::parse::Bolt12SemanticError;
use lightning::routing::router::RouteParametersConfig;

Expand All @@ -28,7 +28,6 @@ use lightning_types::string::UntrustedString;

use rand::RngCore;

use std::num::NonZeroU64;
use std::sync::{Arc, RwLock};
use std::time::{Duration, SystemTime, UNIX_EPOCH};

Expand Down Expand Up @@ -73,11 +72,7 @@ impl Bolt12Payment {
///
/// If `payer_note` is `Some` it will be seen by the recipient and reflected back in the invoice
/// response.
///
/// If `quantity` is `Some` it represents the number of items requested.
pub fn send(
&self, offer: &Offer, quantity: Option<u64>, payer_note: Option<String>,
) -> Result<PaymentId, Error> {
pub fn send(&self, offer: &Offer, payer_note: Option<String>) -> Result<PaymentId, Error> {
if !*self.is_running.read().unwrap() {
return Err(Error::NotRunning);
}
Expand All @@ -104,7 +99,7 @@ impl Bolt12Payment {

match self.channel_manager.pay_for_offer(
&offer,
quantity,
if offer.expects_quantity() { Some(1) } else { None },
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this do the right thing internally w.r.t Quantity::One vs Quantity::Bounded(1)?

None,
payer_note.clone(),
payment_id,
Expand All @@ -126,7 +121,6 @@ impl Bolt12Payment {
secret: None,
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
};
let payment = PaymentDetails::new(
payment_id,
Expand All @@ -151,7 +145,6 @@ impl Bolt12Payment {
secret: None,
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
};
let payment = PaymentDetails::new(
payment_id,
Expand Down Expand Up @@ -179,7 +172,7 @@ impl Bolt12Payment {
/// If `payer_note` is `Some` it will be seen by the recipient and reflected back in the invoice
/// response.
pub fn send_using_amount(
&self, offer: &Offer, amount_msat: u64, quantity: Option<u64>, payer_note: Option<String>,
&self, offer: &Offer, amount_msat: u64, payer_note: Option<String>,
) -> Result<PaymentId, Error> {
if !*self.is_running.read().unwrap() {
return Err(Error::NotRunning);
Expand Down Expand Up @@ -211,7 +204,7 @@ impl Bolt12Payment {

match self.channel_manager.pay_for_offer(
&offer,
quantity,
if offer.expects_quantity() { Some(1) } else { None },
Some(amount_msat),
payer_note.clone(),
payment_id,
Expand All @@ -233,7 +226,6 @@ impl Bolt12Payment {
secret: None,
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
};
let payment = PaymentDetails::new(
payment_id,
Expand All @@ -258,7 +250,6 @@ impl Bolt12Payment {
secret: None,
offer_id: offer.id(),
payer_note: payer_note.map(UntrustedString),
quantity,
};
let payment = PaymentDetails::new(
payment_id,
Expand All @@ -277,7 +268,7 @@ impl Bolt12Payment {
}

pub(crate) fn receive_inner(
&self, amount_msat: u64, description: &str, expiry_secs: Option<u32>, quantity: Option<u64>,
&self, amount_msat: u64, description: &str, expiry_secs: Option<u32>,
) -> Result<LdkOffer, Error> {
let mut offer_builder = self.channel_manager.create_offer_builder().map_err(|e| {
log_error!(self.logger, "Failed to create offer builder: {:?}", e);
Expand All @@ -291,17 +282,7 @@ impl Bolt12Payment {
offer_builder = offer_builder.absolute_expiry(absolute_expiry);
}

let mut offer =
offer_builder.amount_msats(amount_msat).description(description.to_string());

if let Some(qty) = quantity {
if qty == 0 {
log_error!(self.logger, "Failed to create offer: quantity can't be zero.");
return Err(Error::InvalidQuantity);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can now also drop the InvalidQuantity error variant.

} else {
offer = offer.supported_quantity(Quantity::Bounded(NonZeroU64::new(qty).unwrap()))
};
};
let offer = offer_builder.amount_msats(amount_msat).description(description.to_string());

let finalized_offer = offer.build().map_err(|e| {
log_error!(self.logger, "Failed to create offer: {:?}", e);
Expand All @@ -314,9 +295,9 @@ impl Bolt12Payment {
/// Returns a payable offer that can be used to request and receive a payment of the amount
/// given.
pub fn receive(
&self, amount_msat: u64, description: &str, expiry_secs: Option<u32>, quantity: Option<u64>,
&self, amount_msat: u64, description: &str, expiry_secs: Option<u32>,
) -> Result<Offer, Error> {
let offer = self.receive_inner(amount_msat, description, expiry_secs, quantity)?;
let offer = self.receive_inner(amount_msat, description, expiry_secs)?;
Ok(maybe_wrap(offer))
}

Expand Down Expand Up @@ -371,7 +352,6 @@ impl Bolt12Payment {
preimage: None,
secret: None,
payer_note: refund.payer_note().map(|note| UntrustedString(note.0.to_string())),
quantity: refund.quantity(),
};

let payment = PaymentDetails::new(
Expand All @@ -392,8 +372,7 @@ impl Bolt12Payment {
///
/// [`Refund`]: lightning::offers::refund::Refund
pub fn initiate_refund(
&self, amount_msat: u64, expiry_secs: u32, quantity: Option<u64>,
payer_note: Option<String>,
&self, amount_msat: u64, expiry_secs: u32, payer_note: Option<String>,
) -> Result<Refund, Error> {
let mut random_bytes = [0u8; 32];
rand::thread_rng().fill_bytes(&mut random_bytes);
Expand All @@ -419,10 +398,6 @@ impl Bolt12Payment {
Error::RefundCreationFailed
})?;

if let Some(qty) = quantity {
refund_builder = refund_builder.quantity(qty);
}

if let Some(note) = payer_note.clone() {
refund_builder = refund_builder.payer_note(note);
}
Expand All @@ -439,7 +414,6 @@ impl Bolt12Payment {
preimage: None,
secret: None,
payer_note: payer_note.map(|note| UntrustedString(note)),
quantity,
};
let payment = PaymentDetails::new(
payment_id,
Expand Down
12 changes: 2 additions & 10 deletions src/payment/store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,10 +413,6 @@ pub enum PaymentKind {
///
/// [`PAYER_NOTE_LIMIT`]: lightning::offers::invoice_request::PAYER_NOTE_LIMIT
payer_note: Option<UntrustedString>,
/// The quantity of an item requested in the offer.
///
/// This will always be `None` for payments serialized with version `v0.3.0`.
quantity: Option<u64>,
},
/// A [BOLT 12] 'refund' payment, i.e., a payment for a [`Refund`].
///
Expand All @@ -433,10 +429,6 @@ pub enum PaymentKind {
///
/// This will always be `None` for payments serialized with version `v0.3.0`.
payer_note: Option<UntrustedString>,
/// The quantity of an item that the refund is for.
///
/// This will always be `None` for payments serialized with version `v0.3.0`.
quantity: Option<u64>,
},
/// A spontaneous ("keysend") payment.
Spontaneous {
Expand Down Expand Up @@ -468,7 +460,7 @@ impl_writeable_tlv_based_enum!(PaymentKind,
(0, hash, option),
(1, payer_note, option),
(2, preimage, option),
(3, quantity, option),
// Type 3 was formerly the quantity
(4, secret, option),
(6, offer_id, required),
},
Expand All @@ -480,7 +472,7 @@ impl_writeable_tlv_based_enum!(PaymentKind,
(0, hash, option),
(1, payer_note, option),
(2, preimage, option),
(3, quantity, option),
// Type 3 was formerly the quantity
(4, secret, option),
}
);
Expand Down
Loading