Skip to main content

Class: Object

An object on the IOTA blockchain

BCS

The BCS serialized form for this type is defined by the following ABNF:

object = object-data owner digest u64

Extends​

  • UniffiAbstractObject

Implements​

Constructors​

Constructor​

new Object(
   data, 
   owner, 
   previousTransaction, 
   storageRebate
): Object;

Parameters​

data​

ObjectDataLike

owner​

OwnerLike

previousTransaction​

TransactionDigestLike

storageRebate​

bigint

Returns​

Object

Overrides​

UniffiAbstractObject.constructor

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

asPackage()​

asPackage(): MovePackageLike;

Interpret this object as a move package

Returns​

MovePackageLike

Implementation of​

ObjectLike.asPackage

asPackageOpt()​

asPackageOpt(): MovePackageLike | undefined;

Try to interpret this object as a move package

Returns​

MovePackageLike | undefined

Implementation of​

ObjectLike.asPackageOpt

asStruct()​

asStruct(): MoveStruct;

Interpret this object as a move struct

Returns​

MoveStruct

Implementation of​

ObjectLike.asStruct

asStructOpt()​

asStructOpt(): MoveStruct | undefined;

Try to interpret this object as a move struct

Returns​

MoveStruct | undefined

Implementation of​

ObjectLike.asStructOpt

data()​

data(): ObjectDataLike;

Return this object's data

Returns​

ObjectDataLike

Implementation of​

ObjectLike.data

digest()​

digest(): ObjectDigestLike;

Calculate the digest of this Object

This is done by hashing the BCS bytes of this Object prefixed

Returns​

ObjectDigestLike

Implementation of​

ObjectLike.digest

equals()​

equals(other): boolean;

Parameters​

other​

Object

Returns​

boolean

id()​

id(): ObjectIdLike;

Return this object's id

Returns​

ObjectIdLike

Implementation of​

ObjectLike.id

objectRef()​

objectRef(): ObjectReference;

Return this object's reference

Returns​

ObjectReference

Implementation of​

ObjectLike.objectRef

objectType()​

objectType(): ObjectTypeLike;

Return this object's type

Returns​

ObjectTypeLike

Implementation of​

ObjectLike.objectType

owner()​

owner(): OwnerLike;

Return this object's owner

Returns​

OwnerLike

Implementation of​

ObjectLike.owner

previousTransaction()​

previousTransaction(): TransactionDigestLike;

Return the digest of the transaction that last modified this object

Returns​

TransactionDigestLike

Implementation of​

ObjectLike.previousTransaction

storageRebate()​

storageRebate(): bigint;

Return the storage rebate locked in this object

Storage rebates are credited to the gas coin used in a transaction that deletes this object.

Returns​

bigint

Implementation of​

ObjectLike.storageRebate

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(): VersionLike;

Return this object's version

Returns​

VersionLike

Implementation of​

ObjectLike.version

instanceOf()​

static instanceOf(obj_): obj_ is Object;

Parameters​

obj_​

any

Returns​

obj_ is Object