Class Asset

constructor

• new Asset(amount: number, symbol: AssetSymbol): Asset

  Parameters

  • amount: number
  • symbol: AssetSymbol

  Returns Asset

Readonlyamount

Readonlysymbol

add

• add(amount: string | number | Asset): Asset

  Return a new Asset instance with amount added.

  Parameters

  • amount: string | number | Asset

  Returns Asset

divide

• divide(divisor: string | number | Asset): Asset

  Return a new Asset with the amount divided.

  Parameters

  • divisor: string | number | Asset

  Returns Asset

getPrecision

• getPrecision(): number

  Return asset precision.

  Returns number

multiply

• multiply(factor: string | number | Asset): Asset

  Return a new Asset with the amount multiplied by factor.

  Parameters

  • factor: string | number | Asset

  Returns Asset

steem_symbols

• steem_symbols(): Asset

  returns a representation of this asset using only STEEM SBD for legacy purposes

  Returns Asset

subtract

• subtract(amount: string | number | Asset): Asset

  Return a new Asset instance with amount subtracted.

  Parameters

  • amount: string | number | Asset

  Returns Asset

toJSON

• toJSON(): string

  For JSON serialization, same as toString().

  Returns string

toNai

• toNai(): NaiAsset

  Return this asset in the NAI format used by block_api. The legacy STEEM/SBD and testnet TESTS/TBD symbols map to the HIVE and HBD NAIs.

  Returns NaiAsset

toString

• toString(): string

  Return a string representation of this asset, e.g. 42.000 HIVE.

  Returns string

Staticfrom

• from(value: string | number | Asset | NaiAsset, symbol?: AssetSymbol): Asset

  Convenience to create new Asset.

  Parameters

  • value: string | number | Asset | NaiAsset
  • Optionalsymbol: AssetSymbol

    Symbol to use when created from number. Will also be used to validate the asset, throws if the passed value has a different symbol than this.

  Returns Asset

StaticfromNai

• fromNai(nai: NaiAsset): Asset

  Create a new Asset instance from the NAI format used by block_api, e.g. {nai: '@@000000013', amount: '1000', precision: 3} for 1.000 HBD. Throws if the NAI is unknown, the precision does not match its symbol or the amount is not an integer string.

  Parameters

  • nai: NaiAsset

  Returns Asset

StaticfromString

• fromString(string: string, expectedSymbol?: AssetSymbol): Asset

  Create a new Asset instance from a string, e.g. 42.000 HIVE.

  Parameters

  • string: string
  • OptionalexpectedSymbol: AssetSymbol

  Returns Asset

Staticmax

• max(a: Asset, b: Asset): Asset

  Return the larger of the two assets.

  Parameters

  • a: Asset
  • b: Asset

  Returns Asset

Staticmin

• min(a: Asset, b: Asset): Asset

  Return the smaller of the two assets.

  Parameters

  • a: Asset
  • b: Asset

  Returns Asset