iota_types/

error.rs

// Copyright (c) 2021, Facebook, Inc. and its affiliates
// Copyright (c) Mysten Labs, Inc.
// Modifications Copyright (c) 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::{collections::BTreeMap, convert::AsRef, fmt::Debug};

use iota_sdk_types::{
    Address, CheckpointContentsDigest, CommandArgumentError, ObjectDigest, ObjectId,
    ObjectReference, Owner, TransactionDigest, TransactionEffectsDigest, Version,
};
use serde::{Deserialize, Serialize};
use strum::{AsRefStr, IntoStaticStr};
use thiserror::Error;
#[cfg(not(target_arch = "wasm32"))]
use tonic::Status;
use typed_store_error::TypedStoreError;

use crate::{
    base_types::*,
    committee::{Committee, EpochId, StakeUnit},
    messages_checkpoint::CheckpointSequenceNumber,
};

#[cfg(test)]
#[path = "unit_tests/error_codec_tests.rs"]
mod error_codec_tests;

pub const TRANSACTION_NOT_FOUND_MSG_PREFIX: &str = "Could not find the referenced transaction";
pub const TRANSACTIONS_NOT_FOUND_MSG_PREFIX: &str = "Could not find the referenced transactions";

#[macro_export]
macro_rules! fp_bail {
    ($e:expr) => {
        return Err($e)
    };
}

#[macro_export(local_inner_macros)]
macro_rules! fp_ensure {
    ($cond:expr, $e:expr) => {
        if !($cond) {
            fp_bail!($e);
        }
    };
}

use iota_sdk_types::ExecutionError as ExecutionFailureStatus;

#[macro_export]
macro_rules! exit_main {
    ($result:expr) => {
        match $result {
            Ok(_) => (),
            Err(err) => {
                let err = format!("{:?}", err);
                println!("{}", err.bold().red());
                std::process::exit(1);
            }
        }
    };
}

#[macro_export]
macro_rules! make_invariant_violation {
    ($($args:expr),* $(,)?) => {{
        if cfg!(debug_assertions) {
            panic!($($args),*)
        }
        ExecutionError::invariant_violation(format!($($args),*))
    }}
}

#[macro_export]
macro_rules! invariant_violation {
    ($($args:expr),* $(,)?) => {
        return Err(make_invariant_violation!($($args),*).into())
    };
}

#[macro_export]
macro_rules! assert_invariant {
    ($cond:expr, $($args:expr),* $(,)?) => {{
        if !$cond {
            invariant_violation!($($args),*)
        }
    }};
}

