GetCheckpoint gRPC Method

Parameters

sequence_number

string

Loading...

read_mask

object

Loading...

paths

array

Loading...

Returns

checkpoint

object

Loading...

sequenceNumber

string

Loading...

digest

string

Loading...

Request

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "sequence_number": "1000",
7
    "read_mask": {
8
      "paths": [
9
        "sequence_number",
10
        "digest"
11
      ]
12
    }
13
  }' \
14
  docs-demo.sui-mainnet.quiknode.pro:9000 \
15
  sui.rpc.v2beta2.LedgerService/GetCheckpoint
16

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "sequence_number": "1000",
7
    "read_mask": {
8
      "paths": [
9
        "sequence_number",
10
        "digest"
11
      ]
12
    }
13
  }' \
14
  docs-demo.sui-mainnet.quiknode.pro:9000 \
15
  sui.rpc.v2beta2.LedgerService/GetCheckpoint
16

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"log"
9
	"time"
10

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2beta2" // Your Generated .pb.go files path
17
)
18

19
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
20
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

24
var (
25
	token    = "YOUR_TOKEN_NUMBER"
26
	endpoint = "YOUR_QN_ENDPOINT:9000"
27
)
28

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

34
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
35
	return map[string]string{
36
		"x-token": a.token,
37
	}, nil
38
}
39

40
func (a *auth) RequireTransportSecurity() bool {
41
	return true
42
}
43

44
func main() {
45
	// TLS credentials
46
	creds := credentials.NewTLS(&tls.Config{})
47
	opts := []grpc.DialOption{
48
		grpc.WithTransportCredentials(creds),
49
		grpc.WithPerRPCCredentials(&auth{token}),
50
	}
51

52
	conn, err := grpc.Dial(endpoint, opts...)
53
	if err != nil {
54
		log.Fatalf("Failed to connect: %v", err)
55
	}
56
	defer conn.Close()
57

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	// Request for checkpoint with sequence_number = 1000
61
	seq := uint64(1000)
62
	req := &pb.GetCheckpointRequest{
63
		CheckpointId: &pb.GetCheckpointRequest_SequenceNumber{
64
			SequenceNumber: seq,
65
		},
66
		ReadMask: &fieldmaskpb.FieldMask{
67
			Paths: []string{"sequence_number", "digest"},
68
		},
69
	}
70

71
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
72
	defer cancel()
73

74
	resp, err := client.GetCheckpoint(ctx, req)
75
	if err != nil {
76
		log.Fatalf("GetCheckpoint failed: %v", err)
77
	}
78

79
	marshaler := protojson.MarshalOptions{
80
		UseProtoNames:   true,
81
		EmitUnpopulated: true,
82
		Indent:          "  ",
83
	}
84

85
	jsonBytes, err := marshaler.Marshal(resp)
86
	if err != nil {
87
		log.Fatalf("Failed to marshal: %v", err)
88
	}
89

90
	var pretty map[string]interface{}
91
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
92
		log.Fatalf("Failed to unmarshal: %v", err)
93
	}
94

95
	formatted, _ := json.MarshalIndent(pretty, "", "  ")
96
	fmt.Println(string(formatted))
97
}
98

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"log"
9
	"time"
10

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2beta2" // Your Generated .pb.go files path
17
)
18

19
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
20
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

24
var (
25
	token    = "YOUR_TOKEN_NUMBER"
26
	endpoint = "YOUR_QN_ENDPOINT:9000"
27
)
28

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

34
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
35
	return map[string]string{
36
		"x-token": a.token,
37
	}, nil
38
}
39

40
func (a *auth) RequireTransportSecurity() bool {
41
	return true
42
}
43

44
func main() {
45
	// TLS credentials
46
	creds := credentials.NewTLS(&tls.Config{})
47
	opts := []grpc.DialOption{
48
		grpc.WithTransportCredentials(creds),
49
		grpc.WithPerRPCCredentials(&auth{token}),
50
	}
51

52
	conn, err := grpc.Dial(endpoint, opts...)
53
	if err != nil {
54
		log.Fatalf("Failed to connect: %v", err)
55
	}
56
	defer conn.Close()
57

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	// Request for checkpoint with sequence_number = 1000
61
	seq := uint64(1000)
62
	req := &pb.GetCheckpointRequest{
63
		CheckpointId: &pb.GetCheckpointRequest_SequenceNumber{
64
			SequenceNumber: seq,
65
		},
66
		ReadMask: &fieldmaskpb.FieldMask{
67
			Paths: []string{"sequence_number", "digest"},
68
		},
69
	}
70

71
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
72
	defer cancel()
73

74
	resp, err := client.GetCheckpoint(ctx, req)
75
	if err != nil {
76
		log.Fatalf("GetCheckpoint failed: %v", err)
77
	}
78

79
	marshaler := protojson.MarshalOptions{
80
		UseProtoNames:   true,
81
		EmitUnpopulated: true,
82
		Indent:          "  ",
83
	}
84

85
	jsonBytes, err := marshaler.Marshal(resp)
86
	if err != nil {
87
		log.Fatalf("Failed to marshal: %v", err)
88
	}
89

90
	var pretty map[string]interface{}
91
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
92
		log.Fatalf("Failed to unmarshal: %v", err)
93
	}
