Merge pull request #26 from EresDevOrg/development

.github/workflows/jest-testing.yml

@@ -28,9 +28,6 @@ jobs:
       - name: Install dependencies
         run: yarn install
 
-      - name: Setup tests
-        run: yarn pretest
-
       - name: Build & Run test suite
         run: |
           yarn test | tee ./coverage.txt && exit ${PIPESTATUS[0]}

README.md

@@ -9,7 +9,7 @@ This packages leverages [Chainlist's](https://github.com/DefiLlama/chainlist) ne
 - Can re-test the cached RPCs by calling `handler.getFastestRpcProvider()`
 - Can be used in both the browser and Node.js
 - Fully configurable and extendable
-- Only uses endpoints which Chainlist report as tracking _no_ data (see [`extraRpcs.js`](https://github.com/DefiLlama/chainlist/blob/main/constants/extraRpcs.js))
+- Uses endpoints from Chainlist (see [`extraRpcs.js`](https://github.com/DefiLlama/chainlist/blob/main/constants/extraRpcs.js))
 
 ## Installation
 
@@ -33,6 +33,7 @@ export function useHandler(networkId: number) {
     networkName: null, // the name will be deduced from the networkId, unless using a custom network
     networkRpcs: null, // same as networkName, but for injecting additional RPCs
     runtimeRpcs: null, // same as networkRpcs, although these are considered error-free
+    tracking: "yes", // accepted values: "yes" | "limited" | "none"
   };
   // No RPCs are tested at this point
   return new RPCHandler(config);
@@ -51,7 +52,7 @@ app.provider = await handler.getFastestRpcProvider();
 
 - The RPCs are not tested on instantiation, but are tested on each call to `handler.getFastestRpcProvider()` or `handler.testRpcPerformance()`
 
-- See the full [config](src\handler.ts) object (optionally passed in the constructor) for more options
+- See the full [config](types/handler.ts) object (optionally passed in the constructor) for more options
 
 - Local storage is not enabled by default, but can be enabled by passing `autoStorage: true` in the config object
 

build/dynamic-types.ts

@@ -35,8 +35,7 @@ export async function createDynamicTypes() {
     }
 
     if (rpc && rpc.length > 0) {
-      const rpcs = rpc.filter((rpc: { url: string }) => rpc.url);
-      extraRpcs[chainId] = rpcs.map((rpc: { url: string }) => rpc.url);
+      extraRpcs[chainId] = rpc;
     }
 
     idToNativeCurrency[chainId] = nativeCurrency;

package.json

@@ -24,9 +24,7 @@
     "postinstall": "git submodule update --init --recursive",
     "build": "run-s clean build:types",
     "build:types": "tsx build/esbuild-build.ts && tsc --emitDeclarationOnly --declaration --outDir dist",
-    "build:tests": "tsx build/esbuild-build-tests.ts && tsc --emitDeclarationOnly --declaration --project tsconfig.tests.json",
     "postbuild": "rm -rf dist/src",
-    "pretest": "run-s clean build:tests",
     "test": "jest",
     "clean": "rm -rf dist"
   },
@@ -89,4 +87,4 @@
     ]
   },
   "packageManager": "yarn@4.2.2"
-}
+}

tests/benchmark.test.ts

@@ -1,5 +1,6 @@
 import { JsonRpcProvider } from "@ethersproject/providers";
-import { RPCHandler, HandlerConstructorConfig } from "../dist";
+import { RPCHandler } from "../types/rpc-handler";
+import { HandlerConstructorConfig } from "../types/handler";
 
 export const testConfig: HandlerConstructorConfig = {
   networkId: "1",
@@ -9,6 +10,7 @@ export const testConfig: HandlerConstructorConfig = {
   networkRpcs: null,
   rpcTimeout: 1500,
   runtimeRpcs: null,
+  tracking: "yes",
 };
 
 describe("RPCHandler", () => {

tests/env.test.ts

@@ -1,4 +1,4 @@
-import { RPCHandler } from "../dist";
+import { RPCHandler } from "../types/rpc-handler";
 import { testConfig } from "./rpc-handler.test";
 
 describe("Browser env detection", () => {