Skip to main content

Class: IotaSystemState

A typed view of the on-chain 0x3::iota_system::IotaSystemState object (the 0x5 singleton).

This is only the versioned wrapper; the actual state lives in a dynamic field holding e.g. an IotaSystemStateV2.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "IotaSystemState" = "IotaSystemState";

Methods​

id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

Implementation of​

IotaSystemStateLike.id

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

version()​

version(): bigint;

Version selecting which inner state layout the dynamic field holds.

Returns​

bigint

Implementation of​

IotaSystemStateLike.version

instanceOf()​

static instanceOf(obj_): obj_ is IotaSystemState;

Parameters​

obj_​

any

Returns​

obj_ is IotaSystemState

tryFromBcs()​

static tryFromBcs(bytes): IotaSystemStateLike;

Decode from BCS bytes, without validating the on-chain type tag.

Parameters​

bytes​

ArrayBuffer

Returns​

IotaSystemStateLike

tryFromObject()​

static tryFromObject(object): IotaSystemStateLike;

Decode from an on-chain object, validating its Move type tag.

Parameters​

object​

ObjectLike

Returns​

IotaSystemStateLike