chore: adds snap_trackEvent and origin param (#418)

We are adding the snap_trackEvent to the AnalyticsService and passing
the `origin` param to each tracked event.

Author: zone-live

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-solana-wallet.git"
   },
   "source": {
-    "shasum": "rx+CMYlfj25LOq11FMftpUP3nc+J+mO7C64XS2cmrGw=",
+    "shasum": "X1gc72IbqI/j7C0NA0rxAJHeJXlcsFYXVqNrfllJ4n4=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/core/constants/solana.ts

@@ -7,6 +7,7 @@ export const SOL_IMAGE_URL =
 export const MICRO_LAMPORTS_PER_LAMPORTS = 1_000_000n;
 export const LAMPORTS_PER_SOL = 1_000_000_000;
 export const DEFAULT_NETWORK_BLOCK_EXPLORER_URL = 'https://solscan.io';
+export const METAMASK_ORIGIN = 'metamask';
 
 /**
  * Solana CAIP-2 Networks
@@ -51,6 +52,11 @@ export type TokenInfo = {
   decimals: number;
 };
 
+export type TransactionMetadata = {
+  scope: Network;
+  origin: string;
+};
+
 export const TokenMetadata = {
   [KnownCaip19Id.SolMainnet]: {
     symbol: 'SOL',

packages/snap/src/core/handlers/onClientRequest/ClientRequestHandler.test.ts

@@ -101,6 +101,7 @@ describe('ClientRequestHandler', () => {
             MOCK_SOLANA_KEYRING_ACCOUNT_0,
             mockTransaction,
             Network.Testnet,
+            'metamask',
             {
               commitment: 'confirmed',
               skipPreflight: false,

packages/snap/src/core/handlers/onClientRequest/ClientRequestHandler.ts

@@ -6,6 +6,7 @@ import {
 } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/superstruct';
 
+import { METAMASK_ORIGIN } from '../../constants/solana';
 import type { WalletService } from '../../services/wallet/WalletService';
 import type { ILogger } from '../../utils/logger';
 import type { SolanaKeyring } from '../onKeyringRequest/Keyring';
@@ -81,6 +82,7 @@ export class ClientRequestHandler {
       account,
       base64EncodedTransaction,
       scope,
+      METAMASK_ORIGIN,
       options,
     );
   }

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionAdded.ts

@@ -1,5 +1,11 @@
 import { InternalError, type OnCronjobHandler } from '@metamask/snaps-sdk';
-import { assert, literal, object, string } from '@metamask/superstruct';
+import {
+  assert,
+  literal,
+  nullable,
+  object,
+  string,
+} from '@metamask/superstruct';
 
 import { analyticsService, keyring } from '../../../../snapContext';
 import logger from '../../../utils/logger';
@@ -18,7 +24,10 @@ export const OnTransactionAddedRequestStruct = object({
     accountId: UuidStruct,
     /** The base64 encoded transaction or transaction message. */
     base64EncodedTransaction: Base64Struct,
-    scope: NetworkStruct,
+    metadata: object({
+      scope: NetworkStruct,
+      origin: string(),
+    }),
   }),
 });
 
@@ -35,14 +44,14 @@ export const onTransactionAdded: OnCronjobHandler = async ({ request }) => {
 
     assert(request, OnTransactionAddedRequestStruct);
 
-    const { accountId, base64EncodedTransaction, scope } = request.params;
+    const { accountId, base64EncodedTransaction, metadata } = request.params;
 
     const account = await keyring.getAccountOrThrow(accountId);
 
     await analyticsService.trackEventTransactionAdded(
       account,
       base64EncodedTransaction,
-      scope,
+      metadata,
     );
   } catch (error) {
     logger.error(error);

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionApproved.ts

@@ -1,5 +1,11 @@
 import { InternalError, type OnCronjobHandler } from '@metamask/snaps-sdk';
-import { assert, literal, object, string } from '@metamask/superstruct';
+import {
+  assert,
+  literal,
+  nullable,
+  object,
+  string,
+} from '@metamask/superstruct';
 
 import { analyticsService, keyring } from '../../../../snapContext';
 import logger from '../../../utils/logger';
@@ -18,7 +24,10 @@ export const OnTransactionApprovedRequestStruct = object({
     accountId: UuidStruct,
     /** The base64 encoded transaction or transaction message. */
     base64EncodedTransaction: Base64Struct,
-    scope: NetworkStruct,
+    metadata: object({
+      scope: NetworkStruct,
+      origin: string(),
+    }),
   }),
 });
 
