@metamask-previews/phishing-controller 13.1.0-preview-8ccfcb37 → 14.0.0-preview-a5441fae

package/dist/tests/utils.d.mts

@@ -1,3 +1,5 @@
+import type { TransactionMeta } from "@metamask/transaction-controller";
+import { SimulationTokenStandard } from "@metamask/transaction-controller";
 /**
  * Formats a hostname into a URL so we can parse it correctly
  * and pass full URLs into the PhishingDetector class. Previously
@@ -8,4 +10,61 @@
  * @returns the href property of a URL object.
  */
 export declare const formatHostnameToUrl: (hostname: string) => string;
+/**
+ * Test addresses for consistent use in tests
+ */
+export declare const TEST_ADDRESSES: {
+    MOCK_TOKEN_1: `0x${string}`;
+    USDC: `0x${string}`;
+    FROM_ADDRESS: `0x${string}`;
+    TO_ADDRESS: `0x${string}`;
+};
+/**
+ * Creates a mock token balance change object
+ *
+ * @param address - The address of the token
+ * @param options - The options for the token balance change
+ * @param options.difference - The difference in the token balance
+ * @param options.previousBalance - The previous balance of the token
+ * @param options.newBalance - The new balance of the token
+ * @param options.isDecrease - Whether the token balance is decreasing
+ * @param options.standard - The standard of the token
+ * @returns The mock token balance change object
+ */
+export declare const createMockTokenBalanceChange: (address: `0x${string}`, options?: {
+    difference?: `0x${string}`;
+    previousBalance?: `0x${string}`;
+    newBalance?: `0x${string}`;
+    isDecrease?: boolean;
+    standard?: SimulationTokenStandard;
+}) => {
+    address: `0x${string}`;
+    standard: SimulationTokenStandard;
+    difference: `0x${string}`;
+    previousBalance: `0x${string}`;
+    newBalance: `0x${string}`;
+    isDecrease: boolean;
+};
+/**
+ * Creates a mock transaction with token balance changes
+ *
+ * @param id - The transaction ID
+ * @param tokenAddresses - Array of token addresses to include in balance changes
+ * @param overrides - Partial transaction metadata to override defaults
+ * @returns The mock transaction metadata object
+ */
+export declare const createMockTransaction: (id: string, tokenAddresses?: `0x${string}`[], overrides?: Partial<TransactionMeta>) => TransactionMeta;
+/**
+ * Creates a mock state change payload for TransactionController
+ *
+ * @param transactions - The transactions to include in the state change payload.
+ * @returns A mock state change payload.
+ */
+export declare const createMockStateChangePayload: (transactions: TransactionMeta[]) => {
+    transactions: TransactionMeta[];
+    transactionBatches: never[];
+    methodData: {};
+    lastFetchedBlockNumbers: {};
+    submitHistory: never[];
+};
 //# sourceMappingURL=utils.d.mts.map

package/dist/tests/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,MAQtD,CAAC"}
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AACxE,OAAO,EAGL,uBAAuB,EACxB,yCAAyC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,MAQtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B,YAC9B,KAAK,MAAM,EAAE,YACb;IACP,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,uBAAuB,CAAC;CACpC;;;;;;;CAQD,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,OAC5B,MAAM,mBACM,KAAK,MAAM,EAAE,EAAE,cACpB,QAAQ,eAAe,CAAC,KAClC,eA2BF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,iBACzB,eAAe,EAAE;;;;;;CAO/B,CAAC"}

package/dist/tests/utils.mjs

