Struct lightning::offers::invoice_request::InvoiceRequestBuilder

pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: Signing> { /* private fields */ }

Builds an InvoiceRequest from an Offer for the “offer to be paid” flow.

See module-level documentation for usage.

This is not exported to bindings users as builder patterns don’t map outside of move semantics.

Implementations

impl<'a, 'b, T: Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T>

pub fn build(self) -> Result<UnsignedInvoiceRequest, Bolt12SemanticError>

Builds an unsigned InvoiceRequest after checking for valid semantics. It can be signed by UnsignedInvoiceRequest::sign.

impl<'a, 'b, T: Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T>

pub fn build_and_sign(self) -> Result<InvoiceRequest, Bolt12SemanticError>

Builds a signed InvoiceRequest after checking for valid semantics.

impl<'a, 'b, P: PayerIdStrategy, T: Signing> InvoiceRequestBuilder<'a, 'b, P, T>

pub fn chain(self, network: Network) -> Result<Self, Bolt12SemanticError>

Sets the InvoiceRequest::chain of the given Network for paying an invoice. If not called, Network::Bitcoin is assumed. Errors if the chain for network is not supported by the offer.

Successive calls to this method will override the previous setting.

pub fn amount_msats( self, amount_msats: u64 ) -> Result<Self, Bolt12SemanticError>

Sets the InvoiceRequest::amount_msats for paying an invoice. Errors if amount_msats is not at least the expected invoice amount (i.e., Offer::amount times quantity).

Successive calls to this method will override the previous setting.

pub fn quantity(self, quantity: u64) -> Result<Self, Bolt12SemanticError>

Sets InvoiceRequest::quantity of items. If not set, 1 is assumed. Errors if quantity does not conform to Offer::is_valid_quantity.

Successive calls to this method will override the previous setting.

pub fn payer_note(self, payer_note: String) -> Self

Sets the InvoiceRequest::payer_note.

Successive calls to this method will override the previous setting.