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

package/src/__tests__/test-helpers/setup.ts

@@ -1,9 +1,6 @@
-import winston from "winston";
-import { listen } from "@ledgerhq/logs";
+import "./environment";
+
 import BigNumber from "bignumber.js";
-import { setSupportedCurrencies } from "../../currencies";
-import { setPlatformVersion } from "../../platform/version";
-import { EnvName, setEnvUnsafe } from "../../env";
 
 jest.setTimeout(360000);
 
@@ -17,89 +14,3 @@ expect.extend({
     return { message, pass };
   },
 });
-
-setPlatformVersion("1.1.0");
-
-setSupportedCurrencies([
-  "bitcoin",
-  "ethereum",
-  "bsc",
-  "polygon",
-  "elrond",
-  "ripple",
-  "bitcoin_cash",
-  "litecoin",
-  "dash",
-  "ethereum_classic",
-  "tezos",
-  "qtum",
-  "zcash",
-  "bitcoin_gold",
-  "stratis",
-  "dogecoin",
-  "digibyte",
-  "komodo",
-  "pivx",
-  "zencash",
-  "vertcoin",
-  "peercoin",
-  "viacoin",
-  "stakenet",
-  "stealthcoin",
-  "decred",
-  "tron",
-  "stellar",
-  "cosmos",
-  "algorand",
-  "polkadot",
-  "bitcoin_testnet",
-  "ethereum_ropsten",
-  "ethereum_goerli",
-  "cosmos_testnet",
-  "crypto_org_croeseid",
-  "crypto_org",
-  "filecoin",
-  "solana",
-  "celo",
-  "hedera",
-  "cardano",
-  "cardano_testnet",
-  "osmosis",
-  "filecoin",
-]);
-
-for (const k in process.env) setEnvUnsafe(k as EnvName, process.env[k]);
-
-const { VERBOSE, VERBOSE_FILE } = process.env;
-const logger = winston.createLogger({
-  level: "debug",
-  transports: [],
-});
-const { format } = winston;
-const { combine, timestamp, json } = format;
-const winstonFormat = combine(timestamp(), json());
-
-if (VERBOSE_FILE) {
-  logger.add(
-    new winston.transports.File({
-      format: winstonFormat,
-      filename: VERBOSE_FILE,
-      level: "debug",
-    })
-  );
-}
-
-logger.add(
-  new winston.transports.Console({
-    format: winstonFormat,
-    silent: !VERBOSE,
-  })
-);
-// eslint-disable-next-line no-unused-vars
-listen(({ type, message, ...rest }) => {
-  logger.log("debug", {
-    message: type + (message ? ": " + message : ""),
-    // $FlowFixMe
-    ...rest,
-  });
-});

package/src/account/importAccounts.integration.test.ts