/// Errors in the user-provided transaction input.
///
/// Embedded in [`IotaError::UserInput`], so it is also sent between nodes:
/// add new variants only at the very end of the enum (see the WARNING on
/// [`IotaError`]).
#[cfg_attr(test, derive(iota_macros::EnumVariantOrder))]
#[derive(
    Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Error, Hash, AsRefStr, IntoStaticStr,
)]
pub enum UserInputError {
    #[error("Mutable object {object_id} cannot appear more than once in one transaction")]
    MutableObjectUsedMoreThanOnce { object_id: ObjectId },
    #[error("Wrong number of parameters for the transaction")]
    ObjectInputArityViolation,
    #[error("Could not find the referenced object {object_id} at version {version:?}")]
    ObjectNotFound {
        object_id: ObjectId,
        version: Option<Version>,
    },
    #[error(
        "Object ID {} Version {} Digest {} is not available for consumption, current version: {current_version}",
        .provided_obj_ref.object_id, .provided_obj_ref.version, .provided_obj_ref.digest
    )]
    ObjectVersionUnavailableForConsumption {
        provided_obj_ref: ObjectReference,
        current_version: Version,
    },
    #[error("Package verification failed: {err}")]
    PackageVerificationTimedout { err: String },
    #[error("Dependent package not found on-chain: {package_id}")]
    DependentPackageNotFound { package_id: ObjectId },
    #[error("Mutable parameter provided, immutable parameter expected")]
    ImmutableParameterExpected { object_id: ObjectId },
    #[error("Size limit exceeded: {limit} is {value}")]
    SizeLimitExceeded { limit: String, value: String },
    #[error(
        "Object {child_id} is owned by object {parent_id}. \
        Objects owned by other objects cannot be used as input arguments"
    )]
    InvalidChildObjectArgument {
        child_id: ObjectId,
        parent_id: ObjectId,
    },
    #[error("Invalid Object digest for object {object_id}. Expected digest : {expected_digest}")]
    InvalidObjectDigest {
        object_id: ObjectId,
        expected_digest: ObjectDigest,
    },
    #[error("Sequence numbers above the maximal value are not usable for transfers")]
    InvalidSequenceNumber,
    #[error("A move object is expected, instead a move package is passed: {object_id}")]
    MovePackageAsObject { object_id: ObjectId },
    #[error("A move package is expected, instead a move object is passed: {object_id}")]
    MoveObjectAsPackage { object_id: ObjectId },
    #[error("Transaction was not signed by the correct sender: {}", error)]
    IncorrectUserSignature { error: String },

    #[error("Object used as shared is not shared")]
    NotSharedObject,
    #[error("The transaction inputs contain duplicated ObjectReference's")]
    DuplicateObjectRefInput,
    #[error("A transaction input {object_id} is inconsistent")]
    InconsistentInput { object_id: ObjectId },

    // Gas related errors
    #[error("Transaction gas payment missing")]
    MissingGasPayment,
    #[error("Gas object is not an owned object with owner: {}", owner)]
    GasObjectNotOwnedObject { owner: Owner },
    #[error("Gas budget: {} is higher than max: {}", gas_budget, max_budget)]
    GasBudgetTooHigh { gas_budget: u64, max_budget: u64 },
    #[error("Gas budget: {} is lower than min: {}", gas_budget, min_budget)]
    GasBudgetTooLow { gas_budget: u64, min_budget: u64 },
    #[error(
        "Balance of gas object {} is lower than the needed amount: {}",
        gas_balance,
        needed_gas_amount
    )]
    GasBalanceTooLow {
        gas_balance: u128,
        needed_gas_amount: u128,
    },
    #[error("Transaction kind does not support Sponsored Transaction")]
    UnsupportedSponsoredTransactionKind,
    #[error(
        "Gas price {} under reference gas price (RGP) {}",
        gas_price,
        reference_gas_price
    )]
    GasPriceUnderRGP {
        gas_price: u64,
        reference_gas_price: u64,
    },
    #[error("Gas price cannot exceed {} nanos", max_gas_price)]
    GasPriceTooHigh { max_gas_price: u64 },
    #[error("Object {object_id} is not a gas object")]
    InvalidGasObject { object_id: ObjectId },
    #[error("Gas object does not have enough balance to cover minimal gas spend")]
    InsufficientBalanceToCoverMinimalGas,

    #[error(
        "Could not find the referenced object {} as the asked version {} is higher than the latest {}",
        object_id,
        asked_version,
        latest_version
    )]
    ObjectSequenceNumberTooHigh {
        object_id: ObjectId,
        asked_version: Version,
        latest_version: Version,
    },
    #[error("Object deleted at reference {:?}", object_ref)]
    ObjectDeleted { object_ref: ObjectReference },
    #[error("Invalid Batch Transaction: {}", error)]
    InvalidBatchTransaction { error: String },
    #[error("This Move function is currently disabled and not available for call")]
    BlockedMoveFunction,
    #[error("Empty input coins for Pay related transaction")]
    EmptyInputCoins,
    #[error("Invalid Move View Function call: {error}")]
    InvalidMoveViewFunction { error: String },

    #[error(
        "IOTA payment transactions use first input coin for gas payment, but found a different gas object"
    )]
    UnexpectedGasPaymentObject,

    #[error("Wrong initial version given for shared object")]
    SharedObjectStartingVersionMismatch,

    #[error("Wrong id given for shared object")]
    SharedObjectIdMismatch,

    #[error(
        "Attempt to transfer object {object_id} that does not have public transfer. Object transfer must be done instead using a distinct Move function call"
    )]
    TransferObjectWithoutPublicTransfer { object_id: ObjectId },

    #[error(
        "TransferObjects, MergeCoin, and Publish cannot have empty arguments. \
        If MakeMoveVec has empty arguments, it must have a type specified"
    )]
    EmptyCommandInput,

    #[error("Transaction is denied: {error}")]
    TransactionDenied { error: String },

    #[error("Feature is not supported: {0}")]
    Unsupported(String),

    #[error("Query transactions with move function input error: {0}")]
    MoveFunctionInput(String),

    #[error("Verified checkpoint not found for sequence number: {0}")]
    VerifiedCheckpointNotFound(CheckpointSequenceNumber),

    #[error("Verified checkpoint not found for digest: {0}")]
    VerifiedCheckpointDigestNotFound(String),

    #[error("Latest checkpoint sequence number not found")]
    LatestCheckpointSequenceNumberNotFound,

    #[error("Checkpoint contents not found for digest: {0}")]
    CheckpointContentsNotFound(CheckpointContentsDigest),

    #[error("Genesis transaction not found")]
    GenesisTransactionNotFound,

    #[error("Transaction {0} not found")]
    TransactionCursorNotFound(u64),

    #[error("Object {object_id} is a system object and cannot be accessed by user transactions")]
    InaccessibleSystemObject { object_id: ObjectId },
    #[error(
        "{max_publish_commands} max publish/upgrade commands allowed, {publish_count} provided"
    )]
    MaxPublishCountExceeded {
        max_publish_commands: u64,
        publish_count: u64,
    },

    #[error("Immutable parameter provided, mutable parameter expected for {object_id}")]
    MutableParameterExpected { object_id: ObjectId },

    #[error("Address {address} is denied for coin {coin_type}")]
    AddressDeniedForCoin { address: Address, coin_type: String },

    #[error("Commands following a command with Random can only be TransferObjects or MergeCoins")]
    PostRandomCommandRestrictions,

    // Soft Bundle related errors
    #[error("Number of transactions exceeds the maximum allowed ({limit}) in a Soft Bundle")]
    TooManyTransactionsInSoftBundle { limit: u64 },
    #[error(
        "Total transactions size ({size}) bytes exceeds the maximum allowed ({limit}) bytes in a Soft Bundle"
    )]
    SoftBundleTooLarge { size: u64, limit: u64 },
    #[error("Transaction {} in Soft Bundle contains no shared objects", digest)]
    NoSharedObject { digest: TransactionDigest },
    #[error("Transaction {} in Soft Bundle has already been executed", digest)]
    AlreadyExecuted { digest: TransactionDigest },
    #[error("At least one certificate in Soft Bundle has already been processed")]
    CertificateAlreadyProcessed,
    #[error(
        "Gas price for transaction {digest} in Soft Bundle mismatch: want {expected}, have {actual}"
    )]
    GasPriceMismatch {
        digest: TransactionDigest,
        expected: u64,
        actual: u64,
    },

    #[error("Coin type is globally paused for use: {coin_type}")]
    CoinTypeGlobalPause { coin_type: String },

    #[error("Invalid identifier found in the transaction: {error}")]
    InvalidIdentifier { error: String },

    // `MoveAuthenticator` related errors
    #[error(
        "Account object {account_id} with version {account_version} was deleted in transaction {transaction_digest}"
    )]
    AccountObjectDeleted {
        account_id: ObjectId,
        account_version: Version,
        transaction_digest: TransactionDigest,
    },
    #[error(
        "Account object {account_id} with version {account_version} is used in a canceled transaction"
    )]
    AccountObjectInCanceledTransaction {
        account_id: ObjectId,
        account_version: Version,
    },
    #[error("Account object {object_id} is not a shared or immutable object that is unsupported")]
    AccountObjectNotSupported { object_id: ObjectId },
    #[error(
        "The fetched account object version {actual_version} does not match the expected version {expected_version}, object id: {object_id}"
    )]
    AccountObjectVersionMismatch {
        object_id: ObjectId,
        expected_version: Version,
        actual_version: Version,
    },
    #[error(
        "The fetched account object digest {actual_digest} does not match the expected digest {expected_digest}, object id: {object_id}"
    )]
    InvalidAccountObjectDigest {
        object_id: ObjectId,
        expected_digest: ObjectDigest,
        actual_digest: ObjectDigest,
    },

    #[error(
        "AuthenticatorFunctionRef {authenticator_function_ref_id} not found for account {account_object_id} with version {account_object_version}"
    )]
    MoveAuthenticatorNotFound {
        authenticator_function_ref_id: ObjectId,
        account_object_id: ObjectId,
        account_object_version: Version,
    },
    #[error("Unable to get a `MoveAuthenticator` object ID for account {account_object_id}")]
    UnableToGetMoveAuthenticatorId { account_object_id: ObjectId },
    #[error(
        "Invalid authenticator function ref field value found for the account {account_object_id}"
    )]
    InvalidAuthenticatorFunctionRefField { account_object_id: ObjectId },

    #[error("Package {package_id} is in the `MoveAuthenticator` input that is unsupported")]
    PackageIsInMoveAuthenticatorInput { package_id: ObjectId },
    #[error(
        "Address-owned object {object_id} is in the `MoveAuthenticator` input that is unsupported"
    )]
    AddressOwnedIsInMoveAuthenticatorInput { object_id: ObjectId },
    #[error(
        "Object-owned object {object_id} is in the `MoveAuthenticator` input that is unsupported"
    )]
    ObjectOwnedIsInMoveAuthenticatorInput { object_id: ObjectId },
    #[error(
        "Mutable shared object {object_id} is in the `MoveAuthenticator` input that is unsupported"
    )]
    MutableSharedIsInMoveAuthenticatorInput { object_id: ObjectId },
}

