🏗️ [Support] Request device access within HWDeviceProvider (#7440)

* Initialize the HWDeviceProvider with an `Observable<WithDevice>` * Update `useTrustchainSdk` accordingly * Fix tests * Pass an observable of the device id instead of a function * Factor `hwDeviceProvider.withHw` calls into a function * Pass the device id to sdk methods * Remove the "Config" object to get the SDK * Apply changes to LLM and to the web tool * Fix typo in a comment * Fix tests and scenarios * Re-generate failing tests * Fix the web tools build * Fix LLM build * Update changelog * Avoid type castings in the SDK method calls * Actually apply the SDK refactor to the test scenarios --------- Co-authored-by: Theophile Sandoz <Theophile Sandoz>
LedgerHQ · Aug 8, 2024 · bc044e4 · bc044e4
1 parent 858c79e
commit bc044e4
Show file tree

Hide file tree

Showing 59 changed files with 1,631 additions and 1,598 deletions.
diff --git a/.changeset/rude-moons-do.md b/.changeset/rude-moons-do.md
@@ -0,0 +1,8 @@
+---
+"ledger-live-desktop": minor
+"live-mobile": minor
+"@ledgerhq/trustchain": minor
+"@ledgerhq/web-tools": minor
+---
+
+Request device access within `HWDeviceProvider`
diff --git a/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useAddMember.ts b/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useAddMember.ts
@@ -2,12 +2,8 @@ import { memberCredentialsSelector, setTrustchain } from "@ledgerhq/trustchain/s
 import { useDispatch, useSelector } from "react-redux";
 import { setFlow } from "~/renderer/actions/walletSync";
 import { Flow, Step } from "~/renderer/reducers/walletSync";
-import { useTrustchainSdk, runWithDevice } from "./useTrustchainSdk";
-import {
-  MemberCredentials,
-  TrustchainResult,
-  TrustchainResultType,
-} from "@ledgerhq/trustchain/types";
+import { useTrustchainSdk } from "./useTrustchainSdk";
+import { TrustchainResult, TrustchainResultType } from "@ledgerhq/trustchain/types";
 import { useCallback, useEffect, useRef, useState } from "react";
 
 export function useAddMember({ device }: { device: Device | null }) {
@@ -52,24 +48,24 @@ export function useAddMember({ device }: { device: Device | null }) {
   };
 
   useEffect(() => {
-    if (!deviceRef.current) {
-      handleMissingDevice();
-    }
-
     const addMember = async () => {
       try {
-        await runWithDevice(deviceRef.current?.deviceId, async transport => {
-          const trustchainResult = await sdkRef.current.getOrCreateTrustchain(
-            transport,
-            memberCredentialsRef.current as MemberCredentials,
-            {
-              onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
-              onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
-            },
-          );
+        if (!deviceRef.current) {
+          return handleMissingDevice();
+        }
+        if (!memberCredentialsRef.current) {
+          throw new Error("memberCredentials is not set");
+        }
+        const trustchainResult = await sdkRef.current.getOrCreateTrustchain(
+          deviceRef.current.deviceId,
+          memberCredentialsRef.current,
+          {
+            onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
+            onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
+          },
+        );
 
-          transitionToNextScreen(trustchainResult);
-        });
+        transitionToNextScreen(trustchainResult);
       } catch (error) {
         setError(error as Error);
       }

diff --git a/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useRemoveMember.ts b/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useRemoveMember.ts
@@ -6,8 +6,8 @@ import {
 import { useDispatch, useSelector } from "react-redux";
 import { setFlow } from "~/renderer/actions/walletSync";
 import { Flow, Step } from "~/renderer/reducers/walletSync";
-import { useTrustchainSdk, runWithDevice } from "./useTrustchainSdk";
-import { TrustchainMember, Trustchain, MemberCredentials } from "@ledgerhq/trustchain/types";
+import { useTrustchainSdk } from "./useTrustchainSdk";
+import { TrustchainMember, Trustchain } from "@ledgerhq/trustchain/types";
 import { useCallback, useEffect, useRef, useState } from "react";
 import { TrustchainNotAllowed } from "@ledgerhq/trustchain/errors";
 
@@ -51,20 +51,24 @@ export function useRemoveMember({ device, member }: Props) {
   const removeMember = useCallback(
     async (member: TrustchainMember) => {
       try {
-        await runWithDevice(deviceRef.current?.deviceId, async transport => {
-          const newTrustchain = await sdkRef.current.removeMember(
-            transport,
-            trustchainRef.current as Trustchain,
-            memberCredentialsRef.current as MemberCredentials,
-            member,
-            {
-              onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
-              onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
-            },
-          );
+        if (!deviceRef.current) {
+          throw new Error("Device not found");
+        }
+        if (!trustchainRef.current || !memberCredentialsRef.current) {
+          throw new Error("trustchain or memberCredentials is not set");
+        }
+        const newTrustchain = await sdkRef.current.removeMember(
+          deviceRef.current.deviceId,
+          trustchainRef.current,
+          memberCredentialsRef.current,
+          member,
+          {
+            onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
+            onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
+          },
+        );
 
-          transitionToNextScreen(newTrustchain);
-        });
+        transitionToNextScreen(newTrustchain);
       } catch (error) {
         if (error instanceof Error) setError(error);
         if (error instanceof TrustchainNotAllowed) {

diff --git a/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useTrustchainSdk.ts b/apps/ledger-live-desktop/src/newArch/features/WalletSync/hooks/useTrustchainSdk.ts
@@ -1,10 +1,8 @@
 import os from "os";
-import { from, lastValueFrom } from "rxjs";
 import { useMemo } from "react";
 import { getEnv } from "@ledgerhq/live-env";
 import { getSdk } from "@ledgerhq/trustchain/index";
 import { withDevice } from "@ledgerhq/live-common/hw/deviceAccess";
-import Transport from "@ledgerhq/hw-transport";
 import { trustchainLifecycle } from "@ledgerhq/live-wallet/walletsync/index";
 import { useStore } from "react-redux";
 import { walletSelector } from "~/renderer/reducers/wallet";
@@ -13,13 +11,6 @@ import { TrustchainSDK } from "@ledgerhq/trustchain/types";
 import { useFeature } from "@ledgerhq/live-common/featureFlags/index";
 import getWalletSyncEnvironmentParams from "@ledgerhq/live-common/walletSync/getEnvironmentParams";
 
-export function runWithDevice<T>(
-  deviceId: string | undefined,
-  fn: (transport: Transport) => Promise<T>,
-): Promise<T> {
-  return lastValueFrom(withDevice(deviceId || "")(transport => from(fn(transport))));
-}
-
 const platformMap: Record<string, string | undefined> = {
   darwin: "Mac",
   win32: "Windows",
@@ -52,7 +43,7 @@ export function useTrustchainSdk() {
   );
 
   if (sdkInstance === null) {
-    sdkInstance = getSdk(isMockEnv, defaultContext, lifecycle);
+    sdkInstance = getSdk(isMockEnv, defaultContext, withDevice, lifecycle);
   }
 
   return sdkInstance;

diff --git a/apps/ledger-live-desktop/src/newArch/features/WalletSync/testHelper/helper.ts b/apps/ledger-live-desktop/src/newArch/features/WalletSync/testHelper/helper.ts
@@ -1,12 +1,17 @@
 import { getSdk } from "@ledgerhq/trustchain/index";
+import { EMPTY } from "rxjs";
 import { Flow, initialStateWalletSync, Step } from "~/renderer/reducers/walletSync";
 import getWalletSyncEnvironmentParams from "@ledgerhq/live-common/walletSync/getEnvironmentParams";
 
-export const mockedSdk = getSdk(true, {
-  applicationId: 12,
-  name: "LLD Integration",
-  apiBaseUrl: getWalletSyncEnvironmentParams("STAGING").trustchainApiBaseUrl,
-});
+export const mockedSdk = getSdk(
+  true,
+  {
+    applicationId: 12,
+    name: "LLD Integration",
+    apiBaseUrl: getWalletSyncEnvironmentParams("STAGING").trustchainApiBaseUrl,
+  },
+  () => () => EMPTY,
+);
 
 export const walletSyncActivatedState = {
   ...initialStateWalletSync,

diff --git a/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useAddMember.ts b/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useAddMember.ts
@@ -1,11 +1,7 @@
 import { memberCredentialsSelector, setTrustchain } from "@ledgerhq/trustchain/store";
 import { useDispatch, useSelector } from "react-redux";
-import { useTrustchainSdk, runWithDevice } from "./useTrustchainSdk";
-import {
-  MemberCredentials,
-  TrustchainResult,
-  TrustchainResultType,
-} from "@ledgerhq/trustchain/types";
+import { useTrustchainSdk } from "./useTrustchainSdk";
+import { TrustchainResult, TrustchainResultType } from "@ledgerhq/trustchain/types";
 import { useCallback, useEffect, useRef, useState } from "react";
 import { Device } from "@ledgerhq/live-common/hw/actions/types";
 import { useNavigation } from "@react-navigation/native";
@@ -40,19 +36,21 @@ export function useAddMember({ device }: { device: Device | null }) {
   useEffect(() => {
     const addMember = async () => {
       try {
-        await runWithDevice(device?.deviceId || "", async transport => {
-          const trustchainResult = await sdk.getOrCreateTrustchain(
-            transport,
-            memberCredentialsRef.current as MemberCredentials,
-            {
-              onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
-              onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
-            },
-          );
-          if (trustchainResult) {
-            transitionToNextScreen(trustchainResult);
-          }
-        });
+        if (!device) return;
+        if (!memberCredentialsRef.current) {
+          throw new Error("memberCredentials is not set");
+        }
+        const trustchainResult = await sdk.getOrCreateTrustchain(
+          device.deviceId,
+          memberCredentialsRef.current,
+          {
+            onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
+            onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
+          },
+        );
+        if (trustchainResult) {
+          transitionToNextScreen(trustchainResult);
+        }
       } catch (error) {
         setError(error as Error);
       }

diff --git a/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useRemoveMember.ts b/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useRemoveMember.ts
@@ -4,7 +4,7 @@ import {
   trustchainSelector,
 } from "@ledgerhq/trustchain/store";
 import { useDispatch, useSelector } from "react-redux";
-import { useTrustchainSdk, runWithDevice } from "./useTrustchainSdk";
+import { useTrustchainSdk } from "./useTrustchainSdk";
 import { TrustchainMember, Trustchain } from "@ledgerhq/trustchain/types";
 import { useCallback, useEffect, useState } from "react";
 import { Device } from "@ledgerhq/live-common/hw/actions/types";
@@ -54,25 +54,23 @@ export function useRemoveMember({ device, member }: Props) {
 
   const removeMember = useCallback(
     async (member: TrustchainMember) => {
-      if (!device) return;
-      if (!trustchain || !memberCredentials) {
-        throw new Error("trustchain or memberCredentials is not set");
-      }
       try {
-        await runWithDevice(device.deviceId, async transport => {
-          const newTrustchain = await sdk.removeMember(
-            transport,
-            trustchain,
-            memberCredentials,
-            member,
-            {
-              onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
-              onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
-            },
-          );
+        if (!device) return;
+        if (!trustchain || !memberCredentials) {
+          throw new Error("trustchain or memberCredentials is not set");
+        }
+        const newTrustchain = await sdk.removeMember(
+          device.deviceId,
+          trustchain,
+          memberCredentials,
+          member,
+          {
+            onStartRequestUserInteraction: () => setUserDeviceInteraction(true),
+            onEndRequestUserInteraction: () => setUserDeviceInteraction(false),
+          },
+        );
 
-          transitionToNextScreen(newTrustchain);
-        });
+        transitionToNextScreen(newTrustchain);
       } catch (error) {
         if (error instanceof Error) setError(error);
       }

diff --git a/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useTrustchainSdk.ts b/apps/ledger-live-mobile/src/newArch/features/WalletSync/hooks/useTrustchainSdk.ts
@@ -1,21 +1,12 @@
-import { firstValueFrom, from } from "rxjs";
 import { useMemo } from "react";
 import { getEnv } from "@ledgerhq/live-env";
 import { getSdk } from "@ledgerhq/trustchain/index";
-import Transport from "@ledgerhq/hw-transport";
 import { Platform } from "react-native";
 import { withDevice } from "@ledgerhq/live-common/hw/deviceAccess";
 import { TrustchainSDK } from "@ledgerhq/trustchain/types";
 import { useFeature } from "@ledgerhq/live-common/featureFlags/index";
 import getWalletSyncEnvironmentParams from "@ledgerhq/live-common/walletSync/getEnvironmentParams";
 
-export function runWithDevice<T>(
-  deviceId: string,
-  fn: (transport: Transport) => Promise<T>,
-): Promise<T> {
-  return firstValueFrom(withDevice(deviceId)(transport => from(fn(transport))));
-}
-
 const platformMap: Record<string, string | undefined> = {
   ios: "iOS",
   android: "Android",
@@ -38,7 +29,7 @@ export function useTrustchainSdk() {
   }, [trustchainApiBaseUrl]);
 
   if (sdkInstance === null) {
-    sdkInstance = getSdk(isMockEnv, defaultContext);
+    sdkInstance = getSdk(isMockEnv, defaultContext, withDevice);
   }
 
   return sdkInstance;

diff --git a/apps/web-tools/trustchain/components/App.tsx b/apps/web-tools/trustchain/components/App.tsx
@@ -2,6 +2,7 @@ import dynamic from "next/dynamic";
 import React, { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import styled from "styled-components";
 import { Tooltip } from "react-tooltip";
+import { withDevice } from "@ledgerhq/live-common/hw/deviceAccess";
 import { MemberCredentials, Trustchain, TrustchainMember } from "@ledgerhq/trustchain/types";
 import { getInitialStore } from "@ledgerhq/trustchain/store";
 import useEnv from "../useEnv";
@@ -113,7 +114,7 @@ const App = () => {
   );
 
   const sdk = useMemo(
-    () => getSdk(!!mockEnv, context, lifecycle),
+    () => getSdk(!!mockEnv, context, withDevice, lifecycle),
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [
       mockEnv,

diff --git a/apps/web-tools/trustchain/components/AppGetOrCreateTrustchain.tsx b/apps/web-tools/trustchain/components/AppGetOrCreateTrustchain.tsx
@@ -7,7 +7,6 @@ import {
 } from "@ledgerhq/trustchain/types";
 import { Actionable } from "./Actionable";
 import { useTrustchainSDK } from "../context";
-import { runWithDevice } from "../device";
 
 export function AppGetOrCreateTrustchain({
   deviceId,
@@ -26,11 +25,9 @@ export function AppGetOrCreateTrustchain({
 
   const action = useCallback(
     (memberCredentials: MemberCredentials) =>
-      runWithDevice(deviceId, transport =>
-        sdk
-          .getOrCreateTrustchain(transport, memberCredentials, callbacks)
-          .then(result => result.trustchain),
-      ),
+      sdk
+        .getOrCreateTrustchain(deviceId, memberCredentials, callbacks)
+        .then(result => result.trustchain),
     [deviceId, sdk, callbacks],
   );
 

diff --git a/apps/web-tools/trustchain/components/AppMemberRow.tsx b/apps/web-tools/trustchain/components/AppMemberRow.tsx
@@ -9,7 +9,6 @@ import {
 import { Actionable } from "./Actionable";
 import { DisplayName } from "./IdentityManager";
 import { useTrustchainSDK } from "../context";
-import { runWithDevice } from "../device";
 
 export function AppMemberRow({
   deviceId,
@@ -32,13 +31,13 @@ export function AppMemberRow({
 
   const action = useCallback(
     (trustchain: Trustchain, memberCredentials: MemberCredentials) =>
-      runWithDevice(deviceId, transport =>
-        sdk.removeMember(transport, trustchain, memberCredentials, member, callbacks),
-      ).then(async trustchain => {
-        setTrustchain(trustchain);
-        await sdk.getMembers(trustchain, memberCredentials).then(setMembers);
-        return member;
-      }),
+      sdk
+        .removeMember(deviceId, trustchain, memberCredentials, member, callbacks)
+        .then(async trustchain => {
+          setTrustchain(trustchain);
+          await sdk.getMembers(trustchain, memberCredentials).then(setMembers);
+          return member;
+        }),
     [deviceId, sdk, member, setTrustchain, setMembers, callbacks],
   );
 

diff --git a/apps/web-tools/trustchain/context.ts b/apps/web-tools/trustchain/context.ts
@@ -1,4 +1,5 @@
 import React, { useContext } from "react";
+import { withDevice } from "@ledgerhq/live-common/hw/deviceAccess";
 import { TrustchainSDK } from "@ledgerhq/trustchain/types";
 import { getSdk } from "@ledgerhq/trustchain/index";
 import { getEnv } from "@ledgerhq/live-env";
@@ -10,7 +11,7 @@ export const defaultContext = {
 };
 
 export const TrustchainSDKContext = React.createContext<TrustchainSDK>(
-  getSdk(false, defaultContext),
+  getSdk(false, defaultContext, withDevice),
 );
 
 export const useTrustchainSDK = () => useContext(TrustchainSDKContext);
diff --git a/apps/web-tools/trustchain/device.ts b/apps/web-tools/trustchain/device.ts