ListEvents gRPC Method

參數

start_checkpoint

字串

載入中...

end_checkpoint

字串

載入中...

read_mask

物件

載入中...

paths

array<string>

載入中...

filter

物件

載入中...

terms

陣列

載入中...

options

物件

載入中...

上限

整數

載入中...

after

字串

載入中...

before

字串

載入中...

ordering

字串

載入中...

退貨

event

物件

載入中...

packageId

字串

載入中...

module

字串

載入中...

sender

字串

載入中...

eventType

字串

載入中...

json

物件

載入中...

checkpoint

字串

載入中...

watermark

物件

載入中...

cursor

字串

載入中...

checkpoint

字串

載入中...

結束

物件

載入中...

reason

字串

載入中...

請求

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "start_checkpoint": "306133000",
7
    "end_checkpoint": "306133070",
8
    "read_mask": {
9
      "paths": [
10
        "package_id",
11
        "module",
12
        "sender",
13
        "event_type",
14
        "json",
15
        "checkpoint"
16
      ]
17
    },
18
    "options": {
19
      "limit": 2
20
    }
21
  }' \
22
  docs-demo.sui-mainnet.quiknode.pro:9000 \
23
  sui.rpc.v2.LedgerService/ListEvents
24

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "start_checkpoint": "306133000",
7
    "end_checkpoint": "306133070",
8
    "read_mask": {
9
      "paths": [
10
        "package_id",
11
        "module",
12
        "sender",
13
        "event_type",
14
        "json",
15
        "checkpoint"
16
      ]
17
    },
18
    "options": {
19
      "limit": 2
20
    }
21
  }' \
22
  docs-demo.sui-mainnet.quiknode.pro:9000 \
23
  sui.rpc.v2.LedgerService/ListEvents
24

1
套件 主函式
2

3
匯入 (
4
	"上下文"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	"log"
10
	「時間」
11

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

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

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

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

30
// Auth structure for x-token
31
類型 auth 結構體 {
32
	代幣 字串
33
}
34

35
func (a *auth) GetRequestMetadata(ctx 上下文.Context, uri ...字串) (map[字串]字串, 錯誤) {
36
	return map[string]string{"x-token": a.token}, nil
37
}
38
func (a *auth) RequireTransportSecurity() bool {
39
	return true
40
}
41

42
func main() {
43
	creds := credentials.NewTLS(&tls.Config{})
44
	opts := []grpc.DialOption{
45
		grpc.WithTransportCredentials(creds),
46
		grpc.WithPerRPC憑證(&auth{token}),
47
	}
48

49
	conn, err := grpc.撥號(endpoint, opts...)
50
	如果 err != nil {
51
		log.Fatalf("Failed to connect: %v", err)
52
	}
53
	延後 延遲連接.關閉()
54

55
	client := pb.NewLedgerServiceClient(conn)
56

57
	startCheckpoint := uint64(306133000)
58
	endCheckpoint := uint64(306133070)
59
	limit := uint32(2)
60

61
	req := &pb.ListEventsRequest{
62
		StartCheckpoint: &startCheckpoint,
63
		EndCheckpoint:   &endCheckpoint,
64
		ReadMask: &fieldmaskpb.FieldMask{
65
			Paths: []string{"package_id", "module", "sender", "event_type", "json", "checkpoint"},
66
		},
67
		Options: &pb.QueryOptions{
68
			Limit: &limit,
69
		},
70
	}
71

72
	// ListEvents is bounded by start/end checkpoint and options.limit, so the
73
	// stream terminates on its own once the QueryEnd frame is sent.
74
	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
75
	延後 延後()
76

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

82
	marshaler := protojson.MarshalOptions{
83
		UseProtoNames:   true,
84
		EmitUnpopulated: true,
85
		Indent:          "  ",
86
	}
87

88
	fmt.Println("Streaming events...")
89

90
	for {
91
		resp, err := stream.Recv()
92
		if err == io.EOF {
93
			fmt.Println("Stream ended")
94
			break
95
		}
96
		if err != nil {
97
			log.Fatalf("Stream error: %v", err)
98
		}
99

100
		jsonBytes, err := marshaler.Marshal(resp)
101
		if err != nil {
102
			log.Printf("Failed to marshal: %v", err)
103
			continue
104
		}
105

106
		var pretty map[string]interface{}
107
		if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
108
			log.Printf("Failed to parse JSON: %v", err)
109
			continue
110
		}
111

112
		out, _ := json.MarshalIndent(pretty, "", "  ")
113
		fmt.Printf("Received frame:\n%s\n", string(out))
114

115
		if resp.GetEnd() != nil {
116
			fmt.Printf("Query ended: %s\n", resp.GetEnd().GetReason())
117
		}
118
	}
119
}
120

