@ledgerhq/live-common 27.2.0 → 27.3.0-next.0

package/src/bot/specs.ts

@@ -4,10 +4,16 @@ import { log } from "@ledgerhq/logs";
 import expect from "expect";
 import sample from "lodash/sample";
 import { isAccountEmpty } from "../account";
-import type { DeviceAction, DeviceActionArg } from "./types";
+import type {
+  DeviceAction,
+  DeviceActionArg,
+  TransactionDestinationTestInput,
+} from "./types";
 import { Account } from "@ledgerhq/types-live";
 import type { Transaction } from "../generated/types";
 import { botTest } from "./bot-test-context";
+import { CryptoCurrency, TokenCurrency } from "@ledgerhq/types-cryptoassets";
+import BigNumber from "bignumber.js";
 
 export { botTest };
 
@@ -173,3 +179,91 @@ export function deviceActionFlow<T extends Transaction>(
     };
   };
 }
+
+type DeviceAmountFormatOptions = {
+  // the ticker of the coin is AFTER the amount on the device (e.g. "600.1 USDT")
+  postfixCode: boolean;
+  // the device shows "42" as "42.0"
+  forceFloating: boolean;
+  // device don't even display the code (unit ticker)
+  hideCode: boolean;
+  // force the visibility of all digits of the amount
+  showAllDigits: boolean;
+};
+const defaultFormatOptions: DeviceAmountFormatOptions = {
+  postfixCode: false,
+  forceFloating: false,
+  hideCode: false,
+  showAllDigits: false,
+};
+
+const sep = " ";
+export function formatDeviceAmount(
+  currency: CryptoCurrency | TokenCurrency,
+  value: BigNumber,
+  options: Partial<DeviceAmountFormatOptions> = defaultFormatOptions
+): string {
+  const [unit] = currency.units;
+  let code = unit.code;
+  if (currency.type === "CryptoCurrency") {
+    const { deviceTicker } = currency;
+    if (deviceTicker) code = deviceTicker;
+  }
+  const fValue = value.div(new BigNumber(10).pow(unit.magnitude));
+  let v = options.showAllDigits
+    ? fValue.toFixed(unit.magnitude)
+    : fValue.toString(10);
+  if (options.forceFloating) {
+    if (!v.includes(".")) {
+      // if the value is pure integer, in the app it will automatically add an .0
+      v += ".0";
+    }
+  }
+  if (options.hideCode) return v;
+  return options.postfixCode ? v + sep + code : code + sep + v;
+}
+
+// this function throw if the portion of undelegated funds is smaller than the threshold
+// where threshold is a value from 0.0 to 1.0, percentage of the total amount of funds
+// Usage: put these in your spec, on the mutation transaction functions that intend to do more "delegations"
+export function expectSiblingsHaveSpendablePartGreaterThan(
+  siblings: Account[],
+  threshold: number
+): void {
+  const spendableTotal = siblings.reduce(
+    (acc, a) => acc.plus(a.spendableBalance),
+    new BigNumber(0)
+  );
+  const total = siblings.reduce(
+    (acc, a) => acc.plus(a.balance),
+    new BigNumber(0)
+  );
+  invariant(
+    spendableTotal.div(total).gt(threshold),
+    "the spendable part of accounts is sufficient (threshold: %s)",
+    threshold
+  );
+}
+
+export const genericTestDestination = <T>({
+  destination,
+  operation,
+  destinationBeforeTransaction,
+  sendingOperation,
+}: TransactionDestinationTestInput<T>): void => {
+  const amount = sendingOperation.value.minus(sendingOperation.fee);
+  botTest("account balance increased with transaction amount", () =>
+    expect(destination.balance.toString()).toBe(
+      destinationBeforeTransaction.balance.plus(amount).toString()
+    )
+  );
+  botTest("operation amount is consistent with sendingOperation", () =>
+    expect({
+      type: operation.type,
+      amount: operation.value.toString(),
+    }).toMatchObject({
+      type: "IN",
+      amount: amount.toString(),
+    })
+  );
+};

package/src/bot/types.ts

@@ -25,6 +25,15 @@ export type TransactionTestInput<T> = {
   optimisticOperation: Operation;
   operation: Operation;
 };
