@ledgerhq/coin-evm 0.3.0 → 0.4.0-next.0

package/src/__tests__/fixtures/synchronization.fixtures.ts

@@ -0,0 +1,229 @@
+/* instanbul ignore file: don't test fixtures */
+
+import BigNumber from "bignumber.js";
+import { getTokenById } from "@ledgerhq/cryptoassets/tokens";
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
+import * as logic from "../../logic";
+import {
+  makeAccount,
+  makeNft,
+  makeNftOperation,
+  makeOperation,
+  makeTokenAccount,
+} from "./common.fixtures";
+
+jest.useFakeTimers().setSystemTime(new Date("2014-04-21"));
+
+export const currency: CryptoCurrency = Object.freeze({
+  ...getCryptoCurrencyById("ethereum"),
+  ethereumLikeInfo: {
+    chainId: 1,
+    rpc: "https://my-rpc.com",
+    explorer: {
+      uri: "https://api.com",
+      type: "etherscan" as const,
+    },
+  },
+});
+
+export const tokenCurrencies = [
+  Object.freeze(getTokenById("ethereum/erc20/usd__coin")),
+  Object.freeze(getTokenById("ethereum/erc20/usd_tether__erc20_")),
+];
+
+export const tokenAccount = makeTokenAccount("0xkvn", tokenCurrencies[0]);
+export const account = Object.freeze({
+  ...makeAccount("0xkvn", currency, [tokenAccount]),
+  syncHash: logic.getSyncHash(currency),
+});
+
+export const coinOperations = [
+  makeOperation({
+    hash: "0xCoinOp1Hash",
+    accountId: "js:2:ethereum:0xkvn:",
+    blockHash: "0x8df71a12a8c06b36c06c26bf6248857dd2a2b75b6edbb4e33e9477078897b282",
+    senders: ["0xd48f2332Eeed88243Cb6b1D0d65a10368A5370f0"], // johnnyhallyday.eth
+    transactionSequenceNumber: 1,
+    date: new Date(),
+    blockHeight: 1,
+  }),
+  makeOperation({
+    hash: "0xCoinOp2Hash",
+    accountId: "js:2:ethereum:0xkvn:",
+    transactionSequenceNumber: 2,
+    date: new Date(Date.now() + 1),
+    blockHeight: 100,
+  }),
+  makeOperation({
+    hash: "0xCoinOp3Hash",
+    accountId: "js:2:ethereum:0xkvn:",
+    transactionSequenceNumber: 5,
+    date: new Date(Date.now() + 2),
+    blockHeight: 1000,
+  }),
+];
+
+export const tokenOperations = [
+  makeOperation({
+    hash: coinOperations[0].hash, // on purpose to make this token op a subOp of coinOp 1
+    accountId: "js:2:ethereum:0xkvn:+ethereum%2Ferc20%2Fusd__coin",
+    blockHash: "0x95dc138a02c1b0e3fd49305f785e8e27e88a885004af13a9b4c62ad94eed07dd",
+    recipients: ["0xB0B"],
+    senders: ["0x9b744C0451D73C0958d8aA566dAd33022E4Ee797"], // sbf.eth
+    contract: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    value: new BigNumber(152021496),
+    fee: new BigNumber(1935663357068271),
+    type: "OUT",
+    date: new Date(),
+    blockHeight: 10,
+  }),
+  makeOperation({
+    hash: "0xTokenHashAga1n",
+    accountId: "js:2:ethereum:0xkvn:+ethereum%2Ferc20%2Fusd__coin",
+    contract: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    date: new Date(Date.now() + 1),
+    blockHeight: 1000,
+  }),
+  makeOperation({
+    hash: "0xTokenHashAga1n",
+    accountId: "js:2:ethereum:0xkvn:+ethereum%2Ferc20%2Fusd__coin",
+    contract: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+    date: new Date(Date.now() + 2),
+    blockHeight: 10000,
+  }),
+  makeOperation({
+    hash: "0xTokenHashOtherToken",
+    accountId: "js:2:ethereum:0xkvn:+ethereum%2Ferc20%2Fusd_tether__erc20_",
+    contract: "0xdac17f958d2ee523a2206206994597c13d831ec7",
+    date: new Date(Date.now() + 3),
+    blockHeight: 11000,
+  }),
+];
+
+export const erc721Operations = [
+  makeNftOperation(
+    {
+      hash: coinOperations[0].hash, // on purpose to make this erc721 op an nftOp of coinOp 1
+      accountId: coinOperations[0].accountId,
+      blockHash: coinOperations[0].blockHash,
+      recipients: ["0xB0B"],
+      senders: ["0x1084b55cB63dE549806A521036F7dad2d37E3fAE"], // chocolatine.eth
+      contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+      tokenId: "1",
+      standard: "ERC721",
+      value: new BigNumber(1),
+      fee: coinOperations[0].fee,
+      type: "NFT_IN",
+      date: coinOperations[0].date,
+      blockHeight: coinOperations[0].blockHeight,
+    },
+    0,
+  ),
+  makeNftOperation(
+    {
+      hash: coinOperations[1].hash, // on purpose to make this erc721 op an nftOp of coinOp 1
+      accountId: coinOperations[1].accountId,
+      blockHash: coinOperations[1].blockHash,
+      recipients: ["0xB0B"],
+      senders: ["0x1084b55cB63dE549806A521036F7dad2d37E3fAE"], // chocolatine.eth
+      contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+      tokenId: "2",
+      standard: "ERC721",
+      value: new BigNumber(1),
+      fee: coinOperations[1].fee,
+      type: "NFT_IN",
+      date: coinOperations[1].date,
+      blockHeight: coinOperations[1].blockHeight,
+    },
+    0,
+  ),
+  makeNftOperation(
+    {
+      hash: coinOperations[1].hash, // on purpose to make this erc721 op an nftOp of coinOp 1
+      accountId: coinOperations[1].accountId,
+      blockHash: coinOperations[1].blockHash,
+      recipients: ["0xB0B"],
+      senders: ["0x1084b55cB63dE549806A521036F7dad2d37E3fAE"], // chocolatine.eth
+      contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+      tokenId: "1",
+      standard: "ERC721",
+      value: new BigNumber(1),
+      fee: coinOperations[1].fee,
+      type: "NFT_OUT",
+      date: coinOperations[1].date,
+      blockHeight: coinOperations[1].blockHeight,
+    },
+    1,
+  ),
+];
+
+export const erc1155Operations = [
+  makeNftOperation(
+    {
+      hash: coinOperations[0].hash, // on purpose to make this erc1155 op an nftOp of coinOp 1
+      accountId: "js:2:ethereum:0xkvn:",
+      blockHash: "0x95dc138a02c1b0e3fd49305f785e8e27e88a885004af13a9b4c62ad94eed07dd",
+      recipients: ["0xB0B"],
+      senders: ["0x1084b55cB63dE549806A521036F7dad2d37E3fAE"], // painauchocolat.eth
+      contract: "0xBa98C7d6B25309FF097e88D24400c0EbC4D68e3a",
+      tokenId: "1",
+      standard: "ERC1155",
+      value: new BigNumber(10),
+      fee: new BigNumber(1935663357068271),
+      type: "NFT_IN",
+      date: new Date(),
+      blockHeight: 10,
+    },
+    0,
+  ),
+  makeNftOperation(
+    {
+      hash: coinOperations[1].hash, // on purpose to make this erc1155 op an nftOp of coinOp 1
+      accountId: "js:2:ethereum:0xkvn:",
+      blockHash: "0x95dc138a02c1b0e3fd49305f785e8e27e88a885004af13a9b4c62ad94eed07dd",
+      recipients: ["0xB0B"],
+      senders: ["0x1084b55cB63dE549806A521036F7dad2d37E3fAE"], // painauchocolat.eth
+      contract: "0xBa98C7d6B25309FF097e88D24400c0EbC4D68e3a",
+      tokenId: "1",
+      standard: "ERC1155",
+      value: new BigNumber(9),
+      fee: new BigNumber(1935663357068271),
+      type: "NFT_OUT",
+      date: new Date(Date.now() + 1),
+      blockHeight: 11,
+    },
+    0,
+  ),
+];
+
+export const ignoredTokenOperation = makeOperation({
+  hash: "0xigN0r3Me",
+  accountId: "js:2:ethereum:0xkvn:+ethereum%2Ferc20%2Fusd_tether__erc20_",
+  contract: "0xUnknownContract",
+  date: new Date(Date.now() + 4),
+  blockHeight: 12000,
+});
+
+export const pendingOperation = makeOperation({
+  hash: "123",
+});
+
+export const nfts = [
+  makeNft({
+    amount: new BigNumber("1"),
+    contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+    currencyId: "ethereum",
+    id: "js:2:ethereum:0xkvn:+0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D+2+ethereum",
+    standard: "ERC721",
+    tokenId: "2",
+  }),
+  makeNft({
+    amount: new BigNumber("1"),
+    contract: "0xBa98C7d6B25309FF097e88D24400c0EbC4D68e3a",
+    currencyId: "ethereum",
+    id: "js:2:ethereum:0xkvn:+0xBa98C7d6B25309FF097e88D24400c0EbC4D68e3a+1+ethereum",
+    standard: "ERC1155",
+    tokenId: "1",
+  }),
+];

