Skip to main content

Full Node Protocol

The Full node protocol ...

sui.node.v2.proto​

BalanceChange​

Fields

address

Type
Address
Label
optional

coin_type

Type
TypeTag
Label
optional

amount

Type
I128
Label
optional

BalanceChanges​

Fields

balance_changes

Type
BalanceChange
Label
repeated

EffectsFinality​

Fields

certified

Type
ValidatorAggregatedSignature

checkpointed

Type
uint64

quorum_executed

Type
Empty

ExecuteTransactionOptions​

Fields

effects

Type
bool
Label
optional
Description
Include the sui.types.TransactionEffects message in the response.Defaults to false if not included

effects_bcs

Type
bool
Label
optional
Description
Include the TransactionEffects formatted as BCS in the response.Defaults to false if not included

events

Type
bool
Label
optional
Description
Include the sui.types.TransactionEvents message in the response.Defaults to false if not included

events_bcs

Type
bool
Label
optional
Description
Include the TransactionEvents formatted as BCS in the response.Defaults to false if not included

balance_changes

Type
bool
Label
optional
Description
Include the BalanceChanges in the response.Defaults to false if not included

ExecuteTransactionRequest​

Fields

transaction

Type
Transaction
Label
optional

transaction_bcs

Type
Bcs
Label
optional

signatures

Type
UserSignatures
Label
optional

signatures_bytes

Type
UserSignaturesBytes
Label
optional

options

Type
ExecuteTransactionOptions
Label
optional

ExecuteTransactionResponse​

Fields

finality

Type
EffectsFinality
Label
optional

effects

Type
TransactionEffects
Label
optional

effects_bcs

Type
Bcs
Label
optional

events

Type
TransactionEvents
Label
optional

events_bcs

Type
Bcs
Label
optional

balance_changes

Type
BalanceChanges
Label
optional

FullCheckpointObject​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional
Description
The digest of this object

object

Type
Object
Label
optional

object_bcs

Type
Bcs
Label
optional

FullCheckpointObjects​

Fields

objects

Type
FullCheckpointObject
Label
repeated

FullCheckpointTransaction​

Fields

digest

Type
Digest
Label
optional
Description
The digest of this transaction

transaction

Type
Transaction
Label
optional

transaction_bcs

Type
Bcs
Label
optional

effects

Type
TransactionEffects
Label
optional

effects_bcs

Type
Bcs
Label
optional

events

Type
TransactionEvents
Label
optional

events_bcs

Type
Bcs
Label
optional

input_objects

Type
FullCheckpointObjects
Label
optional

output_objects

Type
FullCheckpointObjects
Label
optional

GetCheckpointOptions​

Fields

summary

Type
bool
Label
optional
Description
Include the sui.types.CheckpointSummary in the response.Defaults to false if not included

summary_bcs

Type
bool
Label
optional
Description
Include the CheckpointSummary formatted as BCS in the response.Defaults to false if not included

signature

Type
bool
Label
optional
Description
Include the sui.types.ValidatorAggregatedSignature in the response.Defaults to false if not included

contents

Type
bool
Label
optional
Description
Include the sui.types.CheckpointContents message in the response.Defaults to false if not included

contents_bcs

Type
bool
Label
optional
Description
Include the CheckpointContents formatted as BCS in the response.Defaults to false if not included

GetCheckpointRequest​

Fields

sequence_number

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

options

Type
GetCheckpointOptions
Label
optional

GetCheckpointResponse​

Fields

sequence_number

Type
uint64
Label
optional
Description
The sequence number of this Checkpoint

digest

Type
Digest
Label
optional
Description
The digest of this Checkpoint's CheckpointSummary

summary

Type
CheckpointSummary
Label
optional

summary_bcs

Type
Bcs
Label
optional

signature

Type
ValidatorAggregatedSignature
Label
optional

contents

Type
CheckpointContents
Label
optional

contents_bcs

Type
Bcs
Label
optional

GetCommitteeRequest​

Fields

epoch

Type
uint64
Label
optional

GetCommitteeResponse​

Fields

committee

Type
ValidatorCommittee
Label
optional

GetFullCheckpointOptions​

Fields

summary

Type
bool
Label
optional
Description
Include the sui.types.CheckpointSummary in the response.Defaults to false if not included

summary_bcs

Type
bool
Label
optional
Description
Include the CheckpointSummary formatted as BCS in the response.Defaults to false if not included

signature

Type
bool
Label
optional
Description
Include the sui.types.ValidatorAggregatedSignature in the response.Defaults to false if not included

contents

Type
bool
Label
optional
Description
Include the sui.types.CheckpointContents message in the response.Defaults to false if not included

contents_bcs

Type
bool
Label
optional
Description
Include the CheckpointContents formatted as BCS in the response.Defaults to false if not included

transaction

