SuiGrpcClient class

gRPC-web client for Sui full nodes (sui.rpc.v2).

Thin transport-specific facade that delegates to a CoreClient (GrpcCoreClient); mirrors the official TS SDK's SuiGrpcClient where most methods forward to this.core.

Available extensions

Constructors

SuiGrpcClient({required SuiNetwork network, Dio? dio})

Properties

core CoreClient
Transport-agnostic core API. Prefer this for portable code.
final
hashCode int
The hash code for this object.
no setterinherited
mvr MvrClient?
Move Registry resolver (@org/app → package id / type tag). Null on networks without a public MVR endpoint (devnet/localnet).
final
network SuiNetwork
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

balanceOf(String owner, {String coinType = '0x2::sui::SUI'}) Future<SuiBalance>
getBalance as a transport-neutral SuiBalance.
dryRunTransactionBlock(Uint8List transactionBcs) Future<SimulateTransactionResponse>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of simulateTransaction (old dryRunTransactionBlock).
executeTransaction(Uint8List transactionBcs, List<Uint8List> signatures, {List<String>? readMask}) Future<ExecutedTransaction>
getBalance(String owner, {String coinType = '0x2::sui::SUI'}) Future<Balance>
getChainIdentifier() Future<String>
getCheckpoint({int? sequenceNumber, String? digest, List<String>? readMask}) Future<Checkpoint>
getCoinInfo(String coinType) Future<GetCoinInfoResponse>
getCoinMetadata(String coinType) Future<GetCoinInfoResponse>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of getCoinInfo-derived total supply.
getCurrentSystemState() Future<SystemState>
getDynamicFieldObject(String parentId, String nameType, Uint8List nameBcs, {List<String>? readMask}) Future<Object>
getDynamicObjectField(String parentId, String nameType, Uint8List nameBcs, {List<String>? readMask}) Future<Object>
getEpoch({int? epoch, List<String>? readMask}) Future<Epoch>
getFunction(String packageId, String moduleName, String functionName) Future<FunctionDescriptor>
getObject(String objectId, {List<String>? readMask}) Future<Object>
getObjects(List<String> objectIds, {List<String>? readMask}) Future<List<GetObjectResult>>
getOwnedObjects(String address, {int? limit, Uint8List? cursor, String? objectType}) Future<ListOwnedObjectsResponse>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of listOwnedObjects.
getPackage(String packageId) Future<Package>
getReferenceGasPrice() Future<Int64>
getReferenceGasPriceBigInt() Future<BigInt>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias: old getReferenceGasPrice returned a BigInt.
getTransaction(String digest, {List<String>? readMask}) Future<ExecutedTransaction>
getTransactionBlock(String digest, {List<String>? readMask}) Future<ExecutedTransaction>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of getTransaction.
listBalances(String owner, {int? pageSize, Uint8List? pageToken}) Future<ListBalancesResponse>
listCoins(String owner, {String coinType = '0x2::sui::SUI', Uint8List? cursor, int? limit}) Future<SuiCoinPage>
listDynamicFields(String parentId, {int? pageSize, Uint8List? pageToken}) Future<ListDynamicFieldsResponse>
listOwnedObjects(String owner, {int? pageSize, Uint8List? pageToken, String? objectType, List<String>? readMask}) Future<ListOwnedObjectsResponse>
lookupName(String name) Future<NameRecord>
multiGetObjectsSingle(String objectId, {List<String>? readMask}) Future<Object>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of getObjects / getObject.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
objectInfo(String objectId, {List<String>? readMask}) Future<SuiObjectInfo>
getObject as a transport-neutral SuiObjectInfo.
prepareTransaction(Transaction tx, {required String sender, BigInt? gasBudget}) Future<Uint8List>
Prepare tx and return built TransactionData BCS bytes (ready to sign).
resolveNameServiceAddress(String name) Future<String?>
reverseLookupName(String address) Future<NameRecord>
signAndExecute(SuiAccount signer, Transaction tx, {BigInt? gasBudget}) Future<SuiExecutionResult>
signAndExecuteTransaction returning a transport-neutral result.
signAndExecuteTransaction(SuiAccount signer, Transaction tx, {BigInt? gasBudget, List<String>? readMask}) Future<ExecutedTransaction>
Prepare (gas price/payment/budget), sign and execute tx in one call.
signAndExecuteTransactionBlock(SuiAccount signer, Transaction transaction, {BigInt? gasBudget}) Future<ExecutedTransaction>

Available on SuiGrpcClient, provided by the LegacyNames extension

Legacy alias of signAndExecuteTransaction.
simulateTransaction(Uint8List transactionBcs, {List<String>? readMask, bool doGasSelection = true, bool checksEnabled = true}) Future<SimulateTransactionResponse>
subscribeCheckpoints({List<String>? readMask}) Stream<SubscribeCheckpointsResponse>
Subscribe to executed checkpoints (server-streaming gRPC-web).
toString() String
A string representation of this object.
inherited
verifySignature(Uint8List message, Uint8List signature, {required IntentScope intentScope, String? address}) Future<SignatureVerification>
waitForTransaction(String digest, {Duration timeout = const Duration(seconds: 60), Duration pollInterval = const Duration(milliseconds: 500), List<String>? readMask}) Future<ExecutedTransaction>

Operators

operator ==(Object other) bool
The equality operator.
inherited