Merge pull request #28 from Keyrxng/improved-constants

Author: 0x4007

.cspell.json

@@ -1,12 +1,12 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "lib", "dist"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "lib", "dist", "types/dynamic.ts"],
   "useGitignore": true,
   "language": "en",
   "words": ["dataurl", "devpool", "outdir", "servedir"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"],
-  "ignoreWords": ["Rpcs", "ethersproject", "publicnode", "WXDAI", "XDAI", "chainlist", "Knip", "LOCALSTORAGE"]
+  "ignoreWords": ["Rpcs", "ethersproject", "publicnode", "WXDAI", "XDAI", "chainlist", "Knip", "LOCALSTORAGE", "sonarjs", "cronos", "Cronos", "gochain"]
 }

.github/workflows/jest-testing.yml

@@ -28,10 +28,13 @@ 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]}
-          
+
       - name: Jest Coverage Comment
         # Ensures this step is run even on previous step failure (e.g. test failed)
         if: always()

README.md

@@ -67,6 +67,7 @@ yarn test
 ```
 
 - This below will only work after `yarn build` has been run and will fail under test conditions
+
 ```bash
 npx tsx tests/script-test.ts
-```
+```

build/dynamic-types.ts

@@ -0,0 +1,56 @@
+import { appendFile, writeFile } from "fs/promises";
+import { BlockExplorer, NativeToken } from "../types/handler";
+import { generateChainData } from "../lib/chainlist/utils/fetch";
+
+/**
+ * This produces dynamic types and constants for:
+ * - CHAINS_IDS
+ * - NETWORKS
+ * - NETWORK_FAUCETS
+ * - NETWORK_EXPLORERS
+ * - NETWORK_CURRENCIES
+ * - EXTRA_RPCS
+ */
+
+export async function createDynamicTypes() {
+  const data = await generateChainData();
+  const idToNetwork: Record<string, string> = {};
+  const networkToId: Record<string, number> = {};
+  const idToRpc: Record<string, string[]> = {};
+  const idToFaucet: Record<string, string[]> = {};
+  const idToExplorers = {} as Record<string, BlockExplorer[]>;
+  const idToNativeCurrency: Record<string, NativeToken> = {};
+  const extraRpcs: Record<string, string[]> = {};
+
+  for (const chain of data) {
+    let { name, chainId, networkId, rpc, faucets, explorers, nativeCurrency } = chain;
+    name = name.toLowerCase().replace(/\s/g, "-");
+    idToNetwork[chainId] = name;
+    networkToId[name] = networkId;
+    idToRpc[chainId] = rpc;
+    idToFaucet[chainId] = faucets;
+
+    if (explorers && explorers.length > 0) {
+      idToExplorers[chainId] = explorers;
+    }
+
+    if (rpc && rpc.length > 0) {
+      const rpcs = rpc.filter((rpc: { url: string }) => rpc.url);
+      extraRpcs[chainId] = rpcs.map((rpc: { url: string }) => rpc.url);
+    }
+
+    idToNativeCurrency[chainId] = nativeCurrency;
+  }
+
+  const filename = "types/dynamic.ts";
+
+  // Clear the file
+  await writeFile(filename, "/* eslint-disable sonarjs/no-duplicate-string */\n\n");
+
+  appendFile(filename, `\nexport const CHAINS_IDS = ${JSON.stringify(idToNetwork, null, 2)} as const;\n`);
+  appendFile(filename, `\nexport const NETWORKS = ${JSON.stringify(networkToId, null, 2)} as const;\n`);
+  appendFile(filename, `\nexport const NETWORK_FAUCETS = ${JSON.stringify(idToFaucet, null, 2)};\n`);
+  appendFile(filename, `\nexport const NETWORK_EXPLORERS = ${JSON.stringify(idToExplorers, null, 2)};\n`);
+  appendFile(filename, `\nexport const NETWORK_CURRENCIES = ${JSON.stringify(idToNativeCurrency, null, 2)};\n`);
+  appendFile(filename, `\nexport const EXTRA_RPCS = ${JSON.stringify(extraRpcs, null, 2)};\n`);
+}

build/esbuild-build-tests.ts

@@ -1,27 +1,15 @@
 import esbuild from "esbuild";
-import chainlist from "../lib/chainlist/constants/extraRpcs";
-import chainIDList from "../lib/chainlist/constants/chainIds.json";
 import path from "path";
 import * as fs from "fs";
+import { createDynamicTypes } from "./dynamic-types";
 
 const typescriptEntries = ["tests/mocks/rpc-service.ts", "tests/mocks/rpc-handler.ts", "tests/mocks/handler.ts"];
 export const entries = [...typescriptEntries];
