BREAKING: Transaction Insight API

packages/controllers/src/snaps/SnapController.test.ts

@@ -16,6 +16,7 @@ import {
   SnapManifest,
   HandlerType,
 } from '@metamask/snap-utils';
+
 import { Crypto } from '@peculiar/webcrypto';
 import { EthereumRpcError, ethErrors, serializeError } from 'eth-rpc-errors';
 import fetchMock from 'jest-fetch-mock';
@@ -3661,7 +3662,7 @@ describe('SnapController', () => {
       expect(
         await messenger.call('SnapController:handleRequest', {
           snapId: 'npm:fooSnap',
-          handler: HandlerType.OnTransactionInsight,
+          handler: HandlerType.OnTransaction,
           origin: 'foo',
           request: {},
         }),

packages/execution-environments/jest.config.js

@@ -8,8 +8,8 @@ module.exports = {
     global: {
       branches: 84.33,
       functions: 92.91,
-      lines: 86.65,
-      statements: 86.86,
+      lines: 86.67,
+      statements: 86.88,
     },
   },
   moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],

packages/execution-environments/src/common/BaseSnapExecutor.test.ts

@@ -727,9 +727,9 @@ describe('BaseSnapExecutor', () => {
     });
   });
 
-  it('supports onTransactionInsight export', async () => {
+  it('supports onTransaction export', async () => {
     const CODE = `
-      module.exports.onTransactionInsight = ({ origin, transaction, chainId, metadata }) => ({ origin, transaction, chainId, metadata });
+      module.exports.onTransaction = ({ origin, transaction, chainId }) => ({ origin, transaction, chainId });
     `;
     const executor = new TestSnapExecutor();
 
@@ -750,15 +750,15 @@ describe('BaseSnapExecutor', () => {
     // We also have to decide on the shape of that object.
     const transaction = { maxFeePerGas: '0x' };
 
-    const params = { transaction, metadata: {}, chainId: '0x1' };
+    const params = { transaction, chainId: 'eip155:1' };
 
     await executor.writeCommand({
       jsonrpc: '2.0',
       id: 2,
       method: 'snapRpc',
       params: [
         FAKE_SNAP_NAME,
-        HandlerType.OnTransactionInsight,
+        HandlerType.OnTransaction,
         FAKE_ORIGIN,
         { jsonrpc: '2.0', method: 'foo', params },
       ],

packages/execution-environments/src/common/BaseSnapExecutor.ts

@@ -9,7 +9,7 @@ import {
 } from '@metamask/snap-types';
 import { errorCodes, ethErrors, serializeError } from 'eth-rpc-errors';
 import { JsonRpcNotification } from '@metamask/utils';
-import { HandlerType } from '@metamask/snap-utils';
+import { assert, HandlerType } from '@metamask/snap-utils';
 import EEOpenRPCDocument from '../openrpc.json';
 import {
   Endowments,
@@ -82,8 +82,11 @@ export class BaseSnapExecutor {
         }
 
         // We're capturing the handler in case someone modifies the data object before the call
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const handler = data.exports[handlerName]!;
+        const handler = data.exports[handlerName];
+        assert(
+          handler !== undefined,
+          `No ${handlerName} handler exported for snap "${target}`,
+        );
         // @todo fix type
         return this.executeInSnapContext(target, () => handler(args as any));
       },

packages/execution-environments/src/common/commands.ts

@@ -31,16 +31,12 @@ function getHandlerArguments(
   request: JsonRpcRequest<unknown[] | { [key: string]: unknown }>,
 ): InvokeSnapArgs {
   switch (handler) {
-    case HandlerType.OnTransactionInsight:
+    case HandlerType.OnTransaction:
       // eslint-disable-next-line no-case-declarations
-      const { transaction, metadata, chainId } = request.params as Record<
-        string,
-        any
-      >;
+      const { transaction, chainId } = request.params as Record<string, any>;
       return {
         origin,
         transaction,
-        metadata,
         chainId,
       };
     case HandlerType.OnRpcRequest:

packages/execution-environments/src/openrpc.json

@@ -109,7 +109,7 @@
           "schema": {
             "title": "Handler",
             "type": "string",
-            "enum": ["onRpcRequest", "onTransactionInsight"]
+            "enum": ["onRpcRequest", "onTransaction"]
           }
         },
         {

packages/types/src/types.d.ts

@@ -1,7 +1,7 @@
 import { Json } from '@metamask/controllers';
 import { MetaMaskInpageProvider } from '@metamask/providers';
 import { JsonRpcRequest } from '@metamask/types';
-import { HandlerType, ChainId } from '@metamask/snap-utils';
+import { HandlerType } from '@metamask/snap-utils';
 
 /**
  * Command request sent to a worker.
@@ -28,18 +28,16 @@ export type SnapRpcHandler = (args: {
 
 export type OnRpcRequestHandler = SnapRpcHandler;
 
-export type TransactionInsight = {
+export type OnTransactionResponse = {
   insights: { [key: string]: unknown };
-  cancel?: boolean;
 };
 
 // @todo improve type
-export type OnTransactionInsightHandler = (args: {
+export type OnTransactionHandler = (args: {
   origin: string;
   transaction: { [key: string]: unknown };
-  metadata: { [key: string]: unknown };
   chainId: ChainId;
-}) => Promise<TransactionInsight>;
+}) => Promise<OnTransactionResponse>;
 
 export type SnapRpcHookArgs = {
   origin: string;
@@ -52,6 +50,8 @@ export type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;
 
 export type SnapProvider = MetaMaskInpageProvider;
 
+export type ChainId = string;
+
 export type ErrorJSON = {
   message: string;
   code: number;
@@ -60,7 +60,7 @@ export type ErrorJSON = {
 
 export type SnapExports = {
   onRpcRequest?: OnRpcRequestHandler;
-  onTransactionInsight?: OnTransactionInsightHandler;
+  onTransaction?: OnTransactionHandler;
 };
 
 type ObjectParameters<

packages/utils/package.json

@@ -29,6 +29,7 @@
   },
   "dependencies": {
     "@babel/core": "^7.18.6",
+    "@metamask/snap-types": "^0.19.0",
     "@metamask/utils": "^2.0.0",
     "ajv": "^8.11.0",
     "fast-deep-equal": "^3.1.3",

packages/utils/src/types.ts

@@ -50,7 +50,7 @@ export enum SNAP_STREAM_NAMES {
 
 export enum HandlerType {
   OnRpcRequest = 'onRpcRequest',
-  OnTransactionInsight = 'onTransactionInsight',
+  OnTransaction = 'onTransaction',
 }
 
 export type SnapId = string;

yarn.lock

@@ -2724,7 +2724,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@metamask/snap-types@^0.19.1, @metamask/snap-types@workspace:packages/types":
+"@metamask/snap-types@^0.19.0, @metamask/snap-types@^0.19.1, @metamask/snap-types@workspace:packages/types":
   version: 0.0.0-use.local
   resolution: "@metamask/snap-types@workspace:packages/types"
   dependencies:
@@ -2765,6 +2765,7 @@ __metadata:
     "@metamask/eslint-config-jest": ^9.0.0
     "@metamask/eslint-config-nodejs": ^9.0.0
     "@metamask/eslint-config-typescript": ^9.0.1
+    "@metamask/snap-types": ^0.19.0
     "@metamask/utils": ^2.0.0
     "@types/jest": ^27.5.1
     "@types/semver": ^7.3.10