BatchGetObjects gRPC Method

參數

請求

陣列

必填

載入中...

read_mask

物件

載入中...

paths

陣列

載入中...

退貨

objects

陣列

載入中...

物件

物件

載入中...

bcs

物件

載入中...

名稱

字串

載入中...

值

字串

載入中...

objectId

字串

載入中...

版本

字串

載入中...

digest

字串

載入中...

所有者

物件

載入中...

種類

字串

載入中...

版本

字串

載入中...

objectType

字串

載入中...

hasPublicTransfer

布林值

載入中...

contents

物件

載入中...

名稱

字串

載入中...

值

字串

載入中...

previousTransaction

字串

載入中...

storageRebate

字串

載入中...

請求

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "requests": [
7
      { "object_id": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8" }
8
    ],
9
    "read_mask": {
10
      "paths": [
11
        "bcs",
12
        "object_id",
13
        "version",
14
        "digest",
15
        "owner",
16
        "object_type",
17
        "has_public_transfer",
18
        "contents",
19
        "previous_transaction",
20
        "storage_rebate"
21
      ]
22
    }
23
  }' \
24
  docs-demo.sui-mainnet.quiknode.pro:9000 \
25
  sui.rpc.v2.LedgerService/BatchGetObjects

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "requests": [
7
      { "object_id": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8" }
8
    ],
9
    "read_mask": {
10
      "paths": [
11
        "bcs",
12
        "object_id",
13
        "version",
14
        "digest",
15
        "owner",
16
        "object_type",
17
        "has_public_transfer",
18
        "contents",
19
        "previous_transaction",
20
        "storage_rebate"
21
      ]
22
    }
23
  }' \
24
  docs-demo.sui-mainnet.quiknode.pro:9000 \
25
  sui.rpc.v2.LedgerService/BatchGetObjects

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/v2"  // 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
type auth struct {
30
	token string
31
}
32

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

40
func main() {
41
	creds := credentials.NewTLS(&tls.Config{})
42
	opts := []grpc.DialOption{
43
		grpc.WithTransportCredentials(creds),
44
		grpc.WithPerRPCCredentials(&auth{token}),
45
	}
46

47
	conn, err := grpc.Dial(endpoint, opts...)
48
	if err != nil {
49
		log.Fatalf("Failed to connect: %v", err)
50
	}
51
	defer conn.Close()
52

53
	client := pb.NewLedgerServiceClient(conn)
54

55
	// Object ID to fetch
56
	objectID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	// Build request with field mask
59
	req := &pb.BatchGetObjectsRequest{
60
		Requests: []*pb.GetObjectRequest{
61
			{
62
				ObjectId: &objectID,
63
			},
64
		},
65
		ReadMask: &fieldmaskpb.FieldMask{
66
			Paths: []string{
67
				"object_id",
68
				"version",
69
				"digest",
70
				"owner",
71
				"object_type",
72
				"has_public_transfer",
73
				"contents",
74
				"previous_transaction",
75
				"storage_rebate",
76
				"bcs",
77
			},
78
		},
79
	}
80

81
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
82
	defer cancel()
83

84
	resp, err := client.BatchGetObjects(ctx, req)
85
	if err != nil {
86
		log.Fatalf("BatchGetObjects failed: %v", err)
87
	}
88

89
	// Pretty print the response
90
	marshaler := protojson.MarshalOptions{
91
		UseProtoNames:   true,
92
		EmitUnpopulated: true,
93
		Indent:          "  ",
94
	}
95

96
	jsonBytes, err := marshaler.Marshal(resp)
97
	if err != nil {
98
		log.Fatalf("Failed to marshal: %v", err)
99
	}
100

101
	var pretty map[string]interface{}
102
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
103
		log.Fatalf("Failed to parse JSON: %v", err)
104
	}
105

106
	out, _ := json.MarshalIndent(pretty, "", "  ")
107
	fmt.Println(string(out))
108
}
109

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/v2"  // 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
type auth struct {
30
	token string
31
}
32

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