-const extraRpcs: Record<string, string[]> = {};
-// this flattens all the rpcs into a single object, with key names that match the networkIds. The arrays are just of URLs per network ID.
-
-Object.keys(chainlist).forEach((networkId) => {
-  const officialUrls = chainlist[networkId].rpcs.filter((rpc) => typeof rpc === "string");
-  const extraUrls: string[] = chainlist[networkId].rpcs.filter((rpc) => rpc.url !== undefined && rpc.tracking === "none").map((rpc) => rpc.url);
-
-  extraRpcs[networkId] = [...officialUrls, ...extraUrls].filter((rpc) => rpc.startsWith("https://"));
-});
 
 export const esBuildContext: esbuild.BuildOptions = {
   entryPoints: entries,
   bundle: true,
-
   outdir: "dist",
-  define: createEnvDefines({ extraRpcs, chainIDList }),
 };
 
 async function main() {
@@ -34,8 +22,6 @@ async function main() {
   }
 }
 
-main();
-
 async function buildForEnvironments() {
   ensureDistDir();
 
@@ -62,25 +48,16 @@ async function buildIndex() {
     bundle: true,
     format: "cjs",
     outfile: "dist/index.js",
-    define: createEnvDefines({ extraRpcs, chainIDList }),
   });
 
   console.log("Index build complete.");
 }
 
-function createEnvDefines(generatedAtBuild: Record<string, unknown>): Record<string, string> {
-  const defines: Record<string, string> = {};
-
-  Object.keys(generatedAtBuild).forEach((key) => {
-    defines[key] = JSON.stringify(generatedAtBuild[key]);
-  });
-
-  return defines;
-}
-
 function ensureDistDir() {
   const distPath = path.resolve(__dirname, "dist");
   if (!fs.existsSync(distPath)) {
     fs.mkdirSync(distPath, { recursive: true });
   }
 }
+
+createDynamicTypes().then(main).catch(console.error);

build/esbuild-build.ts

@@ -1,26 +1,15 @@
 import esbuild from "esbuild";
-import chainlist from "../lib/chainlist/constants/extraRpcs";
-import chainIDList from "../lib/chainlist/constants/chainIds.json";
 import path from "path";
 import * as fs from "fs";
+import { createDynamicTypes } from "./dynamic-types";
 
 const typescriptEntries = ["index.ts"];
 export const entries = [...typescriptEntries];
-const extraRpcs: Record<string, string[]> = {};
-
-// this flattens all the rpcs into a single object, with key names that match the networkIds. The arrays are just of URLs per network ID.
-Object.keys(chainlist).forEach((networkId) => {
-  const officialUrls = chainlist[networkId].rpcs.filter((rpc) => typeof rpc === "string");
-  const extraUrls: string[] = chainlist[networkId].rpcs.filter((rpc) => rpc.url !== undefined && rpc.tracking === "none").map((rpc) => rpc.url);
-  extraRpcs[networkId] = [...officialUrls, ...extraUrls].filter((rpc) => rpc.startsWith("https://"));
-});
 
 export const esBuildContext: esbuild.BuildOptions = {
   entryPoints: entries,
   bundle: true,
-
   outdir: "dist",
-  define: createEnvDefines({ extraRpcs, chainIDList }),
 };
 
 async function main() {
@@ -33,8 +22,6 @@ async function main() {
   }
 }
 
-main();
-
 async function buildForEnvironments() {
   ensureDistDir();
 
@@ -76,24 +63,16 @@ async function buildIndex() {
     bundle: true,
     format: "cjs",
     outfile: "dist/index.js",
-    define: createEnvDefines({ extraRpcs, chainIDList }),
   });
 
   console.log("Index build complete.");
 }
 
-function createEnvDefines(generatedAtBuild: Record<string, unknown>): Record<string, string> {
-  const defines: Record<string, string> = {};
-  Object.keys(generatedAtBuild).forEach((key) => {
-    defines[key] = JSON.stringify(generatedAtBuild[key]);
-  });
-
-  return defines;
-}
-
 function ensureDistDir() {
   const distPath = path.resolve(__dirname, "dist");
   if (!fs.existsSync(distPath)) {
     fs.mkdirSync(distPath, { recursive: true });
   }
 }
+
+createDynamicTypes().then(main).catch(console.error);

index.ts

