Skip to content

sui_getCheckpoint ​

Read API

Return a checkpoint

Parameters ​

Result ​

  • Checkpoint · Checkpoint

    • checkpointCommitments · CheckpointCommitment[] · requiredCommitments to checkpoint state
    • digest · CheckpointDigest · requiredCheckpoint digest
    • endOfEpochData · EndOfEpochData or null · optionalPresent only on the final checkpoint of the epoch.
    • epoch · BigInt<u64> · requiredCheckpoint's epoch ID
    • epochRollingGasCostSummary · GasCostSummary · requiredThe running total gas costs of all transactions included in the current epoch so far until this checkpoint.
    • networkTotalTransactions · BigInt<u64> · requiredTotal number of transactions committed since genesis, including those in this checkpoint.
    • previousDigest · CheckpointDigest or null · optionalDigest of the previous checkpoint
    • sequenceNumber · BigInt<u64> · requiredCheckpoint sequence number
    • timestampMs · BigInt<u64> · requiredTimestamp of the checkpoint - number of milliseconds from the Unix epoch Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent checkpoints can have same timestamp if they originate from the same underlining consensus commit
    • transactions · TransactionDigest[] · requiredTransaction digests
    • validatorSignature · Base64 · requiredValidator Signature

Example ​

Request ​

bash
curl https://mainnet-api.inodra.com/v1/jsonrpc \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "sui_getCheckpoint",
  "params": [
    "1000"
  ]
}'

Response ​

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "epoch": "5000",
    "sequenceNumber": "1000",
    "digest": "G6Dtzr1ZSfHFhotGsTE3cLENa7L1ooe1BBvknAUsARbV",
    "networkTotalTransactions": "792385",
    "previousDigest": "6tBy8RXZKrdrB4XkMQn7J3MNG4fQCo9XcRduFFvYrL5Z",
    "epochRollingGasCostSummary": {
      "computationCost": "0",
      "storageCost": "0",
      "storageRebate": "0",
      "nonRefundableStorageFee": "0"
    },
    "timestampMs": "1676911928",
    "transactions": [
      "mN8YNBgVR3wB7vfXmjVgDRF4oqxVRRjzmJ6U4mzbq77"
    ],
    "checkpointCommitments": [],
    "validatorSignature": "wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
  }
}

The full-stack Sui data layer.