Skip to main content

IMoveObject

Interface implemented by types that represent a Move object on-chain (A Move value whose type has key).

interface IMoveObject {
  contents: MoveValue
  dynamicField(
    name: DynamicFieldName!
  ): DynamicField
  dynamicFields(
    first: Int
    after: String
    last: Int
    before: String
  ): DynamicFieldConnection
  dynamicObjectField(
    name: DynamicFieldName!
  ): DynamicField
  hasPublicTransfer: Boolean
  moveObjectBcs: Base64
  multiGetDynamicFields(
    keys: [DynamicFieldName!]!
  ): [DynamicField]!
  multiGetDynamicObjectFields(
    keys: [DynamicFieldName!]!
  ): [DynamicField]!
}

Fields​

IMoveObject.contents ● MoveValue object​

The structured representation of the object's contents.

IMoveObject.dynamicField ● DynamicField object​

Access a dynamic field on an object using its type and BCS-encoded name.

Returns null if a dynamic field with that name could not be found attached to this object.

IMoveObject.dynamicField.name ● DynamicFieldName! non-null input​

IMoveObject.dynamicFields ● DynamicFieldConnection object​

Dynamic fields and dynamic object fields owned by this object.

Dynamic fields on wrapped objects can be accessed using Address.dynamicFields.

IMoveObject.dynamicFields.first ● Int scalar​
IMoveObject.dynamicFields.after ● String scalar​
IMoveObject.dynamicFields.last ● Int scalar​
IMoveObject.dynamicFields.before ● String scalar​

IMoveObject.dynamicObjectField ● DynamicField object​

Access a dynamic object field on an object using its type and BCS-encoded name.

Returns null if a dynamic object field with that name could not be found attached to this object.

IMoveObject.dynamicObjectField.name ● DynamicFieldName! non-null input​

IMoveObject.hasPublicTransfer ● Boolean scalar​

Whether this object can be transfered using the TransferObjects Programmable Transaction Command or sui::transfer::public_transfer.

Both these operations require the object to have both the key and store abilities.

IMoveObject.moveObjectBcs ● Base64 scalar​

The Base64-encoded BCS serialize of this object, as a MoveObject.

IMoveObject.multiGetDynamicFields ● [DynamicField]! non-null object​

Access dynamic fields on an object using their types and BCS-encoded names.

Returns a list of dynamic fields that is guaranteed to be the same length as keys. If a dynamic field in keys could not be found in the store, its corresponding entry in the result will be null.

IMoveObject.multiGetDynamicFields.keys ● [DynamicFieldName!]! non-null input​

IMoveObject.multiGetDynamicObjectFields ● [DynamicField]! non-null object​

Access dynamic object fields on an object using their types and BCS-encoded names.

Returns a list of dynamic object fields that is guaranteed to be the same length as keys. If a dynamic object field in keys could not be found in the store, its corresponding entry in the result will be null.

IMoveObject.multiGetDynamicObjectFields.keys ● [DynamicFieldName!]! non-null input​

Implemented By​

CoinMetadata object ● DynamicField object ● MoveObject object