Skip to main content

Class: BasicOutput

A typed view of an on-chain 0x107a::basic_output::BasicOutput<IOTA> object.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

balance()​

balance(): bigint;

IOTA balance held by the output, in nanos.

Returns​

bigint

Implementation of​

BasicOutputLike.balance

expirationUc()​

expirationUc(): 
  | ExpirationUnlockConditionLike
  | undefined;

Returns​

| ExpirationUnlockConditionLike | undefined

Implementation of​

BasicOutputLike.expirationUc

id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

Implementation of​

BasicOutputLike.id

metadata()​

metadata(): ArrayBuffer | undefined;

Returns​

ArrayBuffer | undefined

Implementation of​

BasicOutputLike.metadata

nativeTokensBagId()​

nativeTokensBagId(): ObjectIdLike;

Object ID of the Bag of native tokens. Use the GraphQL client to list dynamic fields if you need to enumerate the tokens.

Returns​

ObjectIdLike

Implementation of​

BasicOutputLike.nativeTokensBagId

sender()​

sender(): AddressLike | undefined;

Returns​

AddressLike | undefined

Implementation of​

BasicOutputLike.sender

storageDepositReturnUc()​

storageDepositReturnUc(): 
  | StorageDepositReturnUnlockConditionLike
  | undefined;

Returns​

| StorageDepositReturnUnlockConditionLike | undefined

Implementation of​

BasicOutputLike.storageDepositReturnUc

tag()​

tag(): ArrayBuffer | undefined;

Returns​

ArrayBuffer | undefined

Implementation of​

BasicOutputLike.tag

timelockUc()​

timelockUc(): 
  | TimelockUnlockConditionLike
  | undefined;

Returns​

| TimelockUnlockConditionLike | undefined

Implementation of​

BasicOutputLike.timelockUc

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

Parameters​

obj_​

any

Returns​

obj_ is BasicOutput

tryFromBcs()​

static tryFromBcs(bytes): BasicOutputLike;

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

Parameters​

bytes​

ArrayBuffer

Returns​

BasicOutputLike

tryFromObject()​

static tryFromObject(object): BasicOutputLike;

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

Parameters​

object​

ObjectLike

Returns​

BasicOutputLike