Merge branch 'main' into user_ctrl_update

Author: jpuri

app/_locales/en/messages.json

@@ -239,6 +239,7 @@ export default function createRPCMethodTrackingMiddleware({
   snapAndHardwareMessenger,
   appStateController,
   metaMetricsController,
+  getHDEntropyIndex,
 }) {
   return async function rpcMethodTrackingMiddleware(
     /** @type {any} */ req,
@@ -306,6 +307,7 @@ export default function createRPCMethodTrackingMiddleware({
 
       if (event === MetaMetricsEventName.SignatureRequested) {
         eventProperties.signature_type = method;
+        eventProperties.hd_entropy_index = getHDEntropyIndex();
 
         // In personal messages the first param is data while in typed messages second param is data
         // if condition below is added to ensure that the right params are captured as data and address.
@@ -502,7 +504,10 @@ export default function createRPCMethodTrackingMiddleware({
           abandoned: event === eventType.REJECTED,
         };
         const fragmentPayload = {
-          properties,
+          properties: {
+            ...properties,
+            hd_entropy_index: getHDEntropyIndex(),
+          },
           sensitiveProperties: sensitiveEventProperties,
         };
 

app/_locales/en_GB/messages.json

@@ -110,6 +110,7 @@ const createHandler = (opts) =>
     globalRateLimitMaxAmount: 0,
     appStateController,
     metaMetricsController,
+    getHDEntropyIndex: jest.fn(),
     ...opts,
   });
 
@@ -313,6 +314,7 @@ describe('createRPCMethodTrackingMiddleware', () => {
         category: MetaMetricsEventCategory.InpageProvider,
         event: MetaMetricsEventName.SignatureRequested,
         properties: {
+          hd_entropy_index: undefined,
           signature_type: MESSAGE_TYPE.ETH_SIGN_TYPED_DATA_V4,
           security_alert_response: BlockaidResultType.Malicious,
           security_alert_reason: BlockaidReason.maliciousDomain,

app/scripts/lib/createRPCMethodTrackingMiddleware.js

@@ -91,6 +91,7 @@ const mockTransactionMetricsRequest = {
   getSmartTransactionByMinedTxHash: jest.fn(),
   getMethodData: jest.fn(),
   getIsConfirmationAdvancedDetailsOpen: jest.fn(),
+  getHDEntropyIndex: jest.fn(),
 } as TransactionMetricsRequest;
 
 describe('Transaction metrics', () => {

app/scripts/lib/createRPCMethodTrackingMiddleware.test.js

@@ -328,12 +328,17 @@ export const createTransactionEventFragmentWithTxId = async (
  * @param transactionMetricsRequest - Contains controller actions
  * @param transactionMetricsRequest.getParticipateInMetrics - Returns whether the user has opted into metrics
  * @param transactionMetricsRequest.trackEvent - MetaMetrics track event function
+ * @param transactionMetricsRequest.getHDEntropyIndex - Returns Index of the currently selected HD Keyring
  * @param transactionEventPayload - The event payload
  * @param transactionEventPayload.transactionMeta - The updated transaction meta
  * @param transactionEventPayload.approvalTransactionMeta - The updated approval transaction meta
  */
 export const handlePostTransactionBalanceUpdate = async (
-  { getParticipateInMetrics, trackEvent }: TransactionMetricsRequest,
+  {
+    getParticipateInMetrics,
+    trackEvent,
+    getHDEntropyIndex,
+  }: TransactionMetricsRequest,
   {
     transactionMeta,
     approvalTransactionMeta,
@@ -345,9 +350,12 @@ export const handlePostTransactionBalanceUpdate = async (
   if (getParticipateInMetrics() && transactionMeta.swapMetaData) {
     if (transactionMeta.txReceipt?.status === '0x0') {
       trackEvent({
-        event: 'Swap Failed',
-        sensitiveProperties: { ...transactionMeta.swapMetaData },
+        event: MetaMetricsEventName.SwapFailed,
         category: MetaMetricsEventCategory.Swaps,
+        sensitiveProperties: { ...transactionMeta.swapMetaData },
+        properties: {
+          hd_entropy_index: getHDEntropyIndex(),
+        },
       });
     } else {
       const tokensReceived = getSwapsTokensReceivedFromTxMeta(
@@ -401,6 +409,9 @@ export const handlePostTransactionBalanceUpdate = async (
           token_to_amount:
             transactionMeta.swapMetaData.token_to_amount.toString(10),
         },
+        properties: {
+          hd_entropy_index: getHDEntropyIndex(),
+        },
       });
     }
   }
@@ -981,6 +992,11 @@ async function buildEventFragmentProperties({
   const swapAndSendMetricsProperties =
     getSwapAndSendMetricsProps(transactionMeta);
 
+  // Add Entropy Properties
+  const hdEntropyProperties = {
+    hd_entropy_index: transactionMetricsRequest.getHDEntropyIndex(),
+  };
+
   /** The transaction status property is not considered sensitive and is now included in the non-anonymous event */
   let properties = {
     chain_id: chainId,
@@ -1013,6 +1029,7 @@ async function buildEventFragmentProperties({
       : [],
     ...smartTransactionMetricsProperties,
     ...swapAndSendMetricsProperties,
+    ...hdEntropyProperties,
     // TODO: Replace `any` with type
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } as Record<string, any>;

app/scripts/lib/transaction/metrics.test.ts

@@ -5654,6 +5654,23 @@ export default class MetamaskController extends EventEmitter {
     });
   }
 
+  /**
+   * Returns the index of the HD keyring containing the selected account.
+   *
+   * @returns {number | undefined} The index of the HD keyring containing the selected account.
+   */
+  getHDEntropyIndex() {
+    const selectedAccount = this.accountsController.getSelectedAccount();
+    const hdKeyrings = this.keyringController.state.keyrings.filter(
+      (keyring) => keyring.type === KeyringTypes.hd,
+    );
+    const index = hdKeyrings.findIndex((keyring) =>
+      keyring.accounts.includes(selectedAccount.address),
+    );
+
+    return index === -1 ? undefined : index;
+  }
+
   //=============================================================================
   // PASSWORD MANAGEMENT
   //=============================================================================
@@ -6231,6 +6248,7 @@ export default class MetamaskController extends EventEmitter {
       createRPCMethodTrackingMiddleware({
         getAccountType: this.getAccountType.bind(this),
         getDeviceModel: this.getDeviceModel.bind(this),
+        getHDEntropyIndex: this.getHDEntropyIndex.bind(this),
         getHardwareTypeForMetric: this.getHardwareTypeForMetric.bind(this),
         snapAndHardwareMessenger: this.controllerMessenger.getRestricted({
           name: 'SnapAndHardwareMessenger',
@@ -7331,6 +7349,7 @@ export default class MetamaskController extends EventEmitter {
         return this.preferencesController.state.preferences
           .showConfirmationAdvancedDetails;
       },
+      getHDEntropyIndex: this.getHDEntropyIndex.bind(this),
     };
     return {
       ...controllerActions,

app/scripts/lib/transaction/metrics.ts

@@ -687,6 +687,7 @@ export enum MetaMetricsEventName {
   EncryptionPublicKeyRequested = 'Encryption Requested',
   ErrorOccured = 'Error occured',
   ExternalLinkClicked = 'External Link Clicked',
+  ImportSecretRecoveryPhraseClicked = 'Import Secret Recovery Phrase Clicked',
   KeyExportSelected = 'Key Export Selected',
   KeyExportRequested = 'Key Export Requested',
   KeyExportFailed = 'Key Export Failed',
@@ -751,6 +752,9 @@ export enum MetaMetricsEventName {
   ProviderMethodCalled = 'Provider Method Called',
   PublicAddressCopied = 'Public Address Copied',
   QuoteError = 'Quote Error',
+  SecretRecoveryPhrasePickerClicked = 'Secret Recovery Phrase Picker Clicked',
+  SecretRecoveryPhrasePickerDetailsClicked = 'Secret Recovery Phrase Details Clicked',
+  SecretRecoveryPhrasePickerSelected = 'Secret Recovery Phrase Picker Selected',
   SettingsUpdated = 'Settings Updated',
   SignatureApproved = 'Signature Approved',
   SignatureFailed = 'Signature Failed',
@@ -843,7 +847,9 @@ export enum MetaMetricsEventName {
   TransactionFinalized = 'Transaction Finalized',
   ConfirmationQueued = 'Confirmation Queued',
   ExitedSwaps = 'Exited Swaps',
+  MakeAnotherSwap = 'Make Another Swap',
   SwapError = 'Swap Error',
+  SwapFailed = 'Swap Failed',
   SnapInstallStarted = 'Snap Install Started',
   SnapInstallFailed = 'Snap Install Failed',
   SnapInstallRejected = 'Snap Install Rejected',

app/scripts/metamask-controller.js

@@ -975,6 +975,14 @@ export const CHAIN_ID_TOKEN_IMAGE_MAP = {
   [CHAINLIST_CHAIN_IDS_MAP.UNICHAIN_SEPOLIA]: ETH_TOKEN_IMAGE_URL,
 } as const;
 
+/**
+ * A mapping for networks with enabled profolio landing page to their URLs.
+ */
+export const CHAIN_ID_PROFOLIO_LANDING_PAGE_URL_MAP: Record<Hex, string> = {
+  [CHAIN_IDS.LINEA_MAINNET]:
+    'https://portfolio.metamask.io/explore/networks/linea',
+} as const;
+
 export const INFURA_BLOCKED_KEY = 'countryBlocked';
 
 const defaultEtherscanDomain = 'etherscan.io';

shared/constants/metametrics.ts

@@ -42,6 +42,7 @@ const createTransactionMetricsRequest = (customProps = {}) => {
     getSmartTransactionByMinedTxHash: jest.fn(),
     getMethodData: jest.fn(),
     getIsConfirmationAdvancedDetailsOpen: jest.fn(),
+    getHDEntropyIndex: jest.fn(),
     ...customProps,
   } as TransactionMetricsRequest;
 };