94

95
	formatted, _ := json.MarshalIndent(pretty, "", "  ")
96
	fmt.Println(string(formatted))
97
}
98

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/ledger_service.proto');
6

7
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
8
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
9
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
10
// token will be : abcde123456789
11

12
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
13
const token = 'abcde123456789';
14

15
// Load protobuf definitions
16
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
17
  keepCase: true,
18
  longs: String,
19
  enums: String,
20
  defaults: true,
21
  oneofs: true,
22
  includeDirs: [path.join(__dirname, 'protos/proto')],
23
});
24
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
25
const LedgerService = proto.sui.rpc.v2beta2.LedgerService;
26

27
// Create secure client
28
const client = new LedgerService(endpoint, grpc.credentials.createSsl());
29

30
// Metadata for authentication
31
const metadata = new grpc.Metadata();
32
metadata.add('x-token', token);
33

34
const request = {
35
  sequence_number: 1000, // Replace as needed
36
  read_mask: {
37
    paths: ['sequence_number', 'digest'],
38
  },
39
};
40

41
client.GetCheckpoint(request, metadata, (err: grpc.ServiceError | null, response: any) => {
42
  if (err) {
43
    console.error('gRPC Error:', {
44
      code: err.code,
45
      message: err.message,
46
      details: err.details,
47
    });
48
  } else {
49
    console.log('Checkpoint Response:');
50
    console.log(JSON.stringify(response, null, 2));
51
  }
52
});
53

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/ledger_service.proto');
6

7
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
8
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
9
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
10
// token will be : abcde123456789
11

12
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
13
const token = 'abcde123456789';
14

15
// Load protobuf definitions
16
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
17
  keepCase: true,
18
  longs: String,
19
  enums: String,
20
  defaults: true,
21
  oneofs: true,
22
  includeDirs: [path.join(__dirname, 'protos/proto')],
23
});
24
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
25
const LedgerService = proto.sui.rpc.v2beta2.LedgerService;
26

27
// Create secure client
28
const client = new LedgerService(endpoint, grpc.credentials.createSsl());
29

30
// Metadata for authentication
31
const metadata = new grpc.Metadata();
32
metadata.add('x-token', token);
33

34
const request = {
35
  sequence_number: 1000, // Replace as needed
36
  read_mask: {
37
    paths: ['sequence_number', 'digest'],
38
  },
39
};
40

41
client.GetCheckpoint(request, metadata, (err: grpc.ServiceError | null, response: any) => {
42
  if (err) {
43
    console.error('gRPC Error:', {
44
      code: err.code,
45
      message: err.message,
46
      details: err.details,
47
    });
48
  } else {
49
    console.log('Checkpoint Response:');
50
    console.log(JSON.stringify(response, null, 2));
51
  }
52
});
53

1
import grpc
2
import json
3
from google.protobuf.field_mask_pb2 import FieldMask
4
from google.protobuf.json_format import MessageToDict
5
from sui.rpc.v2beta2 import ledger_service_pb2, ledger_service_pb2_grpc
6

7

8
def get_checkpoint():
9
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
10
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
11
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
12
    # token will be: abcde123456789
13

14
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
15
    token = 'abcde123456789';
16

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = ledger_service_pb2_grpc.LedgerServiceStub(channel)
19

20
    # You can specify a checkpoint by sequence_number or digest
21
    # Using sequence_number here as an example
22
    sequence_number = 1000  # Replace with the actual checkpoint sequence number you want to retrieve
23
    
24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "sequence_number",
27
        "digest"
28
    ])
29

30
    # Prepare the GetCheckpointRequest
31
    request = ledger_service_pb2.GetCheckpointRequest(
32
        sequence_number=sequence_number,
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.GetCheckpoint(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = get_checkpoint()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

1
import grpc
2
import json
3
from google.protobuf.field_mask_pb2 import FieldMask
4
from google.protobuf.json_format import MessageToDict
5
from sui.rpc.v2beta2 import ledger_service_pb2, ledger_service_pb2_grpc
6

7

8
def get_checkpoint():
9
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
10
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
11
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
12
    # token will be: abcde123456789
13

14
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
15
    token = 'abcde123456789';
16

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = ledger_service_pb2_grpc.LedgerServiceStub(channel)
19

20
    # You can specify a checkpoint by sequence_number or digest
21
    # Using sequence_number here as an example
22
    sequence_number = 1000  # Replace with the actual checkpoint sequence number you want to retrieve
23
    
24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "sequence_number",
27
        "digest"
28
    ])
29

30
    # Prepare the GetCheckpointRequest
31
    request = ledger_service_pb2.GetCheckpointRequest(
32
        sequence_number=sequence_number,
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.GetCheckpoint(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = get_checkpoint()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free