Struct NewInvoiceParams 

pub struct NewInvoiceParams {
    pub amount: u128,
    pub description: Option<String>,
    pub currency: Currency,
    pub payment_preimage: Option<Hash256>,
    pub payment_hash: Option<Hash256>,
    pub expiry: Option<u64>,
    pub fallback_address: Option<String>,
    pub final_expiry_delta: Option<u64>,
    pub udt_type_script: Option<Script>,
    pub hash_algorithm: Option<HashAlgorithm>,
    pub allow_mpp: Option<bool>,
    pub allow_trampoline_routing: Option<bool>,
}

The parameter struct for generating a new invoice.

Fields

amount: u128

The amount of the invoice.

description: Option<String>

The description of the invoice.

currency: Currency

The currency of the invoice.

payment_preimage: Option<Hash256>

The preimage to settle an incoming TLC payable to this invoice. If preimage is set, hash must be absent. If both preimage and hash are absent, a random preimage is generated.

payment_hash: Option<Hash256>

The hash of the preimage. If hash is set, preimage must be absent. This condition indicates a ‘hold invoice’ for which the tlc must be accepted and held until the preimage becomes known.

expiry: Option<u64>

The expiry time of the invoice, in seconds.

fallback_address: Option<String>

The fallback address of the invoice.

final_expiry_delta: Option<u64>

The final HTLC timeout of the invoice, in milliseconds. Minimal value is 16 hours, and maximal value is 14 days.

udt_type_script: Option<Script>

The UDT type script of the invoice.

hash_algorithm: Option<HashAlgorithm>

The hash algorithm of the invoice.

allow_mpp: Option<bool>

Whether allow payment to use MPP

allow_trampoline_routing: Option<bool>

Whether allow payment to use trampoline routing

Trait Implementations

impl Clone for NewInvoiceParams

fn clone(&self) -> NewInvoiceParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for NewInvoiceParams

fn default() -> NewInvoiceParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NewInvoiceParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for NewInvoiceParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for NewInvoiceParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.