1
套件 主函式
2

3
匯入 (
4
	"上下文"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	"log"
10
	「時間」
11

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

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

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

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

30
// Auth structure for x-token
31
類型 auth 結構體 {
32
	代幣 字串
33
}
34

35
func (a *auth) GetRequestMetadata(ctx 上下文.Context, uri ...字串) (map[字串]字串, 錯誤) {
36
	return map[string]string{"x-token": a.token}, nil
37
}
38
func (a *auth) RequireTransportSecurity() bool {
39
	return true
40
}
41

42
func main() {
43
	creds := credentials.NewTLS(&tls.Config{})
44
	opts := []grpc.DialOption{
45
		grpc.WithTransportCredentials(creds),
46
		grpc.WithPerRPC憑證(&auth{token}),
47
	}
48

49
	conn, err := grpc.撥號(endpoint, opts...)
50
	如果 err != nil {
51
		log.Fatalf("Failed to connect: %v", err)
52
	}
53
	延後 延遲連接.關閉()
54

55
	client := pb.NewLedgerServiceClient(conn)
56

57
	startCheckpoint := uint64(306133000)
58
	endCheckpoint := uint64(306133070)
59
	limit := uint32(2)
60

61
	req := &pb.ListEventsRequest{
62
		StartCheckpoint: &startCheckpoint,
63
		EndCheckpoint:   &endCheckpoint,
64
		ReadMask: &fieldmaskpb.FieldMask{
65
			Paths: []string{"package_id", "module", "sender", "event_type", "json", "checkpoint"},
66
		},
67
		Options: &pb.QueryOptions{
68
			Limit: &limit,
69
		},
70
	}
71

72
	// ListEvents is bounded by start/end checkpoint and options.limit, so the
73
	// stream terminates on its own once the QueryEnd frame is sent.
74
	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
75
	延後 延後()
76

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

82
	marshaler := protojson.MarshalOptions{
83
		UseProtoNames:   true,
84
		EmitUnpopulated: true,
85
		Indent:          "  ",
86
	}
87

88
	fmt.Println("Streaming events...")
89

90
	for {
91
		resp, err := stream.Recv()
92
		if err == io.EOF {
93
			fmt.Println("Stream ended")
94
			break
95
		}
96
		if err != nil {
97
			log.Fatalf("Stream error: %v", err)
98
		}
99

100
		jsonBytes, err := marshaler.Marshal(resp)
101
		if err != nil {
102
			log.Printf("Failed to marshal: %v", err)
103
			continue
104
		}
105

106
		var pretty map[string]interface{}
107
		if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
108
			log.Printf("Failed to parse JSON: %v", err)
109
			continue
110
		}
111

112
		out, _ := json.MarshalIndent(pretty, "", "  ")
113
		fmt.Printf("Received frame:\n%s\n", string(out))
114

115
		if resp.GetEnd() != nil {
116
			fmt.Printf("Query ended: %s\n", resp.GetEnd().GetReason())
117
		}
118
	}
119
}
120

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/v2/ledger_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 LedgerService = proto.sui.rpc.v2.LedgerService;
28

