Logo for jsDocs.io

bitgo

  • Version 24.0.0
  • Published
  • 33.2 MB
  • 70 dependencies
  • Apache-2.0 license

Install

npm i bitgo
yarn add bitgo
pnpm add bitgo

Overview

BitGo JavaScript SDK

Index

Variables

Functions

Classes

Type Aliases

Namespaces

Variables

variable Environments

const Environments: common.Environments;

    variable GlobalCoinFactory

    const GlobalCoinFactory: CoinFactory;

      variable sjcl

      const sjcl: any;

      • Deprecated

      Functions

      function getNetwork

      getNetwork: () => any;

      • Get the network. Returns either "bitcoin" or "testnet".

        Deprecated

      function getNetworkObj

      getNetworkObj: () => utxolib.Network;

      • Deprecated

      function setNetwork

      setNetwork: (network: any) => void;

      • Set the network, i.e. either "bitcoin" for production with real bitcoin, or "testnet" for development with testnet bitcoin.

        Deprecated

      Classes

      class BitGo

      class BitGo extends BitGoAPI {}

        constructor

        constructor(params?: BitGoAPIOptions);

        • Constructor for BitGo Object

        method coin

        coin: (coinName: string) => BaseCoin;

        • Create a basecoin object

          Parameter coinName

        method token

        token: (tokenName: string) => Promise<BaseCoin>;

        • Create a basecoin object for a virtual token

          Parameter tokenName

        Type Aliases

        type BitGoOptions

        type BitGoOptions = BitGoAPIOptions;

          Namespaces

          namespace Coin

          module 'dist/types/src/v2/coins/index.d.ts' {}

            variable FiatEur

            const FiatEur: any;

              variable FiatGBP

              const FiatGBP: any;

                variable FiatUsd

                const FiatUsd: any;

                  variable Ofc

                  const Ofc: any;

                    variable OfcToken

                    const OfcToken: any;

                      variable Susd

                      const Susd: any;

                        variable TfiatEur

                        const TfiatEur: any;

                          variable TfiatGBP

                          const TfiatGBP: any;

                            variable TfiatUsd

                            const TfiatUsd: any;

                              variable Tsusd

                              const Tsusd: any;

                                Package Files (4)

                                Dependencies (70)

                                Dev Dependencies (17)

                                Peer Dependencies (0)

                                No peer dependencies.

                                Badge

                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/bitgo.

                                • Markdown
                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/bitgo)
                                • HTML
                                  <a href="https://www.jsdocs.io/package/bitgo"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>