ClientTransactionBuilder

open class ClientTransactionBuilder : Disposable, AutoCloseable, ClientTransactionBuilderInterface

A builder for creating transactions which uses a GraphQL client to automatically resolve inputs. Use finish to finalize the transaction data.

Functions

Name	Summary
close	@Synchronized open override fun close()
destroy	open override fun destroy()
dryRun	open suspend override fun dryRun(skipChecks: Boolean): DryRunResult Dry run the transaction.
execute	open suspend override fun execute(signer: TransactionSigner, waitFor: WaitForTx?): TransactionEffects Execute the transaction and optionally wait for finalization.
executeWithSponsor	open suspend override fun executeWithSponsor(signer: TransactionSigner, sponsorSigner: TransactionSigner, waitFor: WaitForTx?): TransactionEffects Execute the transaction and optionally wait for finalization.
expiration	open override fun expiration(epoch: ULong): ClientTransactionBuilder Set the expiration of the transaction to be a specific epoch.
finish	open suspend override fun finish(): Transaction Convert this builder into a transaction.
gas	open override fun gas(objectIds: List<ObjectId>): ClientTransactionBuilder Add gas coins that will be consumed. Optional.
gasBudget	open override fun gasBudget(budget: ULong): ClientTransactionBuilder Set the gas budget for the transaction.
gasPrice	open override fun gasPrice(price: ULong): ClientTransactionBuilder Set the gas price for the transaction.
gasStationSponsor	open override fun gasStationSponsor(url: String, duration: Duration?, headers: Map<String, List<String>>?): ClientTransactionBuilder Set the gas station sponsor.
makeMoveVec	open override fun makeMoveVec(elements: List<MoveArg>, typeTag: TypeTag, name: String): ClientTransactionBuilder Make a move vector from a list of elements. The elements must all be of the type indicated by type_tag.
mergeCoins	open override fun mergeCoins(primaryCoin: PtbArgument, consumedCoins: List<PtbArgument>): ClientTransactionBuilder Merge multiple coins into one.
moveCall	open override fun moveCall(package: Address, module: Identifier, function: Identifier, arguments: List<PtbArgument>, typeArgs: List<TypeTag>, names: List<String>): ClientTransactionBuilder Call a Move function with the given arguments.
pay	open override fun pay(coins: List<PtbArgument>, payments: List<Payment>): ClientTransactionBuilder Send coins to multiple recipients, each paired with the amount to send.
payIota	open override fun payIota(payments: List<Payment>): ClientTransactionBuilder Send IOTA to multiple recipients, each paired with the amount to send.
publishPackage	open override fun publishPackage(packageData: MovePackageData, upgradeCapName: String): ClientTransactionBuilder Publish a list of modules with the given dependencies. The result assigned to upgrade_cap_name is the 0x2::package::UpgradeCap Move type. Note that the upgrade capability needs to be handled after this call:
sendCoins	open override fun sendCoins(coins: List<PtbArgument>, recipient: Address, amount: PtbArgument?): ClientTransactionBuilder Transfer some coins to a recipient address. If multiple coins are provided then they will be merged.
sendIota	open override fun sendIota(recipient: Address, amount: PtbArgument): ClientTransactionBuilder Send IOTA to a recipient address.
setSender	open override fun setSender(sender: Address) Set the sender address.
splitCoins	open override fun splitCoins(coin: PtbArgument, amounts: List<PtbArgument>, names: List<String>): ClientTransactionBuilder Split a coin into many.
sponsor	open override fun sponsor(sponsor: Address): ClientTransactionBuilder Set the sponsor of the transaction.
stake	open override fun stake(stake: PtbArgument, validatorAddress: Address): ClientTransactionBuilder Add stake to a validator's staking pool.
transferObjects	open override fun transferObjects(recipient: Address, objects: List<PtbArgument>): ClientTransactionBuilder Transfer a list of objects to the given address, without producing any result.
unstake	open override fun unstake(stakedIota: PtbArgument): ClientTransactionBuilder Withdraw stake from a validator's staking pool.
upgrade	open override fun upgrade(packageId: ObjectId, packageData: MovePackageData, upgradeTicket: PtbArgument, name: String?): ClientTransactionBuilder Upgrade a Move package.