@@ -1,3 +1,4 @@
+import { TransactionStatus, TransactionType, SimulationTokenStandard } from "@metamask/transaction-controller";
 /**
  * Formats a hostname into a URL so we can parse it correctly
  * and pass full URLs into the PhishingDetector class. Previously
@@ -17,4 +18,78 @@ export const formatHostnameToUrl = (hostname) => {
     }
     return url;
 };
+/**
+ * Test addresses for consistent use in tests
+ */
+export const TEST_ADDRESSES = {
+    MOCK_TOKEN_1: '0x1234567890123456789012345678901234567890',
+    USDC: '0xA0B86991c6218B36C1D19D4A2E9EB0CE3606EB48',
+    FROM_ADDRESS: '0x0987654321098765432109876543210987654321',
+    TO_ADDRESS: '0x1234567890123456789012345678901234567890',
+};
+/**
+ * Creates a mock token balance change object
+ *
+ * @param address - The address of the token
+ * @param options - The options for the token balance change
+ * @param options.difference - The difference in the token balance
+ * @param options.previousBalance - The previous balance of the token
+ * @param options.newBalance - The new balance of the token
+ * @param options.isDecrease - Whether the token balance is decreasing
+ * @param options.standard - The standard of the token
+ * @returns The mock token balance change object
+ */
+export const createMockTokenBalanceChange = (address, options = {}) => ({
+    address,
+    standard: options.standard ?? SimulationTokenStandard.erc20,
+    difference: options.difference ?? '0xde0b6b3a7640000',
+    previousBalance: options.previousBalance ?? '0x0',
+    newBalance: options.newBalance ?? '0xde0b6b3a7640000',
+    isDecrease: options.isDecrease ?? false,
+});
+/**
+ * Creates a mock transaction with token balance changes
+ *
+ * @param id - The transaction ID
+ * @param tokenAddresses - Array of token addresses to include in balance changes
+ * @param overrides - Partial transaction metadata to override defaults
+ * @returns The mock transaction metadata object
+ */
+export const createMockTransaction = (id, tokenAddresses = [], overrides = {}) => {
+    const simulationData = tokenAddresses.length > 0
+        ? {
+            tokenBalanceChanges: tokenAddresses.map((address) => createMockTokenBalanceChange(address)),
+        }
+        : overrides.simulationData;
+    return {
+        txParams: {
+            from: TEST_ADDRESSES.FROM_ADDRESS,
+            to: TEST_ADDRESSES.TO_ADDRESS,
+            value: '0x0',
+        },
+        chainId: '0x1',
+        id,
+        networkClientId: 'mainnet',
+        status: TransactionStatus.unapproved,
+        time: Date.now(),
+        type: TransactionType.contractInteraction,
+        origin: 'https://metamask.io',
+        submittedTime: Date.now(),
+        simulationData,
+        ...overrides,
+    };
+};
+/**
+ * Creates a mock state change payload for TransactionController
+ *
+ * @param transactions - The transactions to include in the state change payload.
+ * @returns A mock state change payload.
+ */
+export const createMockStateChangePayload = (transactions) => ({
+    transactions,
+    transactionBatches: [],
+    methodData: {},
+    lastFetchedBlockNumbers: {},
+    submitHistory: [],
+});
 //# sourceMappingURL=utils.mjs.map

