UnsafePayIotaParams
@iota/iota-sdk / client / UnsafePayIotaParams
Interface: UnsafePayIotaParams
Defined in: sdk/typescript/src/client/types/params.ts:621
Send IOTA coins to a list of addresses, following a list of amounts. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_iota does are: 1. debit each input_coin to create new coin following the order of amounts and assign it to the corresponding recipient. 2. accumulate all residual IOTA from input coins left and deposit all IOTA to the first input coin, then use the first input coin as the gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other than the first one are deleted.
Properties
amounts
amounts:
string[]
Defined in: sdk/typescript/src/client/types/params.ts:629
the amounts to be transferred to recipients, following the same order
gasBudget
gasBudget:
string
Defined in: sdk/typescript/src/client/types/params.ts:631
the gas budget, the transaction will fail if the gas cost exceed the budget
inputCoins
inputCoins:
string[]
Defined in: sdk/typescript/src/client/types/params.ts:625
the IOTA coins to be used in this transaction, including the coin for gas payment.
recipients
recipients:
string[]
Defined in: sdk/typescript/src/client/types/params.ts:627
the recipients' addresses, the length of this vector must be the same as amounts.
signal?
optionalsignal?:AbortSignal
Defined in: sdk/typescript/src/client/types/params.ts:632
signer
signer:
string
Defined in: sdk/typescript/src/client/types/params.ts:623
the transaction signer's IOTA address