package sui.rpc.v2beta
Get desktop application:
View/edit binary Protocol Buffers messages
Query the service for general information about its current state.
message
ledger_service.proto:30(message has no fields)
message
ledger_service.proto:32optional string chain_id = 1
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.
optional string chain = 2
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.
optional uint64 epoch = 3
Current epoch of the node based on its highest executed checkpoint.
optional uint64 checkpoint_height = 4
Checkpoint height of the most recently executed checkpoint.
optional timestamp = 5
Unix timestamp of the most recently executed checkpoint.
optional uint64 lowest_available_checkpoint = 6
The lowest checkpoint for which checkpoints and transaction data are available.
optional uint64 lowest_available_checkpoint_objects = 7
The lowest checkpoint for which object data is available.
optional string server_version = 8
Software version of the service. Similar to the `server` http header.
rpc GetObject (, )
ledger_service.proto:19message
ledger_service.proto:77repeated requests = 1
optional read_mask = 2
Mask specifying which fields to read. If no mask is specified, defaults to `object_id,version,digest`.
message
ledger_service.proto:85repeated objects = 1
message
ledger_service.proto:89optional string digest = 1
Required. The digest of the requested transaction.
optional read_mask = 2
Mask specifying which fields to read. If no mask is specified, defaults to `digest`.
message
ledger_service.proto:98repeated string digests = 1
Required. The digests of the requested transactions.
optional read_mask = 2
Mask specifying which fields to read. If no mask is specified, defaults to `object_id,version,digest`.
message
ledger_service.proto:107repeated transactions = 1
rpc GetCheckpoint (, )
ledger_service.proto:25message
ledger_service.proto:111oneof checkpoint_id
If neither is provided, return the latest
uint64 sequence_number = 1
The sequence number of the requested checkpoint.
string digest = 2
The digest of the requested checkpoint.
optional read_mask = 3
Mask specifying which fields to read. If no mask is specified, defaults to `object_id,version,digest`.
rpc GetEpoch (, )
ledger_service.proto:27message
ledger_service.proto:138optional uint64 epoch = 1
The requested epoch. If no epoch is provided the current epoch will be returned.
optional read_mask = 2
Mask specifying which fields to read. If no mask is specified, defaults to `epoch`.
message
epoch.proto:12optional uint64 epoch = 1
optional committee = 2
The committee governing this epoch.
optional uint64 first_checkpoint = 4
optional uint64 last_checkpoint = 5
optional start = 6
optional end = 7
optional uint64 reference_gas_price = 8
Reference gas price denominated in MIST
optional protocol_config = 9
optional transaction = 1
The transaction to execute.
repeated signatures = 2
Set of `UserSiganture`s authorizing the execution of the provided transaction.
optional read_mask = 3
Mask specifying which fields to read. If no mask is specified, defaults to `finality`.
Response message for `NodeService.ExecuteTransaction`.
optional finality = 1
Indicates the finality of the executed transaction.
optional transaction = 2
message
transaction.proto:382A new JWK.
Used in:
optional id = 1
Identifier used to uniquely identify a JWK.
optional jwk = 2
The JWK.
optional uint64 epoch = 3
Most recent epoch in which the JWK was validated.
message
argument.proto:9An argument to a programmable transaction command.
Used in: , , , , ,
optional Argument.ArgumentKind kind = 1
optional uint32 index = 2
Index of an input or the result of another command based on `kind`.
optional uint32 subresult = 3
Used to access a nested result when `kind` is `RESULT`.
Used in:
ARGUMENT_KIND_UNKNOWN = 0
GAS = 1
The gas coin.
INPUT = 2
One of the input objects or primitive values (from `ProgrammableTransaction` inputs).
RESULT = 3
The result of another command (from `ProgrammableTransaction` commands).
message
transaction.proto:449Expire old JWKs.
Used in:
optional uint64 min_epoch = 1
Expire JWKs that have a lower epoch than this.
optional uint64 authenticator_object_initial_shared_version = 2
The initial version of the authenticator object that it was shared at.
message
transaction.proto:370Update the set of valid JWKs.
Used in:
optional uint64 epoch = 1
Epoch of the authenticator state update transaction.
optional uint64 round = 2
Consensus round of the authenticator state update.
repeated new_active_jwks = 3
Newly active JWKs.
optional uint64 authenticator_object_initial_shared_version = 4
The initial version of the authenticator object that it was shared at.
message
balance_change.proto:9The delta, or change, in balance for an address for a particular `Coin` type.
Used in:
optional string address = 1
The account address that is affected by this balance change event.
optional string coin_type = 2
The `Coin` type of this balance change event.
optional string amount = 3
The amount or change in balance.
message
bcs.proto:11`Bcs` contains an arbitrary type that is serialized using the [BCS](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/index.html#bcs) format as well as a name that identifies the type of the serialized value.
Used in: , , , , , , ,
optional string name = 1
Name that identifies the type of the serialized value.
optional bytes value = 2
Bytes of a BCS serialized value.
message
transaction.proto:349A transaction that was canceled.
Used in:
optional string digest = 1
Digest of the canceled transaction.
repeated version_assignments = 2
List of object version assignments.
message
transaction.proto:357Set of canceled transactions.
Used in:
repeated canceled_transactions = 1
message
transaction.proto:259System transaction used to change the epoch.
Used in: ,
optional uint64 epoch = 1
The next (to become) epoch ID.
optional uint64 protocol_version = 2
The protocol version in effect in the new epoch.
optional uint64 storage_charge = 3
The total amount of gas charged for storage during the epoch.
optional uint64 computation_charge = 4
The total amount of gas charged for computation during the epoch.
optional uint64 storage_rebate = 5
The amount of storage rebate refunded to the txn senders.
optional uint64 non_refundable_storage_fee = 6
The non-refundable storage fee.
optional epoch_start_timestamp = 7
Unix timestamp when epoch started.
repeated system_packages = 8
System packages (specifically framework and Move stdlib) that are written before the new epoch starts. This tracks framework upgrades on chain. When executing the `ChangeEpoch` txn, the validator must write out the following modules. Modules are provided with the version they will be upgraded to, their modules in serialized form (which include their package ID), and a list of their transitive dependencies.
message
effects.proto:67Input/output state of an object that was changed during execution.
Used in:
optional string object_id = 1
ID of the object.
optional ChangedObject.InputObjectState input_state = 2
optional uint64 input_version = 3
Version of the object before this transaction executed.
optional string input_digest = 4
Digest of the object before this transaction executed.
optional input_owner = 5
Owner of the object before this transaction executed.
optional ChangedObject.OutputObjectState output_state = 6
optional uint64 output_version = 7
Version of the object after this transaction executed.
optional string output_digest = 8
Digest of the object after this transaction executed.
optional output_owner = 9
Owner of the object after this transaction executed.
optional ChangedObject.IdOperation id_operation = 10
What happened to an `ObjectId` during execution.
optional string object_type = 11
Type information is not provided by the effects structure but is instead provided by an indexing layer
Used in:
ID_OPERATION_UNKNOWN = 0
NONE = 1
CREATED = 2
DELETED = 3
Used in:
INPUT_OBJECT_STATE_UNKNOWN = 0
INPUT_OBJECT_STATE_DOES_NOT_EXIST = 1
INPUT_OBJECT_STATE_EXISTS = 2
Used in:
OUTPUT_OBJECT_STATE_UNKNOWN = 0
OUTPUT_OBJECT_STATE_DOES_NOT_EXIST = 1
OUTPUT_OBJECT_STATE_OBJECT_WRITE = 2
OUTPUT_OBJECT_STATE_PACKAGE_WRITE = 3
message
checkpoint.proto:13Used as response type in: LedgerService.GetCheckpoint
Used as field type in:
optional uint64 sequence_number = 1
The height of this checkpoint.
optional string digest = 2
The digest of this Checkpoint's CheckpointSummary.
optional summary = 3
The `CheckpointSummary` for this checkpoint.
optional signature = 4
An aggregated quorum signature from the validator committee that certified this checkpoint.
optional contents = 5
The `CheckpointContents` for this checkpoint.
repeated transactions = 6
List of transactions included in this checkpoint.
message
checkpoint_summary.proto:90A commitment made by a checkpoint.
Used in: ,
optional CheckpointCommitment.CheckpointCommitmentKind kind = 1
optional string digest = 2
Used in:
CHECKPOINT_COMMITMENT_KIND_UNKNOWN = 0
ECMH_LIVE_OBJECT_SET = 1
An elliptic curve multiset hash attesting to the set of objects that comprise the live state of the Sui blockchain.
message
checkpoint_contents.proto:12The committed to contents of a checkpoint.
Used in:
optional bcs = 1
This CheckpointContents serialized as BCS.
optional string digest = 2
The digest of this CheckpointContents.
optional int32 version = 3
Version of this CheckpointContents
repeated transactions = 4
Set of transactions committed to in this checkpoint.
message
checkpoint_summary.proto:32A header for a checkpoint on the Sui blockchain. On the Sui network, checkpoints define the history of the blockchain. They are quite similar to the concept of blocks used by other blockchains like Bitcoin or Ethereum. The Sui blockchain, however, forms checkpoints after transaction execution has already happened to provide a certified history of the chain, instead of being formed before execution. Checkpoints commit to a variety of state, including but not limited to: - The hash of the previous checkpoint. - The set of transaction digests, their corresponding effects digests, as well as the set of user signatures that authorized its execution. - The objects produced by a transaction. - The set of live objects that make up the current state of the chain. - On epoch transitions, the next validator committee. `CheckpointSummary`s themselves don't directly include all of the previous information but they are the top-level type by which all the information is committed to transitively via cryptographic hashes included in the summary. `CheckpointSummary`s are signed and certified by a quorum of the validator committee in a given epoch to allow verification of the chain's state.
Used in:
optional bcs = 1
This CheckpointSummary serialized as BCS.
optional string digest = 2
The digest of this CheckpointSummary.
optional uint64 epoch = 3
Epoch that this checkpoint belongs to.
optional uint64 sequence_number = 4
The height of this checkpoint.
optional uint64 total_network_transactions = 5
Total number of transactions committed since genesis, including those in this checkpoint.
optional string content_digest = 6
The hash of the `CheckpointContents` for this checkpoint.
optional string previous_digest = 7
The hash of the previous `CheckpointSummary`. This will be `None` only for the first, or genesis, checkpoint.
optional epoch_rolling_gas_cost_summary = 8
The running total gas costs of all transactions included in the current epoch so far until this checkpoint.
optional timestamp = 9
Timestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have the same timestamp if they originate from the same underlining consensus commit.
repeated commitments = 10
Commitments to checkpoint-specific state.
optional end_of_epoch_data = 11
Extra data only present in the final checkpoint of an epoch.
optional bytes version_specific_data = 12
`CheckpointSummary` is not an evolvable structure - it must be readable by any version of the code. Therefore, to allow extensions to be added to `CheckpointSummary`, opaque data can be added to checkpoints, which can be deserialized based on the current protocol version.
message
checkpoint_contents.proto:27Transaction information committed to in a checkpoint.
Used in:
optional string transaction = 1
Digest of the transaction.
optional string effects = 2
Digest of the effects.
repeated signatures = 3
Set of user signatures that authorized the transaction.
message
signature.proto:136A G1 point.
Used in:
optional string e0 = 1
base10 encoded Bn254FieldElement
optional string e1 = 2
base10 encoded Bn254FieldElement
optional string e2 = 3
base10 encoded Bn254FieldElement
message
signature.proto:146A G2 point.
Used in:
optional string e00 = 1
base10 encoded Bn254FieldElement
optional string e01 = 2
base10 encoded Bn254FieldElement
optional string e10 = 3
base10 encoded Bn254FieldElement
optional string e11 = 4
base10 encoded Bn254FieldElement
optional string e20 = 5
base10 encoded Bn254FieldElement
optional string e21 = 6
base10 encoded Bn254FieldElement
message
transaction.proto:127A single command in a programmable transaction.
Used in:
oneof command
move_call = 1
A call to either an entry or a public Move function.
transfer_objects = 2
`(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.
split_coins = 3
`(&mut Coin<T>, Vec<u64>)` -> `Vec<Coin<T>>` It splits off some amounts into new coins with those amounts.
merge_coins = 4
`(&mut Coin<T>, Vec<Coin<T>>)` It merges n-coins into the first coin.
publish = 5
Publishes a Move package. It takes the package bytes and a list of the package's transitive dependencies to link against on chain.
make_move_vector = 6
`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.
upgrade = 7
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.
message
execution_status.proto:221An error with an argument to a command.
Used in:
optional uint32 argument = 1
Position of the problematic argument.
optional CommandArgumentError.CommandArgumentErrorKind kind = 2
optional uint32 index = 3
Index of an input or result.
optional uint32 subresult = 4
Index of a subresult.
Used in:
COMMAND_ARGUMENT_ERROR_KIND_UNKNOWN = 0
TYPE_MISMATCH = 1
The type of the value does not match the expected type.
INVALID_BCS_BYTES = 2
The argument cannot be deserialized into a value of the specified type.
INVALID_USAGE_OF_PURE_ARGUMENT = 3
The argument cannot be instantiated from raw bytes.
INVALID_ARGUMENT_TO_PRIVATE_ENTRY_FUNCTION = 4
Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.
INDEX_OUT_OF_BOUNDS = 5
Out of bounds access to input or results. `index` field will be set indicating the invalid index value.
SECONDARY_INDEX_OUT_OF_BOUNDS = 6
Out of bounds access to subresult. `index` and `subresult` fields will be set indicating the invalid index value.
INVALID_RESULT_ARITY = 7
Invalid usage of result. Expected a single result but found either no return value or multiple. `index` field will be set indicating the invalid index value.
INVALID_GAS_COIN_USAGE = 8
Invalid usage of gas coin. The gas coin can only be used by-value with a `TransferObject` command.
INVALID_VALUE_USAGE = 9
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 = 10
Immutable objects cannot be passed by-value.
INVALID_OBJECT_BY_MUT_REF = 11
Immutable objects cannot be passed by mutable reference, `&mut`.
SHARED_OBJECT_OPERATION_NOT_ALLOWED = 12
Shared object operations such as wrapping, freezing, or converting to owned are not allowed.
message
transaction.proto:301Consensus commit prologue system transaction. This message can represent V1, V2, and V3 prologue types.
Used in:
optional uint64 epoch = 1
Epoch of the commit prologue transaction. Present in V1, V2, V3, V4.
optional uint64 round = 2
Consensus round of the commit. Present in V1, V2, V3, V4.
optional commit_timestamp = 3
Unix timestamp from consensus. Present in V1, V2, V3, V4.
optional string consensus_commit_digest = 4
Digest of consensus output. Present in V2, V3, V4.
optional uint64 sub_dag_index = 5
The sub DAG index of the consensus commit. This field is populated if there are multiple consensus commits per round. Present in V3, V4.
optional consensus_determined_version_assignments = 6
Stores consensus handler determined shared object version assignments. Present in V3, V4.
optional string additional_state_digest = 7
Digest of any additional state computed by the consensus handler. Used to detect forking bugs as early as possible. Present in V4.
message
transaction.proto:362Version assignments performed by consensus.
Used in:
oneof kind
canceled_transactions = 2
Canceled transaction version assignment.
message
checkpoint_summary.proto:80Data, which when included in a `CheckpointSummary`, signals the end of an `Epoch`.
Used in:
repeated next_epoch_committee = 1
The set of validators that will be in the `ValidatorCommittee` for the next epoch.
optional uint64 next_epoch_protocol_version = 2
The protocol version that is in effect during the next epoch.
repeated epoch_commitments = 3
Commitments to epoch specific state (live object set)
message
transaction.proto:417Set of operations run at the end of the epoch to close out the current epoch and start the next one.
Used in:
repeated transactions = 1
message
transaction.proto:422Operation run at the end of an epoch.
Used in:
oneof kind
change_epoch = 2
End the epoch and start the next one.
authenticator_state_expire = 3
Expire JWKs used for zklogin.
execution_time_observations = 4
Execution time observations from the committee to preserve cross epoch
authenticator_state_create = 200
Create and initialize the authenticator object used for zklogin.
randomness_state_create = 201
Create and initialize the randomness object.
deny_list_state_create = 202
Create and initialize the deny list object.
string bridge_state_create = 203
Create and initialize the bridge object.
uint64 bridge_committee_init = 204
Initialize the bridge committee.
message
event.proto:23An event.
Used in:
optional string package_id = 1
Package ID of the top-level function invoked by a `MoveCall` command that triggered this event to be emitted.
optional string module = 2
Module name of the top-level function invoked by a `MoveCall` command that triggered this event to be emitted.
optional string sender = 3
Address of the account that sent the transaction where this event was emitted.
optional string event_type = 4
The type of the event emitted.
optional contents = 5
BCS serialized bytes of the event.
message
executed_transaction.proto:16Used as response type in: LedgerService.GetTransaction
Used as field type in: , , ,
optional string digest = 1
The digest of this Transaction.
optional transaction = 2
The transaction itself.
repeated signatures = 3
List of user signatures that are used to authorize the execution of this transaction.
optional effects = 4
The `TransactionEffects` for this transaction.
optional events = 5
The `TransactionEvents` for this transaction. This field might be empty, even if it was explicitly requested, if the transaction didn't produce any events. `sui.types.TransactionEffects.events_digest` is populated if the transaction produced any events.
optional uint64 checkpoint = 6
The sequence number for the checkpoint that includes this transaction.
optional timestamp = 7
The Unix timestamp of the checkpoint that includes this transaction.
repeated balance_changes = 8
repeated input_objects = 10
Set of input objects used during the execution of this transaction.
repeated output_objects = 11
Set of output objects produced from the execution of this transaction.
message
execution_status.proto:18An error that can occur during the execution of a transaction.
Used in:
optional uint64 command = 1
The command, if any, during which the error occurred.
optional ExecutionError.ExecutionErrorKind kind = 2
optional uint64 abort_code = 3
Abort code from Move.
optional location = 4
Location in Move where the error occurred.
optional size_error = 5
optional command_argument_error = 6
optional type_argument_error = 7
optional package_upgrade_error = 8
optional uint32 index = 9
Index of an input or result.
optional uint32 subresult = 10
Index of a subresult.
optional string object_id = 11
optional string address = 12
Denied address.
optional string coin_type = 13
Coin type.
repeated string congested_objects = 14
Set of objects that were congested, leading to the transaction's cancellation.
Used in:
EXECUTION_ERROR_KIND_UNKNOWN = 0
INSUFFICIENT_GAS = 1
Insufficient gas.
INVALID_GAS_OBJECT = 2
Invalid `Gas` object.
INVARIANT_VIOLATION = 3
Invariant violation.
FEATURE_NOT_YET_SUPPORTED = 4
Attempted to use feature that is not supported yet.
OBJECT_TOO_BIG = 5
Move object is larger than the maximum allowed size.
PACKAGE_TOO_BIG = 6
Package is larger than the maximum allowed size.
CIRCULAR_OBJECT_OWNERSHIP = 7
Circular object ownership.
INSUFFICIENT_COIN_BALANCE = 8
Insufficient coin balance for requested operation.
COIN_BALANCE_OVERFLOW = 9
Coin balance overflowed an u64.
PUBLISH_ERROR_NON_ZERO_ADDRESS = 10
Publish error, non-zero address. The modules in the package must have their self-addresses set to zero.
SUI_MOVE_VERIFICATION_ERROR = 11
Sui Move bytecode verification error.
MOVE_PRIMITIVE_RUNTIME_ERROR = 12
Error from a non-abort instruction. Possible causes: Arithmetic error, stack overflow, max value depth, or similar.
MOVE_ABORT = 13
Move runtime abort.
VM_VERIFICATION_OR_DESERIALIZATION_ERROR = 14
Bytecode verification error.
VM_INVARIANT_VIOLATION = 15
MoveVm invariant violation.
FUNCTION_NOT_FOUND = 16
Function not found.
ARITY_MISMATCH = 17
Parity mismatch for Move function. The number of arguments does not match the number of parameters.
TYPE_ARITY_MISMATCH = 18
Type parity mismatch for Move function. Mismatch between the number of actual versus expected type arguments.
NON_ENTRY_FUNCTION_INVOKED = 19
Non-entry function invoked. Move Call must start with an entry function.
COMMAND_ARGUMENT_ERROR = 20
Invalid command argument.
TYPE_ARGUMENT_ERROR = 21
Type argument error.
UNUSED_VALUE_WITHOUT_DROP = 22
Unused result without the drop ability.
INVALID_PUBLIC_FUNCTION_RETURN_TYPE = 23
Invalid public Move function signature. Unsupported return type for return value.
INVALID_TRANSFER_OBJECT = 24
Invalid transfer object, object does not have public transfer.
EFFECTS_TOO_LARGE = 25
Effects from the transaction are too large.
PUBLISH_UPGRADE_MISSING_DEPENDENCY = 26
Publish or Upgrade is missing dependency.
PUBLISH_UPGRADE_DEPENDENCY_DOWNGRADE = 27
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 = 28
Invalid package upgrade.
WRITTEN_OBJECTS_TOO_LARGE = 29
Indicates the transaction tried to write objects too large to storage.
CERTIFICATE_DENIED = 30
Certificate is on the deny list.
SUI_MOVE_VERIFICATION_TIMEDOUT = 31
Sui Move bytecode verification timed out.
SHARED_OBJECT_OPERATION_NOT_ALLOWED = 32
The requested shared object operation is not allowed.
INPUT_OBJECT_DELETED = 33
Requested shared object has been deleted.
EXECUTION_CANCELED_DUE_TO_SHARED_OBJECT_CONGESTION = 34
Certificate is canceled due to congestion on shared objects.
ADDRESS_DENIED_FOR_COIN = 35
Address is denied for this coin type.
COIN_TYPE_GLOBAL_PAUSE = 36
Coin type is globally paused for use.
EXECUTION_CANCELED_DUE_TO_RANDOMNESS_UNAVAILABLE = 37
Certificate is canceled because randomness could not be generated this epoch.
message
execution_status.proto:9The status of an executed transaction.
Used in:
optional bool success = 1
Indicates if the transaction was successful or not.
optional error = 2
The error if `success` is false.
message
transaction.proto:463Used in:
optional ExecutionTimeObservation.ExecutionTimeObservationKind kind = 1
optional move_entry_point = 2
repeated validator_observations = 3
Used in:
EXECUTION_TIME_OBSERVATION_KIND_UNKNOWN = 0
MOVE_ENTRY_POINT = 1
TRANSFER_OBJECTS = 2
SPLIT_COINS = 3
MERGE_COINS = 4
PUBLISH = 5
MAKE_MOVE_VECTOR = 6
UPGRADE = 7
message
transaction.proto:456Used in:
optional int32 version = 1
Version of this ExecutionTimeObservations
repeated observations = 2
message
gas_cost_summary.proto:9Summary of gas charges.
Used in: ,
optional uint64 computation_cost = 1
Cost of computation/execution.
optional uint64 storage_cost = 2
Storage cost, it's the sum of all storage cost for all objects created or mutated.
optional uint64 storage_rebate = 3
The amount of storage cost refunded to the user for all objects deleted or mutated in the transaction.
optional uint64 non_refundable_storage_fee = 4
The fee for the rebate. The portion of the storage rebate kept by the system.
message
transaction.proto:35Payment information for executing a transaction.
Used in:
repeated objects = 1
Set of gas objects to use for payment.
optional string owner = 2
Owner of the gas objects, either the transaction sender or a sponsor.
optional uint64 price = 3
Gas unit price to use when charging for computation. Must be greater than or equal to the network's current RGP (reference gas price).
optional uint64 budget = 4
Total budget willing to spend for the execution of a transaction.
message
transaction.proto:293The genesis transaction.
Used in:
repeated objects = 1
Set of genesis objects.
message
ledger_service.proto:63Used as request type in: LedgerService.GetObject
Used as field type in:
optional string object_id = 1
Required. The `ObjectId` of the requested object.
optional uint64 version = 2
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.
optional read_mask = 3
Mask specifying which fields to read. If no mask is specified, defaults to `object_id,version,digest`.
message
input.proto:11An input to a user transaction.
Used in:
optional Input.InputKind kind = 1
optional bytes pure = 2
A move value serialized as BCS. For normal operations this is required to be a move primitive type and not contain structs or objects.
optional string object_id = 3
`ObjectId` of the object input.
optional uint64 version = 4
Requested version of the input object when `kind` is `IMMUTABLE_OR_OWNED` or `RECEIVING` or if `kind` is `SHARED` this is the initial version of the object when it was shared
optional string digest = 5
The digest of this object.
optional bool mutable = 6
Controls whether the caller asks for a mutable reference to the shared object.
optional literal = 1000
A literal value INPUT ONLY
Used in:
INPUT_KIND_UNKNOWN = 0
PURE = 1
A move value serialized as BCS.
IMMUTABLE_OR_OWNED = 2
A Move object that is either immutable or address owned.
SHARED = 3
A Move object whose owner is "Shared".
RECEIVING = 4
A Move object that is attempted to be received in this transaction.
message
transaction.proto:404A JSON web key. Struct that contains info for a JWK. A list of them for different kinds can be retrieved from the JWK endpoint (for example, <https://www.googleapis.com/oauth2/v3/certs>). The JWK is used to verify the JWT token.
Used in:
optional string kty = 1
Key type parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.1.
optional string e = 2
RSA public exponent, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
optional string n = 3
RSA modulus, https://datatracker.ietf.org/doc/html/rfc7517#section-9.3.
optional string alg = 4
Algorithm parameter, https://datatracker.ietf.org/doc/html/rfc7517#section-4.4.
message
transaction.proto:392Key to uniquely identify a JWK.
Used in:
optional string iss = 1
The issuer or identity of the OIDC provider.
optional string kid = 2
A key ID used to uniquely identify a key from an OIDC provider.
message
transaction.proto:220Command to build a Move vector out of a set of individual elements.
Used in:
optional string element_type = 1
Type of the individual elements. This is required to be set when the type can't be inferred, for example when the set of provided arguments are all pure input values.
repeated elements = 2
The set individual elements to build the vector with.
message
transaction.proto:200Command to merge multiple coins of the same type into a single coin.
Used in:
optional coin = 1
Coin to merge coins into.
repeated coins_to_merge = 2
Set of coins to merge into `coin`. All listed coins must be of the same type and be the same type as `coin`
message
transaction.proto:170Command to call a Move function. Functions that can be called by a `MoveCall` command are those that have a function signature that is either `entry` or `public` (which don't have a reference return type).
Used in: ,
optional string package = 1
The package containing the module and function.
optional string module = 2
The specific module in the package containing the function.
optional string function = 3
The function to be called.
repeated string type_arguments = 4
The type arguments to the function.
repeated arguments = 5
The arguments to the function.
message
execution_status.proto:207Location in Move bytecode where an error occurred.
Used in:
optional string package = 1
The package ID.
optional string module = 2
The module name.
optional uint32 function = 3
The function index.
optional uint32 instruction = 4
Offset of the instruction where the error occurred.
optional string function_name = 5
The name of the function, if available.
message
object.proto:71Module defined by a package.
Used in:
optional string name = 1
Name of the module.
optional bytes contents = 2
Serialized bytecode of the module.
message
signature.proto:75Aggregated signature from members of a multisig committee.
Used in:
repeated signatures = 1
The plain signatures encoded with signature scheme. The signatures must be in the same order as they are listed in the committee.
optional uint32 bitmap = 2
Bitmap indicating which committee members contributed to the signature.
repeated uint32 legacy_bitmap = 3
If present, means this signature's on-chain format uses the old legacy multisig format.
optional committee = 4
The committee to use to validate this signature.
message
signature.proto:66A multisig committee.
Used in:
repeated members = 1
A list of committee members and their corresponding weight.
optional uint32 threshold = 2
The threshold of signatures needed to validate a signature from this committee.
message
signature.proto:58A member in a multisig committee.
Used in:
optional public_key = 1
The public key of the committee member.
optional uint32 weight = 2
The weight of this member's signature.
message
signature.proto:46Set of valid public keys for multisig committee members.
Used in:
optional SignatureScheme scheme = 1
The signature scheme of this public key.
optional bytes public_key = 2
Public key bytes if scheme is ed25519 | secp256k1 | secp256r1.
optional zklogin = 3
A zklogin public identifier if scheme is zklogin.
message
signature.proto:92A signature from a member of a multisig committee.
Used in:
optional SignatureScheme scheme = 1
The signature scheme of this signature.
optional bytes signature = 2
Signature bytes if scheme is ed25519 | secp256k1 | secp256r1.
optional zklogin = 3
The zklogin authenticator if scheme is `ZKLOGIN`.
message
object.proto:12An object on the Sui blockchain.
Used as response type in: LedgerService.GetObject
Used as field type in: , ,
optional bcs = 1
This Object serialized as BCS.
optional string object_id = 2
`ObjectId` for this object.
optional uint64 version = 3
Version of the object.
optional string digest = 4
The digest of this Object.
optional owner = 5
Owner of the object.
optional string object_type = 6
The type of this object. This will be 'package' for packages and a StructTag for move structs.
optional bool has_public_transfer = 7
DEPRECATED this field is no longer used to determine whether a tx can transfer this object. Instead, it is always calculated from the objects type when loaded in execution. Only set for Move structs
optional contents = 8
BCS bytes of a Move struct value. Only set for Move structs
repeated modules = 9
Set of modules defined by this package. Only set for Packages
repeated type_origin_table = 10
Maps struct/module to a package version where it was first defined, stored as a vector for simple serialization and deserialization. Only set for Packages
repeated linkage_table = 11
For each dependency, maps original package ID to the info about the (upgraded) dependency version that this package is using. Only set for Packages
optional string previous_transaction = 12
The digest of the transaction that created or last mutated this object
optional uint64 storage_rebate = 13
The amount of SUI to rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.
message
object_reference.proto:9Reference to an object.
Used in:
optional string object_id = 1
The object ID of this object.
optional uint64 version = 2
The version of this object.
optional string digest = 3
The digest of this object.
message
owner.proto:9Enum of different types of ownership for an object.
Used in: , ,
optional Owner.OwnerKind kind = 1
optional string address = 2
Address or ObjectId of the owner
optional uint64 version = 3
Used in:
OWNER_KIND_UNKNOWN = 0
ADDRESS = 1
OBJECT = 2
SHARED = 3
IMMUTABLE = 4
message
execution_status.proto:287An error with upgrading a package.
Used in:
optional PackageUpgradeError.PackageUpgradeErrorKind kind = 1
optional string package_id = 2
The Package Id.
optional string digest = 3
A digest.
optional uint32 policy = 4
The policy.
optional string ticket_id = 5
The ticket Id.
Used in:
PACKAGE_UPGRADE_ERROR_KIND_UNKNOWN = 0
UNABLE_TO_FETCH_PACKAGE = 1
Unable to fetch package.
NOT_A_PACKAGE = 2
Object is not a package.
INCOMPATIBLE_UPGRADE = 3
Package upgrade is incompatible with previous version.
DIGETS_DOES_NOT_MATCH = 4
Digest in upgrade ticket and computed digest differ.
UNKNOWN_UPGRADE_POLICY = 5
Upgrade policy is not valid.
PACKAGE_ID_DOES_NOT_MATCH = 6
Package ID does not match `PackageId` in upgrade ticket.
message
signature.proto:169A passkey authenticator. See [struct.PasskeyAuthenticator](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/struct.PasskeyAuthenticator.html#bcs) for more information on the requirements on the shape of the `client_data_json` field.
Used in:
optional bytes authenticator_data = 1
Opaque authenticator data for this passkey signature. See [Authenticator Data](https://www.w3.org/TR/webauthn-2/#sctn-authenticator-data) for more information on this field.
optional string client_data_json = 2
Structured, unparsed, JSON for this passkey signature. See [CollectedClientData](https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata) for more information on this field.
optional signature = 3
A secp256r1 signature.
message
transaction.proto:117A user transaction. Contains a series of native commands and Move calls where the results of one command can be used in future commands.
Used in:
repeated inputs = 1
Input objects or primitive values.
repeated commands = 2
The commands to be executed sequentially. A failure in any command results in the failure of the entire transaction.
message
protocol_config.proto:8Used in:
optional uint64 protocol_version = 1
map<string, bool> feature_flags = 2
map<string, string> attributes = 3
message
transaction.proto:211Command to publish a new Move package.
Used in:
repeated bytes modules = 1
The serialized Move modules.
repeated string dependencies = 2
Set of packages that the to-be published package depends on.
message
transaction.proto:244Randomness update.
Used in:
optional uint64 epoch = 1
Epoch of the randomness state update transaction.
optional uint64 randomness_round = 2
Randomness round of the update.
optional bytes random_bytes = 3
Updated random bytes.
optional uint64 randomness_object_initial_shared_version = 4
The initial version of the randomness object that it was shared at.
Flag use to disambiguate the signature schemes supported by Sui. Note: the enum values defined by this proto message exactly match their expected BCS serialized values when serialized as a u8. See [enum.SignatureScheme](https://mystenlabs.github.io/sui-rust-sdk/sui_sdk_types/enum.SignatureScheme.html) for more information about signature schemes.
Used in: , ,
ED25519 = 0
SECP256K1 = 1
SECP256R1 = 2
MULTISIG = 3
BLS12381 = 4
ZKLOGIN = 5
PASSKEY = 6
message
execution_status.proto:199A size error.
Used in:
optional uint64 size = 1
The offending size.
optional uint64 max_size = 2
The maximum allowable size.
message
transaction.proto:192Command to split a single coin object into multiple coins.
Used in:
optional coin = 1
The coin to split.
repeated amounts = 2
The amounts to split off.
message
transaction.proto:283System package.
Used in:
optional uint64 version = 1
Version of the package.
repeated bytes modules = 2
Move modules.
repeated string dependencies = 3
Package dependencies.
message
transaction.proto:18A transaction.
Used in: , , , ,
optional bcs = 1
This Transaction serialized as BCS.
optional string digest = 2
The digest of this Transaction.
optional int32 version = 3
Version of this Transaction.
optional kind = 4
optional string sender = 5
optional gas_payment = 6
optional expiration = 7
message
effects.proto:14The effects of executing a transaction.
Used in:
optional bcs = 1
This TransactionEffects serialized as BCS.
optional string digest = 2
The digest of this TransactionEffects.
optional int32 version = 3
Version of this TransactionEffects.
optional status = 4
The status of the execution.
optional uint64 epoch = 5
The epoch when this transaction was executed.
optional gas_used = 6
The gas used by this transaction.
optional string transaction_digest = 7
The transaction digest.
optional gas_object = 8
Information about the gas object. Also present in the `changed_objects` vector. System transaction that don't require gas will leave this as `None`.
optional string events_digest = 9
The digest of the events emitted during execution, can be `None` if the transaction does not emit any event.
repeated string dependencies = 10
The set of transaction digests this transaction depends on.
optional uint64 lamport_version = 11
The version number of all the written objects (excluding packages) by this transaction.
repeated changed_objects = 12
Objects whose state are changed by this transaction.
repeated unchanged_shared_objects = 13
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.
optional string auxiliary_data_digest = 14
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.
message
event.proto:11Events emitted during the successful execution of a transaction.
Used in:
optional bcs = 1
This TransactionEvents serialized as BCS.
optional string digest = 2
The digest of this TransactionEvents.
repeated events = 3
Set of events emitted by a transaction.
message
transaction.proto:52A TTL for a transaction.
Used in:
optional TransactionExpiration.TransactionExpirationKind kind = 1
optional uint64 epoch = 2
Used in:
TRANSACTION_EXPIRATION_KIND_UNKNOWN = 0
NONE = 1
The transaction has no expiration.
EPOCH = 2
Validators won't sign and execute transaction unless the expiration epoch is greater than or equal to the current epoch.
Indicates the finality of the executed transaction.
Used in:
oneof finality
certified = 1
A quorum certificate certifying that a transaction is final but might not be included in a checkpoint yet.
uint64 checkpointed = 2
Sequence number of the checkpoint that includes the transaction.
quorum_executed = 3
Indicates that a quorum of validators has executed the transaction but that it might not be included in a checkpoint yet.
message
transaction.proto:70Transaction type.
Used in:
oneof kind
programmable_transaction = 2
A user transaction comprised of a list of native commands and Move calls.
change_epoch = 100
System transaction used to end an epoch. The `ChangeEpoch` variant is now deprecated (but the `ChangeEpoch` struct is still used by `EndOfEpochTransaction`).
genesis = 101
Transaction used to initialize the chain state. Only valid if in the genesis checkpoint (0) and if this is the very first transaction ever executed on the chain.
consensus_commit_prologue_v1 = 102
V1 consensus commit update.
authenticator_state_update = 103
Update set of valid JWKs used for zklogin.
end_of_epoch = 104
Set of operations to run at the end of the epoch to close out the current epoch and start the next one.
randomness_state_update = 105
Randomness update.
consensus_commit_prologue_v2 = 106
V2 consensus commit update.
consensus_commit_prologue_v3 = 107
V3 consensus commit update.
consensus_commit_prologue_v4 = 108
V4 consensus commit update.
message
transaction.proto:184Command to transfer ownership of a set of objects to an address.
Used in:
repeated objects = 1
Set of objects to transfer.
optional address = 2
The address to transfer ownership to.
message
execution_status.proto:326Type argument error.
Used in:
optional uint32 type_argument = 1
Index of the problematic type argument.
optional TypeArgumentError.TypeArgumentErrorKind kind = 2
Used in:
TYPE_ARGUMENT_ERROR_KIND_UNKNOWN = 0
TYPE_NOT_FOUND = 1
A type was not found in the module specified.
CONSTRAINT_NOT_SATISFIED = 2
A type provided did not match the specified constraint.
message
object.proto:79Identifies a struct and the module it was defined in.
Used in:
optional string module_name = 1
optional string struct_name = 2
optional string package_id = 3
message
effects.proto:117A shared object that wasn't changed during execution.
Used in:
optional UnchangedSharedObject.UnchangedSharedObjectKind kind = 1
optional string object_id = 2
ObjectId of the shared object.
optional uint64 version = 3
Version of the shared object.
optional string digest = 4
Digest of the shared object.
optional string object_type = 5
Type information is not provided by the effects structure but is instead provided by an indexing layer
Used in:
UNCHANGED_SHARED_OBJECT_KIND_UNKNOWN = 0
READ_ONLY_ROOT = 1
Read-only shared object from the input.
MUTATE_DELETED = 2
Deleted shared objects that appear mutably/owned in the input.
READ_DELETED = 3
Deleted shared objects that appear as read-only in the input.
CANCELED = 4
Shared objects that was congested and resulted in this transaction being canceled.
PER_EPOCH_CONFIG = 5
Read of a per-epoch config object that should remain the same during an epoch.
message
transaction.proto:232Command to upgrade an already published package.
Used in:
repeated bytes modules = 1
The serialized Move modules.
repeated string dependencies = 2
Set of packages that the to-be published package depends on.
optional string package = 3
Package ID of the package to upgrade.
optional ticket = 4
Ticket authorizing the upgrade.
message
object.proto:86/ Upgraded package info for the linkage table.
Used in:
optional string original_id = 1
ID of the original package.
optional string upgraded_id = 2
ID of the upgraded package.
optional uint64 upgraded_version = 3
Version of the upgraded package.
message
signature.proto:12A signature from a user.
Used in: , , , ,
optional bcs = 1
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.
optional SignatureScheme scheme = 2
The signature scheme of this signature.
optional bytes signature = 3
Signature bytes if scheme is ed25519 | secp256k1 | secp256r1.
optional bytes public_key = 4
Public key bytes if scheme is ed25519 | secp256k1 | secp256r1.
optional multisig = 5
The multisig aggregated signature if scheme is `MULTISIG`.
optional zklogin = 6
The zklogin authenticator if scheme is `ZKLOGIN`.
optional passkey = 7
The passkey authenticator if scheme is `PASSKEY`.
message
signature.proto:205/ An aggregated signature from multiple validators.
Used in: ,
optional uint64 epoch = 1
The epoch when this signature was produced. This can be used to lookup the `ValidatorCommittee` from this epoch to verify this signature.
optional bytes signature = 2
The 48-byte Bls12381 aggregated signature.
repeated uint32 bitmap = 3
Bitmap indicating which members of the committee contributed to this signature.
message
signature.proto:187The validator set for a particular epoch.
Used in:
optional uint64 epoch = 1
The epoch where this committee governs.
repeated members = 2
The committee members.
message
signature.proto:196A member of a validator committee.
Used in: ,
optional bytes public_key = 1
The 96-byte Bls12381 public key for this validator.
optional uint64 stake = 2
Stake weight this validator possesses.
message
transaction.proto:483Used in:
optional bytes validator = 1
Bls12381 public key of the validator
optional duration = 2
Duration of an execution observation
message
transaction.proto:341Object version assignment from consensus.
Used in:
optional string object_id = 1
`ObjectId` of the object.
optional uint64 version = 2
Assigned version.
message
signature.proto:104A zklogin authenticator.
Used in: ,
optional inputs = 1
Zklogin proof and inputs required to perform proof verification.
optional uint64 max_epoch = 2
Maximum epoch for which the proof is valid.
optional signature = 3
User signature with the public key attested to by the provided proof.
message
signature.proto:130A claim of the iss in a zklogin proof.
Used in:
optional string value = 1
optional uint32 index_mod_4 = 2
message
signature.proto:114A zklogin groth16 proof and the required inputs to perform proof verification.
Used in:
optional proof_points = 1
optional iss_base64_details = 2
optional string header_base64 = 3
optional string address_seed = 4
base10 encoded Bn254FieldElement
message
signature.proto:123A zklogin groth16 proof.
Used in:
optional a = 1
optional b = 2
optional c = 3
message
signature.proto:39Public key equivalent for zklogin authenticators.
Used in:
optional string iss = 1
optional string address_seed = 2
base10 encoded Bn254FieldElement