Enum RuntimeError

pub enum RuntimeError {
    KernelError(KernelError),
    SystemError(SystemError),
    SystemModuleError(SystemModuleError),
    SystemUpstreamError(SystemUpstreamError),
    VmError(VmError),
    ApplicationError(ApplicationError),
    FinalizationCostingError(CostingError),
}

Represents an error when executing a transaction.

Variants

KernelError(KernelError)

An error occurred within the kernel.

SystemError(SystemError)

An error occurred within the system, notably the SystemAPI implementation.

SystemModuleError(SystemModuleError)

An error occurred within a specific system module, like auth, costing and royalty. TODO: merge into SystemError?

SystemUpstreamError(SystemUpstreamError)

An error issued by the system when invoking upstream (such as blueprints, node modules). TODO: merge into SystemError?

VmError(VmError)

An error occurred in the vm layer

ApplicationError(ApplicationError)

An error occurred within application logic, like the RE models.

FinalizationCostingError(CostingError)

Implementations

impl RuntimeError

pub fn create_persistable(&self) -> PersistableRuntimeError

Trait Implementations

impl CanBeAbortion for RuntimeError

fn abortion(&self) -> Option<&AbortReason>

impl Categorize<ScryptoCustomValueKind> for RuntimeError

fn value_kind() -> ValueKind<ScryptoCustomValueKind>

impl Clone for RuntimeError

fn clone(&self) -> RuntimeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> ContextualDisplay<ScryptoValueDisplayContext<'a>> for RuntimeError

type Error = Error

