ClientTransactionBuilderInterface
interface ClientTransactionBuilderInterface
A builder for creating transactions which uses a GraphQL client to automatically resolve inputs. Use finish to finalize the transaction data.
Inheritors
| ClientTransactionBuilder |
Functions
| Name | Summary |
|---|---|
| dryRun | abstract suspend fun dryRun(skipChecks: Boolean = false): DryRunResult Dry run the transaction. |
| execute | abstract suspend fun execute(signer: TransactionSigner, waitFor: WaitForTx? = null): TransactionEffects Execute the transaction and optionally wait for finalization. |
| executeWithSponsor | abstract suspend fun executeWithSponsor(signer: TransactionSigner, sponsorSigner: TransactionSigner, waitFor: WaitForTx? = null): TransactionEffects Execute the transaction and optionally wait for finalization. |
| expiration | abstract fun expiration(epoch: ULong): ClientTransactionBuilder Set the expiration of the transaction to be a specific epoch. |
| finish | abstract suspend fun finish(): Transaction Convert this builder into a transaction. |
| gas | abstract fun gas(objectIds: List<ObjectId>): ClientTransactionBuilder Add gas coins that will be consumed. Optional. |
| gasBudget | abstract fun gasBudget(budget: ULong): ClientTransactionBuilder Set the gas budget for the transaction. |
| gasPrice | abstract fun gasPrice(price: ULong): ClientTransactionBuilder Set the gas price for the transaction. |
| gasStationSponsor | abstract fun gasStationSponsor(url: String, duration: Duration? = null, headers: Map<String, List<String>>? = null): ClientTransactionBuilder Set the gas station sponsor. |
| makeMoveVec | abstract 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 | abstract fun mergeCoins(primaryCoin: PtbArgument, consumedCoins: List<PtbArgument>): ClientTransactionBuilder Merge multiple coins into one. |
| moveCall | abstract fun moveCall(package: Address, module: Identifier, function: Identifier, arguments: List<PtbArgument> = listOf(), typeArgs: List<TypeTag> = listOf(), names: List<String> = listOf()): ClientTransactionBuilder Call a Move function with the given arguments. |
| pay | abstract fun pay(coins: List<PtbArgument>, payments: List<Payment>): ClientTransactionBuilder Send coins to multiple recipients, each paired with the amount to send. |
| payIota | abstract fun payIota(payments: List<Payment>): ClientTransactionBuilder Send IOTA to multiple recipients, each paired with the amount to send. |
| publishPackage | abstract 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 | abstract fun sendCoins(coins: List<PtbArgument>, recipient: Address, amount: PtbArgument? = null): ClientTransactionBuilder Transfer some coins to a recipient address. If multiple coins are provided then they will be merged. |
| sendIota | abstract fun sendIota(recipient: Address, amount: PtbArgument): ClientTransactionBuilder Send IOTA to a recipient address. |
| setSender | abstract fun setSender(sender: Address) Set the sender address. |
| splitCoins | abstract fun splitCoins(coin: PtbArgument, amounts: List<PtbArgument>, names: List<String> = listOf()): ClientTransactionBuilder Split a coin into many. |
| sponsor | abstract fun sponsor(sponsor: Address): ClientTransactionBuilder Set the sponsor of the transaction. |
| stake | abstract fun stake(stake: PtbArgument, validatorAddress: Address): ClientTransactionBuilder Add stake to a validator's staking pool. |
| transferObjects | abstract fun transferObjects(recipient: Address, objects: List<PtbArgument>): ClientTransactionBuilder Transfer a list of objects to the given address, without producing any result. |
| unstake | abstract fun unstake(stakedIota: PtbArgument): ClientTransactionBuilder Withdraw stake from a validator's staking pool. |
| upgrade | abstract fun upgrade(packageId: ObjectId, packageData: MovePackageData, upgradeTicket: PtbArgument, name: String? = null): ClientTransactionBuilder Upgrade a Move package. |