ExecutionError

sealed class ExecutionError : Disposable

An error that can occur during the execution of a transaction

BCS

The BCS serialized form for this type is defined by the following ABNF:

execution-error =  insufficient-gas
=/ invalid-gas-object
=/ invariant-violation
=/ feature-not-yet-supported
=/ object-too-big
=/ package-too-big
=/ circular-object-ownership
=/ insufficient-coin-balance
=/ coin-balance-overflow
=/ publish-error-non-zero-address
=/ iota-move-verification-error
=/ move-primitive-runtime-error
=/ move-abort
=/ vm-verification-or-deserialization-error
=/ vm-invariant-violation
=/ function-not-found
=/ arity-mismatch
=/ type-arity-mismatch
=/ non-entry-function-invoked
=/ command-argument-error
=/ type-argument-error
=/ unused-value-without-drop
=/ invalid-public-function-return-type
=/ invalid-transfer-object
=/ effects-too-large
=/ publish-upgrade-missing-dependency
=/ publish-upgrade-dependency-downgrade
=/ package-upgrade-error
=/ written-objects-too-large
=/ certificate-denied
=/ iota-move-verification-timeout
=/ shared-object-operation-not-allowed
=/ input-object-deleted
=/ execution-canceled-due-to-shared-object-congestion
=/ address-denied-for-coin
=/ coin-type-global-pause
=/ execution-canceled-due-to-randomness-unavailable
=/ execution-canceled-due-to-shared-object-congestion-v2
=/ invalid-linkage
=/ move-authentication-error
=/ execution-canceled-due-to-execution-worker-congestion

insufficient-gas                                       = %d00
invalid-gas-object                                     = %d01
invariant-violation                                    = %d02
feature-not-yet-supported                              = %d03
object-too-big                                         = %d04 u64 u64
package-too-big                                        = %d05 u64 u64
circular-object-ownership                              = %d06 object-id
insufficient-coin-balance                              = %d07
coin-balance-overflow                                  = %d08
publish-error-non-zero-address                         = %d09
iota-move-verification-error                           = %d10
move-primitive-runtime-error                           = %d11 (option move-location)
move-abort                                             = %d12 move-location u64
vm-verification-or-deserialization-error               = %d13
vm-invariant-violation                                 = %d14
function-not-found                                     = %d15
arity-mismatch                                         = %d16
type-arity-mismatch                                    = %d17
non-entry-function-invoked                             = %d18
command-argument-error                                 = %d19 u16 command-argument-error
type-argument-error                                    = %d20 u16 type-argument-error
unused-value-without-drop                              = %d21 u16 u16
invalid-public-function-return-type                    = %d22 u16
invalid-transfer-object                                = %d23
effects-too-large                                      = %d24 u64 u64
publish-upgrade-missing-dependency                     = %d25
publish-upgrade-dependency-downgrade                   = %d26
package-upgrade-error                                  = %d27 package-upgrade-error
written-objects-too-large                              = %d28 u64 u64
certificate-denied                                     = %d29
iota-move-verification-timeout                         = %d30
shared-object-operation-not-allowed                    = %d31
input-object-deleted                                   = %d32
execution-canceled-due-to-shared-object-congestion    = %d33 (vector object-id)
address-denied-for-coin                                = %d34 address string
coin-type-global-pause                                 = %d35 string
execution-canceled-due-to-randomness-unavailable      = %d36
execution-canceled-due-to-shared-object-congestion-v2 = %d37 (vector object-id) u64
invalid-linkage                                        = %d38
move-authentication-error                              = %d39 execution-error
execution-canceled-due-to-execution-worker-congestion  = %d40 u64

Inheritors

InsufficientGas
InvalidGasObject
InvariantViolation
FeatureNotYetSupported
ObjectTooBig
PackageTooBig
CircularObjectOwnership
InsufficientCoinBalance
CoinBalanceOverflow
PublishErrorNonZeroAddress
IotaMoveVerification
MovePrimitiveRuntime
MoveAbort
VmVerificationOrDeserialization
VmInvariantViolation
FunctionNotFound
ArityMismatch
TypeArityMismatch
NonEntryFunctionInvoked
CommandArgument
TypeArgument
UnusedValueWithoutDrop
InvalidPublicFunctionReturnType
InvalidTransferObject
EffectsTooLarge
PublishUpgradeMissingDependency
PublishUpgradeDependencyDowngrade
PackageUpgrade
WrittenObjectsTooLarge
CertificateDenied
IotaMoveVerificationTimeout
SharedObjectOperationNotAllowed
InputObjectDeleted
ExecutionCanceledDueToSharedObjectCongestion
ExecutionCanceledDueToSharedObjectCongestionV2
AddressDeniedForCoin
CoinTypeGlobalPause
ExecutionCanceledDueToRandomnessUnavailable
InvalidLinkage
MoveAuthentication
ExecutionCanceledDueToExecutionWorkerCongestion

