@bitgo/statics 6.15.1-rc.7 → 6.16.0-rc.10

package/.prettierignore

@@ -0,0 +1,3 @@
+.nyc_output/
+dist/
+mochawesome-report/

package/README.md

@@ -6,16 +6,18 @@
 </h3>
 
 ## 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
+
+- 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
+#### JavaScript
+
 ```js
 const { coins } = require('@bitgo/statics');
 
@@ -23,7 +25,8 @@ const btc = coins.get('btc');
 console.log(btc.decimalPlaces);
 ```
 
-#### Typescript
+#### TypeScript
+
 ```typescript
 import { coins } from '@bitgo/statics';
 
@@ -33,7 +36,8 @@ console.log(btc.decimalPlaces);
 
 ### Get the contract address for the OmiseGo ERC20 Token
 
-#### Javascript
+#### JavaScript
+
 ```js
 const { coins } = require('@bitgo/statics');
 
@@ -41,7 +45,8 @@ const omg = coins.get('omg');
 console.log(omg.contractAddress);
 ```
 
-#### Typescript
+#### TypeScript
+
 ```typescript
 import { coins, Erc20Coin } from '@bitgo/statics';
 
@@ -53,7 +58,8 @@ if (omg instanceof Erc20Coin) {
 
 ### List full names of all defined coins
 
-#### Javascript
+#### JavaScript
+
 ```js
 const { coins } = require('@bitgo/statics');
 
@@ -62,7 +68,8 @@ coins.forEach((coin) => {
 });
 ```
 
-#### Typescript
+#### TypeScript
+
 ```typescript
 import { coins } from '@bitgo/statics';
 
@@ -72,19 +79,22 @@ coins.forEach((coin) => {
 ```
 
 ## 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
+
+- 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.
+
+- `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:
 
 ```
@@ -97,14 +107,13 @@ $ # (optionally) nvm use 8.6.0
 $ npm install
 ```
 
-To build the project (from TypeScript to Javascript):
+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.
-
+This builds the JavaScript and adds it to `dist/src/`. You will receive compilation errors if you have invalid syntax.
 
 ## Tests