Struct Bolt11InvoiceParameters

pub struct Bolt11InvoiceParameters {
    pub amount_msats: Option<u64>,
    pub description: Bolt11InvoiceDescription,
    pub invoice_expiry_delta_secs: Option<u32>,
    pub min_final_cltv_expiry_delta: Option<u16>,
    pub payment_hash: Option<PaymentHash>,
}

Parameters used with create_bolt11_invoice.

Fields

amount_msats: Option<u64>

The amount for the invoice, if any.

description: Bolt11InvoiceDescription

The description for what the invoice is for, or hash of such description.

invoice_expiry_delta_secs: Option<u32>

The invoice expiration relative to its creation time. If not set, the invoice will expire in [DEFAULT_EXPIRY_TIME] by default.

The creation time used is the duration since the Unix epoch for std builds. For non-std builds, the highest block timestamp seen is used instead. In the latter case, use a long enough expiry to account for the average block time.

min_final_cltv_expiry_delta: Option<u16>

The minimum cltv_expiry for the last HTLC in the route. If not set, will use MIN_FINAL_CLTV_EXPIRY_DELTA.

If set, must be at least MIN_FINAL_CLTV_EXPIRY_DELTA, and a three-block buffer will be added as well to allow for up to a few new block confirmations during routing.

payment_hash: Option<PaymentHash>

The payment hash used in the invoice. If not set, a payment hash will be generated using a preimage that can be reproduced by ChannelManager without storing any state.

Uses the payment hash if set. This may be useful if you’re building an on-chain swap or involving another protocol where the payment hash is also involved outside the scope of lightning.

Trait Implementations

impl Default for Bolt11InvoiceParameters

fn default() -> Bolt11InvoiceParameters

Returns the “default value” for a type.