@ledgerhq/live-common 33.2.0 → 33.3.0-next.0

package/src/currencies/cryptoIcons.ts

@@ -0,0 +1,19 @@
+// logic that infer a crypto icons slug from a currency
+
+import type { CryptoCurrency, TokenCurrency } from "@ledgerhq/types-cryptoassets";
+import camelCase from "lodash/camelCase";
+
+export function inferCryptoCurrencyIcon<Icon>(
+  iconsRegistry: Record<string, Icon>,
+  currency: CryptoCurrency | TokenCurrency,
+): Icon | null | undefined {
+  // FIXME DEPRECATED (ongoing hack due to ticker collision)
+  if (currency.disableCountervalue) return null;
+  // we allow the icons to define a currency_{id} format
+  const maybeIconById = iconsRegistry[camelCase(`currency_${currency.id}`).toUpperCase()];
+  if (maybeIconById) return maybeIconById;
+  // otherwise we fallback by a token lookup
+  let id = currency.ticker.toUpperCase();
+  if (!isNaN(parseInt(id.charAt(0), 10))) id = `_${id}`; // fix variable name leading with a numerical value
+  return iconsRegistry[id];
+}

package/src/currencies/hooks.ts

@@ -0,0 +1,24 @@
+import { sortCurrenciesByIds, fetchMarketcapIds, getMarketcapIdsSync } from "./sortByMarketcap";
+import type { Currency } from "@ledgerhq/types-cryptoassets";
+import { useEffect, useState } from "react";
+
+// React style version of getMarketcapIds
+export const useMarketcapIds = (): string[] | null | undefined => {
+  const [ids, setMarketcapIds] = useState(getMarketcapIdsSync());
+  useEffect(() => {
+    let isMounted = true;
+    fetchMarketcapIds().then(data => {
+      if (isMounted) setMarketcapIds(data);
+    });
+    return () => {
+      isMounted = false;
+    };
+  }, []);
+  return ids;
+};
+
+// React style version of currenciesByMarketcap
+export const useCurrenciesByMarketcap = <C extends Currency>(currencies: C[]): C[] => {
+  const ids = useMarketcapIds();
+  return ids ? sortCurrenciesByIds(currencies, ids) : currencies;
+};

package/src/currencies/index.ts

@@ -35,13 +35,7 @@ import {
 } from "@ledgerhq/coin-framework/currencies/index";
 import { getCurrencyColor, ColorableCurrency } from "./color";
 import { parseCurrencyUnit } from "@ledgerhq/coin-framework/currencies/parseCurrencyUnit";
-import {
-  sortByMarketcap,
-  getMarketcapTickers,
-  useMarketcapTickers,
-  currenciesByMarketcap,
-  useCurrenciesByMarketcap,
-} from "./sortByMarketcap";
+import { sortCurrenciesByIds, currenciesByMarketcap } from "./sortByMarketcap";
 
 export * from "@ledgerhq/coin-framework/currencies/BigNumberToLocaleString";
 export * from "@ledgerhq/coin-framework/currencies/formatCurrencyUnit";
