Enum SuiError

pub enum SuiError {
    UserInputError {
        error: UserInputError,
    },
    SuiObjectResponseError {
        error: SuiObjectResponseError,
    },
    UnexpectedOwnerType,
    TooManyTransactionsPendingExecution {
        queue_len: usize,
        threshold: usize,
    },
    TooManyTransactionsPendingConsensus,
    TooManyTransactionsPendingOnObject {
        object_id: ObjectID,
        queue_len: usize,
        threshold: usize,
    },
    TooOldTransactionPendingOnObject {
        object_id: ObjectID,
        txn_age_sec: u64,
        threshold: u64,
    },
    InvalidTxKindInSoftBundle,
    InvalidSignature {
        error: String,
    },
    SignerSignatureAbsent {
        expected: String,
        actual: Vec<String>,
    },
    SignerSignatureNumberMismatch {
        expected: usize,
        actual: usize,
    },
    IncorrectSigner {
        error: String,
    },
    UnknownSigner {
        signer: Option<String>,
        index: Option<u32>,
        committee: Box<Committee>,
    },
    StakeAggregatorRepeatedSigner {
        signer: AuthorityName,
        conflicting_sig: bool,
    },
    PotentiallyTemporarilyInvalidSignature {
        error: String,
    },
    WrongEpoch {
        expected_epoch: EpochId,
        actual_epoch: EpochId,
    },
    CertificateRequiresQuorum,
    DEPRECATED_ErrorWhileProcessingCertificate,
    QuorumFailedToGetEffectsQuorumWhenProcessingTransaction {
        effects_map: BTreeMap<TransactionEffectsDigest, (Vec<AuthorityName>, StakeUnit)>,
    },
    FailedToVerifyTxCertWithExecutedEffects {
        validator_name: AuthorityName,
        error: String,
    },
    TxAlreadyFinalizedWithDifferentUserSigs,
    InvalidAuthenticator,
    InvalidAddress,
    InvalidTransactionDigest,
    InvalidDigestLength {
        expected: usize,
        actual: usize,
    },
    InvalidDkgMessageSize,
    UnexpectedMessage(String),
    ModuleVerificationFailure {
        error: String,
    },
    ModuleDeserializationFailure {
        error: String,
    },
    ModulePublishFailure {
        error: String,
    },
    ModuleBuildFailure {
        error: String,
    },
    FunctionNotFound {
        error: String,
    },
    ModuleNotFound {
        module_name: String,
    },
    TypeError {
        error: String,
    },
    CircularObjectOwnership,
    ObjectLockAlreadyInitialized {
        refs: Vec<ObjectRef>,
    },
    ObjectLockConflict {
        obj_ref: ObjectRef,
        pending_transaction: TransactionDigest,
    },
    ObjectLockedAtFutureEpoch {
        obj_refs: Vec<ObjectRef>,
        locked_epoch: EpochId,
        new_epoch: EpochId,
        locked_by_tx: TransactionDigest,
    },
    TransactionNotFound {
        digest: TransactionDigest,
    },
    TransactionsNotFound {
        digests: Vec<TransactionDigest>,
    },
    TransactionEventsNotFound {
        digest: TransactionDigest,
    },
    TransactionEffectsNotFound {
        digest: TransactionDigest,
    },
    TransactionAlreadyExecuted {
        digest: TransactionDigest,
    },
    TransactionRejectReasonNotFound {
        digest: TransactionDigest,
    },
    BadObjectType {
        error: String,
    },
    FailObjectLayout {
        st: String,
    },
    ExecutionInvariantViolation,
    ByzantineAuthoritySuspicion {
        authority: AuthorityName,
        reason: String,
    },
    DEPRECATED_StorageError,
    DEPRECATED_GenericStorageError,
    InvalidChildObjectAccess {
        object: ObjectID,
        given_parent: ObjectID,
        actual_owner: Owner,
    },
    DEPRECATED_StorageMissingFieldError,
    DEPRECATED_StorageCorruptedFieldError,
    GenericAuthorityError {
        error: String,
    },
    GenericBridgeError {
        error: String,
    },
    FailedToDispatchSubscription {
        error: String,
    },
    OwnerFailedToSerialize {
        error: String,
    },
    ExtraFieldFailedToDeserialize {
        error: String,
    },
    TransactionOrchestratorLocalExecutionError {
        error: String,
    },
    TransactionSerializationError {
        error: String,
    },
    TransactionDeserializationError {
        error: String,
    },
    TransactionEffectsSerializationError {
        error: String,
    },
    TransactionEffectsDeserializationError {
        error: String,
    },
    TransactionEventsSerializationError {
        error: String,
    },
    TransactionEventsDeserializationError {
        error: String,
    },
    ObjectSerializationError {
        error: String,
    },
    ObjectDeserializationError {
        error: String,
    },
    NoEventStore,
    TooManyIncorrectAuthorities {
        errors: Vec<(AuthorityName, SuiError)>,
        action: String,
    },
    FullNodeInvalidTxRangeQuery {
        error: String,
    },
    FailedToSubmitToConsensus(String),
    ConsensusConnectionBroken(String),
    HandleConsensusTransactionFailure(String),
    SignatureKeyGenError(String),
    KeyConversionError(String),
    InvalidPrivateKey,
    FullNodeCantHandleCertificate,
    ValidatorHaltedAtEpochEnd,
    EpochEnded(EpochId),
    AdvanceEpochError {
        error: String,
    },
    TransactionExpired,
    RpcError(String, String),
    InvalidRpcMethodError,
    UnsupportedFeatureError {
        error: String,
    },
    QuorumDriverCommunicationError {
        error: String,
    },
    TimeoutError,
    ExecutionError(String),
    InvalidCommittee(String),
    MissingCommitteeAtEpoch(EpochId),
    IndexStoreNotAvailable,
    DynamicFieldReadError(String),
    SuiSystemStateReadError(String),
    SuiBridgeReadError(String),
    UnexpectedVersion(String),
    WrongMessageVersion {
        error: String,
    },
    Unknown(String),
    FileIOError(String),
    JWKRetrievalError,
    Storage(String),
    ValidatorOverloadedRetryAfter {
        retry_after_secs: u64,
    },
    TooManyRequests,
    NoCertificateProvidedError,
    NitroAttestationFailedToVerify(String),
    GrpcMessageSerializeError {
        type_info: String,
        error: String,
    },
    GrpcMessageDeserializeError {
        type_info: String,
        error: String,
    },
    ValidatorConsensusLagging {
        round: u32,
        last_committed_round: u32,
    },
    InvalidAdminRequest(String),
}