Type
bool
Label
optional
Description
Include the sui.types.Transaction message in the response.Defaults to false if not included

transaction_bcs

Type
bool
Label
optional
Description
Include the Transaction formatted as BCS in the response.Defaults to false if not included

effects

Type
bool
Label
optional
Description
Include the sui.types.TransactionEffects message in the response.Defaults to false if not included

effects_bcs

Type
bool
Label
optional
Description
Include the TransactionEffects formatted as BCS in the response.Defaults to false if not included

events

Type
bool
Label
optional
Description
Include the sui.types.TransactionEvents message in the response.Defaults to false if not included

events_bcs

Type
bool
Label
optional
Description
Include the TransactionEvents formatted as BCS in the response.Defaults to false if not included

input_objects

Type
bool
Label
optional
Description
Include the input objects for transactions in the response.Defaults to false if not included

output_objects

Type
bool
Label
optional
Description
Include the output objects for transactions in the response.Defaults to false if not included

object

Type
bool
Label
optional
Description
Include the sui.types.Object message in the response.Defaults to false if not included

object_bcs

Type
bool
Label
optional
Description
Include the Object formatted as BCS in the response.Defaults to false if not included

GetFullCheckpointRequest​

Fields

sequence_number

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

options

Type
GetFullCheckpointOptions
Label
optional

GetFullCheckpointResponse​

Fields

sequence_number

Type
uint64
Label
optional
Description
The sequence number of this Checkpoint

digest

Type
Digest
Label
optional
Description
The digest of this Checkpoint's CheckpointSummary

summary

Type
CheckpointSummary
Label
optional

summary_bcs

Type
Bcs
Label
optional

signature

Type
ValidatorAggregatedSignature
Label
optional

contents

Type
CheckpointContents
Label
optional

contents_bcs

Type
Bcs
Label
optional

transactions

Type
FullCheckpointTransaction
Label
repeated

GetNodeInfoRequest​

GetNodeInfoResponse​

Fields

chain_id

Type
Digest
Label
optional
Description
The chain identifier of the chain that this Node is on

chain

Type
string
Label
optional
Description
Human readable name of the chain that this Node is on

epoch

Type
uint64
Label
optional
Description
Current epoch of the Node based on its highest executed checkpoint

checkpoint_height

Type
uint64
Label
optional
Description
Checkpoint height of the most recently executed checkpoint

timestamp

Type
Timestamp
Label
optional
Description
Unix timestamp of the most recently executed checkpoint

lowest_available_checkpoint

Type
uint64
Label
optional
Description
The lowest checkpoint for which checkpoints and transaction data is available

lowest_available_checkpoint_objects

Type
uint64
Label
optional
Description
The lowest checkpoint for which object data is available

software_version

Type
string
Label
optional

GetObjectOptions​

Fields

object

Type
bool
Label
optional
Description
Include the sui.types.Object message in the response.Defaults to false if not included

object_bcs

Type
bool
Label
optional
Description
Include the Object formatted as BCS in the response.Defaults to false if not included

GetObjectRequest​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

options

Type
GetObjectOptions
Label
optional

GetObjectResponse​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional
Description
The digest of this object

object

Type
Object
Label
optional

object_bcs

Type
Bcs
Label
optional

GetTransactionOptions​

Fields

transaction

Type
bool
Label
optional
Description
Include the sui.types.Transaction message in the response.Defaults to false if not included

transaction_bcs

Type
bool
Label
optional
Description
Include the Transaction formatted as BCS in the response.Defaults to false if not included

signatures

Type
bool
Label
optional
Description
Include the set of sui.types.UserSignature's in the response.Defaults to false if not included

signatures_bytes

Type
bool
Label
optional
Description
Include the set of UserSignature's encoded as bytes in the response.Defaults to false if not included

effects

Type
bool
Label
optional
Description
Include the sui.types.TransactionEffects message in the response.Defaults to false if not included

effects_bcs

Type
bool
Label
optional
Description
Include the TransactionEffects formatted as BCS in the response.Defaults to false if not included

events

Type
bool
Label
optional
Description
Include the sui.types.TransactionEvents message in the response.Defaults to false if not included

events_bcs

Type
bool
Label
optional
Description
Include the TransactionEvents formatted as BCS in the response.Defaults to false if not included

GetTransactionRequest​

Fields

digest

Type
Digest
Label
optional

options

Type
GetTransactionOptions
Label
optional

GetTransactionResponse​

Fields

digest

Type
Digest
Label
optional
Description
The digest of this transaction

transaction

Type
Transaction
Label
optional

transaction_bcs

Type
Bcs
Label
optional

signatures

Type
UserSignatures
Label
optional

signatures_bytes

Type
UserSignaturesBytes
Label
optional

effects

Type
TransactionEffects
Label
optional

effects_bcs

Type
Bcs
Label
optional

events

Type
TransactionEvents
Label
optional

