Enum PayBolt11InvoiceError 

#[non_exhaustive]
pub enum PayBolt11InvoiceError {
    PreviousPaymentAttemptStillInProgress {
        operation_id: OperationId,
    },
    NoLnGatewayAvailable,
    FundedContractAlreadyExists {
        contract_id: ContractId,
    },
    InvoiceExpired,
    WrongCurrency {
        expected: Currency,
        found: Currency,
    },
    MissingInvoiceAmount,
    GatewayUnavailable(ServerError),
    NoConsensusBlockCount,
    Federation(Box<FederationError>),
    InternalContract(IncomingSmError),
    PaymentMarkers(Error),
    ExtraMeta(Error),
    Database(DatabaseError),
    Transaction(TransactionSubmitError),
}

A failure to pay a BOLT11 invoice.

The first three variants predate this type’s move into this module and are the conditions a caller most often has to react to: an attempt that is still running, no gateway to route through, and a contract that someone has already funded for this payment hash. The rest name what used to be folded into one opaque message: the invoice itself being unusable, the gateway or the federation refusing, and the transaction failing to submit.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PreviousPaymentAttemptStillInProgress

An earlier attempt to pay this same invoice has not finished.

Fields

operation_id: OperationId

The operation the earlier attempt runs under.

NoLnGatewayAvailable

The payment has to go out over Lightning and no gateway was supplied.

FundedContractAlreadyExists

A contract for this payment hash is already funded, so funding another would pay twice.

Fields

contract_id: ContractId

The contract that already holds funds.

InvoiceExpired

The invoice’s expiry has passed, so the recipient will not accept the payment.

WrongCurrency

The invoice is for a different chain than this federation runs on.

Fields

expected: Currency

The currency this federation’s network implies.

found: Currency

The currency the invoice names.

MissingInvoiceAmount

The invoice carries no amount, so there is nothing to lock into a contract.

GatewayUnavailable(ServerError)

The chosen gateway did not answer, so funding a contract for it would lock money up with nobody to claim it.

NoConsensusBlockCount

The federation did not report a consensus block count, so the contract’s timelock cannot be computed.

Federation(Box<FederationError>)

A request to the federation failed.

InternalContract(IncomingSmError)

The internal (federation-settled) contract for this payment could not be built.

PaymentMarkers(Error)

This client’s internal-payment markers could not be derived, so an internal payment cannot be recognised.

ExtraMeta(Error)

The caller’s extra metadata could not be serialized into the operation log.

Database(DatabaseError)

The payment attempt could not be written to the database.

Transaction(TransactionSubmitError)

The transaction funding the payment could not be built or submitted.

Trait Implementations

impl Debug for PayBolt11InvoiceError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PayBolt11InvoiceError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for PayBolt11InvoiceError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DatabaseError> for PayBolt11InvoiceError

fn from(source: DatabaseError) -> Self

Converts to this type from the input type.

impl From<FederationError> for PayBolt11InvoiceError

fn from(source: FederationError) -> Self

Converts to this type from the input type.

impl From<PayBolt11InvoiceError> for CliCommandError

fn from(source: PayBolt11InvoiceError) -> Self

Converts to this type from the input type.

impl From<PayBolt11InvoiceError> for RpcError

fn from(source: PayBolt11InvoiceError) -> Self

Converts to this type from the input type.

impl From<TransactionSubmitError> for PayBolt11InvoiceError

fn from(source: TransactionSubmitError) -> Self

Converts to this type from the input type.