Struct OfferFromHrn

pub struct OfferFromHrn {
    pub offer: Offer,
    pub hrn: HumanReadableName,
}

An Offer which was fetched from a human readable name, ie through BIP 353.

Fields

offer: Offer

The offer itself.

When you resolve this into an InvoiceRequestBuilder you must call InvoiceRequestBuilder::sourced_from_human_readable_name.

If you call Self::request_invoice rather than Offer::request_invoice this will be handled for you.

hrn: HumanReadableName

The human readable name which was resolved to fetch the Self::offer.

Implementations

impl OfferFromHrn

pub fn request_invoice<'a, 'b, T: Signing>( &'a self, expanded_key: &ExpandedKey, nonce: Nonce, secp_ctx: &'b Secp256k1<T>, payment_id: PaymentId, ) -> Result<InvoiceRequestBuilder<'a, 'b, T>, Bolt12SemanticError>

Creates an InvoiceRequestBuilder for the offer, which

• derives the InvoiceRequest::payer_signing_pubkey such that a different key can be used for each request in order to protect the sender’s privacy,
• sets InvoiceRequest::payer_metadata when InvoiceRequestBuilder::build_and_sign 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, and
• includes the PaymentId encrypted in InvoiceRequest::payer_metadata so that it can be used when sending the payment for the requested invoice.

Errors if the offer contains unknown required features.