events_bcs

Type
Bcs
Label
optional

checkpoint

Type
uint64
Label
optional

timestamp

Type
Timestamp
Label
optional

UserSignatures​

Fields

signatures

Type
UserSignature
Label
repeated

UserSignaturesBytes​

Fields

signatures

Type
bytes
Label
repeated

sui.types.proto​

ActiveJwk​

Fields

id

Type
JwkId
Label
optional

jwk

Type
Jwk
Label
optional

epoch

Type
uint64
Label
optional

Address​

Fields

address

Type
bytes
Label
optional

AddressDeniedForCoinError​

Fields

address

Type
Address
Label
optional

coin_type

Type
string
Label
optional

Argument​

Fields

gas

Type
Empty

input

Type
uint32

result

Type
uint32

nested_result

Type
NestedResult

AuthenticatorStateExpire​

Fields

min_epoch

Type
uint64
Label
optional

authenticator_object_initial_shared_version

Type
uint64
Label
optional

AuthenticatorStateUpdate​

Fields

epoch

Type
uint64
Label
optional

round

Type
uint64
Label
optional

new_active_jwks

Type
ActiveJwk
Label
repeated

authenticator_object_initial_shared_version

Type
uint64
Label
optional

Bcs​

Fields

bcs

Type
bytes
Label
optional

Bn254FieldElement​

Fields

element

Type
bytes
Label
optional

CancelledTransaction​

Fields

digest

Type
Digest
Label
optional

version_assignments

Type
VersionAssignment
Label
repeated

CancelledTransactions​

Fields

cancelled_transactions

Type
CancelledTransaction
Label
repeated

ChangeEpoch​

Fields

epoch

Type
uint64
Label
optional
Description
The next (to become) epoch ID.

protocol_version

Type
uint64
Label
optional
Description
The protocol version in effect in the new epoch.

storage_charge

Type
uint64
Label
optional
Description
The total amount of gas charged for storage during the epoch.

computation_charge

Type
uint64
Label
optional
Description
The total amount of gas charged for computation during the epoch.

storage_rebate

Type
uint64
Label
optional
Description
The amount of storage rebate refunded to the txn senders.

non_refundable_storage_fee

Type
uint64
Label
optional
Description
The non-refundable storage fee.

epoch_start_timestamp_ms

Type
uint64
Label
optional
Description
Unix timestamp when epoch started

system_packages

Type
SystemPackage
Label
repeated
Description
System packages (specifically framework and move stdlib) that are written before the newepoch starts. This tracks framework upgrades on chain. When executing the ChangeEpoch txn,the validator must write out the modules below. Modules are provided with the version theywill be upgraded to, their modules in serialized form (which include their package ID), anda list of their transitive dependencies.

ChangedObject​

Fields

object_id

Type
ObjectId
Label
optional

not_exist

Type
Empty

exist

Type
ObjectExist

removed

Type
Empty

object_write

Type
ObjectWrite

package_write

Type
PackageWrite

none

Type
Empty

created

Type
Empty

deleted

Type
Empty

CheckpointCommitment​

Fields

ecmh_live_object_set

Type
Digest

CheckpointContents​

Fields

v1

Type
V1

V1​

Fields

transactions

Type
CheckpointedTransactionInfo
Label
repeated

CheckpointSummary​

Fields

epoch

Type
uint64
Label
optional

sequence_number

Type
uint64
Label
optional

total_network_transactions

Type
uint64
Label
optional

content_digest

Type
Digest
Label
optional

previous_digest

Type
Digest
Label
optional

epoch_rolling_gas_cost_summary

Type
GasCostSummary
Label
optional

timestamp_ms

Type
uint64
Label
optional

commitments

Type
CheckpointCommitment
Label
repeated

end_of_epoch_data

Type
EndOfEpochData
Label
optional

version_specific_data

Type
bytes
Label
optional

CheckpointedTransactionInfo​

Fields

transaction

Type
Digest
Label
optional
Description
TransactionDigest

effects

Type
Digest
Label
optional
Description
EffectsDigest

signatures

Type
UserSignature
Label
repeated

CircomG1​

Fields

e0

Type
Bn254FieldElement
Label
optional

e1

Type
Bn254FieldElement
Label
optional

e2

Type
Bn254FieldElement
Label
optional

CircomG2​

Fields

e00

Type
Bn254FieldElement
Label
optional

e01

Type
Bn254FieldElement
Label
optional

e10

Type
Bn254FieldElement
Label
optional

e11

Type
Bn254FieldElement
Label
optional

e20

Type
Bn254FieldElement
Label
optional

e21

Type
Bn254FieldElement
Label
optional

Command​

Fields

move_call

Type
MoveCall

transfer_objects

Type
TransferObjects

split_coins

Type
SplitCoins

merge_coins

Type
MergeCoins

publish

