Coin-tester tool engine + EVM coin-tester (#6530)

* coin-tester engine

* coin-tester script

* coin-evm coin-tester implementation

* lockfile

* defaultNanoApp

* lockfile

* scenario before/afterall

* add assertions on ethereum transactions

* add expects in polygon test

* remove unused dependencies

* upgrade docker-compose config versions

* extract initAccount functions

* lockfile

* fix clearInterval type

* signers folder

* docker.ts -> anvil.ts

* use docker 2.4

* use initAccount in ethereum transactions

* polygon expects

* nft expects

* improve transactions expects

* add logs

* polygon expects

* impersonate account helper function

* clean

* fix synchronization tests

* timeout

* simpler ethereum nft expects

* lockfile

* beforeAll

* Move `impersonateAccount` to coin-evm test helpers

* Unify Ethereum & Polygon scenarii

* api node test

* Remove coin-tester "test" script

---------

Co-authored-by: 0xkvn <[email protected]>

.gitignore

@@ -10,3 +10,4 @@ node_modules
 .eslintcache
 tsconfig.tsbuildinfo
 rce
+.env

apps/ledger-live-desktop/src/renderer/screens/market/index.tsx

@@ -89,7 +89,7 @@ export default function Market() {
   useEffect(() => {
     const intervalId = setInterval(() => refetchData(marketCurrentPage ?? 1), refreshRate);
 
-    return () => clearInterval(intervalId);
+    return () => clearInterval(intervalId as unknown as number);
   }, [marketCurrentPage, refetchData, refreshRate]);
 
   const { order, range, counterCurrency, search = "", liveCompatible } = marketParams;

libs/coin-modules/coin-evm/.eslintrc.js

@@ -4,6 +4,12 @@ module.exports = {
     es6: true,
   },
   plugins: ["import"],
+  rules: {
+    "no-console": ["error", { allow: ["warn", "error"] }],
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/explicit-function-return-type": "error",
+    "import/order": ["error"],
+  },
   overrides: [
     {
       files: ["src/**/*.test.{ts,tsx}"],
@@ -16,14 +22,10 @@ module.exports = {
       // allow, as warning, only any in tests
       files: ["*/__tests__/**/*.{ts,tsx}"],
       rules: {
+        "no-console": "off",
         "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/explicit-function-return-type": "off",
       },
     },
   ],
-  rules: {
-    "no-console": ["error", { allow: ["warn", "error"] }],
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/explicit-function-return-type": "error",
-    "import/order": ["error"],
-  },
 };

libs/coin-modules/coin-evm/jest.config.js

@@ -5,7 +5,8 @@ module.exports = {
   testPathIgnorePatterns: ["lib/", "lib-es/"],
   modulePathIgnorePatterns: [
     "__tests__/fixtures",
+    "__tests__/coin-tester",
     "__tests__/integration/bridge.integration.test.ts", // this file is tested at the live-common level
   ],
-  setupFilesAfterEnv: ["jest-expect-message"],
+  setupFilesAfterEnv: ["jest-expect-message", "dotenv/config"],
 };

libs/coin-modules/coin-evm/package.json

@@ -43,6 +43,19 @@
     "./package.json": "./package.json"
   },
   "license": "Apache-2.0",
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx --cache",
+    "lint:fix": "pnpm lint --fix",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "unimported": "unimported",
+    "coin-tester": "DOTENV_CONFIG_PATH=src/__tests__/coin-tester/.env pnpm jest --runTestsByPath src/__tests__/coin-tester/*.test.ts"
+  },
   "dependencies": {
     "@ethersproject/shims": "^5.7.0",
     "@ledgerhq/coin-framework": "workspace:^",
@@ -67,30 +80,23 @@
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@types/imurmurhash": "^0.1.4",
+    "@ledgerhq/coin-tester": "workspace:^",
     "@ledgerhq/hw-app-eth": "workspace:^",
     "@ledgerhq/types-cryptoassets": "workspace:^",
     "@ledgerhq/types-live": "workspace:^",
+    "@types/imurmurhash": "^0.1.4",
     "@types/invariant": "^2.2.2",
     "@types/jest": "^29.5.10",
     "@types/lodash": "^4.14.191",
+    "docker-compose": "^0.24.2",
+    "dotenv": "^16.4.5",
+    "chalk": "^4.1.2",
     "eslint-plugin-import": "^2.28.1",
     "fast-check": "^3.12.0",
     "jest": "^29.7.0",
     "jest-expect-message": "^1.1.3",
+    "msw": "^2.2.12",
     "prando": "^6.0.1",
     "ts-jest": "^29.1.1"
-  },
-  "scripts": {
-    "clean": "rimraf lib lib-es",
-    "build": "tsc && tsc -m ES6 --outDir lib-es",
-    "prewatch": "pnpm build",
-    "watch": "tsc --watch",
-    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
-    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx --cache",
-    "lint:fix": "pnpm lint --fix",
-    "typecheck": "tsc --noEmit",
-    "test": "jest",
-    "unimported": "unimported"
   }
 }

