Struct Api

pub struct Api {
    pub codex_id: CodexId,
    pub conforms: TinyOrdSet<u16>,
    pub default_call: Option<CallState>,
    pub global: TinyOrdMap<StateName, GlobalApi>,
    pub owned: TinyOrdMap<StateName, OwnedApi>,
    pub aggregators: TinyOrdMap<MethodName, Aggregator>,
    pub verifiers: TinyOrdMap<MethodName, CallId>,
    pub errors: TinyOrdMap<u256, TinyString>,
}

API is an interface implementation.

API should work without requiring runtime to have corresponding interfaces; it should provide all necessary data. Basically, one may think of API as a compiled interface hierarchy applied to a specific codex.

API does not commit to an interface, since it can match multiple interfaces in the interface hierarchy.

Fields

codex_id: CodexId

Commitment to the codex under which the API is valid.

conforms: TinyOrdSet<u16>

Interface standards to which the API conforms.

default_call: Option<CallState>

Name for the default API call and owned state name.

global: TinyOrdMap<StateName, GlobalApi>

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

owned: TinyOrdMap<StateName, OwnedApi>

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

aggregators: TinyOrdMap<MethodName, Aggregator>

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.

Implementations

impl Api

pub fn codex_id(&self) -> CodexId

Method returning copy of Api::codex_id field. Commitment to the codex under which the API is valid.

pub fn conforms(&self) -> &TinyOrdSet<u16>

Method borrowing Api::conforms field. Interface standards to which the API conforms.

pub fn default_call(&self) -> &Option<CallState>

Method borrowing Api::default_call field. Name for the default API call and owned state name.

pub fn global(&self) -> &TinyOrdMap<StateName, GlobalApi>

Method borrowing Api::global field. State API defines how a structured global contract state is constructed out of (and

pub fn owned(&self) -> &TinyOrdMap<StateName, OwnedApi>

Method borrowing Api::owned field. State API defines how a structured owned contract state is constructed out of (and converted

pub fn aggregators(&self) -> &TinyOrdMap<MethodName, Aggregator>

Method borrowing Api::aggregators field. Readers have access to the converted global state and can construct a derived state out of

pub fn verifiers(&self) -> &TinyOrdMap<MethodName, CallId>

Method borrowing Api::verifiers field. Links between named transaction methods defined in the interface - and corresponding

pub fn errors(&self) -> &TinyOrdMap<u256, TinyString>

Method borrowing Api::errors field. Maps error type reported by a contract verifier via EA value to an error description taken

impl Api

pub fn api_id(&self) -> StrictHash

pub fn verifier(&self, method: impl Into<MethodName>) -> Option<CallId>

pub fn convert_global( &self, data: &StateData, sys: &TypeSystem, ) -> Result<Option<(StateName, StateAtom)>, StateConvertError>

pub fn convert_owned( &self, value: StateValue, sys: &TypeSystem, ) -> Result<Option<(StateName, StrictVal)>, StateConvertError>

pub fn build_immutable( &self, name: impl Into<StateName>, data: StrictVal, raw: Option<StrictVal>, sys: &TypeSystem, ) -> Result<StateData, StateBuildError>

pub fn build_destructible( &self, name: impl Into<StateName>, data: StrictVal, sys: &TypeSystem, ) -> Result<StateValue, StateBuildError>

pub fn build_witness( &self, name: impl Into<StateName>, data: StrictVal, sys: &TypeSystem, ) -> Result<StateValue, StateBuildError>

pub fn calculate( &self, name: impl Into<StateName>, ) -> Result<StateCalc, StateUnknown>

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Api

type CommitmentId = StrictHash

Type of the resulting commitment.

fn commit_encode(&self, engine: &mut CommitEngine)

Encodes the data for the commitment by writing them directly into a std::io::Write writer instance

impl Debug for Api

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Api

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Api

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Api

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Api

fn eq(&self, other: &Self) -> 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 PartialOrd for Api

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Api

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Api

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

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

impl StrictDumb for Api

fn strict_dumb() -> Self

impl StrictEncode for Api

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

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

impl StrictStruct for Api

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

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Api

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl Eq for Api

impl StrictProduct for Api