Type
Publish

make_move_vector

Type
MakeMoveVector

upgrade

Type
Upgrade

CommandArgumentError​

Fields

argument

Type
uint32
Label
optional

type_mismatch

Type
Empty
Description
The type of the value does not match the expected type

invalid_bcs_bytes

Type
Empty
Description
The argument cannot be deserialized into a value of the specified type

invalid_usage_of_pure_argument

Type
Empty
Description
The argument cannot be instantiated from raw bytes

invalid_argument_to_private_entry_function

Type
Empty
Description
Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.

index_out_of_bounds

Type
uint32
Description
Out of bounds access to input or results

secondary_index_out_of_bounds

Type
NestedResult
Description
Out of bounds access to subresult

invalid_result_arity

Type
uint32
Description
Invalid usage of result. Expected a single result but found either no return value or multiple.

invalid_gas_coin_usage

Type
Empty
Description
Invalid usage of Gas coin. The Gas coin can only be used by-value with a TransferObjects command.

invalid_value_usage

Type
Empty
Description
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

Type
Empty
Description
Immutable objects cannot be passed by-value.

invalid_object_by_mut_ref

Type
Empty
Description
Immutable objects cannot be passed by mutable reference, &mut.

shared_object_operation_not_allowed

Type
Empty
Description
Shared object operations such a wrapping, freezing, or converting to owned are not allowed.

CongestedObjectsError​

Fields

congested_objects

Type
ObjectId
Label
repeated

ConsensusCommitPrologue​

Fields

epoch

Type
uint64
Label
optional

round

Type
uint64
Label
optional

commit_timestamp_ms

Type
uint64
Label
optional

consensus_commit_digest

Type
Digest
Label
optional

sub_dag_index

Type
uint64
Label
optional

consensus_determined_version_assignments

Type
ConsensusDeterminedVersionAssignments
Label
optional

ConsensusDeterminedVersionAssignments​

Fields

cancelled_transactions

Type
CancelledTransactions

Digest​

Fields

digest

Type
bytes
Label
optional

EndOfEpochData​

Fields

next_epoch_committee

Type
ValidatorCommitteeMember
Label
repeated

next_epoch_protocol_version

Type
uint64
Label
optional

epoch_commitments

Type
CheckpointCommitment
Label
repeated

EndOfEpochTransaction​

Fields

transactions

Type
EndOfEpochTransactionKind
Label
repeated

EndOfEpochTransactionKind​

Fields

change_epoch

Type
ChangeEpoch

authenticator_state_expire

Type
AuthenticatorStateExpire

authenticator_state_create

Type
Empty
Description
Use higher field numbers for kinds which happen infrequently

randomness_state_create

Type
Empty

deny_list_state_create

Type
Empty

bridge_state_create

Type
Digest

bridge_committee_init

Type
uint64

Event​

Fields

package_id

Type
ObjectId
Label
optional

module

Type
Identifier
Label
optional

sender

Type
Address
Label
optional

event_type

Type
StructTag
Label
optional

contents

Type
bytes
Label
optional

ExecutionStatus​

Fields

success

Type
bool
Label
optional

status

Type
FailureStatus
Label
optional

FailureStatus​

Fields

command

Type
uint64
Label
optional

insufficient_gas

Type
Empty
Description
Insufficient Gas

invalid_gas_object

Type
Empty
Description
Invalid Gas Object.

invariant_violation

Type
Empty
Description
Invariant Violation

feature_not_yet_supported

Type
Empty
Description
Attempted to used feature that is not supported yet

object_too_big

Type
SizeError
Description
Move object is larger than the maximum allowed size

package_too_big

Type
SizeError
Description
Package is larger than the maximum allowed size

circular_object_ownership

Type
ObjectId
Description
Circular Object Ownership

insufficient_coin_balance

Type
Empty
Description
Coin errors Insufficient coin balance for requested operation

coin_balance_overflow

Type
Empty
Description
Coin balance overflowed an u64

publish_error_non_zero_address

Type
Empty
Description
Publish/Upgrade errors Publish Error, Non-zero Address. The modules in the package must have their self-addresses set to zero.

sui_move_verification_error

Type
Empty
Description
Sui Move Bytecode Verification Error.

move_primitive_runtime_error

Type
MoveError
Description
MoveVm Errors Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, etc."

move_abort

Type
MoveError
Description
Move runtime abort

vm_verification_or_deserialization_error

Type
Empty
Description
Bytecode verification error.

vm_invariant_violation

Type
Empty
Description
MoveVm invariant violation

function_not_found

Type
Empty
Description
Programmable Transaction Errors Function not found

arity_mismatch

Type
Empty
Description
Arity mismatch for Move function. The number of arguments does not match the number of parameters

type_arity_mismatch

Type
Empty
Description
Type arity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.

non_entry_function_invoked