/// Custom error type for Iota.
///
/// WARNING: This enum is sent between nodes, and the code of a variant is its
/// declaration index. Add new variants only at the very end of the enum, then
/// re-run the unit tests and commit the updated variant-order snapshot from
/// `tests/staged/` together with the change.
///
/// The same rules apply to enums embedded in variant fields, such as
/// [`UserInputError`].
#[cfg_attr(test, derive(iota_macros::EnumVariantOrder))]
#[derive(
    Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Error, Hash, AsRefStr, IntoStaticStr,
)]
pub enum IotaError {
    #[error("Error checking transaction input objects: {error}")]
    UserInput { error: UserInputError },

    #[error("There are already {queue_len} transactions pending, above threshold of {threshold}")]
    TooManyTransactionsPendingExecution { queue_len: usize, threshold: usize },

    #[error("There are too many transactions pending in consensus")]
    TooManyTransactionsPendingConsensus,

    #[error(
        "Input {object_id} already has {queue_len} transactions pending, above threshold of {threshold}"
    )]
    TooManyTransactionsPendingOnObject {
        object_id: ObjectId,
        queue_len: usize,
        threshold: usize,
    },

    #[error(
        "Input {object_id} has a transaction {txn_age_sec} seconds old pending, above threshold of {threshold} seconds"
    )]
    TooOldTransactionPendingOnObject {
        object_id: ObjectId,
        txn_age_sec: u64,
        threshold: u64,
    },

    #[error("Soft bundle must only contain transactions of UserTransaction kind")]
    InvalidTxKindInSoftBundle,

    // Signature verification
    #[error("Signature is not valid: {}", error)]
    InvalidSignature { error: String },
    #[error("Required Signature from {expected} is absent {actual:?}")]
    SignerSignatureAbsent {
        expected: String,
        actual: Vec<String>,
    },
    #[error("Expect {expected} signer signatures but got {actual}")]
    SignerSignatureNumberMismatch { expected: usize, actual: usize },
    #[error("Value was not signed by the correct sender: {}", error)]
    IncorrectSigner { error: String },
    #[error(
        "Value was not signed by a known authority. signer: {:?}, index: {:?}, committee: {committee}",
        signer,
        index
    )]
    UnknownSigner {
        signer: Option<String>,
        index: Option<u32>,
        committee: Box<Committee>,
    },
    #[error(
        "Validator {signer:?} responded multiple signatures for the same message, conflicting: {conflicting_sig}"
    )]
    StakeAggregatorRepeatedSigner {
        signer: AuthorityName,
        conflicting_sig: bool,
    },
    // TODO: Used for distinguishing between different occurrences of invalid signatures, to allow
    // retries in some cases.
    #[error("Signature is not valid, but a retry may result in a valid one: {error}")]
    PotentiallyTemporarilyInvalidSignature { error: String },

    // Certificate verification and execution
    #[error(
        "Signature or certificate from wrong epoch, expected {expected_epoch}, got {actual_epoch}"
    )]
    WrongEpoch {
        expected_epoch: EpochId,
        actual_epoch: EpochId,
    },
    #[error("Signatures in a certificate must form a quorum")]
    CertificateRequiresQuorum,
    #[error("Transaction certificate processing failed: {err}")]
    // DEPRECATED: "local execution" was removed from fullnodes
    ErrorWhileProcessingCertificate { err: String },
    #[error(
        "Failed to get a quorum of signed effects when processing transaction: {effects_map:?}"
    )]
    QuorumFailedToGetEffectsQuorumWhenProcessingTransaction {
        effects_map: BTreeMap<TransactionEffectsDigest, (Vec<AuthorityName>, StakeUnit)>,
    },
    #[error(
        "Failed to verify Tx certificate with executed effects, error: {error}, validator: {validator_name:?}"
    )]
    FailedToVerifyTxCertWithExecutedEffects {
        validator_name: AuthorityName,
        error: String,
    },
    #[error("Transaction is already finalized but with different user signatures")]
    TxAlreadyFinalizedWithDifferentUserSigs,

    // Account access
    #[error("Invalid authenticator")]
    InvalidAuthenticator,
    #[error("Invalid address")]
    InvalidAddress,
    #[error("Invalid transaction digest")]
    InvalidTransactionDigest,
    #[error("Invalid move authentication digest")]
    InvalidMoveAuthenticatorDigest,

    #[error("Invalid digest length. Expected {expected}, got {actual}")]
    InvalidDigestLength { expected: usize, actual: usize },
    #[error("Invalid DKG message size")]
    InvalidDkgMessageSize,

    #[error("Unexpected message")]
    UnexpectedMessage,

    #[error("Failed to execute the Move authenticator, reason: {error}")]
    MoveAuthenticatorExecutionFailure { error: String },

    // Move module publishing related errors
    #[error("Failed to verify the Move module, reason: {error}")]
    ModuleVerificationFailure { error: String },
    #[error("Failed to deserialize the Move module, reason: {error}")]
    ModuleDeserializationFailure { error: String },
    #[error("Failed to publish the Move module(s), reason: {error}")]
    ModulePublishFailure { error: String },
    #[error("Failed to build Move modules: {error}")]
    ModuleBuildFailure { error: String },

    // Move call related errors
    #[error("Function resolution failure: {error}")]
    FunctionNotFound { error: String },
    #[error("Module not found in package: {module_name:?}")]
    ModuleNotFound { module_name: String },
    #[error("Type error while binding function arguments: {error}")]
    Type { error: String },
    #[error("Circular object ownership detected")]
    CircularObjectOwnership,

    // Internal state errors
    #[error("Attempt to re-initialize a transaction lock for objects {refs:?}")]
    ObjectLockAlreadyInitialized { refs: Vec<ObjectReference> },
    #[error("Object {obj_ref:?} already locked by a different transaction: {pending_transaction}")]
    ObjectLockConflict {
        obj_ref: ObjectReference,
        pending_transaction: TransactionDigest,
    },
    #[error(
        "Objects {obj_refs:?} are already locked by a transaction from a future epoch {locked_epoch:?}), attempt to override with a transaction from epoch {new_epoch:?}"
    )]
    ObjectLockedAtFutureEpoch {
        obj_refs: Vec<ObjectReference>,
        locked_epoch: EpochId,
        new_epoch: EpochId,
        locked_by_tx: TransactionDigest,
    },
    #[error("Transaction {digest:?} was recently submitted; duplicate resubmission suppressed")]
    RecentlyResubmitted { digest: TransactionDigest },
    #[error("{TRANSACTION_NOT_FOUND_MSG_PREFIX} [{digest}]")]
    TransactionNotFound { digest: TransactionDigest },
    #[error("{TRANSACTIONS_NOT_FOUND_MSG_PREFIX} [{digests:?}]")]
    TransactionsNotFound { digests: Vec<TransactionDigest> },
    #[error("Could not find the referenced transaction events [{digest}]")]
    TransactionEventsNotFound { digest: TransactionDigest },
    #[error(
        "Attempt to move to `Executed` state an transaction that has already been executed: {digest}"
    )]
    TransactionAlreadyExecuted { digest: TransactionDigest },
    #[error("Object ID did not have the expected type")]
    BadObjectType { error: String },
    #[error("Fail to retrieve Object layout for {st}")]
    FailObjectLayout { st: String },

    #[error("Execution invariant violated")]
    ExecutionInvariantViolation,
    #[error("Validator {authority:?} is faulty in a Byzantine manner: {reason}")]
    ByzantineAuthoritySuspicion {
        authority: AuthorityName,
        reason: String,
    },
    #[error(
        "Attempted to access {object} through parent {given_parent}, \
        but it's actual parent is {actual_owner}"
    )]
    InvalidChildObjectAccess {
        object: ObjectId,
        given_parent: ObjectId,
        actual_owner: Owner,
    },

    #[error("Authority Error: {error}")]
    GenericAuthority { error: String },

    #[error("Failed to dispatch subscription: {error}")]
    FailedToDispatchSubscription { error: String },

    #[error("Failed to serialize Owner: {error}")]
    OwnerFailedToSerialize { error: String },

    #[error("Failed to deserialize fields into JSON: {error}")]
    ExtraFieldFailedToDeserialize { error: String },

    #[error("Failed to execute transaction locally by Orchestrator: {error}")]
    TransactionOrchestratorLocalExecution { error: String },

    // Errors returned by authority and client read API's
    #[error("Failure serializing transaction in the requested format: {error}")]
    TransactionSerialization { error: String },
    #[error("Failure serializing object in the requested format: {error}")]
    ObjectSerialization { error: String },
    #[error("Failure deserializing object in the requested format: {error}")]
    ObjectDeserialization { error: String },
    #[error("Failure deserializing runtime module metadata in the requested format: {error}")]
    RuntimeModuleMetadataDeserialization { error: String },
    #[error("Event store component is not active on this node")]
    NoEventStore,

    // Client side error
    #[error("Too many authority errors were detected for {action}: {errors:?}")]
    TooManyIncorrectAuthorities {
        errors: Vec<(AuthorityName, IotaError)>,
        action: String,
    },
    #[error("Invalid transaction range query to the fullnode: {error}")]
    FullNodeInvalidTxRangeQuery { error: String },

    // Errors related to the authority-consensus interface.
    #[error("Failed to submit transaction to consensus: {0}")]
    FailedToSubmitToConsensus(String),
    #[error("Failed to connect with consensus node: {0}")]
    ConsensusConnectionBroken(String),
    #[error("Failed to execute handle_consensus_transaction on Iota: {0}")]
    HandleConsensusTransactionFailure(String),

    // Cryptography errors.
    #[error("Signature key generation error: {0}")]
    SignatureKeyGen(String),
    #[error("Key Conversion Error: {0}")]
    KeyConversion(String),
    #[error("Invalid Private Key provided")]
    InvalidPrivateKey,

    // Unsupported Operations on Fullnode
    #[error("Fullnode does not support handle_certificate")]
    FullNodeCantHandleCertificate,
    #[error("Fullnode does not support ValidatorV2 endpoints")]
    FullNodeCantHandleValidatorV2,
    #[error("Fullnode does not support handle_authority_capabilities")]
    FullNodeCantHandleAuthorityCapabilities,

    // Epoch related errors.
    #[error("Validator temporarily stopped processing transactions due to epoch change")]
    ValidatorHaltedAtEpochEnd,
    #[error("Operations for epoch {0} have ended")]
    EpochEnded(EpochId),
    #[error("Error when advancing epoch: {error}")]
    AdvanceEpoch { error: String },

    #[error("Transaction Expired")]
    TransactionExpired,

    // These are errors that occur when an RPC fails and is simply the utf8 message sent in a
    // Tonic::Status
    #[error("{1} - {0}")]
    Rpc(String, String),

    #[error("Method not allowed")]
    InvalidRpcMethod,

    // TODO: We should fold this into UserInputError::Unsupported.
    #[error("Use of disabled feature: {error}")]
    UnsupportedFeature { error: String },

    #[error("Unable to communicate with the Quorum Driver channel: {error}")]
    QuorumDriverCommunication { error: String },

    #[error("Operation timed out")]
    Timeout,

    #[error("Error executing {0}")]
    Execution(String),

    #[error("Invalid committee composition")]
    InvalidCommittee(String),

    #[error("Missing committee information for epoch {0}")]
    MissingCommitteeAtEpoch(EpochId),

    #[error("Index store not available on this Fullnode")]
    IndexStoreNotAvailable,

    #[error("Failed to read dynamic field from table in the object store: {0}")]
    DynamicFieldRead(String),

    #[error("Failed to read or deserialize system state related data structures on-chain: {0}")]
    IotaSystemStateRead(String),

    #[error("Unexpected version error: {0}")]
    UnexpectedVersion(String),

    #[error("Message version is not supported at the current protocol version: {error}")]
    WrongMessageVersion { error: String },

    #[error("unknown error: {0}")]
    Unknown(String),

    #[error("Failed to perform file operation: {0}")]
    FileIO(String),

    #[error("Failed to get JWK")]
    JWKRetrieval,

    #[error("Storage error: {0}")]
    Storage(String),

    #[error(
        "Validator cannot handle the request at the moment. Please retry after at least {retry_after_secs} seconds"
    )]
    ValidatorOverloadedRetryAfter { retry_after_secs: u64 },

    #[error("Too many requests")]
    TooManyRequests,

    #[error("The request did not contain a certificate")]
    NoCertificateProvided,

    #[error("Invalid admin request: {0}")]
    InvalidAdminRequest(String),

    #[error("Could not find the referenced transaction effects [{digest}]")]
    TransactionEffectsNotFound { digest: TransactionDigest },

    #[error("Dynamic field with key={key} and ID={id} does not exist on parent {parent_id}")]
    DynamicFieldNotExists {
        parent_id: ObjectId,
        id: ObjectId,
        key: String,
    },
}

