50.5.0 • Published 9 months ago

@bitgo/statics v50.5.0

Weekly downloads
6,539
License
Apache-2.0
Repository
github
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
50.5.0

9 months ago

50.4.0

9 months ago

50.3.0

9 months ago

50.1.0

10 months ago

50.2.0

10 months ago

50.0.0

10 months ago

49.6.0

10 months ago

49.5.0

10 months ago

49.4.0

11 months ago

49.3.0

11 months ago

49.2.0

11 months ago

49.1.0

11 months ago

48.19.0

1 year ago

48.18.0

1 year ago

48.17.0

1 year ago

48.28.0

12 months ago

48.16.0

1 year ago

48.27.0

12 months ago

48.22.0

1 year ago

48.21.0

1 year ago

48.20.0

1 year ago

49.0.0

11 months ago

48.15.0

1 year ago

48.26.0

12 months ago

48.14.0

1 year ago

48.25.0

1 year ago

48.13.0

1 year ago

48.24.0

1 year ago

48.23.0

1 year ago

48.12.0

1 year ago

48.11.0

1 year ago

48.10.0

1 year ago

48.9.0

1 year ago

48.8.1

1 year ago

48.8.0

1 year ago

48.7.0

1 year ago

48.6.0

1 year ago

48.5.0

1 year ago

48.4.0

1 year ago

48.3.0

1 year ago

48.2.0

1 year ago

48.1.0

1 year ago

48.0.0

1 year ago

47.2.0

1 year ago

47.1.0

1 year ago

47.0.0

1 year ago

46.1.0

1 year ago

46.0.0

1 year ago

43.0.0

1 year ago

45.0.0

1 year ago

44.0.0

1 year ago

42.0.0

2 years ago

41.0.0

2 years ago

40.0.0

2 years ago

39.0.0

2 years ago

38.0.0

2 years ago

37.0.0

2 years ago

36.0.0

2 years ago

34.0.0

2 years ago

35.0.0

2 years ago

19.0.0

2 years ago

18.2.0

2 years ago

21.0.0

2 years ago

31.0.0

2 years ago

18.1.0

2 years ago

22.0.0

2 years ago

18.0.0

2 years ago

29.0.0

2 years ago

26.0.0

2 years ago

23.0.0

2 years ago

27.0.0

2 years ago

33.0.0

2 years ago

18.4.0

2 years ago

20.0.0

2 years ago

32.0.0

2 years ago

28.0.0

2 years ago

24.0.0

2 years ago

16.1.0

2 years ago

17.0.1

2 years ago

17.0.0

2 years ago

16.2.0

2 years ago

15.1.1

2 years ago

15.1.2

2 years ago

16.0.0

2 years ago

15.0.0

2 years ago

15.1.0

2 years ago

14.3.0

2 years ago

14.4.0

2 years ago

14.1.0

2 years ago

14.2.0

2 years ago

14.0.0

2 years ago

10.0.0

3 years ago

10.0.1

3 years ago

8.2.0

3 years ago

9.0.0

3 years ago

13.1.0

3 years ago

11.0.0

3 years ago

12.0.0

3 years ago

13.0.0

3 years ago

12.1.0

3 years ago

12.1.1

3 years ago

8.0.0-rc.22

3 years ago

8.0.0-rc.23

3 years ago

8.0.0

3 years ago

8.0.0-rc.17

3 years ago

8.0.0-rc.18

3 years ago

8.0.0-rc.15

3 years ago

8.0.0-rc.16

3 years ago

8.0.0-rc.19

3 years ago

8.0.0-rc.10

3 years ago

8.0.0-rc.13

3 years ago

8.0.0-rc.14

3 years ago

8.0.0-rc.11

3 years ago

8.0.0-rc.12

3 years ago

8.0.0-rc.20

3 years ago

8.0.0-rc.21

3 years ago

8.0.0-rc.8

3 years ago

8.0.0-rc.9

3 years ago

8.0.0-rc.7

3 years ago

6.18.0-rc.18

3 years ago

6.18.0-rc.19

3 years ago

6.18.0-rc.10

3 years ago

6.18.0-rc.11

3 years ago

6.18.0-rc.12

3 years ago

6.18.0-rc.13

3 years ago

6.18.0-rc.14

3 years ago

6.18.0-rc.15

3 years ago

6.18.0-rc.16

3 years ago

6.18.0-rc.17

3 years ago

6.18.0-rc.20

3 years ago

7.1.0-rc.0

3 years ago

6.18.0-rc.21

3 years ago

6.18.0-rc.22

3 years ago

6.18.0-rc.23

3 years ago

6.18.0-rc.24

3 years ago

8.0.0-rc.0

3 years ago

8.0.0-rc.1

3 years ago

8.0.0-rc.2

3 years ago

8.0.0-rc.3

3 years ago

8.0.0-rc.4

3 years ago

8.0.0-rc.5

3 years ago

8.0.0-rc.6

3 years ago

6.18.0-dev.0