Type
Empty
Description
Non Entry Function Invoked. Move Call must start with an entry function.

command_argument_error

Type
CommandArgumentError
Description
Invalid command argument

type_argument_error

Type
TypeArgumentError
Description
Type argument error

unused_value_without_drop

Type
NestedResult
Description
Unused result without the drop ability.

invalid_public_function_return_type

Type
uint32
Description
Invalid public Move function signature. Unsupported return type for return value

invalid_transfer_object

Type
Empty
Description
Invalid Transfer Object, object does not have public transfer.

effects_too_large

Type
SizeError
Description
Post-execution errors Effects from the transaction are too large

publish_upgrade_missing_dependency

Type
Empty
Description
Publish or Upgrade is missing dependency

publish_upgrade_dependency_downgrade

Type
Empty
Description
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

Type
PackageUpgradeError
Description
Invalid package upgrade

written_objects_too_large

Type
SizeError
Description
Indicates the transaction tried to write objects too large to storage

certificate_denied

Type
Empty
Description
Certificate is on the deny list

sui_move_verification_timedout

Type
Empty
Description
Sui Move Bytecode verification timed out.

shared_object_operation_not_allowed

Type
Empty
Description
The requested shared object operation is not allowed

input_object_deleted

Type
Empty
Description
Requested shared object has been deleted

execution_cancelled_due_to_shared_object_congestion

Type
CongestedObjectsError
Description
Certificate is cancelled due to congestion on shared objects

address_denied_for_coin

Type
AddressDeniedForCoinError
Description
Address is denied for this coin type

coin_type_global_pause

Type
string
Description
Coin type is globally paused for use

execution_cancelled_due_to_randomness_unavailable

Type
Empty
Description
Certificate is cancelled because randomness could not be generated this epoch

GasCostSummary​

Fields

computation_cost

Type
uint64
Label
optional

storage_cost

Type
uint64
Label
optional

storage_rebate

Type
uint64
Label
optional

non_refundable_storage_fee

Type
uint64
Label
optional

GasPayment​

Fields

objects

Type
ObjectReference
Label
repeated

owner

Type
Address
Label
optional

price

Type
uint64
Label
optional

budget

Type
uint64
Label
optional

GenesisObject​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

owner

Type
Owner
Label
optional

object

Type
ObjectData
Label
optional

GenesisTransaction​

Fields

objects

Type
GenesisObject
Label
repeated

I128​

Little-endian encoded i128

Fields

bytes

Type
bytes
Label
optional

Identifier​

Fields

identifier

Type
string
Label
optional

Input​

Fields

pure

Type
bytes

immutable_or_owned

Type
ObjectReference

shared

Type
SharedObjectInput

receiving

Type
ObjectReference

Jwk​

Fields

kty

Type
string
Label
optional
Description
Key type parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.1

e

Type
string
Label
optional
Description
RSA public exponent, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3

n

Type
string
Label
optional
Description
RSA modulus, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3

alg

Type
string
Label
optional
Description
Algorithm parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.4

JwkId​

Fields

iss

Type
string
Label
optional

kid

Type
string
Label
optional

MakeMoveVector​

Fields

element_type

Type
TypeTag
Label
optional

elements

Type
Argument
Label
repeated

MergeCoins​

Fields

coin

Type
Argument
Label
optional

coins_to_merge

Type
Argument
Label
repeated

ModifiedAtVersion​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

MoveCall​

Fields

package

Type
ObjectId
Label
optional

module

Type
Identifier
Label
optional

function

Type
Identifier
Label
optional

type_arguments

Type
TypeTag
Label
repeated

arguments

Type
Argument
Label
repeated

MoveError​

Fields

location

Type
MoveLocation
Label
optional

abort_code

Type
uint64
Label
optional

MoveField​

Fields

name

Type
Identifier
Label
optional

value

Type
MoveValue
Label
optional

MoveLocation​

Fields

package

Type
ObjectId
Label
optional

module

Type
Identifier
Label
optional

function

Type
uint32
Label
optional

instruction

Type
uint32
Label
optional

function_name

Type
Identifier
Label
optional

MoveModule​

Fields

name

Type
Identifier
Label
optional

contents

Type
bytes
Label
optional

MovePackage​

Fields

id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

modules

Type
MoveModule
Label
repeated

type_origin_table

Type
TypeOrigin
Label
repeated

linkage_table

Type
UpgradeInfo
Label
repeated

MoveStruct​

Fields

object_id

Type
ObjectId
Label
optional

object_type

Type
StructTag
Label
optional

has_public_transfer

Type
bool
Label
optional

version

Type
uint64
Label
optional

contents

Type
bytes
Label
optional

MoveStructValue​

Fields

struct_type

Type
StructTag
Label
optional

fields

Type
MoveField
Label
repeated

MoveValue​

Fields

bool

Type
bool

u8

Type
uint32