#[repr(u64)]
#[expect(non_camel_case_types)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
/// Sub-status codes for the `UNKNOWN_VERIFICATION_ERROR` VM Status Code which
/// provides more context TODO: add more Vm Status errors. We use
/// `UNKNOWN_VERIFICATION_ERROR` as a catchall for now.
pub enum VMMVerifierErrorSubStatusCode {
    MULTIPLE_RETURN_VALUES_NOT_ALLOWED = 0,
    INVALID_OBJECT_CREATION = 1,
}

#[repr(u64)]
#[expect(non_camel_case_types)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
/// Sub-status codes for the `MEMORY_LIMIT_EXCEEDED` VM Status Code which
/// provides more context
pub enum VMMemoryLimitExceededSubStatusCode {
    EVENT_COUNT_LIMIT_EXCEEDED = 0,
    EVENT_SIZE_LIMIT_EXCEEDED = 1,
    NEW_ID_COUNT_LIMIT_EXCEEDED = 2,
    DELETED_ID_COUNT_LIMIT_EXCEEDED = 3,
    TRANSFER_ID_COUNT_LIMIT_EXCEEDED = 4,
    OBJECT_RUNTIME_CACHE_LIMIT_EXCEEDED = 5,
    OBJECT_RUNTIME_STORE_LIMIT_EXCEEDED = 6,
    TOTAL_EVENT_SIZE_LIMIT_EXCEEDED = 7,
}

