Skip to main content

UnsafePayAllIotaParams

@iota/iota-sdk


@iota/iota-sdk / client / UnsafePayAllIotaParams

Interface: UnsafePayAllIotaParams

Defined in: sdk/typescript/src/client/types/params.ts:601

Send all IOTA coins to one recipient. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_all_iota does are: 1. accumulate all IOTA from input coins and deposit all IOTA to the first input coin 2. transfer the updated first coin to the recipient and also use this first coin as gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted.

Properties​

gasBudget​

gasBudget: string

Defined in: sdk/typescript/src/client/types/params.ts:609

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:605

the IOTA coins to be used in this transaction, including the coin for gas payment.


recipient​

recipient: string

Defined in: sdk/typescript/src/client/types/params.ts:607

the recipient address,


signal?​

optional signal?: AbortSignal

Defined in: sdk/typescript/src/client/types/params.ts:610


signer​

signer: string

Defined in: sdk/typescript/src/client/types/params.ts:603

the transaction signer's IOTA address