Struct ApiInner

pub struct ApiInner<Vm: ApiVm> {

    pub version: ReservedBytes<2>,
    pub codex_id: CodexId,
    pub timestamp: i64,
    pub name: Option<TypeName>,
    pub developer: Identity,
    pub conforms: Option<TypeName>,
    pub default_call: Option<CallState>,
    pub reserved: ReservedBytes<8>,
    pub append_only: TinyOrdMap<StateName, AppendApi<Vm>>,
    pub destructible: TinyOrdMap<StateName, DestructibleApi<Vm>>,
    pub readers: TinyOrdMap<MethodName, Vm::Reader>,
    pub verifiers: TinyOrdMap<MethodName, CallId>,
    pub errors: TinyOrdMap<u256, TinyString>,
}

Fields

version: ReservedBytes<2>

Version of the API structure.

codex_id: CodexId

Commitment to the codex under which the API is valid.

timestamp: i64

Timestamp, which is used for versioning (later APIs have priority over new ones).

name: Option<TypeName>

API name. Each codex must have a default API with no name.

developer: Identity

Developer identity string.

conforms: Option<TypeName>

Interface standard to which the API conforms.

default_call: Option<CallState>

Name for the default API call and destructible state name.

reserved: ReservedBytes<8>

Reserved for future use.

append_only: TinyOrdMap<StateName, AppendApi<Vm>>

State API defines how a structured contract state is constructed out of (and converted into) UltraSONIC immutable memory cells.

destructible: TinyOrdMap<StateName, DestructibleApi<Vm>>

State API defines how a structured contract state is constructed out of (and converted into) UltraSONIC destructible memory cells.

readers: TinyOrdMap<MethodName, Vm::Reader>

Readers have access to the converted global state and can construct a derived state out of it.

The typical examples when readers are used are to sum individual asset issues and compute the number of totally issued assets.

verifiers: TinyOrdMap<MethodName, CallId>

Links between named transaction methods defined in the interface - and corresponding verifier call ids defined by the contract.

NB: Multiple methods from the interface may call the came verifier.

errors: TinyOrdMap<u256, TinyString>

Maps error type reported by a contract verifier via EA value to an error description taken from the interfaces.

Trait Implementations

impl<Vm: Clone + ApiVm> Clone for ApiInner<Vm>

where Vm::Reader: Clone,

fn clone(&self) -> ApiInner<Vm>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Vm: Debug + ApiVm> Debug for ApiInner<Vm>

where Vm::Reader: Debug,

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

Formats the value using the given formatter.

impl<'de, Vm: ApiVm> Deserialize<'de> for ApiInner<Vm>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ApiInner<EmbeddedProc>> for Api

fn from(v: ApiInner<EmbeddedProc>) -> Self

Converts to this type from the input type.

impl From<ApiInner<Vm>> for Api

fn from(v: ApiInner<Vm>) -> Self

Converts to this type from the input type.

impl<Vm: ApiVm> Serialize for ApiInner<Vm>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Vm: ApiVm> StrictDecode for ApiInner<Vm>

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl<Vm: ApiVm> StrictDumb for ApiInner<Vm>

fn strict_dumb() -> Self

impl<Vm: ApiVm> StrictEncode for ApiInner<Vm>

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl<Vm: ApiVm> StrictStruct for ApiInner<Vm>

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl<Vm: ApiVm> StrictType for ApiInner<Vm>

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl<Vm: ApiVm> StrictProduct for ApiInner<Vm>