> For the complete documentation index, see [llms.txt](https://docs.getblock.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getblock.io/api-reference/sui-sui/ledgerservice-getcheckpoint-sui.md). # LedgerService/GetCheckpoint - SUI Returns a checkpoint by sequence number or digest. Checkpoints are Sui's primary unit of progress — they're produced every \~400ms and group together all transactions executed in that window. Equivalent in spirit to blocks on other chains. **Service**: `sui.rpc.v2.LedgerService`\ **Proto file**: [`sui/rpc/v2/ledger_service.proto`](https://github.com/MystenLabs/sui-apis/blob/main/proto/sui/rpc/v2/ledger_service.proto)\ **Full method path**: `sui.rpc.v2.LedgerService/GetCheckpoint` ## Request Fields | Field | Type | Required | Description | | ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------- | | sequence\_number | uint64 (one of) | Yes\* | Checkpoint sequence number (provide either this OR `digest`) | | digest | string (one of) | Yes\* | Checkpoint digest (Base58) (provide either this OR `sequence_number`) | | read\_mask | FieldMask | No | Field paths — e.g. `["sequence_number", "digest", "summary"]`. Use `["*"]` for all fields | ## Request Example {% tabs %} {% tab title="grpcurl" %} ```bash # Clone the official proto files first (one-time setup): # git clone https://github.com/MystenLabs/sui-apis.git && cd sui-apis grpcurl \ -import-path proto \ -proto sui/rpc/v2/ledger_service.proto \ -H "x-grpc-web: 1" \ -d '{ "sequence_number": "260411497", "read_mask": { "paths": [ "*" ] } }' \ shared.eu-central-1.getblock.io:443/ \ sui.rpc.v2.LedgerService/GetCheckpoint ``` {% endtab %} {% tab title="TypeScript (@grpc/grpc-js)" %} ```typescript import * as grpc from '@grpc/grpc-js'; import * as protoLoader from '@grpc/proto-loader'; import * as path from 'path'; const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2/ledger_service.proto'); const ACCESS_TOKEN = ''; const packageDef = protoLoader.loadSync(PROTO_PATH, { includeDirs: [path.join(__dirname, 'protos/proto')], keepCase: true, longs: String, enums: String, defaults: true, }); const proto = grpc.loadPackageDefinition(packageDef) as any; const ServiceClient = proto.sui.rpc.v2.LedgerService; const metadata = new grpc.Metadata(); metadata.add('authorization', `Bearer ${ACCESS_TOKEN}`); const client = new ServiceClient('shared.eu-central-1.getblock.io:443', grpc.credentials.createSsl()); const request = { "sequence_number": "260411497", "read_mask": { "paths": [ "*" ] } }; client.GetCheckpoint(request, metadata, (err: any, response: any) => { if (err) { console.error('Error:', err); return; } console.log(JSON.stringify(response, null, 2)); }); ``` {% endtab %} {% tab title="Python (grpcio)" %} ```python # First generate Python stubs from the proto files (one-time setup): # pip install grpcio grpcio-tools # python -m grpc_tools.protoc -I=proto --python_out=. --grpc_python_out=. \ # proto/sui/rpc/v2/ledger_service.proto import grpc from sui.rpc.v2 import sui_rpc_v2_ledger_service_pb2, sui_rpc_v2_ledger_service_pb2_grpc from google.protobuf.json_format import ParseDict, MessageToJson ACCESS_TOKEN = '' channel = grpc.secure_channel('shared.eu-central-1.getblock.io:443', grpc.ssl_channel_credentials()) stub = sui_rpc_v2_ledger_service_pb2_grpc.LedgerServiceStub(channel) metadata = [('authorization', f'Bearer {ACCESS_TOKEN}')] # Build the request message from a dict via ParseDict for readability request_data = { "sequence_number": "260411497", "read_mask": { "paths": [ "*" ] } } request = ParseDict(request_data, sui_rpc_v2_ledger_service_pb2.LedgerRequest()) # (Use the appropriate Request type — adjust as needed for the specific method.) response = stub.GetCheckpoint(request, metadata=metadata) print(response) ``` {% endtab %} {% tab title="Rust (tonic)" %} ```rust // Add to Cargo.toml: // tonic = "0.12" // prost = "0.13" // tokio = { version = "1", features = ["full"] } // Plus a build.rs invoking tonic_build on the Sui proto files. use tonic::{transport::Channel, Request}; use sui_rpc_v2::ledger_service_client::LedgerServiceClient; // Plus the relevant Request type import from sui_rpc_v2. #[tokio::main] async fn main() -> Result<(), Box> { let channel = Channel::from_static("https://shared.eu-central-1.getblock.io").connect().await?; let mut client = LedgerServiceClient::with_interceptor(channel, |mut req: Request<()>| { req.metadata_mut().insert("authorization", "Bearer ".parse().unwrap()); Ok(req) }); let request_json = r#"{ "sequence_number": "260411497", "read_mask": { "paths": [ "*" ] } }"#; let request = Request::new(serde_json::from_str(request_json)?); let response = client.get_checkpoint(request).await?; println!("Response: {:?}", response.into_inner()); Ok(()) } ``` {% endtab %} {% endtabs %} ## Response Example Responses are encoded in Protocol Buffers binary format on the wire. The example below shows the protobuf JSON encoding for readability. {% code overflow="wrap" %} ```json { "checkpoint": { "sequence_number": "260411497", "digest": "8WmKqcRkV5JZw8gEjGyzVxRYHnDvKmJsxLBp7t6vNqrA", "summary": { "epoch": "1084", "sequence_number": "260411497", "network_total_transactions": "987654321", "content_digest": "C9bxKLg5JZw8gEjGyzVxRYHnDvKmJsxLBp7t6vNqrAmK", "previous_digest": "B8aJqcRkV5JZw8gEjGyzVxRYHnDvKmJsxLBp7t6vNqRAm", "epoch_rolling_gas_cost_summary": { "computation_cost": "12345000", "storage_cost": "9876000", "storage_rebate": "8765000" }, "timestamp_ms": "1775050511019", "version_specific_data": "0x0102..." }, "transactions": [ "8WmKqcRkV5JZw8gEjGyzVxRYHnDvKmJsxLBp7t6vNqrA" ] } } ``` {% endcode %} ## Response Fields | Field | Type | Description | | ----------------------------------------------- | --------------- | --------------------------------------------------------------------------- | | checkpoint.sequence\_number | string | Checkpoint sequence number | | checkpoint.digest | string | Checkpoint digest | | checkpoint.summary.epoch | string | Epoch this checkpoint belongs to | | checkpoint.summary.network\_total\_transactions | string | Cumulative transaction count on the network as of this checkpoint | | checkpoint.summary.previous\_digest | string | Digest of the previous checkpoint — used by light clients to walk the chain | | checkpoint.summary.timestamp\_ms | string | Checkpoint timestamp in milliseconds | | checkpoint.transactions | repeated string | Digests of all transactions included in this checkpoint | ## Use Cases * Block-by-block (checkpoint-by-checkpoint) indexing * Light client verification — walking checkpoints via `previous_digest` * Analytics on network throughput over time * Detecting epoch boundaries from checkpoint metadata ## Error Handling gRPC uses status codes rather than JSON-RPC numeric error codes. The most relevant for this method: | Status Code | Numeric | Cause | | ------------------- | ------- | ----------------------------------------------------------------------------------------------------------- | | UNAUTHENTICATED | 16 | Missing or invalid `` in the URL path | | INVALID\_ARGUMENT | 3 | Request fields are missing, malformed, or fail validation | | UNAVAILABLE | 14 | Node is overloaded or temporarily unable to handle the request — retry with backoff | | DEADLINE\_EXCEEDED | 4 | Request did not complete within the timeout window | | RESOURCE\_EXHAUSTED | 8 | Rate limit exceeded for your plan | | NOT\_FOUND | 5 | Checkpoint sequence number is above the current chain tip, or below the node's earliest retained checkpoint | | INVALID\_ARGUMENT | 3 | Neither `sequence_number` nor `digest` was provided, or both were provided | ## SDK Integration {% tabs %} {% tab title="@mysten/sui (TypeScript)" %} ```typescript // The Mysten Labs TypeScript SDK provides higher-level wrappers around the // gRPC API. Use @mysten/sui for typed client access: import { SuiClient } from '@mysten/sui/client'; const client = new SuiClient({ url: 'https://shared.eu-central-1.getblock.io//' }); // Refer to the @mysten/sui API reference for the typed wrapper of this method; // raw gRPC call to sui.rpc.v2.LedgerService/GetCheckpoint is available as shown in the // Request Example tabs above. ``` {% endtab %} {% tab title="pysui (Python)" %} ```python # pysui is the community-maintained Python SDK for Sui (Mysten Labs does not # yet publish an official Python SDK). For raw gRPC access, use grpcio with # the generated proto stubs as shown in the Request Example tabs above. from pysui import SuiConfig, SyncClient config = SuiConfig.user_config( rpc_url='https://shared.eu-central-1.getblock.io//' ) client = SyncClient(config) # Consult pysui docs for the wrapper of LedgerService.GetCheckpoint. ``` {% endtab %} {% endtabs %}