gRPCGetCheckpoint

sui-mainnet.nodit.io:443 sui.rpc.v2.LedgerService/GetCheckpointunary

Retrieves the information of the specified checkpoint.

TransportgRPC

Request and response messages are identical for both transports. Only the wire protocol, headers, and client library differ.

Protocol
Native gRPC over HTTP/2 with TLS. Suited to server-side clients and grpcurl.
Content-Type
application/grpc
Headers
x-api-key
Streaming
Server, client, and bidirectional streaming are all supported.
Errors
grpc-status and grpc-message are delivered as HTTP/2 trailers.
Request Body
sequence_numberinteger

The sequence number of the requested checkpoint.

digeststring

The digest of the requested checkpoint.

pathsstring[]

The set of field mask paths (e.g. "object_id", "version", "digest").

Responses
sequence_numberinteger

The height of this checkpoint.

digeststring

The digest of this Checkpoint's CheckpointSummary.

summaryobject

The checkpoint summary.

bcsobject

CheckpointSummary serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

digeststring

The digest of this CheckpointSummary.

epochinteger

Epoch this checkpoint belongs to.

sequence_numberinteger

Height of the checkpoint.

total_network_transactionsinteger

Total number of transactions since genesis.

content_digeststring

The hash of the CheckpointContents for this checkpoint.

previous_digeststring

Hash of the previous CheckpointSummary.

epoch_rolling_gas_cost_summaryobject

Running total of gas costs for the epoch.

computation_costinteger

Computation cost.

storage_costinteger

Storage cost.

storage_rebateinteger

Storage rebate.

non_refundable_storage_feeinteger

Non-refundable storage fee.

timestampstring

Timestamp in milliseconds from the Unix epoch.

commitmentsobject[]

Commitments to checkpoint-specific state.

kindstring

Kind of the checkpoint commitment.

digeststring

Digest of the commitment.

end_of_epoch_dataobject

Data present only in the final checkpoint of an epoch.

next_epoch_committeeobject[]

Committee of validators for the next epoch.

public_keystring

The 96-byte Bls12381 public key for this validator.

weightinteger

Voting weight this validator possesses.

next_epoch_protocol_versioninteger

Protocol version for the next epoch.

epoch_commitmentsobject[]

Commitments for the epoch.

kindstring

Kind of the checkpoint commitment.

digeststring

Digest of the commitment.

version_specific_datastring

Version-specific data.

signatureobject

Aggregated validator signature over the summary.

epochinteger

The epoch when this signature was produced. This can be used to lookup the ValidatorCommittee from this epoch to verify this signature.

signaturestring

The 48-byte Bls12381 aggregated signature.

bitmapstring

Bitmap indicating which members of the committee contributed to this signature.

contentsobject

Committed contents of the checkpoint.

bcsobject

CheckpointContents serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

digeststring

Digest of the CheckpointContents.

versioninteger

Version of this CheckpointContents.

transactionsobject[]

Set of transactions committed to in this checkpoint.

transactionstring

Digest of the transaction.

effectsstring

Digest of the effects.

signaturesobject[]

Set of user signatures that authorized the transaction.

bcsobject

This signature serialized as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.

schemestring

The signature scheme of this signature.

simpleobject

Simple signature if scheme is ed25519 | secp256k1 | secp256r1.

multisigobject

The multisig aggregated signature if scheme is MULTISIG.

zkloginobject

The zklogin authenticator if scheme is ZKLOGIN.

passkeyobject

The passkey authenticator if scheme is PASSKEY.

address_aliases_versionsobject[]

The AddressAliases object version used to verify the UserSignature at the same position in signatures. Present when CheckpointContents.version >= 2.

versioninteger

Version of the address aliases.

transactionsobject[]

Transactions executed in this checkpoint.

digeststring

Transaction digest.

transactionobject

The transaction itself.

bcsobject

Transaction serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

digeststring

Transaction digest.

versioninteger

Version of the transaction structure.

kindobject

Kind of the transaction.

kindstring

Kind discriminator.

programmable_transactionobject

A programmable (user) transaction.

