payAllSui

suspend fun payAllSui(signer: SuiAddress, inputCoins: List<ObjectId>, recipient: SuiAddress, gasBudget: Long): TransactionBlockBytes

Send all SUI coins to one recipient.

This is for SUI coin only and does not require a separate gas coin object. Specifically, what pay_all_sui does are: 1. accumulate all SUI from input coins and deposit all SUI 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.

Return

TransactionBlockBytes The transaction block bytes after the publishing is completed.

Parameters

signer

The transaction signer's Sui address.

inputCoins

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

recipient

The recipients' Sui address.

gasBudget

The gas budget, the transaction will fail if the gas cost exceed the budget.

Throws

if there is an error during the publishing process.