@@ -0,0 +1,193 @@
+import "../__tests__/test-helpers/setup";
+import { makeBridgeCacheSystem } from "../bridge/cache";
+import { accountToAccountData } from "../cross";
+import {
+  importAccountsMakeItems,
+  importAccountsReduce,
+  fromAccountRaw,
+  syncNewAccountsToImport,
+} from ".";
+import { Account } from "@ledgerhq/types-live";
+
+jest.setTimeout(200000);
+
+test("importAccounts with a set of real data", async () => {
+  const accounts = [
+    {
+      id: "js:2:algorand:32PI2C5HLHMVUF5KMNURLGCTYVIOVJJ2NLHLZ2PIMK567MKMS4RXBSVWQI:",
+      seedIdentifier:
+        "32PI2C5HLHMVUF5KMNURLGCTYVIOVJJ2NLHLZ2PIMK567MKMS4RXBSVWQI",
+      name: "Algorand legacy 32PI2C5H...RXBSVWQI",
+      starred: true,
+      used: true,
+      derivationMode: "",
+      index: 0,
+      freshAddress:
+        "32PI2C5HLHMVUF5KMNURLGCTYVIOVJJ2NLHLZ2PIMK567MKMS4RXBSVWQI",
+      freshAddressPath: "44'/283'/0'/0/0",
+      freshAddresses: [],
+      blockHeight: 23066613,
+      creationDate: "2022-02-04T13:12:58.000Z",
+      operationsCount: 184,
+      operations: [],
+      pendingOperations: [],
+      currencyId: "algorand",
+      unitMagnitude: 6,
+      lastSyncDate: "2022-08-26T09:24:27.076Z",
+      balance: "2100190",
+      spendableBalance: "190",
+      xpub: "32PI2C5HLHMVUF5KMNURLGCTYVIOVJJ2NLHLZ2PIMK567MKMS4RXBSVWQI",
+      subAccounts: [],
+      algorandResources: { rewards: "190", nbAssets: 20 },
+      swapHistory: [],
+    },
+    {
+      id: "js:2:tron:TRbtdwHowocq8ThZbRnTHgK4JG5sx3fFCK:",
+      seedIdentifier: "TRbtdwHowocq8ThZbRnTHgK4JG5sx3fFCK",
+      name: "Tron legacy TRbtdwHo...5sx3fFCK",
+      starred: true,
+      used: true,
+      derivationMode: "",
+      index: 0,
+      freshAddress: "TRbtdwHowocq8ThZbRnTHgK4JG5sx3fFCK",
+      freshAddressPath: "44'/195'/0'/0/0",
+      freshAddresses: [],
+      blockHeight: 43642499,
+      creationDate: "2022-07-19T15:32:12.000Z",
+      operationsCount: 41,
+      operations: [],
+      pendingOperations: [],
+      currencyId: "tron",
+      unitMagnitude: 6,
+      lastSyncDate: "2022-08-26T09:24:59.492Z",
+      balance: "0",
+      spendableBalance: "0",
+      xpub: "TRbtdwHowocq8ThZbRnTHgK4JG5sx3fFCK",
+      subAccounts: [],
+      tronResources: {
+        frozen: {},
+        delegatedFrozen: {},
+        votes: [],
+        tronPower: 0,
+        energy: "0",
+        bandwidth: {
+          freeUsed: "0",
+          freeLimit: "1500",
+          gainedUsed: "0",
+          gainedLimit: "0",
+        },
+        unwithdrawnReward: "2730",
+        lastVotedDate: "2022-07-22T14:39:51.000Z",
+        cacheTransactionInfoById: {},
+      },
+      swapHistory: [],
+    },
+    {
+      id: "js:2:polkadot:15jLBbe9LD6VSUYFkV5Fmo5LhZU5cns9E6g8qcDv5KrKM1eP:polkadotbip44",
+      seedIdentifier: "15jLBbe9LD6VSUYFkV5Fmo5LhZU5cns9E6g8qcDv5KrKM1eP",
+      name: "Polkadot polkadotbip44 15jLBbe9...5KrKM1eP",
+      starred: true,
+      used: true,
+      derivationMode: "polkadotbip44",
+      index: 0,
+      freshAddress: "15jLBbe9LD6VSUYFkV5Fmo5LhZU5cns9E6g8qcDv5KrKM1eP",
+      freshAddressPath: "44'/354'/0'/0'/0'",
+      freshAddresses: [],
+      blockHeight: 11771108,
+      creationDate: "2022-02-24T14:39:00.007Z",
+      operationsCount: 65,
+      operations: [],
+      pendingOperations: [],
+      currencyId: "polkadot",
+      unitMagnitude: 10,
+      lastSyncDate: "2022-08-26T09:25:00.713Z",
+      balance: "15512511464",
+      spendableBalance: "15512511464",
+      xpub: "15jLBbe9LD6VSUYFkV5Fmo5LhZU5cns9E6g8qcDv5KrKM1eP",
+      polkadotResources: {
+        controller: null,
+        stash: null,
+        nonce: 63,
+        lockedBalance: "0",
+        unlockedBalance: "0",
+        unlockingBalance: "0",
+        unlockings: [],
+        nominations: [],
+      },
+      swapHistory: [],
+    },
+    {
+      id: "js:2:bsc:0xa22CA840265d3C5CB1846e419B14c6a6CdD06FAB:",
+      seedIdentifier: "0xa22CA840265d3C5CB1846e419B14c6a6CdD06FAB",
+      name: "Binance Smart Chain legacy 0xa22CA8...CdD06FAB",
+      starred: true,
+      used: true,
+      derivationMode: "",
+      index: 0,
+      freshAddress: "0xa22CA840265d3C5CB1846e419B14c6a6CdD06FAB",
+      freshAddressPath: "44'/60'/0'/0/0",
+      freshAddresses: [],
+      blockHeight: 20775454,
+      syncHash: "[]_655",
+      creationDate: "2022-02-04T13:11:32.001Z",
+      operationsCount: 21,
+      operations: [],
+      pendingOperations: [],
+      currencyId: "bsc",
+      unitMagnitude: 18,
+      lastSyncDate: "2022-08-26T09:25:01.109Z",
+      balance: "3128019430408477",
+      spendableBalance: "3128019430408477",
+      xpub: "0xa22CA840265d3C5CB1846e419B14c6a6CdD06FAB",
+      subAccounts: [],
+      swapHistory: [],
+    },
+  ].map(fromAccountRaw);
+
+  const localCache = {};
+  const bridgeCache = makeBridgeCacheSystem({
+    saveData(c, d) {
+      localCache[c.id] = d;
+      return Promise.resolve();
+    },
+
+    getData(c) {
+      return Promise.resolve(localCache[c.id]);
+    },
+  });
+
+  const result = {
+    accounts: accounts.map(accountToAccountData),
+    settings: { currenciesSettings: {}, pairExchanges: {} },
+    meta: { exporterName: "Test", exporterVersion: "0" },
+  };
+
+  const accountsState = [];
+
+  const items = importAccountsMakeItems({
+    result,
+    accounts: accountsState,
+  });
+  const selectedAccounts = accounts.map((a) => a.id);
+  const syncResult = await syncNewAccountsToImport(
+    { items, selectedAccounts },
+    bridgeCache
+  );
+  const reduced = importAccountsReduce(accountsState, {
+    items,
+    selectedAccounts,
+    syncResult,
+  });
+  expect(reduced.length).toEqual(4);
+  expect((reduced[0] as AlgorandAccount).algorandResources).toBeDefined();
+  expect((reduced[1] as TronAccount).tronResources).toBeDefined();
+  expect((reduced[2] as PolkadotAccount).polkadotResources).toBeDefined();
+  expect(reduced[0].operations.length).toBeGreaterThan(1);
+  expect(reduced[1].operations.length).toBeGreaterThan(1);
+  expect(reduced[2].operations.length).toBeGreaterThan(1);
+  expect(reduced[3].operations.length).toBeGreaterThan(1);
+});
+
+type AlgorandAccount = Account & { algorandResources: any };
+type TronAccount = Account & { tronResources: any };
+type PolkadotAccount = Account & { polkadotResources: any };