Custom error type for Sui.

Variants

UserInputError

Fields

error: UserInputError

SuiObjectResponseError

Fields

error: SuiObjectResponseError

UnexpectedOwnerType

TooManyTransactionsPendingExecution

Fields

queue_len: usize

threshold: usize

TooManyTransactionsPendingConsensus

TooManyTransactionsPendingOnObject

Fields

object_id: ObjectID

queue_len: usize

threshold: usize

TooOldTransactionPendingOnObject

Fields

object_id: ObjectID

txn_age_sec: u64

threshold: u64

InvalidTxKindInSoftBundle

InvalidSignature

Fields

error: String

SignerSignatureAbsent

Fields

expected: String

actual: Vec<String>

SignerSignatureNumberMismatch

Fields

expected: usize

actual: usize

IncorrectSigner

Fields

error: String

UnknownSigner

Fields

signer: Option<String>

index: Option<u32>

committee: Box<Committee>

StakeAggregatorRepeatedSigner

Fields

signer: AuthorityName

conflicting_sig: bool

PotentiallyTemporarilyInvalidSignature

Fields

error: String

WrongEpoch

Fields

expected_epoch: EpochId

actual_epoch: EpochId

CertificateRequiresQuorum

DEPRECATED_ErrorWhileProcessingCertificate

