GetEpoch gRPC Method

Parameters

epoch

tekenreeks

Bezig met laden...

read_mask

object

Bezig met laden...

paths

array

Bezig met laden...

Retourzendingen

epoch

object

Bezig met laden...

epoch

tekenreeks

Bezig met laden...

committee

object

Bezig met laden...

epoch

tekenreeks

Bezig met laden...

members

array

Bezig met laden...

publicKey

tekenreeks

Bezig met laden...

weight

tekenreeks

Bezig met laden...

Verzoek

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "epoch": "10",
7
    "read_mask": {
8
      "paths": [
9
        "epoch",
10
        "committee"
11
      ]
12
    }
13
  }' \
14
  docs-demo.sui-mainnet.quiknode.pro:9000 \
15
  sui.rpc.v2.LedgerService/GetEpoch
16

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/ledger_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "epoch": "10",
7
    "read_mask": {
8
      "paths": [
9
        "epoch",
10
        "committee"
11
      ]
12
    }
13
  }' \
14
  docs-demo.sui-mainnet.quiknode.pro:9000 \
15
  sui.rpc.v2.LedgerService/GetEpoch
16

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/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
	if err != nil {
54
		log.Fatalf("Failed to connect: %v", err)
55
	}
56
	defer conn.Close()
57

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	// Request epoch #10
61
	epochNum := uint64(10)
62
	fieldMask := &fieldmaskpb.FieldMask{
63
		Paths: []string{
64
			"epoch",
65
			"committee",
66
		},
67
	}
68

69
	req := &pb.GetEpochRequest{
70
		Epoch:    &epochNum,
71
		ReadMask: fieldMask,
72
	}
73

74
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
75
	defer cancel()
76

77
	resp, err := client.GetEpoch(ctx, req)
78
	if err != nil {
79
		log.Fatalf("GetEpoch failed: %v", err)
80
	}
81

82
	// Convert protobuf response to readable JSON
83
	marshaler := protojson.MarshalOptions{
84
		UseProtoNames:   true,
85
		EmitUnpopulated: true,
86
		Indent:          "  ",
87
	}
88

89
	jsonBytes, err := marshaler.Marshal(resp)
90
	if err != nil {
91
		log.Fatalf("Failed to marshal response: %v", err)
92
	}
93

94
	var pretty map[string]interface{}
95
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
96
		log.Fatalf("Failed to parse JSON: %v", err)
97
	}
98

99
	formatted, _ := json.MarshalIndent(pretty, "", "  ")
100
	fmt.Println(string(formatted))
101
}
102

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/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
	if err != nil {
54
		log.Fatalf("Failed to connect: %v", err)
55
	}
56
	defer conn.Close()
57

58
	client := pb.NewLedgerServiceClient(conn)
59

60
	// Request epoch #10
61
	epochNum := uint64(10)
62
	fieldMask := &fieldmaskpb.FieldMask{
63
		Paths: []string{
64
			"epoch",
65
			"committee",
66
		},
67
	}
68

69
	req := &pb.GetEpochRequest{
70
		Epoch:    &epochNum,
71
		ReadMask: fieldMask,
72
	}
73

74
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
75
	defer cancel()
76

77
	resp, err := client.GetEpoch(ctx, req)
78
	if err != nil {
79
		log.Fatalf("GetEpoch failed: %v", err)
80
	}
81

82
	// Convert protobuf response to readable JSON
83
	marshaler := protojson.MarshalOptions{
84
		UseProtoNames:   true,
85
		EmitUnpopulated: true,
86
		Indent:          "  ",
87
	}
88

89
	jsonBytes, err := marshaler.Marshal(resp)
90
	if err != nil {
91
		log.Fatalf("Failed to marshal response: %v", err)
92
	}
93

94
	var pretty map[string]interface{}
95
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
96
		log.Fatalf("Failed to parse JSON: %v", err)
