Move common BOLT 12 invoice builder setters to new macro.

Will be useful when we later add support for static BOLT 12 invoices.

diff --git a/lightning/src/offers/invoice.rs b/lightning/src/offers/invoice.rs
index 4206e67d21d2cd00823e775fe9813899d64ba0c4..4fcd38a1c8d347dd7c172c068195814453a18f0a 100644 (file)
--- a/lightning/src/offers/invoice.rs
+++ b/lightning/src/offers/invoice.rs
@@ -102,12 +102,11 @@
 //!
 //! ```
 
-use bitcoin::{WitnessProgram, Network, WitnessVersion, WPubkeyHash, WScriptHash};
+use bitcoin::{WitnessProgram, Network, WitnessVersion};
 use bitcoin::blockdata::constants::ChainHash;
 use bitcoin::secp256k1::{Keypair, PublicKey, Secp256k1, self};
 use bitcoin::secp256k1::schnorr::Signature;
 use bitcoin::address::{Address, Payload};
-use bitcoin::key::TweakedPublicKey;
 use core::time::Duration;
 use core::hash::{Hash, Hasher};
 use crate::io;
@@ -117,6 +116,7 @@ use crate::ln::channelmanager::PaymentId;
 use crate::ln::features::{BlindedHopFeatures, Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
 use crate::ln::inbound_payment::ExpandedKey;
 use crate::ln::msgs::DecodeError;
+use crate::offers::invoice_macros::invoice_builder_methods_common;
 use crate::offers::invoice_request::{INVOICE_REQUEST_PAYER_ID_TYPE, INVOICE_REQUEST_TYPES, IV_BYTES as INVOICE_REQUEST_IV_BYTES, InvoiceRequest, InvoiceRequestContents, InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, TlvStream, WithoutSignatures, self};
 use crate::offers::offer::{Amount, OFFER_TYPES, OfferTlvStream, OfferTlvStreamRef, Quantity};
@@ -371,65 +371,6 @@ macro_rules! invoice_builder_methods { (
 
                Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
        }
-
-       /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
-       /// Any expiry that has already passed is valid and can be checked for using
-       /// [`Bolt12Invoice::is_expired`].
-       ///
-       /// 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 {
-               let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
-               $self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
-               $return_value
-       }
-
-       /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
-       ///
-       /// 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.
-       pub fn fallback_v0_p2wsh($($self_mut)* $self: $self_type, script_hash: &WScriptHash) -> $return_type {
-               use bitcoin::hashes::Hash;
-               let address = FallbackAddress {
-                       version: WitnessVersion::V0.to_num(),
-                       program: Vec::from(script_hash.to_byte_array()),
-               };
-               $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
-               $return_value
-       }
-
-       /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
-       ///
-       /// 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.
-       pub fn fallback_v0_p2wpkh($($self_mut)* $self: $self_type, pubkey_hash: &WPubkeyHash) -> $return_type {
-               use bitcoin::hashes::Hash;
-               let address = FallbackAddress {
-                       version: WitnessVersion::V0.to_num(),
-                       program: Vec::from(pubkey_hash.to_byte_array()),
-               };
-               $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
-               $return_value
-       }
-
-       /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
-       ///
-       /// 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.
-       pub fn fallback_v1_p2tr_tweaked($($self_mut)* $self: $self_type, output_key: &TweakedPublicKey) -> $return_type {
-               let address = FallbackAddress {
-                       version: WitnessVersion::V1.to_num(),
-                       program: Vec::from(&output_key.serialize()[..]),
-               };
-               $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
-               $return_value
-       }
-
-       /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
-       /// disallowed.
-       pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
-               $self.invoice.fields_mut().features.set_basic_mpp_optional();
-               $return_value
-       }
 } }
 
 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
@@ -442,30 +383,35 @@ impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
 
 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
        invoice_builder_methods!(self, Self, Self, self, S, mut);
+       invoice_builder_methods_common!(self, Self, self.invoice.fields_mut(), Self, self, S, mut);
 }
 
 #[cfg(all(c_bindings, not(test)))]
 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
        invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
        invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey);
