ListDynamicFields - Sui

ListDynamicFields. Lists the dynamic fields of an object.

ListDynamicFields - sui [Value: 20CU]
Lists the dynamic fields of an object (its UID), with pagination.
gRPC: sui.rpc.v2.StateService/ListDynamicFields
Use cases

Use cases

  • Read table and bag entries
  • Explore object child storage
  • Index dynamic object fields
Constraints

Constraints

  • Parent UID is required
  • Default 50, maximum 1000 entries
  • Default mask: parent, field_id
Get started
Unlock Access to 100+ chains
Boost your app's speed and reliability with dRPC - get your access API key

Language

Request
Examples
grpcurl \
  -H "x-drpc-key: {API-KEY}" \
  -H "x-drpc-chain: sui" \
  -d '{
  "parent": "0xb57fba584a700a5bcb40991e1b2e6bf68b0f3896d767a0da92e69de73de226ac"
}' \
  grpc.drpc.live:443 \
  sui.rpc.v2.StateService/ListDynamicFields
Copy
Response
200
{
  "dynamic_fields": [
    {
      "parent": "0xb57fba584a700a5bcb40991e1b2e6bf68b0f3896d767a0da92e69de73de226ac",
      "field_id": "0x0a3f6c1d9e2b5847a6c3f0e9d8b7a6958473f2e1d0c9b8a7f6e5d4c3b2a19087"
    },
    {
      "parent": "0xb57fba584a700a5bcb40991e1b2e6bf68b0f3896d767a0da92e69de73de226ac",
      "field_id": "0x1b4e7d2a0f3c6958b7d4e1f0a9c8b7a6959483e2f1d0c9b8a7f6e5d4c3b2a190"
    }
  ],
  "next_page_token": "CiAbTn0qDzxpWLfU4fCpyLemlZSD4vHQybin9uXUw7KhkA=="
}
Copy

Request params

Parametersobject
object
parentstring
Required. The UID of the parent object that owns the dynamic fields.
page_sizeinteger
Optional. Maximum number of entries to return. Defaults to 50, maximum 1000. A page is also cut at about 512 KiB.
page_tokenstring
Optional. Page token (bytes, base64) from a previous call's `next_page_token`. Other parameters must match that call.
read_maskstring
Optional. google.protobuf.FieldMask with the fields to return, as comma-separated paths. Defaults to `parent,field_id`. Use `*` to return all fields.

Response

200
Lists the dynamic fields of an object (its UID), with pagination.

Response params

object
dynamic_fieldsarray_of_objects
Page of dynamic fields owned by the parent.
object
kindstring
`FIELD` for a dynamic field, `OBJECT` for a dynamic object field.
parentstring
Object id of the parent.
field_idstring
Object id of the dynamic field.
field_objectobject
The field object itself.
nameobject
BCS-encoded field name (`name`, `value`).
valueobject
BCS-encoded field value (`name`, `value`).
value_typestring
Type of the value, or of the child object for dynamic object fields.
child_idstring
Id of the child object, for dynamic object fields.
child_objectobject
The child object, for dynamic object fields.
next_page_tokenstring
Token (bytes, base64) for the next page. Omitted when there are no more pages.