pub type IotaResult<T = ()> = Result<T, IotaError>;
pub type UserInputResult<T = ()> = Result<T, UserInputError>;

impl From<iota_protocol_config::Error> for IotaError {
    fn from(error: iota_protocol_config::Error) -> Self {
        IotaError::WrongMessageVersion { error: error.0 }
    }
}

impl From<ExecutionError> for IotaError {
    fn from(error: ExecutionError) -> Self {
        IotaError::Execution(error.to_string())
    }
}

impl From<iota_sdk_types::hash::MissingSignatureError> for IotaError {
    fn from(error: iota_sdk_types::hash::MissingSignatureError) -> Self {
        IotaError::InvalidSignature {
            error: error.to_string(),
        }
    }
}

#[cfg(not(target_arch = "wasm32"))]
impl From<Status> for IotaError {
    fn from(status: Status) -> Self {
        if status.message() == "Too many requests" {
            return Self::TooManyRequests;
        }
        let result = bcs::from_bytes::<IotaError>(status.details());
        if let Ok(iota_error) = result {
            iota_error
        } else {
            Self::Rpc(
                status.message().to_owned(),
                status.code().description().to_owned(),
            )
        }
    }
}

impl From<TypedStoreError> for IotaError {
    fn from(e: TypedStoreError) -> Self {
        Self::Storage(e.to_string())
    }
}