libs/coin-modules/coin-evm/src/__tests__/coin-tester/.env.example

@@ -0,0 +1,7 @@
+# https://iancoleman.io/bip39/
+SEED=your 12/15/24 words
+# has to be a token classic
+GH_TOKEN=gh_p
+API_PORT=4040
+# Only needed if you are on a apple chip
+SPECULOS_IMAGE=speculos

libs/coin-modules/coin-evm/src/__tests__/coin-tester/anvil.ts

@@ -0,0 +1,55 @@
+import { v2 as compose } from "docker-compose";
+import chalk from "chalk";
+import { killSpeculos } from "@ledgerhq/coin-tester/lib/signers/speculos";
+
+const cwd = __dirname;
+
+const delay = (timing: number): Promise<void> =>
+  new Promise(resolve => setTimeout(resolve, timing));
+
+export const spawnAnvil = async (rpc: string): Promise<void> => {
+  console.log("Starting anvil...");
+  await compose.upOne("anvil", {
+    cwd,
+    log: true,
+    env: {
+      ...process.env,
+      RPC: rpc,
+    },
+  });
+
+  const checkAnvilLogs = async (): Promise<void> => {
+    const { out } = await compose.logs("anvil", {
+      cwd,
+      env: {
+        ...process.env,
+        RPC: rpc,
+      },
+    });
+
+    if (out.includes("Listening on 0.0.0.0:")) {
+      console.log(chalk.bgBlueBright(" -  ANVIL READY ✅  - "));
+      return;
+    }
+
+    await delay(200);
+    return checkAnvilLogs();
+  };
+
+  await checkAnvilLogs();
+};
+
+export const killAnvil = async (): Promise<void> => {
+  console.log("Stopping anvil...");
+  await compose.down({
+    cwd,
+    log: true,
+    env: process.env,
+  });
+};
+
+["exit", "SIGINT", "SIGQUIT", "SIGTERM", "SIGUSR1", "SIGUSR2", "uncaughtException"].map(e =>
+  process.on(e, async () => {
+    await Promise.all([killAnvil(), killSpeculos()]);
+  }),
+);

libs/coin-modules/coin-evm/src/__tests__/coin-tester/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2.4'
+
+services:
+  anvil:
+    image: ghcr.io/foundry-rs/foundry:latest
+    container_name: anvil
+    ports:
+      - "8545:8545"
+    command: -c "anvil --host 0.0.0.0 --fork-url ${RPC} --no-storage-caching --steps-tracing --mnemonic='${SEED}'"

libs/coin-modules/coin-evm/src/__tests__/coin-tester/helpers.ts

@@ -0,0 +1,43 @@
+import { ethers } from "ethers";
+import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
+import { getTokenById } from "@ledgerhq/cryptoassets/tokens";
+import ERC20ABI from "../../abis/erc20.abi.json";
+import ERC721ABI from "../../abis/erc721.abi.json";
+import ERC1155ABI from "../../abis/erc1155.abi.json";
+
+export const ethereum = getCryptoCurrencyById("ethereum");
+export const polygon = getCryptoCurrencyById("polygon");
+export const ERC20Interface = new ethers.utils.Interface(ERC20ABI);
+export const ERC721Interface = new ethers.utils.Interface(ERC721ABI);
+export const ERC1155Interface = new ethers.utils.Interface(ERC1155ABI);
+export const USDC_ON_ETHEREUM = getTokenById("ethereum/erc20/usd__coin");
+export const USDC_ON_POLYGON = getTokenById("polygon/erc20/usd_coin_(pos)");
+
+export const impersonnateAccount = async ({
+  provider,
+  addressToImpersonnate,
+  to,
+  data,
+}: {
+  provider: ethers.providers.JsonRpcProvider;
+  addressToImpersonnate: string;
+  to: string;
+  data: string;
+}) => {
+  await provider.send("anvil_impersonateAccount", [addressToImpersonnate]);
+  const impersonatedAccount = {
+    from: addressToImpersonnate,
+    to,
+    data,
+    value: ethers.BigNumber.from(0).toHexString(),
+    gas: ethers.BigNumber.from(1_000_000).toHexString(),
+    type: "0x0",
+    gasPrice: (await provider.getGasPrice()).toHexString(),
+    nonce: "0x" + (await provider.getTransactionCount(addressToImpersonnate)).toString(16),
+    chainId: "0x" + (await provider.getNetwork()).chainId.toString(16),
+  };
+
+  const hash = await provider.send("eth_sendTransaction", [impersonatedAccount]);
+  await provider.send("anvil_stopImpersonatingAccount", [addressToImpersonnate]);
+  await provider.waitForTransaction(hash);
+};