@ledgerhq/coin-framework 0.0.2

package/src/errors.test.ts

@@ -0,0 +1,21 @@
+import { UnsupportedDerivation } from "./errors";
+
+function functionA() {
+  throw new UnsupportedDerivation();
+}
+
+describe("custom errors", () => {
+  test("error instanceof", () => {
+    try {
+      functionA();
+    } catch (e: any) {
+      expect(e).toBeInstanceOf(UnsupportedDerivation);
+    }
+  });
+
+  test("promise error instanceof", () => {
+    expect(Promise.reject(new UnsupportedDerivation())).rejects.toBeInstanceOf(
+      UnsupportedDerivation
+    );
+  });
+});

package/src/errors.ts

@@ -0,0 +1,9 @@
+import { createCustomErrorClass } from "@ledgerhq/errors";
+
+export const FreshAddressIndexInvalid = createCustomErrorClass(
+  "FreshAddressIndexInvalid"
+);
+
+export const UnsupportedDerivation = createCustomErrorClass(
+  "UnsupportedDerivation"
+);

package/src/mocks/account.ts

@@ -0,0 +1,476 @@
+import Prando from "prando";
+import { BigNumber } from "bignumber.js";
+import {
+  listCryptoCurrencies,
+  listTokensForCryptoCurrency,
+  findCompoundToken,
+} from "../currencies";
+import { getOperationAmountNumber } from "../operation";
+import {
+  inferSubOperations,
+  isAccountEmpty,
+  emptyHistoryCache,
+  generateHistoryFromOperations,
+} from "../account";
+import { getDerivationScheme, runDerivationScheme } from "../derivation";
+import { genHex, genAddress } from "./helpers";
+import type {
+  Account,
+  AccountLike,
+  Operation,
+  TokenAccount,
+} from "@ledgerhq/types-live";
+import type {
+  CryptoCurrency,
+  TokenCurrency,
+} from "@ledgerhq/types-cryptoassets";
+import { createFixtureNFT, genNFTOperation } from "./fixtures/nfts";
+
+export function ensureNoNegative(operations: Operation[]) {
+  let total = new BigNumber(0);
+
+  for (let i = operations.length - 1; i >= 0; i--) {
+    const op = operations[i];
+    const amount = getOperationAmountNumber(op);
+
+    if (total.plus(amount).isNegative()) {
+      if (op.type === "IN") {
+        op.type = "OUT";
+      } else if (op.type === "OUT") {
+        op.type = "IN";
+      }
+    }
+
+    total = total.plus(getOperationAmountNumber(op));
+  }
+
+  return total;
+}
+
+const hardcodedMarketcap = [
+  "bitcoin",
+  "ethereum",
+  "ripple",
+  "bitcoin_cash",
+  "litecoin",
+  "ethereum/erc20/usd_tether__erc20_",
+  "bsc",
+  "eos",
+  "stellar",
+  "monero",
+  "cardano",
+  "ethereum/erc20/leo_token",
+  "tron",
+  "dash",
+  "ethereum_classic",
+  "tezos",
+  "iota",
+  "ethereum/erc20/link_chainlink",
+  "neo",
+  "ethereum/erc20/makerdao",
+  "ethereum/erc20/usd__coin",
+  "ontology",
+  "ethereum/erc20/cro",
+  "zcash",
+  "dogecoin",
+  "decred",
+  "vechain",
+  "ethereum/erc20/bat",
+  "qtum",
+  "ethereum/erc20/huobitoken",
+  "bitcoin_gold",
+  "ethereum/erc20/paxos_standard__pax_",
+  "ethereum/erc20/trueusd",
+  "ethereum/erc20/omg",
+  "lisk",
+  "nano",
+  "waves",
+  "ethereum/erc20/holotoken",
+  "ethereum/erc20/icon",
+  "digibyte",
+  "ethereum/erc20/0x_project",
+  "ethereum/erc20/iostoken",
+  "ethereum/erc20/pundi_x_token",
+  "ethereum/erc20/augur",
+  "ethereum/erc20/aurora",
+  "komodo",
+  "ethereum/erc20/quant",
+  "ethereum/erc20/bytom",
+  "ethereum/erc20/dai_stablecoin_v1_0",
+  "ethereum/erc20/dai_stablecoin_v2_0",
+  "ethereum/erc20/egretia_token",
+  "aeternity",
+  "ethereum/erc20/golem",
+  "ethereum/erc20/republic_protocol",
+  "ethereum/erc20/status_network_token",
+  "ethereum/erc20/crypto_com",
+  "ethereum/erc20/enjin",
+  "ethereum/erc20/walton",
+  "ethereum/erc20/gxc",
+  "zcoin",
+  "ethereum/erc20/synthetix_network_token",
+  "stratis",
+  "ethereum/erc20/wax",
+  "ethereum/erc20/nexo",
+  "ethereum/erc20/elf_token",
+  "factom",
+  "wanchain",
+  "ethereum/erc20/pchain",
+  "zencash",
+  "ethereum/erc20/stasis_eurs_token",
+  "ethereum/erc20/revian",
+  "ethereum/erc20/odem_token",
+  "ethereum/erc20/nuls",
+  "ethereum/erc20/decentraland_mana",
+  "ethereum/erc20/nebula",
+  "ethereum/erc20/qash",
+  "ethereum/erc20/dent",
+  "ethereum/erc20/digix_dao",
+  "tomo",
+  "ethereum/erc20/lrc",
+  "ethereum/erc20/crypteriumtoken",
+  "ethereum/erc20/santiment",
+  "ethereum/erc20/matic",
+  "ethereum/erc20/kyber_network",
+  "ethereum/erc20/loom",
+  "ethereum/erc20/digitexfutures",
+  "ethereum/erc20/populous",
+  "ethereum/erc20/fusion",
+  "ethereum/erc20/enigma",
+  "ethereum/erc20/orbs",
+  "ethereum/erc20/quarkchain_token",
+  "ethereum/erc20/fetch",
+  "aion",
+  "ethereum/erc20/bix_token",
+  "ark",
+  "ethereum/erc20/menlo_one",
+  "ethereum/erc20/xmax",
+  "ethereum/erc20/bancor",
+  "ethereum/erc20/bread",
+  "ethereum/erc20/powerledger",
+  "ethereum/erc20/telcoin",
+  "tron/trc10/1002000",
+  "tron/trc10/1002398",
+  "tron/trc10/1000226",
+  "tron/trc10/1002517",
+  "tron/trc10/1002544",
+  "tron/trc10/1002573",
+  "tron/trc10/1002597",
+  "tron/trc10/1002672",
+  "tron/trc10/1002736",
+  "tron/trc10/1002798",
+  "tron/trc10/1002578",
+  "tron/trc10/1002845",
+  "tron/trc10/1002775",
+  "tron/trc10/1002858",
+  "tron/trc10/1002876",
+  "tron/trc20/TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7",
+  "algorand/asa/438840",
+  "algorand/asa/438839",
+  "algorand/asa/438838",
+  "algorand/asa/438837",
+  "algorand/asa/438836",
+  "algorand/asa/438833",
+  "algorand/asa/438832",
+  "algorand/asa/438831",
+  "algorand/asa/438828",
+  "algorand/asa/312769",
+  "algorand/asa/163650",
+];
+// for the mock generation we need to adjust to the actual market price of things, we want to avoid having things < 0.01 EUR
+const currencyIdApproxMarketPrice: Record<string, number> = {
+  bitcoin: 0.0073059,
+  ethereum: 5.7033e-14,
+  ethereum_classic: 1.4857e-15,
+  bitcoin_cash: 0.0011739,
+  bitcoin_gold: 0.00005004,
+  litecoin: 0.00011728,
+  ripple: 0.000057633,
+  dogecoin: 4.9e-9,
+  dash: 0.0003367,
+  peercoin: 0.000226,
+  zcash: 0.000205798,
+};
+// mock only use subset of cryptocurrencies to not affect tests when adding coins
+const currencies = listCryptoCurrencies().filter(
+  (c) => currencyIdApproxMarketPrice[c.id]
+);
+// TODO fix the mock to never generate negative balance...
+
+/**
+ * @memberof mock/account
+ */
+export function genOperation(
+  superAccount: Account,
+  account: AccountLike,
+  ops: any,
+  rng: Prando
+): Operation {
+  const ticker =
+    account.type === "TokenAccount"
+      ? account.token.ticker
+      : account.currency.ticker;
+  const lastOp = ops[ops.length - 1];
+  const date = new Date(
+    (lastOp ? lastOp.date : Date.now()) -
+      rng.nextInt(0, 100000000 * rng.next() * rng.next())
+  );
+  const address = genAddress(superAccount.currency, rng);
+  const type = rng.next() < 0.3 ? "OUT" : "IN";
+  const divider =
+    (account.type === "Account" &&
+      currencyIdApproxMarketPrice[account.currency.id]) ||
+    currencyIdApproxMarketPrice.bitcoin;
+  const value = new BigNumber(
+    Math.floor(rng.nextInt(0, 100000 * rng.next() * rng.next()) / divider)
+  );
+
+  if (Number.isNaN(value)) {
+    throw new Error("invalid amount generated for " + ticker);
+  }
+
+  const hash = genHex(64, rng);
+  const op: Operation = {
+    id: String(`mock_op_${ops.length}_${account.id}`),
+    hash,
+    type,
+    value,
+    fee: new BigNumber(Math.round(value.toNumber() * 0.01)),
+    senders: [type !== "IN" ? genAddress(superAccount.currency, rng) : address],
+    recipients: [
+      type === "IN" ? genAddress(superAccount.currency, rng) : address,
+    ],
+    blockHash: genHex(64, rng),
+    blockHeight:
+      superAccount.blockHeight -
+      Math.floor((Date.now() - (date as any)) / 900000),
+    accountId: account.id,
+    date,
+    extra: {},
+  };
+
+  if (account.type === "Account") {
+    const { subAccounts } = account;
+
+    if (subAccounts) {
+      // TODO make sure tokenAccounts sometimes reuse an existing op hash from main account
+      op.subOperations = inferSubOperations(hash, subAccounts);
+    }
+  }
+
+  return op;
+}
+
+/**
+ * @param id is a number or a string, used as an account identifier and as a seed for the generation.
+ * @memberof mock/account
+ */
+export type GenAccountOptions = {
+  operationsSize?: number;
+  currency?: CryptoCurrency;
+  subAccountsCount?: number;
+  swapHistorySize?: number;
+  withNft?: boolean;
+};
+
+export function genTokenAccount(
+  index: number,
+  account: Account,
+  token: TokenCurrency
+): TokenAccount {
+  const rng = new Prando(account.id + "|" + index);
+  const tokenAccount: TokenAccount = {
+    type: "TokenAccount",
+    starred: false,
+    id: account.id + "|" + index,
+    parentId: account.id,
+    token,
+    operationsCount: 0,
+    operations: [],
+    pendingOperations: [],
+    balance: new BigNumber(0),
+    spendableBalance: new BigNumber(0),
+    creationDate: new Date(),
+    swapHistory: [],
+    balanceHistoryCache: emptyHistoryCache,
+  };
+  const operationsSize = rng.nextInt(1, 200);
+  tokenAccount.operations = Array(operationsSize)
+    .fill(null)
+    .reduce((ops: Operation[]) => {
+      const op = genOperation(account, tokenAccount, ops, rng);
+      return ops.concat(op);
+    }, []);
+  tokenAccount.operationsCount = tokenAccount.operations.length;
+  tokenAccount.spendableBalance = tokenAccount.balance = ensureNoNegative(
+    tokenAccount.operations
+  );
+  tokenAccount.creationDate =
+    tokenAccount.operations.length > 0
+      ? tokenAccount.operations[tokenAccount.operations.length - 1].date
+      : new Date();
+  tokenAccount.balanceHistoryCache =
+    generateHistoryFromOperations(tokenAccount);
+  return tokenAccount;
+}
+
+type GenAccountEnhanceOperations = (
+  account: Account,
+  currency: CryptoCurrency,
+  rng: Prando
+) => void;
+
+export function genAccount(
+  id: number | string,
+  opts: GenAccountOptions = {},
+  completeResources?: (
+    account: Account,
+    currency: CryptoCurrency,
+    address: string
+  ) => void,
+  genAccountEnhanceOperations?: GenAccountEnhanceOperations
+): Account {
+  const rng = new Prando(id);
+  const currency = opts.currency || rng.nextArrayItem(currencies);
+  const operationsSize = opts.operationsSize ?? rng.nextInt(1, 200);
+  const swapHistorySize = opts.swapHistorySize || 0;
+  const withNft = opts.withNft ?? false;
+  const address = genAddress(currency, rng);
+  const derivationPath = runDerivationScheme(
+    getDerivationScheme({
+      currency,
+      derivationMode: "",
+    }),
+    currency
+  );
+  const freshAddress = {
+    address,
+    derivationPath,
+  };
+  // nb Make the third (ethereum_classic, dogecoin) account originally migratable
+  const outdated =
+    ["ethereum_classic", "dogecoin"].includes(currency.id) &&
+    `${id}`.endsWith("_2");
+  const accountId = `mock:${outdated ? 0 : 1}:${currency.id}:${id}:`;
+  const account: Account = {
+    type: "Account",
+    id: accountId,
+    seedIdentifier: "mock",
+    derivationMode: "",
+    xpub: genHex(64, rng),
+    index: 1,
+    freshAddress: address,
+    freshAddressPath: derivationPath,
+    freshAddresses: [freshAddress],
+    name: rng.nextString(rng.nextInt(4, 34)),
+    starred: false,
+    used: false,
+    balance: new BigNumber(0),
+    spendableBalance: new BigNumber(0),
+    blockHeight: rng.nextInt(100000, 200000),
+    currency,
+    unit: rng.nextArrayItem(currency.units),
+    operationsCount: 0,
+    operations: [],
+    pendingOperations: [],
+    lastSyncDate: new Date(),
+    creationDate: new Date(),
+    swapHistory: Array(swapHistorySize)
+      .fill(null)
+      .map((_, i) => ({
+        provider: "changelly",
+        swapId: `swap-id-${i}`,
+        status: "finished",
+        receiverAccountId: "receiver-id",
+        operationId: "operation-id",
+        tokenId: "token-id",
+        fromAmount: new BigNumber("1000"),
+        toAmount: new BigNumber("2000"),
+      })),
+    balanceHistoryCache: emptyHistoryCache,
+    ...(withNft && {
+      nfts: Array(10)
+        .fill(null)
+        .map(() => createFixtureNFT(accountId, currency)),
+    }),
+  };
+
+  if (
+    [
+      "ethereum",
+      "ethereum_ropsten",
+      "ethereum_goerli",
+      "tron",
+      "algorand",
+    ].includes(currency.id)
+  ) {
+    const tokenCount =
+      typeof opts.subAccountsCount === "number"
+        ? opts.subAccountsCount
+        : rng.nextInt(0, 8);
+    const all = listTokensForCryptoCurrency(account.currency).filter((t) =>
+      hardcodedMarketcap.includes(t.id)
+    );
+    const compoundReadyTokens = all.filter(findCompoundToken);
+    const notCompoundReadyTokens = all.filter((a) => !findCompoundToken(a));
+    // favorize the generation of compound tokens
+    const tokens = compoundReadyTokens
+      .concat(
+        // from random index
+        notCompoundReadyTokens.slice(
+          rng.nextInt(Math.floor(notCompoundReadyTokens.length / 2))
+        )
+      )
+      .slice(0, tokenCount);
+    account.subAccounts = tokens.map((token, i) =>
+      genTokenAccount(i, account, token)
+    );
+  }
+
+  completeResources?.(account, currency, address);
+
+  account.operations = Array(operationsSize)
+    .fill(null)
+    .reduce((ops: Operation[]) => {
+      const op = genOperation(account, account, ops, rng);
+      return ops.concat(op);
+    }, []);
+
+  if (withNft) {
+    const nftOperations = Array(5)
+      .fill(null)
+      .reduce((ops: Operation[]) => {
+        const index = Math.floor(Math.random() * (5 - 0 + 1) + 0);
+
+        if (account.nfts && account.nfts[index]) {
+          const { tokenId, contract, standard } = account.nfts[index];
+          const op = genNFTOperation(
+            account,
+            account,
+            ops,
+            rng,
+            contract,
+            standard,
+            tokenId
+          );
+          return ops.concat(op);
+        }
+      }, []);
+
+    account.operations = account.operations.concat(nftOperations);
+  }
+
+  account.creationDate =
+    account.operations.length > 0
+      ? account.operations[account.operations.length - 1].date
+      : new Date();
+  account.operationsCount = account.operations.length;
+  account.spendableBalance = account.balance = ensureNoNegative(
+    account.operations
+  );
+  account.used = !isAccountEmpty(account);
+  if (genAccountEnhanceOperations)
+    genAccountEnhanceOperations(account, currency, rng);
+  account.balanceHistoryCache = generateHistoryFromOperations(account);
+  return account;
+}

package/src/mocks/fixtures/nfts.test.ts

@@ -0,0 +1,25 @@
+import { getCryptoCurrencyById } from "../../currencies";
+import { createFixtureNFT, NFTs, NFTs_POLYGON } from "./nfts";
+
+const POL = getCryptoCurrencyById("polygon");
+describe("nfts fixtures", () => {
+  it("createFixtureNFT", () => {
+    const FIXTURE = createFixtureNFT("account-mock");
+    expect(FIXTURE.currencyId).toEqual("ethereum");
+    expect(FIXTURE.amount).not.toBeUndefined();
+    expect(FIXTURE.contract).not.toBeUndefined();
+    expect(FIXTURE.tokenId).not.toBeUndefined();
+    expect(FIXTURE.id).toContain("account-mock");
+
+    expect(
+      NFTs.map((nft) => nft.tokenId).includes(FIXTURE.tokenId)
+    ).toBeTruthy();
+
+    const FIXTURE_POL = createFixtureNFT("account-mock-pol", POL);
+    expect(FIXTURE_POL.currencyId).toEqual("polygon");
+
+    expect(
+      NFTs_POLYGON.map((nft) => nft.tokenId).includes(FIXTURE_POL.tokenId)
+    ).toBeTruthy();
+  });
+});