impl From<crate::storage::error::Error> for IotaError {
    fn from(e: crate::storage::error::Error) -> Self {
        Self::Storage(e.to_string())
    }
}

#[cfg(not(target_arch = "wasm32"))]
impl From<IotaError> for Status {
    fn from(error: IotaError) -> Self {
        let bytes = bcs::to_bytes(&error).unwrap();
        Status::with_details(tonic::Code::Internal, error.to_string(), bytes.into())
    }
}

impl From<ExecutionErrorKind> for IotaError {
    fn from(kind: ExecutionErrorKind) -> Self {
        ExecutionError::from_kind(kind).into()
    }
}

impl From<&str> for IotaError {
    fn from(error: &str) -> Self {
        IotaError::GenericAuthority {
            error: error.to_string(),
        }
    }
}

impl From<String> for IotaError {
    fn from(error: String) -> Self {
        IotaError::GenericAuthority { error }
    }
}

impl TryFrom<IotaError> for UserInputError {
    type Error = anyhow::Error;

    fn try_from(err: IotaError) -> Result<Self, Self::Error> {
        match err {
            IotaError::UserInput { error } => Ok(error),
            other => anyhow::bail!("error `{other}` is not UserInput"),
        }
    }
}

impl From<UserInputError> for IotaError {
    fn from(error: UserInputError) -> Self {
        IotaError::UserInput { error }
    }
}