package/src/{__tests__/accounts/importAccounts.ts → account/importAccounts.test.ts}

@@ -3,16 +3,15 @@ import {
   importAccountsMakeItems,
   importAccountsReduce,
   fromAccountRaw,
-} from "../../account";
-import { setSupportedCurrencies } from "../../currencies";
-import { setPlatformVersion } from "../../platform/version";
+} from ".";
+import { setSupportedCurrencies } from "../currencies";
+import { setPlatformVersion } from "../platform/version";
 
 setPlatformVersion("1.1.0");
 
 setSupportedCurrencies(["ethereum"]);
 describe("importAccountsMakeItems", () => {
-  // TODO we need to change the dataset as we no longer are migrating away from JS to Libcore but kinda the reverse
-  test.skip("should migrate ethereum accounts", () => {
+  test("importing ethereum accounts", () => {
     const result = {
       meta: {
         exporterName: "desktop",
@@ -20,7 +19,7 @@ describe("importAccountsMakeItems", () => {
       },
       accounts: [
         {
-          id: "libcore:1:ethereum:xpub1:",
+          id: "js:1:ethereum:0x01:",
           name: "Ethereum 1",
           seedIdentifier: "seed",
           derivationMode: "",
@@ -31,7 +30,7 @@ describe("importAccountsMakeItems", () => {
           swapHistory: [],
         },
         {
-          id: "libcore:1:ethereum:xpub2:",
+          id: "js:1:ethereum:0x02:",
           name: "Ethereum 2",
           seedIdentifier: "seed",
           derivationMode: "",
@@ -42,7 +41,7 @@ describe("importAccountsMakeItems", () => {
           swapHistory: [],
         },
         {
-          id: "libcore:1:ethereum:xpub4:",
+          id: "js:1:ethereum:0x04:",
           name: "Ethereum 4",
           seedIdentifier: "seed",
           derivationMode: "",
@@ -53,7 +52,7 @@ describe("importAccountsMakeItems", () => {
           swapHistory: [],
         },
         {
-          id: "libcore:1:ethereum:xpub3:",
+          id: "js:1:ethereum:0x03:",
           name: "ETH3 name edited",
           seedIdentifier: "seed",
           derivationMode: "",
@@ -64,7 +63,7 @@ describe("importAccountsMakeItems", () => {
           swapHistory: [],
         },
         {
-          id: "libcore:1:ethereum:xpub5:",
+          id: "js:1:ethereum:0x05:",
           name: "Ethereum 5",
           seedIdentifier: "seed",
           derivationMode: "",
@@ -84,7 +83,7 @@ describe("importAccountsMakeItems", () => {
     };
     const accounts = [
       <AccountRaw>{
-        id: "ethereumjs:2:ethereum:0x01:",
+        id: "js:1:ethereum:0x01:",
         seedIdentifier: "0x01",
         name: "Ethereum 1",
         derivationMode: "",
@@ -101,7 +100,7 @@ describe("importAccountsMakeItems", () => {
         balance: "51281813126095910",
       },
       <AccountRaw>{
-        id: "ethereumjs:2:ethereum:0x02:",
+        id: "js:1:ethereum:0x02:",
         seedIdentifier: "0x02",
         name: "Ethereum 2",
         derivationMode: "",
@@ -118,7 +117,7 @@ describe("importAccountsMakeItems", () => {
         balance: "1081392000000000",
       },
       <AccountRaw>{
-        id: "libcore:1:ethereum:xpub3:",
+        id: "js:1:ethereum:0x03:",
         seedIdentifier: "seed",
         name: "Ethereum 3",
         derivationMode: "",
@@ -141,71 +140,52 @@ describe("importAccountsMakeItems", () => {
     });
     expect(items).toMatchObject([
       {
-        initialAccountId: "libcore:1:ethereum:xpub4:",
-        account: {
-          id: "libcore:1:ethereum:xpub4:",
-          name: "Ethereum 4",
-        },
+        initialAccountId: "js:1:ethereum:0x04:",
+        account: { id: "js:1:ethereum:0x04:", name: "Ethereum 4" },
         mode: "create",
       },
       {
-        initialAccountId: "libcore:1:ethereum:xpub5:",
-        account: {
-          id: "libcore:1:ethereum:xpub5:",
-          name: "Ethereum 5",
-        },
+        initialAccountId: "js:1:ethereum:0x05:",
+        account: { id: "js:1:ethereum:0x05:", name: "Ethereum 5" },
         mode: "create",
       },
       {
-        initialAccountId: "ethereumjs:2:ethereum:0x01:",
-        account: {
-          id: "libcore:1:ethereum:xpub1:",
-          name: "Ethereum 1",
-        },
+        initialAccountId: "js:1:ethereum:0x03:",
+        account: { id: "js:1:ethereum:0x03:", name: "ETH3 name edited" },
         mode: "update",
       },
       {
-        initialAccountId: "ethereumjs:2:ethereum:0x02:",
-        account: {
-          id: "libcore:1:ethereum:xpub2:",
-          name: "Ethereum 2",
-        },
-        mode: "update",
+        initialAccountId: "js:1:ethereum:0x01:",
+        account: { id: "js:1:ethereum:0x01:", name: "Ethereum 1" },
+        mode: "id",
       },
       {
-        initialAccountId: "libcore:1:ethereum:xpub3:",
-        account: {
-          id: "libcore:1:ethereum:xpub3:",
-          name: "ETH3 name edited",
-        },
-        mode: "update",
+        initialAccountId: "js:1:ethereum:0x02:",
+        account: { id: "js:1:ethereum:0x02:", name: "Ethereum 2" },
+        mode: "id",
       },
     ]);
+    const syncResult = {
+      failed: {},
+      synchronized: {},
+    };
+    result.accounts.forEach((a) => {
+      syncResult.synchronized[a.id] = a;
+    });
     const reduced = importAccountsReduce(accounts, {
       items,
       selectedAccounts: [
-        "libcore:1:ethereum:xpub3:",
-        "libcore:1:ethereum:xpub2:",
-        "libcore:1:ethereum:xpub5:",
+        "js:1:ethereum:0x03:",
+        "js:1:ethereum:0x02:",
+        "js:1:ethereum:0x05:",
       ],
+      syncResult,
     });
     expect(reduced).toMatchObject([
-      {
-        id: "ethereumjs:2:ethereum:0x01:",
-        name: "Ethereum 1",
-      },
-      {
-        id: "libcore:1:ethereum:xpub2:",
-        name: "Ethereum 2",
-      },
-      {
-        id: "libcore:1:ethereum:xpub3:",
-        name: "ETH3 name edited",
-      },
-      {
-        id: "libcore:1:ethereum:xpub5:",
-        name: "Ethereum 5",
-      },
+      { id: "js:1:ethereum:0x01:", name: "Ethereum 1" },
+      { id: "js:1:ethereum:0x02:", name: "Ethereum 2" },
+      { id: "js:1:ethereum:0x03:", name: "ETH3 name edited" },
+      { id: "js:1:ethereum:0x05:", name: "Ethereum 5" },
     ]);
   });
 });

package/src/account/importAccounts.ts

@@ -5,6 +5,13 @@ import { findAccountMigration, checkAccountSupported } from "./support";
 import joinSwapHistories from "../exchange/swap/joinSwapHistories";
 import isEqual from "lodash/isEqual";
 import type { Account } from "@ledgerhq/types-live";
+import { BridgeCacheSystem } from "../bridge/cache";
+import { getAccountBridge } from "../bridge";
+import { promiseAllBatched } from "../promise";
+import { getEnv } from "../env";
+import { Observable } from "rxjs";
+import { reduce } from "rxjs/operators";
+
 const itemModeDisplaySort = {
   create: 1,
   update: 2,
@@ -103,31 +110,115 @@ export const importAccountsMakeItems = ({
         itemModeDisplaySort[(a as ImportItem).mode] -
         itemModeDisplaySort[(b as ImportItem).mode]
     ) as ImportItem[];
+
+/**
+ * SyncNewAccountsOutput
+ * - synchronized: a map of account id to account. the account id are kept as originally set in the items[].account before a possible "remap" of the ids after a sync happened
+ * - failed: a map of account id to errors for all possible fails that happened.
+ */
+export type SyncNewAccountsOutput = {
+  synchronized: Record<string, Account>;
+  failed: Record<string, Error>;
+};
+
+export type SyncNewAccountsInput = {
+  items: ImportItem[];
+  selectedAccounts: string[];
+};
+
+/**
+ *
+ * @param items: result of importAccountsMakeItems
+ * @param selectedAccounts: user's selected accounts
+ * @param bridgeCache: the bridge cache created on user land to prepare currency for a sync
+ * @param blacklistedTokenIds: the list of blacklisted token ids to ignore sync with
+ * @returns SyncNewAccountsOutput
+ */
+export const syncNewAccountsToImport = async (
+  { items, selectedAccounts }: SyncNewAccountsInput,
+  bridgeCache: BridgeCacheSystem,
+  blacklistedTokenIds?: string[]
+): Promise<SyncNewAccountsOutput> => {
+  const selectedItems = items.filter((item) =>
+    selectedAccounts.includes(item.account.id)
+  );
+  const synchronized = {};
+  const failed = {};
+  await promiseAllBatched(
+    getEnv("SYNC_MAX_CONCURRENT"),
+    selectedItems,
+    async ({ account }) => {
+      try {
+        const bridge = getAccountBridge(account);
+        await bridgeCache.prepareCurrency(account.currency);
+        const syncConfig = {
+          paginationConfig: {},
+          blacklistedTokenIds,
+        };
+        const observable = bridge.sync(account, syncConfig);
+        const reduced: Observable<Account> = observable.pipe(
+          reduce((a, f: (_: Account) => Account) => f(a), account)
+        );
+        const synced = await reduced.toPromise();
+        synchronized[account.id] = synced;
+      } catch (e) {
+        failed[account.id] = e;
+      }
+    }
+  );
+  return { synchronized, failed };
+};
+
+export type ImportAccountsReduceInput = {
+  items: ImportItem[];
+  selectedAccounts: string[];
+  syncResult: SyncNewAccountsOutput;
+};
+
+/**
+ *
+ * @param existingAccounts
+ * @param items: value resulting of importAccountsMakeItems
+ * @params selectedAccounts: array of all account ids selected by user for import
+ * @param syncedNewAccounts: accounts resulting of syncNewAccountsToImport(). all accounts that would be missing from that list would be ignored to be imported (fresh sync is needed to make sure the accounts are "ready")
+ * @returns all accounts
+ */
 export const importAccountsReduce = (
   existingAccounts: Account[],
-  {
-    items,
-    selectedAccounts,
-  }: {
-    items: ImportItem[];
-    selectedAccounts: string[];
-  }
+  { items, selectedAccounts, syncResult }: ImportAccountsReduceInput
 ): Account[] => {
   const accounts = existingAccounts.slice(0);
   const selectedItems = items.filter((item) =>
     selectedAccounts.includes(item.account.id)
   );
 
-  for (const { mode, account, initialAccountId } of selectedItems) {
+  for (const {
+    mode,
+    account: { id },
+    initialAccountId,
+  } of selectedItems) {
+    const account = syncResult.synchronized[id];
+    if (!account) continue;
     switch (mode) {
-      case "create":
-        accounts.push(account);
+      case "create": {
+        const exists = accounts.find(
+          (a) => a.id === initialAccountId || a.id === id
+        );
+        if (!exists) {
+          // prevent duplicate cases to happen (in case of race condition)
+          accounts.push(account);
+        }
         break;
+      }
 
       case "update": {
-        const item = accounts.find((a) => a.id === initialAccountId);
+        const item = accounts.find(
+          (a) => a.id === initialAccountId || a.id === id
+        );
         const i = accounts.indexOf(item as Account);
-        accounts[i] = account;
+        if (i !== -1) {
+          accounts[i] = account;
+        }
         break;
       }