UpdateEntityParameters
UpdateEntityParameters =
object
Defined in: src/actions/wallet/updateEntity.ts:24
Parameters for the updateEntity function.
- entityKey: The key of the entity to update.
- payload: The payload of the entity.
- attributes: The attributes of the entity. Attribute values may be strings
or numbers, but numeric values must be integers. To store a non-integer,
scale it to an integer (e.g.
1.5->1500) to preserve numeric ordering, or pass it as a string (e.g."1.5"). A non-integer numeric value throws an InvalidAttributeError. - contentType: The content type of the entity.
- expiresIn: How long until the entity expires, in seconds. Because Arkiv measures expiration in blocks (1 block = 2 seconds), this must be a positive integer and a multiple of the block time (2 seconds). Invalid values throw an InvalidExpirationError.
Properties
Section titled “Properties”attributes
Section titled “attributes”attributes:
Attribute[]
Defined in: src/actions/wallet/updateEntity.ts:28
Entity attributes. Numeric values must be integers (scale non-integers, e.g. 1.5 -> 1500, or use a string). Throws InvalidAttributeError otherwise.
contentType
Section titled “contentType”contentType:
MimeType|string
Defined in: src/actions/wallet/updateEntity.ts:29
entityKey
Section titled “entityKey”entityKey:
Hex
Defined in: src/actions/wallet/updateEntity.ts:25
expiresIn
Section titled “expiresIn”expiresIn:
number
Defined in: src/actions/wallet/updateEntity.ts:32
Seconds until expiry. Must be a positive integer and a multiple of the 2s block time. Throws InvalidExpirationError otherwise.
payload
Section titled “payload”payload:
Uint8Array
Defined in: src/actions/wallet/updateEntity.ts:26