GetObject gRPC Method

매개변수

object_id

문자열

필수

로딩 중...

read_mask

객체

로딩 중...

paths

배열

로딩 중...

버전

문자열

로딩 중...

반품

객체

객체

로딩 중...

bcs

객체

로딩 중...

이름

문자열

로딩 중...

값

문자열

로딩 중...

objectId

문자열

로딩 중...

버전

문자열

로딩 중...

요약

문자열

로딩 중...

소유자

객체

로딩 중...

종류

문자열

로딩 중...

버전

문자열

로딩 중...

객체 유형

문자열

로딩 중...

hasPublicTransfer

부울

로딩 중...

contents

객체

로딩 중...

이름

문자열

로딩 중...

값

문자열

로딩 중...

previousTransaction

문자열

로딩 중...

저장 할인

문자열

로딩 중...

요청

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

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

1
패키지 main
2

3
import (
4
	"문맥"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"로그"
9
	"시간"
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
// 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
	creds := credentials.NewTLS(&tls.Config{})
46

47
	opts := []grpc.DialOption{
48
		grpc.WithTransportCredentials(creds),
49
		grpc.WithPerRPCCredentials(&auth{token}),
50
	}
51

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

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	objectID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
61
	version := uint64(561366061) // Optional: request a specific version of the object
62
	fieldMask := &fieldmaskpb.FieldMask{
63
		Paths: []string{
64
			"bcs",
65
			"object_id",
66
			"version",
67
			"digest",
68
			"owner",
69
			"object_type",
70
			"has_public_transfer",
71
			"contents",
72
			"previous_transaction",
73
			"storage_rebate",
74
		},
75
	}
76

77
	req := &pb.GetObjectRequest{
78
		ObjectId: &objectID,
79
		Version:  &version,
80
		ReadMask: fieldMask,
81
	}
82

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

86
	resp, err := client.GetObject(ctx, req)
87
	만약 err != nil {
88
		log.Fatalf("GetObject failed: %v", err)
89
	}
90

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

97
	jsonBytes, err := marshaler.Marshal(resp)
98
	만약 err != nil {
99
		log.Fatalf("Failed to marshal response to JSON: %v", err)
100
	}
101

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

107
	formatted, err := json.MarshalIndent(prettyJSON, "", "  ")
108
	만약 err != nil {
109
		log.Fatalf("Failed to format JSON: %v", err)
110
	}
111

112
	fmt.Println(string(formatted))
113
}
114

1
패키지 main
2

3
import (
4
	"문맥"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"로그"
9
	"시간"
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
// 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
	creds := credentials.NewTLS(&tls.Config{})
46

47
	opts := []grpc.DialOption{
48
		grpc.WithTransportCredentials(creds),
49
		grpc.WithPerRPCCredentials(&auth{token}),
50
	}
51

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

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	objectID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
61
	version := uint64(561366061) // Optional: request a specific version of the object
62
	fieldMask := &fieldmaskpb.FieldMask{
63
		Paths: []string{
64
			"bcs",
65
			"object_id",
66
			"version",
67
			"digest",
68
			"owner",
69
			"object_type",
70
			"has_public_transfer",
71
			"contents",
72
			"previous_transaction",
73
			"storage_rebate",
74
		},
75
	}
76

77
	req := &pb.GetObjectRequest{
78
		ObjectId: &objectID,
79
		Version:  &version,
80
		ReadMask: fieldMask,
81
	}
82

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

86
	resp, err := client.GetObject(ctx, req)
87
	만약 err != nil {
88
		log.Fatalf("GetObject failed: %v", err)
89
	}
90

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

97
	jsonBytes, err := marshaler.Marshal(resp)
98
	만약 err != nil {
99
		log.Fatalf("Failed to marshal response to JSON: %v", err)
100
	}
101

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

107
	formatted, err := json.MarshalIndent(prettyJSON, "", "  ")
108
	만약 err != nil {
109
		log.Fatalf("Failed to format JSON: %v", err)
110
	}
111

112
	fmt.Println(string(formatted))
113
}
114

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 패키지 정의 = 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.v2.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
// Request setup
35
const request = {
36
  object_id: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
37
  version: '561366061', // Optional: request a specific version of the object
38
  read_mask: {
39
    paths: [
40
      'bcs',
41
      'object_id',
42
      'version',
43
      'digest',
44
      'owner',
45
      'object_type',
46
      'has_public_transfer',
47
      'contents',
48
      'previous_transaction',
49
      'storage_rebate',
50
    ],
51
  },
52
};
53

54
// Recursively convert byte arrays to hex
55
function convertBytesToHex(obj: any): any {
56
  if (Array.isArray(obj)) {
57
    return obj.map(convertBytesToHex);
58
  } else if (obj && typeof obj === 'object') {
59
    const result: any = {};
60
    for (const key of Object.keys(obj)) {
61
      const val = obj[key];
62
      if (Buffer.isBuffer(val) || (Array.isArray(val) && typeof val[0] === 'number')) {
63
        result[key] = Buffer.from(val).toString('hex');
64
      } else {
65
        result[key] = convertBytesToHex(val);
66
      }
67
    }
68
    return result;
69
  }
70
  return obj;
71
}
72

