Transaction class

Constructors

Transaction([Transaction? transaction])

Properties

blockData → TransactionDataV1

no setter

gas → Map<String, dynamic>

Returns an argument for the gas coin, to be used in a transaction.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

pure → Pure

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

add(dynamic transaction) → TransactionResult

balance(String type, BigInt balance, {bool useGasCoin = true}) → TransactionResult

Like coin but produces a Balance<[type]> value — for Move functions that take a balance directly, and for gasless address-balance transfers (e.g. 0x2::balance::send_funds<T>).

build([BuildOptions? options]) → Future<Uint8List>

Build the transaction to BCS bytes.

coin(String type, BigInt balance, {bool useGasCoin = true}) → TransactionResult

Produces a Coin<[type]> of exactly balance base units, sourced from the sender's owned coin objects and/or per-address balance. The exact commands (merge + split of owned coins, or an address-balance withdrawal) are chosen at build time by the CoinWithBalance resolver based on what the sender holds. For SUI, useGasCoin (the default) splits from the gas coin.

getData() → TransactionData

getDigest(BuildOptions options) → Future<String>

Derive transaction digest

isBuilderCallArg(dynamic arg) → bool

isReceivingType(dynamic type) → bool

isUsedAsMutable(TransactionBlockDataBuilder transactionData, int index) → bool

isUsedAsReceiving(TransactionBlockDataBuilder transactionData, int index) → bool

makeMoveVec({required dynamic objects, String? type}) → TransactionResult

mergeCoins(Map<String, dynamic> destination, List<Map<String, dynamic>> sources) → TransactionResult

moveCall(String target, {List? typeArguments, List? arguments}) → TransactionResult

normalizeInputs(BuildOptions options) → Future<void>

normalizeRawArgument(dynamic arg, BcsType schema) → void

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

object(dynamic value) → Map<String, dynamic>

objectId(String value) → Map<String, dynamic>

objectRef(SuiObjectRef args) → Map<String, dynamic>

Add a new object input to the transaction using the fully-resolved object reference. If you only have an object ID, use builder.object(id) instead.

publish(List<String> modules, List<String> dependencies) → TransactionResult

pureAddress(String address) → Map<String, dynamic>

pureBool(bool value) → Map<String, dynamic>

pureInt(int value, [String type = 'u64']) → Map<String, dynamic>

pureString(String str) → Map<String, dynamic>

pureVector(List value, [String type = 'u64']) → Map<String, dynamic>

resolveNames({required Future<String> resolvePackage(String package), required Future<String> resolveType(String package)}) → Future<void>

Resolve Move Registry (@org/app) names in this transaction's moveCall commands — both the package name and any type arguments — using the given resolver callbacks. Rewrites the commands in place. No-op if no MVR names are present. Mirrors the TypeScript SDK's NamedPackagesPlugin.

resolveObjectReferences(BuildOptions options) → Future<void>

serialize() → String

Serialize the transaction to a string so that it can be sent to a separate context. This is different from build in that it does not serialize to BCS bytes, and instead uses a separate format that is unique to the transaction builder. This allows us to serialize partially-complete transactions, that can then be completed and built in a separate context.

setExpiration(int? epoch) → void

setGasBudget(BigInt budget) → void

setGasOwner(String owner) → void

setGasPayment(List<SuiObjectRef> payments) → void

setGasPrice(BigInt price) → void

setSender(String sender) → void

setSenderIfNotSet(String sender) → void

Sets the sender only if it has not already been set. This is useful for sponsored transaction flows where the sender may not be the same as the signer address.

setValidDuringExpiration({int? minEpoch, int? maxEpoch, int? minTimestamp, int? maxTimestamp, required String chain, required int nonce}) → void

Bounds this transaction's validity to a window (epochs and/or timestamps) with a random nonce. Required for transactions carrying no gas payment (address-balance / gasless): validators use the window + nonce instead of an owned gas object to prevent equivocation. chain is the chain identifier (genesis checkpoint digest, base58 — e.g. from getChainIdentifier()).

sharedObjectRef(SuiObject args) → Map<String, dynamic>

Add a new shared object input to the transaction using the fully-resolved shared object reference. If you only have an object ID, use builder.object(id) instead.

sign(SignOptions options) → Future<SignatureWithBytes>

Build the transaction to BCS bytes, and sign it with the provided keypair.

splitCoins(Map<String, dynamic> coin, List amounts) → TransactionResult

toJson([SerializeTransactionOptions? options]) → String

toString() → String

A string representation of this object.

inherited

transferObjects(List objects, dynamic address) → TransactionResult

upgrade({required List<String> modules, required List<String> dependencies, required String packageId, required dynamic ticket}) → TransactionResult

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

from(String serialized) → Transaction

Converts from a serialized transaction format to a Transaction class. There are two supported serialized formats:

fromBytes(Uint8List bytes) → Transaction

fromKind(dynamic serialized) → Transaction

Converts from a serialize transaction kind (built with build({ onlyTransactionKind: true })) to a Transaction class. Supports either a byte array, or base64-encoded bytes.