@ledgerhq/coin-tester 0.2.0 → 0.2.1-nightly.0

package/src/signers/speculos.ts

@@ -1,5 +1,5 @@
 import path from "path";
-import axios from "axios";
+import axios, { AxiosError } from "axios";
 import fs from "fs/promises";
 import { v2 as compose } from "docker-compose";
 import SpeculosTransportHttp from "@ledgerhq/hw-transport-node-speculos-http";
@@ -7,30 +7,56 @@ 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));
 
-export const spawnSpeculos = async (
-  nanoAppEndpoint: `/${string}`,
-): Promise<{
+function ensureEnv() {
+  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])) {
+    throw new Error(
+      `Missing env variables. Make sure that ${mandatory_env_variables.join(",")} are in your .env`,
+    );
+  }
+
+  optional_env_variables.forEach(envVariable => {
+    if (!process.env[envVariable]) {
+      console.warn(`Variable ${envVariable} missing from .env. Using default value.`);
+    }
+  });
+}
+
+export async function spawnSpeculos(nanoAppEndpoint: `/${string}`): Promise<{
   transport: SpeculosTransportHttp;
-  onSignerConfirmation: (e?: SignOperationEvent) => Promise<void>;
-}> => {
+  getOnSpeculosConfirmation: (approvalText?: string) => () => Promise<void>;
+}> {
+  ensureEnv();
   console.log(`Starting speculos...`);
 
-  const { data: blob } = await axios({
-    url: `https://raw.githubusercontent.com/LedgerHQ/coin-apps/master/nanox${nanoAppEndpoint}`,
-    method: "GET",
-    responseType: "stream",
-    headers: {
-      Authorization: `Bearer ${process.env.GH_TOKEN}`,
-    },
-  });
+  try {
+    const { data: blob } = await axios({
+      url: `https://raw.githubusercontent.com/LedgerHQ/coin-apps/master/nanox${nanoAppEndpoint}`,
+      method: "GET",
+      responseType: "stream",
+      headers: {
+        Authorization: `Bearer ${process.env.GH_TOKEN}`,
+      },
+    });
 
-  await fs.mkdir(path.resolve(cwd, "tmp"), { recursive: true });
-  await fs.writeFile(path.resolve(cwd, "tmp/app.elf"), blob, "binary");
+    await fs.mkdir(path.resolve(cwd, "tmp"), { recursive: true });
+    await fs.writeFile(path.resolve(cwd, "tmp/app.elf"), blob, "binary");
+  } catch (err) {
+    if (err instanceof AxiosError) {
+      throw new Error(
+        `${err.status}: Failed to download the app.elf file from ${nanoAppEndpoint}\nMake sure that your GH_TOKEN is correct and has the right permissions.`,
+      );
+    }
+
+    throw err;
+  }
 
   await compose.upOne("speculos", {
     cwd,
@@ -38,55 +64,60 @@ export const spawnSpeculos = async (
     env: process.env,
   });
 
-  const checkSpeculosLogs = async (): Promise<SpeculosTransportHttp> => {
+  async function checkSpeculosLogs(): Promise<SpeculosTransportHttp> {
     const { out } = await compose.logs("speculos", { cwd, env: process.env });
 
     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,
       });
     }
 
     await delay(200);
     return checkSpeculosLogs();
-  };
+  }
 
-  const onSpeculosConfirmation = async (e?: SignOperationEvent): Promise<void> => {
-    if (e?.type === "device-signature-requested") {
-      const { data } = await axios.get(
-        `http://localhost:${process.env.API_PORT}/events?currentscreenonly=true`,
-      );
+  function getOnSpeculosConfirmation(approvalText = "Accept") {
+    async function onSpeculosConfirmation(e?: SignOperationEvent): Promise<void> {
+      if (e?.type === "device-signature-requested") {
+        const { data } = await axios.get(
+          `http://localhost:${SPECULOS_API_PORT}/events?currentscreenonly=true`,
+        );
+
+        if (data.events[0].text !== approvalText) {
+          await axios.post(`http://localhost:${SPECULOS_API_PORT}/button/right`, {
+            action: "press-and-release",
+          });
 
-      if (data.events[0].text !== "Accept") {
-        await axios.post(`http://localhost:${process.env.API_PORT}/button/right`, {
-          action: "press-and-release",
-        });
-        onSpeculosConfirmation(e);
-      } else {
-        await axios.post(`http://localhost:${process.env.API_PORT}/button/both`, {
-          action: "press-and-release",
-        });
+          onSpeculosConfirmation(e);
+        } else {
+          await axios.post(`http://localhost:${SPECULOS_API_PORT}/button/both`, {
+            action: "press-and-release",
+          });
+        }
       }
     }
-  };
+
+    return onSpeculosConfirmation;
+  }
 
   return checkSpeculosLogs().then(transport => {
     return {
       transport,
-      onSignerConfirmation: onSpeculosConfirmation,
+      getOnSpeculosConfirmation,
     };
   });
-};
+}
 
-export const killSpeculos = async () => {
+export async function killSpeculos() {
   console.log("Stopping speculos...");
   await compose.down({
     cwd,
     log: true,
     env: process.env,
   });
-};
+}
 
 ["exit", "SIGINT", "SIGQUIT", "SIGTERM", "SIGUSR1", "SIGUSR2", "uncaughtException"].map(e =>
   process.on(e, async () => {

package/src/types.ts

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