Parameters

package_id

string

REQUIRED

The storage_id of the requested package

module_name

string

REQUIRED

The name of the requested module

name

string

REQUIRED

The name of the requested datatype

Returns

datatype

object

The datatype information

typeName

string

The fully qualified type name

definingId

string

The ID of the package that defines this type

module

string

The module name where this type is defined

name

string

The simple name of the type

abilities

array

Array of abilities this type has (e.g., STORE, KEY, COPY, DROP)

typeParameters

array

Array of type parameters for generic types

isPhantom

boolean

Whether this type parameter is phantom

kind

string

The kind of datatype (e.g., STRUCT)

fields

array

Array of fields in the struct

name

string

The name of the field

position

integer

The position of the field in the struct

type

object

The type information of the field

type

string

The type category (e.g., DATATYPE, TYPE_PARAMETER)

typeName

string

The fully qualified type name for DATATYPE types

typeParameterInstantiation

array

(Optional) Array of type parameter instantiations for generic types

type

string

The type of instantiation (e.g., TYPE_PARAMETER)

typeParameter

integer

The index of the type parameter

typeParameter

integer

The index of the type parameter for TYPE_PARAMETER types

Request

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/move_package_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "package_id": "0x4897ec4008e4f6500880a547c25a6d4a26807c00ec359b4be24e6322fb2b86b5",
7
    "module_name": "master",
8
    "name": "Metadata"
9
  }' \
10
  docs-demo.sui-mainnet.quiknode.pro:9000 \
11
  sui.rpc.v2.MovePackageService/GetDatatype

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/move_package_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "package_id": "0x4897ec4008e4f6500880a547c25a6d4a26807c00ec359b4be24e6322fb2b86b5",
7
    "module_name": "master",
8
    "name": "Metadata"
9
  }' \
10
  docs-demo.sui-mainnet.quiknode.pro:9000 \
11
  sui.rpc.v2.MovePackageService/GetDatatype

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

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

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

23
var (
24
	token = "YOUR_TOKEN_NUMBER"
25
	endpoint = "YOUR_QN_ENDPOINT:9000"
26
)
27

28
// Auth structure for x-token
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.NewMovePackageServiceClient(conn)
54

55
	packageID := "0x4897ec4008e4f6500880a547c25a6d4a26807c00ec359b4be24e6322fb2b86b5"
56
	moduleName := "master"
57
	datatypeName := "Metadata"
58

59
	req := &pb.GetDatatypeRequest{
60
		PackageId:  &packageID,
61
		ModuleName: &moduleName,
62
		Name:       &datatypeName,
63
	}
64

65
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
66
	defer cancel()
67

68
	resp, err := client.GetDatatype(ctx, req)
69
	if err != nil {
70
		log.Fatalf("GetDatatype failed: %v", err)
71
	}
72

73
	// Pretty print the response
74
	marshaler := protojson.MarshalOptions{
75
		UseProtoNames:   true,
76
		EmitUnpopulated: true,
77
		Indent:          "  ",
78
	}
79

80
	jsonBytes, err := marshaler.Marshal(resp)
81
	if err != nil {
82
		log.Fatalf("Failed to marshal: %v", err)
83
	}
84

85
	var pretty map[string]interface{}
86
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
87
		log.Fatalf("Failed to parse JSON: %v", err)
88
	}
89

90
	out, _ := json.MarshalIndent(pretty, "", "  ")
91
	fmt.Println(string(out))
92
}
93

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

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

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

23
var (
24
	token = "YOUR_TOKEN_NUMBER"
25
	endpoint = "YOUR_QN_ENDPOINT:9000"
26
)
27

28
// Auth structure for x-token
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.NewMovePackageServiceClient(conn)
54

55
	packageID := "0x4897ec4008e4f6500880a547c25a6d4a26807c00ec359b4be24e6322fb2b86b5"
56
	moduleName := "master"
57
	datatypeName := "Metadata"
58

