diff --git a/modules/bitgo/.mocharc.yml b/modules/bitgo/.mocharc.yml index e45f770826..4d679fec18 100644 --- a/modules/bitgo/.mocharc.yml +++ b/modules/bitgo/.mocharc.yml @@ -4,4 +4,4 @@ reporter: 'min' reporter-option: - 'cdn=true' - 'json=false' -exit: true \ No newline at end of file +exit: true diff --git a/modules/express/EXTERNAL_SIGNER.md b/modules/express/EXTERNAL_SIGNER.md index b3939c073b..654cbb6057 100644 --- a/modules/express/EXTERNAL_SIGNER.md +++ b/modules/express/EXTERNAL_SIGNER.md @@ -30,15 +30,15 @@ The file is located at `src/fetchEncryptedPrivKeys.ts`. Before using this tool, 1. Fill in the `TODOs` by providing a valid `accessToken` as well as the list of `walletIds`, grouped by the cryptocurrency. 2. Using the same information as #1, update the .env file with the `accessToken` and `walletIds` information. -| Name | Value | Description | -| ----------------------------------------- | ------ | ---------------------------------------------- | -| BITGO_EXTERNAL_SIGNER_ENV | string | test | -| BITGO_EXTERNAL_SIGNER_ACCESS_TOKEN | string | Access token used for access BitGo Wallets | -| BITGO_EXTERNAL_SIGNER_WALLET_IDS | string | JSON formatted string of wallets and their | -| | | ids, the secret is optional for unencrypted | -| | | private material | -| BITGO_EXTERNAL_SIGNER_WALLET_IDS_WITH_PRV | string | JSON formatted string of wallets ids and | -| | | their encrypted private keys | +| Name | Value | Description | +| ----------------------------------------- | ------ | ------------------------------------------- | +| BITGO_EXTERNAL_SIGNER_ENV | string | test | +| BITGO_EXTERNAL_SIGNER_ACCESS_TOKEN | string | Access token used for access BitGo Wallets | +| BITGO_EXTERNAL_SIGNER_WALLET_IDS | string | JSON formatted string of wallets and their | +| | | ids, the secret is optional for unencrypted | +| | | private material | +| BITGO_EXTERNAL_SIGNER_WALLET_IDS_WITH_PRV | string | JSON formatted string of wallets ids and | +| | | their encrypted private keys | BITGO_EXTERNAL_SIGNER_WALLET_IDS examples: diff --git a/modules/express/README.md b/modules/express/README.md index aa0f4772a4..a9c9fef10c 100644 --- a/modules/express/README.md +++ b/modules/express/README.md @@ -80,6 +80,7 @@ $ docker run -it --volume /path/to/certs:/private -p 4000:4000 bitgo/express:lat ``` An alternative way to provide the ssl certification is to export them as environment variables. + ```bash $ export BITGO_SSL_KEY=$(cat /private/cert.key) $ export BITGO_SSL_CERT=$(cat /private/cert.cert) @@ -217,10 +218,10 @@ BitGo Express is able to take configuration options from either command line arg | -t | --timeout | `BITGO_TIMEOUT` | 305000 | Number of milliseconds to wait before requests made by `bitgo-express` time out. | | -d | --debug | N/A, use `BITGO_DEBUG_NAMESPACE` instead | N/A | Enable debug output for bitgo-express. This is equivalent to passing `--debugnamespace bitgo:express`. | | -D | --debugnamespace | `BITGO_DEBUG_NAMESPACE` | N/A | Enable debug output for a particular debug namespace. Multiple debug namespaces can be given as a comma separated list. See the [`bitgo` package README](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/README.md#available-debug-namespaces) for a complete list of recognized options, in addition to those listed in the table below. | -| -k | --keypath | `BITGO_KEYPATH` | N/A | Path to SSL .key file (either `keypath` or `sslkey` required if running against production environment). | -| N/A | --sslkey | `BITGO_SSL_KEY` | N/A | The SSL key (either `keypath` or `sslkey` required if running against production environment). | +| -k | --keypath | `BITGO_KEYPATH` | N/A | Path to SSL .key file (either `keypath` or `sslkey` required if running against production environment). | +| N/A | --sslkey | `BITGO_SSL_KEY` | N/A | The SSL key (either `keypath` or `sslkey` required if running against production environment). | | -c | --crtpath | `BITGO_CRTPATH` | N/A | Path to SSL .crt file (required if running against production environment). | -| N/A | --sslcert | `BITGO_SSL_CERT` | N/A | The SSL cert (either `crtpath` or `sslcert` required if running against production environment). | +| N/A | --sslcert | `BITGO_SSL_CERT` | N/A | The SSL cert (either `crtpath` or `sslcert` required if running against production environment). | | -u | --customrooturi | `BITGO_CUSTOM_ROOT_URI` | N/A | Force a custom BitGo URI. | | -n | --custombitcoinnetwork | `BITGO_CUSTOM_BITCOIN_NETWORK` | N/A | Force a custom BitGo network | | -l | --logfile | `BITGO_LOGFILE` | N/A | Filepath to write access logs. | diff --git a/modules/express/bin/bitgo-express b/modules/express/bin/bitgo-express index 1954fd323b..1598a57a4c 100755 --- a/modules/express/bin/bitgo-express +++ b/modules/express/bin/bitgo-express @@ -11,8 +11,7 @@ process.on('unhandledRejection', (reason, promise) => { const { init } = require('../dist/src/expressApp'); if (require.main === module) { - init() - .catch(err => { + init().catch((err) => { console.log(`Fatal error: ${err.message}`); console.log(err.stack); }); diff --git a/modules/unspents/docs/input-costs.md b/modules/unspents/docs/input-costs.md index 2dfb6af9f8..a0f3838888 100644 --- a/modules/unspents/docs/input-costs.md +++ b/modules/unspents/docs/input-costs.md @@ -1,13 +1,14 @@ # Input Costs + This document contains the worst-case input costs for various script types and spend types. The input costs are calculated using the `Dimensions` class from `@bitgo/unspents`. -| Script Type | Chain Codes | Spend Type | Input Size (Virtual Bytes) | Relative Size (p2trMusig2 = 1.00) | -| --- | --- | --- | --- | --- | -| p2sh | 0/1 | all | 298 | 5.14 | -| p2shP2wsh | 10/11 | all | 140 | 2.41 | -| p2wsh | 20/21 | all | 105 | 1.81 | -| p2tr | 30/31 | Script Path, Level 2 (Backup/User, Backup/BitGo) | 116 | 2.00 | -| p2tr | 30/31 | Script Path, Level 1 (User/BitGo) | 108 | 1.86 | -| p2trMusig2 | 40/41 | Script Path (Backup/User, Backup/BitGo) | 108 | 1.86 | -| p2trMusig2 | 40/41 | Key Path (User/BitGo) | 58 | 1.00 | \ No newline at end of file +| Script Type | Chain Codes | Spend Type | Input Size (Virtual Bytes) | Relative Size (p2trMusig2 = 1.00) | +| ----------- | ----------- | ------------------------------------------------ | -------------------------- | --------------------------------- | +| p2sh | 0/1 | all | 298 | 5.14 | +| p2shP2wsh | 10/11 | all | 140 | 2.41 | +| p2wsh | 20/21 | all | 105 | 1.81 | +| p2tr | 30/31 | Script Path, Level 2 (Backup/User, Backup/BitGo) | 116 | 2.00 | +| p2tr | 30/31 | Script Path, Level 1 (User/BitGo) | 108 | 1.86 | +| p2trMusig2 | 40/41 | Script Path (Backup/User, Backup/BitGo) | 108 | 1.86 | +| p2trMusig2 | 40/41 | Key Path (User/BitGo) | 58 | 1.00 | diff --git a/modules/utxo-bin/README.md b/modules/utxo-bin/README.md index 01d36b8a7c..fbb4257aad 100644 --- a/modules/utxo-bin/README.md +++ b/modules/utxo-bin/README.md @@ -3,7 +3,6 @@ This repository contains a CLI tool for parsing BitGo wallet transactions (withdrawals) and formatting them for terminal output. - # Installation ## npm @@ -75,9 +74,9 @@ utxo-bin -n bitcoin parseTx \ Supported transactions formats are -* full-signed transactions -* half-signed transactions in proprietary bitcoinjs-lib format ("legacy") -* half-signed transactions in PSBT/BIP174 format +- full-signed transactions +- half-signed transactions in proprietary bitcoinjs-lib format ("legacy") +- half-signed transactions in PSBT/BIP174 format Supported encodings are hex and base64. @@ -94,6 +93,7 @@ utxo-bin -n bitcoin parseAddress 3QJmV3qfvL9SuYo34YihAf3sRCW3qSinyC --convert ``` ## Generate addresses + ``` utxo-bin generateAddresses \ --userKey xpub661MyMwAqRbcEvoSo4qrsT5xhByHzUoBjm88hdCPohF1rdQ4TkntuHfccN2N7FbmAmBgmaBxD7VY1QZ43YfgGRLBL37BBkBhYbezgnsPRVP \ diff --git a/modules/web-demo/cypress/support/component-index.html b/modules/web-demo/cypress/support/component-index.html index ac6e79fd83..e39ba42969 100644 --- a/modules/web-demo/cypress/support/component-index.html +++ b/modules/web-demo/cypress/support/component-index.html @@ -1,12 +1,12 @@ - - - + + + Components App
- \ No newline at end of file +