Skip to main content

Class: IotaSystemStateV1

A typed view of the 0x3::iota_system_state_inner::IotaSystemStateV1 inner system state, the layout selected by [IotaSystemState::version] 1.

Exposes the same parameters as [IotaSystemStateV2], except that safe-mode computation is accounted as rewards rather than charges, and the validator set is a [ValidatorSetV1].

Extends

  • UniffiAbstractObject

Implements

Properties

[destructorGuardSymbol]

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]

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

Methods

epoch()

epoch(): bigint;

Returns

bigint

Implementation of

IotaSystemStateV1Like.epoch


epochStartTimestampMs()

epochStartTimestampMs(): bigint;

Unix timestamp (ms) of the current epoch start.

Returns

bigint

Implementation of

IotaSystemStateV1Like.epochStartTimestampMs


extraFieldsId()

extraFieldsId(): ObjectIdLike;

Object ID of the Bag holding fields added to this struct after its current on-chain layout was set.

Returns

ObjectIdLike

Implementation of

IotaSystemStateV1Like.extraFieldsId


iotaTotalSupply()

iotaTotalSupply(): bigint;

Total IOTA supply controlled by the system treasury, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.iotaTotalSupply


parameters()

parameters(): SystemParametersV1Like;

The system parameters.

Returns

SystemParametersV1Like

Implementation of

IotaSystemStateV1Like.parameters


protocolVersion()

protocolVersion(): bigint;

Returns

bigint

Implementation of

IotaSystemStateV1Like.protocolVersion


referenceGasPrice()

referenceGasPrice(): bigint;

The reference gas price for the current epoch, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.referenceGasPrice


safeMode()

safeMode(): boolean;

Whether the system is running in a downgraded safe mode.

Returns

boolean

Implementation of

IotaSystemStateV1Like.safeMode


safeModeComputationRewards()

safeModeComputationRewards(): bigint;

Computation rewards accumulated during safe mode, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.safeModeComputationRewards


safeModeNonRefundableStorageFee()

safeModeNonRefundableStorageFee(): bigint;

Non-refundable storage fees accumulated during safe mode, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.safeModeNonRefundableStorageFee


safeModeStorageCharges()

safeModeStorageCharges(): bigint;

Storage charges accumulated during safe mode, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.safeModeStorageCharges


safeModeStorageRebates()

safeModeStorageRebates(): bigint;

Storage rebates accumulated during safe mode, in nanos.

Returns

bigint

Implementation of

IotaSystemStateV1Like.safeModeStorageRebates


storageFund()

storageFund(): StorageFundV1Like;

The storage fund.

Returns

StorageFundV1Like

Implementation of

IotaSystemStateV1Like.storageFund


systemStateVersion()

systemStateVersion(): bigint;

Returns

bigint

Implementation of

IotaSystemStateV1Like.systemStateVersion


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

validatorReportRecords()

validatorReportRecords(): Map<AddressLike, AddressLike[]>;

Validator report records: each reported validator's address mapped to the addresses of the validators reporting it.

Returns

Map<AddressLike, AddressLike[]>

Implementation of

IotaSystemStateV1Like.validatorReportRecords


validators()

validators(): ValidatorSetV1Like;

The validator set.

Returns

ValidatorSetV1Like

Implementation of

IotaSystemStateV1Like.validators


instanceOf()

static instanceOf(obj_): obj_ is IotaSystemStateV1;

Parameters

obj_

any

Returns

obj_ is IotaSystemStateV1


tryFromBcs()

static tryFromBcs(bytes): IotaSystemStateV1Like;

Decode an IotaSystemStateV1 from raw BCS bytes.

There is no object-based constructor: the inner state is stored as a dynamic field of the 0x5 wrapper, not as a top-level object with its own type tag.

Parameters

bytes

ArrayBuffer

Returns

IotaSystemStateV1Like