Enum SparkSdkError

pub enum SparkSdkError {
    Network(NetworkError),
    Wallet(WalletError),
    Crypto(CryptoError),
    Validation(ValidationError),
    Transaction(TransactionError),
    Io(IoError),
    Internal(InternalError),
    General(String),
}

Main error type for the Spark Wallet SDK.

This enum wraps all subcategory errors and provides a uniform error interface for SDK functions. Most SDK methods return Result<T, SparkSdkError>.

When handling errors, you can either match on the specific error type:

match error {
    SparkSdkError::Network(network_error) => {
        // Handle network-specific errors
        println!("Network error: {}", network_error);
    },
    SparkSdkError::Wallet(wallet_error) => {
        // Handle wallet-specific errors
        println!("Wallet error: {}", wallet_error);
    },
    // Other error categories...
    _ => println!("Other error: {}", error),
}

Or simply use the error’s Display implementation for general handling:

println!("Error occurred: {}", error);

Variants

Network(NetworkError)

Network communication errors, including RPC calls and HTTP requests.

Wallet(WalletError)

Wallet operation errors, including leaf management and funds handling.

Crypto(CryptoError)

Cryptographic operation errors, including signing and key management.

Validation(ValidationError)

Input validation errors, parameter checking, and verification issues.

Transaction(TransactionError)

Bitcoin transaction errors, including creation and processing issues.

Io(IoError)

Input/output errors, including serialization and file operations.

Internal(InternalError)

SDK internal errors, typically for initialization or processing problems.

General(String)

General errors with a string message for cases that don’t fit other categories.

Trait Implementations

impl Debug for SparkSdkError

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

Formats the value using the given formatter.

impl Display for SparkSdkError

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

Formats the value using the given formatter.

impl Error for SparkSdkError

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 SparkSdkError

fn from(s: &str) -> Self

Converts a string slice to a SparkSdkError::General.

This allows passing a string literal directly as an error:

if something_is_wrong() {
    return Err("Something went wrong".into());
}

impl From<CryptoError> for SparkSdkError

fn from(source: CryptoError) -> Self

Converts to this type from the input type.

impl From<Error> for SparkSdkError

fn from(err: Error) -> Self

Converts a tonic transport error to a SparkSdkError::Network.

impl From<Error> for SparkSdkError

fn from(err: Error) -> Self

Converts a secp256k1 error to a SparkSdkError::Crypto.

impl From<InternalError> for SparkSdkError

fn from(source: InternalError) -> Self

Converts to this type from the input type.

impl From<IoError> for SparkSdkError

fn from(source: IoError) -> Self

Converts to this type from the input type.

impl From<NetworkError> for SparkSdkError

fn from(source: NetworkError) -> Self

Converts to this type from the input type.

impl From<String> for SparkSdkError

fn from(s: String) -> Self

Converts a String to a SparkSdkError::General.

This allows passing a string directly as an error:

if something_is_wrong() {
    return Err("Something went wrong".to_string().into());
}

impl From<TransactionError> for SparkSdkError

fn from(source: TransactionError) -> Self

Converts to this type from the input type.

impl From<ValidationError> for SparkSdkError

fn from(source: ValidationError) -> Self

Converts to this type from the input type.

impl From<WalletError> for SparkSdkError

fn from(source: WalletError) -> Self

Converts to this type from the input type.