Types

Name	Summary
AddressDeniedForCoin	data class AddressDeniedForCoin(val address: Address, val coinType: String) : ExecutionError Address is denied for this coin type
ArityMismatch	object ArityMismatch : ExecutionError Arity mismatch for Move function. The number of arguments does not match the number of parameters
CertificateDenied	object CertificateDenied : ExecutionError Certificate is on the deny list
CircularObjectOwnership	data class CircularObjectOwnership(val object: ObjectId) : ExecutionError Circular Object Ownership
CoinBalanceOverflow	object CoinBalanceOverflow : ExecutionError Coin balance overflowed an u64
CoinTypeGlobalPause	data class CoinTypeGlobalPause(val coinType: String) : ExecutionError Coin type is globally paused for use
CommandArgument	data class CommandArgument(val argument: UShort, val kind: CommandArgumentError) : ExecutionError Invalid command argument
EffectsTooLarge	data class EffectsTooLarge(val currentSize: ULong, val maxSize: ULong) : ExecutionError Effects from the transaction are too large
ExecutionCanceledDueToExecutionWorkerCongestion	data class ExecutionCanceledDueToExecutionWorkerCongestion(val suggestedGasPrice: ULong) : ExecutionError Certificate is canceled because the execution workers are congested; suggested gas price can be used to give this certificate more priority. No individual object is responsible, so none is reported.
ExecutionCanceledDueToRandomnessUnavailable	object ExecutionCanceledDueToRandomnessUnavailable : ExecutionError Certificate is canceled because randomness could not be generated this epoch
ExecutionCanceledDueToSharedObjectCongestion	data class ExecutionCanceledDueToSharedObjectCongestion(val congestedObjects: List<ObjectId>) : ExecutionError Certificate is canceled due to congestion on shared objects
ExecutionCanceledDueToSharedObjectCongestionV2	data class ExecutionCanceledDueToSharedObjectCongestionV2(val congestedObjects: List<ObjectId>, val suggestedGasPrice: ULong) : ExecutionError Certificate is canceled due to congestion on shared objects; suggested gas price can be used to give this certificate more priority.
FeatureNotYetSupported	object FeatureNotYetSupported : ExecutionError Attempted to used feature that is not supported yet
FunctionNotFound	object FunctionNotFound : ExecutionError Function not found
InputObjectDeleted	object InputObjectDeleted : ExecutionError Requested shared object has been deleted
InsufficientCoinBalance	object InsufficientCoinBalance : ExecutionError Insufficient coin balance for requested operation
InsufficientGas	object InsufficientGas : ExecutionError Insufficient Gas
InvalidGasObject	object InvalidGasObject : ExecutionError Invalid Gas Object.
InvalidLinkage	object InvalidLinkage : ExecutionError A valid linkage was unable to be determined for the transaction or one of its commands.
InvalidPublicFunctionReturnType	data class InvalidPublicFunctionReturnType(val index: UShort) : ExecutionError Invalid public Move function signature. Unsupported return type for return value
InvalidTransferObject	object InvalidTransferObject : ExecutionError Invalid Transfer Object, object does not have public transfer.
InvariantViolation	object InvariantViolation : ExecutionError Invariant Violation
IotaMoveVerification	object IotaMoveVerification : ExecutionError IOTA Move Bytecode Verification Error.
IotaMoveVerificationTimeout	object IotaMoveVerificationTimeout : ExecutionError IOTA Move Bytecode verification timed out.
MoveAbort	data class MoveAbort(val location: MoveLocation, val code: ULong) : ExecutionError Move runtime abort
MoveAuthentication	data class MoveAuthentication(val error: ExecutionErrorWrapper) : ExecutionError The transaction's Move-based authentication failed while executing an authenticator, before the programmable transaction was run. The wrapped error is the failure produced by the authenticator's execution.
MovePrimitiveRuntime	data class MovePrimitiveRuntime(val location: MoveLocation?) : ExecutionError Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, etc."
NonEntryFunctionInvoked	object NonEntryFunctionInvoked : ExecutionError Non Entry Function Invoked. Move Call must start with an entry function.
ObjectTooBig	data class ObjectTooBig(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError Move object is larger than the maximum allowed size
PackageTooBig	data class PackageTooBig(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError Package is larger than the maximum allowed size
PackageUpgrade	data class PackageUpgrade(val kind: PackageUpgradeError) : ExecutionError Invalid package upgrade
PublishErrorNonZeroAddress	object PublishErrorNonZeroAddress : ExecutionError Publish Error, Non-zero Address. The modules in the package must have their self-addresses set to zero.
PublishUpgradeDependencyDowngrade	object PublishUpgradeDependencyDowngrade : ExecutionError Publish or Upgrade dependency downgrade.
PublishUpgradeMissingDependency	object PublishUpgradeMissingDependency : ExecutionError Publish or Upgrade is missing dependency
SharedObjectOperationNotAllowed	object SharedObjectOperationNotAllowed : ExecutionError The requested shared object operation is not allowed
TypeArgument	data class TypeArgument(val typeArgument: UShort, val kind: TypeArgumentError) : ExecutionError Type argument error
TypeArityMismatch	object TypeArityMismatch : ExecutionError Type arity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.
UnusedValueWithoutDrop	data class UnusedValueWithoutDrop(val result: UShort, val subresult: UShort) : ExecutionError Unused result without the drop ability.
VmInvariantViolation	object VmInvariantViolation : ExecutionError MoveVm invariant violation
VmVerificationOrDeserialization	object VmVerificationOrDeserialization : ExecutionError Bytecode verification error.
WrittenObjectsTooLarge	data class WrittenObjectsTooLarge(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError Indicates the transaction tried to write objects too large to storage

Functions

Name	Summary
destroy	open override fun destroy()

AddressDeniedForCoin

data class AddressDeniedForCoin(val address: Address, val coinType: String) : ExecutionError

Address is denied for this coin type

Constructors

AddressDeniedForCoin	constructor(address: Address, coinType: String)

Properties

Name	Summary
address	val address: Address
coinType	val coinType: String

Functions

Name	Summary
destroy	open override fun destroy()

ArityMismatch

object ArityMismatch : ExecutionError

Arity mismatch for Move function. The number of arguments does not match the number of parameters

Functions

Name	Summary
destroy	open override fun destroy()

CertificateDenied

object CertificateDenied : ExecutionError

Certificate is on the deny list

Functions

Name	Summary
destroy	open override fun destroy()

CircularObjectOwnership

data class CircularObjectOwnership(val object: ObjectId) : ExecutionError

Circular Object Ownership

Constructors

CircularObjectOwnership	constructor(object: ObjectId)

Properties

Name	Summary
object	val object: ObjectId

Functions

Name	Summary
destroy	open override fun destroy()

CoinBalanceOverflow

object CoinBalanceOverflow : ExecutionError

Coin balance overflowed an u64

Functions

Name	Summary
destroy	open override fun destroy()

CoinTypeGlobalPause

data class CoinTypeGlobalPause(val coinType: String) : ExecutionError

Coin type is globally paused for use

Constructors

CoinTypeGlobalPause	constructor(coinType: String)

Properties

Name	Summary
coinType	val coinType: String

Functions

Name	Summary
destroy	open override fun destroy()

CommandArgument

data class CommandArgument(val argument: UShort, val kind: CommandArgumentError) : ExecutionError

Invalid command argument

Constructors

CommandArgument	constructor(argument: UShort, kind: CommandArgumentError)

Properties

Name	Summary
argument	val argument: UShort
kind	val kind: CommandArgumentError

Functions

Name	Summary
destroy	open override fun destroy()

EffectsTooLarge

data class EffectsTooLarge(val currentSize: ULong, val maxSize: ULong) : ExecutionError

Effects from the transaction are too large

Constructors

EffectsTooLarge	constructor(currentSize: ULong, maxSize: ULong)

Properties

Name	Summary
currentSize	val currentSize: ULong
maxSize	val maxSize: ULong

Functions

Name	Summary
destroy	open override fun destroy()

ExecutionCanceledDueToExecutionWorkerCongestion

data class ExecutionCanceledDueToExecutionWorkerCongestion(val suggestedGasPrice: ULong) : ExecutionError

Certificate is canceled because the execution workers are congested; suggested gas price can be used to give this certificate more priority. No individual object is responsible, so none is reported.

Constructors

ExecutionCanceledDueToExecutionWorkerCongestion	constructor(suggestedGasPrice: ULong)

Properties

Name	Summary
suggestedGasPrice	val suggestedGasPrice: ULong

Functions

Name	Summary
destroy	open override fun destroy()

ExecutionCanceledDueToRandomnessUnavailable

object ExecutionCanceledDueToRandomnessUnavailable : ExecutionError

Certificate is canceled because randomness could not be generated this epoch

Functions

Name	Summary
destroy	open override fun destroy()

ExecutionCanceledDueToSharedObjectCongestion

data class ExecutionCanceledDueToSharedObjectCongestion(val congestedObjects: List<ObjectId>) : ExecutionError

Certificate is canceled due to congestion on shared objects

Constructors

ExecutionCanceledDueToSharedObjectCongestion	constructor(congestedObjects: List<ObjectId>)

Properties

Name	Summary
congestedObjects	val congestedObjects: List<ObjectId>

Functions

Name	Summary
destroy	open override fun destroy()

ExecutionCanceledDueToSharedObjectCongestionV2

data class ExecutionCanceledDueToSharedObjectCongestionV2(val congestedObjects: List<ObjectId>, val suggestedGasPrice: ULong) : ExecutionError

Certificate is canceled due to congestion on shared objects; suggested gas price can be used to give this certificate more priority.

Constructors

ExecutionCanceledDueToSharedObjectCongestionV2	constructor(congestedObjects: List<ObjectId>, suggestedGasPrice: ULong)

Properties

Name	Summary
congestedObjects	val congestedObjects: List<ObjectId>
suggestedGasPrice	val suggestedGasPrice: ULong

Functions

Name	Summary
destroy	open override fun destroy()

FeatureNotYetSupported

object FeatureNotYetSupported : ExecutionError

Attempted to used feature that is not supported yet

Functions

Name	Summary
destroy	open override fun destroy()

FunctionNotFound

object FunctionNotFound : ExecutionError

Function not found

Functions

Name	Summary
destroy	open override fun destroy()

InputObjectDeleted

object InputObjectDeleted : ExecutionError

Requested shared object has been deleted

Functions

Name	Summary
destroy	open override fun destroy()

InsufficientCoinBalance

object InsufficientCoinBalance : ExecutionError

Insufficient coin balance for requested operation

Functions

Name	Summary
destroy	open override fun destroy()

InsufficientGas

object InsufficientGas : ExecutionError

Insufficient Gas

Functions

Name	Summary
destroy	open override fun destroy()

InvalidGasObject

object InvalidGasObject : ExecutionError

Invalid Gas Object.

Functions

Name	Summary
destroy	open override fun destroy()

InvalidLinkage

object InvalidLinkage : ExecutionError

A valid linkage was unable to be determined for the transaction or one of its commands.

Functions

Name	Summary
destroy	open override fun destroy()

InvalidPublicFunctionReturnType

data class InvalidPublicFunctionReturnType(val index: UShort) : ExecutionError

Invalid public Move function signature. Unsupported return type for return value

Constructors

InvalidPublicFunctionReturnType	constructor(index: UShort)

Properties

Name	Summary
index	val index: UShort

Functions

Name	Summary
destroy	open override fun destroy()

InvalidTransferObject

object InvalidTransferObject : ExecutionError

Invalid Transfer Object, object does not have public transfer.

Functions

Name	Summary
destroy	open override fun destroy()

InvariantViolation

object InvariantViolation : ExecutionError

Invariant Violation

Functions

Name	Summary
destroy	open override fun destroy()

IotaMoveVerification

object IotaMoveVerification : ExecutionError

IOTA Move Bytecode Verification Error.

Functions

Name	Summary
destroy	open override fun destroy()

IotaMoveVerificationTimeout

object IotaMoveVerificationTimeout : ExecutionError

IOTA Move Bytecode verification timed out.

Functions

Name	Summary
destroy	open override fun destroy()

MoveAbort

data class MoveAbort(val location: MoveLocation, val code: ULong) : ExecutionError

Move runtime abort

Constructors

MoveAbort	constructor(location: MoveLocation, code: ULong)

Properties

Name	Summary
code	val code: ULong
location	val location: MoveLocation

Functions

Name	Summary
destroy	open override fun destroy()

MoveAuthentication

data class MoveAuthentication(val error: ExecutionErrorWrapper) : ExecutionError

The transaction's Move-based authentication failed while executing an authenticator, before the programmable transaction was run. The wrapped error is the failure produced by the authenticator's execution.

Constructors

MoveAuthentication	constructor(error: ExecutionErrorWrapper)

Properties

Name	Summary
error	val error: ExecutionErrorWrapper

Functions

Name	Summary
destroy	open override fun destroy()

MovePrimitiveRuntime

data class MovePrimitiveRuntime(val location: MoveLocation?) : ExecutionError

Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, etc."

Constructors

MovePrimitiveRuntime	constructor(location: MoveLocation?)

Properties

Name	Summary
location	val location: MoveLocation?

Functions

Name	Summary
destroy	open override fun destroy()

NonEntryFunctionInvoked

object NonEntryFunctionInvoked : ExecutionError

Non Entry Function Invoked. Move Call must start with an entry function.

Functions

Name	Summary
destroy	open override fun destroy()

ObjectTooBig

data class ObjectTooBig(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError

Move object is larger than the maximum allowed size

Constructors

ObjectTooBig	constructor(objectSize: ULong, maxObjectSize: ULong)

Properties

Name	Summary
maxObjectSize	val maxObjectSize: ULong
objectSize	val objectSize: ULong

Functions

Name	Summary
destroy	open override fun destroy()

PackageTooBig

data class PackageTooBig(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError

Package is larger than the maximum allowed size

Constructors

PackageTooBig	constructor(objectSize: ULong, maxObjectSize: ULong)

Properties

Name	Summary
maxObjectSize	val maxObjectSize: ULong
objectSize	val objectSize: ULong

Functions

Name	Summary
destroy	open override fun destroy()

PackageUpgrade

data class PackageUpgrade(val kind: PackageUpgradeError) : ExecutionError

Invalid package upgrade

Constructors

PackageUpgrade	constructor(kind: PackageUpgradeError)

Properties

Name	Summary
kind	val kind: PackageUpgradeError

Functions

Name	Summary
destroy	open override fun destroy()

PublishErrorNonZeroAddress

object PublishErrorNonZeroAddress : ExecutionError

Publish Error, Non-zero Address. The modules in the package must have their self-addresses set to zero.

Functions

Name	Summary
destroy	open override fun destroy()

PublishUpgradeDependencyDowngrade

object PublishUpgradeDependencyDowngrade : ExecutionError

Publish or Upgrade dependency downgrade.

Indirect (transitive) dependency of published or upgraded package has been assigned an on-chain version that is less than the version required by one of the package's transitive dependencies.

Functions

Name	Summary
destroy	open override fun destroy()

PublishUpgradeMissingDependency

object PublishUpgradeMissingDependency : ExecutionError

Publish or Upgrade is missing dependency

Functions

Name	Summary
destroy	open override fun destroy()

SharedObjectOperationNotAllowed

object SharedObjectOperationNotAllowed : ExecutionError

The requested shared object operation is not allowed

Functions

Name	Summary
destroy	open override fun destroy()

TypeArgument

data class TypeArgument(val typeArgument: UShort, val kind: TypeArgumentError) : ExecutionError

Type argument error

Constructors

TypeArgument	constructor(typeArgument: UShort, kind: TypeArgumentError)

Properties

Name	Summary
kind	val kind: TypeArgumentError
typeArgument	val typeArgument: UShort Index of the problematic type argument

Functions

Name	Summary
destroy	open override fun destroy()

TypeArityMismatch

object TypeArityMismatch : ExecutionError

Type arity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.

Functions

Name	Summary
destroy	open override fun destroy()

UnusedValueWithoutDrop

data class UnusedValueWithoutDrop(val result: UShort, val subresult: UShort) : ExecutionError

Unused result without the drop ability.

Constructors

UnusedValueWithoutDrop	constructor(result: UShort, subresult: UShort)

Properties

Name	Summary
result	val result: UShort
subresult	val subresult: UShort

Functions

Name	Summary
destroy	open override fun destroy()

VmInvariantViolation

object VmInvariantViolation : ExecutionError

MoveVm invariant violation

Functions

Name	Summary
destroy	open override fun destroy()

VmVerificationOrDeserialization

object VmVerificationOrDeserialization : ExecutionError

Bytecode verification error.

Functions

Name	Summary
destroy	open override fun destroy()

WrittenObjectsTooLarge

data class WrittenObjectsTooLarge(val objectSize: ULong, val maxObjectSize: ULong) : ExecutionError

Indicates the transaction tried to write objects too large to storage

Constructors

WrittenObjectsTooLarge	constructor(objectSize: ULong, maxObjectSize: ULong)

Properties

Name	Summary
maxObjectSize	val maxObjectSize: ULong
objectSize	val objectSize: ULong

Functions

Name	Summary
destroy	open override fun destroy()