GetObject gRPC Method

Parameters

object_id

string

REQUIRED

Loading...

read_mask

object

Loading...

paths

array

Loading...

Returns

object

object

Loading...

bcs

object

Loading...

name

string

Loading...

value

string

Loading...

objectId

string

Loading...

version

string

Loading...

digest

string

Loading...

owner

object

Loading...

kind

string

Loading...

version

string

Loading...

objectType

string

Loading...

hasPublicTransfer

boolean

Loading...

contents

object

Loading...

name

string

Loading...

value

string

Loading...

previousTransaction

string

Loading...

storageRebate

string

Loading...

Request

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

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

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/v2beta2" // 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
	if 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
	fieldMask := &fieldmaskpb.FieldMask{
62
		Paths: []string{
63
			"bcs",
64
			"object_id",
65
			"version",
66
			"digest",
67
			"owner",
68
			"object_type",
69
			"has_public_transfer",
70
			"contents",
71
			"previous_transaction",
72
			"storage_rebate",
73
		},
74
	}
75

76
	req := &pb.GetObjectRequest{
77
		ObjectId: &objectID,
78
		ReadMask: fieldMask,
79
	}
80

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

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

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

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

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

105
	formatted, err := json.MarshalIndent(prettyJSON, "", "  ")
106
	if err != nil {
107
		log.Fatalf("Failed to format JSON: %v", err)
108
	}
109

110
	fmt.Println(string(formatted))
111
}
112

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/v2beta2" // 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
	if 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
	fieldMask := &fieldmaskpb.FieldMask{
62
		Paths: []string{
63
			"bcs",
64
			"object_id",
65
			"version",
66
			"digest",
67
			"owner",
68
			"object_type",
69
			"has_public_transfer",
70
			"contents",
71
			"previous_transaction",
72
			"storage_rebate",
73
		},
74
	}
75

76
	req := &pb.GetObjectRequest{
77
		ObjectId: &objectID,
78
		ReadMask: fieldMask,
79
	}
80

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

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

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

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

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

105
	formatted, err := json.MarshalIndent(prettyJSON, "", "  ")
106
	if err != nil {
107
		log.Fatalf("Failed to format JSON: %v", err)
108
	}
109

110
	fmt.Println(string(formatted))
111
}
112

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/v2beta2/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
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
25
const LedgerService = proto.sui.rpc.v2beta2.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
  read_mask: {
38
    paths: [
39
      'bcs',
40
      'object_id',
41
      'version',
42
      'digest',
43
      'owner',
44
      'object_type',
45
      'has_public_transfer',
46
      'contents',
47
      'previous_transaction',
48
      'storage_rebate',
49
    ],
50
  },
51
};
52

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

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

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/v2beta2/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
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
25
const LedgerService = proto.sui.rpc.v2beta2.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
  read_mask: {
38
    paths: [
39
      'bcs',
40
      'object_id',
41
      'version',
42
      'digest',
43
      'owner',
44
      'object_type',
45
      'has_public_transfer',
46
      'contents',
47
      'previous_transaction',
48
      'storage_rebate',
49
    ],
50
  },
51
};
52

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

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

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.v2beta2 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
    # Prepare the GetObjectRequest
39
    request = ledger_service_pb2.GetObjectRequest(
40
        object_id=object_id,
41
        read_mask=read_mask
42
    )
43

44
    metadata = [("x-token", token)]
45

46
    return stub.GetObject(request, metadata=metadata)
47

48

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

55

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

63

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

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.v2beta2 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
    # Prepare the GetObjectRequest
39
    request = ledger_service_pb2.GetObjectRequest(
40
        object_id=object_id,
41
        read_mask=read_mask
42
    )
43

44
    metadata = [("x-token", token)]
45

46
    return stub.GetObject(request, metadata=metadata)
47

48

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

55

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

63

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

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free