Skip to main content

Sui Full Node gRPC

Sui full node gRPC API replaces JSON-RPC on full nodes. JSON-RPC is deprecated.

sui/rpc/v2/argument.proto​

Messages

Argument​

An argument to a programmable transaction command.

Fields
input
Proto3 optional
Index of an input when kind is INPUT.
kind
Proto3 optional
result
Proto3 optional
Index of a result when kind is RESULT.
subresult
Proto3 optional
Used to access a nested result when kind is RESULT.

Enums

ArgumentKind

Enums
ARGUMENT_KIND_UNKNOWN
GAS
The gas coin.
INPUT
One of the input objects or primitive values (from ProgrammableTransaction inputs).
RESULT
The result of another command (from ProgrammableTransaction commands).

sui/rpc/v2/signature_verification_service.proto​

Messages

VerifySignatureRequest​

Fields
address
Proto3 optional
Optional. Address to validate against the provided signature. If provided, this address will be compared against the the address derived from the provide signature and a successful response will only be returned if they match.
jwks
Repeated []
The set of JWKs to use when verifying Zklogin signatures. If this is empty the current set of valid JWKs stored onchain will be used
message
Proto3 optional
The message to verify against. Today the only supported message types are PersonalMessage and TransactionData and the Bcs.name must be set to indicate which type of message is being verified.
signature
Proto3 optional
The signature to verify.

VerifySignatureResponse​

Fields
is_valid
Proto3 optional
Indicates if the provided signature was valid given the requested parameters.
reason
Proto3 optional
If is_valid is false, this is the reason for why the signature verification failed.

Services (signature_verification_service.proto)​

SignatureVerificationService

Methods
VerifySignatureRequest -> VerifySignatureResponse
Perform signature verification of a UserSignature against the provided message.

sui/rpc/v2/move_package_service.proto​

Messages

GetDatatypeRequest​

Fields
module_name
Proto3 optional
Required. The name of the requested module.
name
Proto3 optional
Required. The name of the requested datatype.
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetDatatypeResponse​

Fields
datatype
Proto3 optional
The datatype.

GetFunctionRequest​

Fields
module_name
Proto3 optional
Required. The name of the requested module.
name
Proto3 optional
Required. The name of the requested function.
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetFunctionResponse​

Fields
function
Proto3 optional
The function.

GetPackageRequest​

Fields
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetPackageResponse​

Fields
package
Proto3 optional
The package.

ListPackageVersionsRequest​

Fields
package_id
Proto3 optional
Required. The storage_id of any version of the package.
page_size
Proto3 optional
The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 1000 entries will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
page_token
Proto3 optional
A page token, received from a previous ListPackageVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPackageVersions must match the call that provided the page token.

ListPackageVersionsResponse​

Fields
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
versions
Repeated []
List of all package versions, ordered by version.

PackageVersion​

A simplified representation of a package version

Fields
package_id
Proto3 optional
The storage ID of this package version
version
Proto3 optional
The version number

Services (move_package_service.proto)​

MovePackageService

Methods
GetPackageRequest -> GetPackageResponse
GetDatatypeRequest -> GetDatatypeResponse
GetFunctionRequest -> GetFunctionResponse
ListPackageVersionsRequest -> ListPackageVersionsResponse

sui/rpc/v2/checkpoint_summary.proto​

Messages

CheckpointCommitment​

A commitment made by a checkpoint.

Fields
digest
Proto3 optional
kind
Proto3 optional

CheckpointSummary​

A header for a checkpoint on the Sui blockchain.

On the Sui network, checkpoints define the history of the blockchain. They are quite similar to the concept of blocks used by other blockchains like Bitcoin or Ethereum. The Sui blockchain, however, forms checkpoints after transaction execution has already happened to provide a certified history of the chain, instead of being formed before execution.

Checkpoints commit to a variety of state, including but not limited to:

  • The hash of the previous checkpoint.
  • The set of transaction digests, their corresponding effects digests, as well as the set of user signatures that authorized its execution.
  • The objects produced by a transaction.
  • The set of live objects that make up the current state of the chain.
  • On epoch transitions, the next validator committee.

CheckpointSummarys themselves don't directly include all of the previous information but they are the top-level type by which all the information is committed to transitively via cryptographic hashes included in the summary. CheckpointSummarys are signed and certified by a quorum of the validator committee in a given epoch to allow verification of the chain's state.

Fields
bcs
Proto3 optional
This CheckpointSummary serialized as BCS.
commitments
Repeated []
Commitments to checkpoint-specific state.
content_digest
Proto3 optional
The hash of the CheckpointContents for this checkpoint.
digest
Proto3 optional
The digest of this CheckpointSummary.
end_of_epoch_data
Proto3 optional
Extra data only present in the final checkpoint of an epoch.
epoch
Proto3 optional
Epoch that this checkpoint belongs to.
epoch_rolling_gas_cost_summary
Proto3 optional
The running total gas costs of all transactions included in the current epoch so far until this checkpoint.
previous_digest
Proto3 optional
The hash of the previous CheckpointSummary. This will be None only for the first, or genesis, checkpoint.
sequence_number
Proto3 optional
The height of this checkpoint.
timestamp
Proto3 optional
Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have the same timestamp if they originate from the same underlining consensus commit.
total_network_transactions
Proto3 optional
Total number of transactions committed since genesis, including those in this checkpoint.
version_specific_data
Proto3 optional
CheckpointSummary is not an evolvable structure - it must be readable by any version of the code. Therefore, to allow extensions to be added to CheckpointSummary, opaque data can be added to checkpoints, which can be deserialized based on the current protocol version.

EndOfEpochData​

Data, which when included in a CheckpointSummary, signals the end of an Epoch.

Fields
epoch_commitments
Repeated []
Commitments to epoch specific state (live object set)
next_epoch_committee
Repeated []
The set of validators that will be in the ValidatorCommittee for the next epoch.
next_epoch_protocol_version
Proto3 optional
The protocol version that is in effect during the next epoch.

Enums

CheckpointCommitmentKind

Enums
CHECKPOINT_COMMITMENT_KIND_UNKNOWN
ECMH_LIVE_OBJECT_SET
An elliptic curve multiset hash attesting to the set of objects that comprise the live state of the Sui blockchain.
CHECKPOINT_ARTIFACTS
Digest of the checkpoint artifacts.

sui/rpc/v2/transaction_execution_service.proto​

Messages

CommandOutput​

Fields
argument
Proto3 optional
json
Proto3 optional
JSON rendering of the output.
value
Proto3 optional

CommandResult​

An intermediate result/output from the execution of a single command

Fields
mutated_by_ref
Repeated []
return_values
Repeated []

ExecuteTransactionRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to effects.status,checkpoint.
signatures
Repeated []
Set of UserSignatures authorizing the execution of the provided transaction.
transaction
Proto3 optional
The transaction to execute.

ExecuteTransactionResponse​

Response message for NodeService.ExecuteTransaction.

Fields
transaction
Proto3 optional

SimulateTransactionRequest​

Fields
checks
Proto3 optional
Specify whether checks should be ENABLED (default) or DISABLED while executing the transaction
do_gas_selection
Proto3 optional
Perform gas selection based on a budget estimation and include the selected gas payment and budget in the response. This option will be ignored if checks is DISABLED.
read_mask
Proto3 optional
Mask specifying which fields to read.
transaction
Proto3 optional

SimulateTransactionResponse​

Fields
command_outputs
Repeated []
transaction
Proto3 optional

Services (transaction_execution_service.proto)​

TransactionExecutionService

Methods
ExecuteTransactionRequest -> ExecuteTransactionResponse
SimulateTransactionRequest -> SimulateTransactionResponse

Enums

TransactionChecks

buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
Enums
ENABLED
DISABLED

sui/rpc/v2/ledger_service.proto​

Messages

BatchGetObjectsRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,digest.
requests
Repeated []

BatchGetObjectsResponse​

Fields
objects
Repeated []

BatchGetTransactionsRequest​

Fields
digests
Repeated []
Required. The digests of the requested transactions.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to digest.

BatchGetTransactionsResponse​

Fields
transactions
Repeated []

GetCheckpointRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to sequence_number,digest.
Union field checkpoint_id can be only one of the following.
digest
The digest of the requested checkpoint.
sequence_number
The sequence number of the requested checkpoint.

GetCheckpointResponse​

Fields
checkpoint
Proto3 optional

GetEpochRequest​

Fields
epoch
Proto3 optional
The requested epoch. If no epoch is provided the current epoch will be returned.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to epoch.

GetEpochResponse​

Fields
epoch
Proto3 optional

GetObjectRequest​

Fields
object_id
Proto3 optional
Required. The ObjectId of the requested object.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,digest.
version
Proto3 optional
Request a specific version of the object. If no version is specified, and the object is live, then the latest version of the object is returned.

GetObjectResponse​

Fields
object
Proto3 optional

GetObjectResult​

Fields
Union field result can be only one of the following.
error
object

GetServiceInfoRequest​

GetServiceInfoResponse​

Fields
chain
Proto3 optional
Human-readable name of the chain that this node is on. This is intended to be a human-readable name like mainnet, testnet, and so on.
chain_id
Proto3 optional
The chain identifier of the chain that this node is on. The chain identifier is the digest of the genesis checkpoint, the checkpoint with sequence number 0.
checkpoint_height
Proto3 optional
Checkpoint height of the most recently executed checkpoint.
epoch
Proto3 optional
Current epoch of the node based on its highest executed checkpoint.
lowest_available_checkpoint
Proto3 optional
The lowest checkpoint for which checkpoints and transaction data are available.
lowest_available_checkpoint_objects
Proto3 optional
The lowest checkpoint for which object data is available.
server
Proto3 optional
Software version of the service. Similar to the server http header.
timestamp
Proto3 optional
Unix timestamp of the most recently executed checkpoint.

GetTransactionRequest​

Fields
digest
Proto3 optional
Required. The digest of the requested transaction.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to digest.

GetTransactionResponse​

Fields
transaction
Proto3 optional

GetTransactionResult​

Fields
Union field result can be only one of the following.
error
transaction

Services (ledger_service.proto)​

LedgerService

Methods
GetServiceInfoRequest -> GetServiceInfoResponse
Query the service for general information about its current state.
GetObjectRequest -> GetObjectResponse
BatchGetObjectsRequest -> BatchGetObjectsResponse
GetTransactionRequest -> GetTransactionResponse
BatchGetTransactionsRequest -> BatchGetTransactionsResponse
GetCheckpointRequest -> GetCheckpointResponse
GetEpochRequest -> GetEpochResponse

sui/rpc/v2/event.proto​

Messages

Event​

An event.

Fields
contents
Proto3 optional
BCS serialized bytes of the event.
event_type
Proto3 optional
The type of the event emitted.
json
Proto3 optional
JSON rendering of the event.
module
Proto3 optional
Module name of the top-level function invoked by a MoveCall command that triggered this event to be emitted.
package_id
Proto3 optional
Package ID of the top-level function invoked by a MoveCall command that triggered this event to be emitted.
sender
Proto3 optional
Address of the account that sent the transaction where this event was emitted.

TransactionEvents​

Events emitted during the successful execution of a transaction.

Fields
bcs
Proto3 optional
This TransactionEvents serialized as BCS.
digest
Proto3 optional
The digest of this TransactionEvents.
events
Repeated []
Set of events emitted by a transaction.

sui/rpc/v2/owner.proto​

Messages

Owner​

Enum of different types of ownership for an object.

Fields
address
Proto3 optional
Address or ObjectId of the owner
kind
Proto3 optional
version
Proto3 optional
The initial_shared_version if kind is SHARED or start_version if kind CONSENSUS_ADDRESS.

Enums

OwnerKind

Enums
OWNER_KIND_UNKNOWN
ADDRESS
OBJECT
SHARED
IMMUTABLE
CONSENSUS_ADDRESS

sui/rpc/v2/object.proto​

Messages

Object​

An object on the Sui blockchain.

Fields
balance
Proto3 optional
Current balance if this object is a 0x2::coin::Coin<T>
bcs
Proto3 optional
This Object serialized as BCS.
contents
Proto3 optional
BCS bytes of a Move struct value. Only set for Move structs
digest
Proto3 optional
The digest of this Object.
has_public_transfer
Proto3 optional
DEPRECATED this field is no longer used to determine whether a tx can transfer this object. Instead, it is always calculated from the objects type when loaded in execution. Only set for Move structs
json
Proto3 optional
JSON rendering of the object.
object_id
Proto3 optional
ObjectId for this object.
object_type
Proto3 optional
The type of this object. This will be 'package' for packages and a StructTag for move structs.
owner
Proto3 optional
Owner of the object.
package
Proto3 optional
Package information for Move Packages
previous_transaction
Proto3 optional
The digest of the transaction that created or last mutated this object
storage_rebate
Proto3 optional
The amount of SUI to rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.
version
Proto3 optional
Version of the object.

ObjectSet​

Set of Objects

Fields
objects
Repeated []
Objects are sorted by the key (object_id, version).

sui/rpc/v2/jwk.proto​

Messages

Jwk​

A JSON web key.