impl IotaError {
    pub fn individual_error_indicates_epoch_change(&self) -> bool {
        matches!(
            self,
            IotaError::ValidatorHaltedAtEpochEnd | IotaError::MissingCommitteeAtEpoch(_)
        )
    }

    /// 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_retryable(&self) -> (bool, bool) {
        let retryable = match self {
            IotaError::Rpc { .. } => true,

            // Reconfig error
            IotaError::ValidatorHaltedAtEpochEnd => true,
            IotaError::MissingCommitteeAtEpoch(..) => true,
            IotaError::WrongEpoch { .. } => true,
            IotaError::EpochEnded { .. } => true,

            IotaError::UserInput { error } => {
                match error {
                    // Only ObjectNotFound and DependentPackageNotFound is potentially retryable
                    UserInputError::ObjectNotFound { .. } => true,
                    UserInputError::DependentPackageNotFound { .. } => true,
                    _ => false,
                }
            }

            IotaError::PotentiallyTemporarilyInvalidSignature { .. } => true,

            // Overload errors
            IotaError::TooManyTransactionsPendingExecution { .. } => true,
            IotaError::TooManyTransactionsPendingOnObject { .. } => true,
            IotaError::TooOldTransactionPendingOnObject { .. } => true,
            IotaError::TooManyTransactionsPendingConsensus => true,
            IotaError::ValidatorOverloadedRetryAfter { .. } => true,

            // Transient consensus failure — other validators likely unaffected
            IotaError::FailedToSubmitToConsensus(..) => true,

            // Same digest already in flight — client should wait for the
            // original to land or retry once the soft locks are released.
            IotaError::RecentlyResubmitted { .. } => true,

            // Non retryable error
            IotaError::Execution(..) => false,
            IotaError::ByzantineAuthoritySuspicion { .. } => false,
            IotaError::QuorumFailedToGetEffectsQuorumWhenProcessingTransaction { .. } => false,
            IotaError::TxAlreadyFinalizedWithDifferentUserSigs => false,
            IotaError::FailedToVerifyTxCertWithExecutedEffects { .. } => false,
            IotaError::ObjectLockConflict { .. } => false,

            // NB: This is not an internal overload, but instead an imposed rate
            // limit / blocking of a client. It must be non-retryable otherwise
            // we will make the threat worse through automatic retries.
            IotaError::TooManyRequests => false,

            // Signature errors — non-retryable, invalid input
            IotaError::InvalidSignature { .. } => false,
            IotaError::SignerSignatureAbsent { .. } => false,
            IotaError::SignerSignatureNumberMismatch { .. } => false,
            IotaError::IncorrectSigner { .. } => false,
            IotaError::UnknownSigner { .. } => false,
            IotaError::InvalidAuthenticator => false,

            // Transaction lifecycle — non-retryable
            IotaError::TransactionExpired => false,

            // Fullnode-internal aggregation errors — non-retryable
            IotaError::StakeAggregatorRepeatedSigner { .. } => false,
            IotaError::CertificateRequiresQuorum => false,

            // For all un-categorized errors, return here with categorized = false.
            _ => return (false, false),
        };

        (retryable, true)
    }

    pub fn is_object_or_package_not_found(&self) -> bool {
        match self {
            IotaError::UserInput { error } => {
                matches!(
                    error,
                    UserInputError::ObjectNotFound { .. }
                        | UserInputError::DependentPackageNotFound { .. }
                )
            }
            _ => false,
        }
    }

    pub fn is_overload(&self) -> bool {
        matches!(
            self,
            IotaError::TooManyTransactionsPendingExecution { .. }
                | IotaError::TooManyTransactionsPendingOnObject { .. }
                | IotaError::TooOldTransactionPendingOnObject { .. }
                | IotaError::TooManyTransactionsPendingConsensus
        )
    }

    pub fn is_retryable_overload(&self) -> bool {
        matches!(self, IotaError::ValidatorOverloadedRetryAfter { .. })
    }

    /// Returns `true` for errors caused by storage or epoch-lifecycle
    /// failures (RocksDB, epoch store closed) rather than semantic transaction
    /// problems. Used by post-consensus validation to distinguish fatal errors
    /// (halt the commit) from per-transaction drops.
    pub fn is_storage_or_epoch_error(&self) -> bool {
        matches!(
            self,
            IotaError::Storage(..)
                | IotaError::EpochEnded(..)
                | IotaError::ValidatorHaltedAtEpochEnd
        )
    }

    pub fn retry_after_secs(&self) -> u64 {
        match self {
            IotaError::ValidatorOverloadedRetryAfter { retry_after_secs } => *retry_after_secs,
            _ => 0,
        }
    }
}

