Struct CreateInvoiceRequest

pub struct CreateInvoiceRequest {
    pub expiration_secs: Option<u32>,
    pub amount: Option<Amount>,
    pub description: Option<String>,
    pub payer_note: Option<String>,
}

A request to create a BOLT 11 invoice.

Fields

expiration_secs: Option<u32>

The expiration, in seconds, to encode into the invoice. If no duration is provided, the expiration time defaults to 86400 (1 day).

amount: Option<Amount>

Optionally include an amount, in sats, to encode into the invoice. If no amount is provided, the sender will specify how much to pay.

description: Option<String>

The description to be encoded into the invoice. The sender will see this description when they scan the invoice.

payer_note: Option<String>

An optional note received from the payer out-of-band via LNURL-pay that is stored with this inbound payment. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

Trait Implementations

impl Default for CreateInvoiceRequest

fn default() -> CreateInvoiceRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateInvoiceRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateInvoiceRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateInvoiceRequest> for CreateInvoiceRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: CreateInvoiceRequest) -> Result<Self>

Performs the conversion.