change_epochobject

A change-epoch system transaction.

genesisobject

The genesis transaction.

consensus_commit_prologueobject

A consensus commit prologue transaction.

authenticator_state_updateobject

An authenticator state update transaction.

end_of_epochobject

An end-of-epoch transaction.

randomness_state_updateobject

A randomness state update transaction.

senderstring

Address of the sender.

gas_paymentobject

Gas payment information.

objectsobject[]

Set of gas objects to use for payment.

ownerstring

Owner of the gas objects, either the transaction sender or a sponsor.

priceinteger

Gas unit price to use when charging for computation. Must be greater than or equal to the network's current RGP (reference gas price).

budgetinteger

Total budget willing to spend for the execution of a transaction.

expirationobject

Transaction expiration (TTL).

kindstring

Kind of the expiration.

epochinteger

Maximum epoch after which the transaction expires.

min_epochinteger

Minimum epoch before which the transaction is invalid.

min_timestampstring

Minimum valid timestamp.

max_timestampstring

Maximum valid timestamp.

chainstring

ChainId used for replay protection.

nonceinteger

Uniqueness identifier.

signaturesobject[]

Signatures on the transaction.

bcsobject

This signature serialized as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

schemestring

The signature scheme of this signature.

simpleobject

Simple signature if scheme is ed25519 | secp256k1 | secp256r1.

schemestring

The signature scheme of this signature.

signaturestring

Signature bytes.

public_keystring

Public key bytes.

multisigobject

The multisig aggregated signature if scheme is MULTISIG.

signaturesobject[]

The plain signatures encoded with signature scheme. The signatures must be in the same order as they are listed in the committee.

bitmapinteger

Bitmap indicating which committee members contributed to the signature.

legacy_bitmapstring

If present, means this signature's on-chain format uses the old legacy multisig format.

committeeobject

The multisig committee used to validate this signature.

zkloginobject

The zklogin authenticator if scheme is ZKLOGIN.

inputsobject

Zklogin proof and inputs required to perform proof verification.

max_epochinteger

Maximum epoch for which the proof is valid.

signatureobject

The ephemeral signature.

public_identifierobject

The public identifier (similar to a public key) for this zklogin authenticator.

jwk_idobject

The id of the JWK used to authorize this zklogin authenticator.

passkeyobject

The passkey authenticator if scheme is PASSKEY.

authenticator_datastring

Opaque authenticator data for this passkey signature.

client_data_jsonstring

Structured, unparsed JSON for this passkey signature.

signatureobject

A secp256r1 signature.

effectsobject

Effects of the transaction.

bcsobject

Effects serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

digeststring

Digest of the effects.

versioninteger

Version of the effects structure.

statusobject

Execution status.

successboolean

Whether execution succeeded.

errorobject

Error information if execution failed.

epochinteger

Epoch of execution.

gas_usedobject

Summary of gas used.

computation_costinteger

Computation cost.

storage_costinteger

Storage cost.

storage_rebateinteger

Storage rebate.

non_refundable_storage_feeinteger

Non-refundable storage fee.

transaction_digeststring

Digest of the executed transaction.

gas_objectobject

The gas object after execution.

object_idstring

ObjectId of the changed object.

input_statestring

Input state of the object.

input_versioninteger

Input version.

input_digeststring

Input digest.

input_ownerobject

Owner before the change.

output_statestring

Output state of the object.

output_versioninteger

Output version.

output_digeststring

Output digest.

output_ownerobject

Owner after the change.

accumulator_writeobject

Accumulator write operation, if any.

id_operationstring

ID operation (created/deleted/etc.).

object_typestring

Type of the object.

events_digeststring

Digest of the emitted events.

dependenciesstring[]

Transactions this transaction depends on.

lamport_versioninteger

Lamport version of written objects.

changed_objectsobject[]

Objects changed during execution.

object_idstring

ObjectId of the changed object.

input_statestring

Input state of the object.

input_versioninteger

Input version.

input_digeststring

Input digest.

input_ownerobject

Owner before the change.

output_statestring

Output state of the object.

