InvoiceBuilder

Struct InvoiceBuilder 

Source
pub struct InvoiceBuilder { /* private fields */ }
Expand description

Builder for creating BOLT11 invoices.

Implementations§

Source§

impl InvoiceBuilder

Source

pub fn new(network: Network) -> Self

Create a new invoice builder.

Source

pub fn amount_msat(self, amount: u64) -> Self

Set the amount in millisatoshis.

Source

pub fn amount_sats(self, sats: u64) -> Self

Set the amount in satoshis.

Source

pub fn description(self, desc: &str) -> Self

Set the description.

Source

pub fn payment_hash(self, hash: PaymentHash) -> Self

Set the payment hash.

Source

pub fn expiry(self, seconds: u64) -> Self

Set the expiry time in seconds.

Source

pub fn route_hint(self, hint: RouteHint) -> Self

Add a route hint.

Source

pub fn min_final_cltv_expiry(self, blocks: u32) -> Self

Set the minimum final CLTV expiry.

Source

pub fn build(self) -> Result<InvoiceData, LightningError>

Build the invoice data.

Note: This creates the invoice data structure but does not encode it to a full BOLT11 string (which requires signing).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V