Options
All
  • Public
  • Public/Protected
  • All
Menu

Module util/functions/format

Variables

Functions

Variables

Const BIP_NOMINATION

BIP_NOMINATION: BN = ...

Number of indivisible units in one BIP. Derived from BIP_NOMINATION_EXP.

Const BIP_NOMINATION_EXP

BIP_NOMINATION_EXP: "18" = 18

Functions

convertBipToPip

  • convertBipToPip(amt?: string | number): string | null

  • Alias to parseBipAmount

    Parameters

    • Optional amt: string | number

    Returns string | null

convertPipToBip

  • convertPipToBip(pipAmt: string | BN, fracDigits?: number): string

  • Alias to formatBipAmount

    Parameters

    • pipAmt: string | BN
    • fracDigits: number = ...

    Returns string

formatBipAmount

  • formatBipAmount(pipAmt: string | BN, fracDigits?: number): string

  • Convert value from PIP units to BIP. 1 BIP is defined by BIP_NOMINATION. Effectively this divides given amount by BIP_NOMINATION.

    Parameters

    • pipAmt: string | BN

      decimal string representing balance in smallest non-divisible PIP units (as specified by BIP_NOMINATION)

    • fracDigits: number = ...

      number of fractional digits to preserve in formatted string. Balance is rounded to match given number of digits.

    Returns string

    Value in human readable BIP units

formatWithCommas

  • formatWithCommas(value: string): string

  • Returns a human-readable value with commas

    Parameters

    • value: string

      A value that may not contain commas

    Returns string

    string A value with commas

parseBipAmount

  • parseBipAmount(amt?: string | number): string | null

  • Convert human readable BIP amount to PIP units. Effectively this multiplies given amount by BIP_NOMINATION.

    Parameters

    • Optional amt: string | number

      decimal string (potentially fractional) denominated in BIP.

    Returns string | null

    The parsed yoctoⓃ https://en.wikipedia.org/wiki/Yocto- amount or null if no amount was passed in

Generated using TypeDoc