Skip to main content

Class: StakedIota

A typed view of an on-chain 0x3::staking_pool::StakedIota object.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

Implementation of​

StakedIotaLike.id


poolId()​

poolId(): ObjectIdLike;

Returns​

ObjectIdLike

Implementation of​

StakedIotaLike.poolId


principal()​

principal(): bigint;

Staked principal in nanos.

Returns​

bigint

Implementation of​

StakedIotaLike.principal


stakeActivationEpoch()​

stakeActivationEpoch(): bigint;

Returns​

bigint

Implementation of​

StakedIotaLike.stakeActivationEpoch


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

instanceOf()​

static instanceOf(obj_): obj_ is StakedIota;

Parameters​

obj_​

any

Returns​

obj_ is StakedIota


tryFromBcs()​

static tryFromBcs(bytes): StakedIotaLike;

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

Parameters​

bytes​

ArrayBuffer

Returns​

StakedIotaLike


tryFromObject()​

static tryFromObject(object): StakedIotaLike;

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

Parameters​

object​

ObjectLike

Returns​

StakedIotaLike