ListEvents gRPC Method

参数

start_checkpoint

字符串

正在加载...

end_checkpoint

字符串

正在加载...

read_mask

对象

正在加载...

paths

array<string>

正在加载...

filter

对象

正在加载...

terms

数组

正在加载...

选项

对象

正在加载...

上限

整数

正在加载...

after

字符串

正在加载...

之前

字符串

正在加载...

ordering

字符串

正在加载...

退货

event

对象

正在加载...

packageId

字符串

正在加载...

module

字符串

正在加载...

发件人

字符串

正在加载...

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.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.mainnet.quiknode.pro:9000 \
23
  sui.rpc.v2.LedgerService/ListEvents
24

1
包 main
2

3
import (
4
	"上下文"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	“日志”
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" // 您生成的 .pb.go 文件路径
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    = "您的令牌编号"
27
	endpoint = "您的QN端点:9000"
28
)
29

30
// Auth structure for x-token
31
类型 auth 结构体 {
32
	token 字符串
33
}
34

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

42
func main() {
43
	creds := credentials.NewTLS(&tls.Config{})
44
	opts := []grpc.DialOption{
45
		grpc.WithTransportCredentials(creds)，
46
		grpc.WithPerRPCCredentials(&auth{令牌}),
47
	}
48

49
	conn, err := grpc.Dial(endpoint, opts...)
50
	如果 err != nil {
51
		log.Fatalf("连接失败：%v", err)
52
	}
53
	推迟 conn.关闭()
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
		缩进:          "  ",
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
			换行
95
		}
96
		如果 err != nil {
97
			log.Fatalf("Stream error: %v", err)
98
		}
99

100
		jsonBytes, err := marshaler.Marshal(resp)
101
		如果 err != nil {
102
			log.Printf("Failed to marshal: %v", err)
103
			继续
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
			继续
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
包 main
2

3
import (
4
	"上下文"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"io"
9
	“日志”
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" // 您生成的 .pb.go 文件路径
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    = "您的令牌编号"
27
	endpoint = "您的QN端点:9000"
28
)
29

30
// Auth structure for x-token
31
类型 auth 结构体 {
32
	token 字符串
33
}
34

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

42
func main() {
43
	creds := credentials.NewTLS(&tls.Config{})
44
	opts := []grpc.DialOption{
45
		grpc.WithTransportCredentials(creds)，
46
		grpc.WithPerRPCCredentials(&auth{令牌}),
47
	}
48

49
	conn, err := grpc.Dial(endpoint, opts...)
50
	如果 err != nil {
51
		log.Fatalf("连接失败：%v", err)
52
	}
53
	推迟 conn.关闭()
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
		缩进:          "  ",
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
			换行
95
		}
96
		如果 err != nil {
97
			log.Fatalf("Stream error: %v", err)
98
		}
99

100
		jsonBytes, err := marshaler.Marshal(resp)
101
		如果 err != nil {
102
			log.Printf("Failed to marshal: %v", err)
103
			继续
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
			继续
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 * 作为 grpc from grpc;
2
import * 作为 protoLoader from grpc;
3
import * 作为 路径 from '路径';
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.mainnet.quiknode.pro:9000';
14
const 令牌 = 'abcde123456789';
15

16
// Load protobuf definitions
17
const 包定义 = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  多头: 字符串,
20
  枚举: 字符串,
21
  默认值: true,
22
  oneofs: true,
23
  includeDirs: [路径.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) 作为 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 元数据 = new grpc.元数据();
34
元数据.添加('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 请求 = {
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 from grpc;
2
import * 作为 protoLoader from grpc;
3
import * 作为 路径 from '路径';
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.mainnet.quiknode.pro:9000';
14
const 令牌 = 'abcde123456789';
15

16
// Load protobuf definitions
17
const 包定义 = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  多头: 字符串,
20
  枚举: 字符串,
21
  默认值: true,
22
  oneofs: true,
23
  includeDirs: [路径.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) 作为 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 元数据 = new grpc.元数据();
34
元数据.添加('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 请求 = {
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
来源 谷歌.protobuf.field_mask_pb2 导入 FieldMask
4
来源 谷歌.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 由两个关键组成部分构成：endpoint 和相应的令牌
9
    # 例如：QNEndpoint：mainnet
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
    频道 = 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
    元数据 = [("x-token", token)]
31

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

34
def parse_response_to_json(response):
35
    返回 json.dumps(
36
        MessageToDict(response, 保留_proto_字段_名称=True),
37
        缩进=2
38
    )
39

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

43
    试一试：
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
    除了 grpc。RpcError 作为 e:
56
        print(f"{e.code().name}: {e.details()}")
57

58
如果 __name__ == "__main__":
59
    主()
60

1
import grpc
2
导入 json
3
来源 谷歌.protobuf.field_mask_pb2 导入 FieldMask
4
来源 谷歌.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 由两个关键组成部分构成：endpoint 和相应的令牌
9
    # 例如：QNEndpoint：mainnet
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
    频道 = 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
    元数据 = [("x-token", token)]
31

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

34
def parse_response_to_json(response):
35
    返回 json.dumps(
36
        MessageToDict(response, 保留_proto_字段_名称=True),
37
        缩进=2
38
    )
39

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

43
    试一试：
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
    除了 grpc。RpcError 作为 e:
56
        print(f"{e.code().name}: {e.details()}")
57

58
如果 __name__ == "__main__":
59
    主()
60

还没有账号吗？

endpoint 几秒钟endpoint 创建您的Quicknode endpoint ，并开始构建

免费开始使用