QuorumFailedToGetEffectsQuorumWhenProcessingTransaction

Fields

effects_map: BTreeMap<TransactionEffectsDigest, (Vec<AuthorityName>, StakeUnit)>

FailedToVerifyTxCertWithExecutedEffects

Fields

validator_name: AuthorityName

error: String

TxAlreadyFinalizedWithDifferentUserSigs

InvalidAuthenticator

InvalidAddress

InvalidTransactionDigest

InvalidDigestLength

Fields

expected: usize

actual: usize

InvalidDkgMessageSize

UnexpectedMessage(String)

ModuleVerificationFailure

Fields

error: String

ModuleDeserializationFailure

Fields

error: String

ModulePublishFailure

Fields

error: String

ModuleBuildFailure

Fields

error: String

FunctionNotFound

Fields

error: String

ModuleNotFound

Fields

module_name: String

TypeError

Fields

error: String

CircularObjectOwnership

ObjectLockAlreadyInitialized

Fields

refs: Vec<ObjectRef>

ObjectLockConflict

Fields

obj_ref: ObjectRef

pending_transaction: TransactionDigest

ObjectLockedAtFutureEpoch

Fields

obj_refs: Vec<ObjectRef>

locked_epoch: EpochId

new_epoch: EpochId

locked_by_tx: TransactionDigest

TransactionNotFound

Fields

digest: TransactionDigest

TransactionsNotFound

Fields

digests: Vec<TransactionDigest>

TransactionEventsNotFound

Fields

digest: TransactionDigest

TransactionEffectsNotFound

Fields

digest: TransactionDigest

TransactionAlreadyExecuted

Fields

digest: TransactionDigest

TransactionRejectReasonNotFound

Fields

digest: TransactionDigest

BadObjectType

Fields

error: String

FailObjectLayout

Fields

st: String

ExecutionInvariantViolation

ByzantineAuthoritySuspicion

Fields

authority: AuthorityName

reason: String

DEPRECATED_StorageError

DEPRECATED_GenericStorageError

InvalidChildObjectAccess

Fields

object: ObjectID

given_parent: ObjectID

actual_owner: Owner

DEPRECATED_StorageMissingFieldError

DEPRECATED_StorageCorruptedFieldError

GenericAuthorityError

Fields

error: String

GenericBridgeError

Fields

error: String

FailedToDispatchSubscription

Fields

error: String

OwnerFailedToSerialize

Fields

error: String

ExtraFieldFailedToDeserialize

Fields

error: String

TransactionOrchestratorLocalExecutionError

Fields

error: String

TransactionSerializationError

Fields

error: String

TransactionDeserializationError

Fields

error: String

TransactionEffectsSerializationError

Fields

error: String

TransactionEffectsDeserializationError

Fields

error: String

TransactionEventsSerializationError

Fields

error: String

TransactionEventsDeserializationError

Fields

error: String

ObjectSerializationError

Fields

error: String

ObjectDeserializationError

Fields

error: String

NoEventStore

TooManyIncorrectAuthorities

Fields

errors: Vec<(AuthorityName, SuiError)>

action: String

FullNodeInvalidTxRangeQuery

Fields

error: String

FailedToSubmitToConsensus(String)

ConsensusConnectionBroken(String)

HandleConsensusTransactionFailure(String)

SignatureKeyGenError(String)

KeyConversionError(String)

InvalidPrivateKey

FullNodeCantHandleCertificate

ValidatorHaltedAtEpochEnd

EpochEnded(EpochId)

AdvanceEpochError

Fields

error: String

TransactionExpired

RpcError(String, String)

InvalidRpcMethodError

UnsupportedFeatureError

Fields

error: String

QuorumDriverCommunicationError

Fields

error: String

TimeoutError

ExecutionError(String)

InvalidCommittee(String)

MissingCommitteeAtEpoch(EpochId)

IndexStoreNotAvailable

