@ledgerhq/live-common 27.0.0 → 27.0.1-next.0

package/src/families/hedera/specs.ts

@@ -9,8 +9,9 @@ import type {
   TransactionRes,
 } from "../../bot/types";
 import type { Transaction } from "./types";
-import { pickSiblings } from "../../bot/specs";
+import { botTest, pickSiblings } from "../../bot/specs";
 import { isAccountEmpty } from "../../account";
+import { acceptTransaction } from "./speculos-deviceActions";
 
 const currency = getCryptoCurrencyById("hedera");
 const memoTestMessage = "This is a test memo.";
@@ -39,6 +40,7 @@ const hedera: AppSpec<Transaction> = {
     firmware: "2.1.0",
     appVersion: "1.0.8",
   },
+  genericDeviceAction: acceptTransaction,
   currency,
   transactionCheck: ({ maxSpendable }) => {
     invariant(maxSpendable.gt(0), "Balance is too low");
@@ -73,8 +75,10 @@ const hedera: AppSpec<Transaction> = {
         accountBeforeTransaction,
         operation,
       }: TransactionTestInput<Transaction>): void => {
-        expect(account.balance.toString()).toBe(
-          accountBeforeTransaction.balance.minus(operation.value).toString()
+        botTest("account balance moved with operation value", () =>
+          expect(account.balance.toString()).toBe(
+            accountBeforeTransaction.balance.minus(operation.value).toString()
+          )
         );
       },
     },
@@ -109,7 +113,9 @@ const hedera: AppSpec<Transaction> = {
           .minus(transaction.amount.plus(operation.fee))
           .toNumber();
 
-        expect(accountBalanceAfterTx).toBe(amount);
+        botTest("account balance moved with operation", () =>
+          expect(accountBalanceAfterTx).toBe(amount)
+        );
       },
     },
     {
@@ -137,7 +143,9 @@ const hedera: AppSpec<Transaction> = {
         };
       },
       test: ({ transaction }: TransactionTestInput<Transaction>): void => {
-        expect(transaction.memo).toBe(memoTestMessage);
+        botTest("transaction.memo is set", () =>
+          expect(transaction.memo).toBe(memoTestMessage)
+        );
       },
     },
   ],

package/src/families/hedera/speculos-deviceActions.ts

@@ -3,63 +3,62 @@ import type { Transaction } from "./types";
 import { formatCurrencyUnit } from "../../currencies";
 import { deviceActionFlow } from "../../bot/specs";
 
-const acceptTransaction: DeviceAction<Transaction, any> = deviceActionFlow({
-  steps: [
-    {
-      title: "Transfer",
-    },
-    {
-      title: "with Key #0?",
-      button: "Rr",
-    },
-    {
-      title: "Operator",
-      button: "Rr",
-      expectedValue: ({ account }) => account.freshAddress,
-    },
-    {
-      title: "Sender",
-      button: "Rr",
-      expectedValue: ({ account }) => account.freshAddress,
-    },
-    {
-      title: "Recipient",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.recipient,
-    },
-    {
-      title: "Amount",
-      button: "Rr",
-      expectedValue: ({ account: { unit }, transaction: { amount } }) =>
-        formatCurrencyUnit(unit, amount, {
-          disableRounding: true,
-          subMagnitude: 10,
-        }) + " hbar",
-    },
-    {
-      title: "Fee",
-      button: "Rr",
-      expectedValue: ({ account: { unit }, status: { estimatedFees } }) =>
-        formatCurrencyUnit(unit, estimatedFees, {
-          disableRounding: true,
-          subMagnitude: 10,
-        }) + " hbar",
-    },
-    {
-      title: "Max Fee",
-      button: "Rr",
-      expectedValue: () => "1 hbar",
-    },
-    {
-      title: "Memo",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.memo as string,
-    },
-    {
-      title: "Confirm",
-      button: "LRlr",
-    },
-  ],
-});
-
-export default { acceptTransaction };
+export const acceptTransaction: DeviceAction<Transaction, any> =
+  deviceActionFlow({
+    steps: [
+      {
+        title: "Transfer",
+      },
+      {
+        title: "with Key #0?",
+        button: "Rr",
+      },
+      {
+        title: "Operator",
+        button: "Rr",
+        expectedValue: ({ account }) => account.freshAddress,
+      },
+      {
+        title: "Sender",
+        button: "Rr",
+        expectedValue: ({ account }) => account.freshAddress,
+      },
+      {
+        title: "Recipient",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.recipient,
+      },
+      {
+        title: "Amount",
+        button: "Rr",
+        expectedValue: ({ account: { unit }, transaction: { amount } }) =>
+          formatCurrencyUnit(unit, amount, {
+            disableRounding: true,
+            showAllDigits: true,
+          }) + " hbar",
+      },
+      {
+        title: "Fee",
+        button: "Rr",
+        expectedValue: ({ account: { unit }, status: { estimatedFees } }) =>
+          formatCurrencyUnit(unit, estimatedFees, {
+            disableRounding: true,
+            showAllDigits: true,
+          }) + " hbar",
+      },
+      {
+        title: "Max Fee",
+        button: "Rr",
+        expectedValue: () => "1 hbar",
+      },
+      {
+        title: "Memo",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.memo as string,
+      },
+      {
+        title: "Confirm",
+        button: "LRlr",
+      },
+    ],
+  });