Struct that contains info for a JWK. A list of them for different kinds can be retrieved from the JWK endpoint (for example, &#lt;https://www.googleapis.com/oauth2/v3/certs>). The JWK is used to verify the JWT token.

Fields
alg
Proto3 optional
e
Proto3 optional
kty
Proto3 optional
n
Proto3 optional

JwkId​

Key to uniquely identify a JWK.

Fields
iss
Proto3 optional
The issuer or identity of the OIDC provider.
kid
Proto3 optional
A key ID used to uniquely identify a key from an OIDC provider.

sui/rpc/v2/effects.proto​

Messages

ChangedObject​

Input/output state of an object that was changed during execution.

Fields
id_operation
Proto3 optional
What happened to an ObjectId during execution.
input_digest
Proto3 optional
Digest of the object before this transaction executed.
input_owner
Proto3 optional
Owner of the object before this transaction executed.
input_state
Proto3 optional
input_version
Proto3 optional
Version of the object before this transaction executed.
object_id
Proto3 optional
ID of the object.
object_type
Proto3 optional
Type information is not provided by the effects structure but is instead provided by an indexing layer
output_digest
Proto3 optional
Digest of the object after this transaction executed.
output_owner
Proto3 optional
Owner of the object after this transaction executed.
output_state
Proto3 optional
output_version
Proto3 optional
Version of the object after this transaction executed.

TransactionEffects​

The effects of executing a transaction.

Fields
auxiliary_data_digest
Proto3 optional
Auxiliary data that are not protocol-critical, generated as part of the effects but are stored separately. Storing it separately allows us to avoid bloating the effects with data that are not critical. It also provides more flexibility on the format and type of the data.
bcs
Proto3 optional
This TransactionEffects serialized as BCS.
changed_objects
Repeated []
Objects whose state are changed by this transaction.
dependencies
Repeated []
The set of transaction digests this transaction depends on.
digest
Proto3 optional
The digest of this TransactionEffects.
epoch
Proto3 optional
The epoch when this transaction was executed.
events_digest
Proto3 optional
The digest of the events emitted during execution, can be None if the transaction does not emit any event.
gas_object
Proto3 optional
Information about the gas object. Also present in the changed_objects vector. System transactions that don't require gas will leave this as None.
gas_used
Proto3 optional
The gas used by this transaction.
lamport_version
Proto3 optional
The version number of all the written objects (excluding packages) by this transaction.
status
Proto3 optional
The status of the execution.
transaction_digest
Proto3 optional
The transaction digest.
unchanged_consensus_objects
Repeated []
Consensus objects that are not mutated in this transaction. Unlike owned objects, read-only consensus objects' version are not committed in the transaction, and in order for a node to catch up and execute it without consensus sequencing, the version needs to be committed in the effects.
unchanged_loaded_runtime_objects
Repeated []
version
Proto3 optional
Version of this TransactionEffects.

UnchangedConsensusObject​

A consensus object that wasn't changed during execution.

Fields
digest
Proto3 optional
Digest of the consensus object.
kind
Proto3 optional
object_id
Proto3 optional
ObjectId of the consensus object.
object_type
Proto3 optional
Type information is not provided by the effects structure but is instead provided by an indexing layer
version
Proto3 optional
Version of the consensus object.

Enums

IdOperation

Enums
ID_OPERATION_UNKNOWN
NONE
CREATED
DELETED

InputObjectState

Enums
INPUT_OBJECT_STATE_UNKNOWN
INPUT_OBJECT_STATE_DOES_NOT_EXIST
INPUT_OBJECT_STATE_EXISTS

OutputObjectState

Enums
OUTPUT_OBJECT_STATE_UNKNOWN
OUTPUT_OBJECT_STATE_DOES_NOT_EXIST
OUTPUT_OBJECT_STATE_OBJECT_WRITE
OUTPUT_OBJECT_STATE_PACKAGE_WRITE

UnchangedConsensusObjectKind

Enums
UNCHANGED_CONSENSUS_OBJECT_KIND_UNKNOWN
READ_ONLY_ROOT
Read-only consensus object from the input.
MUTATE_CONSENSUS_STREAM_ENDED
Objects with ended consensus streams that appear mutably/owned in the input.
READ_CONSENSUS_STREAM_ENDED
Objects with ended consensus streams objects that appear as read-only in the input.
CANCELED
Consensus objects that were congested and resulted in this transaction being canceled.
PER_EPOCH_CONFIG
Read of a per-epoch config object that should remain the same during an epoch. This optionally will indicate the sequence number of the config object at the start of the epoch.

sui/rpc/v2/executed_transaction.proto​

Messages

ExecutedTransaction​

Fields
balance_changes
Repeated []
checkpoint
Proto3 optional
The sequence number for the checkpoint that includes this transaction.
digest
Proto3 optional
The digest of this Transaction.
effects
Proto3 optional
The TransactionEffects for this transaction.
events
Proto3 optional
The TransactionEvents for this transaction. This field might be empty, even if it was explicitly requested, if the transaction didn't produce any events. sui.types.TransactionEffects.events_digest is populated if the transaction produced any events.
objects
Proto3 optional
Set of objects either referenced as inputs or produced as outputs from this Transaction.
signatures
Repeated []
List of user signatures that are used to authorize the execution of this transaction.
timestamp
Proto3 optional
The Unix timestamp of the checkpoint that includes this transaction.
transaction
Proto3 optional
The transaction itself.

sui/rpc/v2/name_service.proto​

Messages

LookupNameRequest​

Fields
name
Proto3 optional
Required. The SuiNS name to lookup. Supports both @name as well as name.sui formats.

LookupNameResponse​

Fields
record
Proto3 optional
The record for the requested name

NameRecord​

Fields
data
Repeated []
Additional data which may be stored in a record
expiration_timestamp
Proto3 optional
Timestamp when the record expires. This is either the expiration of the record itself or the expiration of this record's parent if this is a leaf record.
id
Proto3 optional
Id of this record. Note that records are stored on chain as dynamic fields of the type Field<Domain,NameRecord>.
name
Proto3 optional
The SuiNS name of this record
registration_nft_id
Proto3 optional
The ID of the RegistrationNFT assigned to this record. The owner of the corresponding RegistrationNFT has the rights to be able to change and adjust the target_address of this domain. It is possible that the ID changes if the record expires and is purchased by someone else.
target_address
Proto3 optional
The target address that this name points to

DataEntry​

Fields
key
value

ReverseLookupNameRequest​

Fields
address
Proto3 optional
Required. The address to perform a reverse lookup for.

ReverseLookupNameResponse​

Fields
record
Proto3 optional
The record for the SuiNS name linked to the requested address

Services (name_service.proto)​

NameService

Methods
LookupNameRequest -> LookupNameResponse
ReverseLookupNameRequest -> ReverseLookupNameResponse

sui/rpc/v2/signature.proto​

Messages

CircomG1​

A G1 point.

Fields
e0
Proto3 optional
base10 encoded Bn254FieldElement
e1
Proto3 optional
base10 encoded Bn254FieldElement
e2
Proto3 optional
base10 encoded Bn254FieldElement

CircomG2​

A G2 point.

Fields
e00
Proto3 optional
base10 encoded Bn254FieldElement
e01
Proto3 optional
base10 encoded Bn254FieldElement
e10
Proto3 optional
base10 encoded Bn254FieldElement
e11
Proto3 optional
base10 encoded Bn254FieldElement
e20
Proto3 optional
base10 encoded Bn254FieldElement
e21
Proto3 optional
base10 encoded Bn254FieldElement

MultisigAggregatedSignature​

Aggregated signature from members of a multisig committee.

Fields
bitmap
Proto3 optional
Bitmap indicating which committee members contributed to the signature.
committee
Proto3 optional
The committee to use to validate this signature.
legacy_bitmap
Proto3 optional
If present, means this signature's on-chain format uses the old legacy multisig format.
signatures
Repeated []
The plain signatures encoded with signature scheme. The signatures must be in the same order as they are listed in the committee.

MultisigCommittee​

A multisig committee.

Fields
members
Repeated []
A list of committee members and their corresponding weight.
threshold
Proto3 optional
The threshold of signatures needed to validate a signature from this committee.

MultisigMember​

A member in a multisig committee.

Fields
public_key
Proto3 optional
The public key of the committee member.
weight
Proto3 optional
The weight of this member's signature.

MultisigMemberPublicKey​

Set of valid public keys for multisig committee members.

Fields
public_key
Proto3 optional
Public key bytes if scheme is ed25519 | secp256k1 | secp256r1 | passkey.
scheme
Proto3 optional
The signature scheme of this public key.
zklogin
Proto3 optional
A zklogin public identifier if scheme is zklogin.

MultisigMemberSignature​

A signature from a member of a multisig committee.

Fields
passkey
Proto3 optional
The passkey authenticator if scheme is PASSKEY.
scheme
Proto3 optional
The signature scheme of this signature.
signature
Proto3 optional
Signature bytes if scheme is ed25519 | secp256k1 | secp256r1.
zklogin
Proto3 optional
The zklogin authenticator if scheme is ZKLOGIN.

PasskeyAuthenticator​

A passkey authenticator.

See struct.PasskeyAuthenticator for more information on the requirements on the shape of the client_data_json field.

Fields
authenticator_data
Proto3 optional
Opaque authenticator data for this passkey signature. See Authenticator Data for more information on this field.
client_data_json
Proto3 optional
Structured, unparsed, JSON for this passkey signature. See CollectedClientData for more information on this field.
signature
Proto3 optional
A secp256r1 signature.

SimpleSignature​

Either an ed25519, secp256k1 or secp256r1 signature

Fields
public_key
Proto3 optional
Public key bytes
scheme
Proto3 optional
The signature scheme of this signature.
signature
Proto3 optional
Signature bytes

UserSignature​

A signature from a user.

Fields
bcs
Proto3 optional
This signature serialized as as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.
scheme
Proto3 optional
The signature scheme of this signature.
Union field signature can be only one of the following.
multisig
The multisig aggregated signature if scheme is MULTISIG.
passkey
The passkey authenticator if scheme is PASSKEY.
simple
Simple signature if scheme is ed25519 | secp256k1 | secp256r1.
zklogin
The zklogin authenticator if scheme is ZKLOGIN.

ValidatorAggregatedSignature​

An aggregated signature from multiple validators.

Fields
bitmap
Proto3 optional
Bitmap indicating which members of the committee contributed to this signature.
epoch
Proto3 optional
The epoch when this signature was produced. This can be used to lookup the ValidatorCommittee from this epoch to verify this signature.
signature
Proto3 optional
The 48-byte Bls12381 aggregated signature.

ValidatorCommittee​

The validator set for a particular epoch.

Fields
epoch
Proto3 optional
The epoch where this committee governs.
members
Repeated []
The committee members.

ValidatorCommitteeMember​

A member of a validator committee.

Fields
public_key
Proto3 optional
The 96-byte Bls12381 public key for this validator.
weight
Proto3 optional
voting weight this validator possesses.

ZkLoginAuthenticator​

A zklogin authenticator.

Fields
inputs
Proto3 optional
Zklogin proof and inputs required to perform proof verification.
jwk_id
Proto3 optional
The id of the JWK used to authorize this zklogin authenticator
max_epoch
Proto3 optional
Maximum epoch for which the proof is valid.
public_identifier
Proto3 optional
The public identifier (similar to a public key) for this zklogin authenticator
signature
Proto3 optional
User signature with the public key attested to by the provided proof.

ZkLoginClaim​

A claim of the iss in a zklogin proof.

Fields
index_mod_4
Proto3 optional
value
Proto3 optional

ZkLoginInputs​

A zklogin groth16 proof and the required inputs to perform proof verification.

Fields
address_seed
Proto3 optional
base10 encoded Bn254FieldElement
header_base64
Proto3 optional
iss_base64_details
Proto3 optional
proof_points
Proto3 optional

ZkLoginProof​

A zklogin groth16 proof.

Fields
a
Proto3 optional
b
Proto3 optional
c
Proto3 optional

ZkLoginPublicIdentifier​

Public key equivalent for zklogin authenticators.

Fields
address_seed
Proto3 optional
base10 encoded Bn254FieldElement
iss
Proto3 optional

sui/rpc/v2/gas_cost_summary.proto​

Messages

GasCostSummary​

Summary of gas charges.

Fields
computation_cost
Proto3 optional
Cost of computation/execution.
non_refundable_storage_fee
Proto3 optional
The fee for the rebate. The portion of the storage rebate kept by the system.
storage_cost
Proto3 optional
Storage cost, it's the sum of all storage cost for all objects created or mutated.
storage_rebate
Proto3 optional
The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.

sui/rpc/v2/error_reason.proto​

Enums

ErrorReason

Enums
ERROR_REASON_UNKNOWN
FIELD_INVALID
FIELD_MISSING

sui/rpc/v2/protocol_config.proto​

Messages

ProtocolConfig​

Fields
attributes
Repeated []
feature_flags
Repeated []
protocol_version
Proto3 optional

AttributesEntry​

Fields
key
value

FeatureFlagsEntry​

Fields
key
value

sui/rpc/v2/system_state.proto​

Messages

MoveTable​

A message that represents a Move 0x2::table::Table or 0x2::bag::Bag

Fields
id
Proto3 optional
The UID of the table or bag
size
Proto3 optional
The size or number of key-value pairs in the table or bag

StakeSubsidy​

Fields
balance
Proto3 optional
Balance of SUI set aside for stake subsidies that will be drawn down over time.
current_distribution_amount
Proto3 optional
The amount of stake subsidy to be drawn down per distribution. This amount decays and decreases over time.
distribution_counter
Proto3 optional
Count of the number of times stake subsidies have been distributed.
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
stake_subsidy_decrease_rate
Proto3 optional
The rate at which the distribution amount decays at the end of each period. Expressed in basis points.
stake_subsidy_period_length
Proto3 optional
Number of distributions to occur before the distribution amount decays.

StakingPool​

A staking pool embedded in each validator struct in the system state object.

Fields
activation_epoch
Proto3 optional
The epoch at which this pool became active. The value is None if the pool is pre-active and Some(<epoch_number>) if active or inactive.
deactivation_epoch
Proto3 optional
The epoch at which this staking pool ceased to be active. None = {pre-active, active}, Some(<epoch_number>) if in-active, and it was de-activated at epoch <epoch_number>.
exchange_rates
Proto3 optional
Exchange rate history of previous epochs. The entries start from the activation_epoch of this pool and contains exchange rates at the beginning of each epoch, i.e., right after the rewards for the previous epoch have been deposited into the pool. key: u64 (epoch number), value: PoolTokenExchangeRate
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
id
Proto3 optional
UID of the StakingPool object
pending_pool_token_withdraw
Proto3 optional
Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.
pending_stake
Proto3 optional
Pending stake amount for this epoch, emptied at epoch boundaries.
pending_total_sui_withdraw
Proto3 optional
Pending stake withdrawn during the current epoch, emptied at epoch boundaries. This includes both the principal and rewards SUI withdrawn.
pool_token_balance
Proto3 optional
Total number of pool tokens issued by the pool.
rewards_pool
Proto3 optional
The epoch stake rewards will be added here at the end of each epoch.
sui_balance
Proto3 optional
The total number of SUI tokens in this pool, including the SUI in the rewards_pool, as well as in all the principal in the StakedSui object, updated at epoch boundaries.

StorageFund​

Struct representing the onchain storage fund.

Fields
non_refundable_balance
Proto3 optional
Represents any remaining inflow of the storage fund that should not be taken out of the fund.
total_object_storage_rebates
Proto3 optional
This is the sum of storage_rebate of all objects currently stored on-chain. To maintain this invariant, the only inflow of this balance is storage charges collected from transactions, and the only outflow is storage rebates of transactions, including both the portion refunded to the transaction senders as well as the non-refundable portion taken out and put into non_refundable_balance.

SystemParameters​

Fields
epoch_duration_ms
Proto3 optional
The duration of an epoch, in milliseconds.
extra_fields
Proto3 optional
Any extra fields that are not defined statically.
max_validator_count
Proto3 optional
Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.
min_validator_count
Proto3 optional
Minimum number of active validators at any moment.
min_validator_joining_stake
Proto3 optional
Deprecated. Lower-bound on the amount of stake required to become a validator.
stake_subsidy_start_epoch
Proto3 optional
The starting epoch in which stake subsidies start being paid out
validator_low_stake_grace_period
Proto3 optional
A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.
validator_low_stake_threshold
Proto3 optional
Deprecated. Validators with stake amount below validator_low_stake_threshold are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than validator_low_stake_grace_period number of epochs.
validator_very_low_stake_threshold
Proto3 optional
Deprecated. Validators with stake below validator_very_low_stake_threshold will be removed immediately at epoch change, no grace period.

SystemState​

Fields
epoch
Proto3 optional
The epoch id
epoch_start_timestamp_ms
Proto3 optional
Unix timestamp of when this this epoch started
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
parameters
Proto3 optional
Set of system config parameters
protocol_version
Proto3 optional
The protocol version
reference_gas_price
Proto3 optional
The reference gas price for this epoch
safe_mode
Proto3 optional
Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch. The rest of the fields starting with safe_mode_ are accumulated during safe mode when advance_epoch_safe_mode is executed. They will eventually be processed once we are out of safe mode.
safe_mode_computation_rewards
Proto3 optional
Computation rewards accumulated during safe_mode
safe_mode_non_refundable_storage_fee
Proto3 optional
Nonrefundable storage fees accumulated during safe_mode
safe_mode_storage_rebates
Proto3 optional
Storage rebates paid out during safe_mode
safe_mode_storage_rewards
Proto3 optional
Storage rewards accumulated during safe_mode
stake_subsidy
Proto3 optional
Schedule of stake subsidies given out each epoch.
storage_fund
Proto3 optional
Storage Fund info
validator_report_records
Repeated []
A list of the records of validator reporting each other. There is an entry in this list for each validator that has been reported at least once. Each record contains all the validators that reported them. If a validator has never been reported they don't have a record in this list. This lists persists across epoch: a peer continues being in a reported state until the reporter doesn't explicitly remove their report.
validators
Proto3 optional
Information about the validators
version
Proto3 optional
The version of the system state data structure type.

Validator​

Definition of a Validator in the system contracts

Note: fields of ValidatorMetadata are flattened into this type

Fields
address
Proto3 optional
The Sui Address of the validator. This is the sender that created the Validator object, and also the address to send validator/coins to during withdraws.
commission_rate
Proto3 optional
Commission rate of the validator, in basis point.
description
Proto3 optional
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
gas_price
Proto3 optional
Gas price quote, updated only at end of epoch.
image_url
Proto3 optional
metadata_extra_fields
Proto3 optional
Any extra fields that's not defined statically in the ValidatorMetadata struct
name
Proto3 optional
A unique human-readable name of this validator.
network_address
Proto3 optional
The network address of the validator (could also contain extra info such as port, DNS and etc.).
network_public_key
Proto3 optional
The public key bytes corresponding to the private key that the validator uses to establish TLS connections
next_epoch_commission_rate
Proto3 optional
The commission rate of the validator starting the next epoch, in basis point.
next_epoch_gas_price
Proto3 optional
This validator's gas price quote for the next epoch.
next_epoch_network_address
Proto3 optional
next_epoch_network_public_key
Proto3 optional
next_epoch_p2p_address
Proto3 optional
next_epoch_primary_address
Proto3 optional
next_epoch_proof_of_possession
Proto3 optional
next_epoch_protocol_public_key
Proto3 optional
next_epoch_stake
Proto3 optional
Total amount of stake that would be active in the next epoch.
next_epoch_worker_address
Proto3 optional
next_epoch_worker_public_key
Proto3 optional
operation_cap_id
Proto3 optional
The ID of this validator's current valid UnverifiedValidatorOperationCap
p2p_address
Proto3 optional
The address of the validator used for p2p activities such as state sync (could also contain extra info such as port, DNS and etc.).
primary_address
Proto3 optional
The address of the narwhal primary
project_url
Proto3 optional
proof_of_possession
Proto3 optional
This is a proof that the validator has ownership of the protocol private key
protocol_public_key
Proto3 optional
The public key bytes corresponding to the private key that the validator holds to sign transactions. For now, this is the same as AuthorityName.
staking_pool
Proto3 optional
Staking pool for this validator.
voting_power
Proto3 optional
The voting power of this validator, which might be different from its stake amount.
worker_address
Proto3 optional
The address of the narwhal worker
worker_public_key
Proto3 optional
The public key bytes corresponding to the Narwhal Worker

ValidatorReportRecord​

Fields
reported
Proto3 optional
The address of the validator being reported
reporters
Repeated []
The list of validator (addresses) that are reporting on the validator specified by reported

ValidatorSet​

Fields
active_validators
Repeated []
The current list of active validators.
at_risk_validators
Repeated []
Table storing the number of epochs during which a validator's stake has been below the low stake threshold.
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
inactive_validators
Proto3 optional
Mapping from a staking pool ID to the inactive validator that has that pool as its staking pool. When a validator is deactivated the validator is removed from active_validators it is added to this table so that stakers can continue to withdraw their stake from it. key: address (staking pool Id), value: 0x3::validator_wrapper::ValidatorWrapper
pending_active_validators
Proto3 optional
List of new validator candidates added during the current epoch. They will be processed at the end of the epoch. key: u64 (index), value: 0x3::validator::Validator
pending_removals
Repeated []
Removal requests from the validators. Each element is an index pointing to active_validators.
staking_pool_mappings
Proto3 optional
Mappings from staking pool's ID to the sui address of a validator. key: address (staking pool Id), value: address (sui address of the validator)
total_stake
Proto3 optional
Total amount of stake from all active validators at the beginning of the epoch. Written only once per epoch, in advance_epoch function.
validator_candidates
Proto3 optional
Table storing preactive/candidate validators, mapping their addresses to their Validator structs. When an address calls request_add_validator_candidate, they get added to this table and become a preactive validator. When the candidate has met the min stake requirement, they can call request_add_validator to officially add them to the active validator set active_validators next epoch. key: address (sui address of the validator), value: 0x3::validator_wrapper::ValidatorWrapper

AtRiskValidatorsEntry​

Fields
key
value

sui/rpc/v2/execution_status.proto​

Messages

CleverError​

Fields
constant_name
Proto3 optional
constant_type
Proto3 optional
error_code
Proto3 optional
line_number
Proto3 optional
Union field value can be only one of the following.
raw
rendered

CoinDenyListError​

Fields
address
Proto3 optional
Denied address.
coin_type
Proto3 optional
Coin type.

CommandArgumentError​

An error with an argument to a command.

Fields
argument
Proto3 optional
Position of the problematic argument.
index_error
Proto3 optional
kind
Proto3 optional

CongestedObjects​

Set of objects that were congested, leading to the transaction's cancellation.

Fields
objects
Repeated []

ExecutionError​

An error that can occur during the execution of a transaction.

Fields
command
Proto3 optional
The command, if any, during which the error occurred.
description
Proto3 optional
A human readable description of the error
kind
Proto3 optional
Union field error_details can be only one of the following.
abort
coin_deny_list_error
command_argument_error
congested_objects
Set of objects that were congested, leading to the transaction's cancellation.
index_error
object_id
package_upgrade_error
size_error
type_argument_error

ExecutionStatus​

The status of an executed transaction.

Fields
error
Proto3 optional
The error if success is false.
success
Proto3 optional
Indicates if the transaction was successful or not.

IndexError​

Fields
index
Proto3 optional
Index of an input or result.
subresult
Proto3 optional
Index of a subresult.

MoveAbort​

Fields
abort_code
Proto3 optional
clever_error
Proto3 optional
Extra error information if abort code is a "Clever Error"
location
Proto3 optional
Location in Move where the error occurred.

MoveLocation​

Location in Move bytecode where an error occurred.

Fields
function
Proto3 optional
The function index.
function_name
Proto3 optional
The name of the function, if available.
instruction
Proto3 optional
Offset of the instruction where the error occurred.
module
Proto3 optional
The module name.
package
Proto3 optional
The package ID.

PackageUpgradeError​

An error with upgrading a package.

Fields
digest
Proto3 optional
A digest.
kind
Proto3 optional
package_id
Proto3 optional
The Package Id.
policy
Proto3 optional
The policy.
ticket_id
Proto3 optional
The ticket Id.

SizeError​

A size error.

Fields
max_size
Proto3 optional
The maximum allowable size.
size
Proto3 optional
The offending size.

TypeArgumentError​

Type argument error.

Fields
kind
Proto3 optional
type_argument
Proto3 optional
Index of the problematic type argument.

Enums

CommandArgumentErrorKind

Enums
COMMAND_ARGUMENT_ERROR_KIND_UNKNOWN
TYPE_MISMATCH
The type of the value does not match the expected type.
INVALID_BCS_BYTES
The argument cannot be deserialized into a value of the specified type.
INVALID_USAGE_OF_PURE_ARGUMENT
The argument cannot be instantiated from raw bytes.
INVALID_ARGUMENT_TO_PRIVATE_ENTRY_FUNCTION
Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.
INDEX_OUT_OF_BOUNDS
Out of bounds access to input or results. index field will be set indicating the invalid index value.
SECONDARY_INDEX_OUT_OF_BOUNDS
Out of bounds access to subresult. index and subresult fields will be set indicating the invalid index value.
INVALID_RESULT_ARITY
Invalid usage of result. Expected a single result but found either no return value or multiple. index field will be set indicating the invalid index value.
INVALID_GAS_COIN_USAGE
Invalid usage of gas coin. The gas coin can only be used by-value with a TransferObject command.
INVALID_VALUE_USAGE
Invalid usage of Move value. - Mutably borrowed values require unique usage. - Immutably borrowed values cannot be taken or borrowed mutably. - Taken values cannot be used again.
INVALID_OBJECT_BY_VALUE
Immutable objects cannot be passed by-value.
INVALID_OBJECT_BY_MUT_REF
Immutable objects cannot be passed by mutable reference, &mut.
CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED
Consensus object operations such as wrapping, freezing, or converting to owned are not allowed.
INVALID_ARGUMENT_ARITY
Invalid argument arity. Expected a single argument but found a result that expanded to multiple arguments.

ExecutionErrorKind

Enums
EXECUTION_ERROR_KIND_UNKNOWN
INSUFFICIENT_GAS
Insufficient gas.
INVALID_GAS_OBJECT
Invalid Gas object.
INVARIANT_VIOLATION
Invariant violation.
FEATURE_NOT_YET_SUPPORTED
Attempted to use feature that is not supported yet.
OBJECT_TOO_BIG
Move object is larger than the maximum allowed size.
PACKAGE_TOO_BIG
Package is larger than the maximum allowed size.
CIRCULAR_OBJECT_OWNERSHIP
Circular object ownership.
INSUFFICIENT_COIN_BALANCE
Insufficient coin balance for requested operation.
COIN_BALANCE_OVERFLOW
Coin balance overflowed an u64.
PUBLISH_ERROR_NON_ZERO_ADDRESS
Publish error, non-zero address. The modules in the package must have their self-addresses set to zero.
SUI_MOVE_VERIFICATION_ERROR
Sui Move bytecode verification error.
MOVE_PRIMITIVE_RUNTIME_ERROR
Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, or similar.
MOVE_ABORT
Move runtime abort.
VM_VERIFICATION_OR_DESERIALIZATION_ERROR
Bytecode verification error.
VM_INVARIANT_VIOLATION
MoveVm invariant violation.
FUNCTION_NOT_FOUND
Function not found.
ARITY_MISMATCH
Parity mismatch for Move function. The number of arguments does not match the number of parameters.
TYPE_ARITY_MISMATCH
Type parity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.
NON_ENTRY_FUNCTION_INVOKED
Non-entry function invoked. Move Call must start with an entry function.
COMMAND_ARGUMENT_ERROR
Invalid command argument.
TYPE_ARGUMENT_ERROR
Type argument error.
UNUSED_VALUE_WITHOUT_DROP
Unused result without the drop ability.
INVALID_PUBLIC_FUNCTION_RETURN_TYPE
Invalid public Move function signature. Unsupported return type for return value.
INVALID_TRANSFER_OBJECT
Invalid transfer object, object does not have public transfer.
EFFECTS_TOO_LARGE
Effects from the transaction are too large.
PUBLISH_UPGRADE_MISSING_DEPENDENCY
Publish or Upgrade is missing dependency.
PUBLISH_UPGRADE_DEPENDENCY_DOWNGRADE
Publish or upgrade dependency downgrade. Indirect (transitive) dependency of published or upgraded package has been assigned an on-chain version that is less than the version required by one of the package's transitive dependencies.
PACKAGE_UPGRADE_ERROR
Invalid package upgrade.
WRITTEN_OBJECTS_TOO_LARGE
Indicates the transaction tried to write objects too large to storage.
CERTIFICATE_DENIED
Certificate is on the deny list.
SUI_MOVE_VERIFICATION_TIMEDOUT
Sui Move bytecode verification timed out.
CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED
The requested consensus object operation is not allowed.
INPUT_OBJECT_DELETED
Requested consensus object has been deleted.
EXECUTION_CANCELED_DUE_TO_CONSENSUS_OBJECT_CONGESTION
Certificate is canceled due to congestion on consensus objects.
ADDRESS_DENIED_FOR_COIN
Address is denied for this coin type.
COIN_TYPE_GLOBAL_PAUSE
Coin type is globally paused for use.
EXECUTION_CANCELED_DUE_TO_RANDOMNESS_UNAVAILABLE
Certificate is canceled because randomness could not be generated this epoch.
MOVE_VECTOR_ELEM_TOO_BIG
MOVE_RAW_VALUE_TOO_BIG
INVALID_LINKAGE

PackageUpgradeErrorKind

Enums
PACKAGE_UPGRADE_ERROR_KIND_UNKNOWN
UNABLE_TO_FETCH_PACKAGE
Unable to fetch package.
NOT_A_PACKAGE
Object is not a package.
INCOMPATIBLE_UPGRADE
Package upgrade is incompatible with previous version.
DIGEST_DOES_NOT_MATCH
Digest in upgrade ticket and computed digest differ.
UNKNOWN_UPGRADE_POLICY
Upgrade policy is not valid.
PACKAGE_ID_DOES_NOT_MATCH
Package ID does not match PackageId in upgrade ticket.

TypeArgumentErrorKind

Enums
TYPE_ARGUMENT_ERROR_KIND_UNKNOWN
TYPE_NOT_FOUND
A type was not found in the module specified.
CONSTRAINT_NOT_SATISFIED
A type provided did not match the specified constraint.

sui/rpc/v2/object_reference.proto​

Messages

ObjectReference​

Reference to an object.

Fields
digest
Proto3 optional
The digest of this object.
object_id
Proto3 optional
The object id of this object.
version
Proto3 optional
The version of this object.

sui/rpc/v2/input.proto​

Messages

Input​

An input to a user transaction.

Fields
digest
Proto3 optional
The digest of this object.
kind
Proto3 optional
literal
Proto3 optional
A literal value INPUT ONLY
mutable
Proto3 optional
Controls whether the caller asks for a mutable reference to the shared object.
object_id
Proto3 optional
ObjectId of the object input.
pure
Proto3 optional
A move value serialized as BCS. For normal operations this is required to be a move primitive type and not contain structs or objects.
version
Proto3 optional
Requested version of the input object when kind is IMMUTABLE_OR_OWNED or RECEIVING or if kind is SHARED this is the initial version of the object when it was shared

Enums

InputKind

Enums
INPUT_KIND_UNKNOWN
PURE
A move value serialized as BCS.
IMMUTABLE_OR_OWNED
A Move object that is either immutable or address owned.
SHARED
A Move object whose owner is "Shared".
RECEIVING
A Move object that is attempted to be received in this transaction.

sui/rpc/v2/move_package.proto​

Messages

DatatypeDescriptor​

Describes a Move Datatype.

Fields
abilities
Repeated []
This type's abilities
defining_id
Proto3 optional
PackageId of the package where this Datatype is defined. A type's defining_id is the storage_id of the package version that first introduced or added that type.
fields
Repeated []
Set of fields if this Datatype is a struct. The order of the entries is the order of how the fields are defined.
kind
Proto3 optional
Indicates whether this datatype is a 'STRUCT' or an 'ENUM'
module
Proto3 optional
Name of the module where this Datatype is defined
name
Proto3 optional
Name of this Datatype
type_name
Proto3 optional
Fully qualified name of this Datatype. This is <defining_id>::<module>::<name>
type_parameters
Repeated []
Ability constraints and phantom status for this type's generic type parameters
variants
Repeated []
Set of variants if this Datatype is an enum. The order of the entries is the order of how the variants are defined.

FieldDescriptor​

Descriptor of a field that belongs to a struct or enum variant

Fields
name
Proto3 optional
Name of the field
position
Proto3 optional
Order or position of the field in the struct or enum variant definition.
type
Proto3 optional
The type of the field

FunctionDescriptor​

Descriptor of a Move function

Fields
is_entry
Proto3 optional
Whether the function is marked entry or not.
name
Proto3 optional
Name of the function
parameters
Repeated []
Formal parameter types.
returns
Repeated []
Return types.
type_parameters
Repeated []
Ability constraints for type parameters
visibility
Proto3 optional
Whether the function is public, private or public(friend)

Linkage​

Upgraded package info for the linkage table.

Fields
original_id
Proto3 optional
Id of the original package.
upgraded_id
Proto3 optional
Id of the upgraded package.
upgraded_version
Proto3 optional
Version of the upgraded package.

Module​

A Move Module.

Fields
contents
Proto3 optional
Serialized bytecode of the module.
datatypes
Repeated []
List of DataTypes defined by this module.
functions
Repeated []
List of Functions defined by this module.
name
Proto3 optional
Name of this module.

OpenSignature​

Representation of a type signature that could appear as a function parameter or return value.

Fields
body
Proto3 optional
reference
Proto3 optional

OpenSignatureBody​

Representation of a type signature that could appear as a field type for a struct or enum

Fields
type
Proto3 optional
Type of this signature
type_name
Proto3 optional
Fully qualified name of the datatype when type is DATATYPE
type_parameter
Proto3 optional
Position of the type parameter as defined in the containing data type descriptor when type is TYPE_PARAMETER
type_parameter_instantiation
Repeated []
Set when type is VECTOR or DATATYPE

Package​

A Move Package

Fields
linkage
Repeated []
The package's transitive dependencies as a mapping from the package's runtime Id (the Id it is referred to by in other packages) to its storage Id (the Id it is loaded from on chain).
modules
Repeated []
The modules defined by this package
original_id
Proto3 optional
The PackageId of the first published version of this package. A package's original_id (sometimes also called its runtime_id) is the storage_id of the first version of this package that has been published. The original_id/runtime_id is stable across all versions of the package and does not ever change.
storage_id
Proto3 optional
The PackageId of this package A package's storage_id is the Sui ObjectId of the package on-chain. Outside of system packages the storage_id for every package version is different.
type_origins
Repeated []
List of datatype origins for mapping datatypes to a package version where it was first defined
version
Proto3 optional
The version of this package

TypeOrigin​

Identifies a struct and the module it was defined in.

Fields
datatype_name
Proto3 optional
module_name
Proto3 optional
package_id
Proto3 optional

TypeParameter​

A generic type parameter used in the declaration of a struct or enum.

Fields
constraints
Repeated []
The type parameter constraints
is_phantom
Proto3 optional
Whether the parameter is declared as phantom

VariantDescriptor​

Descriptor of an enum variant

Fields
fields
Repeated []
Set of fields defined by this variant.
name
Proto3 optional
Name of the variant
position
Proto3 optional
Order or position of the variant in the enum definition.

Enums

Ability

An Ability classifies what operations are permitted for a given type
Enums
ABILITY_UNKNOWN
COPY
Allows values of types with this ability to be copied
DROP
Allows values of types with this ability to be dropped.
STORE
Allows values of types with this ability to exist inside a struct in global storage
KEY
Allows the type to serve as a key for global storage operations

DatatypeKind

Enums
DATATYPE_KIND_UNKNOWN
STRUCT
ENUM

Visibility

Enums
VISIBILITY_UNKNOWN
PRIVATE
PUBLIC
FRIEND

Reference

Enums
REFERENCE_UNKNOWN
IMMUTABLE
MUTABLE

Type

Enums
TYPE_UNKNOWN
ADDRESS
BOOL
U8
U16
U32
U64
U128
U256
VECTOR
DATATYPE
TYPE_PARAMETER

sui/rpc/v2/epoch.proto​

Messages

Epoch​

Fields
committee
Proto3 optional
The committee governing this epoch.
end
Proto3 optional
epoch
Proto3 optional
first_checkpoint
Proto3 optional
last_checkpoint
Proto3 optional
protocol_config
Proto3 optional
reference_gas_price
Proto3 optional
Reference gas price denominated in MIST
start
Proto3 optional
system_state
Proto3 optional
Snapshot of Sui's SystemState (0x3::sui_system::SystemState) at the beginning of the epoch, for past epochs, or the current state for the current epoch.

sui/rpc/v2/subscription_service.proto​

Messages

SubscribeCheckpointsRequest​

Request message for SubscriptionService.SubscribeCheckpoints

Fields
read_mask
Proto3 optional
Optional. Mask for specifying which parts of the SubscribeCheckpointsResponse should be returned.

SubscribeCheckpointsResponse​

Response message for SubscriptionService.SubscribeCheckpoints

Fields
checkpoint
Proto3 optional
The requested data for this checkpoint
cursor
Proto3 optional
Required. The checkpoint sequence number and value of the current cursor into the checkpoint stream

Services (subscription_service.proto)​

SubscriptionService

Methods
SubscribeCheckpointsRequest -> SubscribeCheckpointsResponse
Subscribe to the stream of checkpoints. This API provides a subscription to the checkpoint stream for the Sui blockchain. When a subscription is initialized the stream will begin with the latest executed checkpoint as seen by the server. Responses are guaranteed to return checkpoints in-order and without gaps. This enables clients to know exactly the last checkpoint they have processed and in the event the subscription terminates (either by the client/server or by the connection breaking), clients will be able to reinitialize a subscription and then leverage other APIs in order to request data for the checkpoints they missed.

sui/rpc/v2/bcs.proto​

Messages

Bcs​

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.

Fields
name
Proto3 optional
Name that identifies the type of the serialized value.
value
Proto3 optional
Bytes of a BCS serialized value.

sui/rpc/v2/state_service.proto​

Messages

Balance​

Balance information for a specific coin type.

Fields
balance
Proto3 optional
Shows the total balance of the coin in its smallest unit.
coin_type
Proto3 optional
The type of the coin (e.g., 0x2::sui::SUI).

CoinMetadata​

Metadata for a coin type

Fields
decimals
Proto3 optional
Number of decimal places to coin uses.
description
Proto3 optional
Description of the token
icon_url
Proto3 optional
URL for the token logo
id
Proto3 optional
ObjectId of the 0x2::coin::CoinMetadata object or 0x2::sui::coin_registry::Currency object (when registered with CoinRegistry).
metadata_cap_id
Proto3 optional
The MetadataCap ID if it has been claimed for this coin type. This capability allows updating the coin's metadata fields. Only populated when metadata is from CoinRegistry.
metadata_cap_state
Proto3 optional
State of the MetadataCap for this coin type.
name
Proto3 optional
Name for the token
symbol
Proto3 optional
Symbol for the token

CoinTreasury​

Information about a coin type's 0x2::coin::TreasuryCap and its total available supply

Fields
id
Proto3 optional
ObjectId of the 0x2::coin::TreasuryCap object.
supply_state
Proto3 optional
Supply state indicating if the supply is fixed or can still be minted
total_supply
Proto3 optional
Total available supply for this coin type.

DynamicField​

Fields
child_id
Proto3 optional
The ObjectId of the child object when a child is a dynamic object field. The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object
child_object
Proto3 optional
The object itself when a child is a dynamic object field.
field_id
Proto3 optional
ObjectId of this dynamic field.
field_object
Proto3 optional
The field object itself
kind
Proto3 optional
name
Proto3 optional
The dynamic field's "name"
parent
Proto3 optional
ObjectId of this dynamic field's parent.
value
Proto3 optional
The dynamic field's "value"
value_type
Proto3 optional
The type of the dynamic field "value". If this is a dynamic object field then this is the type of the object itself (which is a child of this field), otherwise this is the type of the value of this field.

GetBalanceRequest​

Request message for LiveDataService.GetBalance.

Fields
coin_type
Proto3 optional
Required. The type names for the coin (e.g., 0x2::sui::SUI).
owner
Proto3 optional
Required. The owner's Sui address.

GetBalanceResponse​

Response message for LiveDataService.GetBalance. Return the total coin balance for one coin type, owned by the address owner.

Fields
balance
Proto3 optional
The balance information for the requested coin type.

GetCoinInfoRequest​

Request message for NodeService.GetCoinInfo.

Fields
coin_type
Proto3 optional
The coin type to request information about

GetCoinInfoResponse​

Response message for NodeService.GetCoinInfo.

Fields
coin_type
Proto3 optional
Required. The coin type.
metadata
Proto3 optional
This field will be populated with information about this coin type's 0x2::coin::CoinMetadata if it exists and has not been wrapped.
regulated_metadata
Proto3 optional
If this coin type is a regulated coin, this field will be populated with information either from its Currency object in the CoinRegistry, or from its 0x2::coin::RegulatedCoinMetadata object for coins that have not been migrated to the CoinRegistry If this coin is not known to be regulated, only the coin_regulated_state field will be populated.
treasury
Proto3 optional
This field will be populated with information about this coin type's 0x2::coin::TreasuryCap if it exists and has not been wrapped.

ListBalancesRequest​

Request message for LiveDataService.ListBalances.

Fields
owner
Proto3 optional
Required. The owner's Sui address.
page_size
Proto3 optional
The maximum number of balance entries to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListBalances call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBalances must match the call that provided the page token.

ListBalancesResponse​

Response message for LiveDataService.ListBalances. Return the total coin balance for all coin types, owned by the address owner.

Fields
balances
Repeated []
The list of coin types and their respective balances.
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDynamicFieldsRequest​

Request message for NodeService.ListDynamicFields

Fields
page_size
Proto3 optional
The maximum number of dynamic fields to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListDynamicFields call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDynamicFields must match the call that provided the page token.
parent
Proto3 optional
Required. The UID of the parent, which owns the collections of dynamic fields.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to parent,field_id.

ListDynamicFieldsResponse​

Response message for NodeService.ListDynamicFields

Fields
dynamic_fields
Repeated []
Page of dynamic fields owned by the specified parent.
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListOwnedObjectsRequest​

Fields
object_type
Proto3 optional
Optional type filter to limit the types of objects listed. Providing an object type with no type params will return objects of that type with any type parameter, e.g. 0x2::coin::Coin will return all Coin<T> objects regardless of the type parameter T. Providing a type with a type param will restrict the returned objects to only those objects that match the provided type parameters, e.g. 0x2::coin::Coin<0x2::sui::SUI> will only return Coin<SUI> objects.
owner
Proto3 optional
Required. The address of the account that owns the objects.
page_size
Proto3 optional
The maximum number of entries return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListOwnedObjects call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOwnedObjects must match the call that provided the page token.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,object_type.

ListOwnedObjectsResponse​

Fields
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
objects
Repeated []
Page of dynamic fields owned by the specified parent.

RegulatedCoinMetadata​

Information about a regulated coin, which indicates that it makes use of the transfer deny list.

Fields
allow_global_pause
Proto3 optional
Whether the coin can be globally paused
coin_metadata_object
Proto3 optional
The ID of the coin's CoinMetadata or CoinData object.
coin_regulated_state
Proto3 optional
Indicates the coin's regulated state.
deny_cap_object
Proto3 optional
The ID of the coin's DenyCap object.
id
Proto3 optional
ObjectId of the 0x2::coin::RegulatedCoinMetadata object. Only present for coins that have not been migrated to CoinRegistry.
variant
Proto3 optional
Variant of the regulated coin metadata

Services (state_service.proto)​

StateService

Methods
ListDynamicFieldsRequest -> ListDynamicFieldsResponse
ListOwnedObjectsRequest -> ListOwnedObjectsResponse
GetCoinInfoRequest -> GetCoinInfoResponse
GetBalanceRequest -> GetBalanceResponse
ListBalancesRequest -> ListBalancesResponse

Enums

MetadataCapState

Information about the state of the coin's MetadataCap
Enums
METADATA_CAP_STATE_UNKNOWN
Indicates the state of the MetadataCap is unknown. Set when the coin has not been migrated to the CoinRegistry.
CLAIMED
Indicates the MetadataCap has been claimed.
UNCLAIMED
Indicates the MetadataCap has not been claimed.
DELETED
Indicates the MetadataCap has been deleted.

SupplyState

Supply state of a coin, matching the Move SupplyState enum
Enums
SUPPLY_STATE_UNKNOWN
Supply is unknown or TreasuryCap still exists (minting still possible)
FIXED
Supply is fixed (TreasuryCap consumed, no more minting possible)
BURN_ONLY
Supply can only decrease (burning allowed, minting not allowed)

DynamicFieldKind

Enums
DYNAMIC_FIELD_KIND_UNKNOWN
FIELD
OBJECT

CoinRegulatedState

Indicates the state of the regulation of the coin.
Enums
COIN_REGULATED_STATE_UNKNOWN
Indicates the regulation state of the coin is unknown. This is set when a coin has not been migrated to the coin registry and has no 0x2::coin::RegulatedCoinMetadata object.
REGULATED
Indicates a coin is regulated. RegulatedCoinMetadata will be populated.
UNREGULATED
Indicates a coin is unregulated.

sui/rpc/v2/signature_scheme.proto​

Enums

SignatureScheme

Flag use to disambiguate the signature schemes supported by Sui. Note: the enum values defined by this proto message exactly match their expected BCS serialized values when serialized as a u8. See enum.SignatureScheme for more information about signature schemes.
Enums
ED25519
SECP256K1
SECP256R1
MULTISIG
BLS12381
ZKLOGIN
PASSKEY

sui/rpc/v2/checkpoint.proto​

Messages

Checkpoint​

Fields
contents
Proto3 optional
The CheckpointContents for this checkpoint.
digest
Proto3 optional
The digest of this Checkpoint's CheckpointSummary.
objects
Proto3 optional
Set of objects either referenced as inputs or produced as outputs by transactions included in this checkpoint. In order to benefit from deduplication of objects that appear in multiple transactions in this checkpoint, objects will only be present here and the transactions.objects field will not be populated.
sequence_number
Proto3 optional
The height of this checkpoint.
signature
Proto3 optional
An aggregated quorum signature from the validator committee that certified this checkpoint.
summary
Proto3 optional
The CheckpointSummary for this checkpoint.
transactions
Repeated []
List of transactions included in this checkpoint.

sui/rpc/v2/transaction.proto​

Messages

ActiveJwk​

A new JWK.

Fields
epoch
Proto3 optional
Most recent epoch in which the JWK was validated.
id
Proto3 optional
Identifier used to uniquely identify a JWK.
jwk
Proto3 optional
The JWK.

AuthenticatorStateExpire​

Expire old JWKs.

Fields
authenticator_object_initial_shared_version
Proto3 optional
The initial version of the authenticator object that it was shared at.
min_epoch
Proto3 optional
Expire JWKs that have a lower epoch than this.

AuthenticatorStateUpdate​

Update the set of valid JWKs.

Fields
authenticator_object_initial_shared_version
Proto3 optional
The initial version of the authenticator object that it was shared at.
epoch
Proto3 optional
Epoch of the authenticator state update transaction.
new_active_jwks
Repeated []
Newly active JWKs.
round
Proto3 optional
Consensus round of the authenticator state update.

CanceledTransaction​

A transaction that was canceled.

Fields
digest
Proto3 optional
Digest of the canceled transaction.
version_assignments
Repeated []
List of object version assignments.

ChangeEpoch​

System transaction used to change the epoch.

Fields
computation_charge
Proto3 optional
The total amount of gas charged for computation during the epoch.
epoch
Proto3 optional
The next (to become) epoch ID.
epoch_start_timestamp
Proto3 optional
Unix timestamp when epoch started.
non_refundable_storage_fee
Proto3 optional
The non-refundable storage fee.
protocol_version
Proto3 optional
The protocol version in effect in the new epoch.
storage_charge
Proto3 optional
The total amount of gas charged for storage during the epoch.
storage_rebate
Proto3 optional
The amount of storage rebate refunded to the txn senders.
system_packages
Repeated []
System packages (specifically framework and Move stdlib) that are written before the new epoch starts. This tracks framework upgrades on chain. When executing the ChangeEpoch txn, the validator must write out the following modules. Modules are provided with the version they will be upgraded to, their modules in serialized form (which include their package ID), and a list of their transitive dependencies.

Command​

A single command in a programmable transaction.

Fields
Union field command can be only one of the following.
make_move_vector
forall T: Vec<T> -> vector<T> Given n-values of the same type, it constructs a vector. For non-objects or an empty vector, the type tag must be specified.
merge_coins
(&mut Coin<T>, Vec<Coin<T>>) It merges n-coins into the first coin.
move_call
A call to either an entry or a public Move function.
publish
Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on chain.
split_coins
(&mut Coin<T>, Vec<u64>) -> Vec<Coin<T>> It splits off some amounts into new coins with those amounts.
transfer_objects
(Vec<forall T:key+store. T>, address) It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.
upgrade
Upgrades a Move package. Takes (in order): 1. A vector of serialized modules for the package. 2. A vector of object ids for the transitive dependencies of the new package. 3. The object ID of the package being upgraded. 4. An argument holding the UpgradeTicket that must have been produced from an earlier command in the same programmable transaction.

ConsensusCommitPrologue​

Consensus commit prologue system transaction.

This message can represent V1, V2, and V3 prologue types.

Fields
additional_state_digest
Proto3 optional
Digest of any additional state computed by the consensus handler. Used to detect forking bugs as early as possible. Present in V4.
commit_timestamp
Proto3 optional
Unix timestamp from consensus. Present in V1, V2, V3, V4.
consensus_commit_digest
Proto3 optional
Digest of consensus output. Present in V2, V3, V4.
consensus_determined_version_assignments
Proto3 optional
Stores consensus handler determined consensus object version assignments. Present in V3, V4.
epoch
Proto3 optional
Epoch of the commit prologue transaction. Present in V1, V2, V3, V4.
round
Proto3 optional
Consensus round of the commit. Present in V1, V2, V3, V4.
sub_dag_index
Proto3 optional
The sub DAG index of the consensus commit. This field is populated if there are multiple consensus commits per round. Present in V3, V4.

ConsensusDeterminedVersionAssignments​

Version assignments performed by consensus.

Fields
canceled_transactions
Repeated []
Canceled transaction version assignment.
version
Proto3 optional
Version of this message

EndOfEpochTransaction​

Set of operations run at the end of the epoch to close out the current epoch and start the next one.

Fields
transactions
Repeated []

EndOfEpochTransactionKind​

Operation run at the end of an epoch.

Fields
kind
Proto3 optional
Union field data can be only one of the following.
authenticator_state_expire
Expire JWKs used for zklogin.
bridge_chain_id
ChainId used when initializing the bridge
bridge_object_version
Start version of the Bridge object
change_epoch
End the epoch and start the next one.
execution_time_observations
Execution time observations from the committee to preserve cross epoch

ExecutionTimeObservation​

Fields
kind
Proto3 optional
move_entry_point
Proto3 optional
validator_observations
Repeated []

ExecutionTimeObservations​

Fields
observations
Repeated []
version
Proto3 optional
Version of this ExecutionTimeObservations

GasPayment​

Payment information for executing a transaction.

Fields
budget
Proto3 optional
Total budget willing to spend for the execution of a transaction.
objects
Repeated []
Set of gas objects to use for payment.
owner
Proto3 optional
Owner of the gas objects, either the transaction sender or a sponsor.
price
Proto3 optional
Gas unit price to use when charging for computation. Must be greater than or equal to the network's current RGP (reference gas price).

GenesisTransaction​

The genesis transaction.

Fields
objects
Repeated []
Set of genesis objects.

MakeMoveVector​

Command to build a Move vector out of a set of individual elements.

Fields
element_type
Proto3 optional
Type of the individual elements. This is required to be set when the type can't be inferred, for example when the set of provided arguments are all pure input values.
elements
Repeated []
The set individual elements to build the vector with.

MergeCoins​

Command to merge multiple coins of the same type into a single coin.

Fields
coin
Proto3 optional
Coin to merge coins into.
coins_to_merge
Repeated []
Set of coins to merge into coin. All listed coins must be of the same type and be the same type as coin

MoveCall​

Command to call a Move function.

Functions that can be called by a MoveCall command are those that have a function signature that is either entry or public (which don't have a reference return type).

Fields
arguments
Repeated []
The arguments to the function.
function
Proto3 optional
The function to be called.
module
Proto3 optional
The specific module in the package containing the function.
package
Proto3 optional
The package containing the module and function.
type_arguments
Repeated []
The type arguments to the function.

ProgrammableTransaction​

A user transaction.

Contains a series of native commands and Move calls where the results of one command can be used in future commands.

Fields
commands
Repeated []
The commands to be executed sequentially. A failure in any command results in the failure of the entire transaction.
inputs
Repeated []
Input objects or primitive values.

Publish​

Command to publish a new Move package.

Fields
dependencies
Repeated []
Set of packages that the to-be published package depends on.
modules
Repeated []
The serialized Move modules.

RandomnessStateUpdate​

Randomness update.

Fields
epoch
Proto3 optional
Epoch of the randomness state update transaction.
random_bytes
Proto3 optional
Updated random bytes.
randomness_object_initial_shared_version
Proto3 optional
The initial version of the randomness object that it was shared at.
randomness_round
Proto3 optional
Randomness round of the update.

SplitCoins​

Command to split a single coin object into multiple coins.

Fields
amounts
Repeated []
The amounts to split off.
coin
Proto3 optional
The coin to split.

SystemPackage​

System package.

Fields
dependencies
Repeated []
Package dependencies.
modules
Repeated []
Move modules.
version
Proto3 optional
Version of the package.

Transaction​

A transaction.

Fields
bcs
Proto3 optional
This Transaction serialized as BCS.
digest
Proto3 optional
The digest of this Transaction.
expiration
Proto3 optional
gas_payment
Proto3 optional
kind
Proto3 optional
sender
Proto3 optional
version
Proto3 optional
Version of this Transaction.

TransactionExpiration​

A TTL for a transaction.

Fields
epoch
Proto3 optional
kind
Proto3 optional

TransactionKind​

Transaction type.

Fields
kind
Proto3 optional
Union field data can be only one of the following.
authenticator_state_update
Update set of valid JWKs used for zklogin.
change_epoch
System transaction used to end an epoch. The ChangeEpoch variant is now deprecated (but the ChangeEpoch struct is still used by EndOfEpochTransaction).
consensus_commit_prologue
consensus commit update info
end_of_epoch
Set of operations to run at the end of the epoch to close out the current epoch and start the next one.
genesis
Transaction used to initialize the chain state. Only valid if in the genesis checkpoint (0) and if this is the very first transaction ever executed on the chain.
programmable_transaction
A transaction comprised of a list of native commands and Move calls.
randomness_state_update
Randomness update.

TransferObjects​

Command to transfer ownership of a set of objects to an address.

Fields
address
Proto3 optional
The address to transfer ownership to.
objects
Repeated []
Set of objects to transfer.

Upgrade​

Command to upgrade an already published package.

Fields
dependencies
Repeated []
Set of packages that the to-be published package depends on.
modules
Repeated []
The serialized Move modules.
package
Proto3 optional
Package ID of the package to upgrade.
ticket
Proto3 optional
Ticket authorizing the upgrade.

ValidatorExecutionTimeObservation​

Fields
duration
Proto3 optional
Duration of an execution observation
validator
Proto3 optional
Bls12381 public key of the validator

VersionAssignment​

Object version assignment from consensus.

Fields
object_id
Proto3 optional
ObjectId of the object.
start_version
Proto3 optional
start version of the consensus stream for this object
version
Proto3 optional
Assigned version.

Enums

Kind

Enums
KIND_UNKNOWN
CHANGE_EPOCH
End the epoch and start the next one.
AUTHENTICATOR_STATE_CREATE
Create and initialize the authenticator object used for zklogin.
AUTHENTICATOR_STATE_EXPIRE
Expire JWKs used for zklogin.
RANDOMNESS_STATE_CREATE
Create and initialize the randomness object.
DENY_LIST_STATE_CREATE
Create and initialize the deny list object.
BRIDGE_STATE_CREATE
Create and initialize the bridge object.
BRIDGE_COMMITTEE_INIT
Initialize the bridge committee.
STORE_EXECUTION_TIME_OBSERVATIONS
Execution time observations from the committee to preserve cross epoch
ACCUMULATOR_ROOT_CREATE
Create the accumulator root object.
COIN_REGISTRY_CREATE
Create and initialize the Coin Registry object.
DISPLAY_REGISTRY_CREATE
Create and initialize the Display Registry object.

ExecutionTimeObservationKind

Enums
EXECUTION_TIME_OBSERVATION_KIND_UNKNOWN
MOVE_ENTRY_POINT
TRANSFER_OBJECTS
SPLIT_COINS
MERGE_COINS
PUBLISH
MAKE_MOVE_VECTOR
UPGRADE

TransactionExpirationKind

Enums
TRANSACTION_EXPIRATION_KIND_UNKNOWN
NONE
The transaction has no expiration.
EPOCH
Validators won't sign and execute transaction unless the expiration epoch is greater than or equal to the current epoch.

Kind

Enums
KIND_UNKNOWN
PROGRAMMABLE_TRANSACTION
A user transaction comprised of a list of native commands and Move calls.
CHANGE_EPOCH
System transaction used to end an epoch. The ChangeEpoch variant is now deprecated (but the ChangeEpoch struct is still used by EndOfEpochTransaction).
GENESIS
Transaction used to initialize the chain state. Only valid if in the genesis checkpoint (0) and if this is the very first transaction ever executed on the chain.
CONSENSUS_COMMIT_PROLOGUE_V1
V1 consensus commit update.
AUTHENTICATOR_STATE_UPDATE
Update set of valid JWKs used for zklogin.
END_OF_EPOCH
Set of operations to run at the end of the epoch to close out the current epoch and start the next one.
RANDOMNESS_STATE_UPDATE
Randomness update.
CONSENSUS_COMMIT_PROLOGUE_V2
V2 consensus commit update.
CONSENSUS_COMMIT_PROLOGUE_V3
V3 consensus commit update.
CONSENSUS_COMMIT_PROLOGUE_V4
V4 consensus commit update.

sui/rpc/v2/balance_change.proto​

Messages

BalanceChange​

The delta, or change, in balance for an address for a particular Coin type.

Fields
address
Proto3 optional
The account address that is affected by this balance change event.
amount
Proto3 optional
The amount or change in balance.
coin_type
Proto3 optional
The Coin type of this balance change event.

sui/rpc/v2/checkpoint_contents.proto​

Messages

CheckpointContents​

The committed to contents of a checkpoint.

Fields
bcs
Proto3 optional
This CheckpointContents serialized as BCS.
digest
Proto3 optional
The digest of this CheckpointContents.
transactions
Repeated []
Set of transactions committed to in this checkpoint.
version
Proto3 optional
Version of this CheckpointContents

CheckpointedTransactionInfo​

Transaction information committed to in a checkpoint.

Fields
effects
Proto3 optional
Digest of the effects.
signatures
Repeated []
Set of user signatures that authorized the transaction.
transaction
Proto3 optional
Digest of the transaction.

sui/rpc/v2beta2/argument.proto​

Messages

Argument​

An argument to a programmable transaction command.

Fields
input
Proto3 optional
Index of an input when kind is INPUT.
kind
Proto3 optional
result
Proto3 optional
Index of a result when kind is RESULT.
subresult
Proto3 optional
Used to access a nested result when kind is RESULT.

Enums

ArgumentKind

Enums
ARGUMENT_KIND_UNKNOWN
GAS
The gas coin.
INPUT
One of the input objects or primitive values (from ProgrammableTransaction inputs).
RESULT
The result of another command (from ProgrammableTransaction commands).

sui/rpc/v2beta2/signature_verification_service.proto​

Messages

VerifySignatureRequest​

Fields
address
Proto3 optional
Optional. Address to validate against the provided signature. If provided, this address will be compared against the the address derived from the provide signature and a successful response will only be returned if they match.
jwks
Repeated []
The set of JWKs to use when verifying Zklogin signatures. If this is empty the current set of valid JWKs stored onchain will be used
message
Proto3 optional
The message to verify against. Today the only supported message types are PersonalMessage and TransactionData and the Bcs.name must be set to indicate which type of message is being verified.
signature
Proto3 optional
The siganture to verify.

VerifySignatureResponse​

Fields
is_valid
Proto3 optional
Indicates if the provided signature was valid given the requested parameters.
reason
Proto3 optional
If is_valid is false, this is the reason for why the signature verification failed.

Services (signature_verification_service.proto)​

SignatureVerificationService

Methods
VerifySignatureRequest -> VerifySignatureResponse
Perform signature verification of a UserSignature against the provided message.

sui/rpc/v2beta2/move_package_service.proto​

Messages

GetDatatypeRequest​

Fields
module_name
Proto3 optional
Required. The name of the requested module.
name
Proto3 optional
Required. The name of the requested datatype.
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetDatatypeResponse​

Fields
datatype
Proto3 optional
The datatype.

GetFunctionRequest​

Fields
module_name
Proto3 optional
Required. The name of the requested module.
name
Proto3 optional
Required. The name of the requested function.
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetFunctionResponse​

Fields
function
Proto3 optional
The function.

GetPackageRequest​

Fields
package_id
Proto3 optional
Required. The storage_id of the requested package.

GetPackageResponse​

Fields
package
Proto3 optional
The package.

ListPackageVersionsRequest​

Fields
package_id
Proto3 optional
Required. The storage_id of any version of the package.
page_size
Proto3 optional
The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 1000 entries will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
page_token
Proto3 optional
A page token, received from a previous ListPackageVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPackageVersions must match the call that provided the page token.

ListPackageVersionsResponse​

Fields
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
versions
Repeated []
List of all package versions, ordered by version.

PackageVersion​

A simplified representation of a package version

Fields
package_id
Proto3 optional
The storage ID of this package version
version
Proto3 optional
The version number

Services (move_package_service.proto)​

MovePackageService

Methods
GetPackageRequest -> GetPackageResponse
GetDatatypeRequest -> GetDatatypeResponse
GetFunctionRequest -> GetFunctionResponse
ListPackageVersionsRequest -> ListPackageVersionsResponse

sui/rpc/v2beta2/checkpoint_summary.proto​

Messages

CheckpointCommitment​

A commitment made by a checkpoint.

Fields
digest
Proto3 optional
kind
Proto3 optional

CheckpointSummary​

A header for a checkpoint on the Sui blockchain.

On the Sui network, checkpoints define the history of the blockchain. They are quite similar to the concept of blocks used by other blockchains like Bitcoin or Ethereum. The Sui blockchain, however, forms checkpoints after transaction execution has already happened to provide a certified history of the chain, instead of being formed before execution.

Checkpoints commit to a variety of state, including but not limited to:

  • The hash of the previous checkpoint.
  • The set of transaction digests, their corresponding effects digests, as well as the set of user signatures that authorized its execution.
  • The objects produced by a transaction.
  • The set of live objects that make up the current state of the chain.
  • On epoch transitions, the next validator committee.

CheckpointSummarys themselves don't directly include all of the previous information but they are the top-level type by which all the information is committed to transitively via cryptographic hashes included in the summary. CheckpointSummarys are signed and certified by a quorum of the validator committee in a given epoch to allow verification of the chain's state.

Fields
bcs
Proto3 optional
This CheckpointSummary serialized as BCS.
commitments
Repeated []
Commitments to checkpoint-specific state.
content_digest
Proto3 optional
The hash of the CheckpointContents for this checkpoint.
digest
Proto3 optional
The digest of this CheckpointSummary.
end_of_epoch_data
Proto3 optional
Extra data only present in the final checkpoint of an epoch.
epoch
Proto3 optional
Epoch that this checkpoint belongs to.
epoch_rolling_gas_cost_summary
Proto3 optional
The running total gas costs of all transactions included in the current epoch so far until this checkpoint.
previous_digest
Proto3 optional
The hash of the previous CheckpointSummary. This will be None only for the first, or genesis, checkpoint.
sequence_number
Proto3 optional
The height of this checkpoint.
timestamp
Proto3 optional
Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have the same timestamp if they originate from the same underlining consensus commit.
total_network_transactions
Proto3 optional
Total number of transactions committed since genesis, including those in this checkpoint.
version_specific_data
Proto3 optional
CheckpointSummary is not an evolvable structure - it must be readable by any version of the code. Therefore, to allow extensions to be added to CheckpointSummary, opaque data can be added to checkpoints, which can be deserialized based on the current protocol version.

EndOfEpochData​

Data, which when included in a CheckpointSummary, signals the end of an Epoch.

Fields
epoch_commitments
Repeated []
Commitments to epoch specific state (live object set)
next_epoch_committee
Repeated []
The set of validators that will be in the ValidatorCommittee for the next epoch.
next_epoch_protocol_version
Proto3 optional
The protocol version that is in effect during the next epoch.

Enums

CheckpointCommitmentKind

Enums
CHECKPOINT_COMMITMENT_KIND_UNKNOWN
ECMH_LIVE_OBJECT_SET
An elliptic curve multiset hash attesting to the set of objects that comprise the live state of the Sui blockchain.
CHECKPOINT_ARTIFACTS
Digest of the checkpoint artifacts.

sui/rpc/v2beta2/transaction_execution_service.proto​

Messages

ExecuteTransactionRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to finality.
signatures
Repeated []
Set of UserSigantures authorizing the execution of the provided transaction.
transaction
Proto3 optional
The transaction to execute.

ExecuteTransactionResponse​

Response message for NodeService.ExecuteTransaction.

Fields
finality
Proto3 optional
Indicates the finality of the executed transaction.
transaction
Proto3 optional

TransactionFinality​

Indicates the finality of the executed transaction.

Fields
Union field finality can be only one of the following.
certified
A quorum certificate certifying that a transaction is final but might not be included in a checkpoint yet.
checkpointed
Sequence number of the checkpoint that includes the transaction.
quorum_executed
Indicates that a quorum of validators has executed the transaction but that it might not be included in a checkpoint yet.

Services (transaction_execution_service.proto)​

TransactionExecutionService

Methods
ExecuteTransactionRequest -> ExecuteTransactionResponse
TODO move simulate transaction here for GA release rpc SimulateTransaction(SimulateTransactionRequest) returns (SimulateTransactionResponse);

sui/rpc/v2beta2/ledger_service.proto​

Messages

BatchGetObjectsRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,digest.
requests
Repeated []

BatchGetObjectsResponse​

Fields
objects
Repeated []

BatchGetTransactionsRequest​

Fields
digests
Repeated []
Required. The digests of the requested transactions.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to digest.

BatchGetTransactionsResponse​

Fields
transactions
Repeated []

GetCheckpointRequest​

Fields
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to sequence_number,digest.
Union field checkpoint_id can be only one of the following.
digest
The digest of the requested checkpoint.
sequence_number
The sequence number of the requested checkpoint.

GetCheckpointResponse​

Fields
checkpoint
Proto3 optional

GetEpochRequest​

Fields
epoch
Proto3 optional
The requested epoch. If no epoch is provided the current epoch will be returned.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to epoch.

GetEpochResponse​

Fields
epoch
Proto3 optional

GetObjectRequest​

Fields
object_id
Proto3 optional
Required. The ObjectId of the requested object.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,digest.
version
Proto3 optional
Request a specific version of the object. If no version is specified, and the object is live, then the latest version of the object is returned.

GetObjectResponse​

Fields
object
Proto3 optional

GetObjectResult​

Fields
Union field result can be only one of the following.
error
object

GetServiceInfoRequest​

GetServiceInfoResponse​

Fields
chain
Proto3 optional
Human-readable name of the chain that this node is on. This is intended to be a human-readable name like mainnet, testnet, and so on.
chain_id
Proto3 optional
The chain identifier of the chain that this node is on. The chain identifier is the digest of the genesis checkpoint, the checkpoint with sequence number 0.
checkpoint_height
Proto3 optional
Checkpoint height of the most recently executed checkpoint.
epoch
Proto3 optional
Current epoch of the node based on its highest executed checkpoint.
lowest_available_checkpoint
Proto3 optional
The lowest checkpoint for which checkpoints and transaction data are available.
lowest_available_checkpoint_objects
Proto3 optional
The lowest checkpoint for which object data is available.
server
Proto3 optional
Software version of the service. Similar to the server http header.
timestamp
Proto3 optional
Unix timestamp of the most recently executed checkpoint.

GetTransactionRequest​

Fields
digest
Proto3 optional
Required. The digest of the requested transaction.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to digest.

GetTransactionResponse​

Fields
transaction
Proto3 optional

GetTransactionResult​

Fields
Union field result can be only one of the following.
error
transaction

Services (ledger_service.proto)​

LedgerService

Methods
GetServiceInfoRequest -> GetServiceInfoResponse
Query the service for general information about its current state.
GetObjectRequest -> GetObjectResponse
BatchGetObjectsRequest -> BatchGetObjectsResponse
GetTransactionRequest -> GetTransactionResponse
BatchGetTransactionsRequest -> BatchGetTransactionsResponse
GetCheckpointRequest -> GetCheckpointResponse
GetEpochRequest -> GetEpochResponse

sui/rpc/v2beta2/event.proto​

Messages

Event​

An event.

Fields
contents
Proto3 optional
BCS serialized bytes of the event.
event_type
Proto3 optional
The type of the event emitted.
json
Proto3 optional
JSON rendering of the event.
module
Proto3 optional
Module name of the top-level function invoked by a MoveCall command that triggered this event to be emitted.
package_id
Proto3 optional
Package ID of the top-level function invoked by a MoveCall command that triggered this event to be emitted.
sender
Proto3 optional
Address of the account that sent the transaction where this event was emitted.

TransactionEvents​

Events emitted during the successful execution of a transaction.

Fields
bcs
Proto3 optional
This TransactionEvents serialized as BCS.
digest
Proto3 optional
The digest of this TransactionEvents.
events
Repeated []
Set of events emitted by a transaction.

sui/rpc/v2beta2/owner.proto​

Messages

Owner​

Enum of different types of ownership for an object.

Fields
address
Proto3 optional
Address or ObjectId of the owner
kind
Proto3 optional
version
Proto3 optional
The initial_shared_version if kind is SHARED or start_version if kind CONSENSUS_ADDRESS.

Enums

OwnerKind

Enums
OWNER_KIND_UNKNOWN
ADDRESS
OBJECT
SHARED
IMMUTABLE
CONSENSUS_ADDRESS

sui/rpc/v2beta2/object.proto​

Messages

Object​

An object on the Sui blockchain.

Fields
balance
Proto3 optional
Current balance if this object is a 0x2::coin::Coin<T>
bcs
Proto3 optional
This Object serialized as BCS.
contents
Proto3 optional
BCS bytes of a Move struct value. Only set for Move structs
digest
Proto3 optional
The digest of this Object.
has_public_transfer
Proto3 optional
DEPRECATED this field is no longer used to determine whether a tx can transfer this object. Instead, it is always calculated from the objects type when loaded in execution. Only set for Move structs
json
Proto3 optional
JSON rendering of the object.
object_id
Proto3 optional
ObjectId for this object.
object_type
Proto3 optional
The type of this object. This will be 'package' for packages and a StructTag for move structs.
owner
Proto3 optional
Owner of the object.
package
Proto3 optional
Package information for Move Packages
previous_transaction
Proto3 optional
The digest of the transaction that created or last mutated this object
storage_rebate
Proto3 optional
The amount of SUI to rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.
version
Proto3 optional
Version of the object.

sui/rpc/v2beta2/effects.proto​

Messages

ChangedObject​

Input/output state of an object that was changed during execution.

Fields
id_operation
Proto3 optional
What happened to an ObjectId during execution.
input_digest
Proto3 optional
Digest of the object before this transaction executed.
input_owner
Proto3 optional
Owner of the object before this transaction executed.
input_state
Proto3 optional
input_version
Proto3 optional
Version of the object before this transaction executed.
object_id
Proto3 optional
ID of the object.
object_type
Proto3 optional
Type information is not provided by the effects structure but is instead provided by an indexing layer
output_digest
Proto3 optional
Digest of the object after this transaction executed.
output_owner
Proto3 optional
Owner of the object after this transaction executed.
output_state
Proto3 optional
output_version
Proto3 optional
Version of the object after this transaction executed.

TransactionEffects​

The effects of executing a transaction.

Fields
auxiliary_data_digest
Proto3 optional
Auxiliary data that are not protocol-critical, generated as part of the effects but are stored separately. Storing it separately allows us to avoid bloating the effects with data that are not critical. It also provides more flexibility on the format and type of the data.
bcs
Proto3 optional
This TransactionEffects serialized as BCS.
changed_objects
Repeated []
Objects whose state are changed by this transaction.
dependencies
Repeated []
The set of transaction digests this transaction depends on.
digest
Proto3 optional
The digest of this TransactionEffects.
epoch
Proto3 optional
The epoch when this transaction was executed.
events_digest
Proto3 optional
The digest of the events emitted during execution, can be None if the transaction does not emit any event.
gas_object
Proto3 optional
Information about the gas object. Also present in the changed_objects vector. System transaction that don't require gas will leave this as None.
gas_used
Proto3 optional
The gas used by this transaction.
lamport_version
Proto3 optional
The version number of all the written objects (excluding packages) by this transaction.
status
Proto3 optional
The status of the execution.
transaction_digest
Proto3 optional
The transaction digest.
unchanged_consensus_objects
Repeated []
Consensus objects that are not mutated in this transaction. Unlike owned objects, read-only consensus objects' version are not committed in the transaction, and in order for a node to catch up and execute it without consensus sequencing, the version needs to be committed in the effects.
version
Proto3 optional
Version of this TransactionEffects.

UnchangedConsensusObject​

A consensus object that wasn't changed during execution.

Fields
digest
Proto3 optional
Digest of the consensus object.
kind
Proto3 optional
object_id
Proto3 optional
ObjectId of the consensus object.
object_type
Proto3 optional
Type information is not provided by the effects structure but is instead provided by an indexing layer
version
Proto3 optional
Version of the consensus object.

Enums

IdOperation

Enums
ID_OPERATION_UNKNOWN
NONE
CREATED
DELETED

InputObjectState

Enums
INPUT_OBJECT_STATE_UNKNOWN
INPUT_OBJECT_STATE_DOES_NOT_EXIST
INPUT_OBJECT_STATE_EXISTS

OutputObjectState

Enums
OUTPUT_OBJECT_STATE_UNKNOWN
OUTPUT_OBJECT_STATE_DOES_NOT_EXIST
OUTPUT_OBJECT_STATE_OBJECT_WRITE
OUTPUT_OBJECT_STATE_PACKAGE_WRITE

UnchangedConsensusObjectKind

Enums
UNCHANGED_CONSENSUS_OBJECT_KIND_UNKNOWN
READ_ONLY_ROOT
Read-only consensus object from the input.
MUTATE_CONSENSUS_STREAM_ENDED
Objects with ended consensus streams that appear mutably/owned in the input.
READ_CONSENSUS_STREAM_ENDED
Objects with ended consensus streams objects that appear as read-only in the input.
CANCELED
Consensus objects that were congested and resulted in this transaction being canceled.
PER_EPOCH_CONFIG
Read of a per-epoch config object that should remain the same during an epoch. This optionally will indicate the sequence number of the config object at the start of the epoch.

sui/rpc/v2beta2/executed_transaction.proto​

Messages

ExecutedTransaction​

Fields
balance_changes
Repeated []
checkpoint
Proto3 optional
The sequence number for the checkpoint that includes this transaction.
digest
Proto3 optional
The digest of this Transaction.
effects
Proto3 optional
The TransactionEffects for this transaction.
events
Proto3 optional
The TransactionEvents for this transaction. This field might be empty, even if it was explicitly requested, if the transaction didn't produce any events. sui.types.TransactionEffects.events_digest is populated if the transaction produced any events.
input_objects
Repeated []
Set of input objects used during the execution of this transaction.
output_objects
Repeated []
Set of output objects produced from the execution of this transaction.
signatures
Repeated []
List of user signatures that are used to authorize the execution of this transaction.
timestamp
Proto3 optional
The Unix timestamp of the checkpoint that includes this transaction.
transaction
Proto3 optional
The transaction itself.

sui/rpc/v2beta2/live_data_service.proto​

Messages

Balance​

Balance information for a specific coin type.

Fields
balance
Proto3 optional
Shows the total balance of the coin in its smallest unit.
coin_type
Proto3 optional
The type of the coin (e.g., 0x2::sui::SUI).

CoinMetadata​

Metadata for a coin type

Fields
decimals
Proto3 optional
Number of decimal places to coin uses.
description
Proto3 optional
Description of the token
icon_url
Proto3 optional
URL for the token logo
id
Proto3 optional
ObjectId of the 0x2::coin::CoinMetadata object or 0x2::sui::coin_registry::Currency object (when registered with CoinRegistry).
metadata_cap_id
Proto3 optional
The MetadataCap ID if it has been claimed for this coin type. This capability allows updating the coin's metadata fields. Only populated when metadata is from CoinRegistry.
metadata_cap_state
Proto3 optional
State of the MetadataCap for this coin type.
name
Proto3 optional
Name for the token
symbol
Proto3 optional
Symbol for the token

CoinTreasury​

Information about a coin type's 0x2::coin::TreasuryCap and its total available supply

Fields
id
Proto3 optional
ObjectId of the 0x2::coin::TreasuryCap object.
supply_state
Proto3 optional
Supply state indicating if the supply is fixed or can still be minted
total_supply
Proto3 optional
Total available supply for this coin type.

CommandOutput​

Fields
argument
Proto3 optional
json
Proto3 optional
JSON rendering of the output.
value
Proto3 optional

CommandResult​

An intermediate result/output from the execution of a single command

Fields
mutated_by_ref
Repeated []
return_values
Repeated []

DynamicField​

Fields
dynamic_object_id
Proto3 optional
The ObjectId of the child object when a child is a dynamic object field. The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object
field_id
Proto3 optional
ObjectId of this dynamic field.
kind
Proto3 optional
name_type
Proto3 optional
The type of the dynamic field "name"
name_value
Proto3 optional
The serialized move value of "name"
object
Proto3 optional
The object itself when a child is a dynamic object field.
parent
Proto3 optional
ObjectId of this dynamic field's parent.
value_type
Proto3 optional
The type of the dynamic field "value". If this is a dynamic object field then this is the type of the object itself (which is a child of this field), otherwise this is the type of the value of this field.

GetBalanceRequest​

Request message for LiveDataService.GetBalance.

Fields
coin_type
Proto3 optional
Required. The type names for the coin (e.g., 0x2::sui::SUI).
owner
Proto3 optional
Required. The owner's Sui address.

GetBalanceResponse​

Response message for LiveDataService.GetBalance. Return the total coin balance for one coin type, owned by the address owner.

Fields
balance
Proto3 optional
The balance information for the requested coin type.

GetCoinInfoRequest​

Request message for NodeService.GetCoinInfo.

Fields
coin_type
Proto3 optional
The coin type to request information about

GetCoinInfoResponse​

Response message for NodeService.GetCoinInfo.

Fields
coin_type
Proto3 optional
Required. The coin type.
metadata
Proto3 optional
This field will be populated with information about this coin type's 0x2::coin::CoinMetadata if it exists and has not been wrapped.
regulated_metadata
Proto3 optional
If this coin type is a regulated coin, this field will be populated with information either from its Currency object in the CoinRegistry, or from its 0x2::coin::RegulatedCoinMetadata object for coins that have not been migrated to the CoinRegistry If this coin is not known to be regulated, only the coin_regulated_state field will be populated.
treasury
Proto3 optional
This field will be populated with information about this coin type's 0x2::coin::TreasuryCap if it exists and has not been wrapped.

ListBalancesRequest​

Request message for LiveDataService.ListBalances.

Fields
owner
Proto3 optional
Required. The owner's Sui address.
page_size
Proto3 optional
The maximum number of balance entries to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListBalances call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBalances must match the call that provided the page token.

ListBalancesResponse​

Response message for LiveDataService.ListBalances. Return the total coin balance for all coin types, owned by the address owner.

Fields
balances
Repeated []
The list of coin types and their respective balances.
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDynamicFieldsRequest​

Request message for NodeService.ListDynamicFields

Fields
page_size
Proto3 optional
The maximum number of dynamic fields to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListDynamicFields call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDynamicFields must match the call that provided the page token.
parent
Proto3 optional
Required. The UID of the parent, which owns the collections of dynamic fields.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to parent,field_id.

ListDynamicFieldsResponse​

Response message for NodeService.ListDynamicFields

Fields
dynamic_fields
Repeated []
Page of dynamic fields owned by the specified parent.
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListOwnedObjectsRequest​

Fields
object_type
Proto3 optional
Optional type filter to limit the types of objects listed. Providing an object type with no type params will return objects of that type with any type parameter, e.g. 0x2::coin::Coin will return all Coin<T> objects regardless of the type parameter T. Providing a type with a type param will retrict the returned objects to only those objects that match the provided type parameters, e.g. 0x2::coin::Coin<0x2::sui::SUI> will only return Coin<SUI> objects.
owner
Proto3 optional
Required. The address of the account that owns the objects.
page_size
Proto3 optional
The maximum number of entries return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
Proto3 optional
A page token, received from a previous ListOwnedObjects call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOwnedObjects must match the call that provided the page token.
read_mask
Proto3 optional
Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,object_type.

ListOwnedObjectsResponse​

Fields
next_page_token
Proto3 optional
A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
objects
Repeated []
Page of dynamic fields owned by the specified parent.

RegulatedCoinMetadata​

Information about a regulated coin, which indicates that it makes use of the transfer deny list.

Fields
allow_global_pause
Proto3 optional
Whether the coin can be globally paused
coin_metadata_object
Proto3 optional
The ID of the coin's CoinMetadata or CoinData object.
coin_regulated_state
Proto3 optional
Indicates the coin's regulated state.
deny_cap_object
Proto3 optional
The ID of the coin's DenyCap object.
id
Proto3 optional
ObjectId of the 0x2::coin::RegulatedCoinMetadata object. Only present for coins that have not been migrated to CoinRegistry.
variant
Proto3 optional
Variant of the regulated coin metadata

SimulateTransactionRequest​

Fields
checks
Proto3 optional
Specify whether checks should be ENABLED (default) or DISABLED while executing the transaction
do_gas_selection
Proto3 optional
Perform gas selection based on a budget estimation and include the selected gas payment and budget in the response. This option will be ignored if checks is DISABLED.
read_mask
Proto3 optional
Mask specifying which fields to read.
transaction
Proto3 optional

SimulateTransactionResponse​

Fields
outputs
Repeated []
transaction
Proto3 optional

Services (live_data_service.proto)​

LiveDataService

Methods
ListDynamicFieldsRequest -> ListDynamicFieldsResponse
ListOwnedObjectsRequest -> ListOwnedObjectsResponse
GetCoinInfoRequest -> GetCoinInfoResponse
GetBalanceRequest -> GetBalanceResponse
ListBalancesRequest -> ListBalancesResponse
SimulateTransactionRequest -> SimulateTransactionResponse

Enums

MetadataCapState

Information about the state of the coin's MetadataCap
Enums
METADATA_CAP_STATE_UNKNOWN
Indicates the state of the MetadataCap is unknown. Set when the coin has not been migrated to the CoinRegistry.
CLAIMED
Indicates the MetadataCap has been claimed.
UNCLAIMED
Indicates the MetadataCap has not been claimed.
DELETED
Indicates the MetadataCap has been deleted.

SupplyState

Supply state of a coin, matching the Move SupplyState enum
Enums
SUPPLY_STATE_UNKNOWN
Supply is unknown or TreasuryCap still exists (minting still possible)
FIXED
Supply is fixed (TreasuryCap consumed, no more minting possible)
BURN_ONLY
Supply can only decrease (burning allowed, minting not allowed)

DynamicFieldKind

Enums
DYNAMIC_FIELD_KIND_UNKNOWN
FIELD
OBJECT

CoinRegulatedState

Indicates the state of the regulation of the coin.
Enums
COIN_REGULATED_STATE_UNKNOWN
Indicates the regulation state of the coin is unknown. This is set when a coin has not been migrated to the coin registry and has no 0x2::coin::RegulatedCoinMetadata object.
REGULATED
Indicates a coin is regulated. RegulatedCoinMetadata will be populated.
UNREGULATED
Indicates a coin is unregulated.

TransactionChecks

buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
Enums
ENABLED
DISABLED

sui/rpc/v2beta2/name_service.proto​

Messages

LookupNameRequest​

Fields
name
Proto3 optional
Required. The SuiNS name to lookup. Supports both @name as well as name.sui formats.

LookupNameResponse​

Fields
record
Proto3 optional
The record for the requested name

NameRecord​

Fields
data
Repeated []
Additional data which may be stored in a record
expiration_timestamp
Proto3 optional
Timestamp when the record expires. This is either the expiration of the record itself or the expiration of this record's parent if this is a leaf record.
id
Proto3 optional
Id of this record. Note that records are stored on chain as dynamic fields of the type Field<Domain,NameRecord>.
name
Proto3 optional
The SuiNS name of this record
registration_nft_id
Proto3 optional
The ID of the RegistrationNFT assigned to this record. The owner of the corrisponding RegistrationNFT has the rights to be able to change and adjust the target_address of this domain. It is possible that the ID changes if the record expires and is purchased by someone else.
target_address
Proto3 optional
The target address that this name points to

DataEntry​

Fields
key
value

ReverseLookupNameRequest​

Fields
address
Proto3 optional
Required. The address to perform a reverse lookup for.

ReverseLookupNameResponse​

Fields
record
Proto3 optional
The record for the SuiNS name linked to the requested address

Services (name_service.proto)​

NameService

Methods
LookupNameRequest -> LookupNameResponse
ReverseLookupNameRequest -> ReverseLookupNameResponse

sui/rpc/v2beta2/signature.proto​

Messages

CircomG1​

A G1 point.

Fields
e0
Proto3 optional
base10 encoded Bn254FieldElement
e1
Proto3 optional
base10 encoded Bn254FieldElement
e2
Proto3 optional
base10 encoded Bn254FieldElement

CircomG2​

A G2 point.

Fields
e00
Proto3 optional
base10 encoded Bn254FieldElement
e01
Proto3 optional
base10 encoded Bn254FieldElement
e10
Proto3 optional
base10 encoded Bn254FieldElement
e11
Proto3 optional
base10 encoded Bn254FieldElement
e20
Proto3 optional
base10 encoded Bn254FieldElement
e21
Proto3 optional
base10 encoded Bn254FieldElement

MultisigAggregatedSignature​

Aggregated signature from members of a multisig committee.

Fields
bitmap
Proto3 optional
Bitmap indicating which committee members contributed to the signature.
committee
Proto3 optional
The committee to use to validate this signature.
legacy_bitmap
Repeated []
If present, means this signature's on-chain format uses the old legacy multisig format.
signatures
Repeated []
The plain signatures encoded with signature scheme. The signatures must be in the same order as they are listed in the committee.

MultisigCommittee​

A multisig committee.

Fields
members
Repeated []
A list of committee members and their corresponding weight.
threshold
Proto3 optional
The threshold of signatures needed to validate a signature from this committee.

MultisigMember​

A member in a multisig committee.

Fields
public_key
Proto3 optional
The public key of the committee member.
weight
Proto3 optional
The weight of this member's signature.

MultisigMemberPublicKey​

Set of valid public keys for multisig committee members.

Fields
public_key
Proto3 optional
Public key bytes if scheme is ed25519 | secp256k1 | secp256r1 | passkey.
scheme
Proto3 optional
The signature scheme of this public key.
zklogin
Proto3 optional
A zklogin public identifier if scheme is zklogin.

MultisigMemberSignature​

A signature from a member of a multisig committee.

Fields
passkey
Proto3 optional
The passkey authenticator if scheme is PASSKEY.
scheme
Proto3 optional
The signature scheme of this signature.
signature
Proto3 optional
Signature bytes if scheme is ed25519 | secp256k1 | secp256r1.
zklogin
Proto3 optional
The zklogin authenticator if scheme is ZKLOGIN.

PasskeyAuthenticator​

A passkey authenticator.

See struct.PasskeyAuthenticator for more information on the requirements on the shape of the client_data_json field.

Fields
authenticator_data
Proto3 optional
Opaque authenticator data for this passkey signature. See Authenticator Data for more information on this field.
client_data_json
Proto3 optional
Structured, unparsed, JSON for this passkey signature. See CollectedClientData for more information on this field.
signature
Proto3 optional
A secp256r1 signature.

SimpleSignature​

Either an ed25519, secp256k1 or secp256r1 signature

Fields
public_key
Proto3 optional
Public key bytes
scheme
Proto3 optional
The signature scheme of this signature.
signature
Proto3 optional
Signature bytes

UserSignature​

A signature from a user.

Fields
bcs
Proto3 optional
This signature serialized as as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.
scheme
Proto3 optional
The signature scheme of this signature.
Union field signature can be only one of the following.
multisig
The multisig aggregated signature if scheme is MULTISIG.
passkey
The passkey authenticator if scheme is PASSKEY.
simple
Simple signature if scheme is ed25519 | secp256k1 | secp256r1.
zklogin
The zklogin authenticator if scheme is ZKLOGIN.

ValidatorAggregatedSignature​

An aggregated signature from multiple validators.

Fields
bitmap
Repeated []
Bitmap indicating which members of the committee contributed to this signature.
epoch
Proto3 optional
The epoch when this signature was produced. This can be used to lookup the ValidatorCommittee from this epoch to verify this signature.
signature
Proto3 optional
The 48-byte Bls12381 aggregated signature.

ValidatorCommittee​

The validator set for a particular epoch.

Fields
epoch
Proto3 optional
The epoch where this committee governs.
members
Repeated []
The committee members.

ValidatorCommitteeMember​

A member of a validator committee.

Fields
public_key
Proto3 optional
The 96-byte Bls12381 public key for this validator.
weight
Proto3 optional
voting weight this validator possesses.

ZkLoginAuthenticator​

A zklogin authenticator.

Fields
inputs
Proto3 optional
Zklogin proof and inputs required to perform proof verification.
max_epoch
Proto3 optional
Maximum epoch for which the proof is valid.
signature
Proto3 optional
User signature with the public key attested to by the provided proof.

ZkLoginClaim​

A claim of the iss in a zklogin proof.

Fields
index_mod_4
Proto3 optional
value
Proto3 optional

ZkLoginInputs​

A zklogin groth16 proof and the required inputs to perform proof verification.

Fields
address_seed
Proto3 optional
base10 encoded Bn254FieldElement
header_base64
Proto3 optional
iss_base64_details
Proto3 optional
proof_points
Proto3 optional

ZkLoginProof​

A zklogin groth16 proof.

Fields
a
Proto3 optional
b
Proto3 optional
c
Proto3 optional

ZkLoginPublicIdentifier​

Public key equivalent for zklogin authenticators.

Fields
address_seed
Proto3 optional
base10 encoded Bn254FieldElement
iss
Proto3 optional

sui/rpc/v2beta2/gas_cost_summary.proto​

Messages

GasCostSummary​

Summary of gas charges.

Fields
computation_cost
Proto3 optional
Cost of computation/execution.
non_refundable_storage_fee
Proto3 optional
The fee for the rebate. The portion of the storage rebate kept by the system.
storage_cost
Proto3 optional
Storage cost, it's the sum of all storage cost for all objects created or mutated.
storage_rebate
Proto3 optional
The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.

sui/rpc/v2beta2/error_reason.proto​

Enums

ErrorReason

Enums
ERROR_REASON_UNKNOWN
FIELD_INVALID
FIELD_MISSING

sui/rpc/v2beta2/protocol_config.proto​

Messages

ProtocolConfig​

Fields
attributes
Repeated []
feature_flags
Repeated []
protocol_version
Proto3 optional

AttributesEntry​

Fields
key
value

FeatureFlagsEntry​

Fields
key
value

sui/rpc/v2beta2/system_state.proto​

Messages

MoveTable​

A message that represents a Move 0x2::table::Table or 0x2::bag::Bag

Fields
id
Proto3 optional
The UID of the table or bag
size
Proto3 optional
The size or number of key-value pairs in the table or bag

StakeSubsidy​

Fields
balance
Proto3 optional
Balance of SUI set aside for stake subsidies that will be drawn down over time.
current_distribution_amount
Proto3 optional
The amount of stake subsidy to be drawn down per distribution. This amount decays and decreases over time.
distribution_counter
Proto3 optional
Count of the number of times stake subsidies have been distributed.
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
stake_subsidy_decrease_rate
Proto3 optional
The rate at which the distribution amount decays at the end of each period. Expressed in basis points.
stake_subsidy_period_length
Proto3 optional
Number of distributions to occur before the distribution amount decays.

StakingPool​

A staking pool embedded in each validator struct in the system state object.

Fields
activation_epoch
Proto3 optional
The epoch at which this pool became active. The value is None if the pool is pre-active and Some(<epoch_number>) if active or inactive.
deactivation_epoch
Proto3 optional
The epoch at which this staking pool ceased to be active. None = {pre-active, active}, Some(<epoch_number>) if in-active, and it was de-activated at epoch <epoch_number>.
exchange_rates
Proto3 optional
Exchange rate history of previous epochs. The entries start from the activation_epoch of this pool and contains exchange rates at the beginning of each epoch, i.e., right after the rewards for the previous epoch have been deposited into the pool. key: u64 (epoch number), value: PoolTokenExchangeRate
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
id
Proto3 optional
UID of the StakingPool object
pending_pool_token_withdraw
Proto3 optional
Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.
pending_stake
Proto3 optional
Pending stake amount for this epoch, emptied at epoch boundaries.
pending_total_sui_withdraw
Proto3 optional
Pending stake withdrawn during the current epoch, emptied at epoch boundaries. This includes both the principal and rewards SUI withdrawn.
pool_token_balance
Proto3 optional
Total number of pool tokens issued by the pool.
rewards_pool
Proto3 optional
The epoch stake rewards will be added here at the end of each epoch.
sui_balance
Proto3 optional
The total number of SUI tokens in this pool, including the SUI in the rewards_pool, as well as in all the principal in the StakedSui object, updated at epoch boundaries.

StorageFund​

Struct representing the onchain storage fund.

Fields
non_refundable_balance
Proto3 optional
Represents any remaining inflow of the storage fund that should not be taken out of the fund.
total_object_storage_rebates
Proto3 optional
This is the sum of storage_rebate of all objects currently stored on-chain. To maintain this invariant, the only inflow of this balance is storage charges collected from transactions, and the only outflow is storage rebates of transactions, including both the portion refunded to the transaction senders as well as the non-refundable portion taken out and put into non_refundable_balance.

SystemParameters​

Fields
epoch_duration_ms
Proto3 optional
The duration of an epoch, in milliseconds.
extra_fields
Proto3 optional
Any extra fields that are not defined statically.
max_validator_count
Proto3 optional
Maximum number of active validators at any moment. We do not allow the number of validators in any epoch to go above this.
min_validator_count
Proto3 optional
Minimum number of active validators at any moment.
min_validator_joining_stake
Proto3 optional
Deprecated. Lower-bound on the amount of stake required to become a validator.
stake_subsidy_start_epoch
Proto3 optional
The starting epoch in which stake subsidies start being paid out
validator_low_stake_grace_period
Proto3 optional
A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.
validator_low_stake_threshold
Proto3 optional
Deprecated. Validators with stake amount below validator_low_stake_threshold are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than validator_low_stake_grace_period number of epochs.
validator_very_low_stake_threshold
Proto3 optional
Deprecated. Validators with stake below validator_very_low_stake_threshold will be removed immediately at epoch change, no grace period.

SystemState​

Fields
epoch
Proto3 optional
The epoch id
epoch_start_timestamp_ms
Proto3 optional
Unix timestamp of when this this epoch started
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
parameters
Proto3 optional
Set of system config parameters
protocol_version
Proto3 optional
The protocol version
reference_gas_price
Proto3 optional
The reference gas price for this epoch
safe_mode
Proto3 optional
Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch. The rest of the fields starting with safe_mode_ are accumulated during safe mode when advance_epoch_safe_mode is executed. They will eventually be processed once we are out of safe mode.
safe_mode_computation_rewards
Proto3 optional
Computation rewards accumulated during safe_mode
safe_mode_non_refundable_storage_fee
Proto3 optional
Nonrefundable storage fees accumulated during safe_mode
safe_mode_storage_rebates
Proto3 optional
Storage rebates paid out during safe_mode
safe_mode_storage_rewards
Proto3 optional
Storage rewards accumulated during safe_mode
stake_subsidy
Proto3 optional
Schedule of stake subsidies given out each epoch.
storage_fund
Proto3 optional
Storage Fund info
validator_report_records
Repeated []
A list of the records of validator reporting each other. There is an entry in this list for each validator that has been reported at least once. Each record contains all the validators that reported them. If a validator has never been reported they don't have a record in this list. This lists persists across epoch: a peer continues being in a reported state until the reporter doesn't explicitly remove their report.
validators
Proto3 optional
Information about the validators
version
Proto3 optional
The version of the system state data structure type.

Validator​

Definition of a Validator in the system contracts

Note: fields of ValidatorMetadata are flattened into this type

Fields
address
Proto3 optional
The Sui Address of the validator. This is the sender that created the Validator object, and also the address to send validator/coins to during withdraws.
commission_rate
Proto3 optional
Commission rate of the validator, in basis point.
description
Proto3 optional
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
gas_price
Proto3 optional
Gas price quote, updated only at end of epoch.
image_url
Proto3 optional
metadata_extra_fields
Proto3 optional
Any extra fields that's not defined statically in the ValidatorMetadata struct
name
Proto3 optional
A unique human-readable name of this validator.
network_address
Proto3 optional
The network address of the validator (could also contain extra info such as port, DNS and etc.).
network_public_key
Proto3 optional
The public key bytes corresponding to the private key that the validator uses to establish TLS connections
next_epoch_commission_rate
Proto3 optional
The commission rate of the validator starting the next epoch, in basis point.
next_epoch_gas_price
Proto3 optional
This validator's gas price quote for the next epoch.
next_epoch_network_address
Proto3 optional
next_epoch_network_public_key
Proto3 optional
next_epoch_p2p_address
Proto3 optional
next_epoch_primary_address
Proto3 optional
next_epoch_proof_of_possession
Proto3 optional
next_epoch_protocol_public_key
Proto3 optional
next_epoch_stake
Proto3 optional
Total amount of stake that would be active in the next epoch.
next_epoch_worker_address
Proto3 optional
next_epoch_worker_public_key
Proto3 optional
operation_cap_id
Proto3 optional
The ID of this validator's current valid UnverifiedValidatorOperationCap
p2p_address
Proto3 optional
The address of the validator used for p2p activities such as state sync (could also contain extra info such as port, DNS and etc.).
primary_address
Proto3 optional
The address of the narwhal primary
project_url
Proto3 optional
proof_of_possession
Proto3 optional
This is a proof that the validator has ownership of the protocol private key
protocol_public_key
Proto3 optional
The public key bytes corresponding to the private key that the validator holds to sign transactions. For now, this is the same as AuthorityName.
staking_pool
Proto3 optional
Staking pool for this validator.
voting_power
Proto3 optional
The voting power of this validator, which might be different from its stake amount.
worker_address
Proto3 optional
The address of the narwhal worker
worker_public_key
Proto3 optional
The public key bytes correstponding to the Narwhal Worker

ValidatorReportRecord​

Fields
reported
Proto3 optional
The address of the validator being reported
reporters
Repeated []
The list of validator (addresses) that are reporting on the validator specified by reported

ValidatorSet​

Fields
active_validators
Repeated []
The current list of active validators.
at_risk_validators
Repeated []
Table storing the number of epochs during which a validator's stake has been below the low stake threshold.
extra_fields
Proto3 optional
Any extra fields that's not defined statically.
inactive_validators
Proto3 optional
Mapping from a staking pool ID to the inactive validator that has that pool as its staking pool. When a validator is deactivated the validator is removed from active_validators it is added to this table so that stakers can continue to withdraw their stake from it. key: address (staking pool Id), value: 0x3::validator_wrapper::ValidatorWrapper
pending_active_validators
Proto3 optional
List of new validator candidates added during the current epoch. They will be processed at the end of the epoch. key: u64 (index), value: 0x3::validator::Validator
pending_removals
Repeated []
Removal requests from the validators. Each element is an index pointing to active_validators.
staking_pool_mappings
Proto3 optional
Mappings from staking pool's ID to the sui address of a validator. key: address (staking pool Id), value: address (sui address of the validator)
total_stake
Proto3 optional
Total amount of stake from all active validators at the beginning of the epoch. Written only once per epoch, in advance_epoch function.
validator_candidates
Proto3 optional
Table storing preactive/candidate validators, mapping their addresses to their Validator structs. When an address calls request_add_validator_candidate, they get added to this table and become a preactive validator. When the candidate has met the min stake requirement, they can call request_add_validator to officially add them to the active validator set active_validators next epoch. key: address (sui address of the validator), value: 0x3::validator_wrapper::ValidatorWrapper

AtRiskValidatorsEntry​

Fields
key
value

sui/rpc/v2beta2/execution_status.proto​

Messages

CleverError​

Fields
constant_name
Proto3 optional
constant_type
Proto3 optional
error_code
Proto3 optional
line_number
Proto3 optional
Union field value can be only one of the following.
raw
rendered

CoinDenyListError​

Fields
address
Proto3 optional
Denied address.
coin_type
Proto3 optional
Coin type.

CommandArgumentError​

An error with an argument to a command.

Fields
argument
Proto3 optional
Position of the problematic argument.
index_error
Proto3 optional
kind
Proto3 optional

CongestedObjects​

Set of objects that were congested, leading to the transaction's cancellation.

Fields
objects
Repeated []

ExecutionError​

An error that can occur during the execution of a transaction.

Fields
command
Proto3 optional
The command, if any, during which the error occurred.
description
Proto3 optional
A human readable description of the error
kind
Proto3 optional
Union field error_details can be only one of the following.
abort
coin_deny_list_error
command_argument_error
congested_objects
Set of objects that were congested, leading to the transaction's cancellation.
index_error
object_id
package_upgrade_error
size_error
type_argument_error

ExecutionStatus​

The status of an executed transaction.

Fields
error
Proto3 optional
The error if success is false.
success
Proto3 optional
Indicates if the transaction was successful or not.

IndexError​

Fields
index
Proto3 optional
Index of an input or result.
subresult
Proto3 optional
Index of a subresult.

MoveAbort​

Fields
abort_code
Proto3 optional
clever_error
Proto3 optional
Extra error information if abort code is a "Clever Error"
location
Proto3 optional
Location in Move where the error occurred.

MoveLocation​

Location in Move bytecode where an error occurred.

Fields
function
Proto3 optional
The function index.
function_name
Proto3 optional
The name of the function, if available.
instruction
Proto3 optional
Offset of the instruction where the error occurred.
module
Proto3 optional
The module name.
package
Proto3 optional
The package ID.

PackageUpgradeError​

An error with upgrading a package.

Fields
digest
Proto3 optional
A digest.
kind
Proto3 optional
package_id
Proto3 optional
The Package Id.
policy
Proto3 optional
The policy.
ticket_id
Proto3 optional
The ticket Id.

SizeError​

A size error.

Fields
max_size
Proto3 optional
The maximum allowable size.
size
Proto3 optional
The offending size.

TypeArgumentError​

Type argument error.

Fields
kind
Proto3 optional
type_argument
Proto3 optional
Index of the problematic type argument.

Enums

CommandArgumentErrorKind

Enums
COMMAND_ARGUMENT_ERROR_KIND_UNKNOWN
TYPE_MISMATCH
The type of the value does not match the expected type.
INVALID_BCS_BYTES
The argument cannot be deserialized into a value of the specified type.
INVALID_USAGE_OF_PURE_ARGUMENT
The argument cannot be instantiated from raw bytes.
INVALID_ARGUMENT_TO_PRIVATE_ENTRY_FUNCTION
Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.
INDEX_OUT_OF_BOUNDS
Out of bounds access to input or results. index field will be set indicating the invalid index value.
SECONDARY_INDEX_OUT_OF_BOUNDS
Out of bounds access to subresult. index and subresult fields will be set indicating the invalid index value.
INVALID_RESULT_ARITY
Invalid usage of result. Expected a single result but found either no return value or multiple. index field will be set indicating the invalid index value.
INVALID_GAS_COIN_USAGE
Invalid usage of gas coin. The gas coin can only be used by-value with a TransferObject command.
INVALID_VALUE_USAGE
Invalid usage of Move value. - Mutably borrowed values require unique usage. - Immutably borrowed values cannot be taken or borrowed mutably. - Taken values cannot be used again.
INVALID_OBJECT_BY_VALUE
Immutable objects cannot be passed by-value.
INVALID_OBJECT_BY_MUT_REF
Immutable objects cannot be passed by mutable reference, &mut.
CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED
Consensus object operations such as wrapping, freezing, or converting to owned are not allowed.
INVALID_ARGUMENT_ARITY
Invalid argument arity. Expected a single argument but found a result that expanded to multiple arguments.

ExecutionErrorKind

Enums
EXECUTION_ERROR_KIND_UNKNOWN
INSUFFICIENT_GAS
Insufficient gas.
INVALID_GAS_OBJECT
Invalid Gas object.
INVARIANT_VIOLATION
Invariant violation.
FEATURE_NOT_YET_SUPPORTED
Attempted to use feature that is not supported yet.
OBJECT_TOO_BIG
Move object is larger than the maximum allowed size.
PACKAGE_TOO_BIG
Package is larger than the maximum allowed size.
CIRCULAR_OBJECT_OWNERSHIP
Circular object ownership.
INSUFFICIENT_COIN_BALANCE
Insufficient coin balance for requested operation.
COIN_BALANCE_OVERFLOW
Coin balance overflowed an u64.
PUBLISH_ERROR_NON_ZERO_ADDRESS
Publish error, non-zero address. The modules in the package must have their self-addresses set to zero.
SUI_MOVE_VERIFICATION_ERROR
Sui Move bytecode verification error.
MOVE_PRIMITIVE_RUNTIME_ERROR
Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, or similar.
MOVE_ABORT
Move runtime abort.
VM_VERIFICATION_OR_DESERIALIZATION_ERROR
Bytecode verification error.
VM_INVARIANT_VIOLATION
MoveVm invariant violation.
FUNCTION_NOT_FOUND
Function not found.
ARITY_MISMATCH
Parity mismatch for Move function. The number of arguments does not match the number of parameters.
TYPE_ARITY_MISMATCH
Type parity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.
NON_ENTRY_FUNCTION_INVOKED
Non-entry function invoked. Move Call must start with an entry function.
COMMAND_ARGUMENT_ERROR
Invalid command argument.
TYPE_ARGUMENT_ERROR
Type argument error.
UNUSED_VALUE_WITHOUT_DROP
Unused result without the drop ability.
INVALID_PUBLIC_FUNCTION_RETURN_TYPE
Invalid public Move function signature. Unsupported return type for return value.
INVALID_TRANSFER_OBJECT
Invalid transfer object, object does not have public transfer.
EFFECTS_TOO_LARGE
Effects from the transaction are too large.
PUBLISH_UPGRADE_MISSING_DEPENDENCY
Publish or Upgrade is missing dependency.
PUBLISH_UPGRADE_DEPENDENCY_DOWNGRADE
Publish or upgrade dependency downgrade. Indirect (transitive) dependency of published or upgraded package has been assigned an on-chain version that is less than the version required by one of the package's transitive dependencies.
PACKAGE_UPGRADE_ERROR
Invalid package upgrade.
WRITTEN_OBJECTS_TOO_LARGE
Indicates the transaction tried to write objects too large to storage.
CERTIFICATE_DENIED
Certificate is on the deny list.
SUI_MOVE_VERIFICATION_TIMEDOUT
Sui Move bytecode verification timed out.
CONSENSUS_OBJECT_OPERATION_NOT_ALLOWED
The requested consensus object operation is not allowed.
INPUT_OBJECT_DELETED
Requested consensus object has been deleted.
EXECUTION_CANCELED_DUE_TO_CONSENSUS_OBJECT_CONGESTION
Certificate is canceled due to congestion on consensus objects.
ADDRESS_DENIED_FOR_COIN
Address is denied for this coin type.
COIN_TYPE_GLOBAL_PAUSE
Coin type is globally paused for use.
EXECUTION_CANCELED_DUE_TO_RANDOMNESS_UNAVAILABLE
Certificate is canceled because randomness could not be generated this epoch.
MOVE_VECTOR_ELEM_TOO_BIG
MOVE_RAW_VALUE_TOO_BIG
INVALID_LINKAGE

PackageUpgradeErrorKind

Enums
PACKAGE_UPGRADE_ERROR_KIND_UNKNOWN
UNABLE_TO_FETCH_PACKAGE
Unable to fetch package.
NOT_A_PACKAGE
Object is not a package.
INCOMPATIBLE_UPGRADE
Package upgrade is incompatible with previous version.
DIGEST_DOES_NOT_MATCH
Digest in upgrade ticket and computed digest differ.
UNKNOWN_UPGRADE_POLICY
Upgrade policy is not valid.
PACKAGE_ID_DOES_NOT_MATCH
Package ID does not match PackageId in upgrade ticket.

TypeArgumentErrorKind

Enums
TYPE_ARGUMENT_ERROR_KIND_UNKNOWN
TYPE_NOT_FOUND
A type was not found in the module specified.
CONSTRAINT_NOT_SATISFIED
A type provided did not match the specified constraint.

sui/rpc/v2beta2/object_reference.proto​

Messages

ObjectReference​

Reference to an object.

Fields
digest
Proto3 optional
The digest of this object.
object_id
Proto3 optional
The object id of this object.
version
Proto3 optional
The version of this object.

sui/rpc/v2beta2/input.proto​

Messages

Input​

An input to a user transaction.

Fields
digest
Proto3 optional
The digest of this object.
kind
Proto3 optional
literal
Proto3 optional
A literal value INPUT ONLY
mutable
Proto3 optional
Controls whether the caller asks for a mutable reference to the shared object.
object_id
Proto3 optional
ObjectId of the object input.
pure
Proto3 optional
A move value serialized as BCS. For normal operations this is required to be a move primitive type and not contain structs or objects.
version
Proto3 optional
Requested version of the input object when kind is IMMUTABLE_OR_OWNED or RECEIVING or if kind is SHARED this is the initial version of the object when it was shared

Enums

InputKind

Enums
INPUT_KIND_UNKNOWN
PURE
A move value serialized as BCS.
IMMUTABLE_OR_OWNED
A Move object that is either immutable or address owned.
SHARED
A Move object whose owner is "Shared".
RECEIVING
A Move object that is attempted to be received in this transaction.

sui/rpc/v2beta2/move_package.proto​

Messages

DatatypeDescriptor​

Describes a Move Datatype.

Fields
abilities
Repeated []
This type's abilities
defining_id
Proto3 optional
PackageId of the package where this Datatype is defined. A type's defining_id is the storage_id of the package version that first introduced or added that type.
fields
Repeated []
Set of fields if this Datatype is a struct. The order of the entries is the order of how the fields are defined.
kind
Proto3 optional
Indicates whether this datatype is a 'STRUCT' or an 'ENUM'
module
Proto3 optional
Name of the module where this Datatype is defined
name
Proto3 optional
Name of this Datatype
type_name
Proto3 optional
Fully qualified name of this Datatype. This is <defining_id>::<module>::<name>
type_parameters
Repeated []
Ability constraints and phantom status for this type's generic type parameters
variants
Repeated []
Set of variants if this Datatype is an enum. The order of the entries is the order of how the variants are defined.

FieldDescriptor​

Descriptor of a field that belongs to a struct or enum variant

Fields
name
Proto3 optional
Name of the field
position
Proto3 optional
Order or position of the field in the struct or enum variant definition.
type
Proto3 optional
The type of the field

FunctionDescriptor​

Descriptor of a Move function

Fields
is_entry
Proto3 optional
Whether the function is marked entry or not.
name
Proto3 optional
Name of the function
parameters
Repeated []
Formal parameter types.
returns
Repeated []
Return types.
type_parameters
Repeated []
Ability constraints for type parameters
visibility
Proto3 optional
Whether the function is public, private or public(friend)

Linkage​

Upgraded package info for the linkage table.

Fields
original_id
Proto3 optional
Id of the original package.
upgraded_id
Proto3 optional
Id of the upgraded package.
upgraded_version
Proto3 optional
Version of the upgraded package.

Module​

A Move Module.

Fields
contents
Proto3 optional
Serialized bytecode of the module.
datatypes
Repeated []
List of DataTypes defined by this module.
functions
Repeated []
List of Functions defined by this module.
name
Proto3 optional
Name of this module.

OpenSignature​

Representation of a type signature that could appear as a function parameter or return value.

Fields
body
Proto3 optional
reference
Proto3 optional

OpenSignatureBody​

Representation of a type signature that could appear as a field type for a struct or enum

Fields
type
Proto3 optional
Type of this signature
type_name
Proto3 optional
Fully qualified name of the datatype when type is DATATYPE
type_parameter
Proto3 optional
Position of the type parameter as defined in the containing data type descriptor when type is TYPE_PARAMETER
type_parameter_instantiation
Repeated []
Set when type is VECTOR or DATATYPE

Package​

A Move Package

Fields
linkage
Repeated []
The package's transitive dependencies as a mapping from the package's runtime Id (the Id it is referred to by in other packages) to its storage Id (the Id it is loaded from on chain).
modules
Repeated []
The modules defined by this package
original_id
Proto3 optional
The PackageId of the first published version of this package. A package's original_id (sometimes also called its runtime_id) is the storage_id of the first version of this package that has been published. The original_id/runtime_id is stable across all versions of the package and does not ever change.
storage_id
Proto3 optional
The PackageId of this package A package's storage_id is the Sui ObjectId of the package on-chain. Outside of system packages the storage_id for every package version is different.
type_origins
Repeated []
List of datatype origins for mapping datatypes to a package version where it was first defined
version
Proto3 optional
The version of this package

TypeOrigin​

Identifies a struct and the module it was defined in.

Fields
datatype_name
Proto3 optional
module_name
Proto3 optional
package_id
Proto3 optional

TypeParameter​

A generic type parameter used in the declaration of a struct or enum.

Fields
constraints
Repeated []
The type parameter constraints
is_phantom
Proto3 optional
Whether the parameter is declared as phantom

VariantDescriptor​

Descriptor of an enum variant

Fields
fields
Repeated []
Set of fields defined by this variant.
name
Proto3 optional
Name of the variant
position
Proto3 optional
Order or position of the variant in the enum definition.

Enums

Ability

An Ability classifies what operations are permitted for a given type
Enums
ABILITY_UNKNOWN
COPY
Allows values of types with this ability to be copied
DROP
Allows values of types with this ability to be dropped.
STORE
Allows values of types with this ability to exist inside a struct in global storage
KEY
Allows the type to serve as a key for global storage operations

DatatypeKind

Enums
DATATYPE_KIND_UNKNOWN
STRUCT
ENUM

Visibility

Enums
VISIBILITY_UNKNOWN
PRIVATE
PUBLIC
FRIEND

Reference

Enums
REFERENCE_UNKNOWN
IMMUTABLE
MUTABLE

Type

Enums
TYPE_UNKNOWN
ADDRESS
BOOL
U8
U16
U32
U64
U128
U256
VECTOR
DATATYPE
TYPE_PARAMETER

sui/rpc/v2beta2/epoch.proto​

Messages

Epoch​

Fields
committee
Proto3 optional
The committee governing this epoch.
end
Proto3 optional
epoch
Proto3 optional
first_checkpoint
Proto3 optional
last_checkpoint
Proto3 optional
protocol_config
Proto3 optional
reference_gas_price
Proto3 optional
Reference gas price denominated in MIST
start
Proto3 optional
system_state
Proto3 optional
Snapshot of Sui's SystemState (0x3::sui_system::SystemState) at the beginning of the epoch, for past epochs, or the current state for the current epoch.

sui/rpc/v2beta2/subscription_service.proto​

Messages

SubscribeCheckpointsRequest​

Request message for SubscriptionService.SubscribeCheckpoints

Fields
read_mask
Proto3 optional
Optional. Mask for specifiying which parts of the SubscribeCheckpointsResponse should be returned.

SubscribeCheckpointsResponse​

Response message for SubscriptionService.SubscribeCheckpoints

Fields
checkpoint
Proto3 optional
The requested data for this checkpoint
cursor
Proto3 optional
Required. The checkpoint sequence number and value of the current cursor into the checkpoint stream

Services (subscription_service.proto)​

SubscriptionService

Methods
SubscribeCheckpointsRequest -> SubscribeCheckpointsResponse
Subscribe to the stream of checkpoints. This API provides a subscription to the checkpoint stream for the Sui blockchain. When a subscription is initialized the stream will begin with the latest executed checkpoint as seen by the server. Responses are guaranteed to return checkpoints in-order and without gaps. This enables clients to know exactly the last checkpoint they have processed and in the event the subscription terminates (either by the client/server or by the connection breaking), clients will be able to reinitailize a subscription and then leverage other APIs in order to request data for the checkpoints they missed.

sui/rpc/v2beta2/bcs.proto​

Messages

Bcs​

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.

Fields
name
Proto3 optional
Name that identifies the type of the serialized value.
value
Proto3 optional
Bytes of a BCS serialized value.

sui/rpc/v2beta2/signature_scheme.proto​

Enums

SignatureScheme

Flag use to disambiguate the signature schemes supported by Sui. Note: the enum values defined by this proto message exactly match their expected BCS serialized values when serialized as a u8. See enum.SignatureScheme for more information about signature schemes.
Enums
ED25519
SECP256K1
SECP256R1
MULTISIG
BLS12381
ZKLOGIN
PASSKEY

sui/rpc/v2beta2/checkpoint.proto​

Messages

Checkpoint​

Fields
contents
Proto3 optional
The CheckpointContents for this checkpoint.
digest
Proto3 optional
The digest of this Checkpoint's CheckpointSummary.
sequence_number
Proto3 optional
The height of this checkpoint.
signature
Proto3 optional
An aggregated quorum signature from the validator committee that certified this checkpoint.
summary
Proto3 optional
The CheckpointSummary for this checkpoint.
transactions
Repeated []
List of transactions included in this checkpoint.

sui/rpc/v2beta2/transaction.proto​

Messages

ActiveJwk​

A new JWK.

Fields
epoch
Proto3 optional
Most recent epoch in which the JWK was validated.
id
Proto3 optional
Identifier used to uniquely identify a JWK.
jwk
Proto3 optional
The JWK.

AuthenticatorStateExpire​

Expire old JWKs.

Fields
authenticator_object_initial_shared_version
Proto3 optional
The initial version of the authenticator object that it was shared at.
min_epoch
Proto3 optional
Expire JWKs that have a lower epoch than this.

AuthenticatorStateUpdate​

Update the set of valid JWKs.

Fields
authenticator_object_initial_shared_version
Proto3 optional
The initial version of the authenticator object that it was shared at.
epoch
Proto3 optional
Epoch of the authenticator state update transaction.
new_active_jwks
Repeated []
Newly active JWKs.
round
Proto3 optional
Consensus round of the authenticator state update.

CanceledTransaction​

A transaction that was canceled.

Fields
digest
Proto3 optional
Digest of the canceled transaction.
version_assignments
Repeated []
List of object version assignments.

ChangeEpoch​

System transaction used to change the epoch.

Fields
computation_charge
Proto3 optional
The total amount of gas charged for computation during the epoch.
epoch
Proto3 optional
The next (to become) epoch ID.
epoch_start_timestamp
Proto3 optional
Unix timestamp when epoch started.
non_refundable_storage_fee
Proto3 optional
The non-refundable storage fee.
protocol_version
Proto3 optional
The protocol version in effect in the new epoch.
storage_charge
Proto3 optional
The total amount of gas charged for storage during the epoch.
storage_rebate
Proto3 optional
The amount of storage rebate refunded to the txn senders.
system_packages
Repeated []
System packages (specifically framework and Move stdlib) that are written before the new epoch starts. This tracks framework upgrades on chain. When executing the ChangeEpoch txn, the validator must write out the following modules. Modules are provided with the version they will be upgraded to, their modules in serialized form (which include their package ID), and a list of their transitive dependencies.

Command​

A single command in a programmable transaction.

Fields
Union field command can be only one of the following.
make_move_vector
forall T: Vec<T> -> vector<T> Given n-values of the same type, it constructs a vector. For non-objects or an empty vector, the type tag must be specified.
merge_coins
(&mut Coin<T>, Vec<Coin<T>>) It merges n-coins into the first coin.
move_call
A call to either an entry or a public Move function.
publish
Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on chain.
split_coins
(&mut Coin<T>, Vec<u64>) -> Vec<Coin<T>> It splits off some amounts into new coins with those amounts.
transfer_objects
(Vec<forall T:key+store. T>, address) It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.
upgrade
Upgrades a Move package. Takes (in order): 1. A vector of serialized modules for the package. 2. A vector of object ids for the transitive dependencies of the new package. 3. The object ID of the package being upgraded. 4. An argument holding the UpgradeTicket that must have been produced from an earlier command in the same programmable transaction.

ConsensusCommitPrologue​

Consensus commit prologue system transaction.

This message can represent V1, V2, and V3 prologue types.

Fields
additional_state_digest
Proto3 optional
Digest of any additional state computed by the consensus handler. Used to detect forking bugs as early as possible. Present in V4.
commit_timestamp
Proto3 optional
Unix timestamp from consensus. Present in V1, V2, V3, V4.
consensus_commit_digest
Proto3 optional
Digest of consensus output. Present in V2, V3, V4.
consensus_determined_version_assignments
Proto3 optional
Stores consensus handler determined consensus object version assignments. Present in V3, V4.
epoch
Proto3 optional
Epoch of the commit prologue transaction. Present in V1, V2, V3, V4.
round
Proto3 optional
Consensus round of the commit. Present in V1, V2, V3, V4.
sub_dag_index
Proto3 optional
The sub DAG index of the consensus commit. This field is populated if there are multiple consensus commits per round. Present in V3, V4.

ConsensusDeterminedVersionAssignments​

Version assignments performed by consensus.

Fields
canceled_transactions
Repeated []
Canceled transaction version assignment.
version
Proto3 optional
Version of this message

EndOfEpochTransaction​

Set of operations run at the end of the epoch to close out the current epoch and start the next one.

Fields
transactions
Repeated []

EndOfEpochTransactionKind​

Operation run at the end of an epoch.

Fields
Union field kind can be only one of the following.
accumulator_root_create
Create the accumulator root object.
authenticator_state_create
Create and initialize the authenticator object used for zklogin.
authenticator_state_expire
Expire JWKs used for zklogin.
bridge_committee_init
Initialize the bridge committee.
bridge_state_create
Create and initialize the bridge object.
change_epoch
End the epoch and start the next one.
coin_registry_create
Create and initialize the Coin Registry object.
deny_list_state_create
Create and initialize the deny list object.
display_registry_create
Create and initialize the Display Registry object.
execution_time_observations
Execution time observations from the committee to preserve cross epoch
randomness_state_create
Create and initialize the randomness object.

ExecutionTimeObservation​

Fields
kind
Proto3 optional
move_entry_point
Proto3 optional
validator_observations
Repeated []

ExecutionTimeObservations​

Fields
observations
Repeated []
version
Proto3 optional
Version of this ExecutionTimeObservations

GasPayment​

Payment information for executing a transaction.

Fields
budget
Proto3 optional
Total budget willing to spend for the execution of a transaction.
objects
Repeated []
Set of gas objects to use for payment.
owner
Proto3 optional
Owner of the gas objects, either the transaction sender or a sponsor.
price
Proto3 optional
Gas unit price to use when charging for computation. Must be greater than or equal to the network's current RGP (reference gas price).

GenesisTransaction​

The genesis transaction.

Fields
objects
Repeated []
Set of genesis objects.

Jwk​

A JSON web key.

Struct that contains info for a JWK. A list of them for different kinds can be retrieved from the JWK endpoint (for example, &#lt;https://www.googleapis.com/oauth2/v3/certs>). The JWK is used to verify the JWT token.

Fields
alg
Proto3 optional
e
Proto3 optional
kty
Proto3 optional
n
Proto3 optional

JwkId​

Key to uniquely identify a JWK.

Fields
iss
Proto3 optional
The issuer or identity of the OIDC provider.
kid
Proto3 optional
A key ID used to uniquely identify a key from an OIDC provider.

MakeMoveVector​

Command to build a Move vector out of a set of individual elements.

Fields
element_type
Proto3 optional
Type of the individual elements. This is required to be set when the type can't be inferred, for example when the set of provided arguments are all pure input values.
elements
Repeated []
The set individual elements to build the vector with.

MergeCoins​

Command to merge multiple coins of the same type into a single coin.

Fields
coin
Proto3 optional
Coin to merge coins into.
coins_to_merge
Repeated []
Set of coins to merge into coin. All listed coins must be of the same type and be the same type as coin

MoveCall​

Command to call a Move function.

Functions that can be called by a MoveCall command are those that have a function signature that is either entry or public (which don't have a reference return type).

Fields
arguments
Repeated []
The arguments to the function.
function
Proto3 optional
The function to be called.
module
Proto3 optional
The specific module in the package containing the function.
package
Proto3 optional
The package containing the module and function.
type_arguments
Repeated []
The type arguments to the function.

ProgrammableTransaction​

A user transaction.

Contains a series of native commands and Move calls where the results of one command can be used in future commands.

Fields
commands
Repeated []
The commands to be executed sequentially. A failure in any command results in the failure of the entire transaction.
inputs
Repeated []
Input objects or primitive values.

Publish​

Command to publish a new Move package.

Fields
dependencies
Repeated []
Set of packages that the to-be published package depends on.
modules
Repeated []
The serialized Move modules.

RandomnessStateUpdate​

Randomness update.

Fields
epoch
Proto3 optional
Epoch of the randomness state update transaction.
random_bytes
Proto3 optional
Updated random bytes.
randomness_object_initial_shared_version
Proto3 optional
The initial version of the randomness object that it was shared at.
randomness_round
Proto3 optional
Randomness round of the update.

SplitCoins​

Command to split a single coin object into multiple coins.

Fields
amounts
Repeated []
The amounts to split off.
coin
Proto3 optional
The coin to split.

SystemPackage​

System package.

Fields
dependencies
Repeated []
Package dependencies.
modules
Repeated []
Move modules.
version
Proto3 optional
Version of the package.

Transaction​

A transaction.

Fields
bcs
Proto3 optional
This Transaction serialized as BCS.
digest
Proto3 optional
The digest of this Transaction.
expiration
Proto3 optional
gas_payment
Proto3 optional
kind
Proto3 optional
sender
Proto3 optional
version
Proto3 optional
Version of this Transaction.

TransactionExpiration​

A TTL for a transaction.

Fields
epoch
Proto3 optional
kind
Proto3 optional

TransactionKind​

Transaction type.

Fields
Union field kind can be only one of the following.
authenticator_state_update
Update set of valid JWKs used for zklogin.
change_epoch
System transaction used to end an epoch. The ChangeEpoch variant is now deprecated (but the ChangeEpoch struct is still used by EndOfEpochTransaction).
consensus_commit_prologue_v1
V1 consensus commit update.
consensus_commit_prologue_v2
V2 consensus commit update.
consensus_commit_prologue_v3
V3 consensus commit update.
consensus_commit_prologue_v4
V4 consensus commit update.
end_of_epoch
Set of operations to run at the end of the epoch to close out the current epoch and start the next one.
genesis
Transaction used to initialize the chain state. Only valid if in the genesis checkpoint (0) and if this is the very first transaction ever executed on the chain.
programmable_system_transaction
A system transaction comprised of a list of native commands and Move calls.
programmable_transaction
A user transaction comprised of a list of native commands and Move calls.
randomness_state_update
Randomness update.

TransferObjects​

Command to transfer ownership of a set of objects to an address.

Fields
address
Proto3 optional
The address to transfer ownership to.
objects
Repeated []
Set of objects to transfer.

Upgrade​

Command to upgrade an already published package.

Fields
dependencies
Repeated []
Set of packages that the to-be published package depends on.
modules
Repeated []
The serialized Move modules.
package
Proto3 optional
Package ID of the package to upgrade.
ticket
Proto3 optional
Ticket authorizing the upgrade.

ValidatorExecutionTimeObservation​

Fields
duration
Proto3 optional
Duration of an execution observation
validator
Proto3 optional
Bls12381 public key of the validator

VersionAssignment​

Object version assignment from consensus.

Fields
object_id
Proto3 optional
ObjectId of the object.
start_version
Proto3 optional
start version of the consensus stream for this object
version
Proto3 optional
Assigned version.

Enums

ExecutionTimeObservationKind

Enums
EXECUTION_TIME_OBSERVATION_KIND_UNKNOWN
MOVE_ENTRY_POINT
TRANSFER_OBJECTS
SPLIT_COINS
MERGE_COINS
PUBLISH
MAKE_MOVE_VECTOR
UPGRADE

TransactionExpirationKind

Enums
TRANSACTION_EXPIRATION_KIND_UNKNOWN
NONE
The transaction has no expiration.
EPOCH
Validators won't sign and execute transaction unless the expiration epoch is greater than or equal to the current epoch.

sui/rpc/v2beta2/balance_change.proto​

Messages

BalanceChange​

The delta, or change, in balance for an address for a particular Coin type.

Fields
address
Proto3 optional
The account address that is affected by this balance change event.
amount
Proto3 optional
The amount or change in balance.
coin_type
Proto3 optional
The Coin type of this balance change event.

sui/rpc/v2beta2/checkpoint_contents.proto​

Messages

CheckpointContents​

The committed to contents of a checkpoint.

Fields
bcs
Proto3 optional
This CheckpointContents serialized as BCS.
digest
Proto3 optional
The digest of this CheckpointContents.
transactions
Repeated []
Set of transactions committed to in this checkpoint.
version
Proto3 optional
Version of this CheckpointContents

CheckpointedTransactionInfo​

Transaction information committed to in a checkpoint.

Fields
effects
Proto3 optional
Digest of the effects.
signatures
Repeated []
Set of user signatures that authorized the transaction.
transaction
Proto3 optional
Digest of the transaction.

google/protobuf/timestamp.proto​

Messages

Timestamp​

A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. Restricting to that range ensures that conversion to and from RFC 3339 date strings is possible. See https://www.ietf.org/rfc/rfc3339.txt.

Examples​

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) &#lt;&#lt; 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); //

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
    .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping​

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is {year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (so up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required, though only UTC (as indicated by "Z") is presently supported.

For example, 2017-01-15T01:30:15.01Z encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, you can convert a Date object to this format using the standard toISOString() method. In Python, you can convert a standard datetime.datetime object to this format using strftime with the time format spec %Y-%m-%dT%H:%M:%S.%fZ. Likewise, in Java, you can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Fields
nanos
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nano values that count forward in time. Must be from 0 to 999,999,999 inclusive.
seconds
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

google/protobuf/empty.proto​

Messages

Empty​

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

google/protobuf/struct.proto​

Messages

ListValue​

ListValue is a wrapper around a repeated field of values.

The JSON representation for ListValue is JSON array.

Fields
values
Repeated []
Repeated field of dynamically typed values.

Struct​

Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.

The JSON representation for Struct is JSON object.

Fields
fields
Repeated []
Unordered map of dynamically typed values.

FieldsEntry​

Fields
key
value

Value​

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

The JSON representation for Value is JSON value.

Fields
Union field kind can be only one of the following.
bool_value
Represents a boolean value.
list_value
Represents a repeated Value.
null_value
Represents a null value.
number_value
Represents a double value.
string_value
Represents a string value.
struct_value
Represents a structured value.

Enums

NullValue

NullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null.
Enums
NULL_VALUE
Null value.

google/protobuf/any.proto​

Messages

Any​

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": &#lt;string>, "lastName": &#lt;string> }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

Fields
type_url
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
value
Must be a valid serialized protocol buffer of the above specified type.

google/protobuf/field_mask.proto​

Messages

FieldMask​

FieldMask represents a set of symbolic field paths, for example:

paths: "f.a" paths: "f.b.d"

Here f represents a field in some root message, a and b fields in the message found in f, and d a field found in the message in f.b.

Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below).

Field Masks in Projections​

When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows:

f { a : 22 b { d : 1 x : 2 } y : 13 } z: 8

The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output):

f { a : 22 b { d : 1 } }

A repeated field is not allowed except at the last position of a paths string.

If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified).

Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs.

Field Masks in Update Operations​

A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask.

If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a paths string.

If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource.

For example, given the target message:

f { b { d: 1 x: 2 } c: [1] }

And an update message:

f { b { d: 10 } c: [2] }

then if the field mask is:

paths: ["f.b", "f.c"]

then the result will be:

f { b { d: 10 x: 2 } c: [1, 2] }

An implementation may provide options to override this default behavior for repeated and message fields.

In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below.

If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not.

As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API.

Considerations for HTTP REST​

The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates).

JSON Encoding of Field Masks​

In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions.

As an example, consider the following message declarations:

message Profile { User user = 1; Photo photo = 2; } message User { string display_name = 1; string address = 2; }

In proto a field mask for Profile may look as such:

mask { paths: "user.display_name" paths: "photo" }

In JSON, the same mask is represented as below:

{ mask: "user.displayName,photo" }

Field Masks and Oneof Fields​

Field masks treat fields in oneofs just as regular fields. Consider the following message:

message SampleMessage { oneof test_oneof { string name = 4; SubMessage sub_message = 9; } }

The field mask can be:

mask { paths: "name" }

Or:

mask { paths: "sub_message" }

Note that oneof type names ("test_oneof" in this case) cannot be used in paths.

Field Mask Verification​

The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an INVALID_ARGUMENT error if any path is unmappable.

Fields
paths
Repeated []
The set of field mask paths.

google/protobuf/duration.proto​

Messages

Duration​

A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.

Examples​

Example 1: Compute Duration from two Timestamps in pseudo code.

Timestamp start = ...; Timestamp end = ...; Duration duration = ...;

duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;

if (duration.seconds &#lt; 0 && duration.nanos > 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos &#lt; 0) { duration.seconds -= 1; duration.nanos += 1000000000; }

Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

Timestamp start = ...; Duration duration = ...; Timestamp end = ...;

end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;

if (end.nanos &#lt; 0) { end.seconds -= 1; end.nanos += 1000000000; } else if (end.nanos >= 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }

Example 3: Compute Duration from datetime.timedelta in Python.

td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)

JSON Mapping​

In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

Fields
nanos
Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.
seconds
Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

google/rpc/error_details.proto​

Messages

BadRequest​

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Fields
field_violations
Repeated []
Describes all violations in a client request.

FieldViolation​

A message type used to describe a single bad request field.

Fields
description
A description of why the request element is bad.
field
A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: text,json message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto field could take one of the following values: * full_name for a violation in the full_name value * email_addresses[1].email for a violation in the email field of the first email_addresses message * email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message. In JSON, the same values are represented as: * fullName for a violation in the fullName value * emailAddresses[1].email for a violation in the email field of the first emailAddresses message * emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
localized_message
Provides a localized error message for field-level errors that is safe to return to the API consumer.
reason
The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

DebugInfo​

Describes additional debugging info.

Fields
detail
Additional debugging information provided by the server.
stack_entries
Repeated []
The stack trace entries indicating where the error occurred.

ErrorInfo​

Describes the cause of the error with structured details.

Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

This response indicates that the pubsub.googleapis.com API is not enabled.

Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
Fields
domain
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
metadata
Repeated []
Additional structured details about this error. Keys must match a regular expression of [a-z][a-zA-Z0-9-_]+ but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
reason
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

MetadataEntry​

Fields
key
value

Help​

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Fields
links
Repeated []
URL(s) pointing to additional information on handling the current error.

Describes a URL link.

Fields
description
Describes what the link offers.
url
The URL of the link.

LocalizedMessage​

Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

Fields
locale
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
message
The localized error message in the above locale.

PreconditionFailure​

Describes what preconditions have failed.

For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.

Fields
violations
Repeated []
Describes all precondition violations.

Violation​

A message type used to describe a single precondition failure.

Fields
description
A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".
subject
The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.
type
The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

QuotaFailure​

Describes how a quota check failed.

For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

Also see RetryInfo and Help types for other details about handling a quota failure.

Fields
violations
Repeated []
Describes all quota violations.

Violation​

A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

Fields
description
A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: "Service disabled" or "Daily Limit for read operations exceeded".
subject
The subject on which the quota check failed. For example, clientip:<ip address of client> or project:<Google developer project id>.

RequestInfo​

Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.

Fields
request_id
An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
serving_data
Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.

ResourceInfo​

Describes the resource that is being accessed.

Fields
description
Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the writer permission on the developer console project.
owner
The owner of the resource (optional). For example, user:<owner email> or project:<Google developer project id>.
resource_name
The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
resource_type
A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".

RetryInfo​

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.

It's always recommended that clients should use exponential backoff when retrying.

Clients should wait until retry_delay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retry_delay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

Fields
retry_delay
Clients should wait at least this long between retrying the same request.

google/rpc/status.proto​

Messages

Status​

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.

You can find out more about this error model and how to work with it in the API Design Guide.

Fields
code
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
details
Repeated []
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

Scalar Value Types​

double​

C++
double
C#
double
Go
float64
Java
double
PHP
float
Python
float
Ruby
Float

float​

C++
float
C#
float
Go
float32
Java
float
PHP
float
Python
float
Ruby
Float

int32​

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.

C++
int32
C#
int
Go
int32
Java
int
PHP
integer
Python
int
Ruby
Bignum or Fixnum (as required)

int64​

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.

C++
int64
C#
long
Go
int64
Java
long
PHP
integer/string
Python
int/long
Ruby
Bignum

uint32​

Uses variable-length encoding.

C++
uint32
C#
uint
Go
uint32
Java
int
PHP
integer
Python
int/long
Ruby
Bignum or Fixnum (as required)

uint64​

Uses variable-length encoding.

C++
uint64
C#
ulong
Go
uint64
Java
long
PHP
integer/string
Python
int/long
Ruby
Bignum or Fixnum (as required)

sint32​

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.

C++
int32
C#
int
Go
int32
Java
int
PHP
integer
Python
int
Ruby
Bignum or Fixnum (as required)

sint64​

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.

C++
int64
C#
long
Go
int64
Java
long
PHP
integer/string
Python
int/long
Ruby
Bignum

fixed32​

Always four bytes. More efficient than uint32 if values are often greater than 2^28.

C++
uint32
C#
uint
Go
uint32
Java
int
PHP
integer
Python
int
Ruby
Bignum or Fixnum (as required)

fixed64​

Always eight bytes. More efficient than uint64 if values are often greater than 2^56.

C++
uint64
C#
ulong
Go
uint64
Java
long
PHP
integer/string
Python
int/long
Ruby
Bignum

sfixed32​

Always four bytes.

C++
int32
C#
int
Go
int32
Java
int
PHP
integer
Python
int
Ruby
Bignum or Fixnum (as required)

sfixed64​

Always eight bytes.

C++
int64
C#
long
Go
int64
Java
long
PHP
integer/string
Python
int/long
Ruby
Bignum

bool​

C++
bool
C#
bool
Go
bool
Java
boolean
PHP
boolean
Python
boolean
Ruby
TrueClass/FalseClass

string​

A string must always contain UTF-8 encoded or 7-bit ASCII text.

C++
string
C#
string
Go
string
Java
String
PHP
string
Python
str/unicode
Ruby
String (UTF-8)

bytes​

May contain any arbitrary sequence of bytes.

C++
string
C#
ByteString
Go
[]byte
Java
ByteString
PHP
string
Python
str
Ruby
String (ASCII-8BIT)