SubscribeCheckpoints gRPC Method

Parameters

read_mask

object

Loading...

Returns

cursor

string

Loading...

checkpoint

object

Loading...

sequenceNumber

string

Loading...

digest

string

Loading...

summary

object

Loading...

signature

object

Loading...

contents

object

Loading...

transactions

array

Loading...

Request

1
grpcurl -proto ./sui/rpc/v2beta2/subscription_service.proto -H "x-token: abcde123456789" -d '{
2
  "read_mask": {
3
    "paths": [
4
      "sequence_number",
5
      "digest",
6
      "network_total_transactions",
7
      "previous_digest",
8
      "epoch_rolling_gas_cost_summary",
9
      "timestamp_ms",
10
      "transactions"
11
    ]
12
  }
13
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2beta2.SubscriptionService/SubscribeCheckpoints
14

1
grpcurl -proto ./sui/rpc/v2beta2/subscription_service.proto -H "x-token: abcde123456789" -d '{
2
  "read_mask": {
3
    "paths": [
4
      "sequence_number",
5
      "digest",
6
      "network_total_transactions",
7
      "previous_digest",
8
      "epoch_rolling_gas_cost_summary",
9
      "timestamp_ms",
10
      "transactions"
11
    ]
12
  }
13
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2beta2.SubscriptionService/SubscribeCheckpoints
14

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	"log"
10
	"os"
11
	"os/signal"
12
	"syscall"
13

14
	"google.golang.org/grpc"
15
	"google.golang.org/grpc/credentials"
16
	"google.golang.org/protobuf/encoding/protojson"
17
	"google.golang.org/protobuf/types/known/fieldmaskpb"
18

19
	pb "sui-grpc/sui/rpc/v2beta2" // Your Generated .pb.go files path
20
)
21

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

27
var (
28
	token    = "YOUR_TOKEN_NUMBER"
29
	endpoint = "YOUR_QN_ENDPOINT:9000"
30
)
31

32
// Auth structure for x-token
33
type auth struct {
34
	token string
35
}
36

37
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
38
	return map[string]string{"x-token": a.token}, nil
39
}
40
func (a *auth) RequireTransportSecurity() bool {
41
	return true
42
}
43

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

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

57
	client := pb.NewSubscriptionServiceClient(conn)
58

59
	// Build request with field mask
60
	req := &pb.SubscribeCheckpointsRequest{
61
		ReadMask: &fieldmaskpb.FieldMask{
62
			Paths: []string{
63
				"sequence_number",
64
				"digest",
65
				"network_total_transactions",
66
				"previous_digest",
67
				"epoch_rolling_gas_cost_summary",
68
				"timestamp_ms",
69
				"transactions",
70
			},
71
		},
72
	}
73

74
	ctx, cancel := context.WithCancel(context.Background())
75
	defer cancel()
76

77
	stream, err := client.SubscribeCheckpoints(ctx, req)
78
	if err != nil {
79
		log.Fatalf("SubscribeCheckpoints failed: %v", err)
80
	}
81

82
	sigChan := make(chan os.Signal, 1)
83
	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
84

85
	go func() {
86
		<-sigChan
87
		fmt.Println("\nClosing subscription...")
88
		cancel()
89
	}()
90

91
	fmt.Println("Subscribing to checkpoints... Press Ctrl+C to stop.")
92

93
	marshaler := protojson.MarshalOptions{
94
		UseProtoNames:   true,
95
		EmitUnpopulated: true,
96
		Indent:          "  ",
97
	}
98

99
	for {
100
		resp, err := stream.Recv()
101
		if err == io.EOF {
102
			fmt.Println("Stream ended")
103
			break
104
		}
105
		if err != nil {
106
			log.Printf("Stream error: %v", err)
107
			break
108
		}
109

110
		// Pretty print the response
111
		jsonBytes, err := marshaler.Marshal(resp)
112
		if err != nil {
113
			log.Printf("Failed to marshal: %v", err)
114
			continue
115
		}
116

117
		var pretty map[string]interface{}
118
		if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
119
			log.Printf("Failed to parse JSON: %v", err)
120
			continue
121
		}
122

123
		out, _ := json.MarshalIndent(pretty, "", "  ")
124
		fmt.Printf("Received checkpoint:\n%s\n", string(out))
125
	}
126
}
127

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	"log"
10
	"os"
11
	"os/signal"
