@ledgerhq/live-common 27.1.0-next.5 → 27.2.0-next.0

package/src/bot/index.ts

@@ -249,6 +249,15 @@ export async function bot({
   const { GITHUB_RUN_ID, GITHUB_WORKFLOW } = process.env;
 
   let body = "";
+  let githubBody = "";
+  function appendBody(content) {
+    body += content;
+    githubBody += content;
+  }
+  function appendBodyFullOnly(content) {
+    body += content;
+  }
+
   let title = "";
   const runURL = `https://github.com/LedgerHQ/ledger-live/actions/runs/${String(
     GITHUB_RUN_ID
@@ -282,14 +291,14 @@ export async function bot({
   }
 
   let slackBody = "";
-  body += `## ${title}`;
+  appendBody(`## ${title}`);
 
   if (GITHUB_RUN_ID && GITHUB_WORKFLOW) {
-    body += ` for [**${GITHUB_WORKFLOW}**](${runURL})\n\n`;
+    appendBody(` for [**${GITHUB_WORKFLOW}**](${runURL})\n\n`);
   }
 
-  body += "\n\n";
-  body += subtitle;
+  appendBody("\n\n");
+  appendBody(subtitle);
 
   if (fullySuccessfulSpecs.length) {
     const msg = `> ✅ ${
@@ -297,7 +306,7 @@ export async function bot({
     } specs are successful: _${fullySuccessfulSpecs
       .map((o) => o.spec.name)
       .join(", ")}_\n`;
-    body += msg;
+    appendBody(msg);
     slackBody += msg;
   }
 
@@ -307,7 +316,7 @@ export async function bot({
     } specs have problems: _${specsWithErrors
       .map((o) => o.spec.name)
       .join(", ")}_\n`;
-    body += msg;
+    appendBody(msg);
     slackBody += msg;
   }
 
@@ -315,7 +324,7 @@ export async function bot({
     const missingFundsWarn = `> 💰 ${
       withoutFunds.length
     } specs may miss funds: _${withoutFunds.join(", ")}_\n`;
-    body += missingFundsWarn;
+    appendBody(missingFundsWarn);
     slackBody += missingFundsWarn;
   }
 
@@ -325,21 +334,23 @@ export async function bot({
     } specs may have issues: *${specsWithoutOperations
       .map((o) => o.spec.name)
       .join(", ")}*\n`;
-    body += warn;
+    appendBody(warn);
     slackBody += warn;
   }
 
-  body += "\n\n";
+  appendBody("\n\n");
 
   if (specFatals.length) {
-    body += "<details>\n";
-    body += `<summary>${specFatals.length} critical spec errors</summary>\n\n`;
+    appendBody("<details>\n");
+    appendBody(
+      `<summary>${specFatals.length} critical spec errors</summary>\n\n`
+    );
     specFatals.forEach(({ spec, fatalError }) => {
-      body += `**Spec ${spec.name} failed!**\n`;
-      body += "```\n" + formatError(fatalError, true) + "\n```\n\n";
+      appendBody(`**Spec ${spec.name} failed!**\n`);
+      appendBody("```\n" + formatError(fatalError, true) + "\n```\n\n");
       slackBody += `❌ *Spec ${spec.name}*: \`${formatError(fatalError)}\`\n`;
     });
-    body += "</details>\n\n";
+    appendBody("</details>\n\n");
   }
 
   // summarize the error causes
@@ -361,65 +372,77 @@ export async function bot({
   }
 
   if (errorCases.length) {
-    body += "<details>\n";
-    body += `<summary>${errorCases.length} mutation errors</summary>\n\n`;
+    appendBody("<details>\n");
+    appendBody(`<summary>${errorCases.length} mutation errors</summary>\n\n`);
     errorCases.forEach((c) => {
-      body += "```\n" + formatReportForConsole(c) + "\n```\n\n";
+      appendBody("```\n" + formatReportForConsole(c) + "\n```\n\n");
     });
-    body += "</details>\n\n";
+    appendBody("</details>\n\n");
   }
 
-  body += "<details>\n";
-  body += `<summary>Details of the ${mutationReports.length} mutations</summary>\n\n`;
+  appendBodyFullOnly("<details>\n");
+
+  appendBodyFullOnly(
+    `<summary>Details of the ${mutationReports.length} mutations</summary>\n\n`
+  );
   results.forEach((r, i) => {
     const spec = specs[i];
     const logs = specsLogs[i];
-    body += `#### Spec ${spec.name} (${
-      r.mutations ? r.mutations.length : "failed"
-    })\n`;
-    body += "\n```\n";
-    body += logs.join("\n");
+    appendBodyFullOnly(
+      `#### Spec ${spec.name} (${
+        r.mutations ? r.mutations.length : "failed"
+      })\n`
+    );
+    appendBodyFullOnly("\n```\n");
+    appendBodyFullOnly(logs.join("\n"));
 
     if (r.mutations) {
       r.mutations.forEach((m) => {
         if (m.error || m.mutation) {
-          body += formatReportForConsole(m) + "\n";
+          appendBodyFullOnly(formatReportForConsole(m) + "\n");
         }
       });
     }
 
-    body += "\n```\n";
+    appendBodyFullOnly("\n```\n");
   });
-  body += "</details>\n\n";
+  appendBodyFullOnly("</details>\n\n");
 
   if (uncoveredMutations.length > 0) {
-    body += "<details>\n";
-    body += `<summary>Details of the ${uncoveredMutations.length} uncovered mutations</summary>\n\n`;
+    appendBodyFullOnly("<details>\n");
+    appendBodyFullOnly(
+      `<summary>Details of the ${uncoveredMutations.length} uncovered mutations</summary>\n\n`
+    );
     specsWithUncoveredMutations.forEach(({ spec, unavailableMutations }) => {
-      body += `#### Spec ${spec.name} (${unavailableMutations.length})\n`;
+      appendBodyFullOnly(
+        `#### Spec ${spec.name} (${unavailableMutations.length})\n`
+      );
       unavailableMutations.forEach((m) => {
         // FIXME: we definitely got to stop using Maybe types or | undefined | null
         if (!m) return;
         const msgs = groupBy(m.errors.map((e) => e.message));
-        body +=
+        appendBodyFullOnly(
           "- **" +
-          m.mutation.name +
-          "**: " +
-          Object.keys(msgs)
-            .map((msg) => `${msg} (${msgs[msg].length})`)
-            .join(", ") +
-          "\n";
+            m.mutation.name +
+            "**: " +
+            Object.keys(msgs)
+              .map((msg) => `${msg} (${msgs[msg].length})`)
+              .join(", ") +
+            "\n"
+        );
       });
     });
-    body += "</details>\n\n";
+    appendBodyFullOnly("</details>\n\n");
   }
 
-  body += "<details>\n";
-  body += `<summary>Portfolio ${
-    totalUSD ? " (" + totalUSD + ")" : ""
-  } – Details of the ${results.length} currencies</summary>\n\n`;
-  body += "| Spec (accounts) | Operations | Balance | funds? |\n";
-  body += "|-----------------|------------|---------|--------|\n";
+  appendBody("<details>\n");
+  appendBody(
+    `<summary>Portfolio ${
+      totalUSD ? " (" + totalUSD + ")" : ""
+    } – Details of the ${results.length} currencies</summary>\n\n`
+  );
+  appendBody("| Spec (accounts) | Operations | Balance | funds? |\n");
+  appendBody("|-----------------|------------|---------|--------|\n");
   results.forEach((r) => {
     function sumAccounts(all) {
       if (!all || all.length === 0) return;
@@ -486,22 +509,30 @@ export async function bot({
     const beforeOps = countOps(r.accountsBefore);
     const afterOps = countOps(r.accountsAfter);
     const firstAccount = (r.accountsAfter || r.accountsBefore || [])[0];
-    body += `| ${r.spec.name} (${
-      (r.accountsBefore || []).filter((a) => a.used).length
-    }) `;
-    body += `| ${afterOps || beforeOps}${
-      afterOps > beforeOps ? ` (+${afterOps - beforeOps})` : ""
-    } `;
-    body += `| ${balance} `;
-    body += `| ${etaTxs} ${(firstAccount && firstAccount.freshAddress) || ""} `;
-    body += "|\n";
+    appendBody(
+      `| ${r.spec.name} (${
+        (r.accountsBefore || []).filter((a) => a.used).length
+      }) `
+    );
+    appendBody(
+      `| ${afterOps || beforeOps}${
+        afterOps > beforeOps ? ` (+${afterOps - beforeOps})` : ""
+      } `
+    );
+    appendBody(`| ${balance} `);
+    appendBody(
+      `| ${etaTxs} ${(firstAccount && firstAccount.freshAddress) || ""} `
+    );
+    appendBody("|\n");
   });
-  body += "\n</details>\n\n";
+  appendBody("\n</details>\n\n");
 
   // Add performance details
-  body += "<details>\n";
-  body += `<summary>Performance ⏲ ${formatTime(totalDuration)}</summary>\n\n`;
-  body += "**Time spent for each spec:** (total across mutations)\n";
+  appendBody("<details>\n");
+  appendBody(
+    `<summary>Performance ⏲ ${formatTime(totalDuration)}</summary>\n\n`
+  );
+  appendBody("**Time spent for each spec:** (total across mutations)\n");
 
   function sumMutation(mutations, f) {
     return mutations?.reduce((sum, m) => sum + (f(m) || 0), 0) || 0;
@@ -513,73 +544,98 @@ export async function bot({
     return sumResults((r) => sumMutation(r.mutations, f));
   }
 
-  body +=
-    "| Spec (accounts) | preload | scan | re-sync | tx status | sign op | broadcast | mutation confirm |\n";
-  body += "|---|---|---|---|---|---|---|---|\n";
-
-  body += "| **TOTAL** |";
-  body += `**${formatTime(sumResults((r) => r.preloadDuration))}** |`;
-  body += `**${formatTime(sumResults((r) => r.scanDuration))}** |`;
-  body += `**${formatTime(
-    sumResultsMutation((m) => m.resyncAccountsDuration || 0)
-  )}** |`;
-  body += `**${formatTime(
-    sumResultsMutation((m) =>
-      m.mutationTime && m.statusTime ? m.statusTime - m.mutationTime : 0
-    )
-  )}** |`;
-  body += `**${formatTime(
-    sumResultsMutation((m) =>
-      m.statusTime && m.signedTime ? m.signedTime - m.statusTime : 0
-    )
-  )}** |`;
-  body += `**${formatTime(
-    sumResultsMutation((m) =>
-      m.signedTime && m.broadcastedTime ? m.broadcastedTime - m.signedTime : 0
-    )
-  )}** |`;
-  body += `**${formatTime(
-    sumResultsMutation((m) =>
-      m.broadcastedTime && m.confirmedTime
-        ? m.confirmedTime - m.broadcastedTime
-        : 0
-    )
-  )}** |\n`;
-
-  results.forEach((r) => {
-    body += `| ${r.spec.name} (${
-      (r.accountsBefore || []).filter((a) => a.used).length
-    }) |`;
-    body += `${formatTime(r.preloadDuration || 0)} |`;
-    body += `${formatTime(r.scanDuration || 0)} |`;
-    body += `${formatTime(
-      sumMutation(r.mutations, (m) => m.resyncAccountsDuration || 0)
-    )} |`;
-    body += `${formatTime(
-      sumMutation(r.mutations, (m) =>
+  appendBody(
+    "| Spec (accounts) | preload | scan | re-sync | tx status | sign op | broadcast | mutation confirm |\n"
+  );
+  appendBody("|---|---|---|---|---|---|---|---|\n");
+
+  appendBody("| **TOTAL** |");
+  appendBody(`**${formatTime(sumResults((r) => r.preloadDuration))}** |`);
+  appendBody(`**${formatTime(sumResults((r) => r.scanDuration))}** |`);
+  appendBody(
+    `**${formatTime(
+      sumResultsMutation((m) => m.resyncAccountsDuration || 0)
+    )}** |`
+  );
+  appendBody(
+    `**${formatTime(
+      sumResultsMutation((m) =>
         m.mutationTime && m.statusTime ? m.statusTime - m.mutationTime : 0
       )
-    )} |`;
-    body += `${formatTime(
-      sumMutation(r.mutations, (m) =>
+    )}** |`
+  );
+  appendBody(
+    `**${formatTime(
+      sumResultsMutation((m) =>
         m.statusTime && m.signedTime ? m.signedTime - m.statusTime : 0
       )
-    )} |`;
-    body += `${formatTime(
-      sumMutation(r.mutations, (m) =>
+    )}** |`
+  );
+  appendBody(
+    `**${formatTime(
+      sumResultsMutation((m) =>
         m.signedTime && m.broadcastedTime ? m.broadcastedTime - m.signedTime : 0
       )
-    )} |`;
-    body += `${formatTime(
-      sumMutation(r.mutations, (m) =>
+    )}** |`
+  );
+  appendBody(
+    `**${formatTime(
+      sumResultsMutation((m) =>
         m.broadcastedTime && m.confirmedTime
           ? m.confirmedTime - m.broadcastedTime
           : 0
       )
-    )} |\n`;
+    )}** |\n`
+  );
+
+  results.forEach((r) => {
+    appendBody(
+      `| ${r.spec.name} (${
+        (r.accountsBefore || []).filter((a) => a.used).length
+      }) |`
+    );
+    appendBody(`${formatTime(r.preloadDuration || 0)} |`);
+    appendBody(`${formatTime(r.scanDuration || 0)} |`);
+    appendBody(
+      `${formatTime(
+        sumMutation(r.mutations, (m) => m.resyncAccountsDuration || 0)
+      )} |`
+    );
+    appendBody(
+      `${formatTime(
+        sumMutation(r.mutations, (m) =>
+          m.mutationTime && m.statusTime ? m.statusTime - m.mutationTime : 0
+        )
+      )} |`
+    );
+    appendBody(
+      `${formatTime(
+        sumMutation(r.mutations, (m) =>
+          m.statusTime && m.signedTime ? m.signedTime - m.statusTime : 0
+        )
+      )} |`
+    );
+    appendBody(
+      `${formatTime(
+        sumMutation(r.mutations, (m) =>
+          m.signedTime && m.broadcastedTime
+            ? m.broadcastedTime - m.signedTime
+            : 0
+        )
+      )} |`
+    );
+    appendBody(
+      `${formatTime(
+        sumMutation(r.mutations, (m) =>
+          m.broadcastedTime && m.confirmedTime
+            ? m.confirmedTime - m.broadcastedTime
+            : 0
+        )
+      )} |\n`
+    );
   });
 
-  body += "\n</details>\n\n";
+  appendBody("\n</details>\n\n");
 
   const { BOT_REPORT_FOLDER } = process.env;
 
@@ -589,6 +645,11 @@ export async function bot({
 
   if (BOT_REPORT_FOLDER) {
     await Promise.all([
+      fs.promises.writeFile(
+        path.join(BOT_REPORT_FOLDER, "github-report.md"),
+        githubBody,
+        "utf-8"
+      ),
       fs.promises.writeFile(
         path.join(BOT_REPORT_FOLDER, "full-report.md"),
         body,

package/src/bot/specs.ts

@@ -19,7 +19,14 @@ export function pickSiblings(siblings: Account[], maxAccount = 5): Account {
 
   if (siblings.length > maxAccount) {
     // we are no longer creating accounts
-    return sample(withoutEmpties) as Account;
+    const maybeAccount = sample(withoutEmpties);
+    if (!maybeAccount) {
+      throw new Error(
+        "at least one non-empty sibling account exists. maxAccount=" +
+          maxAccount
+      );
+    }
+    return maybeAccount;
   }
 
   // we are only keeping empty account that have smaller index to favorize creation of non created derivation modes
@@ -30,8 +37,15 @@ export function pickSiblings(siblings: Account[], maxAccount = 5): Account {
     empties = empties.filter((e) => e.index === empties[0].index);
   }
 
-  return sample(withoutEmpties.concat(empties)) as Account;
+  const maybeAccount = sample(withoutEmpties.concat(empties));
+  if (!maybeAccount) {
+    throw new Error(
+      "at least one sibling account exists. maxAccount=" + maxAccount
+    );
+  }
+  return maybeAccount;
 }
+
 type State<T extends Transaction> = {
   finalState: boolean;
   stepTitle: string;

package/src/exchange/swap/getKYCStatus.ts

@@ -4,6 +4,7 @@ import type { GetKYCStatus } from "./types";
 import { SwapCheckKYCStatusFailed } from "../../errors";
 import { getEnv } from "../../env";
 import { mockGetKYCStatus } from "./mock";
+
 export const getKYCStatus: GetKYCStatus = async (
   provider: string,
   id: string
@@ -17,7 +18,7 @@ export const getKYCStatus: GetKYCStatus = async (
   });
 
   if (!res.data?.status) {
-    return new SwapCheckKYCStatusFailed(id);
+    throw new SwapCheckKYCStatusFailed(id);
   }
 
   const { status } = res.data;
@@ -26,4 +27,5 @@ export const getKYCStatus: GetKYCStatus = async (
     status,
   };
 };
+
 export default getKYCStatus;

package/src/families/bitcoin/cache.ts

@@ -68,9 +68,9 @@ export const validateRecipient: (
         recipientError: null,
         recipientWarning,
       };
-    } catch (recipientError) {
+    } catch (e) {
       return {
-        recipientError,
+        recipientError: e instanceof Error ? e : null,
         recipientWarning: null,
       };
     }

package/src/families/bitcoin/hw-signMessage.ts

@@ -1,7 +1,7 @@
 import Btc from "@ledgerhq/hw-app-btc";
-import type { Resolver } from "../../hw/signMessage/types";
+import type { SignMessage } from "../../hw/signMessage/types";
 
-const resolver: Resolver = async (transport, { path, message }) => {
+const signMessage: SignMessage = async (transport, { path, message }) => {
   const btc = new Btc(transport);
   const hexMessage = Buffer.from(message).toString("hex");
   const result = await btc.signMessageNew(path, hexMessage);
@@ -16,4 +16,4 @@ const resolver: Resolver = async (transport, { path, message }) => {
   };
 };
 
-export default resolver;
+export default { signMessage };

package/src/families/cosmos/banner.test.ts

@@ -1,11 +1,15 @@
 import { getAccountBannerState } from "./banner";
 import * as preloadedData from "./preloadedData";
-import * as bridge from "../../bridge";
+import * as logic from "./logic";
 import type { CosmosAccount, CosmosValidatorItem } from "./types";
 import data from "./preloadedData.mock";
 import { LEDGER_VALIDATOR_ADDRESS } from "./utils";
 import { BigNumber } from "bignumber.js";
 
+jest.mock("./js-prepareTransaction", () => ({
+  calculateFees: jest.fn(() => Promise.resolve({})),
+}));
+
 const ledgerValidator: CosmosValidatorItem | undefined = data.validators.find(
   (x) => x.validatorAddress === LEDGER_VALIDATOR_ADDRESS
 );
@@ -103,12 +107,9 @@ describe("cosmos/banner", () => {
         .mockReturnValue({ validators } as {
           validators: CosmosValidatorItem[];
         });
-
-      jest.spyOn(bridge, "getAccountBridge").mockReturnValue({
-        estimateMaxSpendable: () => Promise.resolve(new BigNumber(0)),
-      } as any);
-      const result = await getAccountBannerState(account);
-      expect(1 + 1).toBe(2);
+      jest.spyOn(logic, "canDelegate").mockReturnValue(false);
+      jest.spyOn(logic, "canRedelegate").mockReturnValue(false);
+      const result = getAccountBannerState(account);
       expect(result).toStrictEqual({
         display: false,
         redelegate: false,
@@ -122,10 +123,9 @@ describe("cosmos/banner", () => {
         .mockReturnValue({ validators } as {
           validators: CosmosValidatorItem[];
         });
-      jest.spyOn(bridge, "getAccountBridge").mockReturnValue({
-        estimateMaxSpendable: () => Promise.resolve(new BigNumber(5000)),
-      } as any);
-      const result = await getAccountBannerState(account);
+      jest.spyOn(logic, "canDelegate").mockReturnValue(true);
+      jest.spyOn(logic, "canRedelegate").mockReturnValue(false);
+      const result = getAccountBannerState(account);
       expect(result).toStrictEqual({
         display: true,
         redelegate: false,
@@ -139,16 +139,19 @@ describe("cosmos/banner", () => {
         .mockReturnValue({ validators } as {
           validators: CosmosValidatorItem[];
         });
-      jest.spyOn(bridge, "getAccountBridge").mockReturnValue({
-        estimateMaxSpendable: () => Promise.resolve(new BigNumber(5000)),
-      } as any);
+      jest.spyOn(logic, "canDelegate").mockReturnValue(false);
+      jest.spyOn(logic, "canRedelegate").mockReturnValue(true);
       account.cosmosResources.redelegations.push({
         validatorSrcAddress: "xxxx",
         validatorDstAddress: expensiveValidator?.validatorAddress as string,
         amount: new BigNumber(1000),
         completionDate: new Date(),
       });
-      const result = await getAccountBannerState(account);
+      const accountWithSpendable5000 = {
+        ...account,
+        spendableBalance: new BigNumber(5000),
+      };
+      const result = getAccountBannerState(accountWithSpendable5000);
       expect(result).toStrictEqual({
         display: true,
         redelegate: true,
@@ -156,5 +159,27 @@ describe("cosmos/banner", () => {
         ledgerValidator,
       });
     });
+    it("should return not display redelegate mode", async () => {
+      jest
+        .spyOn(preloadedData, "getCurrentCosmosPreloadData")
+        .mockReturnValue({ validators } as {
+          validators: CosmosValidatorItem[];
+        });
+      jest.spyOn(logic, "canDelegate").mockReturnValue(false);
+      jest.spyOn(logic, "canRedelegate").mockReturnValue(false);
+      account.cosmosResources.redelegations.push({
+        validatorSrcAddress: "xxxx",
+        validatorDstAddress: expensiveValidator?.validatorAddress as string,
+        amount: new BigNumber(1000),
+        completionDate: new Date(),
+      });
+      const result = getAccountBannerState(account);
+      expect(result).toStrictEqual({
+        display: false,
+        redelegate: false,
+        validatorSrcAddress: "",
+        ledgerValidator,
+      });
+    });
   });
 });

package/src/families/cosmos/banner.ts

@@ -1,6 +1,6 @@
 import { getCurrentCosmosPreloadData } from "./preloadedData";
-import { getAccountBridge } from "../../bridge";
 import { LEDGER_VALIDATOR_ADDRESS } from "./utils";
+import { canDelegate, canRedelegate } from "./logic";
 import type { CosmosAccount, CosmosValidatorItem } from "./types";
 
 interface AccountBannerState {
@@ -10,9 +10,9 @@ interface AccountBannerState {
   ledgerValidator: CosmosValidatorItem | undefined;
 }
 
-export async function getAccountBannerState(
+export function getAccountBannerState(
   account: CosmosAccount
-): Promise<AccountBannerState> {
+): AccountBannerState {
   // Group current validator
   const cosmosResources = account.cosmosResources
     ? account.cosmosResources
@@ -43,7 +43,8 @@ export async function getAccountBannerState(
     if (
       worstValidator &&
       validator &&
-      worstValidator.commission < validator.commission
+      worstValidator.commission < validator.commission &&
+      canRedelegate(account, validator)
     ) {
       worstValidator = validator;
     }
@@ -58,15 +59,7 @@ export async function getAccountBannerState(
       worstValidator?.validatorAddress === ledgerValidator?.validatorAddress
     ) {
       // Not found worst validator than ledger
-      const maxSpendable = await getAccountBridge(
-        account,
-        undefined
-      ).estimateMaxSpendable({
-        account,
-        parentAccount: undefined,
-        transaction: undefined,
-      });
-      if (maxSpendable.gt(0)) {
+      if (canDelegate(account)) {
         // Delegate remaining ATOM (not staked)
         display = true;
       }

package/src/families/cosmos/logic.ts

@@ -184,7 +184,7 @@ export function canDelegate(account: CosmosAccount): boolean {
 
 export function canRedelegate(
   account: CosmosAccount,
-  delegation: CosmosDelegation
+  delegation: CosmosDelegation | CosmosValidatorItem
 ): boolean {
   const { cosmosResources } = account;
   invariant(cosmosResources, "cosmosResources should exist");