Skip to main content

Class: IscTransaction

Constructors

Constructor

new IscTransaction(chainData, transaction?): IscTransaction;

Parameters

ParameterType
chainData{ packageId: string; chainId: string; }
chainData.packageIdstring
chainData.chainIdstring
transactionTransaction

Returns

IscTransaction

Methods

transaction()

transaction(): Transaction;

Getter for the IOTA MOVE Transaction.

Returns

Transaction


newBag()

newBag(): TransactionObjectArgument;

Create a bag.

Returns

TransactionObjectArgument


coinFromAmount()

coinFromAmount(__namedParameters): TransactionObjectArgument;

Get some amount in a coin.

Parameters

ParameterType
__namedParameters{ amount: number | bigint; }
__namedParameters.amountnumber | bigint

Returns

TransactionObjectArgument


placeCoinInBag()

placeCoinInBag(__namedParameters): void;

Place a coin in a bag.

Uses the IOTA Coin Type by default.

Parameters

ParameterType
__namedParameters{ coin: ObjectArgument; coinType?: string; bag: TransactionObjectArgument; }
__namedParameters.coinObjectArgument
__namedParameters.coinType?string
__namedParameters.bagTransactionObjectArgument

Returns

void


createAndSend()

createAndSend(__namedParameters): void;

Finally create and send a request calling the given contractFunction with contractArgs in contract

Parameters

ParameterType
__namedParameters{ contractArgs: Uint8Array[]; contract: number; contractFunction: number; transfers: [string, number | bigint][]; gasBudget?: number | bigint; bag: ObjectArgument; }
__namedParameters.contractArgsUint8Array[]
__namedParameters.contractnumber
__namedParameters.contractFunctionnumber
__namedParameters.transfers[string, number | bigint][]
__namedParameters.gasBudget?number | bigint
__namedParameters.bagObjectArgument

Returns

void


createAndSendToEvm()

createAndSendToEvm(__namedParameters): void;

Finally create and send a request calling the given accountsFunction in accountsContract

Parameters

ParameterType
__namedParameters{ address: string; accountsContract: number; accountsFunction: number; transfers: [string, number | bigint][]; gasBudget?: number | bigint; bag: ObjectArgument; }
__namedParameters.addressstring
__namedParameters.accountsContractnumber
__namedParameters.accountsFunctionnumber
__namedParameters.transfers[string, number | bigint][]
__namedParameters.gasBudget?number | bigint
__namedParameters.bagObjectArgument

Returns

void


takeCoinBalanceFromBag()

takeCoinBalanceFromBag(__namedParameters): TransactionObjectArgument;

Take out the specified amount of coin from the bag.

Uses the IOTA Coin Type by default.

Parameters

ParameterType
__namedParameters{ amount: number | bigint; coinType?: string; bag: ObjectArgument; }
__namedParameters.amountnumber | bigint
__namedParameters.coinType?string
__namedParameters.bagObjectArgument

Returns

TransactionObjectArgument


takeAllCoinBalanceFromBag()

takeAllCoinBalanceFromBag(__namedParameters): TransactionObjectArgument;

Take out all the coin from the bag.

Uses the IOTA Coin Type by default.

Parameters

ParameterType
__namedParameters{ bag: ObjectArgument; coinType?: string; }
__namedParameters.bagObjectArgument
__namedParameters.coinType?string

Returns

TransactionObjectArgument


placeCoinBalanceInBag()

placeCoinBalanceInBag(__namedParameters): void;

Place a coin balance in the bag.

Uses the IOTA Coin Type by default.

Parameters

ParameterType
__namedParameters{ balance: ObjectArgument; coinType?: string; bag: ObjectArgument; }
__namedParameters.balanceObjectArgument
__namedParameters.coinType?string
__namedParameters.bagObjectArgument

Returns

void


placeAssetInBag()

placeAssetInBag(__namedParameters): void;

Place an asset in the bag.

Parameters

ParameterType
__namedParameters{ asset: ObjectArgument; bag: ObjectArgument; assetType: string; }
__namedParameters.assetObjectArgument
__namedParameters.bagObjectArgument
__namedParameters.assetTypestring

Returns

void


takeAssetFromBag()

takeAssetFromBag(__namedParameters): void;

Take an asset from a bag.

Parameters

ParameterType
__namedParameters{ bag: ObjectArgument; assetType: string; asset: ObjectArgument; }
__namedParameters.bagObjectArgument
__namedParameters.assetTypestring
__namedParameters.assetObjectArgument

Returns

void


getSizeOfBag()

getSizeOfBag(__namedParameters): TransactionObjectArgument;

Get the size of the bag.

Parameters

ParameterType
__namedParameters{ bag: ObjectArgument; }
__namedParameters.bagObjectArgument

Returns

TransactionObjectArgument


destroyBag()

destroyBag(__namedParameters): TransactionObjectArgument;

Destroy the bag.

Parameters

ParameterType
__namedParameters{ bag: ObjectArgument; }
__namedParameters.bagObjectArgument

Returns

TransactionObjectArgument


startNewChain()

startNewChain(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ metadata: Uint8Array; coin?: ObjectArgument; }
__namedParameters.metadataUint8Array
__namedParameters.coin?ObjectArgument

Returns

TransactionObjectArgument


createAnchorWithAssetBag()

createAnchorWithAssetBag(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ bag: ObjectArgument; }
__namedParameters.bagObjectArgument

Returns

TransactionObjectArgument


updateAnchorStateForMigraton()

updateAnchorStateForMigraton(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; metadata: Uint8Array; stateIndex: number; }
__namedParameters.anchorObjectArgument
__namedParameters.metadataUint8Array
__namedParameters.stateIndexnumber

Returns

TransactionObjectArgument


destroyAnchor()

destroyAnchor(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; }
__namedParameters.anchorObjectArgument

Returns

TransactionObjectArgument


borrowAssets()

borrowAssets(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; }
__namedParameters.anchorObjectArgument

Returns

TransactionObjectArgument


returnAssetsFromBorrow()

returnAssetsFromBorrow(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; bag: ObjectArgument; borrow: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.bagObjectArgument
__namedParameters.borrowObjectArgument

Returns

TransactionObjectArgument


receiveRequest()

receiveRequest(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; request: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.requestObjectArgument

Returns

TransactionObjectArgument


transition()

transition(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; newStateMetadata: Uint8Array; receipts: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.newStateMetadataUint8Array
__namedParameters.receiptsObjectArgument

Returns

TransactionObjectArgument


placeCoinForMigration()

placeCoinForMigration(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; coinType?: string; coin: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.coinType?string
__namedParameters.coinObjectArgument

Returns

TransactionObjectArgument


placeCoinBalanceForMigration()

placeCoinBalanceForMigration(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; coinType?: string; balance: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.coinType?string
__namedParameters.balanceObjectArgument

Returns

TransactionObjectArgument


placeAssetForMigration()

placeAssetForMigration(__namedParameters): TransactionObjectArgument;

Parameters

ParameterType
__namedParameters{ anchor: ObjectArgument; assetType: string; asset: ObjectArgument; }
__namedParameters.anchorObjectArgument
__namedParameters.assetTypestring
__namedParameters.assetObjectArgument

Returns

TransactionObjectArgument


build()

build(): Transaction;

Stop building this ISC Transaction and return the IOTA MOVE Transaction.

Returns

Transaction

IOTA MOVE Transaction.