@@ -49,11 +43,8 @@ export * from "@ledgerhq/coin-framework/currencies/support";
 export * from "./helpers";
 
 export {
-  sortByMarketcap,
-  getMarketcapTickers,
-  useMarketcapTickers,
+  sortCurrenciesByIds,
   currenciesByMarketcap,
-  useCurrenciesByMarketcap,
   listFiatCurrencies,
   listCryptoCurrencies,
   getFiatCurrencyByTicker,

package/src/currencies/mock.ts

@@ -1,44 +1,44 @@
 import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 
-export const TICKERS = [
-  "BTC",
-  "ETH",
-  "USDT",
-  "BNB",
-  "XRP",
-  "USDC",
-  "SOL",
-  "ADA",
-  "DOGE",
-  "TRX",
-  "TON",
-  "LINK",
-  "MATIC",
-  "DOT",
-  "WBTC",
-  "DAI",
-  "LTC",
-  "BCH",
-  "SHIB",
-  "AVAX",
-  "LEO",
-  "XLM",
-  "TUSD",
-  "XMR",
-  "ATOM",
-  "OKB",
-  "ETC",
-  "UNI",
-  "BUSD",
-  "NEAR",
-  "INJ",
-  "EGLD",
-  "XTZ",
-  "CELO",
-  "OSMO",
-  "AXL",
-  "XPRT",
-  "NOM",
+export const IDS = [
+  "bitcoin",
+  "ethereum",
+  "ethereum/erc20/usd_tether__erc20_",
+  "bsc",
+  "ripple",
+  "ethereum/erc20/usd__coin",
+  "solana",
+  "cardano",
+  "dogecoin",
+  "tron",
+  "ethereum/erc20/tontoken",
+  "ethereum/erc20/link_chainlink",
+  "polygon",
+  "polkadot",
+  "ethereum/erc20/wrapped_bitcoin",
+  "ethereum/erc20/dai_stablecoin_v2_0",
+  "litecoin",
+  "bitcoin_cash",
+  "ethereum/erc20/shiba_inu",
+  "avalanche_c_chain",
+  "ethereum/erc20/leo_token",
+  "stellar",
+  "ethereum/erc20/trueusd",
+  "monero",
+  "cosmos",
+  "ethereum/erc20/okb",
+  "ethereum_classic",
+  "ethereum/erc20/uniswap",
+  "ethereum/erc20/binance_usd",
+  "near",
+  "injective",
+  "elrond",
+  "tezos",
+  "celo",
+  "osmo",
+  "axelar",
+  "persistence",
+  "onomy",
 ];
 
 export const CURRENCIES_LIST: CryptoCurrency[] = [
@@ -482,8 +482,8 @@ export const CURRENCIES_LIST: CryptoCurrency[] = [
     ],
     explorerViews: [
       {
-        address: "https://explorer.near.org/accounts/$address",
-        tx: "https://explorer.near.org/transactions/$hash",
+        address: "https://nearblocks.io/address/$address",
+        tx: "https://nearblocks.io/txns/$hash",
       },
     ],
     keywords: ["near"],

package/src/currencies/sortByMarketcap.test.ts

@@ -1,16 +1,22 @@
-import { sortByMarketcap } from "./sortByMarketcap";
-import { listCryptoCurrencies, listTokens } from ".";
+import { sortCurrenciesByIds } from "./sortByMarketcap";
+import { findCurrencyByTicker, listCryptoCurrencies, listTokens } from ".";
 import { getBTCValues } from "../countervalues/mock";
-import { CURRENCIES_LIST, TICKERS } from "./mock";
+import { CURRENCIES_LIST, IDS } from "./mock";
 
-test("sortByMarketcap snapshot", () => {
+test("sortCurrenciesByIds snapshot", () => {
   const list = [...listCryptoCurrencies(), ...listTokens()];
-  const tickers = Object.keys(getBTCValues());
-  expect(sortByMarketcap(list, tickers).map(c => c.id)).toMatchSnapshot();
+  const ids: string[] = [];
+  for (const k in getBTCValues()) {
+    const c = findCurrencyByTicker(k);
+    if (c && (c.type == "CryptoCurrency" || c.type == "TokenCurrency")) {
+      ids.push(c.id);
+    }
+  }
+  expect(sortCurrenciesByIds(list, ids).map(c => c.id)).toMatchSnapshot();
 });
 
-test("sortByMarketcap simulate staking from portfolio", () => {
-  expect(sortByMarketcap(CURRENCIES_LIST, TICKERS).map(c => c.id)).toEqual([
+test("sortCurrenciesByIds simulate staking from portfolio", () => {
+  expect(sortCurrenciesByIds(CURRENCIES_LIST, IDS).map(c => c.id)).toEqual([
     "ethereum",
     "solana",
     "cardano",

package/src/currencies/sortByMarketcap.ts

@@ -1,95 +1,40 @@
-import { listCryptoCurrencies } from "@ledgerhq/coin-framework/currencies/index";
-import { listTokens } from "@ledgerhq/cryptoassets";
 import { makeLRUCache } from "@ledgerhq/live-network/cache";
 import type { Currency } from "@ledgerhq/types-cryptoassets";
-import { useEffect, useState } from "react";
 import api from "../countervalues/api";
 
-// FIXME in future we would put it back in ledgerjs to be more "dynamic"
-let currenciesAndTokenWithCountervaluesByTicker: Map<string, Currency> | null | undefined;
-
-function lazyLoadTickerMap() {
-  if (currenciesAndTokenWithCountervaluesByTicker)
-    return currenciesAndTokenWithCountervaluesByTicker;
-  const m: Map<string, Currency> = new Map();
-  listTokens().forEach(t => {
-    if (!t.disableCountervalue && !m.has(t.ticker)) {
-      m.set(t.ticker, t);
-    }
-  });
-  listCryptoCurrencies().forEach(c => {
-    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);
+// sort currencies by ids provided
+export const sortCurrenciesByIds = <C extends Currency>(currencies: C[], ids: string[]): C[] => {
+  const currenciesById = new Map();
+  for (const c of currencies) {
+    if (c.type !== "FiatCurrency") {
+      currenciesById.set(c.id, c);
     }
-  });
-  currenciesAndTokenWithCountervaluesByTicker = m;
-  return m;
-}
-
-function getCurrencyId(currency: Currency): string {
-  if ("id" in currency && currency.id) {
-    return currency.id;
   }
-  return currency.ticker;
-}
-
-export const sortByMarketcap = <C extends Currency>(currencies: C[], tickers: string[]): C[] => {
-  const tickerMap = lazyLoadTickerMap();
-  const sortedCurrenciesMap: Map<string, C> = new Map();
-  const currenciesSet = new Set(currencies.map(currency => getCurrencyId(currency)));
-
-  tickers.forEach(ticker => {
-    const currency = tickerMap.get(ticker) as C | undefined;
+  const all = new Set<C>();
+  for (const id of ids) {
+    const currency = currenciesById.get(id);
     if (currency) {
-      const currencyId = getCurrencyId(currency);
-      if (currency && currenciesSet.has(currencyId)) {
-        sortedCurrenciesMap.set(currencyId, currency);
-      }
+      all.add(currency);
     }
-  });
-
-  const remainingCurrencies = currencies.filter(
-    currency => !sortedCurrenciesMap.has(getCurrencyId(currency)),
-  );
-
-  return Array.from(sortedCurrenciesMap.values()).concat(remainingCurrencies);
+  }
+  for (const cur of currencies) {
+    all.add(cur);
+  }
+  return [...all];
 };
 
-let marketcapTickersCache;
-export const getMarketcapTickers: () => Promise<string[]> = makeLRUCache(() =>
-  api.fetchMarketcapTickers().then(tickers => {
-    marketcapTickersCache = tickers;
-    return tickers;
+let marketcapIdsCache;
+export const getMarketcapIdsSync = () => marketcapIdsCache;
+
+export const fetchMarketcapIds: () => Promise<string[]> = makeLRUCache(() =>
+  api.fetchIdsSortedByMarketcap().then(ids => {
+    marketcapIdsCache = ids;
+    return ids;
   }),
 );
-// React style version of getMarketcapTickers
-export const useMarketcapTickers = (): string[] | null | undefined => {
-  const [tickers, setMarketcapTickers] = useState(marketcapTickersCache);
-  useEffect(() => {
-    let isMounted = true;
 
-    getMarketcapTickers().then(data => {
-      if (isMounted) setMarketcapTickers(data);
-    });
-
-    return () => {
-      isMounted = false;
-    };
-  }, []);
-  return tickers;
-};
 export const currenciesByMarketcap = <C extends Currency>(currencies: C[]): Promise<C[]> =>
-  getMarketcapTickers().then(
-    tickers => sortByMarketcap(currencies, tickers),
+  fetchMarketcapIds().then(
+    ids => sortCurrenciesByIds(currencies, ids),
     () => currencies,
   );
-// React style version of currenciesByMarketcap
-export const useCurrenciesByMarketcap = <C extends Currency>(currencies: C[]): C[] => {
-  const tickers = useMarketcapTickers();
-  return tickers ? sortByMarketcap(currencies, tickers) : currencies;
-};

package/src/deviceSDK/actions/getLatestAvailableFirmware.test.ts

@@ -14,7 +14,7 @@ import { sharedLogicTaskWrapper } from "../tasks/core";
 
 // Needed for rxjs timeout
 jest.useFakeTimers();
-// Needs to mock the timer from rxjs used in the task retry mechanism (`retryWhen` with `timer`)
+// Needs to mock the timer from rxjs used in the task retry mechanism (`retry` with `timer`)
 jest.mock("rxjs", () => {
   const originalModule = jest.requireActual("rxjs");
 

package/src/deviceSDK/actions/updateFirmware.ts

@@ -15,6 +15,8 @@ export type UpdateFirmwareActionState = FullActionState<{
     | "preparingUpdate"
     // initial step where we retrieve all the necessary information for the update
     | "allowSecureChannelRequested"
+    // the user has refused the allow secure channel that could have been triggered at the initial step
+    | "allowSecureChannelDenied"
     // we need a secure connection to the HSM to install the operating system updater (osu)
     | "installingOsu"
     // step that installs the operating system updater, always happen
@@ -92,6 +94,7 @@ export function updateFirmwareAction({
               progress: event.progress,
             };
           case "allowSecureChannelRequested":
+          case "allowSecureChannelDenied":
           case "installOsuDevicePermissionRequested":
           case "installOsuDevicePermissionGranted":
           case "installOsuDevicePermissionDenied":

package/src/deviceSDK/commands/core.ts

@@ -1 +1,3 @@
+export const LOG_TYPE = "device-sdk-command";
+
 export type UnresponsiveCmdEvent = { type: "unresponsive" };

package/src/deviceSDK/commands/firmwareUpdate/flashMcuOrBootloader.ts

@@ -4,9 +4,10 @@ import Transport from "@ledgerhq/hw-transport";
 import type { DeviceInfo, SocketEvent } from "@ledgerhq/types-live";
 import { version as livecommonversion } from "../../../../package.json";
 import { getEnv } from "@ledgerhq/live-env";
-import { log } from "@ledgerhq/logs";
+import { LocalTracer } from "@ledgerhq/logs";
 import { createDeviceSocket } from "../../../socket";
 import { filter, map } from "rxjs/operators";
+import { LOG_TYPE } from "../core";
 
 export type FlashMcuOrBootloaderCommandRequest = {
   targetId: DeviceInfo["targetId"];
@@ -38,7 +39,9 @@ export function flashMcuOrBootloaderCommand(
   transport: Transport,
   { targetId, version }: FlashMcuOrBootloaderCommandRequest,
 ): Observable<FlashMcuCommandEvent> {
-  log("device-command", "flashMcuOrBootloader", {
+  const tracer = new LocalTracer(LOG_TYPE, { function: "flashMcuOrBootloaderCommand" });
+
+  tracer.trace("Starting", {
     targetId,
     version,
   });
@@ -52,6 +55,7 @@ export function flashMcuOrBootloaderCommand(
         version,
       },
     }),
+    context: tracer.getContext(),
   }).pipe(
     filter<SocketEvent, ProgressEvent>(filterProgressEvent),
     map(e => ({

package/src/deviceSDK/commands/firmwareUpdate/installFirmware.ts

@@ -5,7 +5,7 @@ import type { FinalFirmware, OsuFirmware } from "@ledgerhq/types-live";
 import type { DeviceInfo, SocketEvent } from "@ledgerhq/types-live";
 import { version as livecommonversion } from "../../../../package.json";
 import { getEnv } from "@ledgerhq/live-env";
-import { log } from "@ledgerhq/logs";
+import { LocalTracer } from "@ledgerhq/logs";
 import { createDeviceSocket } from "../../../socket";
 import { catchError, filter, map } from "rxjs/operators";
 import {
@@ -14,7 +14,7 @@ import {
   DeviceOnDashboardExpected,
   ManagerDeviceLockedError,
 } from "@ledgerhq/errors";
-import { UnresponsiveCmdEvent } from "../core";
+import { LOG_TYPE, UnresponsiveCmdEvent } from "../core";
 
 export type InstallFirmwareCommandRequest = {
   targetId: DeviceInfo["targetId"];
@@ -49,11 +49,12 @@ export type InstallFirmwareCommandEvent =
   | UnresponsiveCmdEvent;
 
 /**
- * Creates a scriptrunner connection with the /install API endpoint of the HSM in order to install
+ * Creates a scriptrunner connection with the /install API endpoint of the HSM in order to install (upload)
  * an OSU (operating system updater).
  * This is the same endpoint that is used to install applications, however the parameters that are
  * passed are different. Besides that, the emitted events are semantically different. This is why
  * this is a dedicated command to OSU installations.
+ *
  * @param transport The transport object to contact the device
  * @param param1 The firmware details to be installed
  * @returns An observable that emits the events according to the progression of the firmware installation
@@ -62,9 +63,9 @@ export function installFirmwareCommand(
   transport: Transport,
   { targetId, firmware }: InstallFirmwareCommandRequest,
 ): Observable<InstallFirmwareCommandEvent> {
-  // TODO handle mock
+  const tracer = new LocalTracer(LOG_TYPE, { function: "installFirmwareCommand" });
 
-  log("device-command", "installOsuFirmware", {
+  tracer.trace("Starting", {
     targetId,
     osuFirmware: firmware,
   });
@@ -81,8 +82,12 @@ export function installFirmwareCommand(
       },
     }),
     unresponsiveExpectedDuringBulk: true,
+    context: tracer.getContext(),
   }).pipe(
-    catchError(remapSocketFirmwareError),
+    catchError(error => {
+      tracer.trace("Socket firmware error", { error });
+      return remapSocketFirmwareError(error);
+    }),
     filter<SocketEvent, FilteredSocketEvent>((e): e is FilteredSocketEvent => {
       return e.type === "bulk-progress" || e.type === "device-permission-requested";
     }),
@@ -108,7 +113,10 @@ export function installFirmwareCommand(
       // then type is "device-permission-requested"
       return { type: "allowSecureChannelRequested" };
     }),
-    catchError(remapSocketUnresponsiveError),
+    catchError(error => {
+      tracer.trace("Socket unresponsive error", { error });
+      return remapSocketUnresponsiveError(error);
+    }),
   );
 }
 
@@ -132,8 +140,7 @@ const remapSocketFirmwareError: (e: Error) => Observable<never> = (e: Error) =>
 
   const status =
     e instanceof TransportStatusError
-      ? // @ts-expect-error TransportStatusError to be typed on ledgerjs
-        e.statusCode.toString(16)
+      ? e.statusCode.toString(16)
       : (e as Error).message.slice((e as Error).message.length - 4);
 
   switch (status) {

package/src/deviceSDK/commands/toggleOnboardingEarlyCheck.test.ts

@@ -17,7 +17,6 @@ describe("@deviceSDK/commands/toggleOnboardingEarlyCheckCmd", () => {
         error: (error: unknown) => {
           try {
             if (error instanceof TransportStatusError) {
-              // @ts-expect-error TransportStatusError not typed correctly
               expect(error.statusCode).toBe(StatusCodes.SECURITY_STATUS_NOT_SATISFIED);
               done();
             } else {
@@ -45,7 +44,6 @@ describe("@deviceSDK/commands/toggleOnboardingEarlyCheckCmd", () => {
         error: (error: unknown) => {
           try {
             if (error instanceof TransportStatusError) {
-              // @ts-expect-error TransportStatusError not typed correctly
               expect(error.statusCode).toBe(StatusCodes.INCORRECT_LENGTH);
               done();
             } else {

package/src/deviceSDK/hooks/useBatteryStatuses.ts

@@ -1,11 +1,13 @@
 import { useCallback, useEffect, useState } from "react";
+import { log } from "@ledgerhq/logs";
+import { BatteryStatusFlags } from "@ledgerhq/types-devices";
 import {
   getBatteryStatusesAction,
   GetBatteryStatusesActionState,
   initialState,
 } from "../actions/getBatteryStatuses";
 import { BatteryStatusTypes } from "../../hw/getBatteryStatus";
-import { log } from "@ledgerhq/logs";
+import { useEnv } from "../../env.react";
 
 export type UseBateryStatusesArgs = {
   deviceId?: string;
@@ -32,12 +34,16 @@ export const useBatteryStatuses = ({
   requestCompleted: boolean;
   triggerRequest: () => void;
   cancelRequest: () => void;
+  isBatteryLow: boolean;
+  lowBatteryPercentage: number;
 } => {
   const [batteryStatusesState, setBatteryStatusesState] =
     useState<GetBatteryStatusesActionState>(initialState);
   const [requestCompleted, setRequestCompleted] = useState<boolean>(false);
   const [nonce, setNonce] = useState(0);
   const [cancelRequest, setCancelRequest] = useState<() => void>(() => {});
+  const [isBatteryLow, setIsBatteryLow] = useState<boolean>(false);
+  const lowBatteryPercentage = useEnv("LOW_BATTERY_PERCENTAGE");
 
   useEffect(() => {
     if (nonce > 0 && deviceId) {
@@ -45,7 +51,22 @@ export const useBatteryStatuses = ({
         deviceId,
         statuses,
       }).subscribe({
-        next: state => setBatteryStatusesState(state),
+        next: state => {
+          if (state.error?.type === "UnknownApdu") {
+            setBatteryStatusesState({ ...state, error: null });
+          } else {
+            setBatteryStatusesState(state);
+          }
+
+          // no battery status flags available
+          if (state.batteryStatuses.length <= 1) return;
+
+          const [percentage, statusFlags] = state.batteryStatuses as [number, BatteryStatusFlags];
+
+          if (percentage < lowBatteryPercentage && statusFlags.charging === 0) {
+            setIsBatteryLow(true);
+          }
+        },
         complete: () => {
           setRequestCompleted(true);
         },
@@ -62,10 +83,11 @@ export const useBatteryStatuses = ({
         sub.unsubscribe();
       };
     }
-  }, [deviceId, statuses, nonce]);
+  }, [deviceId, lowBatteryPercentage, statuses, nonce]);
 
   const triggerRequest = useCallback(() => {
     setRequestCompleted(false);
+    setIsBatteryLow(false);
     setBatteryStatusesState(initialState);
     setNonce(nonce => nonce + 1);
   }, []);
@@ -75,5 +97,7 @@ export const useBatteryStatuses = ({
     triggerRequest,
     requestCompleted,
     cancelRequest,
+    isBatteryLow,
+    lowBatteryPercentage,
   };
 };

package/src/deviceSDK/tasks/core.test.ts

@@ -212,7 +212,7 @@ describe("retryOnErrorsCommandWrapper", () => {
           concatMap(_event => {
             counter++;
 
-            // Throws an error even after the limit is reached
+            // Always throws an error, exceeding the set max retry
             return throwError(
               () => new DisconnectedDevice(`Handled error max ${disconnectedDeviceMaxRetries}`),
             );