Skip to content
BitGo JavaScript SDK
Branch: master
Clone or download
paddyquinn Merge pull request #268 from BitGo/BG-11323-generateAddress
BG-11323: Deprecate conflicting params in generateAddress
Latest commit d16517c Mar 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
example BG-7743: added get max spendable example usage file Oct 1, 2018
src Deprecate conflicting params in generateAddress Mar 21, 2019
test
.arcconfig
.arclint
.codecov.yml BG-9424: Update travis config to ensure test parity with jenkins Dec 17, 2018
.dockerignore docker deployment files Apr 28, 2017
.drone.jsonnet
.drone.yml BRE-380: Configure drone and disable travis Mar 20, 2019
.eslintignore
.eslintrc.json
.gitignore BG-6806: Add and configure codecov support Sep 13, 2018
.karma.conf.js
.npmignore add npm ignore file and up package version Dec 21, 2017
.nvmrc Add `.nvmrc` with `lts/carbon` Feb 25, 2019
.travis.yml BRE-380: Configure drone and disable travis Mar 20, 2019
CODEOWNERS BG-11216: Update CODEOWNERS file Mar 18, 2019
Dockerfile
Dockerrun.aws.json
LICENSE
README.md
RELEASE_NOTES.md BG-11111: Add release notes for releases 4.48.0 and 4.48.1 Mar 18, 2019
TODO
package-lock.json Deprecate conflicting params in generateAddress Mar 21, 2019
package.json
webpack.config.js

README.md

BitGoJS

BitGo JavaScript SDK

The BitGo Platform and SDK makes it easy to build multi-signature Bitcoin applications today. 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 join us on our Slack channel if you have questions or comments about this API.

Known Vulnerabilities Build Status

Installation

Please make sure you are running at least Node version 6 (6.12.3 recommended) and NPM version 3 (3.10.10 recommended). We recommend using nvm, the Node Version Manager, for setting your Node version.

git clone https://github.com/BitGo/BitGoJS

cd BitGoJS

npm install

Full Documentation

View our Javascript SDK Documentation.

Example Usage

Initialize SDK

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);
});

Create Wallet

let wallet;
const params = { 
  "passphrase": "replaceme", 
  "label": "firstwallet"
};
bitgo.wallets().createWalletWithKeychains(params, function(err, result) {
  wallet = result.wallet; 
  console.dir(wallet.wallet);
  console.log("Locally created keychain: " + result.userKeychain.encryptedXprv);
});

Create new address

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

View transactions

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

Send coins

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

More examples

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

BitGo Express Local Signing Server (REST API)

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.

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

Usage in Browser

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, ..."

You can’t perform that action at this time.