GetServiceInfo gRPC Method

Parameters

This method does not accept any parameters

Returns

chainId

string

Loading...

chain

string

Loading...

epoch

string

Loading...

checkpointHeight

string

Loading...

timestamp

string

Loading...

lowestAvailableCheckpoint

string

Loading...

lowestAvailableCheckpointObjects

string

Loading...

server

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
  docs-demo.sui-mainnet.quiknode.pro:9000 \
7
  sui.rpc.v2beta2.LedgerService/GetServiceInfo
8

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{}' \
6
  docs-demo.sui-mainnet.quiknode.pro:9000 \
7
  sui.rpc.v2beta2.LedgerService/GetServiceInfo
8

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/grpc/metadata"
14
	"google.golang.org/protobuf/encoding/protojson"
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
func main() {
30
	creds := credentials.NewTLS(&tls.Config{})
31
	conn, err := grpc.Dial(endpoint, grpc.WithTransportCredentials(creds))
32
	if err != nil {
33
		log.Fatalf("Failed to connect: %v", err)
34
	}
35
	defer conn.Close()
36

37
	client := pb.NewLedgerServiceClient(conn)
38

39
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
40
	defer cancel()
41
	ctx = metadata.AppendToOutgoingContext(ctx, "x-token", token)
42

43
	req := &pb.GetServiceInfoRequest{}
44

45
	resp, err := client.GetServiceInfo(ctx, req)
46
	if err != nil {
47
		log.Fatalf("GetServiceInfo failed: %v", err)
48
	}
49

50
	marshaler := protojson.MarshalOptions{
51
		UseProtoNames:   true,
52
		EmitUnpopulated: true,
53
		Indent:          "  ",
54
	}
55

56
	jsonBytes, err := marshaler.Marshal(resp)
57
	if err != nil {
58
		log.Fatalf("Failed to marshal response to JSON: %v", err)
59
	}
60

61
	var prettyJSON map[string]interface{}
62
	if err := json.Unmarshal(jsonBytes, &prettyJSON); err != nil {
63
		log.Fatalf("Failed to unmarshal JSON: %v", err)
64
	}
65

66
	prettyJSONBytes, err := json.MarshalIndent(prettyJSON, "", "  ")
67
	if err != nil {
68
		log.Fatalf("Failed to format JSON: %v", err)
69
	}
70

71
	fmt.Println(string(prettyJSONBytes))
72
}
73

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/grpc/metadata"
14
	"google.golang.org/protobuf/encoding/protojson"
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
func main() {
30
	creds := credentials.NewTLS(&tls.Config{})
31
	conn, err := grpc.Dial(endpoint, grpc.WithTransportCredentials(creds))
32
	if err != nil {
33
		log.Fatalf("Failed to connect: %v", err)
34
	}
35
	defer conn.Close()
36

37
	client := pb.NewLedgerServiceClient(conn)
38

39
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
40
	defer cancel()
41
	ctx = metadata.AppendToOutgoingContext(ctx, "x-token", token)
42

43
	req := &pb.GetServiceInfoRequest{}
44

45
	resp, err := client.GetServiceInfo(ctx, req)
46
	if err != nil {
47
		log.Fatalf("GetServiceInfo failed: %v", err)
48
	}
49

50
	marshaler := protojson.MarshalOptions{
51
		UseProtoNames:   true,
52
		EmitUnpopulated: true,
53
		Indent:          "  ",
54
	}
55

56
	jsonBytes, err := marshaler.Marshal(resp)
57
	if err != nil {
58
		log.Fatalf("Failed to marshal response to JSON: %v", err)
59
	}
60

61
	var prettyJSON map[string]interface{}
62
	if err := json.Unmarshal(jsonBytes, &prettyJSON); err != nil {
63
		log.Fatalf("Failed to unmarshal JSON: %v", err)
64
	}
65

66
	prettyJSONBytes, err := json.MarshalIndent(prettyJSON, "", "  ")
67
	if err != nil {
68
		log.Fatalf("Failed to format JSON: %v", err)
69
	}
70

71
	fmt.Println(string(prettyJSONBytes))
72
}
73

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
// Path to proto file
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/ledger_service.proto');
7

8
// Load proto definitions
9
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
10
  keepCase: true,
11
  longs: String,
12
  enums: String,
13
  defaults: true,
14
  oneofs: true,
15
  includeDirs: [path.join(__dirname, 'protos/proto')],
16
});
17

18
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
19
const LedgerService = proto.sui.rpc.v2beta2.LedgerService;
20

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

26
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
27
const token = 'abcde123456789';
28

29
// Create gRPC client with TLS
30
const client = new LedgerService(endpoint, grpc.credentials.createSsl());
31

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

36
// Empty request for GetServiceInfo
37
const request = {};
38

39
// Make the gRPC call
40
client.GetServiceInfo({}, metadata, (err: grpc.ServiceError | null, response: any) => {
41
  if (err) {
42
    console.error('gRPC Error:', {
43
      code: err.code,
44
      message: err.message,
45
      details: err.details,
46
    });
47
    return;
48
  }
49
  console.log('Service Info:');
50
  console.log(JSON.stringify(response, null, 2));
51
});

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
// Path to proto file
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/ledger_service.proto');
7

8
// Load proto definitions
9
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
10
  keepCase: true,
11
  longs: String,
12
  enums: String,
13
  defaults: true,
14
  oneofs: true,
15
  includeDirs: [path.join(__dirname, 'protos/proto')],
16
});
17

18
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
19
const LedgerService = proto.sui.rpc.v2beta2.LedgerService;
20

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

26
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
27
const token = 'abcde123456789';
28

29
// Create gRPC client with TLS
30
const client = new LedgerService(endpoint, grpc.credentials.createSsl());
31

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

36
// Empty request for GetServiceInfo
37
const request = {};
38

39
// Make the gRPC call
40
client.GetServiceInfo({}, metadata, (err: grpc.ServiceError | null, response: any) => {
41
  if (err) {
42
    console.error('gRPC Error:', {
43
      code: err.code,
44
      message: err.message,
45
      details: err.details,
46
    });
47
    return;
48
  }
49
  console.log('Service Info:');
50
  console.log(JSON.stringify(response, null, 2));
51
});

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_service_info():
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
    # GetServiceInfo doesn't require any specific parameters
21
    request = ledger_service_pb2.GetServiceInfoRequest()
22

23
    metadata = [("x-token", token)]
24

25
    return stub.GetServiceInfo(request, metadata=metadata)
26

27

28
def parse_response_to_json(response):
29
    return json.dumps(
30
        MessageToDict(response, preserving_proto_field_name=True),
31
        indent=2
32
    )
33

34

35
def main():
36
    try:
37
        response = get_service_info()
38
        print(parse_response_to_json(response))
39
    except grpc.RpcError as e:
40
        print(f"{e.code().name}: {e.details()}")
41

42

43
if __name__ == "__main__":
44
    main()
45

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_service_info():
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
    # GetServiceInfo doesn't require any specific parameters
21
    request = ledger_service_pb2.GetServiceInfoRequest()
22

23
    metadata = [("x-token", token)]
24

25
    return stub.GetServiceInfo(request, metadata=metadata)
26

27

28
def parse_response_to_json(response):
29
    return json.dumps(
30
        MessageToDict(response, preserving_proto_field_name=True),
31
        indent=2
32
    )
33

34

35
def main():
36
    try:
37
        response = get_service_info()
38
        print(parse_response_to_json(response))
39
    except grpc.RpcError as e:
40
        print(f"{e.code().name}: {e.details()}")
41

42

43
if __name__ == "__main__":
44
    main()
45

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free