Merge pull request #152 from glethuillier/main

Fix Default Provider for Bitcoin

Author: meriadec

Diff for: .github/workflows/regression_tests/check.py

@@ -182,7 +182,13 @@ def run_negative_test(data: dict, provider: str) -> bool:
 def run_tests(product_under_test=None, currency=None, provider=None):
 
     if provider is None:
-        run_tests(product_under_test, currency, "custom")
+        run_tests(
+            product_under_test,
+            currency,
+            "default"
+            if os.environ.get("XPUB_SCAN_CUSTOM_API_KEY_V2") is None
+            else "custom",
+        )
         return
 
     with open(f"{base_path}/datasets.json", "r") as f:
@@ -234,7 +240,10 @@ def run_tests(product_under_test=None, currency=None, provider=None):
             provider = sys.argv[3].lower()
 
             # when testing the default provider, remove the API KEY env var
-            if provider == "default" and os.environ.get("XPUB_SCAN_CUSTOM_API_KEY_V2") is not None:
+            if (
+                provider == "default"
+                and os.environ.get("XPUB_SCAN_CUSTOM_API_KEY_V2") is not None
+            ):
                 del os.environ["XPUB_SCAN_CUSTOM_API_KEY_V2"]
 
         run_tests(product_under_test, currency, provider)

Diff for: .github/workflows/regression_tests_custom.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: Install Xpub Scan dependencies and build it
         run: |
-          yarn && yarn build
+          npm i && npm run build
 
       - name: ${{ matrix.product }} x ${{ matrix.currency }}
         run: |

Diff for: .github/workflows/regression_tests_default.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Install Xpub Scan dependencies and build it
         run: |
-          yarn && yarn build
+          npm i && npm run build
 
       - name: ${{ matrix.product }} x ${{ matrix.currency }}
         run: |

Diff for: .github/workflows/static_analysis.yml

@@ -15,10 +15,10 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Install dependencies
-        run: yarn
+        run: npm i
 
       - name: Generate code coverage
-        run: yarn sonarqube
+        run: npm run sonarqube
 
       - name: SonarCloud Scan
         uses: sonarsource/sonarcloud-github-action@master

Diff for: .github/workflows/unit_tests.yml

@@ -19,7 +19,6 @@ jobs:
       - name: Check dependencies
         run: |
           npm i
-          yarn check --verify-tree
           check-outdated --ignore-packages chalk,jest,bitcoinjs-lib
           npm audit --audit-level=low --json
 
@@ -33,13 +32,13 @@ jobs:
       - uses: actions/cache@v2
         with:
           path: "**/node_modules"
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/npm-shrinkwrap.json') }}
 
       - name: Install dependencies
-        run: yarn
+        run: npm i
 
       - name: Prettify
-        run: yarn prettier
+        run: npm run prettier
 
       - name: Run checks
-        run: yarn ci
+        run: npm run ci

Diff for: .gitignore

@@ -1,6 +1,5 @@
 .env
 node_modules
 lib
-yarn.lock
 package-lock.json
 coverage/

Diff for: .npmignore

@@ -11,4 +11,3 @@ doc
 node_modules
 src
 tsconfig.json
-yarn.lock

Diff for: CONTRIBUTING.md

@@ -62,7 +62,7 @@ XPUB_SCAN_CUSTOM_API_KEY_V2=<your key>
 Your code has to be correctly formatted. To this effect, a set of rules are defined in `.prettierrc.json` and automatically enforced with this command:
 
 ```
-$ yarn prettier
+$ npm run prettier
 ```
 
 ## Add Unit Tests
@@ -77,7 +77,7 @@ The general idea is to progressively reach near 100% coverage.
 
 Once your fix or feature has been implemented, you can locally ensure that the project will pass the tests in the CI.
 
-(Note: you can run all tests at once: `$ yarn dev:test:all`).
+(Note: you can run all tests at once: `$ npm run dev:test:all`).
 
 ## Up-to-date Requirements
 
@@ -86,7 +86,7 @@ For security reasons, the dependencies have to be up-to-date and strictly pinpoi
 To this effect, a dedicated command verifies the dependencies:
 
 ```
-$ yarn check:dep
+$ npm run check:dep
 ```
 
 If this command reveals that dependencies are outdated, update them in `package.json` **using strict versioning**:
@@ -102,7 +102,7 @@ Run `check:dep` again and, if the check passes, run the subsequent tests to ensu
 To run the unit tests, do:
 
 ```
-$ yarn ci
+$ npm run ci
 ```
 
 To generate the coverage (prerequisites: `jest` and `ts-node`, run:
@@ -120,7 +120,7 @@ Regression tests are essential to ensure that the core logic of Xpub Scan is not
 To run the regression tests locally, use the following command:
 
 ```
-$ yarn regression
+$ npm run regression
 ```
 
 (Important: the tests will fail if no CryptoAPIs API v2 key is provided).

Diff for: Dockerfile

@@ -10,7 +10,7 @@ WORKDIR /app
 
 COPY package.json npm-shrinkwrap.json ./
 
-RUN npm i && npm ci
+RUN npm i && npm run ci
 
 COPY . .
 

Diff for: README.md

@@ -23,14 +23,6 @@ Given an extended public key (xpub, Ltub, _etc._), get the balances of its deriv
 
 ## Install
 
-With yarn:
-
-```
-$ yarn global add @ledgerhq/xpub-scan
-```
-
-With npm:
-
 ```
 $ npm i -g @ledgerhq/xpub-scan
 ```
@@ -66,7 +58,7 @@ scanResult("your_xpub");
 Install dependencies:
 
 ```
-$ npm ci
+$ npm run ci
 ```
 
 Build the project
@@ -84,7 +76,7 @@ $ node ./lib/scan.js [options] <xpub>
 _Alternatively, if you want to use the locally-built version of xpub-scan with just `xpub-scan` command, you can:_
 
 ```
-$ yarn link
+$ npm link
 ```
 
 ### Currencies
@@ -207,7 +199,7 @@ The derived addresses are displayed during the analysis. Perfect matches are dis
 ### Change Settings
 
 1. Modify `./src/settings.ts`
-2. rebuild the tool: `$ yarn build`
+2. rebuild the tool: `$ npm run build`
 3. Re-run it: `$ node ./lib/scan.js <xpub> …`
 
 ### Change External Provider
@@ -218,6 +210,6 @@ The derived addresses are displayed during the analysis. Perfect matches are dis
 
 1. At the root of the project, rename `.env.template` to `.env`
 2. In `.env`, set the `XPUB_SCAN_CUSTOM_API_KEY_V2` (corresponding to your Crypto APIs v2 API key—e.g.: `XPUB_SCAN_CUSTOM_API_KEY_V2=abcd6eacca264f7530eb2f7025a84f8`)
-3. rebuild the tool: `$ yarn build`
+3. rebuild the tool: `$ npm run build`
 4. Re-run it: `$ node ./lib/scan.js <xpub> …`
 5. Ensure that, when running the tool, it shows that the _custom_ provider is being used