mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-03-15 15:39:09 +01:00
Rename InvoiceRequest::payer_id
For consistency with Offer::issuer_signing_pubkey, rename InvoiceRequest::payer_id to use "signing_pubkey" instead of "id".
This commit is contained in:
Jeffrey Czyz
parent
de29295bb4
commit
dd8f744257
10 changed files with 163 additions and 162 deletions
|
|
@ -85,7 +85,7 @@ fn build_response<T: secp256k1::Signing + secp256k1::Verification>(
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: OfferId([42; 32]),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: invoice_request.quantity(),
|
||||
payer_note_truncated: invoice_request
|
||||
.payer_note()
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutb
|
|||
use crate::ln::wire::Encode;
|
||||
use crate::offers::invoice::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder, UnsignedBolt12Invoice};
|
||||
use crate::offers::invoice_error::InvoiceError;
|
||||
use crate::offers::invoice_request::{DerivedPayerId, InvoiceRequest, InvoiceRequestBuilder};
|
||||
use crate::offers::invoice_request::{DerivedPayerSigningPubkey, InvoiceRequest, InvoiceRequestBuilder};
|
||||
use crate::offers::nonce::Nonce;
|
||||
use crate::offers::offer::{Offer, OfferBuilder};
|
||||
use crate::offers::parse::Bolt12SemanticError;
|
||||
|
|
@ -9226,8 +9226,8 @@ where
|
|||
let secp_ctx = &self.secp_ctx;
|
||||
|
||||
let nonce = Nonce::from_entropy_source(entropy);
|
||||
let builder: InvoiceRequestBuilder<DerivedPayerId, secp256k1::All> = offer
|
||||
.request_invoice_deriving_payer_id(expanded_key, nonce, secp_ctx, payment_id)?
|
||||
let builder: InvoiceRequestBuilder<DerivedPayerSigningPubkey, secp256k1::All> = offer
|
||||
.request_invoice_deriving_signing_pubkey(expanded_key, nonce, secp_ctx, payment_id)?
|
||||
.into();
|
||||
let builder = builder.chain_hash(self.chain_hash)?;
|
||||
|
||||
|
|
|
|||
|
|
@ -566,13 +566,13 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
});
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), david_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), david_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(charlie_id));
|
||||
|
||||
let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
|
||||
|
|
@ -726,13 +726,13 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
});
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), bob_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), bob_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(bob_id));
|
||||
|
||||
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
|
||||
|
|
@ -846,7 +846,7 @@ fn pays_for_offer_without_blinded_paths() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
|
|
@ -1112,13 +1112,13 @@ fn creates_and_pays_for_offer_with_retry() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
});
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), bob_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), bob_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(bob_id));
|
||||
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
|
||||
bob.onion_messenger.handle_onion_message(alice_id, &onion_message);
|
||||
|
|
@ -1176,7 +1176,7 @@ fn pays_bolt12_invoice_asynchronously() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
|
|
@ -1265,12 +1265,12 @@ fn creates_offer_with_blinded_path_using_unannounced_introduction_node() {
|
|||
let payment_context = PaymentContext::Bolt12Offer(Bolt12OfferContext {
|
||||
offer_id: offer.id(),
|
||||
invoice_request: InvoiceRequestFields {
|
||||
payer_id: invoice_request.payer_id(),
|
||||
payer_signing_pubkey: invoice_request.payer_signing_pubkey(),
|
||||
quantity: None,
|
||||
payer_note_truncated: None,
|
||||
},
|
||||
});
|
||||
assert_ne!(invoice_request.payer_id(), bob_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), bob_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(alice_id));
|
||||
|
||||
let onion_message = alice.onion_messenger.next_onion_message_for_peer(bob_id).unwrap();
|
||||
|
|
@ -1411,7 +1411,7 @@ fn fails_authentication_when_handling_invoice_request() {
|
|||
|
||||
let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), david_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), david_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(charlie_id));
|
||||
|
||||
assert_eq!(alice.onion_messenger.next_onion_message_for_peer(charlie_id), None);
|
||||
|
|
@ -1441,7 +1441,7 @@ fn fails_authentication_when_handling_invoice_request() {
|
|||
|
||||
let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), david_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), david_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(charlie_id));
|
||||
|
||||
assert_eq!(alice.onion_messenger.next_onion_message_for_peer(charlie_id), None);
|
||||
|
|
@ -1543,7 +1543,7 @@ fn fails_authentication_when_handling_invoice_for_offer() {
|
|||
|
||||
let (invoice_request, reply_path) = extract_invoice_request(alice, &onion_message);
|
||||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_ne!(invoice_request.payer_id(), david_id);
|
||||
assert_ne!(invoice_request.payer_signing_pubkey(), david_id);
|
||||
assert_eq!(reply_path.introduction_node(), &IntroductionNode::NodeId(charlie_id));
|
||||
|
||||
let onion_message = alice.onion_messenger.next_onion_message_for_peer(charlie_id).unwrap();
|
||||
|
|
|
|||
|
|
@ -749,8 +749,8 @@ macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
|
|||
/// refund in case there are no [`message_paths`].
|
||||
///
|
||||
/// [`message_paths`]: Self::message_paths
|
||||
pub fn payer_id(&$self) -> PublicKey {
|
||||
$contents.payer_id()
|
||||
pub fn payer_signing_pubkey(&$self) -> PublicKey {
|
||||
$contents.payer_signing_pubkey()
|
||||
}
|
||||
|
||||
/// A payer-provided note reflected back in the invoice.
|
||||
|
|
@ -1017,10 +1017,10 @@ impl InvoiceContents {
|
|||
}
|
||||
}
|
||||
|
||||
fn payer_id(&self) -> PublicKey {
|
||||
fn payer_signing_pubkey(&self) -> PublicKey {
|
||||
match self {
|
||||
InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
|
||||
InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
|
||||
InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_signing_pubkey(),
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1099,9 +1099,9 @@ impl InvoiceContents {
|
|||
});
|
||||
let tlv_stream = offer_records.chain(invreq_records);
|
||||
|
||||
let payer_id = self.payer_id();
|
||||
let signing_pubkey = self.payer_signing_pubkey();
|
||||
signer::verify_payer_metadata(
|
||||
metadata.as_ref(), key, iv_bytes, payer_id, tlv_stream, secp_ctx,
|
||||
metadata.as_ref(), key, iv_bytes, signing_pubkey, tlv_stream, secp_ctx,
|
||||
)
|
||||
}
|
||||
|
||||
|
|
@ -1526,7 +1526,7 @@ mod tests {
|
|||
assert_eq!(unsigned_invoice.amount_msats(), 1000);
|
||||
assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
|
||||
assert_eq!(unsigned_invoice.quantity(), None);
|
||||
assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
|
||||
assert_eq!(unsigned_invoice.payer_signing_pubkey(), payer_pubkey());
|
||||
assert_eq!(unsigned_invoice.payer_note(), None);
|
||||
assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
|
||||
assert_eq!(unsigned_invoice.created_at(), now);
|
||||
|
|
@ -1568,7 +1568,7 @@ mod tests {
|
|||
assert_eq!(invoice.amount_msats(), 1000);
|
||||
assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
|
||||
assert_eq!(invoice.quantity(), None);
|
||||
assert_eq!(invoice.payer_id(), payer_pubkey());
|
||||
assert_eq!(invoice.payer_signing_pubkey(), payer_pubkey());
|
||||
assert_eq!(invoice.payer_note(), None);
|
||||
assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
|
||||
assert_eq!(invoice.created_at(), now);
|
||||
|
|
@ -1666,7 +1666,7 @@ mod tests {
|
|||
assert_eq!(invoice.amount_msats(), 1000);
|
||||
assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
|
||||
assert_eq!(invoice.quantity(), None);
|
||||
assert_eq!(invoice.payer_id(), payer_pubkey());
|
||||
assert_eq!(invoice.payer_signing_pubkey(), payer_pubkey());
|
||||
assert_eq!(invoice.payer_note(), None);
|
||||
assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
|
||||
assert_eq!(invoice.created_at(), now);
|
||||
|
|
|
|||
|
|
@ -36,8 +36,8 @@
|
|||
//! let pubkey = PublicKey::from(keys);
|
||||
//! let mut buffer = Vec::new();
|
||||
//!
|
||||
//! # use lightning::offers::invoice_request::{ExplicitPayerId, InvoiceRequestBuilder};
|
||||
//! # <InvoiceRequestBuilder<ExplicitPayerId, _>>::from(
|
||||
//! # use lightning::offers::invoice_request::{ExplicitPayerSigningPubkey, InvoiceRequestBuilder};
|
||||
//! # <InvoiceRequestBuilder<ExplicitPayerSigningPubkey, _>>::from(
|
||||
//! "lno1qcp4256ypq"
|
||||
//! .parse::<Offer>()?
|
||||
//! .request_invoice(vec![42; 64], pubkey)?
|
||||
|
|
@ -102,11 +102,11 @@ pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
|
|||
/// This is not exported to bindings users as builder patterns don't map outside of move semantics.
|
||||
///
|
||||
/// [module-level documentation]: self
|
||||
pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
|
||||
pub struct InvoiceRequestBuilder<'a, 'b, P: PayerSigningPubkeyStrategy, T: secp256k1::Signing> {
|
||||
offer: &'a Offer,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerId,
|
||||
payer_id: Option<PublicKey>,
|
||||
payer_id_strategy: core::marker::PhantomData<P>,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerSigningPubkey,
|
||||
payer_signing_pubkey: Option<PublicKey>,
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData<P>,
|
||||
secp_ctx: Option<&'b Secp256k1<T>>,
|
||||
}
|
||||
|
||||
|
|
@ -116,11 +116,11 @@ pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signi
|
|||
///
|
||||
/// [module-level documentation]: self
|
||||
#[cfg(c_bindings)]
|
||||
pub struct InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
|
||||
pub struct InvoiceRequestWithExplicitPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
offer: &'a Offer,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerId,
|
||||
payer_id: Option<PublicKey>,
|
||||
payer_id_strategy: core::marker::PhantomData<ExplicitPayerId>,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerSigningPubkey,
|
||||
payer_signing_pubkey: Option<PublicKey>,
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData<ExplicitPayerSigningPubkey>,
|
||||
secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
|
||||
}
|
||||
|
||||
|
|
@ -130,47 +130,47 @@ pub struct InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
|
|||
///
|
||||
/// [module-level documentation]: self
|
||||
#[cfg(c_bindings)]
|
||||
pub struct InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
|
||||
pub struct InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
offer: &'a Offer,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerId,
|
||||
payer_id: Option<PublicKey>,
|
||||
payer_id_strategy: core::marker::PhantomData<DerivedPayerId>,
|
||||
invoice_request: InvoiceRequestContentsWithoutPayerSigningPubkey,
|
||||
payer_signing_pubkey: Option<PublicKey>,
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData<DerivedPayerSigningPubkey>,
|
||||
secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
|
||||
}
|
||||
|
||||
/// Indicates how [`InvoiceRequest::payer_id`] will be set.
|
||||
/// Indicates how [`InvoiceRequest::payer_signing_pubkey`] will be set.
|
||||
///
|
||||
/// This is not exported to bindings users as builder patterns don't map outside of move semantics.
|
||||
pub trait PayerIdStrategy {}
|
||||
pub trait PayerSigningPubkeyStrategy {}
|
||||
|
||||
/// [`InvoiceRequest::payer_id`] will be explicitly set.
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`] will be explicitly set.
|
||||
///
|
||||
/// This is not exported to bindings users as builder patterns don't map outside of move semantics.
|
||||
pub struct ExplicitPayerId {}
|
||||
pub struct ExplicitPayerSigningPubkey {}
|
||||
|
||||
/// [`InvoiceRequest::payer_id`] will be derived.
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`] will be derived.
|
||||
///
|
||||
/// This is not exported to bindings users as builder patterns don't map outside of move semantics.
|
||||
pub struct DerivedPayerId {}
|
||||
pub struct DerivedPayerSigningPubkey {}
|
||||
|
||||
impl PayerIdStrategy for ExplicitPayerId {}
|
||||
impl PayerIdStrategy for DerivedPayerId {}
|
||||
impl PayerSigningPubkeyStrategy for ExplicitPayerSigningPubkey {}
|
||||
impl PayerSigningPubkeyStrategy for DerivedPayerSigningPubkey {}
|
||||
|
||||
macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident, $self_type: ty) => {
|
||||
macro_rules! invoice_request_explicit_payer_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
|
||||
#[cfg_attr(c_bindings, allow(dead_code))]
|
||||
pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
|
||||
pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, signing_pubkey: PublicKey) -> Self {
|
||||
Self {
|
||||
offer,
|
||||
invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
|
||||
payer_id: Some(payer_id),
|
||||
payer_id_strategy: core::marker::PhantomData,
|
||||
payer_signing_pubkey: Some(signing_pubkey),
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData,
|
||||
secp_ctx: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg_attr(c_bindings, allow(dead_code))]
|
||||
pub(super) fn deriving_metadata(
|
||||
offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,
|
||||
offer: &'a Offer, signing_pubkey: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,
|
||||
payment_id: PaymentId,
|
||||
) -> Self {
|
||||
let payment_id = Some(payment_id);
|
||||
|
|
@ -179,8 +179,8 @@ macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident,
|
|||
Self {
|
||||
offer,
|
||||
invoice_request: Self::create_contents(offer, metadata),
|
||||
payer_id: Some(payer_id),
|
||||
payer_id_strategy: core::marker::PhantomData,
|
||||
payer_signing_pubkey: Some(signing_pubkey),
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData,
|
||||
secp_ctx: None,
|
||||
}
|
||||
}
|
||||
|
|
@ -194,11 +194,11 @@ macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident,
|
|||
}
|
||||
} }
|
||||
|
||||
macro_rules! invoice_request_derived_payer_id_builder_methods { (
|
||||
macro_rules! invoice_request_derived_payer_signing_pubkey_builder_methods { (
|
||||
$self: ident, $self_type: ty, $secp_context: ty
|
||||
) => {
|
||||
#[cfg_attr(c_bindings, allow(dead_code))]
|
||||
pub(super) fn deriving_payer_id(
|
||||
pub(super) fn deriving_signing_pubkey(
|
||||
offer: &'a Offer, expanded_key: &ExpandedKey, nonce: Nonce,
|
||||
secp_ctx: &'b Secp256k1<$secp_context>, payment_id: PaymentId
|
||||
) -> Self {
|
||||
|
|
@ -208,8 +208,8 @@ macro_rules! invoice_request_derived_payer_id_builder_methods { (
|
|||
Self {
|
||||
offer,
|
||||
invoice_request: Self::create_contents(offer, metadata),
|
||||
payer_id: None,
|
||||
payer_id_strategy: core::marker::PhantomData,
|
||||
payer_signing_pubkey: None,
|
||||
payer_signing_pubkey_strategy: core::marker::PhantomData,
|
||||
secp_ctx: Some(secp_ctx),
|
||||
}
|
||||
}
|
||||
|
|
@ -236,9 +236,9 @@ macro_rules! invoice_request_builder_methods { (
|
|||
$self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $secp_context: ty $(, $self_mut: tt)?
|
||||
) => {
|
||||
#[cfg_attr(c_bindings, allow(dead_code))]
|
||||
fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
|
||||
fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
let offer = offer.contents.clone();
|
||||
InvoiceRequestContentsWithoutPayerId {
|
||||
InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
|
||||
features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
|
||||
}
|
||||
|
|
@ -343,7 +343,7 @@ macro_rules! invoice_request_builder_methods { (
|
|||
debug_assert!(tlv_stream.2.payer_id.is_none());
|
||||
tlv_stream.0.metadata = None;
|
||||
if !metadata.derives_payer_keys() {
|
||||
tlv_stream.2.payer_id = $self.payer_id.as_ref();
|
||||
tlv_stream.2.payer_id = $self.payer_signing_pubkey.as_ref();
|
||||
}
|
||||
|
||||
let (derived_metadata, derived_keys) =
|
||||
|
|
@ -351,23 +351,23 @@ macro_rules! invoice_request_builder_methods { (
|
|||
metadata = derived_metadata;
|
||||
keys = derived_keys;
|
||||
if let Some(keys) = keys {
|
||||
debug_assert!($self.payer_id.is_none());
|
||||
$self.payer_id = Some(keys.public_key());
|
||||
debug_assert!($self.payer_signing_pubkey.is_none());
|
||||
$self.payer_signing_pubkey = Some(keys.public_key());
|
||||
}
|
||||
|
||||
$self.invoice_request.payer.0 = metadata;
|
||||
}
|
||||
|
||||
debug_assert!($self.invoice_request.payer.0.as_bytes().is_some());
|
||||
debug_assert!($self.payer_id.is_some());
|
||||
let payer_id = $self.payer_id.unwrap();
|
||||
debug_assert!($self.payer_signing_pubkey.is_some());
|
||||
let payer_signing_pubkey = $self.payer_signing_pubkey.unwrap();
|
||||
|
||||
let invoice_request = InvoiceRequestContents {
|
||||
#[cfg(not(c_bindings))]
|
||||
inner: $self.invoice_request,
|
||||
#[cfg(c_bindings)]
|
||||
inner: $self.invoice_request.clone(),
|
||||
payer_id,
|
||||
payer_signing_pubkey,
|
||||
};
|
||||
let unsigned_invoice_request = UnsignedInvoiceRequest::new($self.offer, invoice_request);
|
||||
|
||||
|
|
@ -410,15 +410,15 @@ macro_rules! invoice_request_builder_test_methods { (
|
|||
}
|
||||
} }
|
||||
|
||||
impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
|
||||
invoice_request_explicit_payer_id_builder_methods!(self, Self);
|
||||
impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerSigningPubkey, T> {
|
||||
invoice_request_explicit_payer_signing_pubkey_builder_methods!(self, Self);
|
||||
}
|
||||
|
||||
impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
|
||||
invoice_request_derived_payer_id_builder_methods!(self, Self, T);
|
||||
impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerSigningPubkey, T> {
|
||||
invoice_request_derived_payer_signing_pubkey_builder_methods!(self, Self, T);
|
||||
}
|
||||
|
||||
impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
|
||||
impl<'a, 'b, P: PayerSigningPubkeyStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
|
||||
invoice_request_builder_methods!(self, Self, Self, self, T, mut);
|
||||
|
||||
#[cfg(test)]
|
||||
|
|
@ -426,55 +426,55 @@ impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a
|
|||
}
|
||||
|
||||
#[cfg(all(c_bindings, not(test)))]
|
||||
impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
|
||||
invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
|
||||
impl<'a, 'b> InvoiceRequestWithExplicitPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
invoice_request_explicit_payer_signing_pubkey_builder_methods!(self, &mut Self);
|
||||
invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
|
||||
}
|
||||
|
||||
#[cfg(all(c_bindings, test))]
|
||||
impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
|
||||
invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
|
||||
impl<'a, 'b> InvoiceRequestWithExplicitPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
invoice_request_explicit_payer_signing_pubkey_builder_methods!(self, &mut Self);
|
||||
invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
|
||||
invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
|
||||
}
|
||||
|
||||
#[cfg(all(c_bindings, not(test)))]
|
||||
impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
|
||||
invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
|
||||
impl<'a, 'b> InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
invoice_request_derived_payer_signing_pubkey_builder_methods!(self, &mut Self, secp256k1::All);
|
||||
invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
|
||||
}
|
||||
|
||||
#[cfg(all(c_bindings, test))]
|
||||
impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
|
||||
invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
|
||||
impl<'a, 'b> InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b> {
|
||||
invoice_request_derived_payer_signing_pubkey_builder_methods!(self, &mut Self, secp256k1::All);
|
||||
invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
|
||||
invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
|
||||
}
|
||||
|
||||
#[cfg(c_bindings)]
|
||||
impl<'a, 'b> From<InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>>
|
||||
for InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, secp256k1::All> {
|
||||
fn from(builder: InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>) -> Self {
|
||||
let InvoiceRequestWithExplicitPayerIdBuilder {
|
||||
offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
|
||||
impl<'a, 'b> From<InvoiceRequestWithExplicitPayerSigningPubkeyBuilder<'a, 'b>>
|
||||
for InvoiceRequestBuilder<'a, 'b, ExplicitPayerSigningPubkey, secp256k1::All> {
|
||||
fn from(builder: InvoiceRequestWithExplicitPayerSigningPubkeyBuilder<'a, 'b>) -> Self {
|
||||
let InvoiceRequestWithExplicitPayerSigningPubkeyBuilder {
|
||||
offer, invoice_request, payer_signing_pubkey, payer_signing_pubkey_strategy, secp_ctx,
|
||||
} = builder;
|
||||
|
||||
Self {
|
||||
offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
|
||||
offer, invoice_request, payer_signing_pubkey, payer_signing_pubkey_strategy, secp_ctx,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(c_bindings)]
|
||||
impl<'a, 'b> From<InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>>
|
||||
for InvoiceRequestBuilder<'a, 'b, DerivedPayerId, secp256k1::All> {
|
||||
fn from(builder: InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>) -> Self {
|
||||
let InvoiceRequestWithDerivedPayerIdBuilder {
|
||||
offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
|
||||
impl<'a, 'b> From<InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b>>
|
||||
for InvoiceRequestBuilder<'a, 'b, DerivedPayerSigningPubkey, secp256k1::All> {
|
||||
fn from(builder: InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b>) -> Self {
|
||||
let InvoiceRequestWithDerivedPayerSigningPubkeyBuilder {
|
||||
offer, invoice_request, payer_signing_pubkey, payer_signing_pubkey_strategy, secp_ctx,
|
||||
} = builder;
|
||||
|
||||
Self {
|
||||
offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
|
||||
offer, invoice_request, payer_signing_pubkey, payer_signing_pubkey_strategy, secp_ctx,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -548,7 +548,7 @@ macro_rules! unsigned_invoice_request_sign_method { (
|
|||
pub fn sign<F: SignInvoiceRequestFn>(
|
||||
$($self_mut)* $self: $self_type, sign: F
|
||||
) -> Result<InvoiceRequest, SignError> {
|
||||
let pubkey = $self.contents.payer_id;
|
||||
let pubkey = $self.contents.payer_signing_pubkey;
|
||||
let signature = merkle::sign_message(sign, &$self, pubkey)?;
|
||||
|
||||
// Append the signature TLV record to the bytes.
|
||||
|
|
@ -630,13 +630,13 @@ pub struct VerifiedInvoiceRequest {
|
|||
#[derive(Clone, Debug)]
|
||||
#[cfg_attr(test, derive(PartialEq))]
|
||||
pub(super) struct InvoiceRequestContents {
|
||||
pub(super) inner: InvoiceRequestContentsWithoutPayerId,
|
||||
payer_id: PublicKey,
|
||||
pub(super) inner: InvoiceRequestContentsWithoutPayerSigningPubkey,
|
||||
payer_signing_pubkey: PublicKey,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
#[cfg_attr(test, derive(PartialEq))]
|
||||
pub(super) struct InvoiceRequestContentsWithoutPayerId {
|
||||
pub(super) struct InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
pub(super) payer: PayerContents,
|
||||
pub(super) offer: OfferContents,
|
||||
chain: Option<ChainHash>,
|
||||
|
|
@ -648,9 +648,9 @@ pub(super) struct InvoiceRequestContentsWithoutPayerId {
|
|||
|
||||
macro_rules! invoice_request_accessors { ($self: ident, $contents: expr) => {
|
||||
/// An unpredictable series of bytes, typically containing information about the derivation of
|
||||
/// [`payer_id`].
|
||||
/// [`payer_signing_pubkey`].
|
||||
///
|
||||
/// [`payer_id`]: Self::payer_id
|
||||
/// [`payer_signing_pubkey`]: Self::payer_signing_pubkey
|
||||
pub fn payer_metadata(&$self) -> &[u8] {
|
||||
$contents.metadata()
|
||||
}
|
||||
|
|
@ -679,8 +679,8 @@ macro_rules! invoice_request_accessors { ($self: ident, $contents: expr) => {
|
|||
}
|
||||
|
||||
/// A possibly transient pubkey used to sign the invoice request.
|
||||
pub fn payer_id(&$self) -> PublicKey {
|
||||
$contents.payer_id()
|
||||
pub fn payer_signing_pubkey(&$self) -> PublicKey {
|
||||
$contents.payer_signing_pubkey()
|
||||
}
|
||||
|
||||
/// A payer-provided note which will be seen by the recipient and reflected back in the invoice
|
||||
|
|
@ -856,9 +856,9 @@ impl InvoiceRequest {
|
|||
}
|
||||
|
||||
impl InvoiceRequest {
|
||||
/// Signature of the invoice request using [`payer_id`].
|
||||
/// Signature of the invoice request using [`payer_signing_pubkey`].
|
||||
///
|
||||
/// [`payer_id`]: Self::payer_id
|
||||
/// [`payer_signing_pubkey`]: Self::payer_signing_pubkey
|
||||
pub fn signature(&self) -> Signature {
|
||||
self.signature
|
||||
}
|
||||
|
|
@ -939,14 +939,14 @@ impl VerifiedInvoiceRequest {
|
|||
|
||||
pub(crate) fn fields(&self) -> InvoiceRequestFields {
|
||||
let InvoiceRequestContents {
|
||||
payer_id,
|
||||
inner: InvoiceRequestContentsWithoutPayerId {
|
||||
payer_signing_pubkey,
|
||||
inner: InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
payer: _, offer: _, chain: _, amount_msats: _, features: _, quantity, payer_note
|
||||
},
|
||||
} = &self.inner.contents;
|
||||
|
||||
InvoiceRequestFields {
|
||||
payer_id: *payer_id,
|
||||
payer_signing_pubkey: *payer_signing_pubkey,
|
||||
quantity: *quantity,
|
||||
payer_note_truncated: payer_note.clone()
|
||||
.map(|mut s| { s.truncate(PAYER_NOTE_LIMIT); UntrustedString(s) }),
|
||||
|
|
@ -975,8 +975,8 @@ impl InvoiceRequestContents {
|
|||
self.inner.quantity
|
||||
}
|
||||
|
||||
pub(super) fn payer_id(&self) -> PublicKey {
|
||||
self.payer_id
|
||||
pub(super) fn payer_signing_pubkey(&self) -> PublicKey {
|
||||
self.payer_signing_pubkey
|
||||
}
|
||||
|
||||
pub(super) fn payer_note(&self) -> Option<PrintableString> {
|
||||
|
|
@ -986,12 +986,12 @@ impl InvoiceRequestContents {
|
|||
|
||||
pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
|
||||
let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
|
||||
invoice_request.payer_id = Some(&self.payer_id);
|
||||
invoice_request.payer_id = Some(&self.payer_signing_pubkey);
|
||||
(payer, offer, invoice_request)
|
||||
}
|
||||
}
|
||||
|
||||
impl InvoiceRequestContentsWithoutPayerId {
|
||||
impl InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
pub(super) fn metadata(&self) -> &[u8] {
|
||||
self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
|
||||
}
|
||||
|
|
@ -1054,7 +1054,7 @@ impl Readable for InvoiceRequest {
|
|||
/// Valid type range for invoice_request TLV records.
|
||||
pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
|
||||
|
||||
/// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
|
||||
/// TLV record type for [`InvoiceRequest::payer_signing_pubkey`] and [`Refund::payer_id`].
|
||||
///
|
||||
/// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
|
||||
pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
|
||||
|
|
@ -1139,7 +1139,7 @@ impl TryFrom<Vec<u8>> for InvoiceRequest {
|
|||
Some(signature) => signature,
|
||||
};
|
||||
let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
|
||||
merkle::verify_signature(&signature, &message, contents.payer_id)?;
|
||||
merkle::verify_signature(&signature, &message, contents.payer_signing_pubkey)?;
|
||||
|
||||
Ok(InvoiceRequest { bytes, contents, signature })
|
||||
}
|
||||
|
|
@ -1176,8 +1176,8 @@ impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
|
|||
|
||||
let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
|
||||
|
||||
let payer_id = match payer_id {
|
||||
None => return Err(Bolt12SemanticError::MissingPayerId),
|
||||
let payer_signing_pubkey = match payer_id {
|
||||
None => return Err(Bolt12SemanticError::MissingPayerSigningPubkey),
|
||||
Some(payer_id) => payer_id,
|
||||
};
|
||||
|
||||
|
|
@ -1186,10 +1186,10 @@ impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
|
|||
}
|
||||
|
||||
Ok(InvoiceRequestContents {
|
||||
inner: InvoiceRequestContentsWithoutPayerId {
|
||||
inner: InvoiceRequestContentsWithoutPayerSigningPubkey {
|
||||
payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
|
||||
},
|
||||
payer_id,
|
||||
payer_signing_pubkey,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
@ -1200,7 +1200,7 @@ impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
|
|||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct InvoiceRequestFields {
|
||||
/// A possibly transient pubkey used to sign the invoice request.
|
||||
pub payer_id: PublicKey,
|
||||
pub payer_signing_pubkey: PublicKey,
|
||||
|
||||
/// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
|
||||
pub quantity: Option<u64>,
|
||||
|
|
@ -1216,7 +1216,7 @@ pub const PAYER_NOTE_LIMIT: usize = 512;
|
|||
impl Writeable for InvoiceRequestFields {
|
||||
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
|
||||
write_tlv_fields!(writer, {
|
||||
(0, self.payer_id, required),
|
||||
(0, self.payer_signing_pubkey, required),
|
||||
(2, self.quantity.map(|v| HighZeroBytesDroppedBigSize(v)), option),
|
||||
(4, self.payer_note_truncated.as_ref().map(|s| WithoutLength(&s.0)), option),
|
||||
});
|
||||
|
|
@ -1227,13 +1227,13 @@ impl Writeable for InvoiceRequestFields {
|
|||
impl Readable for InvoiceRequestFields {
|
||||
fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
|
||||
_init_and_read_len_prefixed_tlv_fields!(reader, {
|
||||
(0, payer_id, required),
|
||||
(0, payer_signing_pubkey, required),
|
||||
(2, quantity, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
|
||||
(4, payer_note_truncated, (option, encoding: (String, WithoutLength))),
|
||||
});
|
||||
|
||||
Ok(InvoiceRequestFields {
|
||||
payer_id: payer_id.0.unwrap(),
|
||||
payer_signing_pubkey: payer_signing_pubkey.0.unwrap(),
|
||||
quantity,
|
||||
payer_note_truncated: payer_note_truncated.map(|s| UntrustedString(s)),
|
||||
})
|
||||
|
|
@ -1302,7 +1302,7 @@ mod tests {
|
|||
assert_eq!(unsigned_invoice_request.amount_msats(), None);
|
||||
assert_eq!(unsigned_invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
|
||||
assert_eq!(unsigned_invoice_request.quantity(), None);
|
||||
assert_eq!(unsigned_invoice_request.payer_id(), payer_pubkey());
|
||||
assert_eq!(unsigned_invoice_request.payer_signing_pubkey(), payer_pubkey());
|
||||
assert_eq!(unsigned_invoice_request.payer_note(), None);
|
||||
|
||||
match UnsignedInvoiceRequest::try_from(buffer) {
|
||||
|
|
@ -1334,7 +1334,7 @@ mod tests {
|
|||
assert_eq!(invoice_request.amount_msats(), None);
|
||||
assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
|
||||
assert_eq!(invoice_request.quantity(), None);
|
||||
assert_eq!(invoice_request.payer_id(), payer_pubkey());
|
||||
assert_eq!(invoice_request.payer_signing_pubkey(), payer_pubkey());
|
||||
assert_eq!(invoice_request.payer_note(), None);
|
||||
|
||||
let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice_request.bytes);
|
||||
|
|
@ -1405,7 +1405,7 @@ mod tests {
|
|||
|
||||
#[test]
|
||||
fn builds_invoice_request_with_derived_metadata() {
|
||||
let payer_id = payer_pubkey();
|
||||
let signing_pubkey = payer_pubkey();
|
||||
let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
|
||||
let entropy = FixedEntropy {};
|
||||
let nonce = Nonce::from_entropy_source(&entropy);
|
||||
|
|
@ -1416,11 +1416,11 @@ mod tests {
|
|||
.amount_msats(1000)
|
||||
.build().unwrap();
|
||||
let invoice_request = offer
|
||||
.request_invoice_deriving_metadata(payer_id, &expanded_key, nonce, payment_id)
|
||||
.request_invoice_deriving_metadata(signing_pubkey, &expanded_key, nonce, payment_id)
|
||||
.unwrap()
|
||||
.build().unwrap()
|
||||
.sign(payer_sign).unwrap();
|
||||
assert_eq!(invoice_request.payer_id(), payer_pubkey());
|
||||
assert_eq!(invoice_request.payer_signing_pubkey(), payer_pubkey());
|
||||
|
||||
let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
|
||||
.unwrap()
|
||||
|
|
@ -1482,7 +1482,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn builds_invoice_request_with_derived_payer_id() {
|
||||
fn builds_invoice_request_with_derived_payer_signing_pubkey() {
|
||||
let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
|
||||
let entropy = FixedEntropy {};
|
||||
let nonce = Nonce::from_entropy_source(&entropy);
|
||||
|
|
@ -1493,7 +1493,7 @@ mod tests {
|
|||
.amount_msats(1000)
|
||||
.build().unwrap();
|
||||
let invoice_request = offer
|
||||
.request_invoice_deriving_payer_id(&expanded_key, nonce, &secp_ctx, payment_id)
|
||||
.request_invoice_deriving_signing_pubkey(&expanded_key, nonce, &secp_ctx, payment_id)
|
||||
.unwrap()
|
||||
.build_and_sign()
|
||||
.unwrap();
|
||||
|
|
@ -2215,7 +2215,7 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn fails_parsing_invoice_request_without_payer_id() {
|
||||
fn fails_parsing_invoice_request_without_payer_signing_pubkey() {
|
||||
let offer = OfferBuilder::new(recipient_pubkey())
|
||||
.amount_msats(1000)
|
||||
.build().unwrap();
|
||||
|
|
@ -2229,7 +2229,7 @@ mod tests {
|
|||
|
||||
match InvoiceRequest::try_from(buffer) {
|
||||
Ok(_) => panic!("expected error"),
|
||||
Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
|
||||
Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerSigningPubkey)),
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -2349,7 +2349,7 @@ mod tests {
|
|||
assert_eq!(
|
||||
fields,
|
||||
InvoiceRequestFields {
|
||||
payer_id: payer_pubkey(),
|
||||
payer_signing_pubkey: payer_pubkey(),
|
||||
quantity: Some(1),
|
||||
payer_note_truncated: Some(UntrustedString("0".repeat(PAYER_NOTE_LIMIT))),
|
||||
}
|
||||
|
|
|
|||
|
|
@ -99,11 +99,11 @@ use crate::util::string::PrintableString;
|
|||
|
||||
#[cfg(not(c_bindings))]
|
||||
use {
|
||||
crate::offers::invoice_request::{DerivedPayerId, ExplicitPayerId, InvoiceRequestBuilder},
|
||||
crate::offers::invoice_request::{DerivedPayerSigningPubkey, ExplicitPayerSigningPubkey, InvoiceRequestBuilder},
|
||||
};
|
||||
#[cfg(c_bindings)]
|
||||
use {
|
||||
crate::offers::invoice_request::{InvoiceRequestWithDerivedPayerIdBuilder, InvoiceRequestWithExplicitPayerIdBuilder},
|
||||
crate::offers::invoice_request::{InvoiceRequestWithDerivedPayerSigningPubkeyBuilder, InvoiceRequestWithExplicitPayerSigningPubkeyBuilder},
|
||||
};
|
||||
|
||||
#[allow(unused_imports)]
|
||||
|
|
@ -695,10 +695,10 @@ impl Offer {
|
|||
}
|
||||
}
|
||||
|
||||
macro_rules! request_invoice_derived_payer_id { ($self: ident, $builder: ty) => {
|
||||
macro_rules! request_invoice_derived_signing_pubkey { ($self: ident, $builder: ty) => {
|
||||
/// Similar to [`Offer::request_invoice`] except it:
|
||||
/// - derives the [`InvoiceRequest::payer_id`] such that a different key can be used for each
|
||||
/// request,
|
||||
/// - derives the [`InvoiceRequest::payer_signing_pubkey`] such that a different key can be used
|
||||
/// for each request,
|
||||
/// - sets [`InvoiceRequest::payer_metadata`] when [`InvoiceRequestBuilder::build`] is called
|
||||
/// such that it can be used by [`Bolt12Invoice::verify_using_metadata`] to determine if the
|
||||
/// invoice was requested using a base [`ExpandedKey`] from which the payer id was derived,
|
||||
|
|
@ -708,11 +708,11 @@ macro_rules! request_invoice_derived_payer_id { ($self: ident, $builder: ty) =>
|
|||
///
|
||||
/// Useful to protect the sender's privacy.
|
||||
///
|
||||
/// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`]: crate::offers::invoice_request::InvoiceRequest::payer_signing_pubkey
|
||||
/// [`InvoiceRequest::payer_metadata`]: crate::offers::invoice_request::InvoiceRequest::payer_metadata
|
||||
/// [`Bolt12Invoice::verify_using_metadata`]: crate::offers::invoice::Bolt12Invoice::verify_using_metadata
|
||||
/// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
|
||||
pub fn request_invoice_deriving_payer_id<
|
||||
pub fn request_invoice_deriving_signing_pubkey<
|
||||
'a, 'b,
|
||||
#[cfg(not(c_bindings))]
|
||||
T: secp256k1::Signing
|
||||
|
|
@ -728,34 +728,35 @@ macro_rules! request_invoice_derived_payer_id { ($self: ident, $builder: ty) =>
|
|||
return Err(Bolt12SemanticError::UnknownRequiredFeatures);
|
||||
}
|
||||
|
||||
Ok(<$builder>::deriving_payer_id($self, expanded_key, nonce, secp_ctx, payment_id))
|
||||
Ok(<$builder>::deriving_signing_pubkey($self, expanded_key, nonce, secp_ctx, payment_id))
|
||||
}
|
||||
} }
|
||||
|
||||
macro_rules! request_invoice_explicit_payer_id { ($self: ident, $builder: ty) => {
|
||||
/// Similar to [`Offer::request_invoice_deriving_payer_id`] except uses `payer_id` for the
|
||||
/// [`InvoiceRequest::payer_id`] instead of deriving a different key for each request.
|
||||
macro_rules! request_invoice_explicit_signing_pubkey { ($self: ident, $builder: ty) => {
|
||||
/// Similar to [`Offer::request_invoice_deriving_signing_pubkey`] except uses `signing_pubkey`
|
||||
/// for the [`InvoiceRequest::payer_signing_pubkey`] instead of deriving a different key for
|
||||
/// each request.
|
||||
///
|
||||
/// Useful for recurring payments using the same `payer_id` with different invoices.
|
||||
/// Useful for recurring payments using the same `signing_pubkey` with different invoices.
|
||||
///
|
||||
/// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`]: crate::offers::invoice_request::InvoiceRequest::payer_signing_pubkey
|
||||
pub fn request_invoice_deriving_metadata(
|
||||
&$self, payer_id: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,
|
||||
&$self, signing_pubkey: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,
|
||||
payment_id: PaymentId
|
||||
) -> Result<$builder, Bolt12SemanticError> {
|
||||
if $self.offer_features().requires_unknown_bits() {
|
||||
return Err(Bolt12SemanticError::UnknownRequiredFeatures);
|
||||
}
|
||||
|
||||
Ok(<$builder>::deriving_metadata($self, payer_id, expanded_key, nonce, payment_id))
|
||||
Ok(<$builder>::deriving_metadata($self, signing_pubkey, expanded_key, nonce, payment_id))
|
||||
}
|
||||
|
||||
/// Creates an [`InvoiceRequestBuilder`] for the offer with the given `metadata` and `payer_id`,
|
||||
/// which will be reflected in the `Bolt12Invoice` response.
|
||||
/// Creates an [`InvoiceRequestBuilder`] for the offer with the given `metadata` and
|
||||
/// `signing_pubkey`, which will be reflected in the `Bolt12Invoice` response.
|
||||
///
|
||||
/// The `metadata` is useful for including information about the derivation of `payer_id` such
|
||||
/// that invoice response handling can be stateless. Also serves as payer-provided entropy while
|
||||
/// hashing in the signature calculation.
|
||||
/// The `metadata` is useful for including information about the derivation of `signing_pubkey`
|
||||
/// such that invoice response handling can be stateless. Also serves as payer-provided entropy
|
||||
/// while hashing in the signature calculation.
|
||||
///
|
||||
/// This should not leak any information such as by using a simple BIP-32 derivation path.
|
||||
/// Otherwise, payments may be correlated.
|
||||
|
|
@ -764,26 +765,26 @@ macro_rules! request_invoice_explicit_payer_id { ($self: ident, $builder: ty) =>
|
|||
///
|
||||
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
|
||||
pub fn request_invoice(
|
||||
&$self, metadata: Vec<u8>, payer_id: PublicKey
|
||||
&$self, metadata: Vec<u8>, signing_pubkey: PublicKey
|
||||
) -> Result<$builder, Bolt12SemanticError> {
|
||||
if $self.offer_features().requires_unknown_bits() {
|
||||
return Err(Bolt12SemanticError::UnknownRequiredFeatures);
|
||||
}
|
||||
|
||||
Ok(<$builder>::new($self, metadata, payer_id))
|
||||
Ok(<$builder>::new($self, metadata, signing_pubkey))
|
||||
}
|
||||
} }
|
||||
|
||||
#[cfg(not(c_bindings))]
|
||||
impl Offer {
|
||||
request_invoice_derived_payer_id!(self, InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T>);
|
||||
request_invoice_explicit_payer_id!(self, InvoiceRequestBuilder<ExplicitPayerId, secp256k1::SignOnly>);
|
||||
request_invoice_derived_signing_pubkey!(self, InvoiceRequestBuilder<'a, 'b, DerivedPayerSigningPubkey, T>);
|
||||
request_invoice_explicit_signing_pubkey!(self, InvoiceRequestBuilder<ExplicitPayerSigningPubkey, secp256k1::SignOnly>);
|
||||
}
|
||||
|
||||
#[cfg(c_bindings)]
|
||||
impl Offer {
|
||||
request_invoice_derived_payer_id!(self, InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>);
|
||||
request_invoice_explicit_payer_id!(self, InvoiceRequestWithExplicitPayerIdBuilder);
|
||||
request_invoice_derived_signing_pubkey!(self, InvoiceRequestWithDerivedPayerSigningPubkeyBuilder<'a, 'b>);
|
||||
request_invoice_explicit_signing_pubkey!(self, InvoiceRequestWithExplicitPayerSigningPubkeyBuilder);
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
|
|
|||
|
|
@ -173,8 +173,8 @@ pub enum Bolt12SemanticError {
|
|||
UnexpectedMetadata,
|
||||
/// Payer metadata was expected but was missing.
|
||||
MissingPayerMetadata,
|
||||
/// A payer id was expected but was missing.
|
||||
MissingPayerId,
|
||||
/// A payer signing pubkey was expected but was missing.
|
||||
MissingPayerSigningPubkey,
|
||||
/// The payment id for a refund or request is already in use.
|
||||
DuplicatePaymentId,
|
||||
/// Blinded paths were expected but were missing.
|
||||
|
|
|
|||
|
|
@ -16,9 +16,9 @@ use crate::util::ser::WithoutLength;
|
|||
use crate::prelude::*;
|
||||
|
||||
/// An unpredictable sequence of bytes typically containing information needed to derive
|
||||
/// [`InvoiceRequest::payer_id`].
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`].
|
||||
///
|
||||
/// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
|
||||
/// [`InvoiceRequest::payer_signing_pubkey`]: crate::offers::invoice_request::InvoiceRequest::payer_signing_pubkey
|
||||
#[derive(Clone, Debug)]
|
||||
#[cfg_attr(test, derive(PartialEq))]
|
||||
pub(super) struct PayerContents(pub Metadata);
|
||||
|
|
|
|||
|
|
@ -902,7 +902,7 @@ impl TryFrom<RefundTlvStream> for RefundContents {
|
|||
let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
|
||||
|
||||
let payer_id = match payer_id {
|
||||
None => return Err(Bolt12SemanticError::MissingPayerId),
|
||||
None => return Err(Bolt12SemanticError::MissingPayerSigningPubkey),
|
||||
Some(payer_id) => payer_id,
|
||||
};
|
||||
|
||||
|
|
@ -1395,7 +1395,7 @@ mod tests {
|
|||
match Refund::try_from(tlv_stream.to_bytes()) {
|
||||
Ok(_) => panic!("expected error"),
|
||||
Err(e) => {
|
||||
assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId));
|
||||
assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerSigningPubkey));
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -878,7 +878,7 @@ pub trait NodeSigner {
|
|||
/// Implementors may check that the `invoice_request` is expected rather than blindly signing
|
||||
/// the tagged hash. An `Ok` result should sign `invoice_request.tagged_hash().as_digest()` with
|
||||
/// the node's signing key or an ephemeral key to preserve privacy, whichever is associated with
|
||||
/// [`UnsignedInvoiceRequest::payer_id`].
|
||||
/// [`UnsignedInvoiceRequest::payer_signing_pubkey`].
|
||||
///
|
||||
/// [`TaggedHash`]: crate::offers::merkle::TaggedHash
|
||||
fn sign_bolt12_invoice_request(
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue