Sui Full Node gRPC Message Definitions
This page lists all message definitions for the Sui Full Node gRPC API. Each message shows its fields, types, labels (optional, repeated), and descriptions. For union fields (oneof), the available variants are listed under the union name.
Messages with more than 4 non-oneof fields show only a summary here. Use the View all fields link for the complete field-level reference, including any hidden union variants.
See also: Enum and Scalar Type Definitions | Methods | Proto source files
sui/rpc/v2/balance_change.proto
BalanceChange
The delta, or change, in balance for an address for a particular Coin type.
sui/rpc/v2/checkpoint.proto
Checkpoint
contents
CheckpointContents (optional) — The
CheckpointContents for this checkpoint.digest
string (optional) — The digest of this Checkpoint's CheckpointSummary.
objects
ObjectSet (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
uint64 (optional) — The height of this checkpoint.
... and 3 more fields. View all fields
sui/rpc/v2/epoch.proto
Epoch
committee
ValidatorCommittee (optional) — The committee governing this epoch.
end
Timestamp (optional)
epoch
uint64 (optional)
first_checkpoint
uint64 (optional)
... and 5 more fields. View all fields
sui/rpc/v2/move_package.proto
DatatypeDescriptor
Describes a Move Datatype.
abilities
Ability (repeated) — This type's abilities
defining_id
string (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
FieldDescriptor (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
DatatypeKind (optional) — Indicates whether this datatype is a 'STRUCT' or an 'ENUM'
... and 5 more fields. View all fields
FieldDescriptor
Descriptor of a field that belongs to a struct or enum variant
name
string (optional) — Name of the field
position
uint32 (optional) — Order or position of the field in the struct or enum variant definition.
type
OpenSignatureBody (optional) — The type of the field
FunctionDescriptor
Descriptor of a Move function
is_entry
bool (optional) — Whether the function is marked
entry or not.name
string (optional) — Name of the function
parameters
OpenSignature (repeated) — Formal parameter types.
returns
OpenSignature (repeated) — Return types.
... and 2 more fields. View all fields
Linkage
Upgraded package info for the linkage table.
Module
A Move Module.
contents
bytes (optional) — Serialized bytecode of the module.
datatypes
DatatypeDescriptor (repeated) — List of DataTypes defined by this module.
functions
FunctionDescriptor (repeated) — List of Functions defined by this module.
name
string (optional) — Name of this module.
OpenSignature
Representation of a type signature that could appear as a function parameter or return value.
OpenSignatureBody
Representation of a type signature that could appear as a field type for a struct or enum
Package
A Move Package
linkage
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
Module (repeated) — The modules defined by this package
original_id
string (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
string (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.... and 2 more fields. View all fields
TypeOrigin
Identifies a struct and the module it was defined in.
TypeParameter
A generic type parameter used in the declaration of a struct or enum.
VariantDescriptor
Descriptor of an enum variant
fields
FieldDescriptor (repeated) — Set of fields defined by this variant.
name
string (optional) — Name of the variant
position
uint32 (optional) — Order or position of the variant in the enum definition.
sui/rpc/v2/query_options.proto
LedgerPosition
A point in ledger order: the boundary between the items whose keys sort below this position and the items whose keys sort at or above it.
QueryEnd
Marker for the final frame of a successful query stream. Every successful
stream sets QueryEnd on exactly one frame, after which no further frames
are sent. That frame always carries the final watermark. For ItemLimit, it
also carries the final matching item; for every other reason it carries no
item. A ScanLimit terminal watermark may repeat the previous frame's cursor
when its authoritative scan frontier was already emitted; this does not
repeat an item.
reason
QueryEndReason (optional) — Reason this response stopped.
QueryOptions
Cursor-bounded query options.
after
bytes (optional) — Opaque exclusive lower bound. Results must be strictly after this cursor in canonical ledger order.
before
bytes (optional) — Opaque exclusive upper bound. Results must be strictly before this cursor in canonical ledger order.
limit
uint32 (optional) — The maximum number of items to return. Each method applies its own default and maximum. QueryEnd does not count against this limit.
ordering
Ordering (optional) — Ordering for returned results. Defaults to ASCENDING. Ordering only controls the order of results within the bounded interval; cursor bounds keep the same meaning for ascending and descending reads.
Watermark
Progress of a scan, carried on every response frame, whether or not the frame delivers a matching item. Watermarks never regress in the requested ordering, but consecutive frames may carry the same watermark when additional work does not advance the safe resume frontier.
checkpoint
uint64 (optional) — The inclusive boundary checkpoint that the scan has fully covered within the request's effective interval, in the request's ordering direction: an ascending scan has emitted every matching item in the interval at checkpoints
<= checkpoint (strictly greater ones may still hold matches); a descending scan has emitted every matching item in the interval at checkpoints >= checkpoint. This boundary never regresses in the scan direction, but it may repeat while the cursor advances. Unset until the scan's first checkpoint is fully covered. For example, a scan resumed from a cursor that lands mid-checkpoint leaves this unset until the next checkpoint boundary in the scan direction is fully covered. A watermark still has a valid resume cursor while this field is unset.cursor
bytes (optional) — Opaque cursor at the resume point. Set on every watermark. Use as
options.after (ascending) or options.before (descending) on the next request to resume from here. The most recently received cursor is always the safe resume point. Pass cursors back unchanged; never compare or inspect them. Cursors that differ can name the same point, and their encoding may change.cursor_position
LedgerPosition (optional) — The resume point in ledger coordinates. Set on every watermark by servers that support it. Ascending, every match from the request's start up to (excluding)
cursor_position has been delivered. Descending, every match from cursor_position up to (excluding) the request's end has been delivered. On a frame that carries an item, ascending, it is the boundary just past the item, so it is not the item's own key: it is that key with its finest index incremented (event_index for events, transaction_index for transactions, checkpoint for checkpoints). Descending, it is the boundary just before the item, which is the item's key. It never moves before the request's start (ascending) or past its end (descending), so an ascending request that starts beyond what the server has indexed gets its start echoed back: the resume point says where the client is, not where the ledger is. cursor may then name an earlier point; bounds intersect, so resuming with both starts at cursor_position.sui/rpc/v2/transaction_execution_service.proto
CommandOutput
CommandResult
An intermediate result/output from the execution of a single command
ExecuteTransactionRequest
read_mask
FieldMask (optional) — Mask specifying which fields to read. If no mask is specified, defaults to
effects.status,checkpoint.signatures
UserSignature (repeated) — Set of
UserSignatures authorizing the execution of the provided transaction.transaction
Transaction (optional) — The transaction to execute.
ExecuteTransactionResponse
Response message for NodeService.ExecuteTransaction.
transaction
ExecutedTransaction (optional)
SimulateTransactionRequest
checks
TransactionChecks (optional) — Specify whether checks should be ENABLED (default) or DISABLED while executing the transaction
do_gas_selection
bool (optional) — Perform gas selection based on a budget estimation and include the selected gas payment and budget in the response. If selection fails because the gas owner lacks enough SUI to cover the budget, the returned error carries a
google.rpc.ErrorInfo with reason INSUFFICIENT_GAS_BALANCE, or TRANSACTION_EXECUTION_FAILED if the transaction also fails while estimating the budget (see ErrorReason). This option will be ignored if checks is DISABLED.read_mask
FieldMask (optional) — Mask specifying which fields to read.
transaction
Transaction (optional)
SimulateTransactionResponse
command_outputs
CommandResult (repeated)
suggested_gas_price
uint64 (optional) — A suggested gas price to use, that is above RGP, in order to provide a better chance of the transaction being included in the presence of congested objects.
transaction
ExecutedTransaction (optional)
sui/rpc/v2/effects.proto
AccumulatorWrite
accumulator_type
string (optional)
address
string (optional)
event_digest_value
EventDigestEntry (repeated) — Set when the accumulator value is an event digest list (value_kind = EVENT_DIGEST). Contains a non-empty list of (event_index, digest) pairs representing authenticated event stream entries within a transaction.
integer_tuple
uint64 (repeated) — Set, with len 2, when the accumulator value is an integer tuple (value_kind = INTEGER_TUPLE).
... and 3 more fields. View all fields
ChangedObject
Input/output state of an object that was changed during execution.
accumulator_write
AccumulatorWrite (optional) — The contents of the accumulator write when
output_state is OUTPUT_OBJECT_STATE_ACCUMULATOR_WRITEid_operation
IdOperation (optional) — What happened to an
ObjectId during execution.input_digest
string (optional) — Digest of the object before this transaction executed.
input_owner
Owner (optional) — Owner of the object before this transaction executed.
... and 8 more fields. View all fields
EventDigestEntry
An entry in an event digest accumulator value.
TransactionEffects
The effects of executing a transaction.
auxiliary_data_digest
string (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
Bcs (optional) — This TransactionEffects serialized as BCS.
changed_objects
ChangedObject (repeated) — Objects whose state are changed by this transaction.
dependencies
string (repeated) — The set of transaction digests this transaction depends on.
... and 11 more fields. View all fields
UnchangedConsensusObject
A consensus object that wasn't changed during execution.
digest
string (optional) — Digest of the consensus object.
kind
UnchangedConsensusObjectKind (optional)
object_id
string (optional) — ObjectId of the consensus object.
object_type
string (optional) — Type information is not provided by the effects structure but is instead provided by an indexing layer
... and 1 more fields. View all fields
sui/rpc/v2/protocol_config.proto
ProtocolConfig
attributes
AttributesEntry (repeated) — Deprecated in favor of the lossless
configs field.configs
ConfigsEntry (repeated)
feature_flags
FeatureFlagsEntry (repeated) — Deprecated in favor of the lossless
configs field.protocol_version
uint64 (optional)
sui/rpc/v2/subscription_service.proto
SubscribeCheckpointsRequest
Request message for SubscriptionService.SubscribeCheckpoints.
filter
TransactionFilter (optional) — Optional. DNF filter over indexed transaction dimensions. A checkpoint matches if any transaction it contains satisfies the filter. If absent, every checkpoint is streamed.
read_mask
FieldMask (optional) — Optional. Mask for specifying which parts of the Checkpoint should be returned (e.g. summary, contents, signatures).
cursor is always populated and is not subject to the mask.SubscribeCheckpointsResponse
Response message for SubscriptionService.SubscribeCheckpoints.
checkpoint
Checkpoint (optional) — The matching checkpoint. Unset when this frame only advances the cursor past non-matching checkpoints.
cursor
uint64 (optional) — Required. The checkpoint sequence number the stream has fully covered, inclusive: every matching checkpoint from the stream's start position through
cursor has been delivered. Present on every frame and advances monotonically.SubscribeEventsRequest
Request message for SubscriptionService.SubscribeEvents.
filter
EventFilter (optional) — Optional. DNF filter over indexed dimensions. If absent, every event is streamed.
read_mask
FieldMask (optional) — Optional. Mask for specifying which parts of the Event should be returned.
SubscribeEventsResponse
Response message for SubscriptionService.SubscribeEvents.
Mirrors ListEventsResponse, except there is no end field: a subscription
stream has no successful end.
event
Event (optional) — One matching event. Its ledger position -- containing checkpoint, emitting transaction digest and offset, and index within that transaction's event list -- is reported by the corresponding fields on
Event.watermark
Watermark (optional) — Progress watermark as of this frame. Present on every frame.
SubscribeTransactionsRequest
Request message for SubscriptionService.SubscribeTransactions.
filter
TransactionFilter (optional) — Optional. DNF filter over indexed dimensions. If absent, every transaction is streamed.
read_mask
FieldMask (optional) — Optional. Mask for specifying which parts of the ExecutedTransaction should be returned.
SubscribeTransactionsResponse
Response message for SubscriptionService.SubscribeTransactions.
Mirrors ListTransactionsResponse, except there is no end field: a
subscription stream has no successful end.
transaction
ExecutedTransaction (optional) — One matching transaction. Its position within the containing checkpoint is reported by
ExecutedTransaction.transaction_index.watermark
Watermark (optional) — Progress watermark as of this frame. Present on every frame.
sui/rpc/v2/ledger_service.proto
BatchGetObjectsRequest
read_mask
FieldMask (optional) — Mask specifying which fields to read. If no mask is specified, defaults to
object_id,version,digest.requests
GetObjectRequest (repeated)
BatchGetObjectsResponse
objects
GetObjectResult (repeated)
BatchGetTransactionsRequest
BatchGetTransactionsResponse
transactions
GetTransactionResult (repeated)
GetCheckpointRequest
GetCheckpointResponse
checkpoint
Checkpoint (optional)
GetEpochRequest
GetEpochResponse
epoch
Epoch (optional)
GetObjectRequest
object_id
string (optional) — Required. The
ObjectId of the requested object.read_mask
FieldMask (optional) — Mask specifying which fields to read. If no mask is specified, defaults to
object_id,version,digest.version
uint64 (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
object
Object (optional)
GetServiceInfoRequest
GetServiceInfoResponse
chain
string (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
string (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
uint64 (optional) — Checkpoint height of the most recently executed checkpoint.
epoch
uint64 (optional) — Current epoch of the node based on its highest executed checkpoint.
... and 4 more fields. View all fields
GetTransactionRequest
GetTransactionResponse
transaction
ExecutedTransaction (optional)
GetTransactionResult
ListCheckpointsRequest
Request message for LedgerService.ListCheckpoints.
end_checkpoint
uint64 (optional) — Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.
filter
TransactionFilter (optional) — Optional. DNF filter over indexed transaction dimensions. A checkpoint matches if any transaction it contains satisfies the filter. If absent, all checkpoints in the range are returned.
options
QueryOptions (optional) — Optional cursor-bounded query options. If unspecified, reads in ascending order with the default item limit. The server enforces a maximum item limit and silently coerces larger values down to it. To paginate, pass the last received
Watermark.cursor as options.after (ascending) or options.before (descending) on the next request.read_mask
FieldMask (optional) — Optional. Mask for specifying which parts of the Checkpoint should be returned (e.g. summary, contents, signatures).
... and 1 more fields. View all fields
ListCheckpointsResponse
Response message for LedgerService.ListCheckpoints.
checkpoint
Checkpoint (optional) — One matching checkpoint.
end
QueryEnd (optional) — Set exactly once, on the final frame of a successful query stream.
watermark
Watermark (optional) — Progress watermark as of this frame. Present on every frame. A ScanLimit terminal watermark may repeat the previous frame's cursor when its authoritative scan frontier was already emitted.
ListEventsRequest
Request message for LedgerService.ListEvents.
end_checkpoint
uint64 (optional) — Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.
end_event_index
uint32 (optional) — Optional. Event position within the transaction at
end_transaction_index at which the query ends (exclusive): events of that transaction whose Event.event_index is below this value are also returned. Unset, like 0, returns none of the transaction's events. An index past the transaction's last event returns all of them. Requires end_transaction_index. Servers that predate this field ignore it, as for end_transaction_index.end_transaction_index
uint64 (optional) — Optional. Transaction position within the last checkpoint of the range,
end_checkpoint - 1, at which the query ends (exclusive): within that checkpoint, only events of transactions whose Event.transaction_index is below this value are returned, plus, with end_event_index, the events of the transaction at this index that precede it. Unset ends after the whole checkpoint. An index at or past the checkpoint's transaction count ends after the whole checkpoint. Requires end_checkpoint. A query that stops at this position ends with QUERY_END_REASON_CHECKPOINT_BOUND. When this position leaves events of that checkpoint out, an ascending query does not report it as covered in Watermark.checkpoint. Combines with options.before by intersection: the query ends at whichever of the two is earlier in ledger order. Servers that predate this field ignore it and return the whole checkpoint, so clients must still drop events at or after this position themselves.filter
EventFilter (optional) — Optional. DNF filter over indexed dimensions. If absent, all events in the range are returned.
... and 5 more fields. View all fields
ListEventsResponse
Response message for LedgerService.ListEvents.
end
QueryEnd (optional) — Set exactly once, on the final frame of a successful query stream.
event
Event (optional) — One matching event. Its ledger position -- containing checkpoint, emitting transaction digest and offset, and index within that transaction's event list -- is reported by the corresponding fields on
Event.watermark
Watermark (optional) — Progress watermark as of this frame. Present on every frame. A ScanLimit terminal watermark may repeat the previous frame's cursor when its authoritative scan frontier was already emitted.
ListTransactionsRequest
Request message for LedgerService.ListTransactions.
end_checkpoint
uint64 (optional) — Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.
end_transaction_index
uint64 (optional) — Optional. Transaction position within the last checkpoint of the range,
end_checkpoint - 1, at which the query ends (exclusive): within that checkpoint, only transactions whose ExecutedTransaction.transaction_index is below this value are returned, so 0 returns none of it. Unset ends after the whole checkpoint. An index at or past the checkpoint's transaction count ends after the whole checkpoint. Requires end_checkpoint. A query that stops at this position ends with QUERY_END_REASON_CHECKPOINT_BOUND. When this position leaves transactions of that checkpoint out, an ascending query does not report it as covered in Watermark.checkpoint. Combines with options.before by intersection: the query ends at whichever of the two is earlier in ledger order. Servers that predate this field ignore it and return the whole checkpoint, so clients must still drop transactions at or after this position themselves.filter
TransactionFilter (optional) — Optional. DNF filter over indexed dimensions. If absent, all transactions in the range are returned.
options
QueryOptions (optional) — Optional cursor-bounded query options. If unspecified, reads in ascending order with the default item limit. The server enforces a maximum item limit and silently coerces larger values down to it. To paginate, pass the last received
Watermark.cursor as options.after (ascending) or options.before (descending) on the next request.... and 3 more fields. View all fields
ListTransactionsResponse
Response message for LedgerService.ListTransactions.
end
QueryEnd (optional) — Set exactly once, on the final frame of a successful query stream.
transaction
ExecutedTransaction (optional) — One matching transaction. Its position within the containing checkpoint is reported by
ExecutedTransaction.transaction_index.watermark
Watermark (optional) — Progress watermark as of this frame. Present on every frame. A ScanLimit terminal watermark may repeat the previous frame's cursor when its authoritative scan frontier was already emitted.
sui/rpc/v2/jwk.proto
Jwk
A JSON web key.
alg
string (optional) — Algorithm parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.4.
e
string (optional) — RSA public exponent, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
kty
string (optional) — Key type parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.1.
n
string (optional) — RSA modulus, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
JwkId
Key to uniquely identify a JWK.
sui/rpc/v2/execution_status.proto
CleverError
CoinDenyListError
CommandArgumentError
An error with an argument to a command.
argument
uint32 (optional) — Position of the problematic argument.
index_error
IndexError (optional)
kind
CommandArgumentErrorKind (optional)
CongestedObjects
Set of objects that were congested, leading to the transaction's cancellation.
objects
string (repeated)
ExecutionError
An error that can occur during the execution of a transaction.
command
uint64 (optional) — The command, if any, during which the error occurred.
description
string (optional) — A human readable description of the error
kind
ExecutionErrorKind (optional)
Union: error_details
abort
coin_deny_list_error
command_argument_error
congested_objects
CongestedObjects — 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.
error
ExecutionError (optional) — The error if
success is false.success
bool (optional) — Indicates if the transaction was successful or not.
IndexError
MoveAbort
abort_code
uint64 (optional)
clever_error
CleverError (optional) — Extra error information if abort code is a "Clever Error"
location
MoveLocation (optional) — Location in Move where the error occurred.
MoveLocation
Location in Move bytecode where an error occurred.
function
uint32 (optional) — The function index.
function_name
string (optional) — The name of the function, if available.
instruction
uint32 (optional) — Offset of the instruction where the error occurred.
module
string (optional) — The module name.
... and 1 more fields. View all fields
PackageUpgradeError
An error with upgrading a package.
digest
string (optional) — A digest.
kind
PackageUpgradeErrorKind (optional)
package_id
string (optional) — The Package Id.
policy
uint32 (optional) — The policy.
... and 1 more fields. View all fields
SizeError
A size error.
TypeArgumentError
Type argument error.
kind
TypeArgumentErrorKind (optional)
type_argument
uint32 (optional) — Index of the problematic type argument.
sui/rpc/v2/move_package_service.proto
GetDatatypeRequest
GetDatatypeResponse
datatype
DatatypeDescriptor (optional) — The datatype.
GetFunctionRequest
GetFunctionResponse
function
FunctionDescriptor (optional) — The function.
GetPackageRequest
package_id
string (optional) — Required. The
storage_id of any version of the requested package. When no selector is set, the package stored at exactly this id is returned. When a selector is set, package_id only identifies the package's upgrade lineage (via its original id), and the selected version within that lineage is returned.Union: selector
at_checkpoint
version
GetPackageResponse
package
Package (optional) — The package.
ListPackageVersionsRequest
package_id
string (optional) — Required. The
storage_id of any version of the package.page_size
uint32 (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
bytes (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
next_page_token
bytes (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
PackageVersion (repeated) — List of all package versions, ordered by version.
PackageVersion
A simplified representation of a package version
sui/rpc/v2/checkpoint_contents.proto
AddressAliasesVersion
version
uint64 (optional)
CheckpointContents
The committed to contents of a checkpoint.
bcs
Bcs (optional) — This CheckpointContents serialized as BCS.
digest
string (optional) — The digest of this CheckpointContents.
transactions
CheckpointedTransactionInfo (repeated) — Set of transactions committed to in this checkpoint.
version
int32 (optional) — Version of this CheckpointContents
CheckpointedTransactionInfo
Transaction information committed to in a checkpoint.
address_aliases_versions
AddressAliasesVersion (repeated) — The
AddressAliases object version, if any, that was used to verify the UserSignature at the same position in signatures. This field is present when CheckpointContents.version is >= 2.effects
string (optional) — Digest of the effects.
signatures
UserSignature (repeated) — Set of user signatures that authorized the transaction.
transaction
string (optional) — Digest of the transaction.
sui/rpc/v2/event.proto
Event
An event.
checkpoint
uint64 (optional) — The sequence number of the checkpoint that includes the transaction that emitted this event. Populated when the event is delivered on its own (for example via
LedgerService.ListEvents); left unset when the event is carried inside its transaction's events list, where the enclosing ExecutedTransaction already provides this context.contents
Bcs (optional) — BCS serialized bytes of the event.
event_index
uint32 (optional) — Zero-based index of this event within its transaction's event list.
event_type
string (optional) — The type of the event emitted.
... and 6 more fields. View all fields
TransactionEvents
Events emitted during the successful execution of a transaction.
sui/rpc/v2/filter.proto
AffectedAddressFilter
Match by any address whose state moved as a side effect of the transaction: object ownership changes (in either direction), prior owners of removed/wrapped objects, and address-balance changes via accumulator events.
address
string (optional) — The affected address (hex-encoded).
AffectedObjectFilter
Match by changed object ID.
object_id
string (optional) — The changed object ID (hex-encoded).
EmitModuleFilter
Match by an event's package/module fields, specified as a ::-delimited
Move path. These identify the top-level Move call that triggered the event.
module
string (optional) — Required. Move path of the form
package[::module].EventFilter
DNF filter for events: any term may match, and each term is an AND of signed literals. Sender predicates match all events from matching transactions; emit-module, event-type, and event-stream-head predicates match individual event-space dimensions. An absent filter matches everything. A present filter must have at least one term.
terms
EventTerm (repeated) — Terms are ORed together.
EventLiteral
One signed event predicate literal: a predicate, optionally negated.
negated
bool — When true, the literal matches events that the predicate does not match.
Union: predicate
emit_module
EmitModuleFilter — Match events whose package/module fields match the specified filter.
event_stream_head
EventStreamHeadFilter — Match events committed to the specified authenticated event stream head.
event_type
EventTypeFilter — Match events whose type matches the specified filter.
sender
SenderFilter — Match events from transactions sent by the specified address.
EventStreamHeadFilter
Match by authenticated event stream head.
stream_id
string (optional) — The stream id address (hex-encoded).
EventTerm
One conjunction in an event DNF filter.
literals
EventLiteral (repeated) — Literals are ANDed together.
EventTypeFilter
Match by event struct type, specified as a Move type string.
event_type
string (optional) — Required. Move type string of the form
address[::module[::Name[<type_params>]]].MoveCallFilter
Match by Move function call, specified as a ::-delimited Move path.
function
string (optional) — Required. Move path of the form
package[::module[::function]].PackageWriteFilter
Match transactions that wrote a Move package.
SenderFilter
Match by transaction sender address.
address
string (optional) — The sender address (hex-encoded).
TransactionFilter
DNF filter for transactions: any term may match, and each term is an AND of signed literals. An absent filter matches everything. A present filter must have at least one term.
terms
TransactionTerm (repeated) — Terms are ORed together.
TransactionLiteral
One signed transaction predicate literal: a predicate, optionally negated.
negated
bool — When true, the literal matches transactions that the predicate does not match.
Union: predicate
affected_address
AffectedAddressFilter — Match transactions where the specified address's state moved as a side effect: it owns an object after the txn, owned an object before the txn that was mutated/transferred away/deleted/wrapped, or its address-balance changed via an accumulator event.
affected_object
AffectedObjectFilter — Match transactions whose effects include a change for the specified object.
emit_module
EmitModuleFilter — Match transactions that emitted an event whose package/module fields match the specified filter.
event_stream_head
EventStreamHeadFilter — Match transactions that wrote to the specified authenticated event stream head.
event_type
EventTypeFilter — Match transactions that emitted an event with a type matching the specified filter.
move_call
MoveCallFilter — Match transactions that made a Move call matching the specified filter.
package_write
PackageWriteFilter — Match transactions that wrote a Move package — a first publish or an upgrade, of any package.
sender
SenderFilter — Match transactions sent by the specified address.
TransactionTerm
One conjunction in a transaction DNF filter.
literals
TransactionLiteral (repeated) — Literals are ANDed together.
sui/rpc/v2/state_service.proto
Balance
Balance information for a specific coin type.
address_balance
uint64 (optional) — The balance of
Balance<T> in this address's Address Balance.balance
uint64 (optional) — The total balance of
coin_type in its smallest unit. This is the sum of all spendable amounts of coin_type (address_balance and coin_balance).coin_balance
uint64 (optional) — The balance of all
Coin<T> objects owned by this address.coin_type
string (optional) — The type of the coin (e.g., 0x2::sui::SUI).
CoinMetadata
Metadata for a coin type
decimals
uint32 (optional) — Number of decimal places to coin uses.
description
string (optional) — Description of the token
icon_url
string (optional) — URL for the token logo
id
string (optional) — ObjectId of the
0x2::coin::CoinMetadata object or 0x2::sui::coin_registry::Currency object (when registered with CoinRegistry).... and 4 more fields. View all fields
CoinTreasury
Information about a coin type's 0x2::coin::TreasuryCap and its total available supply
id
string (optional) — ObjectId of the
0x2::coin::TreasuryCap object.supply_state
SupplyState (optional) — Supply state indicating if the supply is fixed or can still be minted
total_supply
uint64 (optional) — Total available supply for this coin type.
DynamicField
child_id
string (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
Object (optional) — The object itself when a child is a dynamic object field.
field_id
string (optional) — ObjectId of this dynamic field.
field_object
Object (optional) — The field object itself
... and 5 more fields. View all fields
GetBalanceRequest
Request message for LiveDataService.GetBalance.
GetBalanceResponse
Response message for LiveDataService.GetBalance.
Return the total coin balance for one coin type, owned by the address owner.
balance
Balance (optional) — The balance information for the requested coin type.
GetCoinInfoRequest
Request message for NodeService.GetCoinInfo.
coin_type
string (optional) — The coin type to request information about
GetCoinInfoResponse
Response message for NodeService.GetCoinInfo.
coin_type
string (optional) — Required. The coin type.
metadata
CoinMetadata (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
RegulatedCoinMetadata (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
CoinTreasury (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.
owner
string (optional) — Required. The owner's Sui address.
page_size
uint32 (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
bytes (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.
ListDynamicFieldsRequest
Request message for NodeService.ListDynamicFields
page_size
uint32 (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
bytes (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
string (optional) — Required. The
UID of the parent, which owns the collections of dynamic fields.read_mask
FieldMask (optional) — Mask specifying which fields to read. If no mask is specified, defaults to
parent,field_id.ListDynamicFieldsResponse
Response message for NodeService.ListDynamicFields
dynamic_fields
DynamicField (repeated) — Page of dynamic fields owned by the specified parent.
next_page_token
bytes (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
object_type
string (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
string (optional) — Required. The address of the account that owns the objects.
page_size
uint32 (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
bytes (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.... and 1 more fields. View all fields
ListOwnedObjectsResponse
RegulatedCoinMetadata
Information about a regulated coin, which indicates that it makes use of the transfer deny list.
allow_global_pause
bool (optional) — Whether the coin can be globally paused
coin_metadata_object
coin_regulated_state
CoinRegulatedState (optional) — Indicates the coin's regulated state.
deny_cap_object
string (optional) — The ID of the coin's
DenyCap object.... and 2 more fields. View all fields
sui/rpc/v2/system_state.proto
MoveTable
A message that represents a Move 0x2::table::Table or 0x2::bag::Bag
StakeSubsidy
balance
uint64 (optional) — Balance of SUI set aside for stake subsidies that will be drawn down over time.
current_distribution_amount
uint64 (optional) — The amount of stake subsidy to be drawn down per distribution. This amount decays and decreases over time.
distribution_counter
uint64 (optional) — Count of the number of times stake subsidies have been distributed.
extra_fields
MoveTable (optional) — Any extra fields that's not defined statically.
... and 2 more fields. View all fields
StakingPool
A staking pool embedded in each validator struct in the system state object.
activation_epoch
uint64 (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
uint64 (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
MoveTable (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: PoolTokenExchangeRateextra_fields
MoveTable (optional) — Any extra fields that's not defined statically.
... and 7 more fields. View all fields
StorageFund
Struct representing the onchain storage fund.
non_refundable_balance
uint64 (optional) — Represents any remaining inflow of the storage fund that should not be taken out of the fund.
total_object_storage_rebates
uint64 (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
epoch_duration_ms
uint64 (optional) — The duration of an epoch, in milliseconds.
extra_fields
MoveTable (optional) — Any extra fields that are not defined statically.
max_validator_count
uint64 (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
uint64 (optional) — Minimum number of active validators at any moment.
... and 5 more fields. View all fields
SystemState
epoch
uint64 (optional) — The epoch id
epoch_start_timestamp_ms
uint64 (optional) — Unix timestamp of when this this epoch started
extra_fields
MoveTable (optional) — Any extra fields that's not defined statically.
parameters
SystemParameters (optional) — Set of system config parameters
... and 12 more fields. View all fields
Validator
Definition of a Validator in the system contracts
Note: fields of ValidatorMetadata are flattened into this type
address
string (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
uint64 (optional) — Commission rate of the validator, in basis point.
description
string (optional)
extra_fields
MoveTable (optional) — Any extra fields that's not defined statically.
... and 27 more fields. View all fields
ValidatorReportRecord
ValidatorSet
active_validators
Validator (repeated) — The current list of active validators.
at_risk_validators
AtRiskValidatorsEntry (repeated) — Table storing the number of epochs during which a validator's stake has been below the low stake threshold.
extra_fields
MoveTable (optional) — Any extra fields that's not defined statically.
inactive_validators
MoveTable (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... and 5 more fields. View all fields
sui/rpc/v2/object_reference.proto
ObjectReference
Reference to an object.
sui/rpc/v2/checkpoint_summary.proto
CheckpointCommitment
A commitment made by a checkpoint.
CheckpointSummary
A header for a checkpoint on the Sui blockchain.
bcs
Bcs (optional) — This CheckpointSummary serialized as BCS.
commitments
CheckpointCommitment (repeated) — Commitments to checkpoint-specific state.
content_digest
string (optional) — The hash of the
CheckpointContents for this checkpoint.digest
string (optional) — The digest of this CheckpointSummary.
... and 8 more fields. View all fields
EndOfEpochData
Data, which when included in a CheckpointSummary, signals the end of an Epoch.
epoch_commitments
CheckpointCommitment (repeated) — Commitments to epoch specific state (live object set)
next_epoch_committee
ValidatorCommitteeMember (repeated) — The set of validators that will be in the
ValidatorCommittee for the next epoch.next_epoch_protocol_version
uint64 (optional) — The protocol version that is in effect during the next epoch.
sui/rpc/v2/bcs.proto
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.
sui/rpc/v2/name_service.proto
LookupNameRequest
name
string (optional) — Required. The SuiNS name to lookup. Supports both
@name as well as name.sui formats.LookupNameResponse
record
NameRecord (optional) — The record for the requested name
NameRecord
data
DataEntry (repeated) — Additional data which may be stored in a record
expiration_timestamp
Timestamp (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
string (optional) — Id of this record. Note that records are stored on chain as dynamic fields of the type
Field<Domain,NameRecord>.name
string (optional) — The SuiNS name of this record
... and 2 more fields. View all fields
ReverseLookupNameRequest
address
string (optional) — Required. The address to perform a reverse lookup for.
ReverseLookupNameResponse
record
NameRecord (optional) — The record for the SuiNS name linked to the requested address
sui/rpc/v2/owner.proto
Owner
Enum of different types of ownership for an object.
sui/rpc/v2/transaction.proto
ActiveJwk
A new JWK.
AllowedProposers
The validators allowed to propose a transaction in consensus.
Proposal by any other validator is byzantine behavior and invalidates the whole block.
epoch
uint64 (optional) — The epoch whose committee
proposers indexes into. Committee indices are only meaningful against one committee, so a set recorded for any other epoch is ignored and the transaction is treated as naming no proposers.proposers
uint32 (repeated) — Committee indices of the allowed proposers, strictly increasing and non-empty. An empty list names no validator and is rejected; omit
allowed_proposers entirely to let any validator propose the transaction.AuthenticatorStateExpire
Expire old JWKs.
AuthenticatorStateUpdate
Update the set of valid JWKs.
authenticator_object_initial_shared_version
uint64 (optional) — The initial version of the authenticator object that it was shared at.
epoch
uint64 (optional) — Epoch of the authenticator state update transaction.
new_active_jwks
ActiveJwk (repeated) — Newly active JWKs.
round
uint64 (optional) — Consensus round of the authenticator state update.
CanceledTransaction
A transaction that was canceled.
digest
string (optional) — Digest of the canceled transaction.
version_assignments
VersionAssignment (repeated) — List of object version assignments.
ChangeEpoch
System transaction used to change the epoch.
computation_charge
uint64 (optional) — The total amount of gas charged for computation during the epoch.
epoch
uint64 (optional) — The next (to become) epoch ID.
epoch_start_timestamp
Timestamp (optional) — Unix timestamp when epoch started.
non_refundable_storage_fee
uint64 (optional) — The non-refundable storage fee.
... and 4 more fields. View all fields
Command
A single command in a programmable transaction.
Union: command
make_move_vector
MakeMoveVector —
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
MergeCoins —
(&mut Coin<T>, Vec<Coin<T>>) It merges n-coins into the first coin.move_call
MoveCall — A call to either an entry or a public Move function.
publish
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
SplitCoins —
(&mut Coin<T>, Vec<u64>) -> Vec<Coin<T>> It splits off some amounts into new coins with those amounts.transfer_objects
TransferObjects —
(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
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.
additional_state_digest
string (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
Timestamp (optional) — Unix timestamp from consensus. Present in V1, V2, V3, V4.
consensus_commit_digest
string (optional) — Digest of consensus output. Present in V2, V3, V4.
consensus_determined_version_assignments
ConsensusDeterminedVersionAssignments (optional) — Stores consensus handler determined consensus object version assignments. Present in V3, V4.
... and 3 more fields. View all fields
ConsensusDeterminedVersionAssignments
Version assignments performed by consensus.
canceled_transactions
CanceledTransaction (repeated) — Canceled transaction version assignment.
version
int32 (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.
transactions
EndOfEpochTransactionKind (repeated)
EndOfEpochTransactionKind
Operation run at the end of an epoch.
kind
Kind (optional)
Union: data
authenticator_state_expire
AuthenticatorStateExpire — Expire JWKs used for zklogin.
bridge_chain_id
string — ChainId used when initializing the bridge
bridge_object_version
uint64 — Start version of the Bridge object
change_epoch
ChangeEpoch — End the epoch and start the next one.
execution_time_observations
ExecutionTimeObservations — Execution time observations from the committee to preserve cross epoch
storage_cost
uint64 — Contains the end-of-epoch-computed storage cost for accumulator objects.
ExecutionTimeObservation
kind
ExecutionTimeObservationKind (optional)
move_entry_point
MoveCall (optional)
validator_observations
ValidatorExecutionTimeObservation (repeated)
ExecutionTimeObservations
observations
ExecutionTimeObservation (repeated)
version
int32 (optional) — Version of this ExecutionTimeObservations
GasPayment
Payment information for executing a transaction.
budget
uint64 (optional) — Total budget willing to spend for the execution of a transaction.
objects
ObjectReference (repeated) — Set of gas objects to use for payment.
owner
string (optional) — Owner of the gas objects, either the transaction sender or a sponsor.
price
uint64 (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).
MakeMoveVector
Command to build a Move vector out of a set of individual elements.
MergeCoins
Command to merge multiple coins of the same type into a single coin.
MoveCall
Command to call a Move function.
arguments
Argument (repeated) — The arguments to the function.
function
string (optional) — The function to be called.
module
string (optional) — The specific module in the package containing the function.
package
string (optional) — The package containing the module and function.
... and 1 more fields. View all fields
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.
Publish
Command to publish a new Move package.
RandomnessStateUpdate
Randomness update.
epoch
uint64 (optional) — Epoch of the randomness state update transaction.
random_bytes
bytes (optional) — Updated random bytes.
randomness_object_initial_shared_version
uint64 (optional) — The initial version of the randomness object that it was shared at.
randomness_round
uint64 (optional) — Randomness round of the update.
SplitCoins
Command to split a single coin object into multiple coins.
SystemPackage
System package.
Transaction
A transaction.
bcs
Bcs (optional) — This Transaction serialized as BCS.
digest
string (optional) — The digest of this Transaction.
expiration
TransactionExpiration (optional)
gas_payment
GasPayment (optional)
... and 3 more fields. View all fields
TransactionExpiration
A TTL for a transaction.
allowed_proposers
AllowedProposers (optional) — The validators allowed to propose this transaction in consensus. Only set when
kind is VALIDITY. Leave unset to let any validator propose the transaction.chain
string (optional) — ChainId of the network this transaction is intended for in order to prevent cross-chain replay
epoch
uint64 (optional) — Maximum epoch in which a transaction can be executed. The provided maximal epoch must be greater than or equal to the current epoch for a transaction to execute.
kind
TransactionExpirationKind (optional)
... and 4 more fields. View all fields
TransactionKind
Transaction type.
kind
Kind (optional)
Union: data
authenticator_state_update
AuthenticatorStateUpdate — Update set of valid JWKs used for zklogin.
change_epoch
ChangeEpoch — 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
ConsensusCommitPrologue — consensus commit update info
end_of_epoch
EndOfEpochTransaction — Set of operations to run at the end of the epoch to close out the current epoch and start the next one.
genesis
GenesisTransaction — 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
ProgrammableTransaction — A transaction comprised of a list of native commands and Move calls.
randomness_state_update
RandomnessStateUpdate — Randomness update.
TransferObjects
Command to transfer ownership of a set of objects to an address.
Upgrade
Command to upgrade an already published package.
ValidatorExecutionTimeObservation
VersionAssignment
Object version assignment from consensus.
sui/rpc/v2/input.proto
FundsWithdrawal
allowance
string (optional) —
ObjectId of the allowance object authorizing the withdrawal if source is SENDER_ALLOWANCE.amount
uint64 (optional)
coin_type
string (optional)
funder
... and 1 more fields. View all fields
Input
An input to a user transaction.
digest
string (optional) — The digest of this object.
funds_withdrawal
kind
InputKind (optional)
literal
Value (optional) — A literal value INPUT ONLY
... and 5 more fields. View all fields
sui/rpc/v2/signature_verification_service.proto
VerifySignatureRequest
address
string (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.
check_address_aliases
bool (optional) — Optional. If true,
address is required and the signature must be from a member of address's current AddressAliases set rather than from address itself. An address with no AddressAliases set is its own only alias. Servers that predate this field ignore it, so clients must check address_aliases_checked in the response.jwks
ActiveJwk (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
Bcs (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.... and 1 more fields. View all fields
VerifySignatureResponse
address_aliases_checked
bool (optional) — Set to true when the server applied
check_address_aliases, whether or not the signature is valid. Unset by servers that predate it.is_valid
bool (optional) — Indicates if the provided signature was valid given the requested parameters.
reason
string (optional) — If
is_valid is false, this is the reason for why the signature verification failed.sui/rpc/v2/argument.proto
Argument
An argument to a programmable transaction command.
sui/rpc/v2/object.proto
Display
A rendered JSON blob based on an on-chain template.
errors
Value (optional) — If any fields failed to render, this will contain a mapping from failed field names to error messages. If all fields succeed, this will either be
null or not set.output
Value (optional) — Output for all successfully substituted display fields. Unsuccessful fields will be
null, and will be accompanied by a field in errors, explaining the error.Object
An object on the Sui blockchain.
balance
uint64 (optional) — Current balance if this object is a
0x2::coin::Coin<T>bcs
Bcs (optional) — This Object serialized as BCS.
contents
Bcs (optional) — BCS bytes of a Move struct value. Only set for Move structs
digest
string (optional) — The digest of this Object.
... and 10 more fields. View all fields
ObjectSet
Set of Objects
objects
Object (repeated) — Objects are sorted by the key
(object_id, version).sui/rpc/v2/gas_cost_summary.proto
GasCostSummary
Summary of gas charges.
computation_cost
uint64 (optional) — Cost of computation/execution.
non_refundable_storage_fee
uint64 (optional) — The fee for the rebate. The portion of the storage rebate kept by the system.
storage_cost
uint64 (optional) — Storage cost, it's the sum of all storage cost for all objects created or mutated.
storage_rebate
uint64 (optional) — The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.
sui/rpc/v2/signature.proto
CircomG1
A G1 point.
CircomG2
A G2 point.
e00
string (optional) — base10 encoded Bn254FieldElement
e01
string (optional) — base10 encoded Bn254FieldElement
e10
string (optional) — base10 encoded Bn254FieldElement
e11
string (optional) — base10 encoded Bn254FieldElement
... and 2 more fields. View all fields
MultisigAggregatedSignature
Aggregated signature from members of a multisig committee.
bitmap
uint32 (optional) — Bitmap indicating which committee members contributed to the signature.
committee
MultisigCommittee (optional) — The committee to use to validate this signature.
legacy_bitmap
bytes (optional) — If present, means this signature's on-chain format uses the old legacy multisig format.
signatures
MultisigMemberSignature (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.
members
MultisigMember (repeated) — A list of committee members and their corresponding weight.
threshold
uint32 (optional) — The threshold of signatures needed to validate a signature from this committee.
MultisigMember
A member in a multisig committee.
public_key
MultisigMemberPublicKey (optional) — The public key of the committee member.
weight
uint32 (optional) — The weight of this member's signature.
MultisigMemberPublicKey
Set of valid public keys for multisig committee members.
public_key
bytes (optional) — Public key bytes if scheme is ed25519 | secp256k1 | secp256r1 | passkey | mldsa65.
scheme
SignatureScheme (optional) — The signature scheme of this public key.
zklogin
ZkLoginPublicIdentifier (optional) — A zklogin public identifier if scheme is zklogin.
MultisigMemberSignature
A signature from a member of a multisig committee.
passkey
PasskeyAuthenticator (optional) — The passkey authenticator if scheme is
PASSKEY.scheme
SignatureScheme (optional) — The signature scheme of this signature.
signature
bytes (optional) — Signature bytes if scheme is ed25519 | secp256k1 | secp256r1 | mldsa65.
zklogin
ZkLoginAuthenticator (optional) — The zklogin authenticator if scheme is
ZKLOGIN.PasskeyAuthenticator
A passkey authenticator.
authenticator_data
bytes (optional) — Opaque authenticator data for this passkey signature. See Authenticator Data for more information on this field.
client_data_json
string (optional) — Structured, unparsed, JSON for this passkey signature. See CollectedClientData for more information on this field.
signature
SimpleSignature (optional) — A secp256r1 signature.
SimpleSignature
Either an ed25519, secp256k1, secp256r1 or mldsa65 signature
public_key
bytes (optional) — Public key bytes
scheme
SignatureScheme (optional) — The signature scheme of this signature.
signature
bytes (optional) — Signature bytes
UserSignature
A signature from a user.
bcs
Bcs (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
SignatureScheme (optional) — The signature scheme of this signature.
Union: signature
multisig
MultisigAggregatedSignature — The multisig aggregated signature if scheme is
MULTISIG.passkey
PasskeyAuthenticator — The passkey authenticator if scheme is
PASSKEY.simple
SimpleSignature — Simple signature if scheme is ed25519 | secp256k1 | secp256r1 | mldsa65.
zklogin
ZkLoginAuthenticator — The zklogin authenticator if scheme is
ZKLOGIN.ValidatorAggregatedSignature
An aggregated signature from multiple validators.
bitmap
bytes (optional) — Bitmap indicating which members of the committee contributed to this signature.
epoch
uint64 (optional) — The epoch when this signature was produced. This can be used to lookup the
ValidatorCommittee from this epoch to verify this signature.signature
bytes (optional) — The 48-byte Bls12381 aggregated signature.
ValidatorCommittee
The validator set for a particular epoch.
epoch
uint64 (optional) — The epoch where this committee governs.
members
ValidatorCommitteeMember (repeated) — The committee members.
ValidatorCommitteeMember
A member of a validator committee.
ZkLoginAuthenticator
A zklogin authenticator.
inputs
ZkLoginInputs (optional) — Zklogin proof and inputs required to perform proof verification.
jwk_id
JwkId (optional) — The id of the JWK used to authorize this zklogin authenticator
max_epoch
uint64 (optional) — Maximum epoch for which the proof is valid.
public_identifier
ZkLoginPublicIdentifier (optional) — The public identifier (similar to a public key) for this zklogin authenticator
... and 1 more fields. View all fields
ZkLoginClaim
A claim of the iss in a zklogin proof.
ZkLoginInputs
A zklogin groth16 proof and the required inputs to perform proof verification.
address_seed
string (optional) — base10 encoded Bn254FieldElement
header_base64
string (optional)
iss_base64_details
ZkLoginClaim (optional)
proof_points
ZkLoginProof (optional)
ZkLoginPublicIdentifier
Public key equivalent for zklogin authenticators.
sui/rpc/v2/executed_transaction.proto
ExecutedTransaction
balance_changes
BalanceChange (repeated)
checkpoint
uint64 (optional) — The sequence number for the checkpoint that includes this transaction.
digest
string (optional) — The digest of this Transaction.
effects
TransactionEffects (optional) — The
TransactionEffects for this transaction.... and 6 more fields. View all fields