Class AssetParams

AssetParams describes the parameters of an asset.

Implements

Constructors

constructor

Properties

assetName? clawback? decimals defaultFrozen freeze? manager? metadataHash? reserve? total unitName? url? encodingSchema

Methods

getEncodingSchema toEncodingData fromEncodingData

Constructors

constructor

  • new AssetParams(params): AssetParams

  • Parameters

    • params: {
          assetName?: Uint8Array;
          clawback?: Address;
          decimals: number;
          defaultFrozen: boolean;
          freeze?: Address;
          manager?: Address;
          metadataHash?: Uint8Array;
          reserve?: Address;
          total: bigint;
          unitName?: Uint8Array;
          url?: Uint8Array;
      }
      • Optional assetName?: Uint8Array
      • Optional clawback?: Address
      • decimals: number
      • defaultFrozen: boolean
      • Optional freeze?: Address
      • Optional manager?: Address
      • Optional metadataHash?: Uint8Array
      • Optional reserve?: Address
      • total: bigint
      • Optional unitName?: Uint8Array
      • Optional url?: Uint8Array

    Returns AssetParams

Properties

Optional assetName

assetName?: Uint8Array

AssetName specifies a hint for the name of the asset.

Optional clawback

clawback?: Address

Clawback specifies an account that is allowed to take units of this asset from any account.

decimals

decimals: number

Decimals specifies the number of digits to display after the decimal place when displaying this asset. A value of 0 represents an asset that is not divisible, a value of 1 represents an asset divisible into tenths, and so on. This value must be between 0 and 19 (inclusive).

defaultFrozen

defaultFrozen: boolean

DefaultFrozen specifies whether slots for this asset in user accounts are frozen by default or not.

Optional freeze

freeze?: Address

Freeze specifies an account that is allowed to change the frozen state of holdings of this asset.

Optional manager

manager?: Address

Manager specifies an account that is allowed to change the non-zero addresses in this AssetParams.

Optional metadataHash

metadataHash?: Uint8Array

MetadataHash specifies a commitment to some unspecified asset metadata. The format of this metadata is up to the application.

Optional reserve

reserve?: Address

Reserve specifies an account whose holdings of this asset should be reported as "not minted".

total

total: bigint

Total specifies the total number of units of this asset created.

Optional unitName

unitName?: Uint8Array

UnitName specifies a hint for the name of a unit of this asset.

Optional url

url?: Uint8Array

URL specifies a URL where more information about the asset can be retrieved.

Static Readonly encodingSchema

encodingSchema: NamedMapSchema = ...

Methods

getEncodingSchema

toEncodingData

  • toEncodingData(): Map<string, unknown>

  • Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

    Returns Map<string, unknown>

Static fromEncodingData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc