gRPCListDynamicFields

sui-mainnet.nodit.io:443 sui.rpc.v2.StateService/ListDynamicFieldsunary

Retrieves the list of dynamic fields of the specified object.

TransportgRPC

Request and response messages are identical for both transports. Only the wire protocol, headers, and client library differ.

Protocol
Native gRPC over HTTP/2 with TLS. Suited to server-side clients and grpcurl.
Content-Type
application/grpc
Headers
x-api-key
Streaming
Server, client, and bidirectional streaming are all supported.
Errors
grpc-status and grpc-message are delivered as HTTP/2 trailers.
Request Body
parentstringrequired

Required. The UID of the parent, which owns the collection of dynamic fields.

page_sizeinteger

The maximum number of dynamic fields to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstring

A page token, received from a previous ListDynamicFields call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDynamicFields must match the call that provided the page token.

pathsstring[]

The set of field mask paths (e.g. "object_id", "version", "digest").

Responses
kindstring

Kind of the dynamic field.

parentstring

ObjectId of the parent.

field_idstring

ObjectId of the field.

field_objectobject

The field object.

bcsobject

This Object serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

The digest of this Object.

ownerobject

Owner of the object.

kindstring

Kind of ownership.

addressstring

Address or ObjectId of the owner.

versioninteger

The initial_shared_version if kind is SHARED or start_version if kind is CONSENSUS_ADDRESS.

object_typestring

Type of the object.

has_public_transferboolean

DEPRECATED. Whether the object has public transfer.

contentsobject

BCS bytes of a Move struct value. Only set for Move structs.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

packageobject

Package data if the object is a package.

storage_idstring

Package ObjectId (storage ID).

original_idstring

ID of the first published version.

versioninteger

Version of the package.

modulesobject[]

Modules in the package.

namestring

Name of the module.

contentsstring

Serialized bytecode.

datatypesobject[]

Datatypes defined in the module.

functionsobject[]

Functions defined in the module.

type_originsobject[]

Type origins for the package's types.

module_namestring

Name of the defining module.

datatype_namestring

Name of the datatype.

package_idstring

Package ID where the type originated.

linkageobject[]

Transitive dependencies (linkage table).

original_idstring

Original package ID.

upgraded_idstring

Upgraded package ID.

upgraded_versioninteger

Upgraded package version.

previous_transactionstring

Digest of the transaction that created or last mutated this object.

storage_rebateinteger

Storage rebate for the object.

jsonobject

JSON rendering of the object.

balanceinteger

Current balance if this object is a 0x2::coin::Coin<T>.

displayobject

Template-based display rendering.

outputobject

Substituted display fields.

errorsobject

Fields that failed to render.

nameobject

Name of the field.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

valueobject

Value of the field.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

value_typestring

Type of the value.

child_idstring

ObjectId of the child if this is a dynamic object field.

child_objectobject

The child object.

bcsobject

This Object serialized as BCS.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

object_idstring

ObjectId of the object.

versioninteger

Version of the object.

digeststring

The digest of this Object.

ownerobject

Owner of the object.

kindstring

Kind of ownership.

addressstring

Address or ObjectId of the owner.

versioninteger

The initial_shared_version if kind is SHARED or start_version if kind is CONSENSUS_ADDRESS.

object_typestring

Type of the object.

has_public_transferboolean

DEPRECATED. Whether the object has public transfer.

contentsobject

BCS bytes of a Move struct value. Only set for Move structs.

namestring

Name that identifies the type of the serialized value.

valuestring

Bytes of a BCS serialized value.

packageobject

Package data if the object is a package.

storage_idstring

Package ObjectId (storage ID).

original_idstring

ID of the first published version.

versioninteger

Version of the package.

modulesobject[]

Modules in the package.

namestring

Name of the module.

contentsstring

Serialized bytecode.

datatypesobject[]

Datatypes defined in the module.

functionsobject[]

Functions defined in the module.

type_originsobject[]

Type origins for the package's types.

module_namestring

Name of the defining module.

datatype_namestring

Name of the datatype.

package_idstring

Package ID where the type originated.

linkageobject[]

Transitive dependencies (linkage table).

original_idstring

Original package ID.

upgraded_idstring

Upgraded package ID.

upgraded_versioninteger

Upgraded package version.

previous_transactionstring

Digest of the transaction that created or last mutated this object.

storage_rebateinteger

Storage rebate for the object.

jsonobject

JSON rendering of the object.

balanceinteger

Current balance if this object is a 0x2::coin::Coin<T>.

displayobject

Template-based display rendering.

outputobject

Substituted display fields.

errorsobject

Fields that failed to render.

next_page_tokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

X-API-KEY
RequestCU50
grpcurl
grpcurl \
  -import-path . -proto sui/rpc/v2/state_service.proto \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -d '{
  "parent": "",
  "page_size": 50,
  "page_token": "",
  "read_mask": {
    "paths": []
  }
}' \
  sui-mainnet.nodit.io:443 sui.rpc.v2.StateService/ListDynamicFields
Response
Example · 200
{
  "dynamic_fields": [],
  "next_page_token": ""
}