Skip to content

Commit 6f7df83

Browse files
committed
Re-write Offer::issuer_signing_pubkey documentation
1 parent 2782110 commit 6f7df83

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

lightning/src/offers/offer.rs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,17 @@ macro_rules! offer_accessors { ($self: ident, $contents: expr) => {
631631
$contents.supported_quantity()
632632
}
633633

634-
/// The public key used by the recipient to sign invoices.
634+
/// The public key corresponding to the key used by the recipient to sign invoices.
635+
/// - If [`Offer::paths`] is empty, MUST be `Some` and contain the recipient's node id for
636+
/// sending an [`InvoiceRequest`].
637+
/// - If [`Offer::paths`] is not empty, MAY be `Some` and contain a transient id.
638+
/// - If `None`, the signing pubkey will be the final blinded node id from the
639+
/// [`BlindedMessagePath`] in [`Offer::paths`] used to send the [`InvoiceRequest`].
640+
///
641+
/// See also [`Bolt12Invoice::signing_pubkey`].
642+
///
643+
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
644+
/// [`Bolt12Invoice::signing_pubkey`]: crate::offers::invoice::Bolt12Invoice::signing_pubkey
635645
pub fn issuer_signing_pubkey(&$self) -> Option<bitcoin::secp256k1::PublicKey> {
636646
$contents.issuer_signing_pubkey()
637647
}

0 commit comments

Comments
 (0)