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

package/src/load/speculos.ts

@@ -21,6 +21,24 @@ let idCounter = 0;
 
 const data = {};
 
+const modelMap: Record<string, DeviceModelId> = {
+  nanos: <DeviceModelId>"nanoS",
+  "nanos+": <DeviceModelId>"nanoSP",
+  nanox: <DeviceModelId>"nanoX",
+  blue: <DeviceModelId>"blue",
+};
+const reverseModelMap = {};
+for (const k in modelMap) {
+  reverseModelMap[modelMap[k]] = k;
+}
+const modelMapPriority: Record<string, number> = {
+  nanos: 4,
+  "nanos+": 3,
+  nanox: 2,
+  blue: 1,
+};
+const defaultFirmware: Record<string, string> = {};
+
 export async function releaseSpeculosDevice(id: string) {
   log("speculos", "release " + id);
   const obj = data[id];
@@ -34,6 +52,23 @@ export function closeAllSpeculosDevices() {
   return Promise.all(Object.keys(data).map(releaseSpeculosDevice));
 }
 
+// to keep in sync from https://github.com/LedgerHQ/speculos/tree/master/speculos/cxlib
+const existingSdks = [
+  "nanos-cx-2.0.elf",
+  "nanos-cx-2.1.elf",
+  "nanosp-cx-1.0.3.elf",
+  "nanosp-cx-1.0.elf",
+  "nanox-cx-2.0.2.elf",
+  "nanox-cx-2.0.elf",
+];
+
+function inferSDK(firmware: string, model: string): string | undefined {
+  const begin = `${model.toLowerCase()}-cx-`;
+  if (existingSdks.includes(begin + firmware + ".elf")) return firmware;
+  const shortVersion = firmware.slice(0, 3);
+  if (existingSdks.includes(begin + shortVersion + ".elf")) return shortVersion;
+}
+
 export async function createSpeculosDevice(
   arg: {
     model: DeviceModelId;
@@ -59,14 +94,11 @@ export async function createSpeculosDevice(
   const buttonPort = 42000 + idCounter;
   const automationPort = 43000 + idCounter;
 
-  // workaround until we have a clearer way to resolve sdk for a firmware.
-  const sdk =
-    model === "nanoX" ? "1.2" : model === "nanoS" ? firmware.slice(0, 3) : null;
+  const sdk = inferSDK(firmware, model);
 
-  const appPath = `./apps/${model.toLowerCase()}/${firmware}/${appName.replace(
-    / /g,
-    ""
-  )}/app_${appVersion}.elf`;
+  const appPath = `./apps/${
+    reverseModelMap[model]
+  }/${firmware}/${appName.replace(/ /g, "")}/app_${appVersion}.elf`;
 
   const params = [
     "run",
@@ -91,7 +123,7 @@ export async function createSpeculosDevice(
     ...(dependency
       ? [
           "-l",
-          `${dependency}:${`./apps/${model.toLowerCase()}/${firmware}/${dependency}/app_${appVersion}.elf`}`,
+          `${dependency}:${`./apps/${reverseModelMap[model]}/${firmware}/${dependency}/app_${appVersion}.elf`}`,
         ]
       : []),
     ...(sdk ? ["--sdk", sdk] : []),
@@ -213,17 +245,6 @@ export type AppCandidate = {
   appName: string;
   appVersion: string;
 };
-const modelMap: Record<string, DeviceModelId> = {
-  nanos: <DeviceModelId>"nanoS",
-  nanox: <DeviceModelId>"nanoX",
-  blue: <DeviceModelId>"blue",
-};
-const modelMapPriority: Record<string, number> = {
-  nanos: 3,
-  nanox: 2,
-  blue: 1,
-};
-const defaultFirmware: Record<string, string> = {};
 
 function hackBadSemver(str) {
   const split = str.split(".");
@@ -268,7 +289,6 @@ export async function listAppCandidates(cwd: string): Promise<AppCandidate[]> {
           if (elf.startsWith("app_") && elf.endsWith(".elf")) {
             const p4 = path.join(p3, elf);
             const appVersion = elf.slice(4, elf.length - 4);
-
             if (
               semver.valid(appVersion) &&
               !shouldUpgrade(model, appName, appVersion) &&
@@ -318,7 +338,8 @@ export function appCandidatesMatches(
           hackBadSemver(appCandidate.firmware),
           searchFirmware
         ))) &&
-    ((!search.appVersion && !appCandidate.appVersion.includes("-")) ||
+    (appCandidate.appVersion === search.appVersion ||
+      (!search.appVersion && !appCandidate.appVersion.includes("-")) ||
       (search.appVersion &&
         semver.satisfies(appCandidate.appVersion, search.appVersion)))
   );

package/src/manager/hooks.ts

@@ -76,18 +76,18 @@ export function useManagerBlueDot(
   return display;
 }
 
-export const useAvailableLanguagesForDevice = (
-  deviceInfo: DeviceInfo
-): Language[] => {
+export const useAvailableLanguagesForDevice = (deviceInfo?: DeviceInfo) => {
   const [availableLanguages, setAvailableLanguages] = useState<Language[]>([]);
+  const [loaded, setLoaded] = useState(false);
 
   useEffect(() => {
     if (deviceInfo) {
       manager
         .getAvailableLanguagesDevice(deviceInfo)
-        .then(setAvailableLanguages);
+        .then(setAvailableLanguages)
+        .finally(() => setLoaded(true));
     }
-  }, [deviceInfo, setAvailableLanguages]);
+  }, [deviceInfo]);
 
-  return availableLanguages;
+  return { availableLanguages, loaded };
 };

package/src/manager/localization.ts

@@ -3,8 +3,8 @@ import { satisfies as versionSatisfies } from "semver";
 
 const deviceVersionRangesForLocalization: { [key in DeviceModelId]?: string } =
   {
-    nanoX: ">=2.1.0 || =2.1.0-lo2 || =2.1.0-lo4 || =2.1.0-lo5",
-    nanoSP: ">=1.1.0 || =1.1.0-lo1",
+    nanoX: ">=2.1.0 || =2.1.0-lo2 || =2.1.0-lo4 || =2.1.0-lo5  || =2.1.0-rc1",
+    nanoSP: ">=1.1.0 || =1.1.0-lo1 || =1.1.0-rc1",
   };
 
 export const isDeviceLocalizationSupported = (

package/src/mock/account.ts

@@ -183,25 +183,22 @@ const hardcodedMarketcap = [
   "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 tickerApproxMarketPrice = {
-  BTC: 0.0073059,
-  ETH: 5.7033e-14,
-  ETC: 1.4857e-15,
-  BCH: 0.0011739,
-  BTG: 0.00005004,
-  LTC: 0.00011728,
-  XRP: 0.000057633,
-  DOGE: 4.9e-9,
-  DASH: 0.0003367,
-  PPC: 0.000226,
-  ZEC: 0.000205798,
+const currencyIdApproxMarketPrice = {
+  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) =>
-    tickerApproxMarketPrice[c.ticker] &&
-    // take only "official" currencies, otherwise you might end up with ticker collisions
-    c.name === c.managerAppName
+  (c) => currencyIdApproxMarketPrice[c.id]
 );
 // TODO fix the mock to never generate negative balance...
 
@@ -225,11 +222,12 @@ export function genOperation(
   );
   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()) /
-        (tickerApproxMarketPrice[ticker] || tickerApproxMarketPrice.BTC)
-    )
+    Math.floor(rng.nextInt(0, 100000 * rng.next() * rng.next()) / divider)
   );
 
   if (Number.isNaN(value)) {

package/src/notifications/ServiceStatusProvider/index.tsx

@@ -47,7 +47,14 @@ export function filterServiceStatusIncidents(
   incidents: Incident[],
   tickers: string[] = []
 ): Incident[] {
-  if (!tickers || tickers.length === 0) return [];
+  if (
+    !tickers ||
+    tickers.length === 0 ||
+    !incidents ||
+    incidents.length === 0
+  ) {
+    return [];
+  }
 
   const tickersRegex = new RegExp(escapeRegExp(tickers.join("|")), "i");
   return incidents.filter(

package/src/postOnboarding/PostOnboardingProvider.tsx

@@ -0,0 +1,49 @@
+import React, { PropsWithChildren } from "react";
+import { DeviceModelId } from "@ledgerhq/types-devices";
+import {
+  PostOnboardingAction,
+  PostOnboardingActionId,
+} from "@ledgerhq/types-live";
+
+export type PostOnboardingDependencies = {
+  /** function to navigate to the post onboarding hub */
+  navigateToPostOnboardingHub: () => void;
+  /**
+   * function that returns a `PostOnboardingAction` for the given
+   * `PostOnboardingActionId` parameter.
+   * */
+  getPostOnboardingAction?: (
+    id: PostOnboardingActionId
+  ) => PostOnboardingAction;
+  /**
+   * function that returns an array of `PostOnboardingAction` for the given
+   * `DeviceModelId` parameter.
+   */
+  getPostOnboardingActionsForDevice: (
+    id: DeviceModelId,
+    mock?: boolean
+  ) => PostOnboardingAction[];
+};
+
+const defaultValue: PostOnboardingDependencies = {
+  navigateToPostOnboardingHub: () => {},
+  getPostOnboardingAction: undefined,
+  getPostOnboardingActionsForDevice: () => [],
+};
+
+export const PostOnboardingContext = React.createContext(defaultValue);
+
+export const PostOnboardingProvider: React.FC<
+  PropsWithChildren<PostOnboardingDependencies>
+> = ({ children, ...props }) => {
+  if (!props.getPostOnboardingAction) {
+    console.warn(
+      "`getPostOnboardingAction` prop is undefined in the current PostOnboardingProvider. Without this, the post onboarding is not able to function normally."
+    );
+  }
+  return (
+    <PostOnboardingContext.Provider value={props}>
+      {children}
+    </PostOnboardingContext.Provider>
+  );
+};

package/src/postOnboarding/actions.ts

@@ -0,0 +1,40 @@
+import { DeviceModelId } from "@ledgerhq/types-devices";
+import {
+  PostOnboardingActionId,
+  PostOnboardingState,
+} from "@ledgerhq/types-live";
+
+type ActionCreatorPlain = () => { type: string };
+type ActionCreator<T> = (arg0: T) => ReturnType<ActionCreatorPlain> & T;
+
+export const importPostOnboardingState: ActionCreator<{
+  newState: PostOnboardingState;
+}> = ({ newState }) => ({
+  type: "POST_ONBOARDING_IMPORT_STATE",
+  newState,
+});
+
+export const initPostOnboarding: ActionCreator<{
+  deviceModelId: DeviceModelId;
+  actionsIds: PostOnboardingActionId[];
+}> = ({ deviceModelId, actionsIds }) => ({
+  type: "POST_ONBOARDING_INIT",
+  deviceModelId,
+  actionsIds,
+});
+
+export const setPostOnboardingActionCompleted: ActionCreator<{
+  actionId: PostOnboardingActionId;
+}> = ({ actionId }) => ({
+  type: "POST_ONBOARDING_SET_ACTION_COMPLETED",
+  actionId,
+});
+
+export const clearPostOnboardingLastActionCompleted: ActionCreatorPlain =
+  () => ({
+    type: "POST_ONBOARDING_CLEAR_LAST_ACTION_COMPLETED",
+  });
+
+export const hidePostOnboardingWalletEntryPoint: ActionCreatorPlain = () => ({
+  type: "POST_ONBOARDING_HIDE_WALLET_ENTRY_POINT",
+});

package/src/postOnboarding/hooks/index.ts

@@ -0,0 +1,5 @@
+export * from "./useAllPostOnboardingActionsCompleted";
+export * from "./usePostOnboardingContext";
+export * from "./usePostOnboardingEntryPointVisibleOnWallet";
+export * from "./usePostOnboardingHubState";
+export * from "./useStartPostOnboardingCallback";

package/src/postOnboarding/hooks/useAllPostOnboardingActionsCompleted.test.ts

@@ -0,0 +1,82 @@
+import { PostOnboardingHubState } from "@ledgerhq/types-live";
+import { renderHook } from "@testing-library/react-hooks";
+import { useAllPostOnboardingActionsCompleted } from "./useAllPostOnboardingActionsCompleted";
+import {
+  claimTestMock,
+  personalizeTestMock,
+  migrateAssetsTestMock,
+} from "../mock";
+
+import { usePostOnboardingHubState } from "./usePostOnboardingHubState";
+jest.mock("./usePostOnboardingHubState");
+jest.mock("react-redux", () => ({}));
+
+const mockedUsePostOnboardingHubState = jest.mocked(usePostOnboardingHubState);
+
+const mockedStateNoActions: PostOnboardingHubState = {
+  deviceModelId: null,
+  lastActionCompleted: null,
+  actionsState: [],
+};
+
+const mockedStateAllActionsCompleted: PostOnboardingHubState = {
+  deviceModelId: null,
+  lastActionCompleted: null,
+  actionsState: [
+    { ...claimTestMock, completed: true },
+    { ...personalizeTestMock, completed: true },
+    { ...migrateAssetsTestMock, completed: true },
+  ],
+};
+
+const mockedStateNoActionsCompleted: PostOnboardingHubState = {
+  deviceModelId: null,
+  lastActionCompleted: null,
+  actionsState: [
+    { ...claimTestMock, completed: false },
+    { ...personalizeTestMock, completed: false },
+    { ...migrateAssetsTestMock, completed: false },
+  ],
+};
+
+const mockedStateSomeActionsCompleted: PostOnboardingHubState = {
+  deviceModelId: null,
+  lastActionCompleted: null,
+  actionsState: [
+    { ...claimTestMock, completed: false },
+    { ...personalizeTestMock, completed: true },
+    { ...migrateAssetsTestMock, completed: false },
+  ],
+};
+
+describe("useAllPostOnboardingActionsCompleted", () => {
+  it("should return true if no actions are present", () => {
+    mockedUsePostOnboardingHubState.mockReturnValue(mockedStateNoActions);
+    const { result } = renderHook(() => useAllPostOnboardingActionsCompleted());
+    expect(result.current).toBe(true);
+  });
+
+  it("should return true if all actions are completed", () => {
+    mockedUsePostOnboardingHubState.mockReturnValue(
+      mockedStateAllActionsCompleted
+    );
+    const { result } = renderHook(() => useAllPostOnboardingActionsCompleted());
+    expect(result.current).toBe(true);
+  });
+
+  it("should return false if some actions are completed", () => {
+    mockedUsePostOnboardingHubState.mockReturnValue(
+      mockedStateSomeActionsCompleted
+    );
+    const { result } = renderHook(() => useAllPostOnboardingActionsCompleted());
+    expect(result.current).toBe(false);
+  });
+
+  it("should return false if no actions are completed", () => {
+    mockedUsePostOnboardingHubState.mockReturnValue(
+      mockedStateNoActionsCompleted
+    );
+    const { result } = renderHook(() => useAllPostOnboardingActionsCompleted());
+    expect(result.current).toBe(false);
+  });
+});

package/src/postOnboarding/hooks/useAllPostOnboardingActionsCompleted.ts

@@ -0,0 +1,12 @@
+import { usePostOnboardingHubState } from "./usePostOnboardingHubState";
+
+/**
+ *
+ * @returns a boolean representing whether all the post onboarding actions have
+ * been completed.
+ * TODO: unit test this
+ */
+export function useAllPostOnboardingActionsCompleted(): boolean {
+  const { actionsState } = usePostOnboardingHubState();
+  return actionsState.every((action) => action.completed);
+}

package/src/postOnboarding/hooks/usePostOnboardingContext.ts

@@ -0,0 +1,9 @@
+import { useContext } from "react";
+import {
+  PostOnboardingContext,
+  PostOnboardingDependencies,
+} from "../PostOnboardingProvider";
+
+export function usePostOnboardingContext(): PostOnboardingDependencies {
+  return useContext(PostOnboardingContext);
+}

package/src/postOnboarding/hooks/usePostOnboardingEntryPointVisibleOnWallet.test.ts

@@ -0,0 +1,83 @@
+import { renderHook } from "@testing-library/react-hooks";
+import {
+  postOnboardingDeviceModelIdSelector,
+  walletPostOnboardingEntryPointDismissedSelector,
+} from "../reducer";
+import { useAllPostOnboardingActionsCompleted } from "./useAllPostOnboardingActionsCompleted";
+import { usePostOnboardingEntryPointVisibleOnWallet } from "./usePostOnboardingEntryPointVisibleOnWallet";
+import { DeviceModelId } from "@ledgerhq/types-devices";
+
+jest.mock("react-redux", () => ({
+  useSelector: (fun) => fun(),
+}));
+jest.mock("../reducer");
+jest.mock("./useAllPostOnboardingActionsCompleted");
+
+const mockedUseAllCompleted = jest.mocked(useAllPostOnboardingActionsCompleted);
+const mockedDismissedSelector = jest.mocked(
+  walletPostOnboardingEntryPointDismissedSelector
+);
+const mockedDeviceModelIdSelector = jest.mocked(
+  postOnboardingDeviceModelIdSelector
+);
+
+describe("usePostOnboardingEntryPointVisibleOnWallet", () => {
+  beforeEach(() => {
+    mockedUseAllCompleted.mockClear();
+    mockedDismissedSelector.mockClear();
+    mockedDeviceModelIdSelector.mockClear();
+  });
+
+  it("should be false if deviceModelId is null", () => {
+    mockedUseAllCompleted.mockReturnValue(false);
+    mockedDismissedSelector.mockReturnValue(false);
+    mockedDeviceModelIdSelector.mockReturnValue(null);
+
+    const { result } = renderHook(() =>
+      usePostOnboardingEntryPointVisibleOnWallet()
+    );
+
+    expect(result.current).toBe(false);
+  });
+
+  it("should be false if the the entry point HAS been dismissed", () => {
+    mockedDismissedSelector.mockReturnValue(true);
+    mockedDeviceModelIdSelector.mockReturnValue(DeviceModelId.nanoX);
+
+    mockedUseAllCompleted.mockReturnValue(false);
+    const { result: res1 } = renderHook(() =>
+      usePostOnboardingEntryPointVisibleOnWallet()
+    );
+    expect(res1.current).toBe(false);
+
+    mockedUseAllCompleted.mockReturnValue(true);
+    const { result: res2 } = renderHook(() =>
+      usePostOnboardingEntryPointVisibleOnWallet()
+    );
+    expect(res2.current).toBe(false);
+  });
+
+  it("should be false if all actions are completed", () => {
+    mockedDismissedSelector.mockReturnValue(false);
+    mockedUseAllCompleted.mockReturnValue(true);
+
+    mockedDeviceModelIdSelector.mockReturnValue(DeviceModelId.nanoX);
+    const { result } = renderHook(() =>
+      usePostOnboardingEntryPointVisibleOnWallet()
+    );
+
+    expect(result.current).toBe(false);
+  });
+
+  it("should be true if the entry point HAS NOT been dismissed and all actions are NOT completed", () => {
+    mockedDismissedSelector.mockReturnValue(false);
+    mockedUseAllCompleted.mockReturnValue(false);
+    mockedDeviceModelIdSelector.mockReturnValue(DeviceModelId.nanoX);
+
+    const { result } = renderHook(() =>
+      usePostOnboardingEntryPointVisibleOnWallet()
+    );
+
+    expect(result.current).toBe(true);
+  });
+});

package/src/postOnboarding/hooks/usePostOnboardingEntryPointVisibleOnWallet.ts

@@ -0,0 +1,22 @@
+import { useSelector } from "react-redux";
+import {
+  postOnboardingDeviceModelIdSelector,
+  walletPostOnboardingEntryPointDismissedSelector,
+} from "../reducer";
+import { useAllPostOnboardingActionsCompleted } from "./useAllPostOnboardingActionsCompleted";
+
+/**
+ *
+ * @returns a boolean representing whether the post onboarding entry point
+ * should be visible on the wallet page.
+ * TODO: unit test this
+ */
+export function usePostOnboardingEntryPointVisibleOnWallet(): boolean {
+  const deviceModelId = useSelector(postOnboardingDeviceModelIdSelector);
+  const dismissed = useSelector(
+    walletPostOnboardingEntryPointDismissedSelector
+  );
+  const allCompleted = useAllPostOnboardingActionsCompleted();
+
+  return !!deviceModelId && !(dismissed || allCompleted);
+}