package/src/__tests__/fixtures/transaction.fixtures.ts

@@ -0,0 +1,229 @@
+import BigNumber from "bignumber.js";
+import { getTokenById } from "@ledgerhq/cryptoassets/tokens";
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
+import { makeAccount, makeTokenAccount } from "./common.fixtures";
+import {
+  EvmTransactionEIP1559,
+  EvmTransactionEIP1559Raw,
+  EvmTransactionLegacy,
+  EvmTransactionLegacyRaw,
+  Transaction as EvmTransaction,
+  EvmNftTransactionRaw,
+  EvmNftTransaction,
+} from "../../types";
+
+export const testData = Object.freeze(Buffer.from("testBufferString").toString("hex"));
+
+const rawNft = Object.freeze({
+  tokenId: "123",
+  contract: "0xContract",
+  quantity: "10",
+  collectionName: "collectionName",
+});
+
+const nft = Object.freeze({
+  tokenId: "123",
+  contract: "0xContract",
+  quantity: new BigNumber("10"),
+  collectionName: "collectionName",
+});
+
+export const rawEip1559Tx: EvmTransactionEIP1559Raw = Object.freeze(
+  Object.freeze({
+    amount: "100",
+    useAllAmount: false,
+    subAccountId: "id",
+    recipient: "0xkvn",
+    feesStrategy: "custom",
+    family: "evm",
+    mode: "send",
+    nonce: 0,
+    gasLimit: "21000",
+    chainId: 1,
+    data: testData,
+    maxFeePerGas: "10000",
+    maxPriorityFeePerGas: "10000",
+    additionalFees: "420",
+    type: 2,
+  }),
+);
+
+export const rawNftEip1559Tx: EvmTransactionEIP1559Raw & EvmNftTransactionRaw = Object.freeze({
+  ...rawEip1559Tx,
+  mode: "erc721",
+  nft: rawNft,
+});
+
+export const eip1559Tx: EvmTransactionEIP1559 = Object.freeze(
+  Object.freeze({
+    amount: new BigNumber(100),
+    useAllAmount: false,
+    subAccountId: "id",
+    recipient: "0xkvn",
+    feesStrategy: "custom",
+    family: "evm",
+    mode: "send",
+    nonce: 0,
+    gasLimit: new BigNumber(21000),
+    chainId: 1,
+    data: Buffer.from(testData, "hex"),
+    maxFeePerGas: new BigNumber(10000),
+    maxPriorityFeePerGas: new BigNumber(10000),
+    additionalFees: new BigNumber(420),
+    type: 2,
+  }),
+);
+
+export const nftEip1559tx = Object.freeze({
+  ...eip1559Tx,
+  mode: "erc721",
+  nft,
+});
+
+export const rawLegacyTx: EvmTransactionLegacyRaw = Object.freeze({
+  amount: "100",
+  useAllAmount: false,
+  subAccountId: "id",
+  recipient: "0xkvn",
+  feesStrategy: "custom",
+  family: "evm",
+  mode: "send",
+  nonce: 0,
+  gasLimit: "21000",
+  chainId: 1,
+  data: testData,
+  gasPrice: "10000",
+  additionalFees: "420",
+  type: 0,
+});
+
+export const nftRawLegacyTx: EvmTransactionLegacyRaw & EvmNftTransactionRaw = Object.freeze({
+  ...rawLegacyTx,
+  mode: "erc721",
+  nft: rawNft,
+});
+
+export const legacyTx: EvmTransactionLegacy = Object.freeze(
+  Object.freeze({
+    amount: new BigNumber(100),
+    useAllAmount: false,
+    subAccountId: "id",
+    recipient: "0xkvn",
+    feesStrategy: "custom",
+    family: "evm",
+    mode: "send",
+    nonce: 0,
+    gasLimit: new BigNumber(21000),
+    chainId: 1,
+    data: Buffer.from(testData, "hex"),
+    gasPrice: new BigNumber(10000),
+    additionalFees: new BigNumber(420),
+    type: 0,
+  }),
+);
+
+export const nftLegacyTx: EvmTransactionLegacy & EvmNftTransaction = Object.freeze({
+  ...legacyTx,
+  mode: "erc721",
+  nft,
+});
+
+export const currency: CryptoCurrency = Object.freeze({
+  ...getCryptoCurrencyById("ethereum"),
+  ethereumLikeInfo: {
+    chainId: 1,
+    rpc: "https://my-rpc.com",
+    explorer: {
+      uri: "https://api.com",
+      type: "etherscan" as const,
+    },
+  },
+});
+export const tokenCurrency = Object.freeze(getTokenById("ethereum/erc20/usd__coin"));
+export const tokenAccount = makeTokenAccount(
+  "0x6cBCD73CD8e8a42844662f0A0e76D7F79Afd933d",
+  tokenCurrency,
+);
+export const account = makeAccount("0x6cBCD73CD8e8a42844662f0A0e76D7F79Afd933d", currency, [
+  tokenAccount,
+]);
+
+export const tokenTransaction: EvmTransaction = Object.freeze({
+  family: "evm",
+  mode: "send",
+  amount: new BigNumber(100),
+  useAllAmount: false,
+  subAccountId: tokenAccount.id,
+  recipient: "0x51DF0aF74a0DBae16cB845B46dAF2a35cB1D4168", // michel.eth
+  feesStrategy: "custom",
+  nonce: 0,
+  gasLimit: new BigNumber(60000),
+  chainId: 1,
+  maxFeePerGas: new BigNumber(100),
+  maxPriorityFeePerGas: new BigNumber(100),
+  type: 2,
+});
+
+export const erc721Transaction: EvmTransaction = Object.freeze({
+  family: "evm",
+  mode: "erc721",
+  amount: new BigNumber(0),
+  useAllAmount: false,
+  recipient: "0x51DF0aF74a0DBae16cB845B46dAF2a35cB1D4168", // michel.eth
+  feesStrategy: "custom",
+  nonce: 0,
+  gasLimit: new BigNumber(60000),
+  chainId: 1,
+  nft: {
+    contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+    tokenId: "1",
+    quantity: new BigNumber(1),
+    collectionName: "BAYC",
+  },
+  maxFeePerGas: new BigNumber(100),
+  maxPriorityFeePerGas: new BigNumber(100),
+  type: 2,
+});
+
+export const erc1155Transaction: EvmTransaction = Object.freeze({
+  family: "evm",
+  mode: "erc1155",
+  amount: new BigNumber(0),
+  useAllAmount: false,
+  recipient: "0x51DF0aF74a0DBae16cB845B46dAF2a35cB1D4168", // michel.eth
+  feesStrategy: "custom",
+  nonce: 0,
+  gasLimit: new BigNumber(60000),
+  chainId: 1,
+  nft: {
+    contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+    tokenId: "1",
+    quantity: new BigNumber(10),
+    collectionName: "BAYC",
+  },
+  maxFeePerGas: new BigNumber(100),
+  maxPriorityFeePerGas: new BigNumber(100),
+  type: 2,
+});
+
+export const erc1155TransactionNonFinite: EvmTransaction = Object.freeze({
+  family: "evm",
+  mode: "erc1155",
+  amount: new BigNumber(0),
+  useAllAmount: false,
+  recipient: "0x51DF0aF74a0DBae16cB845B46dAF2a35cB1D4168", // michel.eth
+  feesStrategy: "custom",
+  nonce: 0,
+  gasLimit: new BigNumber(60000),
+  chainId: 1,
+  nft: {
+    contract: "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
+    tokenId: "1",
+    quantity: new BigNumber(Infinity),
+    collectionName: "BAYC",
+  },
+  maxFeePerGas: new BigNumber(100),
+  maxPriorityFeePerGas: new BigNumber(100),
+  type: 2,
+});

