Enum SdkError 

pub enum SdkError {
    SparkError(String),
    InsufficientFunds {
        token_identifier: Option<String>,
    },
    InvalidUuid(String),
    InvalidInput(String),
    CrossChainAmountOutOfRange {
        reason: String,
        too_small: bool,
        bound_amount: Option<u128>,
        bound_usd_cents: Option<u64>,
    },
    CrossChainRouteUnavailable {
        reason: String,
        temporary: bool,
    },
    NetworkError(String),
    StorageError(String),
    ChainServiceError(String),
    MaxDepositClaimFeeExceeded {
        tx: String,
        vout: u32,
        max_fee: Option<Fee>,
        required_fee_sats: u64,
        required_fee_rate_sat_per_vbyte: u64,
    },
    MissingUtxo {
        tx: String,
        vout: u32,
    },
    DepositClaimInProgress {
        tx: String,
        vout: u32,
    },
    RefundReplacementFeeTooLow {
        pending_fee_sats: u64,
        required_fee_sats: u64,
    },
    LnurlError(String),
    Signer(String),
    OptimizationAlreadyRunning,
    OptimizationCancelled,
    InsufficientCpfpFunds {
        required_sat: u64,
    },
    Generic(String),
}

Error type for the BreezSdk

Variants

SparkError(String)

InsufficientFunds

Fields

token_identifier: Option<String>

The token that cannot cover the payment. Unset when the shortfall is in sats or when no single token can be named.

InvalidUuid(String)

InvalidInput(String)

Invalid input error

CrossChainAmountOutOfRange

A cross-chain provider rejected the amount as outside what it accepts for the route.

The bound fields carry what the route publishes in the direction that failed, in whichever denominations the provider publishes. A route can enforce a tighter bound than it publishes, so an amount inside the published one can still land here.

The message is the provider’s own rejection text with the published bound appended, so it already names the direction.

Fields

reason: String

too_small: bool

true for a rejection below the minimum, false for one above the maximum or beyond available liquidity.

bound_amount: Option<u128>

The published bound in the base units of the asset paid in: the Spark-side asset on a send, the external asset on a receive.

bound_usd_cents: Option<u64>

The published bound as an order value in USD cents.

CrossChainRouteUnavailable

A cross-chain provider won’t serve the route, for now or at all.

The message leads with a fixed phrase for each case, for bindings that only see the text, followed by the provider’s own reason.

Fields

reason: String

temporary: bool

true when the provider expects the route back shortly, so the same request can succeed later. Otherwise try another route.

NetworkError(String)

Network error

StorageError(String)

Storage error

ChainServiceError(String)

MaxDepositClaimFeeExceeded

Fields

tx: String

vout: u32

max_fee: Option<Fee>

required_fee_sats: u64

required_fee_rate_sat_per_vbyte: u64

MissingUtxo

Fields

tx: String

vout: u32

DepositClaimInProgress

Another claim on this deposit is already running.

Fields

tx: String

vout: u32

RefundReplacementFeeTooLow

A refund for this deposit is already on the network, and the requested replacement does not pay enough to displace it.

Fields

pending_fee_sats: u64

required_fee_sats: u64

LnurlError(String)

Signer(String)

OptimizationAlreadyRunning

optimize_leaves was called while another optimization run (auto or manual) was already in flight.

OptimizationCancelled

optimize_leaves was preempted by the SDK to free leaves for a higher-priority operation (typically a payment).

InsufficientCpfpFunds

The provided CPFP funding is too low to cover the exit’s on-chain fees.

Fields

required_sat: u64

Generic(String)

Trait Implementations

impl Clone for SdkError

fn clone(&self) -> SdkError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkError

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

Formats the value using the given formatter.

impl Display for SdkError

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

Formats the value using the given formatter.

impl Error for SdkError

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<&str> for SdkError

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<BoltzError> for SdkError

fn from(e: BoltzError) -> Self

Converts to this type from the input type.

impl From<ChainServiceError> for SdkError

fn from(e: ChainServiceError) -> Self

Converts to this type from the input type.

impl From<ConversionError> for SdkError

fn from(e: ConversionError) -> Self

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SdkError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<FlashnetError> for SdkError

fn from(e: FlashnetError) -> Self

Converts to this type from the input type.

impl From<FromHexError> for SdkError

fn from(e: FromHexError) -> Self

Converts to this type from the input type.

impl From<HttpError> for SdkError

fn from(value: ServiceConnectivityError) -> Self

Converts to this type from the input type.

impl From<Infallible> for SdkError

fn from(value: Infallible) -> Self

Converts to this type from the input type.

impl From<LnurlError> for SdkError

fn from(e: LnurlError) -> Self

Converts to this type from the input type.

impl From<OptimizationError> for SdkError

fn from(e: OptimizationError) -> Self

Converts to this type from the input type.

impl From<ParseError> for SdkError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for SdkError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<SdkError> for ConversionError

fn from(source: SdkError) -> Self

Converts to this type from the input type.

impl From<SdkError> for DepositClaimError

fn from(value: SdkError) -> Self

Converts to this type from the input type.

impl From<SparkWalletError> for SdkError

fn from(e: SparkWalletError) -> Self

Converts to this type from the input type.

impl From<StorageError> for SdkError

fn from(e: StorageError) -> Self

Converts to this type from the input type.

impl From<String> for SdkError

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<SystemTimeError> for SdkError

fn from(e: SystemTimeError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for SdkError

fn from(e: TryFromIntError) -> Self

Converts to this type from the input type.

impl From<TryInitError> for SdkError

fn from(_value: TryInitError) -> Self

Converts to this type from the input type.