Options
All
  • Public
  • Public/Protected
  • All
Menu

Mosaic flags model

Hierarchy

  • MosaicFlags

Index

Constructors

constructor

Properties

restrictable

restrictable: boolean

Not all the mosaics of a given network will be subject to mosaic restrictions. The feature will only affect those to which the issuer adds the "restrictable" property explicitly at the moment of its creation. This property appears disabled by default, as it is undesirable for autonomous tokens like the public network currency.

supplyMutable

supplyMutable: boolean

The creator can choose between a definition that allows a mosaic supply change at a later point or an immutable supply. Allowed values for the property are "true" and "false". The default value is "false".

transferable

transferable: boolean

The creator can choose if the mosaic definition should allow for transfers of the mosaic among accounts other than the creator. If the property 'transferable' is set to "false", only transfer transactions having the creator as sender or as recipient can transfer mosaics of that type. If set to "true" the mosaics can be transferred to and from arbitrary accounts. Allowed values for the property are thus "true" and "false". The default value is "true".

Methods

getValue

  • getValue(): number

toDTO

  • toDTO(): { flags: number }

Static create

  • create(supplyMutable: boolean, transferable: boolean, restrictable?: boolean): MosaicFlags
  • Static constructor function with default parameters

    Parameters

    • supplyMutable: boolean
    • transferable: boolean
    • Default value restrictable: boolean = false

    Returns MosaicFlags

Generated using TypeDoc