DynamicFieldReadError(String)

SuiSystemStateReadError(String)

SuiBridgeReadError(String)

UnexpectedVersion(String)

WrongMessageVersion

Fields

error: String

Unknown(String)

FileIOError(String)

JWKRetrievalError

Storage(String)

ValidatorOverloadedRetryAfter

Fields

retry_after_secs: u64

TooManyRequests

NoCertificateProvidedError

NitroAttestationFailedToVerify(String)

GrpcMessageSerializeError

Fields

type_info: String

error: String

GrpcMessageDeserializeError

Fields

type_info: String

error: String

ValidatorConsensusLagging

Fields

round: u32

last_committed_round: u32

InvalidAdminRequest(String)

Implementations

impl SuiError

pub fn individual_error_indicates_epoch_change(&self) -> bool

pub fn is_retryable(&self) -> (bool, bool)

Returns if the error is retryable and if the error’s retryability is explicitly categorized. There should be only a handful of retryable errors. For now we list common non-retryable error below to help us find more retryable errors in logs.

pub fn is_transaction_submission_retriable(&self) -> bool

Checks if this error is retriable with transaction resubmission attempts, when this error is received outside of validators during transaction lifecycle.

When a non-retriable error is returned by an honest validator during transaction submission or effects query, this and other honest validators will never vote to accept the same transaction with the same user signature. So this transaction can never be finalized and retrying submission will not help.

Also, when an error is categorized as non-retriable, we expect some consistency among honest validators in also returning non-retriable errors for the same transaction when there are no other temporary failures (network, overload, etc).

SuiError contains many variants unrelated to transaction processing. They can be returned externally by malicious validators or due to software bugs. These variants are considered retriable, because they don’t meet the criteria for non-retriable errors above.

pub fn is_object_or_package_not_found(&self) -> bool

pub fn is_overload(&self) -> bool

pub fn is_retryable_overload(&self) -> bool

pub fn retry_after_secs(&self) -> u64

Trait Implementations

impl AsRef<str> for SuiError

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SuiError

fn clone(&self) -> SuiError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SuiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SuiError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SuiError

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

Formats the value using the given formatter.

impl Error for SuiError

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<'_derivative_strum> From<&'_derivative_strum SuiError> for &'static str

fn from(x: &'_derivative_strum SuiError) -> &'static str

Converts to this type from the input type.

impl From<&str> for SuiError

fn from(error: &str) -> Self

Converts to this type from the input type.

impl From<Error> for SuiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SuiError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ExecutionError> for SuiError

fn from(error: ExecutionError) -> Self

Converts to this type from the input type.

impl From<ExecutionFailureStatus> for SuiError

fn from(kind: ExecutionErrorKind) -> Self

Converts to this type from the input type.

impl From<NitroAttestationVerifyError> for SuiError

fn from(err: NitroAttestationVerifyError) -> Self

Converts to this type from the input type.

impl From<Status> for SuiError

fn from(status: Status) -> Self

Converts to this type from the input type.

impl From<String> for SuiError

fn from(error: String) -> Self

Converts to this type from the input type.

impl From<SuiError> for &'static str

fn from(x: SuiError) -> &'static str

Converts to this type from the input type.

impl From<SuiError> for Status

fn from(error: SuiError) -> Self

Converts to this type from the input type.

impl From<SuiObjectResponseError> for SuiError

fn from(error: SuiObjectResponseError) -> Self

Converts to this type from the input type.

impl From<TypedStoreError> for SuiError

fn from(e: TypedStoreError) -> Self

Converts to this type from the input type.

impl From<UserInputError> for SuiError

fn from(error: UserInputError) -> Self

Converts to this type from the input type.

impl Hash for SuiError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SuiError

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SuiError

fn eq(&self, other: &SuiError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SuiError

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SuiError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SuiError> for UserInputError

type Error = Error

The type returned in the event of a conversion error.

fn try_from(err: SuiError) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SuiError

impl StructuralPartialEq for SuiError