97
	}
98

99
	formatted, _ := json.MarshalIndent(pretty, "", "  ")
100
	fmt.Println(string(formatted))
101
}
102

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 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.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
  epoch: 10, // Replace with desired epoch number
37
  read_mask: {
38
    paths: ['epoch', 'committee'], // FieldMask
39
  },
40
};
41

42
// Recursively convert byte arrays to hex
43
function convertBytesToHex(obj: any): any {
44
  if (Array.isArray(obj)) {
45
    return obj.map(convertBytesToHex);
46
  } else if (obj && typeof obj === 'object') {
47
    const result: any = {};
48
    for (const key of Object.keys(obj)) {
49
      const val = obj[key];
50
      if (Buffer.isBuffer(val) || (Array.isArray(val) && typeof val[0] === 'number')) {
51
        result[key] = Buffer.from(val).toString('hex');
52
      } else {
53
        result[key] = convertBytesToHex(val);
54
      }
55
    }
56
    return result;
57
  }
58
  return obj;
59
}
60

61
client.GetEpoch(request, metadata, (err: grpc.ServiceError | null, response: any) => {
62
  if (err) {
63
    console.error('gRPC Error:', {
64
      code: err.code,
65
      message: err.message,
66
      details: err.details,
67
    });
68
  } else {
69
    const decoded = convertBytesToHex(response);
70
    console.log('GetEpoch Response:');
71
    console.log(JSON.stringify(decoded, null, 2));
72
  }
73
});
74

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 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.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
  epoch: 10, // Replace with desired epoch number
37
  read_mask: {
38
    paths: ['epoch', 'committee'], // FieldMask
39
  },
40
};
41

42
// Recursively convert byte arrays to hex
43
function convertBytesToHex(obj: any): any {
44
  if (Array.isArray(obj)) {
45
    return obj.map(convertBytesToHex);
46
  } else if (obj && typeof obj === 'object') {
47
    const result: any = {};
48
    for (const key of Object.keys(obj)) {
49
      const val = obj[key];
50
      if (Buffer.isBuffer(val) || (Array.isArray(val) && typeof val[0] === 'number')) {
51
        result[key] = Buffer.from(val).toString('hex');
52
      } else {
53
        result[key] = convertBytesToHex(val);
54
      }
55
    }
56
    return result;
57
  }
58
  return obj;
59
}
60

61
client.GetEpoch(request, metadata, (err: grpc.ServiceError | null, response: any) => {
62
  if (err) {
63
    console.error('gRPC Error:', {
64
      code: err.code,
65
      message: err.message,
66
      details: err.details,
67
    });
68
  } else {
69
    const decoded = convertBytesToHex(response);
70
    console.log('GetEpoch Response:');
71
    console.log(JSON.stringify(decoded, null, 2));
72
  }
73
});
74

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_epoch():
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 which epoch you want to retrieve
21
    # For example, epoch 10 - replace with the actual epoch number you want
22
    epoch_number = 10
23

24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "epoch",
27
        "committee"
28
    ])
29
    
30
    # Prepare the GetEpochRequest
31
    request = ledger_service_pb2.GetEpochRequest(
32
        epoch=epoch_number,
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.GetEpoch(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = get_epoch()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

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_epoch():
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 which epoch you want to retrieve
21
    # For example, epoch 10 - replace with the actual epoch number you want
22
    epoch_number = 10
23

24
    # Create a field mask to specify which fields to include in the response
25
    read_mask = FieldMask(paths=[
26
        "epoch",
27
        "committee"
28
    ])
29
    
30
    # Prepare the GetEpochRequest
31
    request = ledger_service_pb2.GetEpochRequest(
32
        epoch=epoch_number,
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.GetEpoch(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = get_epoch()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

Heb je nog geen account?

Maak binnen enkele seconden je Quicknode-eindpunt aan en ga aan de slag

Ga gratis aan de slag