12
	"syscall"
13

14
	"google.golang.org/grpc"
15
	"google.golang.org/grpc/credentials"
16
	"google.golang.org/protobuf/encoding/protojson"
17
	"google.golang.org/protobuf/types/known/fieldmaskpb"
18

19
	pb "sui-grpc/sui/rpc/v2beta2" // Your Generated .pb.go files path
20
)
21

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

27
var (
28
	token    = "YOUR_TOKEN_NUMBER"
29
	endpoint = "YOUR_QN_ENDPOINT:9000"
30
)
31

32
// Auth structure for x-token
33
type auth struct {
34
	token string
35
}
36

37
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
38
	return map[string]string{"x-token": a.token}, nil
39
}
40
func (a *auth) RequireTransportSecurity() bool {
41
	return true
42
}
43

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

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

57
	client := pb.NewSubscriptionServiceClient(conn)
58

59
	// Build request with field mask
60
	req := &pb.SubscribeCheckpointsRequest{
61
		ReadMask: &fieldmaskpb.FieldMask{
62
			Paths: []string{
63
				"sequence_number",
64
				"digest",
65
				"network_total_transactions",
66
				"previous_digest",
67
				"epoch_rolling_gas_cost_summary",
68
				"timestamp_ms",
69
				"transactions",
70
			},
71
		},
72
	}
73

74
	ctx, cancel := context.WithCancel(context.Background())
75
	defer cancel()
76

77
	stream, err := client.SubscribeCheckpoints(ctx, req)
78
	if err != nil {
79
		log.Fatalf("SubscribeCheckpoints failed: %v", err)
80
	}
81

82
	sigChan := make(chan os.Signal, 1)
83
	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
84

85
	go func() {
86
		<-sigChan
87
		fmt.Println("\nClosing subscription...")
88
		cancel()
89
	}()
90

91
	fmt.Println("Subscribing to checkpoints... Press Ctrl+C to stop.")
92

93
	marshaler := protojson.MarshalOptions{
94
		UseProtoNames:   true,
95
		EmitUnpopulated: true,
96
		Indent:          "  ",
97
	}
98

99
	for {
100
		resp, err := stream.Recv()
101
		if err == io.EOF {
102
			fmt.Println("Stream ended")
103
			break
104
		}
105
		if err != nil {
106
			log.Printf("Stream error: %v", err)
107
			break
108
		}
109

110
		// Pretty print the response
111
		jsonBytes, err := marshaler.Marshal(resp)
112
		if err != nil {
113
			log.Printf("Failed to marshal: %v", err)
114
			continue
115
		}
116

117
		var pretty map[string]interface{}
118
		if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
119
			log.Printf("Failed to parse JSON: %v", err)
120
			continue
121
		}
122

123
		out, _ := json.MarshalIndent(pretty, "", "  ")
124
		fmt.Printf("Received checkpoint:\n%s\n", string(out))
125
	}
126
}
127

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

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

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

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

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

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const SubscriptionService = proto.sui.rpc.v2beta2.SubscriptionService;
28

29
// Create secure client
30
const client = new SubscriptionService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  read_mask: {
39
    paths: [
40
      'sequence_number',
41
      'digest',
42
      'network_total_transactions',
43
      'previous_digest',
44
      'epoch_rolling_gas_cost_summary',
45
      'timestamp_ms',
46
      'transactions',
47
    ],
48
  },
49
};
50

51
const call = client.SubscribeCheckpoints(request, metadata);
52

53
call.on('data', (response: any) => {
54
  console.log('Received checkpoint:', JSON.stringify(response, null, 2));
55
});
56

57
call.on('error', (error: any) => {
58
  console.error('Stream error:', error);
59
});
60

61
call.on('end', () => {
62
  console.log('Stream ended');
63
});
64

65
console.log('Subscribing to checkpoints... Press Ctrl+C to stop.');
66
process.on('SIGINT', () => {
67
  console.log('Closing subscription...');
68
  call.cancel();
69
  process.exit(0);
70
});
71

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

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

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

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

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

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const SubscriptionService = proto.sui.rpc.v2beta2.SubscriptionService;
28

29
// Create secure client
30
const client = new SubscriptionService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  read_mask: {
39
    paths: [
40
      'sequence_number',
41
      'digest',
42
      'network_total_transactions',
43
      'previous_digest',
44
      'epoch_rolling_gas_cost_summary',
45
      'timestamp_ms',
46
      'transactions',
47
    ],
48
  },
