Enum solana_sdk::instruction::InstructionError

[−] Show declaration

pub enum InstructionError {
    GenericError,
    InvalidArgument,
    InvalidInstructionData,
    InvalidAccountData,
    AccountDataTooSmall,
    InsufficientFunds,
    IncorrectProgramId,
    MissingRequiredSignature,
    AccountAlreadyInitialized,
    UninitializedAccount,
    UnbalancedInstruction,
    ModifiedProgramId,
    ExternalAccountLamportSpend,
    ExternalAccountDataModified,
    ReadonlyLamportChange,
    ReadonlyDataModified,
    DuplicateAccountIndex,
    ExecutableModified,
    RentEpochModified,
    NotEnoughAccountKeys,
    AccountDataSizeChanged,
    AccountNotExecutable,
    AccountBorrowFailed,
    AccountBorrowOutstanding,
    DuplicateAccountOutOfSync,
    Custom(u32),
    InvalidError,
    ExecutableDataModified,
    ExecutableLamportChange,
    ExecutableAccountNotRentExempt,
    UnsupportedProgramId,
    CallDepth,
    MissingAccount,
    ReentrancyNotAllowed,
    MaxSeedLengthExceeded,
    InvalidSeeds,
    InvalidRealloc,
    ComputationalBudgetExceeded,
    PrivilegeEscalation,
    ProgramEnvironmentSetupFailure,
    ProgramFailedToComplete,
    ProgramFailedToCompile,
    Immutable,
    IncorrectAuthority,
    BorshIoError(String),
    AccountNotRentExempt,
    InvalidAccountOwner,
}

[−] Expand description

Reasons the runtime might have rejected an instruction.

Variants

GenericError

[−] Expand description

Deprecated! Use CustomError instead! The program instruction returned an error

InvalidArgument

[−] Expand description

The arguments provided to a program were invalid

InvalidInstructionData

[−] Expand description

An instruction’s data contents were invalid

InvalidAccountData

[−] Expand description

An account’s data contents was invalid

AccountDataTooSmall

[−] Expand description

An account’s data was too small

InsufficientFunds

[−] Expand description

An account’s balance was too small to complete the instruction

IncorrectProgramId

[−] Expand description

The account did not have the expected program id

MissingRequiredSignature

[−] Expand description

A signature was required but not found

AccountAlreadyInitialized

[−] Expand description

An initialize instruction was sent to an account that has already been initialized.

UninitializedAccount

[−] Expand description

An attempt to operate on an account that hasn’t been initialized.

UnbalancedInstruction

[−] Expand description

Program’s instruction lamport balance does not equal the balance after the instruction

ModifiedProgramId

[−] Expand description

Program modified an account’s program id

ExternalAccountLamportSpend

[−] Expand description

Program spent the lamports of an account that doesn’t belong to it

ExternalAccountDataModified

[−] Expand description

Program modified the data of an account that doesn’t belong to it

ReadonlyLamportChange

[−] Expand description

Read-only account’s lamports modified

ReadonlyDataModified

[−] Expand description

Read-only account’s data was modified

DuplicateAccountIndex

[−] Expand description

An account was referenced more than once in a single instruction

ExecutableModified

[−] Expand description

Executable bit on account changed, but shouldn’t have

RentEpochModified

[−] Expand description

Rent_epoch account changed, but shouldn’t have

NotEnoughAccountKeys

[−] Expand description

The instruction expected additional account keys

AccountDataSizeChanged

[−] Expand description

A non-system program changed the size of the account data

AccountNotExecutable

[−] Expand description

The instruction expected an executable account

AccountBorrowFailed

[−] Expand description

Failed to borrow a reference to account data, already borrowed

AccountBorrowOutstanding

[−] Expand description

Account data has an outstanding reference after a program’s execution

DuplicateAccountOutOfSync

[−] Expand description

The same account was multiply passed to an on-chain program’s entrypoint, but the program modified them differently. A program can only modify one instance of the account because the runtime cannot determine which changes to pick or how to merge them if both are modified

Custom(u32)

[−] Expand description

Allows on-chain programs to implement program-specific error types and see them returned by the Solana runtime. A program-specific error may be any type that is represented as or serialized to a u32 integer.

InvalidError

[−] Expand description

The return value from the program was invalid. Valid errors are either a defined builtin error value or a user-defined error in the lower 32 bits.

ExecutableDataModified

[−] Expand description

Executable account’s data was modified

ExecutableLamportChange

[−] Expand description

Executable account’s lamports modified

ExecutableAccountNotRentExempt

[−] Expand description

Executable accounts must be rent exempt

UnsupportedProgramId

[−] Expand description

Unsupported program id

CallDepth

[−] Expand description

Cross-program invocation call depth too deep

MissingAccount

[−] Expand description

An account required by the instruction is missing

ReentrancyNotAllowed

[−] Expand description

Cross-program invocation reentrancy not allowed for this instruction

MaxSeedLengthExceeded

[−] Expand description

Length of the seed is too long for address generation

InvalidSeeds

[−] Expand description

Provided seeds do not result in a valid address

InvalidRealloc

[−] Expand description

Failed to reallocate account data of this length

ComputationalBudgetExceeded

[−] Expand description

Computational budget exceeded

PrivilegeEscalation

[−] Expand description

Cross-program invocation with unauthorized signer or writable account

ProgramEnvironmentSetupFailure

ProgramFailedToComplete

ProgramFailedToCompile

Immutable

IncorrectAuthority

BorshIoError(String)

AccountNotRentExempt

InvalidAccountOwner

Trait Implementations

impl Clone for InstructionError[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> InstructionError[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for InstructionError[+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstructionError[+]

[+] Show hidden undocumented items

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<InstructionError, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Display for InstructionError[+]

[+] Show hidden undocumented items

pub fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Eq for InstructionError

impl Error for InstructionError[+]

[+] Show hidden undocumented items

pub fn source(&self) -> Option<&(dyn Error + 'static)>[−]

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>[−]

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str[−]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<T> From<T> for InstructionError where
    T: ToPrimitive, [+]

[+] Show hidden undocumented items

pub fn from(error: T) -> InstructionError[−]

Performs the conversion.

impl PartialEq<InstructionError> for InstructionError[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &InstructionError) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &InstructionError) -> bool[−]

This method tests for !=.

impl Serialize for InstructionError[+]

[+] Show hidden undocumented items

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl StructuralEq for InstructionError

impl StructuralPartialEq for InstructionError

impl TryFrom<InstructionError> for ProgramError[+]

[+] Show hidden undocumented items

type Error = InstructionError

The type returned in the event of a conversion error.

pub fn try_from(
    error: InstructionError
) -> Result<ProgramError, <ProgramError as TryFrom<InstructionError>>::Error>[−]

Performs the conversion.