IscTransaction

@iota/isc-sdk

---

@iota/isc-sdk / transaction / IscTransaction

Class: IscTransaction

Defined in: isc-sdk/src/transaction.ts:17

Constructors

Constructor

new IscTransaction(chainData, transaction?): IscTransaction

Defined in: isc-sdk/src/transaction.ts:22

Parameters

chainData

chainId

string = ...

packageId

string = ...

transaction?

Transaction = ...

Returns

IscTransaction

Methods

borrowAssets()

borrowAssets(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:275

Parameters

__namedParameters

anchor

ObjectArgument

Returns

TransactionObjectArgument

---

build()

build(): Transaction

Defined in: isc-sdk/src/transaction.ts:378

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

Returns

Transaction

IOTA MOVE Transaction.

---

coinFromAmount()

coinFromAmount(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:52

Get some amount in a coin.

Parameters

__namedParameters

amount

number | bigint

Returns

TransactionObjectArgument

---

createAnchorWithAssetBag()

createAnchorWithAssetBag(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:246

Parameters

__namedParameters

bag

ObjectArgument

Returns

TransactionObjectArgument

---

createAndSend()

createAndSend(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:78

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

Parameters

__namedParameters

bag

ObjectArgument

contract

number

contractArgs

Uint8Array<ArrayBufferLike>[]

contractFunction

number

gasBudget?

number | bigint = L2_FROM_L1_GAS_BUDGET

transfers

[string, number | bigint][]

Returns

void

---

createAndSendToEvm()

createAndSendToEvm(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:109

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

Parameters

__namedParameters

accountsContract

number

accountsFunction

number

address

string

bag

ObjectArgument

gasBudget?

number | bigint = L2_FROM_L1_GAS_BUDGET

transfers

[string, number | bigint][]

Returns

void

---

destroyAnchor()

destroyAnchor(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:270

Parameters

__namedParameters

anchor

ObjectArgument

Returns

TransactionObjectArgument

---

destroyBag()

destroyBag(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:236

Destroy the bag.

Parameters

__namedParameters

bag

ObjectArgument

Returns

TransactionObjectArgument

---

getSizeOfBag()

getSizeOfBag(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:228

Get the size of the bag.

Parameters

__namedParameters

bag

ObjectArgument

Returns

TransactionObjectArgument

---

newBag()

newBag(): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:44

Create a bag.

Returns

TransactionObjectArgument

---

placeAssetForMigration()

placeAssetForMigration(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:355

Parameters

__namedParameters

anchor

ObjectArgument

asset

ObjectArgument

assetType

string

Returns

TransactionObjectArgument

---

placeAssetInBag()

placeAssetInBag(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:196

Place an asset in the bag.

Parameters

__namedParameters

asset

ObjectArgument

assetType

string

bag

ObjectArgument

Returns

void

---

placeCoinBalanceForMigration()

placeCoinBalanceForMigration(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:336

Parameters

__namedParameters

anchor

ObjectArgument

balance

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

TransactionObjectArgument

---

placeCoinBalanceInBag()

placeCoinBalanceInBag(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:180

Place a coin balance in the bag.

Uses the IOTA Coin Type by default.

Parameters

__namedParameters

bag

ObjectArgument

balance

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

void

---

placeCoinForMigration()

placeCoinForMigration(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:317

Parameters

__namedParameters

anchor

ObjectArgument

coin

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

TransactionObjectArgument

---

placeCoinInBag()

placeCoinInBag(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:62

Place a coin in a bag.

Uses the IOTA Coin Type by default.

Parameters

__namedParameters

bag

TransactionObjectArgument

coin

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

void

---

receiveRequest()

receiveRequest(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:293

Parameters

__namedParameters

anchor

ObjectArgument

request

ObjectArgument

Returns

TransactionObjectArgument

---

returnAssetsFromBorrow()

returnAssetsFromBorrow(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:280

Parameters

__namedParameters

anchor

ObjectArgument

bag

ObjectArgument

borrow

ObjectArgument

Returns

TransactionObjectArgument

---

startNewChain()

startNewChain(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:241

Parameters

__namedParameters

coin?

ObjectArgument

metadata

Uint8Array

Returns

TransactionObjectArgument

---

takeAllCoinBalanceFromBag()

takeAllCoinBalanceFromBag(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:164

Take out all the coin from the bag.

Uses the IOTA Coin Type by default.

Parameters

__namedParameters

bag

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

TransactionObjectArgument

---

takeAssetFromBag()

takeAssetFromBag(__namedParameters): void

Defined in: isc-sdk/src/transaction.ts:212

Take an asset from a bag.

Parameters

__namedParameters

asset

ObjectArgument

assetType

string

bag

ObjectArgument

Returns

void

---

takeCoinBalanceFromBag()

takeCoinBalanceFromBag(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:140

Take out the specified amount of coin from the bag.

Uses the IOTA Coin Type by default.

Parameters

__namedParameters

amount

number | bigint

bag

ObjectArgument

coinType?

string = IOTA_TYPE_ARG

Returns

TransactionObjectArgument

---

transaction()

transaction(): Transaction

Defined in: isc-sdk/src/transaction.ts:37

Getter for the IOTA MOVE Transaction.

Returns

Transaction

---

transition()

transition(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:298

Parameters

__namedParameters

anchor

ObjectArgument

newStateMetadata

Uint8Array

receipts

ObjectArgument

Returns

TransactionObjectArgument

---

updateAnchorStateForMigraton()

updateAnchorStateForMigraton(__namedParameters): TransactionObjectArgument

Defined in: isc-sdk/src/transaction.ts:251

Parameters

__namedParameters

anchor

ObjectArgument

metadata

Uint8Array

stateIndex

number

Returns

TransactionObjectArgument