soroban-client 0.5.7

A high-level library Rust client library for interacting with Soroban smart contracts on the Stellar blockchain
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

/// Error Handling in `soroban_client` crate
/// This module defines all possible error types used in the `soroban_client` crate.
use stellar_baselib::xdr::SorobanTransactionData;
use thiserror::Error;

/// Possible error for AuthMode in simulation request
#[derive(Error, Debug)]
pub enum AuthModeError {
    /// Error while converting AuthMode
    #[error("Invalid auth mode: {0}, should be one of 'enforce', 'record', 'record_allow_nonroot' or be omitted")]
    Invalid(String),
}

/// Possible error types
#[derive(Error, Debug)]
pub enum Error {
    /// Error for invalid RPC URL
    #[error(transparent)]
    InvalidRpc(#[from] InvalidRpcUrl),
    /// Error when XDR processing fails
    #[error("XdrError")]
    XdrError,
    /// Error when JSON parsing fails, with a descriptive message
    #[error("JsonError: could not parse {0}")]
    JsonError(String),
    /// Error for network-related failures
    #[error("NetworkError")]
    NetworkError(#[from] reqwest::Error),
    /// Error when an account is not found
    #[error("AccountError")]
    AccountNotFound,
    /// Error when contract data is missing
    #[error("ContractError")]
    ContractDataNotFound,
    /// Error for general transaction failures
    #[error("TransactionError")]
    TransactionError,
    /// Error for invalid Soroban transactions
    #[error("InvalidSorobanTransaction")]
    InvalidSorobanTransaction,
    /// Error when a simulation fails
    #[error("SimulationFailed: `{0}`")]
    SimulationFailed(String),
    /// Error when restoration is required with additional data
    #[error("RestorationRequired")]
    RestorationRequired(i64, SorobanTransactionData),
    /// Error for RPC failures, includes code and message
    #[error("RPCError {code}: {message}")]
    RPCError {
        /// The error code returned from the RPC
        code: i32,
        /// The error message returned from the RPC
        message: String,
    },
    /// Unexpected error, should be reported
    #[error("UnexpectedError")]
    UnexpectedError,
    /// Error when Friendbot is not available on the current network
    #[error("NoFriendbot")]
    NoFriendbot,
    /// Error when a timeout occurs
    #[error("Timeout of {0}s reached after {1}s while waiting for a transaction to complete")]
    WaitTransactionTimeout(u64, u64),
    /// Error when a function is not implemented, you probably need to enable a feature
    #[error("NotImplemented: `{0}`")]
    NotImplemented(String),
}

/// Possible  errors for invalid RPC URLs
#[derive(Error, Debug)]
pub enum InvalidRpcUrl {
    /// Error when the URL scheme is not HTTP or HTTPS
    #[error("The RPC Url scheme should be http or https")]
    NotHttpScheme,
    /// Error when insecure HTTP URLs are used without explicit permission
    #[error("Http scheme requires the option allow_http: true")]
    UnsecureHttpNotAllowed,
    /// Error when the provided URL is invalid
    #[error("InvalidUrl")]
    InvalidUri,
}