Parameters

parent

string

REQUIRED

The UID of the parent object that owns the dynamic fields

page_size

integer

Maximum number of dynamic fields to return (default: 50, max: 1000)

page_token

string

A page token, received from a previous ListDynamicFields call. Provide this to retrieve the subsequent page

read_mask

object

Mask specifying which fields to read (defaults to parent,field_id)

Returns

dynamicFields

array

List of dynamic fields owned by the parent object

kind

string

The kind of dynamic field (FIELD or OBJECT)

parent

string

ObjectId of this dynamic field's parent

fieldId

string

ObjectId of this dynamic field

nameType

string

The type of the dynamic field name

nameValue

string

The serialized move value of the field name

valueType

string

The type of the dynamic field value or object type for dynamic object fields

dynamicObjectId

string

The ObjectId of the child object when this is a dynamic object field

object

object

The object itself when this is a dynamic object field

nextPageToken

string

Token for retrieving the next page (omitted if no more pages)

Request

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/state_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "parent": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
7
  }' \
8
  docs-demo.sui-mainnet.quiknode.pro:9000 \
9
  sui.rpc.v2.StateService/ListDynamicFields

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2/state_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "parent": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
7
  }' \
8
  docs-demo.sui-mainnet.quiknode.pro:9000 \
9
  sui.rpc.v2.StateService/ListDynamicFields

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{"x-token": a.token}, nil
36
}
37
func (a *auth) RequireTransportSecurity() bool {
38
	return true
39
}
40

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

48
	conn, err := grpc.Dial(endpoint, opts...)
49
	if err != nil {
50
		log.Fatalf("Failed to connect: %v", err)
51
	}
52
	defer conn.Close()
53

54
	client := pb.NewStateServiceClient(conn)
55

56
	parentID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	req := &pb.ListDynamicFieldsRequest{
59
		Parent: &parentID,
60
		ReadMask: &fieldmaskpb.FieldMask{
61
			Paths: []string{
62
			},
63
		},
64
	}
65

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

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

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
	"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{"x-token": a.token}, nil
36
}
37
func (a *auth) RequireTransportSecurity() bool {
38
	return true
39
}
40

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

48
	conn, err := grpc.Dial(endpoint, opts...)
49
	if err != nil {
50
		log.Fatalf("Failed to connect: %v", err)
51
	}
52
	defer conn.Close()
53

54
	client := pb.NewStateServiceClient(conn)
55

56
	parentID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	req := &pb.ListDynamicFieldsRequest{
59
		Parent: &parentID,
60
		ReadMask: &fieldmaskpb.FieldMask{
61
			Paths: []string{
62
			},
63
		},
64
	}
65

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

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

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

29
// Create secure client
30
const client = new StateService(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
  parent: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
39
};
40

41
// Perform gRPC call
42
client.ListDynamicFields(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('ListDynamicFields 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/v2/state_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 StateService = proto.sui.rpc.v2.StateService;
28

29
// Create secure client
30
const client = new StateService(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
  parent: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
39
};
40

41
// Perform gRPC call
42
client.ListDynamicFields(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('ListDynamicFields 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.v2 import state_service_pb2, state_service_pb2_grpc
5

6

7
def list_dynamic_fields():
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 = state_service_pb2_grpc.StateServiceStub(channel)
19

20
    parent = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
21

22
    request = state_service_pb2.ListDynamicFieldsRequest(
23
        parent=parent
24
    )
25

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

28
    return stub.ListDynamicFields(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 = list_dynamic_fields()
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.v2 import state_service_pb2, state_service_pb2_grpc
5

6

7
def list_dynamic_fields():
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 = state_service_pb2_grpc.StateServiceStub(channel)
19

20
    parent = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
21

22
    request = state_service_pb2.ListDynamicFieldsRequest(
23
        parent=parent
24
    )
25

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

28
    return stub.ListDynamicFields(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 = list_dynamic_fields()
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