@@ -12,25 +12,20 @@ export default async function getRPCHandler() {
 }
 
 import {
-  ChainId,
-  ChainNames,
+  NetworkId,
+  NetworkName,
   HandlerConstructorConfig,
   HandlerInterface,
   NativeToken,
   NetworkCurrencies,
   NetworkExplorers,
-  NetworkIds,
-  NetworkNames,
   NetworkRPCs,
   Token,
-  Tokens,
   ValidBlockData,
 } from "./types/handler";
 
 import {
   LOCAL_HOST,
-  chainIDList,
-  extraRpcs,
   getNetworkName,
   networkCurrencies,
   networkExplorers,
@@ -39,39 +34,23 @@ import {
   networkRpcs,
   nftAddress,
   permit2Address,
-  tokens,
+  getNetworkId,
 } from "./types/constants";
 
 import { RPCHandler } from "./types/rpc-handler";
 
-export {
-  LOCAL_HOST,
-  chainIDList,
-  extraRpcs,
-  getNetworkName,
-  networkCurrencies,
-  networkExplorers,
-  networkIds,
-  networkNames,
-  networkRpcs,
-  nftAddress,
-  permit2Address,
-  tokens,
-};
+export { LOCAL_HOST, getNetworkName, getNetworkId, networkCurrencies, networkExplorers, networkIds, networkNames, networkRpcs, nftAddress, permit2Address };
 
 export type {
-  ChainId,
-  ChainNames,
+  NetworkId,
+  NetworkName,
   HandlerConstructorConfig,
   HandlerInterface,
   NativeToken,
   NetworkCurrencies,
   NetworkExplorers,
-  NetworkIds,
-  NetworkNames,
   NetworkRPCs,
   Token,
-  Tokens,
   ValidBlockData,
 };
 export { RPCHandler };

package.json

@@ -14,19 +14,21 @@
     "node": ">=20.10.0"
   },
   "scripts": {
-    "format": "run-s format:lint format:prettier format:cspell",
+    "format": "run-p format:*",
     "format:lint": "eslint --fix .",
     "format:prettier": "prettier --write .",
     "format:cspell": "cspell **/*",
     "knip": "knip",
     "knip-ci": "knip --no-exit-code --reporter json",
     "prepare": "husky install",
-    "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist && rm -rf dist/src",
-    "build:tests": "tsx build/esbuild-build-tests.ts && tsc --emitDeclarationOnly --declaration --project tsconfig.tests.json",
-    "build": "rm -rf dist && tsx build/esbuild-build.ts",
-    "postbuild": "yarn build:types",
     "postinstall": "git submodule update --init --recursive",
-    "test": "rm -rf dist && yarn build:tests && jest"
+    "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"
   },
   "keywords": [
     "typescript",
@@ -87,4 +89,4 @@
     ]
   },
   "packageManager": "yarn@4.2.2"
-}
+}

src/services/rpc-service.ts

@@ -1,10 +1,10 @@
-import { ValidBlockData } from "../../types/handler";
+import { NetworkId, ValidBlockData } from "../../types/handler";
 import axios from "axios";
 type PromiseResult = { success: boolean; rpcUrl: string; duration: number };
 
 export class RPCService {
   static async testRpcPerformance(
-    networkId: number,
+    networkId: NetworkId,
     latencies: Record<string, number>,
     runtimeRpcs: string[],
     rpcHeader: object,
@@ -58,7 +58,7 @@ export class RPCService {
 
     return { latencies, runtimeRpcs };
   }
-  static async findFastestRpc(latencies: Record<string, number>, networkId: number): Promise<string | null> {
+  static async findFastestRpc(latencies: Record<string, number>, networkId: NetworkId): Promise<string | null> {
     try {
       const validLatencies: Record<string, number> = Object.entries(latencies)
         .filter(([key]) => key.startsWith(`${networkId}__`))

src/services/storage-service.ts

@@ -1,5 +1,7 @@
+import { NetworkId } from "types/handler";
+
 export class StorageService {
-  static getLatencies(env: string, networkId: number): Record<string | number, number> {
+  static getLatencies(env: string, networkId: NetworkId): Record<string | number, number> {
     if (env === "browser") {
       if (this.bypassForTests()) return {};
       const latencies: Record<string, number> = JSON.parse(localStorage.getItem("rpcLatencies") || "{}");

tests/benchmark.test.ts

@@ -2,7 +2,7 @@ import { JsonRpcProvider } from "@ethersproject/providers";
 import { RPCHandler, HandlerConstructorConfig } from "../dist";
 
 export const testConfig: HandlerConstructorConfig = {
-  networkId: 1,
+  networkId: "1",
   autoStorage: false,
   cacheRefreshCycles: 3,
   networkName: null,