Logo for jsDocs.io

bitgo

  • Version 49.5.0
  • Published
  • 43.4 MB
  • 95 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 getCoinConstructor

      getCoinConstructor: (coinName: string) => CoinConstructor | undefined;

        function getNetwork

        getNetwork: () => any;

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

          Deprecated

        function getNetworkObj

        getNetworkObj: () => utxolib.Network;

        • Deprecated

        function getTokenConstructor

        getTokenConstructor: (tokenConfig: TokenConfig) => CoinConstructor | undefined;

          function registerCoinConstructors

          registerCoinConstructors: (coinFactory: CoinFactory, coinMap?: CoinMap) => void;

            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?: any);

              • Constructor for BitGo Object

              method coin

              coin: (coinName: string) => BaseCoin;

              • Create a basecoin object

                Parameter coinName

              method initCoinFactory

              initCoinFactory: (
                  tokenConfigMap: Record<string, TrimmedAmsTokenConfig[]>
              ) => void;

              • Initialize the coin factory with token configurations

                Parameter tokenConfigMap

                A map of token metadata from AMS

              method registerAllTokens

              registerAllTokens: () => Promise<void>;

              • Fetch all the tokens and initialize the coin factory

              method registerToken

              registerToken: (tokenName: string) => Promise<void>;

              • Register a token in the coin factory

                Parameter tokenConfig

                The token metadata from AMS

              method token

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

              • Create a basecoin object for a virtual token

                Parameter tokenName

              Type Aliases

              type BitGoOptions

              type BitGoOptions = BitGoAPIOptions & {
                  useAms?: boolean;
              };

                Namespaces

                namespace Coin

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

                  variable FiatAED

                  const FiatAED: any;

                    variable FiatEur

                    const FiatEur: any;

                      variable FiatGBP

                      const FiatGBP: any;

                        variable FiatSGD

                        const FiatSGD: any;

                          variable FiatUsd

                          const FiatUsd: any;

                            variable Ofc

                            const Ofc: any;

                              variable OfcToken

                              const OfcToken: any;

                                variable Susd

                                const Susd: any;

                                  variable TfiatAED

                                  const TfiatAED: any;

                                    variable TfiatEur

                                    const TfiatEur: any;

                                      variable TfiatGBP

                                      const TfiatGBP: any;

                                        variable TfiatSGD

                                        const TfiatSGD: any;

                                          variable TfiatUsd

                                          const TfiatUsd: any;

                                            variable Tsusd

                                            const Tsusd: any;

                                              Package Files (4)

                                              Dependencies (95)

                                              Dev Dependencies (20)

                                              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>