u16

Type
uint32

u32

Type
uint32

u64

Type
uint64

u128

Type
U128

u256

Type
U256

address

Type
Address

vector

Type
MoveVector

struct

Type
MoveStructValue

signer

Type
Address

variant

Type
MoveVariant

MoveVariant​

Fields

enum_type

Type
StructTag
Label
optional

variant_name

Type
Identifier
Label
optional

tag

Type
uint32
Label
optional

fields

Type
MoveField
Label
repeated

MoveVector​

Fields

values

Type
MoveValue
Label
repeated

MultisigAggregatedSignature​

Fields

signatures

Type
MultisigMemberSignature
Label
repeated

bitmap

Type
uint32
Label
optional

legacy_bitmap

Type
RoaringBitmap
Label
optional

committee

Type
MultisigCommittee
Label
optional

MultisigCommittee​

Fields

members

Type
MultisigMember
Label
repeated

threshold

Type
uint32
Label
optional

MultisigMember​

Fields

public_key

Type
MultisigMemberPublicKey
Label
optional

weight

Type
uint32
Label
optional

MultisigMemberPublicKey​

Fields

ed25519

Type
bytes

secp256k1

Type
bytes

secp256r1

Type
bytes

zklogin

Type
ZkLoginPublicIdentifier

MultisigMemberSignature​

Fields

ed25519

Type
bytes

secp256k1

Type
bytes

secp256r1

Type
bytes

zklogin

Type
ZkLoginAuthenticator

NestedResult​

Fields

result

Type
uint32
Label
optional

subresult

Type
uint32
Label
optional

Object​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

owner

Type
Owner
Label
optional

object

Type
ObjectData
Label
optional

previous_transaction

Type
Digest
Label
optional

storage_rebate

Type
uint64
Label
optional

ObjectData​

Fields

struct

Type
MoveStruct

package

Type
MovePackage

ObjectExist​

Fields

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

owner

Type
Owner
Label
optional

ObjectId​

Fields

object_id

Type
bytes
Label
optional

ObjectReference​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

ObjectReferenceWithOwner​

Fields

reference

Type
ObjectReference
Label
optional

owner

Type
Owner
Label
optional

ObjectWrite​

Fields

digest

Type
Digest
Label
optional

owner

Type
Owner
Label
optional

Owner​

Fields

address

Type
Address

object

Type
ObjectId

shared

Type
uint64

immutable

Type
Empty

PackageIdDoesNotMatch​

Fields

package_id

Type
ObjectId
Label
optional

object_id

Type
ObjectId
Label
optional

PackageUpgradeError​

Fields

unable_to_fetch_package

Type
ObjectId

not_a_package

Type
ObjectId

incompatible_upgrade

Type
Empty

digets_does_not_match

Type
Digest

unknown_upgrade_policy

Type
uint32

package_id_does_not_match

Type
PackageIdDoesNotMatch

PackageWrite​

Fields

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

PasskeyAuthenticator​

Fields

authenticator_data

Type
bytes
Label
optional

client_data_json

Type
string
Label
optional

signature

Type
SimpleSignature
Label
optional

ProgrammableTransaction​

Fields

inputs

Type
Input
Label
repeated

commands

Type
Command
Label
repeated

Publish​

Fields

modules

Type
bytes
Label
repeated

dependencies

Type
ObjectId
Label
repeated

RandomnessStateUpdate​

Fields

epoch

Type
uint64
Label
optional

randomness_round

Type
uint64
Label
optional

random_bytes

Type
bytes
Label
optional

randomness_object_initial_shared_version

Type
uint64
Label
optional

ReadOnlyRoot​

Fields

version

Type
uint64
Label
optional

digest

Type
Digest
Label
optional

RoaringBitmap​

Fields

bitmap

Type
bytes
Label
optional

SharedObjectInput​

Fields

object_id

Type
ObjectId
Label
optional

initial_shared_version

Type
uint64
Label
optional

mutable

Type
bool
Label
optional

SimpleSignature​

Fields

scheme

Type
SignatureScheme
Label
optional

signature

Type
bytes
Label
optional

public_key

Type
bytes
Label
optional

SizeError​

Fields

size

Type
uint64
Label
optional

max_size

Type
uint64
Label
optional

SplitCoins​

Fields

coin

Type
Argument
Label
optional

amounts

Type
Argument
Label
repeated

StructTag​

Fields

address

Type
Address
Label
optional

module

Type
Identifier
Label
optional

name

Type
Identifier
Label
optional

type_parameters

Type
TypeTag
Label
repeated

SystemPackage​

Fields

version

Type
uint64
Label
optional

modules

Type
bytes
Label
repeated

dependencies

Type
ObjectId
Label
repeated

Transaction​

Fields

v1

Type
TransactionV1

TransactionV1​

Fields

kind

Type
TransactionKind
Label
optional