package/dist/tests/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC9D,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;KAC9B;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC","sourcesContent":["/**\n * Formats a hostname into a URL so we can parse it correctly\n * and pass full URLs into the PhishingDetector class. Previously\n * only hostnames were supported, but now only full URLs are\n * supported since we want to block IPFS CIDs.\n *\n * @param hostname - the hostname of the URL.\n * @returns the href property of a URL object.\n */\nexport const formatHostnameToUrl = (hostname: string): string => {\n  let url = '';\n  try {\n    url = new URL(hostname).href;\n  } catch (e) {\n    url = new URL(['https://', hostname].join('')).href;\n  }\n  return url;\n};\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACxB,yCAAyC;AAE1C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC9D,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;KAC9B;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,YAAY,EAAE,4CAA6D;IAC3E,IAAI,EAAE,4CAA6D;IACnE,YAAY,EAAE,4CAA6D;IAC3E,UAAU,EAAE,4CAA6D;CAC1E,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,OAAsB,EACtB,UAMI,EAAE,EACN,EAAE,CAAC,CAAC;IACJ,OAAO;IACP,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,uBAAuB,CAAC,KAAK;IAC3D,UAAU,EAAE,OAAO,CAAC,UAAU,IAAK,mBAAqC;IACxE,eAAe,EAAE,OAAO,CAAC,eAAe,IAAK,KAAuB;IACpE,UAAU,EAAE,OAAO,CAAC,UAAU,IAAK,mBAAqC;IACxE,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;CACxC,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,EAAU,EACV,iBAAkC,EAAE,EACpC,YAAsC,EAAE,EACvB,EAAE;IACnB,MAAM,cAAc,GAClB,cAAc,CAAC,MAAM,GAAG,CAAC;QACvB,CAAC,CAAC;YACE,mBAAmB,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAClD,4BAA4B,CAAC,OAAO,CAAC,CACtC;SACF;QACH,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC;IAE/B,OAAO;QACL,QAAQ,EAAE;YACR,IAAI,EAAE,cAAc,CAAC,YAAY;YACjC,EAAE,EAAE,cAAc,CAAC,UAAU;YAC7B,KAAK,EAAE,KAAsB;SAC9B;QACD,OAAO,EAAE,KAAsB;QAC/B,EAAE;QACF,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE,iBAAiB,CAAC,UAAU;QACpC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;QAChB,IAAI,EAAE,eAAe,CAAC,mBAAmB;QACzC,MAAM,EAAE,qBAAqB;QAC7B,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE;QACzB,cAAc;QACd,GAAG,SAAS;KACb,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,YAA+B,EAC/B,EAAE,CAAC,CAAC;IACJ,YAAY;IACZ,kBAAkB,EAAE,EAAE;IACtB,UAAU,EAAE,EAAE;IACd,uBAAuB,EAAE,EAAE;IAC3B,aAAa,EAAE,EAAE;CAClB,CAAC,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\nimport {\n  TransactionStatus,\n  TransactionType,\n  SimulationTokenStandard,\n} from '@metamask/transaction-controller';\n\n/**\n * Formats a hostname into a URL so we can parse it correctly\n * and pass full URLs into the PhishingDetector class. Previously\n * only hostnames were supported, but now only full URLs are\n * supported since we want to block IPFS CIDs.\n *\n * @param hostname - the hostname of the URL.\n * @returns the href property of a URL object.\n */\nexport const formatHostnameToUrl = (hostname: string): string => {\n  let url = '';\n  try {\n    url = new URL(hostname).href;\n  } catch (e) {\n    url = new URL(['https://', hostname].join('')).href;\n  }\n  return url;\n};\n\n/**\n * Test addresses for consistent use in tests\n */\nexport const TEST_ADDRESSES = {\n  MOCK_TOKEN_1: '0x1234567890123456789012345678901234567890' as `0x${string}`,\n  USDC: '0xA0B86991c6218B36C1D19D4A2E9EB0CE3606EB48' as `0x${string}`,\n  FROM_ADDRESS: '0x0987654321098765432109876543210987654321' as `0x${string}`,\n  TO_ADDRESS: '0x1234567890123456789012345678901234567890' as `0x${string}`,\n};\n\n/**\n * Creates a mock token balance change object\n *\n * @param address - The address of the token\n * @param options - The options for the token balance change\n * @param options.difference - The difference in the token balance\n * @param options.previousBalance - The previous balance of the token\n * @param options.newBalance - The new balance of the token\n * @param options.isDecrease - Whether the token balance is decreasing\n * @param options.standard - The standard of the token\n * @returns The mock token balance change object\n */\nexport const createMockTokenBalanceChange = (\n  address: `0x${string}`,\n  options: {\n    difference?: `0x${string}`;\n    previousBalance?: `0x${string}`;\n    newBalance?: `0x${string}`;\n    isDecrease?: boolean;\n    standard?: SimulationTokenStandard;\n  } = {},\n) => ({\n  address,\n  standard: options.standard ?? SimulationTokenStandard.erc20,\n  difference: options.difference ?? ('0xde0b6b3a7640000' as `0x${string}`),\n  previousBalance: options.previousBalance ?? ('0x0' as `0x${string}`),\n  newBalance: options.newBalance ?? ('0xde0b6b3a7640000' as `0x${string}`),\n  isDecrease: options.isDecrease ?? false,\n});\n\n/**\n * Creates a mock transaction with token balance changes\n *\n * @param id - The transaction ID\n * @param tokenAddresses - Array of token addresses to include in balance changes\n * @param overrides - Partial transaction metadata to override defaults\n * @returns The mock transaction metadata object\n */\nexport const createMockTransaction = (\n  id: string,\n  tokenAddresses: `0x${string}`[] = [],\n  overrides: Partial<TransactionMeta> = {},\n): TransactionMeta => {\n  const simulationData =\n    tokenAddresses.length > 0\n      ? {\n          tokenBalanceChanges: tokenAddresses.map((address) =>\n            createMockTokenBalanceChange(address),\n          ),\n        }\n      : overrides.simulationData;\n\n  return {\n    txParams: {\n      from: TEST_ADDRESSES.FROM_ADDRESS,\n      to: TEST_ADDRESSES.TO_ADDRESS,\n      value: '0x0' as `0x${string}`,\n    },\n    chainId: '0x1' as `0x${string}`,\n    id,\n    networkClientId: 'mainnet',\n    status: TransactionStatus.unapproved,\n    time: Date.now(),\n    type: TransactionType.contractInteraction,\n    origin: 'https://metamask.io',\n    submittedTime: Date.now(),\n    simulationData,\n    ...overrides,\n  };\n};\n\n/**\n * Creates a mock state change payload for TransactionController\n *\n * @param transactions - The transactions to include in the state change payload.\n * @returns A mock state change payload.\n */\nexport const createMockStateChangePayload = (\n  transactions: TransactionMeta[],\n) => ({\n  transactions,\n  transactionBatches: [],\n  methodData: {},\n  lastFetchedBlockNumbers: {},\n  submitHistory: [],\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/phishing-controller",
-  "version": "13.1.0-preview-8ccfcb37",
+  "version": "14.0.0-preview-a5441fae",
   "description": "Maintains a periodically updated list of approved and unapproved website origins",
   "keywords": [
     "MetaMask",
@@ -57,6 +57,7 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/transaction-controller": "^60.4.0",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
@@ -67,6 +68,9 @@
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~5.2.2"
   },
+  "peerDependencies": {
+    "@metamask/transaction-controller": "^60.4.0"
+  },
   "engines": {
     "node": "^18.18 || >=20"
   },