Skip to main content

Class: TokenPolicy

A typed view of an on-chain 0x2::token::TokenPolicy<T> object.

Extends

  • UniffiAbstractObject

Implements

Properties

[destructorGuardSymbol]

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]

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

Methods

id()

id(): ObjectIdLike;

The object's ID.

Returns

ObjectIdLike

Implementation of

TokenPolicyLike.id


rules()

rules(): Map<string, string[]>;

Fully-qualified type names of the rules attached to each action, keyed by action name.

Returns

Map<string, string[]>

Implementation of

TokenPolicyLike.rules


spentBalance()

spentBalance(): bigint;

Balance spent on the spend action, in base units.

Returns

bigint

Implementation of

TokenPolicyLike.spentBalance


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 TokenPolicy;

Parameters

obj_

any

Returns

obj_ is TokenPolicy


tryFromBcs()

static tryFromBcs(bytes): TokenPolicyLike;

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

Parameters

bytes

ArrayBuffer

Returns

TokenPolicyLike


tryFromObjectWithType()

static tryFromObjectWithType(object, typeParam): TokenPolicyLike;

Decode from an on-chain object, validating its Move type tag, including that its type parameter equals type_param.

Parameters

object

ObjectLike

typeParam

TypeTagLike

Returns

TokenPolicyLike