sender

Type
Address
Label
optional

gas_payment

Type
GasPayment
Label
optional

expiration

Type
TransactionExpiration
Label
optional

TransactionEffects​

Fields

v1

Type
TransactionEffectsV1

v2

Type
TransactionEffectsV2

TransactionEffectsV1​

Fields

status

Type
ExecutionStatus
Label
optional
Description
The status of the execution

epoch

Type
uint64
Label
optional
Description
The epoch when this transaction was executed.

gas_used

Type
GasCostSummary
Label
optional

modified_at_versions

Type
ModifiedAtVersion
Label
repeated
Description
The version that every modified (mutated or deleted) object had before it was modified by this transaction.

shared_objects

Type
ObjectReference
Label
repeated
Description
The object references of the shared objects used in this transaction. Empty if no shared objects were used.

transaction_digest

Type
Digest
Label
optional
Description
The transaction digest

created

Type
ObjectReferenceWithOwner
Label
repeated
Description
ObjectReference and owner of new objects created.

mutated

Type
ObjectReferenceWithOwner
Label
repeated
Description
ObjectReference and owner of mutated objects, including gas object.

unwrapped

Type
ObjectReferenceWithOwner
Label
repeated
Description
ObjectReference and owner of objects that are unwrapped in this transaction. Unwrapped objects are objects that were wrapped into other objects in the past, and just got extracted out.

deleted

Type
ObjectReference
Label
repeated
Description
Object Refs of objects now deleted (the new refs).

unwrapped_then_deleted

Type
ObjectReference
Label
repeated
Description
Object refs of objects previously wrapped in other objects but now deleted.

wrapped

Type
ObjectReference
Label
repeated
Description
Object refs of objects now wrapped in other objects.

gas_object

Type
ObjectReferenceWithOwner
Label
optional
Description
The updated gas object reference. Have a dedicated field for convenient access. It's also included in mutated.

events_digest

Type
Digest
Label
optional
Description
The digest of the events emitted during execution, can be None if the transaction does not emit any event.

dependencies

Type
Digest
Label
repeated
Description
The set of transaction digests this transaction depends on.

TransactionEffectsV2​

Fields

status

Type
ExecutionStatus
Label
optional
Description
The status of the execution

epoch

Type
uint64
Label
optional
Description
The epoch when this transaction was executed.

gas_used

Type
GasCostSummary
Label
optional

transaction_digest

Type
Digest
Label
optional
Description
The transaction digest

gas_object_index

Type
uint32
Label
optional
Description
The updated gas object reference, as an index into the changed_objects vector. Having a dedicated field for convenient access. System transaction that don't require gas will leave this as None.

events_digest

Type
Digest
Label
optional
Description
The digest of the events emitted during execution, can be None if the transaction does not emit any event.

dependencies

Type
Digest
Label
repeated
Description
The set of transaction digests this transaction depends on.

lamport_version

Type
uint64
Label
optional
Description
The version number of all the written Move objects by this transaction.

changed_objects

Type
ChangedObject
Label
repeated
Description
Objects whose state are changed in the object store.

unchanged_shared_objects

Type
UnchangedSharedObject
Label
repeated
Description
Shared objects that are not mutated in this transaction. Unlike owned objects, read-only shared 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.

auxiliary_data_digest

Type
Digest
Label
optional
Description
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.

TransactionEvents​

Fields

events

Type
Event
Label
repeated

TransactionExpiration​

Fields

none

Type
Empty

epoch

Type
uint64

TransactionKind​

Fields

programmable_transaction

Type
ProgrammableTransaction

change_epoch

Type
ChangeEpoch

genesis

Type
GenesisTransaction

consensus_commit_prologue_v1

Type
ConsensusCommitPrologue

authenticator_state_update

Type
AuthenticatorStateUpdate

end_of_epoch

Type
EndOfEpochTransaction

randomness_state_update

Type
RandomnessStateUpdate

consensus_commit_prologue_v2

Type
ConsensusCommitPrologue

consensus_commit_prologue_v3

Type
ConsensusCommitPrologue

TransferObjects​

Fields

objects

Type
Argument
Label
repeated

address

Type
Argument
Label
optional

TypeArgumentError​

Fields

type_argument

Type
uint32
Label
optional

type_not_found

Type
Empty

constraint_not_satisfied

Type
Empty

TypeOrigin​

Fields

module_name

Type
Identifier
Label
optional

struct_name

Type
Identifier
Label
optional

package_id

Type
ObjectId
Label
optional

TypeTag​

Fields

u8

Type
Empty

u16

Type
Empty

u32

Type
Empty

u64

Type
Empty

u128

Type
Empty

u256

Type
Empty

bool

Type
Empty

address

Type
Empty

signer

Type
Empty

vector

Type
TypeTag

struct

Type
StructTag

U128​

Little-endian encoded u128