40
func main() {
41
	creds := credentials.NewTLS(&tls.Config{})
42
	opts := []grpc.DialOption{
43
		grpc.WithTransportCredentials(creds),
44
		grpc.WithPerRPCCredentials(&auth{token}),
45
	}
46

47
	conn, err := grpc.Dial(endpoint, opts...)
48
	if err != nil {
49
		log.Fatalf("Failed to connect: %v", err)
50
	}
51
	defer conn.Close()
52

53
	client := pb.NewLedgerServiceClient(conn)
54

55
	// Object ID to fetch
56
	objectID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	// Build request with field mask
59
	req := &pb.BatchGetObjectsRequest{
60
		Requests: []*pb.GetObjectRequest{
61
			{
62
				ObjectId: &objectID,
63
			},
64
		},
65
		ReadMask: &fieldmaskpb.FieldMask{
66
			Paths: []string{
67
				"object_id",
68
				"version",
69
				"digest",
70
				"owner",
71
				"object_type",
72
				"has_public_transfer",
73
				"contents",
74
				"previous_transaction",
75
				"storage_rebate",
76
				"bcs",
77
			},
78
		},
79
	}
80

81
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
82
	defer cancel()
83

84
	resp, err := client.BatchGetObjects(ctx, req)
85
	if err != nil {
86
		log.Fatalf("BatchGetObjects failed: %v", err)
87
	}
88

89
	// Pretty print the response
90
	marshaler := protojson.MarshalOptions{
91
		UseProtoNames:   true,
92
		EmitUnpopulated: true,
93
		Indent:          "  ",
94
	}
95

96
	jsonBytes, err := marshaler.Marshal(resp)
97
	if err != nil {
98
		log.Fatalf("Failed to marshal: %v", err)
99
	}
100

101
	var pretty map[string]interface{}
102
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
103
		log.Fatalf("Failed to parse JSON: %v", err)
104
	}
105

106
	out, _ := json.MarshalIndent(pretty, "", "  ")
107
	fmt.Println(string(out))
108
}
109

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/v2/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

25
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
26
const LedgerService = proto.sui.rpc.v2.LedgerService;
27

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

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

35
// Request payload
36
const request = {
37
  requests: [
38
    {
39
      object_id: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
40
    },
41
  ],
42
  read_mask: {
43
    paths: [
44
      'bcs',
45
      'object_id',
46
      'version',
47
      'digest',
48
      'owner',
49
      'object_type',
50
      'has_public_transfer',
51
      'contents',
52
      'previous_transaction',
53
      'storage_rebate',
54
    ],
55
  },
56
};
57

58
// Recursively decode Uint8Array or Buffer fields to hex
59
function decodeBytesFields(obj: any): any {
60
  if (Array.isArray(obj)) {
61
    return obj.map(decodeBytesFields);
62
  } else if (obj && typeof obj === 'object') {
63
    const result: any = {};
64
    for (const key of Object.keys(obj)) {
65
      const val = obj[key];
66
      if (val instanceof Uint8Array) {
67
        result[key] = Buffer.from(val).toString('hex');
68
      } else if (val && val.type === 'Buffer' && Array.isArray(val.data)) {
69
        result[key] = Buffer.from(val.data).toString('hex');
70
      } else {
71
        result[key] = decodeBytesFields(val);
72
      }
73
    }
74
    return result;
75
  } else {
76
    return obj;
77
  }
78
}
79

80
// Perform gRPC call
81
client.BatchGetObjects(request, metadata, (err: grpc.ServiceError | null, response: any) => {
82
  if (err) {
83
    console.error('gRPC Error:', {
84
      code: err.code,
85
      message: err.message,
86
      details: err.details,
87
    });
88
  } else {
89
    const decoded = decodeBytesFields(response);
90
    console.log('BatchGetObjects Response:');
91
    console.log(JSON.stringify(decoded, null, 2));
92
  }
93
});
94

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/v2/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

25
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
26
const LedgerService = proto.sui.rpc.v2.LedgerService;
27

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

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

35
// Request payload
36
const request = {
37
  requests: [
38
    {
39
      object_id: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
40
    },
41
  ],
42
  read_mask: {
43
    paths: [
44
      'bcs',
45
      'object_id',
46
      'version',
47
      'digest',
48
      'owner',
49
      'object_type',
50
      'has_public_transfer',
51
      'contents',
52
      'previous_transaction',
53
      'storage_rebate',
54
    ],
55
  },
56
};
57