/// Categorizes IotaError into ErrorCategory.
pub fn categorize(error: &IotaError) -> ErrorCategory {
    match error {
        IotaError::UserInput { error } => match error {
            UserInputError::ObjectNotFound { .. } => ErrorCategory::Aborted,
            UserInputError::DependentPackageNotFound { .. } => ErrorCategory::Aborted,
            _ => ErrorCategory::InvalidTransaction,
        },
        IotaError::InvalidSignature { .. }
        | IotaError::SignerSignatureAbsent { .. }
        | IotaError::SignerSignatureNumberMismatch { .. }
        | IotaError::IncorrectSigner { .. }
        | IotaError::UnknownSigner { .. }
        | IotaError::TransactionExpired => ErrorCategory::InvalidTransaction,

        IotaError::ObjectLockConflict { .. } => ErrorCategory::LockConflict,

        IotaError::TooManyTransactionsPendingExecution { .. }
        | IotaError::TooManyTransactionsPendingOnObject { .. }
        | IotaError::TooOldTransactionPendingOnObject { .. }
        | IotaError::TooManyTransactionsPendingConsensus
        | IotaError::ValidatorOverloadedRetryAfter { .. } => ErrorCategory::ValidatorOverloaded,

        _ => ErrorCategory::Aborted,
    }
}

/// Types of IotaError categories for retry decisions.
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, IntoStaticStr)]
pub enum ErrorCategory {
    /// A generic error that is retriable with new transaction resubmissions.
    Aborted,
    /// Any validator or full node can check if a transaction is valid.
    InvalidTransaction,
    /// Lock conflict on the transaction input.
    LockConflict,
    /// Unexpected client error, for example generating invalid request or
    /// entering into invalid state. And unexpected error from the remote
    /// peer.
    Internal,
    /// Validator is overloaded.
    ValidatorOverloaded,
    /// Target validator is down or there are network issues.
    Unavailable,
}

impl ErrorCategory {
    /// Whether the failure is retriable with new transaction submission.
    pub fn is_submission_retriable(&self) -> bool {
        matches!(
            self,
            ErrorCategory::Aborted
                | ErrorCategory::ValidatorOverloaded
                | ErrorCategory::Unavailable
        )
    }
}

impl IotaError {
    /// Categorizes this error into an ErrorCategory.
    pub fn categorize(&self) -> ErrorCategory {
        categorize(self)
    }
}

impl Ord for IotaError {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        Ord::cmp(self.as_ref(), other.as_ref())
    }
}

impl PartialOrd for IotaError {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

type BoxError = Box<dyn std::error::Error + Send + Sync + 'static>;

pub type ExecutionErrorKind = ExecutionFailureStatus;

#[derive(Debug)]
pub struct ExecutionError {
    inner: Box<ExecutionErrorInner>,
}

#[derive(Debug)]
struct ExecutionErrorInner {
    kind: ExecutionErrorKind,
    source: Option<BoxError>,
    command: Option<u64>,
}

impl ExecutionError {
    pub fn new(kind: ExecutionErrorKind, source: Option<BoxError>) -> Self {
        Self {
            inner: Box::new(ExecutionErrorInner {
                kind,
                source,
                command: None,
            }),
        }
    }

    pub fn new_with_source<E: Into<BoxError>>(kind: ExecutionErrorKind, source: E) -> Self {
        Self::new(kind, Some(source.into()))
    }

    pub fn invariant_violation<E: Into<BoxError>>(source: E) -> Self {
        Self::new_with_source(ExecutionFailureStatus::InvariantViolation, source)
    }

    pub fn with_command_index(mut self, command: u64) -> Self {
        self.inner.command = Some(command);
        self
    }

    /// Rewrap this error, produced while executing a Move authenticator, as a
    /// [`ExecutionFailureStatus::MoveAuthentication`]. The command index
    /// is dropped: it referred to a command of the authenticator's own
    /// programmable transaction and is meaningless in the transaction's
    /// effects, where it would otherwise collide with the first command of the
    /// programmable transaction.
    pub fn into_move_authentication_error(self) -> Self {
        let ExecutionErrorInner { kind, source, .. } = *self.inner;
        Self::new(
            ExecutionFailureStatus::MoveAuthentication {
                error: Box::new(kind),
            },
            source,
        )
    }

    pub fn from_kind(kind: ExecutionErrorKind) -> Self {
        Self::new(kind, None)
    }

    pub fn kind(&self) -> &ExecutionErrorKind {
        &self.inner.kind
    }

    pub fn command(&self) -> Option<u64> {
        self.inner.command
    }

    pub fn source(&self) -> &Option<BoxError> {
        &self.inner.source
    }

    pub fn to_execution_status(&self) -> (ExecutionFailureStatus, Option<u64>) {
        (self.kind().clone(), self.command())
    }
}

impl std::fmt::Display for ExecutionError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}: {}", self.inner.kind.as_ref(), self.inner.kind)?;
        if let Some(source) = self.inner.source.as_ref() {
            write!(f, "; caused by: {source}")?;
        }
        if let Some(command) = self.inner.command {
            write!(f, "; at command index: {command}")?;
        }
        Ok(())
    }
}

impl std::error::Error for ExecutionError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.inner.source.as_ref().map(|e| &**e as _)
    }
}

impl From<ExecutionErrorKind> for ExecutionError {
    fn from(kind: ExecutionErrorKind) -> Self {
        Self::from_kind(kind)
    }
}

pub fn command_argument_error(e: CommandArgumentError, arg_idx: usize) -> ExecutionError {
    ExecutionError::from_kind(ExecutionErrorKind::command_argument_error(
        e,
        arg_idx as u16,
    ))
}