API Reference ex_sui v#0.1.0
View SourceModules
Sui gRPC client
Contains functions to interface with the Sui Ledger service.
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
A message type used to describe a single bad request field.
Describes additional debugging info.
Describes the cause of the error with structured details.
Provides links to documentation or for performing an out of band action.
Describes a URL link.
Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
Describes what preconditions have failed.
A message type used to describe a single precondition failure.
Describes how a quota check failed.
A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
Describes the resource that is being accessed.
Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
The Status
type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details.
An Ability
classifies what operations are permitted for a given type
A set of abilities for a type parameter
Balance information for a specific coin type.
Metadata for a coin type
Information about a coin type's 0x2::coin::TreasuryCap
and its total available supply
An intermediate result/output from the execution of a single command
Describes a Move Datatype.
Descriptor of a field that belongs to a struct or enum variant
Descriptor of a Move function
Request message for LiveDataService.GetBalance
.
Response message for LiveDataService.GetBalance
.
Return the total coin balance for one coin type, owned by the address owner.
Request message for NodeService.GetCoinInfo
.
Response message for NodeService.GetCoinInfo
.
Request message for LiveDataService.ListBalances
.
Response message for LiveDataService.ListBalances
.
Return the total coin balance for all coin types, owned by the address owner.
Request message for NodeService.ListDynamicFields
Response message for NodeService.ListDynamicFields
A Move Module.
Representation of a type signature that could appear as a function parameter or return value.
Representation of a type signature that could appear as a field type for a struct or enum
A Move Package
A simplified representation of a package version
Information about a regulated coin, which indicates that it makes use of the transfer deny list.
buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
Request message for SubscriptionService.SubscribeCheckpoints
Response message for SubscriptionService.SubscribeCheckpoints
A generic type parameter used in the declaration of a struct or enum.
Descriptor of an enum variant
A new JWK.
An argument to a programmable transaction command.
Expire old JWKs.
Update the set of valid JWKs.
The delta, or change, in balance for an address for a particular Coin
type.
Bcs
contains an arbitrary type that is serialized using the
BCS
format as well as a name that identifies the type of the serialized value.
A transaction that was canceled.
System transaction used to change the epoch.
Input/output state of an object that was changed during execution.
A commitment made by a checkpoint.
The committed to contents of a checkpoint.
A header for a checkpoint on the Sui blockchain.
Transaction information committed to in a checkpoint.
A G1 point.
A G2 point.
A single command in a programmable transaction.
An error with an argument to a command.
Consensus commit prologue system transaction.
Version assignments performed by consensus.
Data, which when included in a CheckpointSummary
, signals the end of an Epoch
.
Set of operations run at the end of the epoch to close out the current epoch and start the next one.
Operation run at the end of an epoch.
An event.
Response message for NodeService.ExecuteTransaction
.
An error that can occur during the execution of a transaction.
The status of an executed transaction.
Summary of gas charges.
Payment information for executing a transaction.
The genesis transaction.
message BatchGetCheckpointsRequest { repeated GetCheckpointRequest requests = 1;
An input to a user transaction.
A JSON web key.
Key to uniquely identify a JWK.
Command to build a Move vector out of a set of individual elements.
Command to merge multiple coins of the same type into a single coin.
Command to call a Move function.
Location in Move bytecode where an error occurred.
Module defined by a package.
A message that represents a Move 0x2::table::Table
or 0x2::bag::Bag
Aggregated signature from members of a multisig committee.
A multisig committee.
A member in a multisig committee.
Set of valid public keys for multisig committee members.
A signature from a member of a multisig committee.
An object on the Sui blockchain.
Reference to an object.
Enum of different types of ownership for an object.
An error with upgrading a package.
A passkey authenticator.
A user transaction.
Command to publish a new Move package.
Randomness update.
Flag use to disambiguate the signature schemes supported by Sui.
A size error.
Command to split a single coin object into multiple coins.
A staking pool embedded in each validator struct in the system state object.
Struct representing the onchain storage fund.
System package.
A transaction.
The effects of executing a transaction.
Events emitted during the successful execution of a transaction.
A TTL for a transaction.
Indicates the finality of the executed transaction.
Transaction type.
Command to transfer ownership of a set of objects to an address.
Type argument error.
Identifies a struct and the module it was defined in.
A shared object that wasn't changed during execution.
Command to upgrade an already published package.
/ Upgraded package info for the linkage table.
A signature from a user.
Definition of a Validator in the system contracts
/ An aggregated signature from multiple validators.
The validator set for a particular epoch.
A member of a validator committee.
Object version assignment from consensus.
A zklogin authenticator.
A claim of the iss in a zklogin proof.
A zklogin groth16 proof and the required inputs to perform proof verification.
A zklogin groth16 proof.
Public key equivalent for zklogin authenticators.
Mix Tasks
Clones the sui gRPC protobuf files from their github repository