+export type TransactionDestinationTestInput<T> = {
+  sendingAccount: Account;
+  sendingOperation: Operation;
+  destinationBeforeTransaction: Account;
+  operation: Operation;
+  destination: Account;
+  transaction: T;
+  status: TransactionStatus;
+};
 export type DeviceActionArg<T extends Transaction, S> = {
   appCandidate: AppCandidate;
   account: Account;
@@ -50,6 +59,7 @@ export type TransactionArg<T extends Transaction> = {
 export type TransactionRes<T extends Transaction> = {
   transaction: T;
   updates: Array<Partial<T> | null | undefined>;
+  destination?: Account;
 };
 export type MutationSpec<T extends Transaction> = {
   // Name what this mutation is doing
@@ -71,7 +81,9 @@ export type MutationSpec<T extends Transaction> = {
   // how much time to wait in maximum to reach the final state
   testTimeout?: number;
   // Implement a test that runs after the operation is applied to the account
-  test?: (arg0: TransactionTestInput<T>) => void;
+  test?: (input: TransactionTestInput<T>) => void;
+  // Implement a second test that allows to test the effect of the transaction on the DESTINATION account (matched by recipient)
+  testDestination?: (input: TransactionDestinationTestInput<T>) => void;
 };
 
 export type AppSpec<T extends Transaction> = {
@@ -101,9 +113,13 @@ export type AppSpec<T extends Transaction> = {
   // can implement generic invariants for a mutation transaction to be possible
   transactionCheck?: (arg: TransactionArg<T>) => void;
   // Implement a test that also runs on each mutation after the operation is applied to the account
+  // this allows to verify the effect of the transaction is correctly applied on the account
   test?: (arg0: TransactionTestInput<T>) => void;
   // Express the device actions to do (buttons,..) and validate the device screen
   genericDeviceAction: DeviceAction<T, any>;
+  // indicates to the engine what's the generally minimal amount we use to opt out from doing a transaction
+  // NB: at the moment it's purely informative and help inferring good "hints", but we could eventually automate it
+  minViableAmount?: BigNumber;
 };
 export type SpecReport<T extends Transaction> = {
   spec: AppSpec<T>;
@@ -114,6 +130,8 @@ export type SpecReport<T extends Transaction> = {
   accountsAfter?: Account[];
   mutations?: MutationReport<T>[];
   fatalError?: Error;
+  // express hints for the spec developers on things that could be improved
+  hintWarnings: string[];
 };
 export type MutationReport<T extends Transaction> = {
   resyncAccountsDuration: number;
@@ -144,5 +162,9 @@ export type MutationReport<T extends Transaction> = {
   confirmedTime?: number;
   finalAccount?: Account;
   testDuration?: number;
+  destinationConfirmedTime?: number;
+  finalDestination?: Account;
+  finalDestinationOperation?: Operation;
+  testDestinationDuration?: number;
   error?: Error;
 };

package/src/currencies/__snapshots__/sortByMarketcap.test.ts.snap

@@ -184,7 +184,7 @@ Array [
   "ethereum/erc20/dtr",
   "ethereum/erc20/crypto20",
   "ethereum/erc20/karatbank_coin",
-  "ethereum/erc20/ecoreal_estate",
+  "ethereum/erc20/ecoreal",
   "ethereum/erc20/bz",
   "ethereum/erc20/edcoin",
   "ethereum/erc20/btu_protocol",
@@ -1354,26 +1354,26 @@ Array [
   "ethereum/erc20/holotoken",
   "ethereum/erc20/etoro_euro",
   "near",
-  "arbitrum",
   "avalanche",
   "banano",
   "celo",
-  "cronos",
   "dexon",
   "elrond",
   "fic",
-  "flare",
   "flow",
   "icp",
   "LBRY",
-  "moonbeam",
   "moonriver",
   "musicoin",
-  "songbird",
   "reosc",
   "resistance",
   "osmo",
   "shyft",
+  "arbitrum",
+  "cronos",
+  "flare",
+  "songbird",
+  "moonbeam",
   "ethereum/erc20/$aapl",
   "ethereum/erc20/$based",
   "ethereum/erc20/$die",
@@ -2338,7 +2338,10 @@ Array [
   "ethereum/erc20/curio_governance_token",
   "ethereum/erc20/current",
   "ethereum/erc20/curryswap",
+  "ethereum/erc20/curve_crv-eth",
+  "ethereum/erc20/curve_cvx-eth",
   "ethereum/erc20/curve_dao_token",
+  "ethereum/erc20/curve_eurt-3crv",
   "ethereum/erc20/curve_fi",
   "ethereum/erc20/curve_fi_daiusdcusdt",
   "ethereum/erc20/curve_fi_daiusdcusdtsusd",
@@ -2348,6 +2351,33 @@ Array [
   "ethereum/erc20/curve_fi_renbtcwbtcsbtc",
   "ethereum/erc20/curve_fi_usd-btc-eth",
   "ethereum/erc20/curve_fi_usdk_3crv",
+  "ethereum/erc20/curvefi_cydaicyusdccyusdt",
+  "ethereum/erc20/curvefi_dusd3crv",
+  "ethereum/erc20/curvefi_ethaeth",
+  "ethereum/erc20/curvefi_ethsteth",
+  "ethereum/erc20/curvefi_factory_crypto_pool_yfieth",
+  "ethereum/erc20/curvefi_factory_plain_pool_3eurpool",
+  "ethereum/erc20/curvefi_factory_plain_pool_cvxcrv",
+  "ethereum/erc20/curvefi_factory_plain_pool_ibchfschf",
+  "ethereum/erc20/curvefi_factory_plain_pool_ibeurseur",
+  "ethereum/erc20/curvefi_factory_plain_pool_ibgbpsgbp",
+  "ethereum/erc20/curvefi_factory_plain_pool_ibkrwskrw",
+  "ethereum/erc20/curvefi_factory_plain_pool_neutrino_eur",
+  "ethereum/erc20/curvefi_factory_pool_aleth",
+  "ethereum/erc20/curvefi_factory_usd_metapool_alchemix_usd",
+  "ethereum/erc20/curvefi_factory_usd_metapool_binance_usd",
+  "ethereum/erc20/curvefi_factory_usd_metapool_dola-3pool_curve_lp",
+  "ethereum/erc20/curvefi_factory_usd_metapool_liquity",
+  "ethereum/erc20/curvefi_factory_usd_metapool_magic_internet_mone",
+  "ethereum/erc20/curvefi_factory_usd_metapool_origin_dollar",
+  "ethereum/erc20/curvefi_factory_usd_metapool_trueusd",
+  "ethereum/erc20/curvefi_gusd3crv",
+  "ethereum/erc20/curvefi_hbtcwbtc",
+  "ethereum/erc20/curvefi_musd3crv",
+  "ethereum/erc20/curvefi_obtcsbtccrv",
+  "ethereum/erc20/curvefi_tbtcsbtccrv",
+  "ethereum/erc20/curvefi_usd-btc-eth",
+  "ethereum/erc20/curvefi_usdn3crv",
   "ethereum/erc20/cute_coin",
   "ethereum/erc20/cvault_finance",
   "ethereum/erc20/cvtoken",
@@ -2649,6 +2679,7 @@ Array [
   "ethereum/erc20/eco_token",
   "ethereum/erc20/eco_value_coin",
   "ethereum/erc20/ecofi_token",
+  "ethereum/erc20/ecoreal_estate_old",
   "ethereum/erc20/ecoscu",
   "ethereum/erc20/ecpn_token",
   "ethereum/erc20/edda",
@@ -3113,6 +3144,7 @@ Array [
   "ethereum/erc20/green_metaverse_token",
   "ethereum/erc20/green_token",
   "ethereum/erc20/greenmed",
+  "ethereum/erc20/greenmetaversetoken",
   "ethereum/erc20/grey_token",
   "ethereum/erc20/gridzone_io",
   "ethereum/erc20/grind_token",
@@ -3130,6 +3162,7 @@ Array [
   "ethereum/erc20/guarded_ether",
   "ethereum/erc20/guarded_ether_old",
   "ethereum/erc20/guild_of_guardians",
+  "ethereum/erc20/guildfi_token",
   "ethereum/erc20/guld_erc20",
   "ethereum/erc20/gunthy",
   "ethereum/erc20/guss_one",
@@ -3420,6 +3453,7 @@ Array [
   "ethereum/erc20/keytango_token",
   "ethereum/erc20/khipu_token",
   "ethereum/erc20/ki",
+  "ethereum/erc20/kiba_inu",
   "ethereum/erc20/kids_cash",
   "ethereum/erc20/kiloample",
   "ethereum/erc20/kimchi_finance",
@@ -4276,9 +4310,11 @@ Array [
   "ethereum/erc20/racing_pigeon_coin",
   "ethereum/erc20/radar",
   "ethereum/erc20/radicle",
+  "ethereum/erc20/radio_caca_v2",
   "ethereum/erc20/radioyo",
   "ethereum/erc20/ragetoken",
   "ethereum/erc20/rai",
+  "ethereum/erc20/rai3crv",
   "ethereum/erc20/rai_finance",
   "ethereum/erc20/rai_reflex_index",
   "ethereum/erc20/raid_guild_token_âš”ï¸_x008f_",
@@ -4539,6 +4575,7 @@ Array [
   "ethereum/erc20/shinigami_inu",
   "ethereum/erc20/shipit_pro",
   "ethereum/erc20/shiryo-inu",
+  "ethereum/erc20/shita-kiri_suzume",
   "ethereum/erc20/shitcoin",
   "ethereum/erc20/shopping_io",
   "ethereum/erc20/showcase_token",
@@ -4552,6 +4589,7 @@ Array [
   "ethereum/erc20/siacashcoin",
   "ethereum/erc20/siambitcoin",
   "ethereum/erc20/siberian_husky",
+  "ethereum/erc20/sid_token",
   "ethereum/erc20/sideshift_token",
   "ethereum/erc20/sienna_(erc20)",
   "ethereum/erc20/sift",
@@ -5227,6 +5265,7 @@ Array [
   "ethereum/erc20/vision_network",
   "ethereum/erc20/vision_token",
   "ethereum/erc20/visor",
+  "ethereum/erc20/vita_inu",
   "ethereum/erc20/vitadao_token",
   "ethereum/erc20/viu",
   "ethereum/erc20/vixco",
@@ -5724,6 +5763,7 @@ Array [
   "polygon/erc20/dfyn_token_(pos)",
   "polygon/erc20/dhedge_dao_token",
   "polygon/erc20/dogelon",
+  "polygon/erc20/dominium",
   "polygon/erc20/dovu",
   "polygon/erc20/dragon_quick",
   "polygon/erc20/dsla",
@@ -5824,6 +5864,7 @@ Array [
   "polygon/erc20/mimatic",
   "polygon/erc20/minerva_wallet_supertoken",
   "polygon/erc20/moo_curve_atricrypto3",
+  "polygon/erc20/moo_curve_stmatic-matic",
   "polygon/erc20/moo_mai_usdc-mimatic",
   "polygon/erc20/moonwolf_io",
   "polygon/erc20/mover",
@@ -5832,6 +5873,7 @@ Array [
   "polygon/erc20/mysterium_(pos)",
   "polygon/erc20/nakamoto.games",
   "polygon/erc20/napoleonx",
+  "polygon/erc20/nash_exchange_token_(pos)",
   "polygon/erc20/neighbourhoods_token",
   "polygon/erc20/neos_credits_(pos)",
   "polygon/erc20/nexo",
@@ -5910,6 +5952,7 @@ Array [
   "polygon/erc20/stake_dao_curve_amdaiamusdcamusdt",
   "polygon/erc20/stake_dao_token_(pos)",
   "polygon/erc20/staked_abi",
+  "polygon/erc20/staked_dominium",
   "polygon/erc20/staked_matic_(pos)",
   "polygon/erc20/stakewise",
   "polygon/erc20/stasis_eurs_token",
@@ -6003,6 +6046,7 @@ Array [
   "bsc/bep20/2030floki",
   "bsc/bep20/accel_bnb_pre_sale",
   "bsc/bep20/acryptos",
+  "bsc/bep20/acts_token",
   "bsc/bep20/adex_network",
   "bsc/bep20/aleph.im_v2",
   "bsc/bep20/alice",
@@ -6041,6 +6085,7 @@ Array [
   "bsc/bep20/bakerytoken",
   "bsc/bep20/bat_true_dollar",
   "bsc/bep20/bat_true_share",
+  "bsc/bep20/battleinfinity",
   "bsc/bep20/bb_verse",
   "bsc/bep20/bdollar",
   "bsc/bep20/bdollar_share",
@@ -6246,6 +6291,7 @@ Array [
   "bsc/bep20/gforce",
   "bsc/bep20/gg_token",
   "bsc/bep20/gomining_token",
+  "bsc/bep20/good_games_guild",
   "bsc/bep20/goose_coin",
   "bsc/bep20/goose_golden_egg",
   "bsc/bep20/gorilladiamond",
@@ -6338,6 +6384,7 @@ Array [
   "bsc/bep20/movez.me",
   "bsc/bep20/mtlx-erc20",
   "bsc/bep20/multiplier",
+  "bsc/bep20/musicverse",
   "bsc/bep20/muuinu",
   "bsc/bep20/mx_token",
   "bsc/bep20/my_defi_pet_token",
@@ -6480,6 +6527,7 @@ Array [
   "bsc/bep20/tft_on_bsc",
   "bsc/bep20/the_force_token",
   "bsc/bep20/the_sandbox",
+  "bsc/bep20/thetan_gem",
   "bsc/bep20/thugs",
   "bsc/bep20/tiki",
   "bsc/bep20/titano",
@@ -6516,6 +6564,7 @@ Array [
   "bsc/bep20/vai_stablecoin",
   "bsc/bep20/vallhund_inu",
   "bsc/bep20/vanci.finance",
+  "bsc/bep20/veed",
   "bsc/bep20/venus",
   "bsc/bep20/venus_ada",
   "bsc/bep20/venus_bch",

package/src/currencies/sortByMarketcap.ts

@@ -20,7 +20,12 @@ function lazyLoadTickerMap() {
     }
   });
   listCryptoCurrencies().forEach((c) => {
-    if (!c.disableCountervalue) {
+    if (
+      !c.disableCountervalue &&
+      // FIXME Avoid duplicates & override if the already set currency is a token
+      // E.g. 'Binance-Peg Ethereum Token' has an 'ETH' ticker
+      (!m.has(c.ticker) || m.get(c.ticker)?.type !== "CryptoCurrency")
+    ) {
       m.set(c.ticker, c);
     }
   });

package/src/currencies/support.ts

@@ -75,7 +75,8 @@ export function listSupportedFiats(): FiatCurrency[] {
   return userSupportedFiats;
 }
 export function setSupportedCurrencies(ids: CryptoCurrencyIds[]) {
-  userSupportedCurrencies = ids.map((id) => getCryptoCurrencyById(id));
+  userSupportedCurrencies = Array.from(new Set(ids)) // Make sure to remove duplicates
+    .map((id) => getCryptoCurrencyById(id));
 }
 
 function getExperimentalSupports() {

package/src/derivation.ts

@@ -156,16 +156,14 @@ const modes = Object.freeze({
   polkadotbip44: {
     overridesDerivation: "44'/354'/<account>'/0'/<address>'",
   },
-  // glif legacy derivation
   gliflegacy: {
     overridesDerivation: "44'/1'/0'/0/<account>",
-    tag: "glif-legacy",
+    tag: "legacy",
   },
-  // glif normal derivation
   glif: {
     overridesDerivation: "44'/461'/0'/0/<account>",
     startsAt: 1,
-    tag: "glif",
+    tag: "third-party",
   },
   solanaMain: {
     isNonIterable: true,

package/src/env.ts

@@ -500,7 +500,7 @@ const envDefinitions = {
     desc: "dev flag to skip onboarding flow",
   },
   SWAP_API_BASE: {
-    def: "https://swap.ledger.com/v3",
+    def: "https://swap.ledger.com/v4",
     parser: stringParser,
     desc: "Swap API base",
   },

package/src/exchange/swap/getExchangeRates.ts

@@ -13,7 +13,12 @@ import {
 } from "../../errors";
 import network from "../../network";
 import type { Transaction } from "../../generated/types";
-import { getAvailableProviders, getSwapAPIBaseURL, getSwapAPIError } from "./";
+import {
+  getAvailableProviders,
+  getSwapAPIBaseURL,
+  getSwapAPIError,
+  getSwapAPIVersion,
+} from "./";
 import { mockGetExchangeRates } from "./mock";
 import type { CustomMinOrMaxError, Exchange, GetExchangeRates } from "./types";
 
@@ -26,8 +31,7 @@ const getExchangeRates: GetExchangeRates = async (
   if (getEnv("MOCK"))
     return mockGetExchangeRates(exchange, transaction, currencyTo);
 
-  // Rely on the api base to determine the version logic
-  const usesV3 = getSwapAPIBaseURL().endsWith("v3");
+  const usesV3 = getSwapAPIVersion() >= 3;
   const from = getAccountCurrency(exchange.fromAccount).id;
   const unitFrom = getAccountUnit(exchange.fromAccount);
   const unitTo =
@@ -135,8 +139,11 @@ const inferError = (
     }
 
     // For out of range errors we will have a min/max pairing
-    if (minAmountFrom) {
-      const isTooSmall = new BigNumber(apiAmount).lte(minAmountFrom);
+    const hasAmountLimit = minAmountFrom || maxAmountFrom;
+    if (hasAmountLimit) {
+      const isTooSmall = minAmountFrom
+        ? new BigNumber(apiAmount).lte(minAmountFrom)
+        : false;
 
       const MinOrMaxError = isTooSmall
         ? SwapExchangeRateAmountTooLow