58
// Recursively decode Uint8Array or Buffer fields to hex
59
function decodeBytesFields(obj: any): any {
60
  if (Array.isArray(obj)) {
61
    return obj.map(decodeBytesFields);
62
  } else if (obj && typeof obj === 'object') {
63
    const result: any = {};
64
    for (const key of Object.keys(obj)) {
65
      const val = obj[key];
66
      if (val instanceof Uint8Array) {
67
        result[key] = Buffer.from(val).toString('hex');
68
      } else if (val && val.type === 'Buffer' && Array.isArray(val.data)) {
69
        result[key] = Buffer.from(val.data).toString('hex');
70
      } else {
71
        result[key] = decodeBytesFields(val);
72
      }
73
    }
74
    return result;
75
  } else {
76
    return obj;
77
  }
78
}
79

80
// Perform gRPC call
81
client.BatchGetObjects(request, metadata, (err: grpc.ServiceError | null, response: any) => {
82
  if (err) {
83
    console.error('gRPC Error:', {
84
      code: err.code,
85
      message: err.message,
86
      details: err.details,
87
    });
88
  } else {
89
    const decoded = decodeBytesFields(response);
90
    console.log('BatchGetObjects Response:');
91
    console.log(JSON.stringify(decoded, null, 2));
92
  }
93
});
94

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.v2 import ledger_service_pb2, ledger_service_pb2_grpc
6

7

8
def batch_get_objects():
9

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

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

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

21
    object_id = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
22

23
    # Define valid read_mask field paths from Object message
24
    read_mask = FieldMask(paths=[
25
        "bcs",
26
        "object_id",
27
        "version",
28
        "digest",
29
        "owner",
30
        "object_type",
31
        "has_public_transfer",
32
        "contents",
33
        "previous_transaction",
34
        "storage_rebate"
35
    ])
36

37
    request = ledger_service_pb2.BatchGetObjectsRequest(
38
        requests=[ledger_service_pb2.GetObjectRequest(object_id=object_id)],
39
        read_mask=read_mask
40
    )
41

42
    metadata = [("x-token", token)]
43

44
    return stub.BatchGetObjects(request, metadata=metadata)
45

46

47
def parse_response_to_json(response):
48
    return json.dumps(
49
        MessageToDict(response, preserving_proto_field_name=True),
50
        indent=2
51
    )
52

53

54
def main():
55
    try:
56
        response = batch_get_objects()
57
        print(parse_response_to_json(response))
58
    except grpc.RpcError as e:
59
        print(f"{e.code().name}: {e.details()}")
60

61

62
if __name__ == "__main__":
63
    main()
64

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.v2 import ledger_service_pb2, ledger_service_pb2_grpc
6

7

8
def batch_get_objects():
9

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

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

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

21
    object_id = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
22

23
    # Define valid read_mask field paths from Object message
24
    read_mask = FieldMask(paths=[
25
        "bcs",
26
        "object_id",
27
        "version",
28
        "digest",
29
        "owner",
30
        "object_type",
31
        "has_public_transfer",
32
        "contents",
33
        "previous_transaction",
34
        "storage_rebate"
35
    ])
36

37
    request = ledger_service_pb2.BatchGetObjectsRequest(
38
        requests=[ledger_service_pb2.GetObjectRequest(object_id=object_id)],
39
        read_mask=read_mask
40
    )
41

42
    metadata = [("x-token", token)]
43

44
    return stub.BatchGetObjects(request, metadata=metadata)
45

46

47
def parse_response_to_json(response):
48
    return json.dumps(
49
        MessageToDict(response, preserving_proto_field_name=True),
50
        indent=2
51
    )
52

53

54
def main():
55
    try:
56
        response = batch_get_objects()
57
        print(parse_response_to_json(response))
58
    except grpc.RpcError as e:
59
        print(f"{e.code().name}: {e.details()}")
60

61

62
if __name__ == "__main__":
63
    main()
64

還沒有帳號嗎？

只需幾秒鐘即可建立您的 Quicknode 端點，並開始建置

立即免費開始使用