feat(HW-761): log all navigation params for Posthog

package.json

@@ -1,6 +1,6 @@
 {
   "name": "haqq",
-  "version": "1.9.3",
+  "version": "1.9.4",
   "private": true,
   "scripts": {
     "android": "react-native run-android",

src/app.tsx

@@ -32,12 +32,10 @@ import {VariablesBool} from '@app/models/variables-bool';
 import {Wallet} from '@app/models/wallet';
 import {navigator} from '@app/navigator';
 import {
-  HomeStackRoutes,
   KeystoneStackRoutes,
   LedgerStackRoutes,
   OnboardingStackRoutes,
   SssMigrateStackRoutes,
-  WelcomeStackRoutes,
 } from '@app/route-types';
 import {RootStack} from '@app/screens/RootStack';
 import {AppTheme, ModalType} from '@app/types';
@@ -79,15 +77,6 @@ const SAFE_AREA_INTIAL_METRICS: Metrics = {
   },
 };
 
-// We need to log some screens with params
-// be careful with this list to avoid capturing sensitive data
-const ALLOWED_SCREEN_TO_LOG_PARAMS = [
-  HomeStackRoutes.TransactionDetail,
-  HomeStackRoutes.Web3BrowserPopup,
-  HomeStackRoutes.InAppBrowser,
-  WelcomeStackRoutes.InAppBrowser,
-];
-
 export const App = () => {
   const [initialized, setInitialized] = useState(false);
   const [isPinReseted, setPinReseted] = useState(false);
@@ -249,11 +238,7 @@ export const App = () => {
                   captureScreens: true,
                   navigation: {
                     routeToProperties: (name, params) => {
-                      // @ts-ignore
-                      if (ALLOWED_SCREEN_TO_LOG_PARAMS.includes(name)) {
-                        return params;
-                      }
-                      return undefined;
+                      return params;
                     },
                   },
                 }}>

src/components/onboarding-repeat-pin.tsx

@@ -43,7 +43,7 @@ export const OnboardingRepeatPin = ({
 
   useEffect(() => {
     if (pin.length === 6) {
-      if (pin === currentPin) {
+      if (pin === currentPin.value) {
         onSetPin(pin);
       } else {
         const invalidCode = getText(I18N.onboardingRepeatPinInvalidCode);

src/helpers/get-provider-for-new-wallet.ts

@@ -17,7 +17,7 @@ export async function getProviderForNewWallet(params?: WalletInitialData) {
       params.sssLocalShare || null,
       null,
       params.verifier,
-      params.token,
+      params.token.value,
       app.getPassword.bind(app),
       storage,
       {

src/modifiers/secure-value.ts

@@ -0,0 +1,23 @@
+export class SecureValue<T> {
+  private readonly _value: T;
+
+  constructor(value: T) {
+    this._value = value;
+
+    Object.defineProperty(this, 'toJSON', {
+      value: () => 'This is secured value, not for public usage',
+      writable: true,
+      configurable: true,
+    });
+
+    Object.defineProperty(this, 'toString', {
+      value: () => 'This is secured value, not for public usage',
+      writable: true,
+      configurable: true,
+    });
+  }
+
+  get value() {
+    return this._value;
+  }
+}

src/route-types.ts

@@ -30,6 +30,7 @@ import {
 import {WalletConnectApproveConnectionEvent} from '@app/types/wallet-connect';
 
 import {Fee} from './models/fee';
+import {SecureValue} from './modifiers/secure-value';
 import {CalculatedFees} from './services/eth-network/types';
 
 export type AnyRouteFromParent =
@@ -169,15 +170,15 @@ export type SssMigrateStackParamList = HomeStackParamList & {
   [SssMigrateStackRoutes.SssMigrateNetworks]: {accountId: string};
   [SssMigrateStackRoutes.SssMigrateRewrite]: {
     accountId: string;
-    privateKey: string;
+    privateKey: SecureValue<string>;
     provider: SssProviders;
     email?: string;
     verifier: string;
     token: string;
   };
   [SssMigrateStackRoutes.SssMigrateStore]: {
     accountId: string;
-    privateKey: string | null;
+    privateKey: SecureValue<string | null>;
     provider?: SssProviders;
     email?: string;
     verifier: string;
@@ -675,13 +676,13 @@ export enum OnboardingStackRoutes {
 export type OnboardingStackParamList = WelcomeStackParamList & {
   [OnboardingStackRoutes.OnboardingSetupPin]: WalletInitialData & {
     provider?: ProviderMnemonicBase;
-    currentPin: string;
+    currentPin: SecureValue<string>;
     nextScreen: AnyRouteFromParent;
     errorText?: string;
   };
   [OnboardingStackRoutes.OnboardingRepeatPin]: WalletInitialData & {
     provider?: ProviderMnemonicBase;
-    currentPin: string;
+    currentPin: SecureValue<string>;
     nextScreen: AnyRouteFromParent;
   };
   [OnboardingStackRoutes.OnboardingBiometry]: {

src/screens/HomeStack/SssMigrate/sss-migrate-networks.tsx

@@ -5,6 +5,7 @@ import {app} from '@app/contexts';
 import {getMetadataValueWrapped} from '@app/helpers/wrappers/get-metadata-value';
 import {useTypedNavigation, useTypedRoute} from '@app/hooks';
 import {ErrorHandler} from '@app/models/error-handler';
+import {SecureValue} from '@app/modifiers/secure-value';
 import {
   SssMigrateStackParamList,
   SssMigrateStackRoutes,
@@ -60,7 +61,9 @@ export const SssMigrateNetworksScreen = memo(() => {
             //@ts-ignore
             navigation.navigate(nextScreen, {
               accountId: route.params.accountId,
-              privateKey: creds?.privateKey,
+              privateKey: new SecureValue<string | null | undefined>(
+                creds?.privateKey,
+              ),
               token: creds?.token,
               verifier: creds?.verifier,
               provider,
@@ -81,7 +84,7 @@ export const SssMigrateNetworksScreen = memo(() => {
         } else {
           navigation.navigate(SssMigrateStackRoutes.SssMigrateStore, {
             accountId: route.params.accountId,
-            privateKey: null,
+            privateKey: new SecureValue<string | null>(null),
             token: creds.token,
             verifier: creds.verifier,
           });

src/screens/HomeStack/SssMigrate/sss-migrate-store.tsx

@@ -52,7 +52,7 @@ export const SssMigrateStoreScreen = observer(() => {
         entropy = entropy.padStart(64, '0');
 
         const provider = await ProviderSSSBase.initialize(
-          route.params.privateKey,
+          route.params.privateKey.value,
           null,
           null,
           entropy,

src/screens/WelcomeStack/OnboardingStack/onboarding-setup-pin.tsx

@@ -2,6 +2,7 @@ import React, {memo, useCallback, useEffect, useState} from 'react';
 
 import {OnboardingSetupPin} from '@app/components/onboardinng-setup-pin';
 import {useTypedNavigation, useTypedRoute} from '@app/hooks';
+import {SecureValue} from '@app/modifiers/secure-value';
 import {
   OnboardingStackParamList,
   OnboardingStackRoutes,
@@ -29,7 +30,7 @@ export const OnboardingSetupPinScreen = memo(() => {
     if (pin.length === 6) {
       navigation.navigate(OnboardingStackRoutes.OnboardingRepeatPin, {
         ...route,
-        currentPin: pin,
+        currentPin: new SecureValue<string>(pin),
       });
       setPin('');
     }

src/screens/WelcomeStack/SignInStack/signin-restore-wallet.tsx

@@ -6,6 +6,7 @@ import {utils} from 'ethers';
 import {SignInRestore} from '@app/components/singin-restore-wallet';
 import {app} from '@app/contexts';
 import {useTypedNavigation} from '@app/hooks';
+import {SecureValue} from '@app/modifiers/secure-value';
 import {SignInStackParamList, SignInStackRoutes} from '@app/route-types';
 import {makeID} from '@app/utils';
 
@@ -26,7 +27,9 @@ export const SignInRestoreScreen = memo(() => {
 
         navigation.push(nextScreen, {
           type: 'privateKey',
-          privateKey: pk.startsWith('0x') ? pk : `0x${pk}`,
+          privateKey: new SecureValue<string>(
+            pk.startsWith('0x') ? pk : `0x${pk}`,
+          ),
         });
 
         return;
@@ -45,7 +48,7 @@ export const SignInRestoreScreen = memo(() => {
         navigation.push(SignInStackRoutes.SigninChooseAccount, {
           provider,
           type: 'mnemonic',
-          mnemonic: seed.trim().toLowerCase(),
+          mnemonic: new SecureValue<string>(seed.trim().toLowerCase()),
         });
 
         return;

src/screens/WelcomeStack/SignInStack/signin-store-wallet.tsx

@@ -56,9 +56,10 @@ export const SignInStoreWalletScreen = observer(() => {
                     number: `${total + 1}`,
                   });
 
-            let privateKey = params.privateKey.startsWith('0x')
-              ? params.privateKey.slice(2)
-              : params.privateKey;
+            const privateKeyValue = params.privateKey.value;
+            let privateKey = privateKeyValue.startsWith('0x')
+              ? privateKeyValue.slice(2)
+              : privateKeyValue;
 
             const provider = await ProviderHotBase.initialize(
               privateKey,
@@ -77,7 +78,7 @@ export const SignInStoreWalletScreen = observer(() => {
             break;
           case 'mnemonic':
             const mnemonicProvider = await ProviderMnemonicBase.initialize(
-              params.mnemonic,
+              params.mnemonic.value,
               getPassword,
               {},
             );
@@ -97,7 +98,7 @@ export const SignInStoreWalletScreen = observer(() => {
               params.sssLocalShare,
               null,
               params.verifier,
-              params.token,
+              params.token.value,
               app.getPassword.bind(app),
               storage,
               {

src/types.ts

@@ -42,6 +42,7 @@ import {EIP155_SIGNING_METHODS} from '@app/variables/EIP155';
 
 import {AwaitValue} from './helpers/await-for-value';
 import {Fee} from './models/fee';
+import {SecureValue} from './modifiers/secure-value';
 
 export enum MarketingEvents {
   accountCreated = 'q3vxmg',
@@ -115,19 +116,19 @@ export type SendTransactionRequest = Awaited<
 export type WalletInitialData =
   | {
       type: 'mnemonic';
-      mnemonic: string;
+      mnemonic: SecureValue<string>;
     }
   | {
       type: 'privateKey';
-      privateKey: string;
+      privateKey: SecureValue<string>;
     }
   | {
       type: 'sss';
       sssPrivateKey: string | null;
       sssCloudShare: string | null;
       sssLocalShare: string | null;
       verifier: string;
-      token: string;
+      token: SecureValue<string>;
       action?: 'restore' | 'replace';
       provider: SssProviders;
     }