mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 15:20:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Genericize BOLT 12 invoice{_builder} common macro docs over invoice type

Browse source 
Will be useful so the docs generated work for static invoices.
This commit is contained in:
Valentine Wallace 2024-05-22 16:13:10 -04:00
parent 7417406676
commit bbc15f56e9
No known key found for this signature in database
GPG key ID: FD3E106A2CE099B4
2 changed files with 23 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lightning/src/offers/invoice.rs
View file

@ -383,35 +383,35 @@ impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> { impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
invoice_builder_methods!(self, Self, Self, self, S, mut); invoice_builder_methods!(self, Self, Self, self, S, mut);
invoice_builder_methods_common!(self, Self, self.invoice.fields_mut(), Self, self, S, mut); invoice_builder_methods_common!(self, Self, self.invoice.fields_mut(), Self, self, S, Bolt12Invoice, mut);
} }
#[cfg(all(c_bindings, not(test)))] #[cfg(all(c_bindings, not(test)))]
impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> { impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self); invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey); invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey);
invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), ExplicitSigningPubkey); invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), ExplicitSigningPubkey, Bolt12Invoice);
} }
#[cfg(all(c_bindings, test))] #[cfg(all(c_bindings, test))]
impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> { impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self); invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
invoice_builder_methods!(self, &mut Self, &mut Self, self, ExplicitSigningPubkey); invoice_builder_methods!(self, &mut Self, &mut Self, self, ExplicitSigningPubkey);
invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), &mut Self, self, ExplicitSigningPubkey); invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), &mut Self, self, ExplicitSigningPubkey, Bolt12Invoice);
} }
#[cfg(all(c_bindings, not(test)))] #[cfg(all(c_bindings, not(test)))]
impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> { impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
invoice_derived_signing_pubkey_builder_methods!(self, &mut Self); invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey); invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey);
invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), DerivedSigningPubkey); invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), DerivedSigningPubkey, Bolt12Invoice);
} }
#[cfg(all(c_bindings, test))] #[cfg(all(c_bindings, test))]
impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> { impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
invoice_derived_signing_pubkey_builder_methods!(self, &mut Self); invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
invoice_builder_methods!(self, &mut Self, &mut Self, self, DerivedSigningPubkey); invoice_builder_methods!(self, &mut Self, &mut Self, self, DerivedSigningPubkey);
invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), &mut Self, self, DerivedSigningPubkey); invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), &mut Self, self, DerivedSigningPubkey, Bolt12Invoice);
} }
#[cfg(c_bindings)] #[cfg(c_bindings)]
@ -752,12 +752,12 @@ macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
} } } }
impl UnsignedBolt12Invoice { impl UnsignedBolt12Invoice {
invoice_accessors_common!(self, self.contents); invoice_accessors_common!(self, self.contents, Bolt12Invoice);
invoice_accessors!(self, self.contents); invoice_accessors!(self, self.contents);
} }
impl Bolt12Invoice { impl Bolt12Invoice {
invoice_accessors_common!(self, self.contents); invoice_accessors_common!(self, self.contents, Bolt12Invoice);
invoice_accessors!(self, self.contents); invoice_accessors!(self, self.contents);
/// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`]. /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].

29
lightning/src/offers/invoice_macros.rs
View file

@ -11,11 +11,12 @@
macro_rules! invoice_builder_methods_common { ( macro_rules! invoice_builder_methods_common { (
$self: ident, $self_type: ty, $invoice_fields: expr, $return_type: ty, $return_value: expr, $self: ident, $self_type: ty, $invoice_fields: expr, $return_type: ty, $return_value: expr,
$type_param: ty $(, $self_mut: tt)? $type_param: ty, $invoice_type: ty $(, $self_mut: tt)?
) => { ) => {
/// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`]. #[doc = concat!("Sets the [`", stringify!($invoice_type), "::relative_expiry`]")]
/// Any expiry that has already passed is valid and can be checked for using #[doc = concat!("as seconds since [`", stringify!($invoice_type), "::created_at`].")]
/// [`Bolt12Invoice::is_expired`]. #[doc = "Any expiry that has already passed is valid and can be checked for using"]
#[doc = concat!("[`", stringify!($invoice_type), "::is_expired`].")]
/// ///
/// Successive calls to this method will override the previous setting. /// Successive calls to this method will override the previous setting.
pub fn relative_expiry($($self_mut)* $self: $self_type, relative_expiry_secs: u32) -> $return_type { pub fn relative_expiry($($self_mut)* $self: $self_type, relative_expiry_secs: u32) -> $return_type {
@ -24,7 +25,7 @@ macro_rules! invoice_builder_methods_common { (
$return_value $return_value
} }
/// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`]. #[doc = concat!("Adds a P2WSH address to [`", stringify!($invoice_type), "::fallbacks`].")]
/// ///
/// Successive calls to this method will add another address. Caller is responsible for not /// Successive calls to this method will add another address. Caller is responsible for not
/// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses. /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
@ -41,7 +42,7 @@ macro_rules! invoice_builder_methods_common { (
$return_value $return_value
} }
/// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`]. #[doc = concat!("Adds a P2WPKH address to [`", stringify!($invoice_type), "::fallbacks`].")]
/// ///
/// Successive calls to this method will add another address. Caller is responsible for not /// Successive calls to this method will add another address. Caller is responsible for not
/// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses. /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
@ -58,7 +59,7 @@ macro_rules! invoice_builder_methods_common { (
$return_value $return_value
} }
/// Adds a P2TR address to [`Bolt12Invoice::fallbacks`]. #[doc = concat!("Adds a P2TR address to [`", stringify!($invoice_type), "::fallbacks`].")]
/// ///
/// Successive calls to this method will add another address. Caller is responsible for not /// Successive calls to this method will add another address. Caller is responsible for not
/// adding duplicate addresses and only calling if capable of receiving to P2TR addresses. /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
@ -73,20 +74,21 @@ macro_rules! invoice_builder_methods_common { (
$return_value $return_value
} }
/// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is #[doc = concat!("Sets [`", stringify!($invoice_type), "::invoice_features`]")]
/// disallowed. #[doc = "to indicate MPP may be used. Otherwise, MPP is disallowed."]
pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type { pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
$invoice_fields.features.set_basic_mpp_optional(); $invoice_fields.features.set_basic_mpp_optional();
$return_value $return_value
} }
} } } }
macro_rules! invoice_accessors_common { ($self: ident, $contents: expr) => { macro_rules! invoice_accessors_common { ($self: ident, $contents: expr, $invoice_type: ty) => {
/// Paths to the recipient originating from publicly reachable nodes, including information /// Paths to the recipient originating from publicly reachable nodes, including information
/// needed for routing payments across them. /// needed for routing payments across them.
/// ///
/// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
/// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`]. /// privacy is lost if a public node id is used for
#[doc = concat!("[`", stringify!($invoice_type), "::signing_pubkey`].")]
/// ///
/// This is not exported to bindings users as slices with non-reference types cannot be ABI /// This is not exported to bindings users as slices with non-reference types cannot be ABI
/// matched in another language. /// matched in another language.
@ -99,8 +101,9 @@ macro_rules! invoice_accessors_common { ($self: ident, $contents: expr) => {
$contents.created_at() $contents.created_at()
} }
/// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore /// Duration since
/// should no longer be paid. #[doc = concat!("[`", stringify!($invoice_type), "::created_at`]")]
/// when the invoice has expired and therefore should no longer be paid.
pub fn relative_expiry(&$self) -> Duration { pub fn relative_expiry(&$self) -> Duration {
$contents.relative_expiry() $contents.relative_expiry()
} }