3 years ago

6.18.0-rc.9

3 years ago

7.0.0-rc.4

3 years ago

7.0.0-rc.3

3 years ago

7.0.0-rc.0

3 years ago

7.0.0-rc.2

3 years ago

7.0.0-rc.1

3 years ago

7.0.0

3 years ago

7.1.0

3 years ago

6.17.0

3 years ago

6.18.0-rc.7

3 years ago

6.18.0-rc.8

3 years ago

6.18.0-rc.5

3 years ago

6.18.0-rc.6

3 years ago

6.18.0-rc.3

3 years ago

6.18.0-rc.1

3 years ago

6.18.0-rc.2

3 years ago

6.18.0-rc.0

3 years ago

6.17.0-rc.23

3 years ago

6.17.0-rc.24

3 years ago

6.16.1-dev.0

3 years ago

6.16.1-dev.1

3 years ago

6.17.0-rc.9

3 years ago

6.17.0-rc.8

3 years ago

6.17.0-rc.7

3 years ago

6.17.0-rc.6

3 years ago

6.17.0-rc.5

3 years ago

6.17.0-rc.4

3 years ago

6.17.0-rc.10

3 years ago

6.17.0-rc.19

3 years ago

6.17.0-rc.16

3 years ago

6.17.0-rc.15

3 years ago

6.17.0-rc.18

3 years ago

6.17.0-rc.17

3 years ago

6.17.0-rc.12

3 years ago

6.17.0-rc.11

3 years ago

6.17.0-rc.14

3 years ago

6.17.0-rc.13

3 years ago

6.17.0-rc.21

3 years ago

6.17.0-rc.20

3 years ago

6.17.0-rc.22

3 years ago

6.17.0-rc.3

3 years ago

6.17.0-rc.2

3 years ago

6.17.0-rc.1

3 years ago

6.17.0-rc.0

3 years ago

6.16.0

3 years ago

6.16.0-rc.13

3 years ago

6.16.0-rc.12

3 years ago

6.15.1-rc.7

4 years ago

6.15.1-rc.8

4 years ago

6.15.1-rc.5

4 years ago

6.15.1-rc.6

4 years ago

6.16.0-rc.11

3 years ago

6.16.0-rc.10

3 years ago

6.16.0-rc.0

4 years ago

6.16.0-rc.1

4 years ago

6.16.0-rc.2

4 years ago

6.16.0-rc.3

4 years ago

6.16.0-rc.4

4 years ago

6.16.0-rc.5

4 years ago

6.16.0-rc.6

4 years ago

6.16.0-rc.7

4 years ago

6.16.0-rc.8

4 years ago

6.16.0-rc.9

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

6.15.1-rc.0.1

4 years ago

6.15.1-rc.0.0

4 years ago

6.15.0

4 years ago

6.15.1-rc.3

4 years ago

6.15.1-rc.4

4 years ago

6.15.1-rc.1

4 years ago

6.15.1-rc.2

4 years ago

6.15.0-rc.7

4 years ago

6.15.0-rc.6

4 years ago

6.15.0-rc.3

4 years ago

6.15.0-rc.5

4 years ago

6.15.0-rc.4

4 years ago

6.15.0-rc.1

4 years ago

6.15.0-rc.0

4 years ago

6.15.0-rc.2

4 years ago

6.14.0-rc.4

4 years ago

6.14.0-rc.7

4 years ago

6.14.0-rc.5

4 years ago

6.14.0-rc.6

4 years ago

6.14.0

4 years ago

6.14.0-rc.3

4 years ago

6.14.0-rc.1

4 years ago

6.14.0-rc.2

4 years ago

6.13.0

4 years ago

6.14.0-rc.0

4 years ago

6.13.0-rc.11

4 years ago

6.13.0-rc.10

4 years ago

6.13.0-rc.9

4 years ago

6.13.0-rc.8

4 years ago

6.13.0-rc.7

4 years ago

6.13.0-rc.6

4 years ago

6.13.0-rc.4

4 years ago

6.13.0-rc.5

4 years ago

6.13.0-rc.0.1.3

4 years ago

6.13.0-rc.3

4 years ago

6.13.0-rc.0.1.0

4 years ago

6.13.0-rc.1

4 years ago

6.13.0-rc.2

4 years ago

6.13.0-rc.0

4 years ago

6.12.0

4 years ago

6.12.0-rc.4

4 years ago

6.12.0-rc.3

4 years ago

6.12.0-rc.2

4 years ago

6.12.0-rc.0

4 years ago

6.12.0-rc.1

4 years ago

6.11.0-rc.0

4 years ago

6.11.0

4 years ago

6.10.0

4 years ago

6.10.0-rc.2

4 years ago

6.10.0-rc.1

4 years ago

6.10.0-rc.0

4 years ago

6.9.0-rc.1

4 years ago

6.9.0

4 years ago

6.9.0-rc.0

4 years ago

6.8.0-rc.2

4 years ago

6.8.0

4 years ago