@@ -35,14 +44,14 @@ export const onTransactionApproved: OnCronjobHandler = async ({ request }) => {
 
     assert(request, OnTransactionApprovedRequestStruct);
 
-    const { accountId, base64EncodedTransaction, scope } = request.params;
+    const { accountId, base64EncodedTransaction, metadata } = request.params;
 
     const account = await keyring.getAccountOrThrow(accountId);
 
     await analyticsService.trackEventTransactionApproved(
       account,
       base64EncodedTransaction,
-      scope,
+      metadata,
     );
   } catch (error) {
     logger.error(error);

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionFinalized.test.ts

@@ -47,6 +47,7 @@ describe('onTransactionFinalized', () => {
 
   it('refreshes assets, balances and transactions for all accounts that are involved in the transaction', async () => {
     const mockAccountId = MOCK_SOLANA_KEYRING_ACCOUNT_0.id;
+    const mockOrigin = 'https://metamask.io';
 
     // A special transaction with multiple senders and recipients that are all owned by the keyring
     const mockTransaction: Transaction = {
@@ -117,6 +118,10 @@ describe('onTransactionFinalized', () => {
         params: {
           accountId: mockAccountId,
           transaction: mockTransaction,
+          metadata: {
+            scope: Network.Testnet,
+            origin: mockOrigin,
+          },
         },
       },
     });
@@ -144,6 +149,7 @@ describe('onTransactionFinalized', () => {
 
   it('refreshes balances and transactions for the sender only if it is the only account involved in the transaction', async () => {
     const mockAccountId = MOCK_SOLANA_KEYRING_ACCOUNT_0.id;
+    const mockOrigin = 'https://metamask.io';
 
     // Transaction with only one owned sender, and one non-owned recipient
     const mockTransaction: Transaction = {
@@ -187,6 +193,10 @@ describe('onTransactionFinalized', () => {
         params: {
           accountId: mockAccountId,
           transaction: mockTransaction,
+          metadata: {
+            scope: Network.Testnet,
+            origin: mockOrigin,
+          },
         },
       },
     });

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionFinalized.ts

@@ -1,6 +1,12 @@
 import { TransactionStruct } from '@metamask/keyring-api';
 import { InternalError, type OnCronjobHandler } from '@metamask/snaps-sdk';
-import { assert, literal, object, string } from '@metamask/superstruct';
+import {
+  assert,
+  literal,
+  nullable,
+  object,
+  string,
+} from '@metamask/superstruct';
 
 import {
   analyticsService,
@@ -9,7 +15,7 @@ import {
   transactionsService,
 } from '../../../../snapContext';
 import logger from '../../../utils/logger';
-import { UuidStruct } from '../../../validation/structs';
+import { NetworkStruct, UuidStruct } from '../../../validation/structs';
 import { ScheduleBackgroundEventMethod } from './ScheduleBackgroundEventMethod';
 
 export const OnTransactionFinalizedRequestStruct = object({
@@ -19,6 +25,10 @@ export const OnTransactionFinalizedRequestStruct = object({
   params: object({
     accountId: UuidStruct,
     transaction: TransactionStruct,
+    metadata: object({
+      scope: NetworkStruct,
+      origin: string(),
+    }),
   }),
 });
 
@@ -36,7 +46,7 @@ export const onTransactionFinalized: OnCronjobHandler = async ({ request }) => {
 
     assert(request, OnTransactionFinalizedRequestStruct);
 
-    const { accountId, transaction } = request.params;
+    const { accountId, transaction, metadata } = request.params;
 
     const account = await keyring.getAccountOrThrow(accountId);
 
@@ -64,6 +74,7 @@ export const onTransactionFinalized: OnCronjobHandler = async ({ request }) => {
     const trackEventPromise = analyticsService.trackEventTransactionFinalized(
       account,
       transaction,
+      metadata,
     );
 
     await Promise.all([

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionRejected.ts

@@ -1,5 +1,11 @@
 import { InternalError, type OnCronjobHandler } from '@metamask/snaps-sdk';
-import { assert, literal, object, string } from '@metamask/superstruct';
+import {
+  assert,
+  literal,
+  nullable,
+  object,
+  string,
+} from '@metamask/superstruct';
 
 import { analyticsService, keyring } from '../../../../snapContext';
 import logger from '../../../utils/logger';
@@ -18,7 +24,10 @@ export const OnTransactionRejectedRequestStruct = object({
     accountId: UuidStruct,
     /** The base64 encoded transaction or transaction message. */
     base64EncodedTransaction: Base64Struct,
-    scope: NetworkStruct,
+    metadata: object({
+      scope: NetworkStruct,
+      origin: string(),
+    }),
   }),
 });
 
@@ -35,14 +44,14 @@ export const onTransactionRejected: OnCronjobHandler = async ({ request }) => {
 
     assert(request, OnTransactionRejectedRequestStruct);
 
-    const { accountId, base64EncodedTransaction, scope } = request.params;
+    const { accountId, base64EncodedTransaction, metadata } = request.params;
 
     const account = await keyring.getAccountOrThrow(accountId);
 
     await analyticsService.trackEventTransactionRejected(
       account,
       base64EncodedTransaction,
-      scope,
+      metadata,
     );
   } catch (error) {
     logger.error(error);

packages/snap/src/core/handlers/onCronjob/backgroundEvents/onTransactionSubmitted.ts

@@ -1,5 +1,11 @@
 import { InternalError, type OnCronjobHandler } from '@metamask/snaps-sdk';
-import { assert, literal, object, string } from '@metamask/superstruct';
+import {
+  assert,
+  literal,
+  nullable,
+  object,
+  string,
+} from '@metamask/superstruct';
 
 import { analyticsService, keyring } from '../../../../snapContext';
 import logger from '../../../utils/logger';
@@ -19,7 +25,10 @@ export const OnTransactionSubmittedRequestStruct = object({
     /** The base64 encoded transaction message. */
     transactionMessageBase64Encoded: Base64Struct,
     signature: string(),
-    scope: NetworkStruct,
+    metadata: object({
+      scope: NetworkStruct,
+      origin: string(),
+    }),
   }),
 });
 
@@ -36,7 +45,7 @@ export const onTransactionSubmitted: OnCronjobHandler = async ({ request }) => {
 
     assert(request, OnTransactionSubmittedRequestStruct);
 
-    const { accountId, transactionMessageBase64Encoded, signature, scope } =
+    const { accountId, transactionMessageBase64Encoded, signature, metadata } =
       request.params;
 
     const account = await keyring.getAccountOrThrow(accountId);
@@ -45,7 +54,7 @@ export const onTransactionSubmitted: OnCronjobHandler = async ({ request }) => {
       account,
       transactionMessageBase64Encoded,
       signature,
-      scope,
+      metadata,
     );
   } catch (error) {
     logger.error(error);