GetPackage gRPC Method

Parameters

package_id

string

REQUIRED

Loading...

Returns

package

object

Loading...

storageId

string

Loading...

originalId

string

Loading...

version

string

Loading...

modules

array

Loading...

name

string

Loading...

datatypes

array

Loading...

typeName

string

Loading...

definingId

string

Loading...

module

string

Loading...

name

string

Loading...

abilities

array

Loading...

kind

string

Loading...

typeParameters

array

Loading...

fields

array

Loading...

name

string

Loading...

position

integer

Loading...

type

object

Loading...

functions

array

Loading...

name

string

Loading...

visibility

string

Loading...

isEntry

boolean

Loading...

typeParameters

array

Loading...

parameters

array

Loading...

reference

string

Loading...

body

object

Loading...

type

string

Loading...

typeName

string

Loading...

returns

array

Loading...

body

object

Loading...

type

string

Loading...

typeName

string

Loading...

Request

1
grpcurl -proto ./sui/rpc/v2beta2/move_package_service.proto -H "x-token: abcde123456789" -d '{
2
  "package_id": "0x2"
3
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2beta2.MovePackageService/GetPackage

1
grpcurl -proto ./sui/rpc/v2beta2/move_package_service.proto -H "x-token: abcde123456789" -d '{
2
  "package_id": "0x2"
3
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2beta2.MovePackageService/GetPackage

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/v2beta2" // 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 := "0x2"
56

57
	// Build request with field mask
58
	req := &pb.GetPackageRequest{
59
		PackageId: &packageID,
60
	}
61

62
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
63
	defer cancel()
64

65
	resp, err := client.GetPackage(ctx, req)
66
	if err != nil {
67
		log.Fatalf("GetPackage failed: %v", err)
68
	}
69

70
	// Pretty print the response
71
	marshaler := protojson.MarshalOptions{
72
		UseProtoNames:   true,
73
		EmitUnpopulated: true,
74
		Indent:          "  ",
75
	}
76

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

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

87
	out, _ := json.MarshalIndent(pretty, "", "  ")
88
	fmt.Println(string(out))
89
}
90

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/v2beta2" // 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 := "0x2"
56

57
	// Build request with field mask
58
	req := &pb.GetPackageRequest{
59
		PackageId: &packageID,
60
	}
61

62
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
63
	defer cancel()
64

65
	resp, err := client.GetPackage(ctx, req)
66
	if err != nil {
67
		log.Fatalf("GetPackage failed: %v", err)
68
	}
69

70
	// Pretty print the response
71
	marshaler := protojson.MarshalOptions{
72
		UseProtoNames:   true,
73
		EmitUnpopulated: true,
74
		Indent:          "  ",
75
	}
76

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

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

87
	out, _ := json.MarshalIndent(pretty, "", "  ")
88
	fmt.Println(string(out))
89
}
90

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/v2beta2/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.v2beta2.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
};
40

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

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/v2beta2/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.v2beta2.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
};
40

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

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

6

7
def get_package():
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

22
    request = move_package_service_pb2.GetPackageRequest(
23
        package_id=package_id
24
    )
25

26
    metadata = [("x-token", token)]
27

28
    return stub.GetPackage(request, metadata=metadata)
29

30

31
def parse_response_to_json(response):
32
    return json.dumps(
33
        MessageToDict(response, preserving_proto_field_name=True),
34
        indent=2
35
    )
36

37

38
def main():
39
    try:
40
        response = get_package()
41
        print(parse_response_to_json(response))
42
    except grpc.RpcError as e:
43
        print(f"{e.code().name}: {e.details()}")
44

45

46
if __name__ == "__main__":
47
    main()
48

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

6

7
def get_package():
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

22
    request = move_package_service_pb2.GetPackageRequest(
23
        package_id=package_id
24
    )
25

26
    metadata = [("x-token", token)]
27

28
    return stub.GetPackage(request, metadata=metadata)
29

30

31
def parse_response_to_json(response):
32
    return json.dumps(
33
        MessageToDict(response, preserving_proto_field_name=True),
34
        indent=2
35
    )
36

37

38
def main():
39
    try:
40
        response = get_package()
41
        print(parse_response_to_json(response))
42
    except grpc.RpcError as e:
43
        print(f"{e.code().name}: {e.details()}")
44

45

46
if __name__ == "__main__":
47
    main()
48

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free