btcutil-js - v0.2.0
    Preparing search index...

    Variable amountConst

    amount: {
        format(satoshis: number, unit?: string): Promise<string>;
        fromBTC(btc: number): Promise<number>;
        toBTC(satoshis: number): Promise<number>;
    } = ...

    Bitcoin amount conversions between BTC and satoshis.

    Type Declaration

    • format: function
      • Format a satoshi amount with a unit label. Calls Go: btcutil.Amount.Format() from btcutil.

        Parameters

        • satoshis: number
        • Optionalunit: string

          "BTC", "mBTC", "uBTC", "satoshi", or "sat". Default: "BTC".

        Returns Promise<string>

    • fromBTC: function
      • Convert a BTC value to satoshis. Calls Go: btcutil.NewAmount() from btcutil.

        Parameters

        • btc: number

        Returns Promise<number>

    • toBTC: function
      • Convert satoshis to BTC. Calls Go: btcutil.Amount.ToBTC() from btcutil.

        Parameters

        • satoshis: number

        Returns Promise<number>