29
// Create secure client
30
const client = new LedgerService(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
// ListEvents is bounded by start/end_checkpoint and options.limit, so the
38
// stream ends on its own — no Ctrl+C handling needed.
39
const request = {
40
  start_checkpoint: '306133000',
41
  end_checkpoint: '306133070',
42
  read_mask: {
43
    paths: ['package_id', 'module', 'sender', 'event_type', 'json', 'checkpoint'],
44
  },
45
  options: {
46
    limit: 2,
47
  },
48
};
49

50
const call = client.ListEvents(request, metadata);
51

52
console.log('Streaming events...');
53

54
call.on('data', (response: any) => {
55
  console.log('Received frame:', JSON.stringify(response, null, 2));
56
  if (response.end) {
57
    console.log('Query ended:', response.end.reason);
58
  }
59
});
60

61
call.on('error', (error: any) => {
62
  console.error('Stream error:', error);
63
});
64

65
call.on('end', () => {
66
  console.log('Stream ended');
67
});
68

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/v2/ledger_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 LedgerService = proto.sui.rpc.v2.LedgerService;
28

29
// Create secure client
30
const client = new LedgerService(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
// ListEvents is bounded by start/end_checkpoint and options.limit, so the
38
// stream ends on its own — no Ctrl+C handling needed.
39
const request = {
40
  start_checkpoint: '306133000',
41
  end_checkpoint: '306133070',
42
  read_mask: {
43
    paths: ['package_id', 'module', 'sender', 'event_type', 'json', 'checkpoint'],
44
  },
45
  options: {
46
    limit: 2,
47
  },
48
};
49

50
const call = client.ListEvents(request, metadata);
51

52
console.log('Streaming events...');
53

54
call.on('data', (response: any) => {
55
  console.log('Received frame:', JSON.stringify(response, null, 2));
56
  if (response.end) {
57
    console.log('Query ended:', response.end.reason);
58
  }
59
});
60

61
call.on('error', (error: any) => {
62
  console.error('Stream error:', error);
63
});
64

65
call.on('end', () => {
66
  console.log('Stream ended');
67
});
68

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

7
def list_events():
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
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
    token = 'abcde123456789';
15

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

19
    read_mask = FieldMask(paths=["package_id", "module", "sender", "event_type", "json", "checkpoint"])
20

21
    # ListEvents is bounded by start/end_checkpoint and options.limit, so the
22
    # stream ends on its own once the server sends the QueryEnd frame.
23
    request = ledger_service_pb2.ListEventsRequest(
24
        start_checkpoint=306133000,
25
        end_checkpoint=306133070,
26
        read_mask=read_mask,
27
        options=query_options_pb2.QueryOptions(limit=2)
28
    )
29

30
    metadata = [("x-token", token)]
31

32
    return stub.ListEvents(request, metadata=metadata)
33

34
def parse_response_to_json(response):
35
    return json.dumps(
36
        MessageToDict(response, preserving_proto_field_name=True),
37
        indent=2
38
    )
39

40
def main():
41
    print("Streaming events...")
42

43
    try:
44
        response_stream = list_events()
45

46
        for response in response_stream:
47
            print("Received frame:")
48
            print(parse_response_to_json(response))
49
            if response.HasField("end"):
50
                reason = query_options_pb2.QueryEndReason.Name(response.end.reason)
51
                print(f"Query ended: {reason}")
52

53
        print("Stream ended")
54

55
    except grpc.RpcError as e:
56
        print(f"{e.code().name}: {e.details()}")
57

58
if __name__ == "__main__":
59
    main()
60

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

7
def list_events():
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
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
    token = 'abcde123456789';
15

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

19
    read_mask = FieldMask(paths=["package_id", "module", "sender", "event_type", "json", "checkpoint"])
20

21
    # ListEvents is bounded by start/end_checkpoint and options.limit, so the
22
    # stream ends on its own once the server sends the QueryEnd frame.
23
    request = ledger_service_pb2.ListEventsRequest(
24
        start_checkpoint=306133000,
25
        end_checkpoint=306133070,
26
        read_mask=read_mask,
27
        options=query_options_pb2.QueryOptions(limit=2)
28
    )
29

30
    metadata = [("x-token", token)]
31

32
    return stub.ListEvents(request, metadata=metadata)
33

34
def parse_response_to_json(response):
35
    return json.dumps(
36
        MessageToDict(response, preserving_proto_field_name=True),
37
        indent=2
38
    )
39

40
def main():
41
    print("Streaming events...")
42

43
    try:
44
        response_stream = list_events()
45

46
        for response in response_stream:
47
            print("Received frame:")
48
            print(parse_response_to_json(response))
49
            if response.HasField("end"):
50
                reason = query_options_pb2.QueryEndReason.Name(response.end.reason)
51
                print(f"Query ended: {reason}")
52

53
        print("Stream ended")
54

55
    except grpc.RpcError as e:
56
        print(f"{e.code().name}: {e.details()}")
57

58
if __name__ == "__main__":
59
    main()
60

還沒有帳號嗎？

endpoint 幾秒鐘endpoint 建立您的Quicknode endpoint ，並開始建置

立即免費開始使用