MosaicMetadataTransactionV1Descriptor

MosaicMetadataTransactionV1Descriptor

Type safe descriptor used to generate a descriptor map for MosaicMetadataTransactionV1Descriptor.

Associate a key-value state (metadata) to a mosaic (V1, latest). Compare to AccountMetadataTransaction and NamespaceMetadataTransaction.

Constructors

new MosaicMetadataTransactionV1Descriptor()

new MosaicMetadataTransactionV1Descriptor(
   targetAddress, 
   scopedMetadataKey, 
   targetMosaicId, 
   valueSizeDelta, 
   value?): MosaicMetadataTransactionV1Descriptor

Creates a descriptor for MosaicMetadataTransactionV1.

Parameters

Parameter	Type	Description
targetAddress	Address	Account owning the mosaic whose metadata should be modified.
scopedMetadataKey	bigint	Metadata key scoped to source, target and type.
targetMosaicId	UnresolvedMosaicId	Mosaic whose metadata should be modified.
valueSizeDelta	number	Change in value size in bytes, compared to previous size.
value?	string | Uint8Array<ArrayBufferLike>	Difference between existing value and new value. \note When there is no existing value, this array is directly used and value_size_delta==value_size. \note When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.

Returns

MosaicMetadataTransactionV1Descriptor

Properties

Property	Type
rawDescriptor	object
rawDescriptor.scopedMetadataKey	bigint
rawDescriptor.targetAddress	Address
rawDescriptor.targetMosaicId	UnresolvedMosaicId
rawDescriptor.type	string
rawDescriptor.valueSizeDelta	number

Methods

toMap()

toMap(): object

MosaicMetadataTransactionV1Descriptor.toMap

Builds a representation of this descriptor that can be passed to a factory function.

Returns

object

Descriptor that can be passed to a factory function.