Struct ConfigurableAmountPaymentInstructions 

pub struct ConfigurableAmountPaymentInstructions { /* private fields */ }

Parsed payment instructions representing a set of possible ways to pay a configurable quantity of Bitcoin, as well as some associated metadata.

Implementations

impl ConfigurableAmountPaymentInstructions

pub fn min_amt(&self) -> Option<Amount>

The minimum amount which the recipient will accept payment for, if provided as a part of the payment instructions.

pub fn max_amt(&self) -> Option<Amount>

The minimum amount which the recipient will accept payment for, if provided as a part of the payment instructions.

pub fn methods<'a>( &'a self, ) -> impl Iterator<Item = PossiblyResolvedPaymentMethod<'a>>

The supported list of PossiblyResolvedPaymentMethod.

See PossiblyResolvedPaymentMethod::method_type for the specific payment protocol which each payment method will ultimately resolve to.

pub async fn set_amount<R: HrnResolver>( self, amount: Amount, resolver: &R, ) -> Result<FixedAmountPaymentInstructions, &'static str>

Resolve the configurable amount to a fixed amount and create a FixedAmountPaymentInstructions.

May resolve LNURL-Pay instructions that were created from an LN-Address Human Readable Name into a lightning Bolt11Invoice.

Note that for lightning BOLT 11 or BOLT 12 instructions, we cannot modify the invoice/offer itself and thus cannot set a specific amount on the PaymentMethod::LightningBolt11 or PaymentMethod::LightningBolt12 inner fields themselves. Still, FixedAmountPaymentInstructions::ln_payment_amount will return the value provided in amount.

impl ConfigurableAmountPaymentInstructions

pub fn recipient_description(&self) -> Option<&str>

A recipient-provided description of the payment instructions.

This may be:

• the label or message parameter in a BIP 321 bitcoin: URI
• the description field in a lightning BOLT 11 invoice
• the description field in a lightning BOLT 12 offer

pub fn pop_callback(&self) -> Option<&str>

Fetches the proof-of-payment callback URI.

Once a payment has been completed, the proof-of-payment (hex-encoded payment preimage for a lightning BOLT 11 invoice, raw transaction serialized in hex for on-chain payments, not-yet-defined for lightning BOLT 12 invoices) must be appended to this URI and the URI opened with the default system URI handler.

pub fn human_readable_name(&self) -> &Option<HumanReadableName>

Fetches the HumanReadableName which was resolved, if the resolved payment instructions were for a Human Readable Name.

pub fn bip_353_dnssec_proof(&self) -> &Option<Vec<u8>>

Fetches the BIP 353 DNSSEC proof which was used to resolve these payment instructions, if they were resolved from a HumanReadable Name using BIP 353.

This proof should be included in any PSBT output (as type PSBT_OUT_DNSSEC_PROOF) generated using these payment instructions.

It should also be stored to allow us to later prove that this payment was made to Self::human_readable_name.

Trait Implementations

impl Clone for ConfigurableAmountPaymentInstructions

fn clone(&self) -> ConfigurableAmountPaymentInstructions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigurableAmountPaymentInstructions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConfigurableAmountPaymentInstructions

fn eq(&self, other: &ConfigurableAmountPaymentInstructions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConfigurableAmountPaymentInstructions

impl StructuralPartialEq for ConfigurableAmountPaymentInstructions