Enum AptosError 

pub enum AptosError {
    Http(Error),
    Json(Error),
    Bcs(String),
    Url(ParseError),
    Hex(FromHexError),
    InvalidAddress(String),
    InvalidPublicKey(String),
    InvalidPrivateKey(String),
    InvalidSignature(String),
    SignatureVerificationFailed,
    InvalidTypeTag(String),
    Transaction(String),
    SimulationFailed(String),
    SubmissionFailed(String),
    ExecutionFailed {
        vm_status: String,
    },
    TransactionTimeout {
        hash: String,
        timeout_secs: u64,
    },
    Api {
        status_code: u16,
        message: String,
        error_code: Option<String>,
        vm_error_code: Option<u64>,
    },
    RateLimited {
        retry_after_secs: Option<u64>,
    },
    NotFound(String),
    AccountNotFound(String),
    InvalidMnemonic(String),
    InvalidJwt(String),
    KeyDerivation(String),
    InsufficientSignatures {
        required: usize,
        provided: usize,
    },
    FeatureNotEnabled(String),
    Config(String),
    Internal(String),
    Other(Error),
}

The main error type for the Aptos SDK.

This enum covers all possible error conditions that can occur when interacting with the Aptos blockchain through this SDK.

Variants

Http(Error)

Error occurred during HTTP communication

Json(Error)

Error occurred during JSON serialization/deserialization

Bcs(String)

Error occurred during BCS serialization/deserialization

Url(ParseError)

Error occurred during URL parsing

Hex(FromHexError)

Error occurred during hex encoding/decoding

InvalidAddress(String)

Invalid account address

InvalidPublicKey(String)

Invalid public key

InvalidPrivateKey(String)

Invalid private key

InvalidSignature(String)

Invalid signature

SignatureVerificationFailed

Signature verification failed

InvalidTypeTag(String)

Invalid type tag format

Transaction(String)

Transaction building error

SimulationFailed(String)

Transaction simulation failed

SubmissionFailed(String)

Transaction submission failed

ExecutionFailed

Transaction execution failed on chain

Fields

vm_status: String

The VM status message explaining the failure

TransactionTimeout

Transaction timed out waiting for confirmation

Fields

hash: String

The hash of the transaction that timed out

timeout_secs: u64

How long we waited before timing out

Api

API returned an error response

Fields

status_code: u16

HTTP status code

message: String

Error message from the API

error_code: Option<String>

Optional error code from the API

vm_error_code: Option<u64>

Optional VM error code

RateLimited

Rate limited by the API

Fields

retry_after_secs: Option<u64>

How long to wait before retrying (if provided)

NotFound(String)

Resource not found

AccountNotFound(String)

Account not found

InvalidMnemonic(String)

Invalid mnemonic phrase

InvalidJwt(String)

Invalid JWT

KeyDerivation(String)

Key derivation error

InsufficientSignatures

Insufficient signatures for multi-signature operation

Fields

required: usize

Number of signatures required

provided: usize

Number of signatures provided

FeatureNotEnabled(String)

Feature not enabled

Config(String)

Configuration error

Internal(String)

Internal SDK error (should not happen)

Other(Error)

Any other error

Implementations

impl AptosError

pub fn bcs<E: Display>(err: E) -> Self

Creates a new BCS error

pub fn transaction<S: Into<String>>(msg: S) -> Self

Creates a new transaction error

pub fn api(status_code: u16, message: impl Into<String>) -> Self

Creates a new API error from response details

pub fn api_with_details( status_code: u16, message: impl Into<String>, error_code: Option<String>, vm_error_code: Option<u64>, ) -> Self

Creates a new API error with additional details

pub fn is_not_found(&self) -> bool

Returns true if this is a “not found” error

pub fn is_timeout(&self) -> bool

Returns true if this is a timeout error

pub fn is_retryable(&self) -> bool

Returns true if this is a transient error that might succeed on retry

pub fn sanitized_message(&self) -> String

Returns a sanitized version of the error message safe for logging.

This method:

• Removes control characters that could corrupt logs
• Truncates very long messages to prevent log flooding
• Redacts patterns that might indicate sensitive information

Example

use aptos_sdk::AptosError;

let err = AptosError::api(500, "Internal server error with details...");
let safe_msg = err.sanitized_message();
// safe_msg is guaranteed to be safe for logging

pub fn user_message(&self) -> &'static str

Returns the error message suitable for display to end users.

This is a more conservative sanitization that provides less detail but is safer for user-facing error messages.

Trait Implementations

impl Debug for AptosError

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

Formats the value using the given formatter.

impl Display for AptosError

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

Formats the value using the given formatter.

impl Error for AptosError

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<Error> for AptosError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AptosError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AptosError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromHexError> for AptosError

fn from(source: FromHexError) -> Self

Converts to this type from the input type.

impl From<ParseError> for AptosError

fn from(source: ParseError) -> Self

Converts to this type from the input type.