Skip to main content

DynamicField

@iota/grpc

@iota/grpc / DynamicField

Type Alias: DynamicField

DynamicField = Message<"iota.grpc.v1.dynamic_field.DynamicField"> & object

Defined in: sdk/grpc/src/proto/iota/grpc/v1/dynamic_field_pb.ts:29

Type Declaration​

childId?​

optional childId?: ObjectId

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

The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object

Generated​

from field: optional iota.grpc.v1.types.ObjectId child_id = 8;

childObject?​

optional childObject?: Object$

The object itself when a child is a dynamic object field.

Generated​

from field: optional iota.grpc.v1.object.Object child_object = 9;

fieldId?​

optional fieldId?: ObjectId

ObjectId of this dynamic field.

Generated​

from field: optional iota.grpc.v1.types.ObjectId field_id = 3;

fieldObject?​

optional fieldObject?: Object$

The field object itself

Generated​

from field: optional iota.grpc.v1.object.Object field_object = 4;

kind?​

optional kind?: DynamicField_DynamicFieldKind

Generated​

from field: optional iota.grpc.v1.dynamic_field.DynamicField.DynamicFieldKind kind = 1;

name?​

optional name?: BcsData

The dynamic field's "name"

Generated​

from field: optional iota.grpc.v1.bcs.BcsData name = 5;

parent?​

optional parent?: ObjectId

ObjectId of this dynamic field's parent.

Generated​

from field: optional iota.grpc.v1.types.ObjectId parent = 2;

value?​

optional value?: BcsData

The dynamic field's "value".

For regular dynamic fields this contains the BCS-encoded value whose type is given by value_type. For dynamic object The basic unit of storage in IOTA is object. In contrast to many other blockchains, where storage is centered around address and each address contains a key-value store, IOTA's storage is centered around objects. IOTA objects have one of the following primary states:

- Immutable - the object cannot be modified.
- Mutable - the object can be changed.

Further, mutable objects are divided into these categories:

- Owned - the object can be modified only by its owner.
- Shared - the object can be modified by anyone.

Immutable objects do not need this distinction because they have no owner. fields this contains the BCS-encoded ObjectID of the child object; use child_object to access the full object.

Generated​

from field: optional iota.grpc.v1.bcs.BcsData value = 6;

valueType?​

optional valueType?: string

The type of the dynamic field "value".

For regular dynamic fields this is the Move type of the value stored in the value field. For dynamic object The basic unit of storage in IOTA is object. In contrast to many other blockchains, where storage is centered around address and each address contains a key-value store, IOTA's storage is centered around objects. IOTA objects have one of the following primary states:

- Immutable - the object cannot be modified.
- Mutable - the object can be changed.

Further, mutable objects are divided into these categories:

- Owned - the object can be modified only by its owner.
- Shared - the object can be modified by anyone.

Immutable objects do not need this distinction because they have no owner. fields this is the Move type of the child object itself (e.g. 0x2::coin::Coin<0x2::iota::IOTA>), not 0x2::object::ID — clients should use child_object rather than BCS-decoding value with this type.

Generated​

from field: optional string value_type = 7;

Generated​

from message iota.grpc.v1.dynamic_field.DynamicField