+       invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), ExplicitSigningPubkey);
 }
 
 #[cfg(all(c_bindings, test))]
 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
        invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
        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);
 }
 
 #[cfg(all(c_bindings, not(test)))]
 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
        invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
        invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey);
+       invoice_builder_methods_common!(self, &mut Self, self.invoice.fields_mut(), (), (), DerivedSigningPubkey);
 }
 
 #[cfg(all(c_bindings, test))]
 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
        invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
        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);
 }
 
 #[cfg(c_bindings)]

diff --git a/lightning/src/offers/invoice_macros.rs b/lightning/src/offers/invoice_macros.rs
new file mode 100644 (file)
index 0000000..c1e860b
--- /dev/null
+++ b/lightning/src/offers/invoice_macros.rs
@@ -0,0 +1,83 @@
+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// You may not use this file except in accordance with one or both of these
+// licenses.
+
+//! Shared code between BOLT 12 static and single-use invoices.
+
+macro_rules! invoice_builder_methods_common { (
+       $self: ident, $self_type: ty, $invoice_fields: expr, $return_type: ty, $return_value: expr, $type_param: ty $(, $self_mut: tt)?
+) => {
+       /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
+       /// Any expiry that has already passed is valid and can be checked for using
+       /// [`Bolt12Invoice::is_expired`].
+       ///
+       /// 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 {
+               let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
+               $invoice_fields.relative_expiry = Some(relative_expiry);
+               $return_value
+       }
+
+       /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
+       ///
+       /// 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.
+       pub fn fallback_v0_p2wsh(
+               $($self_mut)* $self: $self_type, script_hash: &bitcoin::WScriptHash
+       ) -> $return_type {
+               use bitcoin::hashes::Hash;
+
+               let address = FallbackAddress {
+                       version: bitcoin::WitnessVersion::V0.to_num(),
+                       program: Vec::from(script_hash.to_byte_array()),
+               };
+               $invoice_fields.fallbacks.get_or_insert_with(Vec::new).push(address);
+               $return_value
+       }
+
+       /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
+       ///
+       /// 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.
+       pub fn fallback_v0_p2wpkh(
+               $($self_mut)* $self: $self_type, pubkey_hash: &bitcoin::WPubkeyHash
+       ) -> $return_type {
+               use bitcoin::hashes::Hash;
+
+               let address = FallbackAddress {
+                       version: bitcoin::WitnessVersion::V0.to_num(),
+                       program: Vec::from(pubkey_hash.to_byte_array()),
+               };
+               $invoice_fields.fallbacks.get_or_insert_with(Vec::new).push(address);
+               $return_value
+       }
+
+       /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
+       ///
+       /// 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.
+       pub fn fallback_v1_p2tr_tweaked(
+               $($self_mut)* $self: $self_type, output_key: &bitcoin::key::TweakedPublicKey
+       ) -> $return_type {
+               let address = FallbackAddress {
+                       version: bitcoin::WitnessVersion::V1.to_num(),
+                       program: Vec::from(&output_key.serialize()[..]),
+               };
+               $invoice_fields.fallbacks.get_or_insert_with(Vec::new).push(address);
+               $return_value
+       }
+
+       /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
+       /// disallowed.
+       pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
+               $invoice_fields.features.set_basic_mpp_optional();
+               $return_value
+       }
+} }
+
+pub(super) use invoice_builder_methods_common;

diff --git a/lightning/src/offers/mod.rs b/lightning/src/offers/mod.rs
index 3593b14f1a81185c92536e382877bb0079f87051..eb9b18e1817277a88fa231d5a964cb34f40f434b 100644 (file)
--- a/lightning/src/offers/mod.rs
+++ b/lightning/src/offers/mod.rs
@@ -17,6 +17,7 @@ pub mod offer;
 
 pub mod invoice;
 pub mod invoice_error;
+mod invoice_macros;
 pub mod invoice_request;
 pub mod merkle;
 pub mod parse;