fn contextual_format<F: Write>( &self, f: &mut F, context: &ScryptoValueDisplayContext<'_>, ) -> Result<(), Self::Error>

Formats the value to the given fmt::Write buffer, making use of the provided context. See also format, which is typically easier to use, as it takes an Into<Context> instead of a &Context.

fn format<F, TContext>( &self, f: &mut F, context: TContext, ) -> Result<(), Self::Error>

where F: Write, TContext: Into<Context>,

Formats the value to the given fmt::Write buffer, making use of the provided context. See also contextual_format, which takes a &Context instead of an Into<Context>.

fn display<'a, 'b, TContext>( &'a self, context: TContext, ) -> ContextDisplayable<'a, Self, Context>

where TContext: Into<Context>,

Returns an object implementing fmt::Display, which can be used in a format! style macro.

fn to_string<'a, 'b, TContext>(&'a self, context: TContext) -> String

where TContext: Into<Context>,

impl Debug for RuntimeError

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

Formats the value using the given formatter.

impl<D: Decoder<ScryptoCustomValueKind>> Decode<ScryptoCustomValueKind, D> for RuntimeError

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ScryptoCustomValueKind>, ) -> Result<Self, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl Describe<ScryptoCustomTypeKind> for RuntimeError

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<ScryptoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<ScryptoCustomTypeKind>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E: Encoder<ScryptoCustomValueKind>> Encode<ScryptoCustomValueKind, E> for RuntimeError

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl From<AccessControllerError> for RuntimeError

fn from(value: AccessControllerError) -> Self

Converts to this type from the input type.

impl From<AccountError> for RuntimeError

fn from(value: AccountError) -> Self

Converts to this type from the input type.

impl From<ApplicationError> for RuntimeError

fn from(error: ApplicationError) -> Self

Converts to this type from the input type.

impl From<BucketError> for RuntimeError

fn from(bucket_error: BucketError) -> Self

Converts to this type from the input type.

impl From<Error> for RuntimeError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RuntimeError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RuntimeError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl<E: SelfError> From<InvokeError<E>> for RuntimeError

fn from(error: InvokeError<E>) -> Self

Converts to this type from the input type.

impl From<KernelError> for RuntimeError

fn from(error: KernelError) -> Self

Converts to this type from the input type.

impl<E: SelfError> From<RuntimeError> for InvokeError<E>

fn from(runtime_error: RuntimeError) -> Self

Converts to this type from the input type.

impl From<SystemModuleError> for RuntimeError

fn from(error: SystemModuleError) -> Self

Converts to this type from the input type.

impl From<SystemUpstreamError> for RuntimeError

fn from(error: SystemUpstreamError) -> Self

Converts to this type from the input type.

impl<T> From<T> for RuntimeError

where T: Into<CallFrameError>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<TransactionProcessorError> for RuntimeError

fn from(value: TransactionProcessorError) -> Self

Converts to this type from the input type.

impl From<VaultError> for RuntimeError

fn from(error: VaultError) -> Self

Converts to this type from the input type.

impl PartialEq for RuntimeError

fn eq(&self, other: &RuntimeError) -> 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 SborEnum<ScryptoCustomValueKind> for RuntimeError

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl<'a, Y: SystemBasedKernelApi> SystemActorApi<RuntimeError> for SystemService<'a, Y>

fn actor_get_blueprint_id(&mut self) -> Result<BlueprintId, RuntimeError>

Retrieve the current blueprint id

fn actor_get_node_id( &mut self, ref_handle: ActorRefHandle, ) -> Result<NodeId, RuntimeError>

Retrieve the current method actor’s node id

fn actor_is_feature_enabled( &mut self, object_handle: ActorStateHandle, feature: &str, ) -> Result<bool, RuntimeError>

Check if a feature is enabled for a given object

fn actor_open_field( &mut self, object_handle: ActorStateHandle, field_index: u8, flags: LockFlags, ) -> Result<SubstateHandle, RuntimeError>

Open a field in a given object for reading/writing

fn actor_emit_event( &mut self, event_name: String, event_data: Vec<u8>, event_flags: EventFlags, ) -> Result<(), RuntimeError>

Emits an event of the current actor

impl<'a, Y: SystemBasedKernelApi> SystemActorIndexApi<RuntimeError> for SystemService<'a, Y>

fn actor_index_insert( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, key: Vec<u8>, buffer: Vec<u8>, ) -> Result<(), RuntimeError>

Inserts an entry into an index

fn actor_index_remove( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, key: Vec<u8>, ) -> Result<Option<Vec<u8>>, RuntimeError>

Removes an entry from an index

fn actor_index_scan_keys( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, limit: u32, ) -> Result<Vec<Vec<u8>>, RuntimeError>

Scans arbitrary elements of count from an index

fn actor_index_drain( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, limit: u32, ) -> Result<Vec<(Vec<u8>, Vec<u8>)>, RuntimeError>

Removes and returns arbitrary elements of count from an index

fn actor_index_insert_typed<K, V>( &mut self, object_handle: u32, collection_index: u8, key: K, value: V, ) -> Result<(), E>

where K: ScryptoEncode, V: ScryptoEncode,

Inserts an entry into an index

fn actor_index_remove_typed<V>( &mut self, object_handle: u32, collection_index: u8, key: Vec<u8>, ) -> Result<Option<V>, E>

where V: ScryptoDecode,

Removes an entry from an index

fn actor_index_scan_keys_typed<K>( &mut self, object_handle: u32, collection_index: u8, limit: u32, ) -> Result<Vec<K>, E>

where K: ScryptoDecode,

Scans arbitrary elements of count from an index

fn actor_index_drain_typed<K, V>( &mut self, object_handle: u32, collection_index: u8, limit: u32, ) -> Result<Vec<(K, V)>, E>

where K: ScryptoDecode, V: ScryptoDecode,

Removes and returns arbitrary elements of count from an index

impl<'a, Y: SystemBasedKernelApi> SystemActorKeyValueEntryApi<RuntimeError> for SystemService<'a, Y>

fn actor_open_key_value_entry( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, key: &Vec<u8>, flags: LockFlags, ) -> Result<KeyValueEntryHandle, RuntimeError>

Returns a handle for a specified key value entry in a collection. If an invalid collection index or key is passed an error is returned.

fn actor_remove_key_value_entry( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, key: &Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Removes an entry from a collection. If an invalid collection index or key is passed an error is returned, otherwise the encoding of a value of the entry is returned.

fn actor_remove_key_value_entry_typed<V>( &mut self, object_handle: u32, collection_index: u8, key: &Vec<u8>, ) -> Result<Option<V>, E>

where V: ScryptoDecode,

Removes an entry from a collection. If an invalid collection index or key is passed an error is returned, otherwise the value of the entry is returned.

impl<'a, Y: SystemBasedKernelApi> SystemActorSortedIndexApi<RuntimeError> for SystemService<'a, Y>

fn actor_sorted_index_insert( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, sorted_key: SortedKey, buffer: Vec<u8>, ) -> Result<(), RuntimeError>

Inserts an entry into a sorted index

fn actor_sorted_index_remove( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, sorted_key: &SortedKey, ) -> Result<Option<Vec<u8>>, RuntimeError>

Removes an entry from a sorted index

fn actor_sorted_index_scan( &mut self, object_handle: ActorStateHandle, collection_index: CollectionIndex, limit: u32, ) -> Result<Vec<(SortedKey, Vec<u8>)>, RuntimeError>

Scans the first elements of count from a sorted index

fn actor_sorted_index_insert_typed<V>( &mut self, object_handle: u32, collection_index: u8, sorted_key: ([u8; 2], Vec<u8>), value: V, ) -> Result<(), E>

where V: ScryptoEncode,

Inserts an entry into a sorted index

fn actor_sorted_index_remove_typed<V>( &mut self, object_handle: u32, collection_index: u8, sorted_key: &([u8; 2], Vec<u8>), ) -> Result<Option<V>, E>

where V: ScryptoDecode,

Removes an entry from a sorted index

fn actor_sorted_index_scan_typed<K, V>( &mut self, object_handle: u32, collection_index: u8, count: u32, ) -> Result<Vec<(K, V)>, E>

where K: ScryptoDecode, V: ScryptoDecode,

Scans the first elements of count from a sorted index

impl<'a, Y: SystemBasedKernelApi> SystemBlueprintApi<RuntimeError> for SystemService<'a, Y>

fn call_function( &mut self, package_address: PackageAddress, blueprint_name: &str, function_name: &str, args: Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Calls a function on a blueprint

fn resolve_blueprint_type( &mut self, blueprint_type_id: &BlueprintTypeIdentifier, ) -> Result<(Rc<VersionedScryptoSchema>, ScopedTypeId), RuntimeError>

Retrieves the schema of type under a blueprint

impl<'a, Y: SystemBasedKernelApi> SystemCostingApi<RuntimeError> for SystemService<'a, Y>

fn consume_cost_units( &mut self, costing_entry: ClientCostingEntry<'_>, ) -> Result<(), RuntimeError>

Consume an amount of cost units.

fn start_lock_fee( &mut self, amount: Decimal, contingent: bool, ) -> Result<bool, RuntimeError>

Check if costing is enabled.

fn lock_fee(&mut self, locked_fee: LiquidFungibleResource, contingent: bool)

Add cost units to the reserve. This should never fail.

fn execution_cost_unit_limit(&mut self) -> Result<u32, RuntimeError>

Retrieve the cost unit limit for the transaction

fn execution_cost_unit_price(&mut self) -> Result<Decimal, RuntimeError>

Retrieve the cost unit price in XRD

fn finalization_cost_unit_limit(&mut self) -> Result<u32, RuntimeError>

Retrieve the finalization cost unit limit

fn finalization_cost_unit_price(&mut self) -> Result<Decimal, RuntimeError>

Retrieve the finalization cost unit price in XRD

fn usd_price(&mut self) -> Result<Decimal, RuntimeError>

Retrieve the usd price of XRD

fn max_per_function_royalty_in_xrd(&mut self) -> Result<Decimal, RuntimeError>

Retrieve the maximum allowable royalty per function

fn tip_percentage_truncated(&mut self) -> Result<u32, RuntimeError>

Retrieve the tip percentage of the transaction

fn fee_balance(&mut self) -> Result<Decimal, RuntimeError>

Retrieve the current fee balance in XRD

impl<'a, Y: SystemBasedKernelApi> SystemExecutionTraceApi<RuntimeError> for SystemService<'a, Y>

fn update_instruction_index( &mut self, new_index: usize, ) -> Result<(), RuntimeError>

impl<'a, Y: SystemBasedKernelApi> SystemFieldApi<RuntimeError> for SystemService<'a, Y>

fn field_read(&mut self, handle: FieldHandle) -> Result<Vec<u8>, RuntimeError>

Retrieve the value of a field

fn field_write( &mut self, handle: FieldHandle, buffer: Vec<u8>, ) -> Result<(), RuntimeError>

Write a value to a field

fn field_lock(&mut self, handle: FieldHandle) -> Result<(), RuntimeError>

Lock a field such that it becomes immutable

fn field_close(&mut self, handle: FieldHandle) -> Result<(), RuntimeError>

Close a field handle so that it is no longer usable

fn field_read_typed<S>(&mut self, handle: u32) -> Result<S, E>

where S: ScryptoDecode,

Retrieve the value of a field

fn field_write_typed<S>(&mut self, handle: u32, substate: &S) -> Result<(), E>

where S: ScryptoEncode,

Write a value to a field

impl<'a, Y: SystemBasedKernelApi> SystemKeyValueEntryApi<RuntimeError> for SystemService<'a, Y>

fn key_value_entry_get( &mut self, handle: KeyValueEntryHandle, ) -> Result<Vec<u8>, RuntimeError>

Reads the value of a key value entry

fn key_value_entry_lock( &mut self, handle: KeyValueEntryHandle, ) -> Result<(), RuntimeError>

Lock the value of a key value entry making the value immutable

fn key_value_entry_remove( &mut self, handle: KeyValueEntryHandle, ) -> Result<Vec<u8>, RuntimeError>

Remove the value of a key value entry

fn key_value_entry_set( &mut self, handle: KeyValueEntryHandle, buffer: Vec<u8>, ) -> Result<(), RuntimeError>

Set the value of a key value entry

fn key_value_entry_close( &mut self, handle: KeyValueEntryHandle, ) -> Result<(), RuntimeError>

Close the handle into the key value entry rendering it unusable after close

fn key_value_entry_get_typed<S>(&mut self, handle: u32) -> Result<Option<S>, E>

where S: ScryptoDecode,

Reads the value of a key value entry and decodes it into a specific type

fn key_value_entry_set_typed<S>( &mut self, handle: u32, value: S, ) -> Result<(), E>

where S: ScryptoEncode,

Set the value of a key value entry

impl<'a, Y: SystemBasedKernelApi> SystemKeyValueStoreApi<RuntimeError> for SystemService<'a, Y>

fn key_value_store_new( &mut self, data_schema: KeyValueStoreDataSchema, ) -> Result<NodeId, RuntimeError>

Creates a new key value store with a given schema

fn key_value_store_open_entry( &mut self, node_id: &NodeId, key: &Vec<u8>, flags: LockFlags, ) -> Result<KeyValueEntryHandle, RuntimeError>

Open a key value store entry for reading/writing

fn key_value_store_remove_entry( &mut self, node_id: &NodeId, key: &Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Removes an entry from a key value store

impl<'a, Y: SystemBasedKernelApi> SystemObjectApi<RuntimeError> for SystemService<'a, Y>

fn new_object( &mut self, blueprint_ident: &str, features: Vec<&str>, generic_args: GenericArgs, fields: IndexMap<u8, FieldValue>, kv_entries: IndexMap<u8, IndexMap<Vec<u8>, KVEntry>>, ) -> Result<NodeId, RuntimeError>

Creates a new object of a given blueprint type

fn allocate_global_address( &mut self, blueprint_id: BlueprintId, ) -> Result<(GlobalAddressReservation, GlobalAddress), RuntimeError>

Allocates a global address, for a future globalization.

fn allocate_virtual_global_address( &mut self, blueprint_id: BlueprintId, global_address: GlobalAddress, ) -> Result<GlobalAddressReservation, RuntimeError>

Allocates a specific virtual global address

fn globalize( &mut self, node_id: NodeId, modules: IndexMap<AttachedModuleId, NodeId>, address_reservation: Option<GlobalAddressReservation>, ) -> Result<GlobalAddress, RuntimeError>

Moves an object currently in the heap into the global space making it accessible to all with the provided global address.

fn globalize_with_address_and_create_inner_object_and_emit_event( &mut self, node_id: NodeId, modules: IndexMap<AttachedModuleId, NodeId>, address_reservation: GlobalAddressReservation, inner_object_blueprint: &str, inner_object_fields: IndexMap<u8, FieldValue>, event_name: &str, event_data: Vec<u8>, ) -> Result<(GlobalAddress, NodeId), RuntimeError>

Globalizes with a new inner object and emits an event

fn call_method( &mut self, receiver: &NodeId, method_name: &str, args: Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Calls a method on an object

fn call_direct_access_method( &mut self, receiver: &NodeId, method_name: &str, args: Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Calls a direct access method on an object

fn call_module_method( &mut self, receiver: &NodeId, module_id: AttachedModuleId, method_name: &str, args: Vec<u8>, ) -> Result<Vec<u8>, RuntimeError>

Calls a method on an object module

fn get_blueprint_id( &mut self, node_id: &NodeId, ) -> Result<BlueprintId, RuntimeError>

Get the blueprint id of a visible object

fn get_outer_object( &mut self, node_id: &NodeId, ) -> Result<GlobalAddress, RuntimeError>

Get the outer object of a visible object

fn get_reservation_address( &mut self, node_id: &NodeId, ) -> Result<GlobalAddress, RuntimeError>

Retrieve the global address of a given address reservation

fn drop_object( &mut self, node_id: &NodeId, ) -> Result<Vec<Vec<u8>>, RuntimeError>

Drops an owned object, returns the fields of the object

fn new_simple_object( &mut self, blueprint_ident: &str, fields: IndexMap<u8, FieldValue>, ) -> Result<NodeId, E>

Creates a new simple blueprint object of a given blueprint type

impl<'a, Y: SystemBasedKernelApi> SystemTransactionRuntimeApi<RuntimeError> for SystemService<'a, Y>

fn get_transaction_hash(&mut self) -> Result<Hash, RuntimeError>

Retrieve the hash of the current transaction which is running.

fn generate_ruid(&mut self) -> Result<[u8; 32], RuntimeError>

Generate a unique id

fn bech32_encode_address( &mut self, address: GlobalAddress, ) -> Result<String, RuntimeError>

Encode an address into Bech32. The HRP part is dependent on the network which is running.

fn emit_log( &mut self, level: Level, message: String, ) -> Result<(), RuntimeError>

Emit a log message which will be available in the transaction receipt

fn panic(&mut self, message: String) -> Result<(), RuntimeError>

End the transaction immediately with a given message to be included in the transaction receipt

impl<'a, 'e, Y: SystemApi<RuntimeError>> TransformHandler<RuntimeError> for IntentProcessorObjectsWithApi<'a, 'e, Y>

fn replace_bucket(&mut self, b: ManifestBucket) -> Result<Own, RuntimeError>

fn replace_proof(&mut self, p: ManifestProof) -> Result<Own, RuntimeError>

fn replace_address_reservation( &mut self, r: ManifestAddressReservation, ) -> Result<Own, RuntimeError>

fn replace_named_address( &mut self, a: ManifestNamedAddress, ) -> Result<Reference, RuntimeError>

fn replace_expression( &mut self, e: ManifestExpression, ) -> Result<Vec<Own>, RuntimeError>

fn replace_blob(&mut self, b: ManifestBlobRef) -> Result<Vec<u8>, RuntimeError>

impl Eq for RuntimeError

impl StructuralPartialEq for RuntimeError

impl<'a, Y: SystemBasedKernelApi> SystemApi<RuntimeError> for SystemService<'a, Y>

impl SystemApiError for RuntimeError