BitGo JavaScript SDK

The BitGo Platform and SDK makes it easy to build multi-signature crypto-currency applications today with support for Bitcoin, Ethereum and many other coins. The SDK is fully integrated with the BitGo co-signing service for managing all of your BitGo wallets.

Included in the SDK are examples for how to use the API to manage your multi-signature wallets.

Please email us at [email protected] if you have questions or comments about this API.

Please make sure you are running at least Node version 8 (the latest LTS release is recommended) and NPM version 6. We recommend using nvm, the Node Version Manager, for setting your Node version.

npm install bitgo

View our API Documentation.

You can find the complete release notes (since version 4.44.0) here.

Create an access token by logging into your bitgo account, going to the API access tab in the settings area and making a developer token.

const BitGo = require('bitgo');
const bitgo = new BitGo.BitGo({ accessToken: ACCESS_TOKEN }); // defaults to testnet. add env: 'prod' if you want to go against mainnet
bitgo.session({}, function(err,res) {
  console.dir(err);
  console.dir(res);
});

let wallet;
const params = {
  "passphrase": "replaceme",
  "label": "firstwallet"
};
bitgo.coin('tbtc').wallets().generateWallet(params, function(err, result) {
  wallet = result.wallet;
  console.dir(wallet._wallet);
});

wallet.createAddress({ "chain": 10 }, function callback(err, address) {
    console.dir(address);
});

wallet.transfers({}, function callback(err, transfers) {
    console.dir(transfers);
});

wallet.sendCoins({
  address: "2NEe9QhKPB2gnQLB3hffMuDcoFKZFjHYJYx",
  amount: 0.01 * 1e8,
  walletPassphrase:  "replaceme"
}, function(err, result) {
    console.dir(result);
});

Further demos and examples can be found in the example directory and documented here.

Suitable for developers working in a language without an official BitGo SDK.

BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo. This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.

npm explore bitgo -- bin/bitgo-express [-h] [-v] [-p PORT] [-b BIND] [-e ENV] [-d] [-l LOGFILEPATH] [-k KEYPATH] [-c CRTPATH]

Note: When running against the BitGo production environment, you must run node in a production configuration as well. You can do that by running export NODE_ENV=production prior to starting bitgo-express.

For a full tutorial of how to install, authenticate, and use Bitgo Express, see the Bitgo Express Quickstart

For use inside a browser, BitGoJS can be bundled with any module bundler. There is a Webpack configuration file already included, which can be triggered with package scripts.

For a production build: npm run-script compile

For a development (non-minified) build: npm run-script compile-dbg

To build the test suite into a single test file: npm run-script compile-test

To build for specific coins: npm run compile -- --env.coins="eth, btc, ..."