Merge pull request #4800 from LedgerHQ/bugfix/onclose-LIVE-9487

fix(LLM): platform-sdk & wallet-api onClose response in `account.request` & `message.sign` [LIVE-9487]
LedgerHQ · Sep 22, 2023 · acdb1d1 · acdb1d1 · vercel · Sep 22, 2023
2 parents bfb181f + e63d3bb
commit acdb1d1
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 74 deletions.
diff --git a/.changeset/thick-icons-pull.md b/.changeset/thick-icons-pull.md
@@ -0,0 +1,7 @@
+---
+"ledger-live-desktop": patch
+"live-mobile": patch
+"@ledgerhq/live-common": patch
+---
+
+fix: platform-sdk & wallet-api onClose response in `account.request` & `message.sign`
diff --git a/apps/ledger-live-desktop/src/renderer/components/Web3AppWebview/PlatformAPIWebview.tsx b/apps/ledger-live-desktop/src/renderer/components/Web3AppWebview/PlatformAPIWebview.tsx
@@ -247,7 +247,7 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
                   },
                   onClose: () => {
                     tracking.platformSignMessageUserRefused(manifest);
-                    reject(UserRefusedOnDevice());
+                    reject(new UserRefusedOnDevice());
                   },
                 }),
               );

diff --git a/apps/ledger-live-desktop/src/renderer/components/Web3AppWebview/WalletAPIWebview.tsx b/apps/ledger-live-desktop/src/renderer/components/Web3AppWebview/WalletAPIWebview.tsx
@@ -41,7 +41,7 @@ function useUiHook(manifest: AppManifest): Partial<UiHook> {
 
   return useMemo(
     () => ({
-      "account.request": ({ accounts$, currencies, onSuccess, onError }) => {
+      "account.request": ({ accounts$, currencies, onSuccess, onCancel }) => {
         setDrawer(
           SelectAccountAndCurrencyDrawer,
           {
@@ -55,7 +55,7 @@ function useUiHook(manifest: AppManifest): Partial<UiHook> {
           {
             onRequestClose: () => {
               setDrawer();
-              onError();
+              onCancel();
             },
           },
         );

diff --git a/apps/ledger-live-mobile/src/components/RootNavigator/BaseNavigator.tsx b/apps/ledger-live-mobile/src/components/RootNavigator/BaseNavigator.tsx
@@ -216,6 +216,14 @@ export default function BaseNavigator() {
           name={NavigatorName.SignMessage}
           component={SignMessageNavigator}
           options={{ headerShown: false }}
+          listeners={({ route }) => ({
+            beforeRemove: () => {
+              const onClose = route.params?.onClose;
+              if (onClose && typeof onClose === "function") {
+                onClose();
+              }
+            },
+          })}
         />
         <Stack.Screen
           name={NavigatorName.SignTransaction}
@@ -255,17 +263,10 @@ export default function BaseNavigator() {
           }}
           listeners={({ route }) => ({
             beforeRemove: () => {
-              /**
-              react-navigation workaround try to fetch params from current route params
-              or fallback to child navigator route params
-              since this listener is on top of another navigator
-            */
-              const onError =
-                route.params?.onError || (route.params as unknown as typeof route)?.params?.onError;
-              // @TODO This route.params.error mechanism is deprecated, no part of the code is currently using it
-              // WalletAPI are suggesting they will rework that at some point
-              if (onError && typeof onError === "function" && route.params.error)
-                onError(route.params.error);
+              const onClose = route.params?.onClose;
+              if (onClose && typeof onClose === "function") {
+                onClose();
+              }
             },
           })}
         />

diff --git a/apps/ledger-live-mobile/src/components/RootNavigator/types/AddAccountsNavigator.ts b/apps/ledger-live-mobile/src/components/RootNavigator/types/AddAccountsNavigator.ts
@@ -16,15 +16,13 @@ export type AddAccountsNavigatorParamList = {
     returnToSwap?: boolean;
     analyticsPropertyFlow?: string;
     onSuccess?: () => void;
-    onError?: (_: Error) => void;
   };
   [ScreenName.AddAccountsAccounts]: {
     currency: CryptoOrTokenCurrency;
     device: Device;
     inline?: boolean;
     returnToSwap?: boolean;
     onSuccess?: (_?: unknown) => void;
-    onError?: (_: Error) => void;
   };
   [ScreenName.AddAccountsSuccess]?: {
     currency: CryptoOrTokenCurrency;

diff --git a/apps/ledger-live-mobile/src/components/RootNavigator/types/BaseNavigator.ts b/apps/ledger-live-mobile/src/components/RootNavigator/types/BaseNavigator.ts
@@ -227,8 +227,7 @@ export type BaseNavigatorStackParamList = {
       })
     | undefined;
   [NavigatorName.RequestAccount]: NavigatorScreenParams<RequestAccountNavigatorParamList> & {
-    onError?: (_: Error) => void;
-    error?: Error;
+    onClose?: () => void;
   };
   [NavigatorName.Exchange]: NavigatorScreenParams<ExchangeLiveAppNavigatorParamList> | undefined;
   [NavigatorName.ExchangeStack]: NavigatorScreenParams<ExchangeStackNavigatorParamList> & {

diff --git a/apps/ledger-live-mobile/src/components/RootNavigator/types/RequestAccountNavigator.ts b/apps/ledger-live-mobile/src/components/RootNavigator/types/RequestAccountNavigator.ts
@@ -13,15 +13,13 @@ export type RequestAccountNavigatorParamList = {
     currencies: CryptoOrTokenCurrency[];
     allowAddAccount?: boolean;
     onSuccess?: (account: AccountLike, parentAccount?: Account) => void;
-    onError?: (_: Error) => void;
   };
   [ScreenName.RequestAccountsSelectAccount]: {
     accounts$?: Observable<WalletAPIAccount[]>;
     currencies?: CryptoOrTokenCurrency[];
     currency: CryptoOrTokenCurrency;
     allowAddAccount?: boolean;
     onSuccess?: (account: AccountLike, parentAccount?: Account) => void;
-    onError?: (_: Error) => void;
   };
   [NavigatorName.RequestAccountsAddAccounts]: NavigatorScreenParams<AddAccountsNavigatorParamList> &
     Partial<{
@@ -31,6 +29,5 @@ export type RequestAccountNavigatorParamList = {
       returnToSwap?: boolean;
       analyticsPropertyFlow?: string;
       onSuccess?: (account: AccountLike, parentAccount?: Account) => void;
-      onError?: (_: Error) => void;
     }>;
 };
diff --git a/apps/ledger-live-mobile/src/components/Web3AppWebview/PlatformAPIWebview.tsx b/apps/ledger-live-mobile/src/components/Web3AppWebview/PlatformAPIWebview.tsx
@@ -134,9 +134,9 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
             resolve(serializePlatformAccount(accountToPlatformAccount(account, parentAccount)));
           };
 
-          const onError = (error: Error) => {
+          const onClose = () => {
             tracking.platformRequestAccountFail(manifest);
-            reject(error);
+            reject(new Error("User cancelled"));
           };
 
           // if single currency available redirect to select account directly
@@ -157,8 +157,8 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
                 currency,
                 allowAddAccount,
                 onSuccess,
-                onError,
               },
+              onClose,
             });
           } else {
             navigation.navigate(NavigatorName.RequestAccount, {
@@ -167,8 +167,8 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
                 currencies: allCurrencies,
                 allowAddAccount,
                 onSuccess,
-                onError,
               },
+              onClose,
             });
           }
         }),
@@ -233,44 +233,41 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
             );
 
             return new Promise((resolve, reject) => {
-              (navigation as StackNavigatorNavigation<BaseNavigatorStackParamList>).navigate(
-                NavigatorName.SignTransaction,
-                {
-                  screen: ScreenName.SignTransactionSummary,
-                  params: {
-                    currentNavigation: ScreenName.SignTransactionSummary,
-                    nextNavigation: ScreenName.SignTransactionSelectDevice,
-                    transaction: tx as Transaction,
-                    accountId,
-                    parentId: parentAccount?.id,
-                    appName: params?.useApp,
-                    onSuccess: ({
-                      signedOperation,
-                      transactionSignError,
-                    }: {
-                      signedOperation: SignedOperation;
-                      transactionSignError: Error;
-                    }) => {
-                      if (transactionSignError) {
-                        tracking.platformSignTransactionFail(manifest);
-                        reject(transactionSignError);
-                      } else {
-                        tracking.platformSignTransactionSuccess(manifest);
-                        resolve(serializePlatformSignedTransaction(signedOperation));
-                        const n =
-                          navigation.getParent<
-                            StackNavigatorNavigation<BaseNavigatorStackParamList>
-                          >() || navigation;
-                        n.pop();
-                      }
-                    },
-                    onError: (error: Error) => {
+              navigation.navigate(NavigatorName.SignTransaction, {
+                screen: ScreenName.SignTransactionSummary,
+                params: {
+                  currentNavigation: ScreenName.SignTransactionSummary,
+                  nextNavigation: ScreenName.SignTransactionSelectDevice,
+                  transaction: tx as Transaction,
+                  accountId,
+                  parentId: parentAccount?.id,
+                  appName: params?.useApp,
+                  onSuccess: ({
+                    signedOperation,
+                    transactionSignError,
+                  }: {
+                    signedOperation: SignedOperation;
+                    transactionSignError: Error;
+                  }) => {
+                    if (transactionSignError) {
                       tracking.platformSignTransactionFail(manifest);
-                      reject(error);
-                    },
+                      reject(transactionSignError);
+                    } else {
+                      tracking.platformSignTransactionSuccess(manifest);
+                      resolve(serializePlatformSignedTransaction(signedOperation));
+                      const n =
+                        navigation.getParent<
+                          StackNavigatorNavigation<BaseNavigatorStackParamList>
+                        >() || navigation;
+                      n.pop();
+                    }
+                  },
+                  onError: (error: Error) => {
+                    tracking.platformSignTransactionFail(manifest);
+                    reject(error);
                   },
                 },
-              );
+              });
             });
           },
         ),
@@ -435,7 +432,7 @@ export const PlatformAPIWebview = forwardRef<WebviewAPI, WebviewProps>(
                 },
                 onClose: () => {
                   tracking.platformSignMessageUserRefused(manifest);
-                  reject(UserRefusedOnDevice());
+                  reject(new UserRefusedOnDevice());
                 },
               });
             }),