Fields

bytes

Type
bytes
Label
optional

U256​

Little-endian encoded u256

Fields

bytes

Type
bytes
Label
optional

UnchangedSharedObject​

Fields

object_id

Type
ObjectId
Label
optional

read_only_root

Type
ReadOnlyRoot

mutate_deleted

Type
uint64

read_deleted

Type
uint64

cancelled

Type
uint64

per_epoch_config

Type
Empty

Upgrade​

Fields

modules

Type
bytes
Label
repeated

dependencies

Type
ObjectId
Label
repeated

package

Type
ObjectId
Label
optional

ticket

Type
Argument
Label
optional

UpgradeInfo​

Fields

original_id

Type
ObjectId
Label
optional

upgraded_id

Type
ObjectId
Label
optional

upgraded_version

Type
uint64
Label
optional

UserSignature​

Fields

simple

Type
SimpleSignature

multisig

Type
MultisigAggregatedSignature

zklogin

Type
ZkLoginAuthenticator

passkey

Type
PasskeyAuthenticator

ValidatorAggregatedSignature​

Fields

epoch

Type
uint64
Label
optional

signature

Type
bytes
Label
optional

bitmap

Type
RoaringBitmap
Label
optional

ValidatorCommittee​

Fields

epoch

Type
uint64
Label
optional

members

Type
ValidatorCommitteeMember
Label
repeated

ValidatorCommitteeMember​

Fields

public_key

Type
bytes
Label
optional

stake

Type
uint64
Label
optional

VersionAssignment​

Fields

object_id

Type
ObjectId
Label
optional

version

Type
uint64
Label
optional

ZkLoginAuthenticator​

Fields

inputs

Type
ZkLoginInputs
Label
optional

max_epoch

Type
uint64
Label
optional

signature

Type
SimpleSignature
Label
optional

ZkLoginClaim​

Fields

value

Type
string
Label
optional

index_mod_4

Type
uint32
Label
optional

ZkLoginInputs​

Fields

proof_points

Type
ZkLoginProof
Label
optional

iss_base64_details

Type
ZkLoginClaim
Label
optional

header_base64

Type
string
Label
optional

address_seed

Type
Bn254FieldElement
Label
optional

ZkLoginProof​

Fields

a

Type
CircomG1
Label
optional

b

Type
CircomG2
Label
optional

c

Type
CircomG1
Label
optional

ZkLoginPublicIdentifier​

Fields

iss

Type
string
Label
optional

address_seed

Type
Bn254FieldElement
Label
optional

google/protobuf/empty.proto​

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/timestamp.proto​

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. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. 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 (i.e. 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, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString] method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Fields

seconds

Type
int64
Description
Represents seconds of UTC time since Unix epoch1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to9999-12-31T23:59:59Z inclusive.

nanos

Type
int32
Description
Non-negative fractions of a second at nanosecond resolution. Negativesecond values with fractions must still have non-negative nanos valuesthat count forward in time. Must be from 0 to 999,999,999inclusive.

Scalar Value Types​

double​

C++JavaPythonGoC#PHPRuby
doubledoublefloatfloat64doublefloatFloat

float​

C++JavaPythonGoC#PHPRuby
floatfloatfloatfloat32floatfloatFloat

int32​

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

C++JavaPythonGoC#PHPRuby
int32intintint32intintegerBignum 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++JavaPythonGoC#PHPRuby
int64longint/longint64longinteger/stringBignum

uint32​

Uses variable-length encoding.

C++JavaPythonGoC#PHPRuby
uint32intint/longuint32uintintegerBignum or Fixnum (as required)

uint64​

Uses variable-length encoding.

C++JavaPythonGoC#PHPRuby
uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)

sint32​

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

C++JavaPythonGoC#PHPRuby
int32intintint32intintegerBignum or Fixnum (as required)

sint64​

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

C++JavaPythonGoC#PHPRuby
int64longint/longint64longinteger/stringBignum

fixed32​

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

C++JavaPythonGoC#PHPRuby
uint32intintuint32uintintegerBignum or Fixnum (as required)

fixed64​

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

C++JavaPythonGoC#PHPRuby
uint64longint/longuint64ulonginteger/stringBignum

sfixed32​

Always four bytes.

C++JavaPythonGoC#PHPRuby
int32intintint32intintegerBignum or Fixnum (as required)

sfixed64​

Always eight bytes.

C++JavaPythonGoC#PHPRuby
int64longint/longint64longinteger/stringBignum

bool​

C++JavaPythonGoC#PHPRuby
boolbooleanbooleanboolboolbooleanTrueClass/FalseClass

string​

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

C++JavaPythonGoC#PHPRuby
stringStringstr/unicodestringstringstringString (UTF-8)

bytes​

May contain any arbitrary sequence of bytes.

C++JavaPythonGoC#PHPRuby
stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)