@bitgo/statics NPM | npm.io

50.5.0 • Published 9 months ago

Install

Weekly downloads

6,539

License

Apache-2.0

Repository

Last release

9 months ago

Goals

Provide an "encyclopedia" of all relevant constants which are sprinkled throughout the BitGo stack.
Separate static config data from dynamic config data
Strong typing for static config properties, with full type information for configuration items
Ability to export static configuration as JSON for consumption by non-javascript projects

Examples

Get the number of decimal places in a Bitcoin

JavaScript

const { coins } = require('@bitgo/statics');

const btc = coins.get('btc');
console.log(btc.decimalPlaces);

TypeScript

import { coins } from '@bitgo/statics';

const btc = coins.get('btc');
console.log(btc.decimalPlaces);

Get the contract address for the OmiseGo ERC20 Token

JavaScript

const { coins } = require('@bitgo/statics');

const omg = coins.get('omg');
console.log(omg.contractAddress);

TypeScript

import { coins, Erc20Coin } from '@bitgo/statics';

const omg = coins.get('omg');
if (omg instanceof Erc20Coin) {
  console.log(omg.contractAddress);
}

List full names of all defined coins

JavaScript

const { coins } = require('@bitgo/statics');

coins.forEach((coin) => {
  console.log(coin.fullName);
});

TypeScript

import { coins } from '@bitgo/statics';

coins.forEach((coin) => {
  console.log(coin.fullName);
});

Repo Status

UTXO and account base types are defined
Documentation is mostly source code comments and README examples
This library can be depended on, but expect some changes going forward

Project Structure

src/base.ts: Interfaces and enums used by coin implementation classes.
src/coins.ts: Coin definitions.
src/networks.ts: Network interfaces and implementation classes.
src/utxo.ts: Unspent Transaction Output (UTXO) based coin classes and factory function.
src/account.ts: Account-based coin classes and factory methods. Includes ERC20 factory functions.
src/errors.ts: Custom Error classes.

Installation + Building

To install the project locally, run the following steps:

$ # clone the project locally
$ git clone git@github.com:BitGo/statics.git

$ # npm install dependencies (optionally use node >8.6.0)
$ # (optionally) nvm install 8.6.0 -- required to run the linter which is executed pre-commit
$ # (optionally) nvm use 8.6.0
$ npm install

To build the project (from TypeScript to JavaScript):

$ npm run build

This builds the JavaScript and adds it to dist/src/. You will receive compilation errors if you have invalid syntax.

Tests

To run tests:

$ npm run test

@alebusse/account-lib alebusse @everything-registry/sub-chunk-127 @bitgo/sdk-coin-xtz jachaval jichaoli jiclibitgo @bitgo/abstract-cosmos @bitgo/abstract-eth @bitgo/sdk-coin-aca @bitgo/sdk-coin-ada @bitgo/sdk-coin-algo @bitgo/sdk-coin-arbeth @bitgo/sdk-coin-atom @bitgo/sdk-coin-avaxc @bitgo/sdk-coin-avaxp @bitgo/sdk-coin-bera @bitgo/sdk-coin-bld @bitgo/sdk-coin-bsc @bitgo/sdk-coin-celo @bitgo/sdk-coin-core @bitgo/sdk-coin-coreum @bitgo/sdk-coin-cspr @bitgo/sdk-coin-dot @bitgo/account-lib @bitgo/key-card @bitgo/sdk-coin-osmo @bitgo/sdk-coin-polygon @bitgo/sdk-coin-rbtc @bitgo/sdk-coin-rune @bitgo/sdk-coin-sei @bitgo/sdk-coin-sol @bitgo/sdk-coin-stx @bitgo/sdk-coin-sui @bitgo/sdk-coin-tia @bitgo/sdk-coin-ton @bitgo/sdk-coin-trx @bitgo/sdk-coin-xlm @bitgo/sdk-coin-eos @bitgo/sdk-coin-etc @bitgo/sdk-coin-eth @bitgo/sdk-coin-hash @bitgo/sdk-coin-hbar @bitgo/sdk-coin-injective @bitgo/sdk-coin-islm @bitgo/sdk-coin-near @bitgo/sdk-coin-opeth @bitgo/sdk-coin-xrp @bitgo/sdk-coin-ethlike @bitgo/sdk-coin-ethw @bitgo/sdk-unified-wallet @bitgo/utxo-bin @bitgo/sdk-coin-zeta @bitgo/sdk-coin-zketh @bitgo/sdk-core @frausch/account-lib @gibrangul95/account-lib @infinitebrahmanuniverse/nolb-_bit @nbellanich/bitgo @facuintive/account-lib @jachaval/account-lib @jichaoli/account-lib @ryan-bitgo/account-lib @ryan-bitgo/bitgo @rafaeltaranto/bitgo bitg nbellanich nbellanich-1 silalvado @zalastax/nolb-_bit bitgo-ish bitgo frausch-bitgo @sskim18/sdk-coin-avaxp @tatsujoestar/abstract-eth @silalvado/account-lib

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

11 months ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

3 years ago

6.15.1-node12.0

3 years ago

6.15.1-node12.2

3 years ago

6.15.1-node12.1

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

6.15.1-6.15.1-rc.0.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

6.13.0-rc.0.1.3

4 years ago

6.13.0-rc.0.1.4.1

4 years ago

6.12.1-rc.0.0.1.0

4 years ago

4 years ago

6.13.0-rc.0.1.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago