Bugfix/coin tester setup (#7140)

* Add documentation on coin tester

* SPECULOS_API_PORT

* coin-polkadot support websocket provider

* rpc.polkadot.io endpoint in chopsticks

.gitignore

@@ -12,3 +12,4 @@ tsconfig.tsbuildinfo
 rce
 .env
 coverage
+db.sqlite*

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

@@ -2,6 +2,6 @@
 SEED=chronic find success crew board merit elder life achieve scout gravity soul brief pen job
 # has to be a token classic
 GH_TOKEN=gh_token
-API_PORT=4040
+SPECULOS_API_PORT=4040
 # Only needed if you are on a apple chip
 SPECULOS_IMAGE=speculos

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

@@ -29,7 +29,6 @@
     "test": "jest",
     "typecheck": "tsc --noEmit",
     "unimported": "unimported",
-    "coin-tester:build": "make build -f src/test/coin-tester/Makefile",
     "coin-tester": "DOTENV_CONFIG_PATH=src/test/coin-tester/.env pnpm jest --runTestsByPath src/test/coin-tester/*.test.ts --forceExit"
   },
   "dependencies": {

libs/coin-modules/coin-polkadot/src/network/node/apiPromise.ts

@@ -1,8 +1,9 @@
-import { ApiPromise, HttpProvider } from "@polkadot/api";
+import { ApiPromise, HttpProvider, WsProvider } from "@polkadot/api";
 import { getCoinConfig, PolkadotCoinConfig } from "../../config";
 
 let coinConfig: PolkadotCoinConfig | undefined;
 let api: ApiPromise | undefined;
+
 export default async function () {
   const config = getCoinConfig();
   // Need to constantly check if a new config is setted
@@ -11,8 +12,21 @@ export default async function () {
     const headers = coinConfig.node.credentials
       ? { Authorization: "Basic " + coinConfig.node.credentials }
       : undefined;
+
+    const nodeURL = coinConfig.node.url;
+
+    let provider: HttpProvider | WsProvider;
+
+    if (nodeURL.startsWith("ws://") || nodeURL.startsWith("wss://")) {
+      provider = new WsProvider(nodeURL);
+    } else if (nodeURL.startsWith("http://") || nodeURL.startsWith("https://")) {
+      provider = new HttpProvider(nodeURL, headers);
+    } else {
+      throw new Error("[Polkadot] Invalid node URL");
+    }
+
     api = await ApiPromise.create({
-      provider: new HttpProvider(coinConfig.node.url, headers),
+      provider,
       noInitWarn: true, //to avoid undesired warning (ex: "API/INIT: polkadot/1002000: Not decorating unknown runtime apis")
     });
   }

libs/coin-modules/coin-polkadot/src/test/coin-tester/.env.example

@@ -1,5 +1,5 @@
 # development seed only. generated with https://iancoleman.io/bip39
 SEED=chronic find success crew board merit elder life achieve scout gravity soul brief pen job
 GH_TOKEN=gh_token
-API_PORT=4040
+SPECULOS_API_PORT=4040
 SPECULOS_IMAGE=speculos

libs/coin-modules/coin-polkadot/src/test/coin-tester/Makefile

@@ -1,9 +1,8 @@
 IMAGE_NAME = coin-tester-chopsticks
 CONTAINER_NAME = chopsticks
-CURRENT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 build:
-		docker build -f $(CURRENT_DIR)/chopsticks.Dockerfile -t $(IMAGE_NAME)\:latest .
+		docker build -f chopsticks.Dockerfile -t $(IMAGE_NAME)\:latest .
 
 run:
 		docker run --rm -d -p "8000:8000" --name $(CONTAINER_NAME) $(IMAGE_NAME)\:latest

libs/coin-modules/coin-polkadot/src/test/coin-tester/chopsticks-sidecar.ts

@@ -19,7 +19,6 @@ export async function spawnChopsticksAndSidecar() {
   ensureEnv();
   console.log("Starting chopsticks and sidecar...");
 
-  // await compose.buildOne("chopsticks", { cwd });
   await compose.upAll({
     cwd,
     log: true,
@@ -48,7 +47,7 @@ export async function spawnChopsticksAndSidecar() {
 }
 
 export const killChopsticksAndSidecar = async (): Promise<void> => {
-  console.log("Stopping anvil...");
+  console.log("Stopping chopsticks...");
   await compose.down({
     cwd,
     log: true,

libs/coin-modules/coin-polkadot/src/test/coin-tester/chopsticks.Dockerfile

@@ -8,4 +8,4 @@ RUN npm install -g @acala-network/chopsticks@latest
 
 EXPOSE 8000
 
-CMD ["chopsticks", "--endpoint", "wss://rpc.polkadot.io", "--config", "coin-tester-chopsticks.yml"]
+CMD ["chopsticks", "--config", "coin-tester-chopsticks.yml"]

libs/coin-modules/coin-polkadot/src/test/coin-tester/coin-tester-chopsticks.yml

@@ -1,6 +1,8 @@
 # Configuration file for chopsticks
-# https://github.com/AcalaNetwork/chopsticks?tab=readme-ov-file
+# Inspired by https://github.com/AcalaNetwork/chopsticks/blob/master/configs/polkadot.yml
+# Documentation: https://github.com/AcalaNetwork/chopsticks?tab=readme-ov-file
 endpoint:
+  - wss://rpc.polkadot.io
   - wss://rpc.ibp.network/polkadot
   - wss://polkadot-rpc.dwellir.com
 mock-signature-host: true

libs/coin-modules/coin-polkadot/src/test/coin-tester/docker-compose.yml

@@ -1,6 +1,7 @@
 name: chopsticks-sidecar
 services:
   chopsticks:
+    # TODO: Deploy the image in in ghr.io/ledgerhq
     image: coin-tester-chopsticks:latest
     container_name: chopsticks
     build:
@@ -17,8 +18,8 @@ services:
         retries: 12
   sidecar-api:
     image: ghcr.io/ledgerhq/polkadot-sidecar:19.0.0-ledger-live
-    platform: linux/x86_64
     container_name: sidecar-api
+    platform: linux/x86_64
     depends_on:
       chopsticks:
         condition: service_healthy

libs/coin-modules/coin-polkadot/src/test/coin-tester/scenarios.test.ts

@@ -8,12 +8,16 @@ jest.setTimeout(300_000);
 
 export const defaultNanoApp = { firmware: "2.3.0" as const, version: "25.10100.0" as const };
 
-export const LOCAL_TESTNODE_URL = "ws://127.0.0.1:8000";
-export const SIDECAR_BASE_URL = "http://127.0.0.1:8080";
-
 describe("Polkadot Deterministic Tester", () => {
   it("Basic scenario", async () => {
-    await executeScenario(basicScenario);
+    try {
+      await executeScenario(basicScenario);
+    } catch (e) {
+      if (e != "done") {
+        await Promise.all([killSpeculos(), killChopsticksAndSidecar()]);
+        throw e;
+      }
+    }
   });
 });
 

libs/coin-modules/coin-polkadot/src/test/coin-tester/scenarios/basic.ts

@@ -12,7 +12,7 @@ import {
 } from "../../../types/bridge";
 import { createBridges } from "../../../bridge";
 import { makeAccount } from "../../fixtures";
-import { defaultNanoApp, LOCAL_TESTNODE_URL, SIDECAR_BASE_URL } from "../scenarios.test";
+import { defaultNanoApp } from "../scenarios.test";
 import { PolkadotCoinConfig } from "../../../config";
 import { killChopsticksAndSidecar, spawnChopsticksAndSidecar } from "../chopsticks-sidecar";
 import { polkadot } from "./utils";
@@ -214,7 +214,10 @@ function getTransactions() {
   ];
 }
 
-const wsProvider = new WsProvider(LOCAL_TESTNODE_URL, false);
+const LOCAL_TESTNODE_WS_URL = "ws://127.0.0.1:8000";
+const SIDECAR_BASE_URL = "http://127.0.0.1:8080";
+
+const wsProvider = new WsProvider(LOCAL_TESTNODE_WS_URL, false);
 let api: ApiPromise;
 let unsubscribeNewBlockListener: () => void;
 
@@ -223,7 +226,7 @@ const coinConfig: PolkadotCoinConfig = {
     type: "active",
   },
   node: {
-    url: LOCAL_TESTNODE_URL,
+    url: LOCAL_TESTNODE_WS_URL,
   },
   sidecar: {
     url: SIDECAR_BASE_URL,
@@ -248,6 +251,7 @@ export const basicScenario: Scenario<PolkadotTransaction, PolkadotAccount> = {
     ]);
 
     const onSignerConfirmation = getOnSpeculosConfirmation("APPROVE");
+
     await cryptoWaitReady();
     await wsProvider.connect();
     api = await ApiPromise.create({ provider: wsProvider });
@@ -291,12 +295,21 @@ export const basicScenario: Scenario<PolkadotTransaction, PolkadotAccount> = {
 
     subscriptions.push(unsubGetBasicScenarioBalance);
 
-    await api.tx.balances
+    const unsub = await api.tx.balances
       .transferAllowDeath(
         basicScenarioAccountPair.address,
         parseCurrencyUnit(polkadot.units[0], "500000").toNumber(),
       )
-      .signAndSend(alice);
+      .signAndSend(alice, result => {
+        console.log(`Current status is ${result.status}`);
+
+        if (result.status.isInBlock) {
+          console.log(`Transaction included at blockHash ${result.status.asInBlock}`);
+        } else if (result.status.isFinalized) {
+          console.log(`Transaction finalized at blockHash ${result.status.asFinalized}`);
+          unsub();
+        }
+      });
 
     const account = makeAccount(basicScenarioAccountPair.address, polkadot);
 

libs/coin-tester/README.md

@@ -23,6 +23,7 @@ pnpm build:libs
 You only have to build speculos locally if you are on a Mac M1. Otherwise you can uncomment the image provided in the docker-compose.yml
 
 1. Clone speculos: `git clone [email protected]:LedgerHQ/speculos.git`
+
 2. Patch Dockerfile:
 
 ```Dockerfile
@@ -33,6 +34,7 @@ FROM speculos-builder:latest AS builder
 ```
 
 3. Build image
+
 ```sh
 cd speculos
 docker build -f build.Dockerfile -t speculos-builder:latest .
@@ -41,7 +43,7 @@ docker build -f Dockerfile -t speculos:latest .
 
 ### Environment variables
 
-- Generate a [Github token classic](https://github.com/settings/tokens) and make sure to authorize Ledger SSO
+- Generate a [Github token classic](https://github.com/settings/tokens) and give it full "repo" and "project" rights. Make sure to authorize Ledger SSO.
 
 - Go in the coin-module you want to test and create a `.env` in the folder where your test resides.
 For exemple for `coin-evm` create the file should be located in: `src/__test__/coin-tester/.env`.
@@ -70,15 +72,23 @@ If you want you can generate a new seed using [this tool](https://iancoleman.io/
 To coin Polkadot Coin tester we will need to build the local test node Docker image.
 
 ```sh
-pnpm coin:polkadot coin-tester:build
+cd libs/coin-modules/coin-polkadot/src/test/coin-tester
+make build
 ```
-
 ## Run tests for a coin module {#runtests}
 
 ```sh
 pnpm coin:<coin-module-name> coin-tester
 
 # e.g
-# pnpm coin:ethereum coin-tester
+# pnpm coin:evm coin-tester
 # pnpm coin:polkadot coin-tester
 ```
+
+## Troubleshooting
+
+### EVM Coin tester
+
+> The \"RPC\" variable is not set. Defaulting to a blank string.
+
+This error can safely be ignored. The RPC is passed as a variable env at runtime. Check [here](https://github.com/LedgerHQ/ledger-live/blob/develop/libs/coin-modules/coin-evm/src/__tests__/coin-tester/anvil.ts#L28) and [here](https://github.com/LedgerHQ/ledger-live/blob/develop/libs/coin-modules/coin-evm/src/__tests__/coin-tester/scenarios/ethereum.ts#L144)

libs/coin-tester/docker-compose.yml

@@ -7,7 +7,7 @@ services:
     volumes:
       - ./lib/signers/tmp:/speculos/apps
     ports:
-      - "${API_PORT}:${API_PORT}"
+      - "${SPECULOS_API_PORT}:${SPECULOS_API_PORT}"
     build:
       context: /speculos
-    command: --model nanox ./apps/app.elf --seed="${SEED}" --display headless --api-port ${API_PORT}
+    command: --model nanox ./apps/app.elf --seed="${SEED}" --display headless --api-port ${SPECULOS_API_PORT}

libs/coin-tester/src/signers/speculos.ts

@@ -7,13 +7,13 @@ import { ENV } from "../types";
 import chalk from "chalk";
 import { SignOperationEvent } from "@ledgerhq/types-live";
 
-const { API_PORT } = process.env as ENV;
+const { SPECULOS_API_PORT } = process.env as ENV;
 const cwd = path.join(__dirname);
 
 const delay = (timing: number) => new Promise(resolve => setTimeout(resolve, timing));
 
 function ensureEnv() {
-  const mandatory_env_variables = ["SEED", "API_PORT", "GH_TOKEN"];
+  const mandatory_env_variables = ["SEED", "SPECULOS_API_PORT", "GH_TOKEN"];
   const optional_env_variables = ["SPECULOS_IMAGE"];
 
   if (!mandatory_env_variables.every(variable => !!process.env[variable])) {
@@ -70,7 +70,7 @@ export async function spawnSpeculos(nanoAppEndpoint: `/${string}`): Promise<{
     if (out.includes("Running on all addresses (0.0.0.0)")) {
       console.log(chalk.bgYellowBright.black(" -  SPECULOS READY ✅  - "));
       return SpeculosTransportHttp.open({
-        apiPort: API_PORT,
+        apiPort: SPECULOS_API_PORT,
       });
     }
 
@@ -82,17 +82,17 @@ export async function spawnSpeculos(nanoAppEndpoint: `/${string}`): Promise<{
     async function onSpeculosConfirmation(e?: SignOperationEvent): Promise<void> {
       if (e?.type === "device-signature-requested") {
         const { data } = await axios.get(
-          `http://localhost:${process.env.API_PORT}/events?currentscreenonly=true`,
+          `http://localhost:${SPECULOS_API_PORT}/events?currentscreenonly=true`,
         );
 
         if (data.events[0].text !== approvalText) {
-          await axios.post(`http://localhost:${process.env.API_PORT}/button/right`, {
+          await axios.post(`http://localhost:${SPECULOS_API_PORT}/button/right`, {
             action: "press-and-release",
           });
 
           onSpeculosConfirmation(e);
         } else {
-          await axios.post(`http://localhost:${process.env.API_PORT}/button/both`, {
+          await axios.post(`http://localhost:${SPECULOS_API_PORT}/button/both`, {
             action: "press-and-release",
           });
         }

libs/coin-tester/src/types.ts

@@ -1,5 +1,5 @@
 export type ENV = {
   GH_TOKEN: string;
   SEED: string;
-  API_PORT: string;
+  SPECULOS_API_PORT: string;
 };