package/src/families/osmosis/specs.ts

@@ -1,7 +1,7 @@
 import invariant from "invariant";
 import type { Transaction } from "./types";
 import { getCryptoCurrencyById, parseCurrencyUnit } from "../../currencies";
-import { pickSiblings } from "../../bot/specs";
+import { botTest, pickSiblings } from "../../bot/specs";
 import type { AppSpec } from "../../bot/types";
 import { DeviceModelId } from "@ledgerhq/devices";
 import type {
@@ -19,10 +19,11 @@ import sample from "lodash/sample";
 import expect from "expect";
 import { toOperationRaw } from "../../account";
 import { BigNumber } from "bignumber.js";
+import { acceptTransaction } from "./speculos-deviceActions";
 
 const currency = getCryptoCurrencyById("osmosis");
 const minimalAmount = parseCurrencyUnit(currency.units[0], "0.00001");
-const maxAccount = 3;
+const maxAccount = 16;
 // amounts of delegation are not exact so we are applying an approximation
 function approximateValue(value) {
   return "~" + value.div(100).integerValue().times(100).toString();
@@ -48,6 +49,7 @@ const osmosis: AppSpec<Transaction> = {
     model: DeviceModelId.nanoS,
     appName: "Cosmos",
   },
+  genericDeviceAction: acceptTransaction,
   testTimeout: 2 * 60 * 1000,
   transactionCheck: ({ maxSpendable }) => {
     invariant(maxSpendable.gt(minimalAmount), "balance is too low");
@@ -59,9 +61,11 @@ const osmosis: AppSpec<Transaction> = {
     if (allOperationsMatchingId.length > 1) {
       console.warn(allOperationsMatchingId);
     }
-    expect({ allOperationsMatchingId }).toEqual({
-      allOperationsMatchingId: [operation],
-    });
+    botTest("only one operation emerged on the tx id", () =>
+      expect({ allOperationsMatchingId }).toEqual({
+        allOperationsMatchingId: [operation],
+      })
+    );
     const opExpected: Record<string, any> = toOperationRaw({
       ...optimisticOperation,
     });
@@ -74,8 +78,12 @@ const osmosis: AppSpec<Transaction> = {
     delete opExpected.extra;
     delete opExpected.transactionSequenceNumber;
     const op = toOperationRaw(operation);
-    expect(op).toMatchObject(opExpected);
-    expect(approximateExtra(op.extra)).toMatchObject(approximateExtra(extra));
+    botTest("optimistic operation matches op", () =>
+      expect(op).toMatchObject(opExpected)
+    );
+    botTest("operation extra matches", () =>
+      expect(approximateExtra(op.extra)).toMatchObject(approximateExtra(extra))
+    );
   },
   mutations: [
     {

package/src/families/osmosis/speculos-deviceActions.ts

@@ -9,86 +9,85 @@ const typeWording = {
   claimReward: "Withdraw Reward",
   claimRewardCompound: "(not tested)",
 };
-const acceptTransaction: DeviceAction<Transaction, any> = deviceActionFlow({
-  steps: [
-    {
-      title: "Sequence",
-      button: "Rr",
-    },
-    {
-      title: "Chain ID",
-      button: "Rr",
-    },
-    {
-      title: "Account",
-      button: "Rr",
-    },
-    {
-      title: "Type",
-      button: "Rr",
-      expectedValue: ({ transaction }) => typeWording[transaction.mode],
-    },
-    {
-      title: "Validator Source",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.sourceValidator || "",
-    },
-    {
-      title: "Validator Dest",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.validators[0].address,
-    },
-    {
-      title: "Validator",
-      button: "Rr",
-      expectedValue: ({ transaction }, acc) =>
-        transaction.validators[
-          acc.filter((a) => a.title === "Validator").length
-        ].address,
-    },
-    {
-      title: "Memo",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.memo || "",
-    },
-    {
-      title: "Fee",
-      button: "Rr",
-    },
-    {
-      title: "Gas",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.gas?.toString() || "",
-    },
-    {
-      title: "Amount",
-      button: "Rr",
-    },
-    {
-      title: "From",
-      button: "Rr",
-      expectedValue: ({ account }) => account.freshAddress,
-    },
-    {
-      title: "To",
-      button: "Rr",
-      expectedValue: ({ transaction }) => transaction.recipient,
-    },
-    {
-      title: "Delegator",
-      button: "Rr",
-      expectedValue: ({ account }) => account.freshAddress,
-    },
-    {
-      title: "APPROVE",
-      button: "LRlr",
-      final: true,
-    },
-    {
-      title: "REJECT",
-    },
-  ],
-});
-export default {
-  acceptTransaction,
-};
+
+export const acceptTransaction: DeviceAction<Transaction, any> =
+  deviceActionFlow({
+    steps: [
+      {
+        title: "Sequence",
+        button: "Rr",
+      },
+      {
+        title: "Chain ID",
+        button: "Rr",
+      },
+      {
+        title: "Account",
+        button: "Rr",
+      },
+      {
+        title: "Type",
+        button: "Rr",
+        expectedValue: ({ transaction }) => typeWording[transaction.mode],
+      },
+      {
+        title: "Validator Source",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.sourceValidator || "",
+      },
+      {
+        title: "Validator Dest",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.validators[0].address,
+      },
+      {
+        title: "Validator",
+        button: "Rr",
+        expectedValue: ({ transaction }, acc) =>
+          transaction.validators[
+            acc.filter((a) => a.title === "Validator").length
+          ].address,
+      },
+      {
+        title: "Memo",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.memo || "",
+      },
+      {
+        title: "Fee",
+        button: "Rr",
+      },
+      {
+        title: "Gas",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.gas?.toString() || "",
+      },
+      {
+        title: "Amount",
+        button: "Rr",
+      },
+      {
+        title: "From",
+        button: "Rr",
+        expectedValue: ({ account }) => account.freshAddress,
+      },
+      {
+        title: "To",
+        button: "Rr",
+        expectedValue: ({ transaction }) => transaction.recipient,
+      },
+      {
+        title: "Delegator",
+        button: "Rr",
+        expectedValue: ({ account }) => account.freshAddress,
+      },
+      {
+        title: "APPROVE",
+        button: "LRlr",
+        final: true,
+      },
+      {
+        title: "REJECT",
+      },
+    ],
+  });

package/src/families/polkadot/platformAdapter.test.ts

@@ -0,0 +1,61 @@
+import dot from "./platformAdapter";
+import { PolkadotTransaction as PlatformTransaction } from "@ledgerhq/live-app-sdk";
+import { FAMILIES } from "@ledgerhq/live-app-sdk";
+import BigNumber from "bignumber.js";
+import { Transaction } from "./types";
+
+describe("getPlatformTransactionSignFlowInfos", () => {
+  describe("should properly get infos for DOT platform tx", () => {
+    it("with most basic tx", () => {
+      const dotPlatformTx: PlatformTransaction = {
+        family: FAMILIES.POLKADOT,
+        amount: new BigNumber(100000),
+        recipient: "0xABCDEF",
+        mode: "send",
+      };
+
+      const expectedLiveTx: Partial<Transaction> = {
+        family: dotPlatformTx.family,
+        amount: dotPlatformTx.amount,
+        recipient: dotPlatformTx.recipient,
+        mode: dotPlatformTx.mode,
+      };
+
+      const { canEditFees, hasFeesProvided, liveTx } =
+        dot.getPlatformTransactionSignFlowInfos(dotPlatformTx);
+
+      expect(canEditFees).toBe(false);
+
+      expect(hasFeesProvided).toBe(false);
+
+      expect(liveTx).toEqual(expectedLiveTx);
+    });
+
+    it("with era provided", () => {
+      const dotPlatformTx: PlatformTransaction = {
+        family: FAMILIES.POLKADOT,
+        amount: new BigNumber(100000),
+        recipient: "0xABCDEF",
+        mode: "send",
+        era: 1,
+      };
+
+      const expectedLiveTx: Partial<Transaction> = {
+        family: dotPlatformTx.family,
+        amount: dotPlatformTx.amount,
+        recipient: dotPlatformTx.recipient,
+        mode: dotPlatformTx.mode,
+        era: `${dotPlatformTx.era}`,
+      };
+
+      const { canEditFees, hasFeesProvided, liveTx } =
+        dot.getPlatformTransactionSignFlowInfos(dotPlatformTx);
+
+      expect(canEditFees).toBe(false);
+
+      expect(hasFeesProvided).toBe(false);
+
+      expect(liveTx).toEqual(expectedLiveTx);
+    });
+  });
+});

package/src/families/polkadot/specs.ts

@@ -9,7 +9,7 @@ import type {
   Transaction,
 } from "../../families/polkadot/types";
 import { getCryptoCurrencyById, parseCurrencyUnit } from "../../currencies";
-import { pickSiblings } from "../../bot/specs";
+import { botTest, pickSiblings } from "../../bot/specs";
 import type { AppSpec } from "../../bot/types";
 import { toOperationRaw } from "../../account";
 import {
@@ -18,8 +18,10 @@ import {
   canNominate,
   isFirstBond,
   hasMinimumBondBalance,
+  getMinimumBalance,
 } from "../../families/polkadot/logic";
 import { DeviceModelId } from "@ledgerhq/devices";
+import { acceptTransaction } from "./speculos-deviceActions";
 
 const maxAccounts = 32;
 const currency = getCryptoCurrencyById("polkadot");
@@ -28,6 +30,7 @@ const POLKADOT_MIN_SAFE = parseCurrencyUnit(currency.units[0], "0.1");
 // FIXME Should be replaced with EXISTENTIAL_DEPOSIT in logic.ts
 const EXISTENTIAL_DEPOSIT = parseCurrencyUnit(currency.units[0], "1.0");
 const MIN_LOCKED_BALANCE_REQ = parseCurrencyUnit(currency.units[0], "1.0");
+
 const polkadot: AppSpec<Transaction> = {
   name: "Polkadot",
   currency: getCryptoCurrencyById("polkadot"),
@@ -36,6 +39,7 @@ const polkadot: AppSpec<Transaction> = {
     appName: "Polkadot",
   },
   testTimeout: 2 * 60 * 1000,
+  genericDeviceAction: acceptTransaction,
   transactionCheck: ({ maxSpendable }) => {
     invariant(maxSpendable.gt(POLKADOT_MIN_SAFE), "balance is too low");
   },
@@ -48,7 +52,9 @@ const polkadot: AppSpec<Transaction> = {
     delete opExpected.date;
     delete opExpected.blockHash;
     delete opExpected.blockHeight;
-    expect(toOperationRaw(operation)).toMatchObject(opExpected);
+    botTest("optimistic operation matches", () =>
+      expect(toOperationRaw(operation)).toMatchObject(opExpected)
+    );
   },
   mutations: [
     {
@@ -71,6 +77,18 @@ const polkadot: AppSpec<Transaction> = {
           amount = EXISTENTIAL_DEPOSIT.plus(POLKADOT_MIN_SAFE);
         }
 
+        const minimumBalanceExistential = getMinimumBalance(account);
+        const leftover = account.spendableBalance.minus(
+          amount.plus(POLKADOT_MIN_SAFE)
+        );
+        if (
+          minimumBalanceExistential.gt(0) &&
+          leftover.lt(minimumBalanceExistential) &&
+          leftover.gt(0)
+        ) {
+          throw new Error("risk of PolkadotDoMaxSendInstead");
+        }
+
         return {
           transaction: bridge.createTransaction(account),
           updates: [