49
};
50

51
const call = client.SubscribeCheckpoints(request, metadata);
52

53
call.on('data', (response: any) => {
54
  console.log('Received checkpoint:', JSON.stringify(response, null, 2));
55
});
56

57
call.on('error', (error: any) => {
58
  console.error('Stream error:', error);
59
});
60

61
call.on('end', () => {
62
  console.log('Stream ended');
63
});
64

65
console.log('Subscribing to checkpoints... Press Ctrl+C to stop.');
66
process.on('SIGINT', () => {
67
  console.log('Closing subscription...');
68
  call.cancel();
69
  process.exit(0);
70
});
71

1
import grpc
2
import json
3
import signal
4
import sys
5
from google.protobuf.field_mask_pb2 import FieldMask
6
from google.protobuf.json_format import MessageToDict
7
from sui.rpc.v2beta2 import subscription_service_pb2, subscription_service_pb2_grpc
8

9
def signal_handler(sig, frame):
10
    print('\nClosing subscription...')
11
    sys.exit(0)
12

13
def subscribe_checkpoints():
14
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
15
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
16
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
17
    # token will be : abcde123456789
18

19
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
20
    token = 'abcde123456789';
21

22
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
23
    stub = subscription_service_pb2_grpc.SubscriptionServiceStub(channel)
24

25
    read_mask = FieldMask(paths=[
26
        "sequence_number",
27
        "digest",
28
        "network_total_transactions",
29
        "previous_digest",
30
        "epoch_rolling_gas_cost_summary",
31
        "timestamp_ms",
32
        "transactions"
33
    ])
34

35
    request = subscription_service_pb2.SubscribeCheckpointsRequest(
36
        read_mask=read_mask
37
    )
38

39
    metadata = [("x-token", token)]
40

41
    return stub.SubscribeCheckpoints(request, metadata=metadata)
42

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

49
def main():
50
    signal.signal(signal.SIGINT, signal_handler)
51
    print("Subscribing to checkpoints... Press Ctrl+C to stop.")
52

53
    try:
54
        response_stream = subscribe_checkpoints()
55
        
56
        for response in response_stream:
57
            print("Received checkpoint:")
58
            print(parse_response_to_json(response))
59
            
60
    except grpc.RpcError as e:
61
        print(f"{e.code().name}: {e.details()}")
62
    except KeyboardInterrupt:
63
        print("\nSubscription interrupted")
64

65
if __name__ == "__main__":
66
    main()
67

1
import grpc
2
import json
3
import signal
4
import sys
5
from google.protobuf.field_mask_pb2 import FieldMask
6
from google.protobuf.json_format import MessageToDict
7
from sui.rpc.v2beta2 import subscription_service_pb2, subscription_service_pb2_grpc
8

9
def signal_handler(sig, frame):
10
    print('\nClosing subscription...')
11
    sys.exit(0)
12

13
def subscribe_checkpoints():
14
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
15
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
16
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
17
    # token will be : abcde123456789
18

19
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
20
    token = 'abcde123456789';
21

22
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
23
    stub = subscription_service_pb2_grpc.SubscriptionServiceStub(channel)
24

25
    read_mask = FieldMask(paths=[
26
        "sequence_number",
27
        "digest",
28
        "network_total_transactions",
29
        "previous_digest",
30
        "epoch_rolling_gas_cost_summary",
31
        "timestamp_ms",
32
        "transactions"
33
    ])
34

35
    request = subscription_service_pb2.SubscribeCheckpointsRequest(
36
        read_mask=read_mask
37
    )
38

39
    metadata = [("x-token", token)]
40

41
    return stub.SubscribeCheckpoints(request, metadata=metadata)
42

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

49
def main():
50
    signal.signal(signal.SIGINT, signal_handler)
51
    print("Subscribing to checkpoints... Press Ctrl+C to stop.")
52

53
    try:
54
        response_stream = subscribe_checkpoints()
55
        
56
        for response in response_stream:
57
            print("Received checkpoint:")
58
            print(parse_response_to_json(response))
59
            
60
    except grpc.RpcError as e:
61
        print(f"{e.code().name}: {e.details()}")
62
    except KeyboardInterrupt:
63
        print("\nSubscription interrupted")
64

65
if __name__ == "__main__":
66
    main()
67

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free