output_versioninteger

Output version.

output_digeststring

Output digest.

output_ownerobject

Owner after the change.

accumulator_writeobject

Accumulator write operation, if any.

id_operationstring

ID operation (created/deleted/etc.).

object_typestring

Type of the object.

unchanged_consensus_objectsobject[]

Consensus objects not changed during execution.

kindstring

Kind of the unchanged consensus object.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

Digest of the object.

object_typestring

Type of the object.

auxiliary_data_digeststring

Digest of auxiliary data.

unchanged_loaded_runtime_objectsobject[]

Loaded runtime objects that were not changed.

object_idstring

The object id of this object.

versioninteger

The version of this object.

digeststring

The digest of this object.

eventsobject

Events emitted by the transaction.

bcsobject

TransactionEvents serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

digeststring

Digest of the TransactionEvents.

eventsobject[]

Set of events emitted by a transaction.

package_idstring

Package ID of the invoked function.

modulestring

Module name of the top-level function of a MoveCall command that triggered this event to be emitted.

senderstring

Address of the transaction sender.

event_typestring

Type of the emitted event.

contentsobject

BCS serialized bytes of the event.

jsonobject

JSON rendering of the event.

checkpointinteger

Checkpoint including this transaction.

timestampstring

Timestamp of execution.

balance_changesobject[]

Balance changes caused by the transaction.

addressstring

The affected account address.

coin_typestring

Coin type.

amountstring

Balance change amount.

objectsobject

Objects related to the transaction.

objectsobject[]

Objects, sorted by object_id and version.

bcsobject

This Object serialized as BCS.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

The digest of this Object.

ownerobject

Owner of the object.

object_typestring

Type of the object.

has_public_transferboolean

DEPRECATED. Whether the object has public transfer.

contentsobject

BCS bytes of a Move struct value. Only set for Move structs.

packageobject

Package data if the object is a package.

previous_transactionstring

Digest of the transaction that created or last mutated this object.

storage_rebateinteger

Storage rebate for the object.

jsonobject

JSON rendering of the object.

balanceinteger

Current balance if this object is a 0x2::coin::Coin<T>.

displayobject

Template-based display rendering.

objectsobject

Set of objects either referenced as inputs or produced as outputs by transactions included in this checkpoint. Objects appear here for deduplication; transactions.objects will not be populated.

objectsobject[]

Objects, sorted by object_id and version.

bcsobject

This Object serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

The digest of this Object.

ownerobject

Owner of the object.

kindstring

Kind of ownership.

addressstring

Address or ObjectId of the owner.

versioninteger

The initial_shared_version if kind is SHARED or start_version if kind is CONSENSUS_ADDRESS.

object_typestring

Type of the object.

has_public_transferboolean

DEPRECATED. Whether the object has public transfer.

contentsobject

BCS bytes of a Move struct value. Only set for Move structs.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

packageobject

Package data if the object is a package.

storage_idstring

Package ObjectId (storage ID).

original_idstring

ID of the first published version.

versioninteger

Version of the package.

modulesobject[]

Modules in the package.

type_originsobject[]

Type origins for the package's types.

linkageobject[]

Transitive dependencies (linkage table).

previous_transactionstring

Digest of the transaction that created or last mutated this object.

storage_rebateinteger

Storage rebate for the object.

jsonobject

JSON rendering of the object.

balanceinteger

Current balance if this object is a 0x2::coin::Coin<T>.

displayobject

Template-based display rendering.

outputobject

Substituted display fields.

errorsobject

Fields that failed to render.

X-API-KEY
RequestCU10
grpcurl
grpcurl \
  -import-path . -proto sui/rpc/v2/ledger_service.proto \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -d '{
  "sequence_number": 12345678,
  "digest": "7Gy9UsHEyJm1m1ANwLzpMPpFVGt3XoMMfbVgsCuFZHNN",
  "read_mask": {
    "paths": []
  }
}' \
  sui-mainnet.nodit.io:443 sui.rpc.v2.LedgerService/GetCheckpoint
Response
Example · 200
{
  "checkpoint": {}
}