6.6.0

4 years ago

6.7.0

4 years ago

6.7.0-rc.0

4 years ago

6.8.0-rc.1

4 years ago

6.8.0-rc.0

4 years ago

6.6.0-rc.1

4 years ago

6.6.0-rc.0

4 years ago

6.5.0

4 years ago

6.4.1-rc.1

4 years ago

6.4.1-rc.0

4 years ago

6.4.0

4 years ago

6.3.1-rc.0

4 years ago

6.3.0-rc.2

4 years ago

6.3.0

4 years ago

6.3.0-rc.1

4 years ago

6.3.0-rc.0

4 years ago

6.2.1-rc.3

4 years ago

6.2.1

4 years ago

6.2.1-rc.2

4 years ago

6.2.1-rc.1

4 years ago

6.2.1-rc.0

4 years ago

6.2.0

4 years ago

6.2.0-rc.1

4 years ago

6.2.0-rc.0

4 years ago

6.1.1-rc.1

5 years ago

6.1.1-rc.0

5 years ago

6.1.0

5 years ago

6.1.0-rc.2

5 years ago

6.1.0-rc.1

5 years ago

6.1.0-rc.0

5 years ago

6.0.0

5 years ago

6.0.0-rc.0

5 years ago

5.4.0-rc.2

5 years ago

5.4.0-rc.1

5 years ago

5.4.0-rc.0

5 years ago

5.3.0

5 years ago

5.3.0-rc.2

5 years ago

5.3.0-rc.1

5 years ago

5.3.0-rc.0

5 years ago

5.2.0

5 years ago

5.1.1-rc.0

5 years ago

5.1.1-hbar.0

5 years ago

5.1.0

5 years ago

5.0.1-rc.5

5 years ago

5.0.1-rc.4

5 years ago

5.0.1-rc.3

5 years ago

5.0.1-rc.2

5 years ago

5.0.1-rc.1

5 years ago

5.0.1-rc.0

5 years ago

5.0.1-alpha.0

5 years ago

5.0.0-rc.4

5 years ago

5.0.0

5 years ago

5.0.0-rc.2

5 years ago

5.0.0-rc.1

5 years ago

5.0.0-rc.0

5 years ago

4.4.0-rc.0

5 years ago

4.3.0

5 years ago

4.3.0-rc.6

5 years ago

4.3.0-rc.5

5 years ago

4.3.0-rc.4

5 years ago

4.3.0-rc.3

5 years ago

4.3.0-rc.2

5 years ago

4.3.0-rc.1

5 years ago

4.3.0-rc.0

5 years ago

4.2.0

5 years ago

4.2.0-rc.0

5 years ago

4.1.0

5 years ago

4.1.0-rc.3

5 years ago

4.1.0-rc.2

5 years ago

4.1.0-rc.1

5 years ago

4.1.0-rc.0

5 years ago

4.0.1

5 years ago

4.0.1-rc.0

5 years ago

4.0.0

5 years ago

4.0.0-rc.1

5 years ago

4.0.0-rc.0

5 years ago

3.5.0

5 years ago

3.5.0-rc.0

5 years ago

3.4.5-alpha.0

5 years ago

3.4.4

5 years ago

3.4.4-rc.0

5 years ago

3.4.3

5 years ago

3.4.2

5 years ago

3.4.2-rc.0

5 years ago

3.4.1

5 years ago

3.4.0

5 years ago

3.4.0-rc.2

5 years ago

3.4.0-rc.1

5 years ago

3.4.0-rc.0

5 years ago

3.3.0

5 years ago

3.3.0-rc.0

5 years ago

3.2.0

5 years ago

3.2.0-rc.0

5 years ago

3.1.1

5 years ago

3.1.1-rc.0

5 years ago

3.1.0

5 years ago

3.1.0-rc.0

6 years ago

3.0.1

6 years ago

3.0.1-rc.0

6 years ago

3.0.0

6 years ago

3.0.0-rc.0

6 years ago

2.8.0

6 years ago

2.8.0-rc.1

6 years ago

2.8.0-rc.0

6 years ago

2.7.0

6 years ago

2.7.0-rc.0

6 years ago

2.6.0

6 years ago

2.6.0-rc.0

6 years ago

2.5.0

6 years ago

2.5.0-rc.0

6 years ago

2.4.2

6 years ago

2.4.1

6 years ago

2.4.0

6 years ago

2.4.0-rc.1

6 years ago

2.4.0-rc.0

6 years ago

2.4.0-alpha.1

6 years ago

2.3.0

6 years ago

2.4.0-alpha.0

6 years ago

2.3.0-rc.0

6 years ago

2.2.0

6 years ago

2.1.0

6 years ago

2.0.0

6 years ago

1.6.1

6 years ago

1.6.1-rc.0

6 years ago

1.6.0

6 years ago

1.5.1

6 years ago

1.5.0

6 years ago

1.4.1

6 years ago

1.4.0

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.0

6 years ago

1.0.0

6 years ago