radix-engine-interface 1.3.1

The interface between system layer and VM layer, from the Radix DLT project.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

pub mod actor_api;
pub mod actor_index_api;
pub mod actor_key_value_entry_api;
pub mod actor_sorted_index_api;
pub mod blueprint_api;
pub mod costing_api;
pub mod execution_trace_api;
pub mod field_api;
pub mod key_value_entry_api;
pub mod key_value_store_api;
pub mod object_api;
pub mod transaction_runtime_api;

// Re-exports
pub use actor_api::*;
pub use actor_index_api::*;
pub use actor_key_value_entry_api::*;
pub use actor_sorted_index_api::*;
pub use blueprint_api::*;
pub use costing_api::*;
pub use execution_trace_api::*;
pub use field_api::*;
pub use key_value_entry_api::*;
pub use key_value_store_api::*;
pub use object_api::*;
pub use transaction_runtime_api::*;

pub type ActorStateHandle = u32;

pub const ACTOR_STATE_SELF: ActorStateHandle = 0u32;
pub const ACTOR_STATE_OUTER_OBJECT: ActorStateHandle = 1u32;

pub type ActorRefHandle = u32;

pub const ACTOR_REF_SELF: ActorRefHandle = 0u32;
pub const ACTOR_REF_OUTER: ActorRefHandle = 1u32;
pub const ACTOR_REF_GLOBAL: ActorRefHandle = 2u32;
pub const ACTOR_REF_AUTH_ZONE: ActorRefHandle = 8u32;

pub type FieldIndex = u8;
pub type CollectionIndex = u8;

use radix_common::prelude::*;

pub trait SystemApiError: fmt::Debug + ScryptoCategorize + ScryptoDecode {}

/// Interface of the system, for blueprints and object modules.
///
/// For WASM blueprints, only a subset of the API is exposed at the moment.
pub trait SystemApi<E: SystemApiError>:
    SystemActorApi<E>
    + SystemActorKeyValueEntryApi<E>
    + SystemObjectApi<E>
    + SystemKeyValueStoreApi<E>
    + SystemKeyValueEntryApi<E>
    + SystemActorSortedIndexApi<E>
    + SystemActorIndexApi<E>
    + SystemFieldApi<E>
    + SystemBlueprintApi<E>
    + SystemCostingApi<E>
    + SystemTransactionRuntimeApi<E>
    + SystemExecutionTraceApi<E>
{
}