LL-4373 Discard existing ops on sync if blacklist has changed (#1010)

* LL-4373 Discard existing ops on sync if blacklist has changed

Add testing for blacklisted feature

* update tests

* snapshot

Co-authored-by: Gaëtan Renaudeau <[email protected]>

src/__tests__/currencies.js

@@ -58,8 +58,8 @@ test("sort by marketcap", () => {
     "bitcoin",
     "ethereum",
     "ethereum/erc20/0x_project",
-    "stealthcoin",
     "ethereum/erc20/holotoken",
+    "stealthcoin",
     "ethereum/erc20/hydro_protocol",
     "ethereum/erc20/xensor",
   ]);

src/__tests__/test-helpers/libcore-setup.js

@@ -5,8 +5,6 @@ import "./setup";
 import { setEnvUnsafe } from "../../env";
 import implementLibcore from "../../libcore/platforms/nodejs";
 
-jest.setTimeout(180000);
-
 let setupCalled = null;
 export const setup = (testId) => {
   if (setupCalled) {

src/__tests__/test-helpers/libcore-setup.native.js

@@ -3,8 +3,6 @@ import { listen } from "@ledgerhq/logs";
 import "./setup";
 import "./implement-react-native-libcore";
 
-jest.setTimeout(180000);
-
 export const setup = (testName) => {
   global._JEST_SETUP(testName);
 };

src/__tests__/test-helpers/setup.js

@@ -1,5 +1,7 @@
 import { setSupportedCurrencies } from "../../currencies";
 
+jest.setTimeout(180000);
+
 setSupportedCurrencies([
   "bitcoin",
   "ethereum",

src/account/serialization.js

@@ -579,6 +579,7 @@ export function fromAccountRaw(rawAccount: AccountRaw): Account {
     bitcoinResources,
     swapHistory,
     algorandResources,
+    blacklistedTokensCache,
     polkadotResources,
   } = rawAccount;
 
@@ -632,6 +633,7 @@ export function fromAccountRaw(rawAccount: AccountRaw): Account {
     currency,
     lastSyncDate: new Date(lastSyncDate || 0),
     swapHistory: [],
+    blacklistedTokensCache,
   };
 
   if (xpub) {
@@ -701,6 +703,7 @@ export function toAccountRaw({
   bitcoinResources,
   swapHistory,
   algorandResources,
+  blacklistedTokensCache,
   polkadotResources,
 }: Account): AccountRaw {
   const res: $Exact<AccountRaw> = {
@@ -714,6 +717,7 @@ export function toAccountRaw({
     freshAddressPath,
     freshAddresses,
     blockHeight,
+    blacklistedTokensCache,
     creationDate: creationDate.toISOString(),
     operationsCount,
     operations: (operations || []).map((o) => toOperationRaw(o)),

src/families/ethereum/modules/compound.resilience.test.js

@@ -1,14 +1,13 @@
 // @flow
+import "../../../__tests__/test-helpers/setup";
 import { reduce } from "rxjs/operators";
-import { setSupportedCurrencies } from "../../../currencies";
 import { fromAccountRaw, toAccountRaw } from "../../../account";
 import type { Account } from "../../../types";
 import { getAccountBridge } from "../../../bridge";
 import { makeBridgeCacheSystem } from "../../../bridge/cache";
 import { ethereum1 } from "../test-dataset";
 import { setEnv } from "../../../env";
 
-setSupportedCurrencies(["ethereum"]);
 setEnv("COMPOUND_API", "https://status.ledger.com"); // hack to hit an endpoint that actually is going to 404
 
 test("if API is down, an account still sync fine", async () => {

src/families/ethereum/synchronisation.js

@@ -34,10 +34,16 @@ export const getAccountShape: GetAccountShape = async (
 
   // fetch transactions, incrementally if possible
   const mostRecentStableOperation = initialStableOperations[0];
+
+  const newBlacklistedTokensCache = JSON.stringify(blacklistedTokenIds || []);
+  const outdatedBlacklist =
+    initialAccount?.blacklistedTokensCache !== newBlacklistedTokensCache;
+
   let pullFromBlockHash =
     initialAccount &&
     areAllOperationsLoaded(initialAccount) &&
-    mostRecentStableOperation
+    mostRecentStableOperation &&
+    !outdatedBlacklist
       ? mostRecentStableOperation.blockHash
       : undefined;
 
@@ -159,6 +165,7 @@ export const getAccountShape: GetAccountShape = async (
     blockHeight,
     lastSyncDate: new Date(),
     balanceHistory: undefined,
+    blacklistedTokensCache: newBlacklistedTokensCache,
   };
 
   return accountShape;

src/families/ethereum/synchronisation.test.js

@@ -0,0 +1,95 @@
+// @flow
+import "../../__tests__/test-helpers/setup";
+import { reduce } from "rxjs/operators";
+import { fromAccountRaw } from "../../account";
+import { getAccountCurrency } from "../../account/helpers";
+import type { Account } from "../../types";
+import { getAccountBridge } from "../../bridge";
+import { makeBridgeCacheSystem } from "../../bridge/cache";
+import { ethereum1 } from "./test-dataset";
+
+describe("blacklistedTokenIds functionality", () => {
+  const account = fromAccountRaw(ethereum1);
+  let localCache = {};
+  const cache = makeBridgeCacheSystem({
+    saveData(c, d) {
+      localCache[c.id] = d;
+      return Promise.resolve();
+    },
+    getData(c) {
+      return Promise.resolve(localCache[c.id]);
+    },
+  });
+
+  test("initial raw account contains no token accounts", async () => {
+    await cache.prepareCurrency(account.currency);
+    expect(ethereum1.subAccounts?.length).toBeFalsy();
+  });
+
+  test("sync finds tokens, but not blacklisted ones", async () => {
+    const bridge = getAccountBridge(account);
+    const blacklistedTokenIds = ["ethereum/erc20/weth"];
+    const synced = await bridge
+      .sync(account, {
+        paginationConfig: {},
+        blacklistedTokenIds,
+      })
+      .pipe(reduce((a, f: (Account) => Account) => f(a), account))
+      .toPromise();
+
+    // Contains token accounts
+    expect(synced.subAccounts?.length).toBeTruthy();
+
+    // Contains a known token
+    expect(
+      synced.subAccounts.find(
+        (a) => getAccountCurrency(a)?.id === "ethereum/erc20/0x_project"
+      )
+    ).toBeTruthy();
+
+    // Does not contain a blacklisted token
+    expect(
+      synced.subAccounts.find((a) =>
+        blacklistedTokenIds.includes(getAccountCurrency(a)?.id)
+      )
+    ).toBe(undefined);
+  });
+
+  test("account resyncs tokens if no longer blacklisted", async () => {
+    const bridge = getAccountBridge(account);
+    const blacklistedTokenIds = ["ethereum/erc20/weth"];
+    const syncedWithoutWeth = await bridge
+      .sync(account, {
+        paginationConfig: {},
+        blacklistedTokenIds,
+      })
+      .pipe(reduce((a, f: (Account) => Account) => f(a), account))
+      .toPromise();
+
+    // Contains token accounts
+    expect(syncedWithoutWeth.subAccounts?.length).toBeTruthy();
+
+    // Does not contain a blacklisted token
+    expect(
+      syncedWithoutWeth.subAccounts.find((a) =>
+        blacklistedTokenIds.includes(getAccountCurrency(a)?.id)
+      )
+    ).toBe(undefined);
+
+    //Sync again with `syncedWithoutWeth` as a base but without it being blacklisted
+    const synced = await bridge
+      .sync(account, {
+        paginationConfig: {},
+        blacklistedTokenIds: ["ethereum/erc20/somethingElse"],
+      })
+      .pipe(reduce((a, f: (Account) => Account) => f(a), account))
+      .toPromise();
+
+    // Does not contain a blacklisted token
+    expect(
+      synced.subAccounts.find(
+        (a) => getAccountCurrency(a)?.id === "ethereum/erc20/weth"
+      )
+    ).toBeTruthy();
+  });
+});

src/reconciliation.js

@@ -261,6 +261,11 @@ export function patchAccount(
     changed = true;
   }
 
+  if (account.blacklistedTokensCache !== updatedRaw.blacklistedTokensCache) {
+    next.blacklistedTokensCache = updatedRaw.blacklistedTokensCache;
+    changed = true;
+  }
+
   if (
     updatedRaw.tronResources &&
     account.tronResources !== updatedRaw.tronResources

src/types/account.js

@@ -199,6 +199,9 @@ export type Account = {
 
   // Swap operations linked to this account
   swapHistory: SwapOperation[],
+
+  // Hash used to discard tx history on sync if blacklisted token ids change
+  blacklistedTokensCache?: string,
 };
 
 export type SubAccount = TokenAccount | ChildAccount;
@@ -279,6 +282,7 @@ export type AccountRaw = {
   polkadotResources?: PolkadotResourcesRaw,
   // Swap operations linked to this account
   swapHistory?: SwapOperationRaw[],
+  blacklistedTokensCache?: string,
 };
 
 export type SubAccountRaw = TokenAccountRaw | ChildAccountRaw;