59
	req := &pb.GetDatatypeRequest{
60
		PackageId:  &packageID,
61
		ModuleName: &moduleName,
62
		Name:       &datatypeName,
63
	}
64

65
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
66
	defer cancel()
67

68
	resp, err := client.GetDatatype(ctx, req)
69
	if err != nil {
70
		log.Fatalf("GetDatatype failed: %v", err)
71
	}
72

73
	// Pretty print the response
74
	marshaler := protojson.MarshalOptions{
75
		UseProtoNames:   true,
76
		EmitUnpopulated: true,
77
		Indent:          "  ",
78
	}
79

80
	jsonBytes, err := marshaler.Marshal(resp)
81
	if err != nil {
82
		log.Fatalf("Failed to marshal: %v", err)
83
	}
84

85
	var pretty map[string]interface{}
86
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
87
		log.Fatalf("Failed to parse JSON: %v", err)
88
	}
89

90
	out, _ := json.MarshalIndent(pretty, "", "  ")
91
	fmt.Println(string(out))
92
}
93

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

29
// Create secure client
30
const client = new MovePackageService(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
const request = {
38
  package_id: '0x2',
39
  module_name: 'coin',
40
  name: 'Coin',
41
};
42

43
// Perform gRPC call
44
client.GetDatatype(request, metadata, (err: grpc.ServiceError | null, response: any) => {
45
  if (err) {
46
    console.error('gRPC Error:', {
47
      code: err.code,
48
      message: err.message,
49
      details: err.details,
50
    });
51
  } else {
52
    console.log('GetDatatype Response:');
53
    console.log(JSON.stringify(response, null, 2));
54
  }
55
});
56

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

29
// Create secure client
30
const client = new MovePackageService(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
const request = {
38
  package_id: '0x2',
39
  module_name: 'coin',
40
  name: 'Coin',
41
};
42

43
// Perform gRPC call
44
client.GetDatatype(request, metadata, (err: grpc.ServiceError | null, response: any) => {
45
  if (err) {
46
    console.error('gRPC Error:', {
47
      code: err.code,
48
      message: err.message,
49
      details: err.details,
50
    });
51
  } else {
52
    console.log('GetDatatype Response:');
53
    console.log(JSON.stringify(response, null, 2));
54
  }
55
});
56

1
import grpc
2
import json
3
from google.protobuf.json_format import MessageToDict
4
from sui.rpc.v2 import move_package_service_pb2, move_package_service_pb2_grpc
5

6

7
def get_datatype():
8

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 = move_package_service_pb2_grpc.MovePackageServiceStub(channel)
19

20
    package_id = "0x2"
21
    module_name = "coin"
22
    name = "Coin"
23

24
    request = move_package_service_pb2.GetDatatypeRequest(
25
        package_id=package_id,
26
        module_name=module_name,
27
        name=name
28
    )
29

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

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

34

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

41

42
def main():
43
    try:
44
        response = get_datatype()
45
        print(parse_response_to_json(response))
46
    except grpc.RpcError as e:
47
        print(f"{e.code().name}: {e.details()}")
48

49
if __name__ == "__main__":
50
    main()
51

1
import grpc
2
import json
3
from google.protobuf.json_format import MessageToDict
4
from sui.rpc.v2 import move_package_service_pb2, move_package_service_pb2_grpc
5

6

7
def get_datatype():
8

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 = move_package_service_pb2_grpc.MovePackageServiceStub(channel)
19

20
    package_id = "0x2"
21
    module_name = "coin"
22
    name = "Coin"
23

24
    request = move_package_service_pb2.GetDatatypeRequest(
25
        package_id=package_id,
26
        module_name=module_name,
27
        name=name
28
    )
29

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

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

34

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

41

42
def main():
43
    try:
44
        response = get_datatype()
45
        print(parse_response_to_json(response))
46
    except grpc.RpcError as e:
47
        print(f"{e.code().name}: {e.details()}")
48

49
if __name__ == "__main__":
50
    main()
51

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free