diff --git a/apps/ledger-live-mobile/src/components/Web3AppWebview/helpers.ts b/apps/ledger-live-mobile/src/components/Web3AppWebview/helpers.ts
@@ -251,7 +251,7 @@ function useUiHook(): Partial<UiHook> {
 
   return useMemo(
     () => ({
-      "account.request": ({ accounts$, currencies, onSuccess, onError }) => {
+      "account.request": ({ accounts$, currencies, onSuccess, onCancel }) => {
         if (currencies.length === 1) {
           navigation.navigate(NavigatorName.RequestAccount, {
             screen: ScreenName.RequestAccountsSelectAccount,
@@ -260,8 +260,8 @@ function useUiHook(): Partial<UiHook> {
               currency: currencies[0],
               allowAddAccount: true,
               onSuccess,
-              onError,
             },
+            onClose: onCancel,
           });
         } else {
           navigation.navigate(NavigatorName.RequestAccount, {
@@ -271,8 +271,8 @@ function useUiHook(): Partial<UiHook> {
               currencies,
               allowAddAccount: true,
               onSuccess,
-              onError,
             },
+            onClose: onCancel,
           });
         }
       },

diff --git a/apps/ledger-live-mobile/src/screens/RequestAccount/02-SelectAccount.tsx b/apps/ledger-live-mobile/src/screens/RequestAccount/02-SelectAccount.tsx
@@ -96,7 +96,7 @@ const List = ({
 
 function SelectAccount({ navigation, route }: Props) {
   const { colors } = useTheme();
-  const { accounts$, currency, allowAddAccount, onSuccess, onError } = route.params;
+  const { accounts$, currency, allowAddAccount, onSuccess } = route.params;
   const accountIds = useGetAccountIds(accounts$);
   const accounts = useSelector(accountsByCryptoCurrencyScreenSelector(currency, accountIds)) as {
     account: AccountLike;
@@ -122,15 +122,10 @@ function SelectAccount({ navigation, route }: Props) {
       screen: ScreenName.AddAccountsSelectDevice,
       params: {
         currency: currency as CryptoOrTokenCurrency,
-        onSuccess: () =>
-          navigation.navigate(NavigatorName.RequestAccount, {
-            screen: ScreenName.RequestAccountsSelectAccount,
-            params: route.params,
-          }),
-        onError,
+        onSuccess: () => navigation.navigate(ScreenName.RequestAccountsSelectAccount, route.params),
       },
     });
-  }, [currency, navigation, onError, route.params]);
+  }, [currency, navigation, route.params]);
 
   const renderFooter = useCallback(
     () =>

diff --git a/libs/ledger-live-common/src/wallet-api/react.ts b/libs/ledger-live-common/src/wallet-api/react.ts
@@ -112,7 +112,7 @@ export interface UiHook {
     accounts$: Observable<WalletAPIAccount[]>;
     currencies: CryptoOrTokenCurrency[];
     onSuccess: (account: AccountLike, parentAccount: Account | undefined) => void;
-    onError: () => void;
+    onCancel: () => void;
   }) => void;
   "account.receive": (params: {
     account: AccountLike;
@@ -354,7 +354,7 @@ export function useWalletAPIServer({
             tracking.requestAccountSuccess(manifest);
             resolve(accountToWalletAPIAccount(account, parentAccount));
           },
-          onError: () => {
+          onCancel: () => {
             tracking.requestAccountFail(manifest);
             reject(new Error("Canceled by user"));
           },