73
// Invoke GetObject
74
client.GetObject(request, metadata, (err: grpc.ServiceError | null, response: any) => {
75
  if (err) {
76
    console.error('gRPC Error:', {
77
      code: err.code,
78
      message: err.message,
79
      details: err.details,
80
    });
81
  } else {
82
    const decoded = convertBytesToHex(response);
83
    console.log('GetObject Response:');
84
    console.log(JSON.stringify(decoded, null, 2));
85
  }
86
});
87

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 패키지 정의 = 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.v2.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
// Request setup
35
const request = {
36
  object_id: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
37
  version: '561366061', // Optional: request a specific version of the object
38
  read_mask: {
39
    paths: [
40
      'bcs',
41
      'object_id',
42
      'version',
43
      'digest',
44
      'owner',
45
      'object_type',
46
      'has_public_transfer',
47
      'contents',
48
      'previous_transaction',
49
      'storage_rebate',
50
    ],
51
  },
52
};
53

54
// Recursively convert byte arrays to hex
55
function convertBytesToHex(obj: any): any {
56
  if (Array.isArray(obj)) {
57
    return obj.map(convertBytesToHex);
58
  } else if (obj && typeof obj === 'object') {
59
    const result: any = {};
60
    for (const key of Object.keys(obj)) {
61
      const val = obj[key];
62
      if (Buffer.isBuffer(val) || (Array.isArray(val) && typeof val[0] === 'number')) {
63
        result[key] = Buffer.from(val).toString('hex');
64
      } else {
65
        result[key] = convertBytesToHex(val);
66
      }
67
    }
68
    return result;
69
  }
70
  return obj;
71
}
72

73
// Invoke GetObject
74
client.GetObject(request, metadata, (err: grpc.ServiceError | null, response: any) => {
75
  if (err) {
76
    console.error('gRPC Error:', {
77
      code: err.code,
78
      message: err.message,
79
      details: err.details,
80
    });
81
  } else {
82
    const decoded = convertBytesToHex(response);
83
    console.log('GetObject Response:');
84
    console.log(JSON.stringify(decoded, null, 2));
85
  }
86
});
87

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 get_object():
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
    # Specify the object ID you want to retrieve
21
    # Replace with an actual Sui object ID
22
    object_id = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
23

24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "bcs",
27
        "object_id",
28
        "version",
29
        "digest",
30
        "owner",
31
        "object_type",
32
        "has_public_transfer",
33
        "contents",
34
        "previous_transaction",
35
        "storage_rebate"
36
    ])
37
    
38
    # Optional: request a specific version of the object
39
    version = 561366061
40

41
    # Prepare the GetObjectRequest
42
    request = ledger_service_pb2.GetObjectRequest(
43
        object_id=object_id,
44
        version=version,
45
        read_mask=read_mask
46
    )
47

48
    metadata = [("x-token", token)]
49

50
    return stub.GetObject(request, metadata=metadata)
51

52

53
def parse_response_to_json(response):
54
    return json.dumps(
55
        MessageToDict(response, preserving_proto_field_name=True),
56
        indent=2
57
    )
58

59

60
def main():
61
    시도해 보세요:
62
        response = get_object()
63
        print(parse_response_to_json(response))
64
    except grpc.RpcError as e:
65
        print(f"{e.code().name}: {e.details()}")
66

67

68
if __name__ == "__main__":
69
    main()
70

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 get_object():
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
    # Specify the object ID you want to retrieve
21
    # Replace with an actual Sui object ID
22
    object_id = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
23

24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "bcs",
27
        "object_id",
28
        "version",
29
        "digest",
30
        "owner",
31
        "object_type",
32
        "has_public_transfer",
33
        "contents",
34
        "previous_transaction",
35
        "storage_rebate"
36
    ])
37
    
38
    # Optional: request a specific version of the object
39
    version = 561366061
40

41
    # Prepare the GetObjectRequest
42
    request = ledger_service_pb2.GetObjectRequest(
43
        object_id=object_id,
44
        version=version,
45
        read_mask=read_mask
46
    )
47

48
    metadata = [("x-token", token)]
49

50
    return stub.GetObject(request, metadata=metadata)
51

52

53
def parse_response_to_json(response):
54
    return json.dumps(
55
        MessageToDict(response, preserving_proto_field_name=True),
56
        indent=2
57
    )
58

59

60
def main():
61
    시도해 보세요:
62
        response = get_object()
63
        print(parse_response_to_json(response))
64
    except grpc.RpcError as e:
65
        print(f"{e.code().name}: {e.details()}")
66

67

68
if __name__ == "__main__":
69
    main()
70

아직 계정이 없으신가요?

단 몇 초 만에 Quicknode 엔드포인트를 생성하고 개발을 시작하세요

지금 무료로 시작하세요