@ledgerhq/live-common 21.19.0 → 21.19.4

package/src/env.ts

@@ -381,6 +381,11 @@ const envDefinitions = {
     parser: boolParser,
     desc: "synchronizing nfts",
   },
+  NFT_CURRENCIES: {
+    def: "ethereum",
+    parser: stringParser,
+    desc: "set the currencies where NFT is active",
+  },
   NFT_ETH_METADATA_SERVICE: {
     // FIXME LL-8001
     def: "https://nft.staging.aws.ledger.fr/v1/ethereum/1/contracts/tokens/infos",

package/src/families/bitcoin/test-dataset.ts

@@ -1,6 +1,6 @@
 import type { DatasetTest } from "../../types";
 import type { Transaction } from "./types";
-import bitcoin_cash from "./datasets/bitcoin_cash";
+// import bitcoin_cash from "./datasets/bitcoin_cash";
 // import bitcoin_gold from "./datasets/bitcoin_gold";
 import bitcoin from "./datasets/bitcoin";
 import dash from "./datasets/dash";
@@ -21,7 +21,7 @@ const dataset: DatasetTest<Transaction> = {
   implementations: ["js", "libcore", "mock"],
   currencies: {
     bitcoin,
-    bitcoin_cash,
+    // bitcoin_cash,
     // bitcoin_gold,
     dash,
     // decred, // BACK-2443

package/src/families/ethereum/bridge/js.ts

@@ -24,11 +24,16 @@ import {
   estimateGasLimit,
 } from "../transaction";
 import { getAccountShape } from "../synchronisation";
-import { preload, hydrate } from "../modules";
+import {
+  preload,
+  hydrate,
+  prepareTransaction as prepareTransactionModules,
+} from "../modules";
 import { signOperation } from "../signOperation";
 import { modes } from "../modules";
 import postSyncPatch from "../postSyncPatch";
 import { inferDynamicRange } from "../../../range";
+
 const receive = makeAccountBridgeReceive();
 
 const broadcast = async ({
@@ -173,6 +178,8 @@ const prepareTransaction = async (a, t: Transaction): Promise<Transaction> => {
     t.estimatedGasLimit = estimatedGasLimit;
   }
 
+  t = await prepareTransactionModules(a, t);
+
   return t;
 };
 

package/src/families/ethereum/modules/erc1155.ts

@@ -9,6 +9,7 @@ import {
 import { validateRecipient } from "../transaction";
 import type { ModeModule, Transaction } from "../types";
 import type { Account } from "../../../types";
+import { prepareTransaction } from "./erc721";
 
 const notOwnedNft = createCustomErrorClass("NotOwnedNft");
 const notEnoughNftOwned = createCustomErrorClass("NotEnoughNftOwned");
@@ -75,25 +76,37 @@ const erc1155Transfer: ModeModule = {
     fields.push({
       type: "text",
       label: "Type",
-      value: `ERC721.transfer`,
+      value: `NFT Transfer`,
     });
 
     fields.push({
       type: "text",
-      label: "Collection",
-      value: input.transaction.collection ?? "",
+      label: "To",
+      value: input.transaction.recipient ?? "",
     });
 
     fields.push({
       type: "text",
-      label: "Token IDs",
-      value: input.transaction.tokenIds?.join(",") ?? "",
+      label: "Collection Name",
+      value: input.transaction.collectionName || "",
     });
 
     fields.push({
       type: "text",
-      label: "Quantities",
-      value: input.transaction.quantities?.join(",") ?? "",
+      label: "Quantity",
+      value: input.transaction.quantities?.[0]?.toFixed() ?? "",
+    });
+
+    fields.push({
+      type: "address",
+      label: "NFT Address",
+      address: input.transaction.collection ?? "",
+    });
+
+    fields.push({
+      type: "text",
+      label: "NFT ID",
+      value: input.transaction.tokenIds?.[0] ?? "",
     });
   },
 
@@ -107,6 +120,8 @@ const erc1155Transfer: ModeModule = {
       approving: true, // workaround to track the status ENABLING
     };
   },
+
+  prepareTransaction,
 };
 
 function serializeTransactionData(

package/src/families/ethereum/modules/erc721.ts

@@ -9,11 +9,35 @@ import {
 import { validateRecipient } from "../transaction";
 import type { ModeModule, Transaction } from "../types";
 import type { Account } from "../../../types";
+import { apiForCurrency } from "../../../api/Ethereum";
 
 const notOwnedNft = createCustomErrorClass("NotOwnedNft");
 
 export type Modes = "erc721.transfer";
 
+export async function prepareTransaction(
+  account: Account,
+  transaction: Transaction
+): Promise<Transaction> {
+  let t = transaction;
+  const { collection, collectionName, tokenIds } = transaction;
+  if (collection && tokenIds && typeof collectionName === "undefined") {
+    const api = apiForCurrency(account.currency);
+    const [{ status, result }] = await api.getNFTMetadata([
+      {
+        contract: collection,
+        tokenId: tokenIds[0],
+      },
+    ]);
+    let collectionName = ""; // default value fallback if issue
+    if (status === 200) {
+      collectionName = result?.tokenName || "";
+    }
+    t = { ...t, collectionName };
+  }
+  return Promise.resolve(t);
+}
+
 const erc721Transfer: ModeModule = {
   /**
    * Tx data is filled during the buildEthereumTx
@@ -52,6 +76,8 @@ const erc721Transfer: ModeModule = {
     }
   },
 
+  prepareTransaction,
+
   /**
    * This will only be used by LLM & LLD, not the HW.
    */
@@ -59,18 +85,30 @@ const erc721Transfer: ModeModule = {
     fields.push({
       type: "text",
       label: "Type",
-      value: `ERC721.transfer`,
+      value: `NFT Transfer`,
     });
 
     fields.push({
       type: "text",
-      label: "Collection",
-      value: input.transaction.collection ?? "",
+      label: "To",
+      value: input.transaction.recipient ?? "",
+    });
+
+    fields.push({
+      type: "text",
+      label: "Collection Name",
+      value: input.transaction.collectionName || "",
+    });
+
+    fields.push({
+      type: "address",
+      label: "NFT Address",
+      address: input.transaction.collection ?? "",
     });
 
     fields.push({
       type: "text",
-      label: "Token ID",
+      label: "NFT ID",
       value: input.transaction.tokenIds?.[0] ?? "",
     });
   },

package/src/families/ethereum/modules/index.ts

@@ -90,6 +90,14 @@ export type ModeModule = {
     arg1: Transaction,
     arg2: Operation
   ) => void;
+
+  /**
+   * hook to resolve a transaction like the prepareTransaction of the bridge
+   */
+  prepareTransaction?: (
+    account: Account,
+    transaction: Transaction
+  ) => Promise<Transaction>;
 };
 export const modes: Record<TransactionMode, ModeModule> = {} as Record<
   TransactionMode,
@@ -137,6 +145,18 @@ export function hydrate(value: unknown, currency: CryptoCurrency): void {
     }
   }
 }
+export const prepareTransaction = (
+  account: Account,
+  transaction: Transaction
+): Promise<Transaction> =>
+  values(modules)
+    // @ts-expect-error some module implement it
+    .map((m) => m.prepareTransaction)
+    .filter(Boolean)
+    .reduce(
+      (p, fn) => p.then((t) => fn(account, t)),
+      Promise.resolve(transaction)
+    );
 export const prepareTokenAccounts = (
   currency: CryptoCurrency,
   subAccounts: TokenAccount[],

package/src/families/ethereum/nft.test.ts

@@ -1,11 +1,16 @@
 import "../../__tests__/test-helpers/setup";
+import BigNumber from "bignumber.js";
 import { reduce } from "rxjs/operators";
-import { fromAccountRaw, toAccountRaw } from "../../account";
-import type { Account, AccountRaw } from "../../types";
+import { fromAccountRaw, toAccountRaw, toNFTRaw } from "../../account";
+import type { Account, AccountRaw, NFT } from "../../types";
 import { getAccountBridge } from "../../bridge";
 import { makeBridgeCacheSystem } from "../../bridge/cache";
 import { patchAccount } from "../../reconciliation";
 import { setEnv } from "../../env";
+import { mergeNfts } from "../../bridge/jsHelpers";
+import { encodeNftId } from "../../nft";
+
+jest.setTimeout(120000);
 
 const gaspardAccount: AccountRaw = {
   id: "js:1:ethereum:0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a:",
@@ -26,32 +31,146 @@ const gaspardAccount: AccountRaw = {
   xpub: "",
 };
 
-describe("nft reconciliation", () => {
-  let account = fromAccountRaw(gaspardAccount);
-  const localCache = {};
-  const cache = makeBridgeCacheSystem({
-    saveData(c, d) {
-      localCache[c.id] = d;
-      return Promise.resolve();
-    },
-    getData(c) {
-      return Promise.resolve(localCache[c.id]);
+/*
+const gaspardPolygonAccount: AccountRaw = {
+  id: "js:1:polygon:0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a:",
+  seedIdentifier: "0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a",
+  name: "G4sp4rd",
+  derivationMode: "",
+  index: 0,
+  freshAddress: "0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a",
+  freshAddressPath: "44'/60'/0'/0/0",
+  freshAddresses: [],
+  pendingOperations: [],
+  operations: [],
+  currencyId: "polygon",
+  unitMagnitude: 18,
+  balance: "",
+  blockHeight: 0,
+  lastSyncDate: "",
+  xpub: "",
+};
+*/
+
+const gaspardBscAccount: AccountRaw = {
+  id: "js:1:bsc:0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a:",
+  seedIdentifier: "0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a",
+  name: "G4sp4rd",
+  derivationMode: "",
+  index: 0,
+  freshAddress: "0xb98d10d9f6d07ba283bfd21b2dfec050f9ae282a",
+  freshAddressPath: "44'/60'/0'/0/0",
+  freshAddresses: [],
+  pendingOperations: [],
+  operations: [],
+  currencyId: "bsc",
+  unitMagnitude: 18,
+  balance: "",
+  blockHeight: 0,
+  lastSyncDate: "",
+  xpub: "",
+};
+
+async function sync(account, withNFT = true) {
+  const bridge = getAccountBridge(account);
+  const blacklistedTokenIds = [];
+  setEnv("NFT", withNFT);
+  const r = await bridge
+    .sync(account, {
+      paginationConfig: {},
+      blacklistedTokenIds,
+    })
+    .pipe(reduce((a, f: (arg0: Account) => Account) => f(a), account))
+    .toPromise();
+  setEnv("NFT", false);
+  return r;
+}
+
+const localCache = {};
+const cache = makeBridgeCacheSystem({
+  saveData(c, d) {
+    localCache[c.id] = d;
+    return Promise.resolve();
+  },
+  getData(c) {
+    return Promise.resolve(localCache[c.id]);
+  },
+});
+
+describe("nft merging", () => {
+  const makeNFT = (tokenId: string, contract: string, amount: number): NFT => ({
+    id: encodeNftId("test", contract, tokenId),
+    tokenId,
+    amount: new BigNumber(amount),
+    collection: {
+      contract,
+      standard: "erc721",
     },
   });
-  const bridge = getAccountBridge(account);
-  async function sync(account) {
-    const blacklistedTokenIds = [];
-    setEnv("NFT", true);
-    const r = await bridge
-      .sync(account, {
-        paginationConfig: {},
-        blacklistedTokenIds,
-      })
-      .pipe(reduce((a, f: (arg0: Account) => Account) => f(a), account))
-      .toPromise();
-    setEnv("NFT", false);
-    return r;
-  }
+  const oldNfts = [
+    makeNFT("1", "contract1", 10),
+    makeNFT("2", "contract1", 1),
+    makeNFT("3", "contract2", 6),
+  ];
+
+  test("should remove first NFT and return new array with same refs", () => {
+    const nfts = [makeNFT("2", "contract1", 1), makeNFT("3", "contract2", 6)];
+    const newNfts = mergeNfts(oldNfts, nfts);
+
+    expect(newNfts.map(toNFTRaw)).toEqual(nfts.map(toNFTRaw));
+    expect(oldNfts[1]).toBe(newNfts[0]);
+    expect(oldNfts[2]).toBe(newNfts[1]);
+  });
+
+  test("should remove any NFT and return new array with same refs", () => {
+    const nfts = [makeNFT("1", "contract1", 10), makeNFT("3", "contract2", 6)];
+    const newNfts = mergeNfts(oldNfts, nfts);
+
+    expect(newNfts.map(toNFTRaw)).toEqual(nfts.map(toNFTRaw));
+    expect(oldNfts[0]).toBe(newNfts[0]);
+    expect(oldNfts[2]).toBe(newNfts[1]);
+  });
+
+  test("should change NFT amount and return new array with new ref", () => {
+    const nfts = [
+      makeNFT("1", "contract1", 10),
+      makeNFT("2", "contract1", 5),
+      makeNFT("3", "contract2", 6),
+    ];
+    const addToNft1 = mergeNfts(oldNfts, nfts);
+
+    expect(addToNft1.map(toNFTRaw)).toEqual(nfts.map(toNFTRaw));
+    expect(oldNfts[0]).toBe(addToNft1[0]);
+    expect(oldNfts[1]).not.toBe(addToNft1[1]);
+    expect(oldNfts[2]).toBe(addToNft1[2]);
+  });
+
+  test("should add NFT and return new array with new ref", () => {
+    const nfts = [
+      makeNFT("1", "contract1", 10),
+      makeNFT("2", "contract1", 1),
+      makeNFT("3", "contract2", 6),
+      makeNFT("4", "contract2", 4),
+    ];
+    const addToNft1 = mergeNfts(oldNfts, nfts);
+
+    expect(addToNft1.map(toNFTRaw)).toEqual(
+      [
+        makeNFT("4", "contract2", 4),
+        makeNFT("1", "contract1", 10),
+        makeNFT("2", "contract1", 1),
+        makeNFT("3", "contract2", 6),
+      ].map(toNFTRaw)
+    );
+    expect(oldNfts[0]).toBe(addToNft1[1]);
+    expect(oldNfts[1]).toBe(addToNft1[2]);
+    expect(oldNfts[2]).toBe(addToNft1[3]);
+    expect(addToNft1[0]).toBe(nfts[3]);
+  });
+});
+
+describe("gaspard NFT on ethereum", () => {
+  let account = fromAccountRaw(gaspardAccount);
 
   test("first sync & have nfts", async () => {
     await cache.prepareCurrency(account.currency);
@@ -78,6 +197,17 @@ describe("nft reconciliation", () => {
     expect(resync.nfts).toEqual(account.nfts);
   });
 
+  test("remove half NFTs will restore them with half operations", async () => {
+    const halfOps = Math.ceil(account.operations.length / 2);
+    const copy = {
+      ...account,
+      operations: account.operations.slice(halfOps),
+      nfts: account.nfts?.slice(Math.ceil((account.nfts?.length || 0) / 2)),
+    };
+    const resync = await sync(copy);
+    expect(resync.nfts).toEqual(account.nfts);
+  });
+
   test("patchAccount restore new NFTs correctly", async () => {
     const copy = {
       ...account,
@@ -87,4 +217,47 @@ describe("nft reconciliation", () => {
     const newAccount = patchAccount(copy, toAccountRaw(account));
     expect(newAccount.nfts).toEqual(account.nfts);
   });
+
+  test("start account with .nfts and disable the NFT flag should make it disappear", async () => {
+    expect(account.nfts).not.toBeFalsy();
+    const resync = await sync(account, false);
+    expect(resync.nfts).toBeFalsy();
+  });
+
+  test("start account without .nfts and enable the NFT flag should make it appear", async () => {
+    const first = await sync(account, false);
+    expect(first.nfts).toBeFalsy();
+    const second = await sync(first, true);
+    expect(second.nfts).not.toBeFalsy();
+    expect(second.nfts).toEqual(account.nfts);
+  });
+
+  test("no nft should be on quantity 0 or negative", async () => {
+    expect(account.nfts?.find((n) => !n.amount.gt(0))).toEqual(undefined);
+  });
+});
+
+/*
+// this is never ending here... have to disable this test... (backend issue)
+describe("gaspard NFT on polygon", () => {
+  let account = fromAccountRaw(gaspardPolygonAccount);
+  test("first sync", async () => {
+    await cache.prepareCurrency(account.currency);
+    account = await sync(account);
+  });
+  test(".nfts shouldn't be visible", () => {
+    expect(account.nfts).toBeFalsy();
+  });
+});
+*/
+
+describe("gaspard NFT on bsc", () => {
+  let account = fromAccountRaw(gaspardBscAccount);
+  test("first sync", async () => {
+    await cache.prepareCurrency(account.currency);
+    account = await sync(account);
+  });
+  test(".nfts shouldn't be visible", () => {
+    expect(account.nfts).toBeFalsy();
+  });
 });

package/src/families/ethereum/signOperation.ts

@@ -13,7 +13,7 @@ import { getGasLimit, buildEthereumTx } from "./transaction";
 import { apiForCurrency } from "../../api/Ethereum";
 import { withDevice } from "../../hw/deviceAccess";
 import { modes } from "./modules";
-import { getEnv } from "../../env";
+import { isNFTActive } from "../../nft";
 export const signOperation = ({
   account,
   deviceId,
@@ -57,12 +57,11 @@ export const signOperation = ({
                 nonce
               );
               const to = eip55.encode("0x" + tx.to.toString("hex"));
-              const chainId = tx.getChainId();
               const value = new BigNumber(
                 "0x" + (tx.value.toString("hex") || "0")
               );
               const eth = new Eth(transport);
-              if (getEnv("NFT")) {
+              if (isNFTActive(account.currency)) {
                 eth.setLoadConfig({
                   // FIXME drop this after LL-8001
                   nftExplorerBaseURL: