Skip to main content

TransactionBuilder

TransactionBuilder​

class TransactionBuilder

A builder for creating transactions. Use finish to finalize the transaction data.

init(sender:)​

convenience init(sender: Address)

Create a new transaction builder and initialize its elements to default.

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

executeWithGasStation(signer:)​

func executeWithGasStation(signer: TransactionSigner) async throws -> Value

Execute the transaction using the gas station and return the JSON transaction effects. This will fail unless data is set with the gas_station_sponsor function.

NOTE: These effects are not necessarily compatible with TransactionEffects

expiration(epoch:)​

func expiration(epoch: UInt64) -> TransactionBuilder

Set the expiration of the transaction to be a specific epoch.

finish()​

func finish() throws -> Transaction

Convert this builder into a transaction.

gas(objectRefs:)​

func gas(objectRefs: [ObjectReference]) -> TransactionBuilder

Add gas coins that will be consumed. Optional.

gasBudget(budget:)​

func gasBudget(budget: UInt64) -> TransactionBuilder

Set the gas budget for the transaction.

gasPrice(price:)​

func gasPrice(price: UInt64) -> TransactionBuilder

Set the gas price for the transaction.

gasStationSponsor(url:duration:headers:)​

func gasStationSponsor(url: String, duration: TimeInterval? = nil, headers: [String : [String]]? = nil) -> TransactionBuilder

Set the gas station sponsor.

makeMoveVec(elements:typeTag:name:)​

func makeMoveVec(elements: [MoveArg], typeTag: TypeTag, name: String) -> TransactionBuilder

Make a move vector from a list of elements. The elements must all be of the type indicated by type_tag.

mergeCoins(primaryCoin:consumedCoins:)​

func mergeCoins(primaryCoin: PtbArgument, consumedCoins: [PtbArgument]) -> TransactionBuilder

Merge multiple coins into one.

This method combines the balances of multiple coins of the same coin type into a single coin. The primary_coin will receive the balances from all consumed_coins. After merging, the consumed_coins will be consumed and no longer exist.

moveCall(package:module:function:arguments:typeArgs:names:)​

func moveCall(package: Address, module: Identifier, function: Identifier, arguments: [PtbArgument] = [], typeArgs: [TypeTag] = [], names: [String] = []) -> TransactionBuilder

Call a Move function with the given arguments.

pay(coins:payments:)​

func pay(coins: [PtbArgument], payments: [Payment]) -> TransactionBuilder

Send coins to multiple recipients, each paired with the amount to send.

The amounts specify quantities in the coins' smallest unit (NANOS for IOTA coins, where 1 IOTA equals 1_000_000_000 NANOS).

The coins are merged into the first one, the amounts are split off it in a single command, and each split coin is transferred to its corresponding recipient, with one transfer command per unique recipient. The remainder stays in the first coin.

All provided coins must have the same coin type. Mixing coins of different types will result in an error.

To pay IOTA directly from the gas coin, use TransactionBuilder::pay_iota() instead.

For a single recipient, consider using TransactionBuilder::send_coins() or TransactionBuilder::send_iota() instead.

payIota(payments:)​

func payIota(payments: [Payment]) -> TransactionBuilder

Send IOTA to multiple recipients, each paired with the amount to send.

The amounts specify quantities in NANOS, where 1 IOTA equals 1_000_000_000 NANOS. They are split off the gas coin in a single command, and each split coin is transferred to its corresponding recipient, with one transfer command per unique recipient.

To pay with specific coins, or with a coin type other than IOTA, use TransactionBuilder::pay(). For a single recipient, consider using TransactionBuilder::send_iota() instead.

publishPackage(packageData:upgradeCapName:)​

func publishPackage(packageData: MovePackageData, upgradeCapName: String) -> TransactionBuilder

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:

  • transfer it to the transaction sender or another address
  • burn it
  • wrap it for access control
  • discard the it to make a package immutable

The arguments required for this command are:

  • modules: is the modules' bytecode to be published
  • dependencies: is the list of IDs of the transitive dependencies of the package

sendCoins(coins:recipient:amount:)​

func sendCoins(coins: [PtbArgument], recipient: Address, amount: PtbArgument? = nil) -> TransactionBuilder

Transfer some coins to a recipient address. If multiple coins are provided then they will be merged.

The amount parameter specifies the quantity in NANOS, where 1 IOTA equals 1_000_000_000 NANOS. If amount is provided, that amount is split from the provided coins and sent. If amount is None, the entire coins are transferred.

All provided coins must have the same coin type. Mixing coins of different types will result in an error.

If you intend to transfer all provided coins to another address in a single transaction, consider using TransactionBuilder::transfer_objects() instead.

sendIota(recipient:amount:)​

func sendIota(recipient: Address, amount: PtbArgument) -> TransactionBuilder

Send IOTA to a recipient address.

The amount parameter specifies the quantity in NANOS, where 1 IOTA equals 1_000_000_000 NANOS. That amount is split from the gas coin and sent.

setSender(sender:)​

func setSender(sender: Address)

Set the sender address.

splitCoins(coin:amounts:names:)​

func splitCoins(coin: PtbArgument, amounts: [PtbArgument], names: [String] = []) -> TransactionBuilder

Split a coin by the provided amounts.

sponsor(sponsor:)​

func sponsor(sponsor: Address) -> TransactionBuilder

Set the sponsor of the transaction.

stake(stake:validatorAddress:)​

func stake(stake: PtbArgument, validatorAddress: Address) -> TransactionBuilder

Add stake to a validator's staking pool.

This is a high-level function which will split the provided stake amount from the gas coin and then stake using the resulting coin.

transferObjects(recipient:objects:)​

func transferObjects(recipient: Address, objects: [PtbArgument]) -> TransactionBuilder

Transfer a list of objects to the given address, without producing any result.

unstake(stakedIota:)​

func unstake(stakedIota: PtbArgument) -> TransactionBuilder

Withdraw stake from a validator's staking pool.

upgrade(packageId:packageData:upgradeTicket:name:)​

func upgrade(packageId: ObjectId, packageData: MovePackageData, upgradeTicket: PtbArgument, name: String? = nil) -> TransactionBuilder

Upgrade a Move package.

  • modules: is the modules' bytecode for the modules to be published
  • dependencies: is the list of IDs of the transitive dependencies of the package to be upgraded
  • package: is the ID of the current package being upgraded
  • ticket: is the upgrade ticket

To get the ticket, you have to call the 0x2::package::authorize_upgrade function, and pass the package ID, the upgrade policy, and package digest.

withClient(client:)​

func withClient(client: GraphQlClient) -> ClientTransactionBuilder

fromProgrammableTransaction(ptb:)​

static func fromProgrammableTransaction(ptb: ProgrammableTransaction) -> TransactionBuilder

Create a transaction builder from a programmable transaction.

The returned builder has the original inputs and commands but no sender, gas payment, sponsor, or expiration; the sender defaults to the zero address and must be set via set_sender before finish is called.

fromTransaction(transaction:)​

static func fromTransaction(transaction: Transaction) throws -> TransactionBuilder

Reconstruct a transaction builder from a finalized transaction. Calling finish on the returned builder produces a transaction equal to the input.

Only programmable transactions are supported; other transaction kinds will return an error.