Skip to content

Symbol Docs WIP 🚧

MosaicGlobalRestrictionTransactionV1Descriptor

MosaicGlobalRestrictionTransactionV1Descriptor⚓︎

MosaicGlobalRestrictionTransactionV1Descriptor: Type safe descriptor used to generate a descriptor map for MosaicGlobalRestrictionTransactionV1Descriptor.

Set global rules to transfer a restrictable mosaic (V1, latest).

Constructors ⚓︎

new MosaicGlobalRestrictionTransactionV1Descriptor()⚓︎

new MosaicGlobalRestrictionTransactionV1Descriptor(
   mosaicId, 
   referenceMosaicId, 
   restrictionKey, 
   previousRestrictionValue, 
   newRestrictionValue, 
   previousRestrictionType, 
   newRestrictionType): MosaicGlobalRestrictionTransactionV1Descriptor

Creates a descriptor for MosaicGlobalRestrictionTransactionV1.

Parameters⚓︎

Parameter	Type	Description
`mosaicId`	`UnresolvedMosaicId`	Identifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
`referenceMosaicId`	`UnresolvedMosaicId`	Identifier of the mosaic providing the restriction key. The mosaic global restriction for the mosaic identifier depends on global restrictions set on the reference mosaic. Set `reference_mosaic_id` to 0 if the mosaic giving the restriction equals the `mosaic_id`.
`restrictionKey`	`bigint`	Restriction key relative to the reference mosaic identifier.
`previousRestrictionValue`	`bigint`	Previous restriction value.
`newRestrictionValue`	`bigint`	New restriction value.
`previousRestrictionType`	`MosaicRestrictionType`	Previous restriction type.
`newRestrictionType`	`MosaicRestrictionType`	New restriction type.

Returns⚓︎

MosaicGlobalRestrictionTransactionV1Descriptor

Properties⚓︎

Property	Type
`rawDescriptor`	`object`
`rawDescriptor.mosaicId`	`UnresolvedMosaicId`
`rawDescriptor.newRestrictionType`	`MosaicRestrictionType`
`rawDescriptor.newRestrictionValue`	`bigint`
`rawDescriptor.previousRestrictionType`	`MosaicRestrictionType`
`rawDescriptor.previousRestrictionValue`	`bigint`
`rawDescriptor.referenceMosaicId`	`UnresolvedMosaicId`
`rawDescriptor.restrictionKey`	`bigint`
`rawDescriptor.type`	`string`

Methods⚓︎

toMap()⚓︎

toMap(): object

MosaicGlobalRestrictionTransactionV1Descriptor.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.