package/src/__tests__/integration/bridge.integration.test.ts

@@ -0,0 +1,74 @@
+/**
+ * ⚠️ In order to test this file, you must run the test from the live-common repo
+ */
+
+import { BigNumber } from "bignumber.js";
+import { FeeNotLoaded, NotEnoughBalance } from "@ledgerhq/errors";
+import type { AccountRaw, DatasetTest } from "@ledgerhq/types-live";
+import { fromTransactionRaw } from "../../transaction";
+import { ethereum1 } from "../../datasets/ethereum1";
+import type { Transaction } from "../../types";
+
+export const dataset: DatasetTest<Transaction> = {
+  implementations: ["mock", "js"],
+  currencies: {
+    ethereum_as_evm_test_only: {
+      accounts: [
+        {
+          FIXME_tests: ["balance is sum of ops"],
+          implementations: ["js"],
+          raw: ethereum1 as AccountRaw,
+          transactions: [
+            {
+              name: "Send",
+              transaction: fromTransactionRaw({
+                family: "evm",
+                mode: "send",
+                recipient: "0x17733CAb76d9A2112576443F21735789733B1ca3",
+                amount: (1e19).toString(), // 10 ETH
+                gasPrice: "0",
+                gasLimit: "21000",
+                chainId: 1,
+                nonce: 0,
+              }),
+              expectedStatus: (account, transaction) => {
+                const estimatedFees = transaction.gasLimit.times(transaction.maxFeePerGas || 0);
+                return {
+                  amount: new BigNumber(1e19), // 10 ETH
+                  estimatedFees, // fees are calculated during preparation and therefore cannot be guessed without mocks
+                  totalSpent: new BigNumber(1e19).plus(estimatedFees), // fees are calculated during preparation and therefore cannot be guessed without mocks
+                  errors: {
+                    amount: new NotEnoughBalance(), // "The parent account balance is insufficient for network fees" since account is empty
+                    gasLimit: new FeeNotLoaded(), // "Could not load fee rates. Please set manual fees" because gas estimation failed as the account is empty
+                  },
+                  warnings: {},
+                };
+              },
+            },
+            {
+              name: "Send max",
+              transaction: fromTransactionRaw({
+                family: "evm",
+                mode: "send",
+                recipient: "0x17733CAb76d9A2112576443F21735789733B1ca3",
+                amount: "1",
+                gasPrice: "100000000",
+                gasLimit: "21000",
+                chainId: 1,
+                nonce: 0,
+                useAllAmount: true,
+              }),
+              expectedStatus: (account, _, status) => {
+                return {
+                  amount: BigNumber.max(account.balance.minus(status.estimatedFees), 0),
+                  errors: {},
+                  warnings: {},
+                };
+              },
+            },
+          ],
+        },
+      ],
+    },
+  },
+};