9.0.0-rc1

.github/workflows/require-additional-reviewer.yml

@@ -2,7 +2,9 @@ name: Require Additional Reviewer for Releases
 
 on:
   pull_request:
+    branches: ['main']
   pull_request_review:
+    branches: ['main']
 
 jobs:
   require-additional-reviewer:

CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.0.0-rc1]
+### Changed
+- **BREAKING**: peerDependency @metamask/composable-controller requires upgrade from v1 to v4
+- **BREAKING**: Bump `@metamask/gas-fee-controller` from v3 to v12
+  - TODO: What's actual implications here?
+- Bump `@metamask/base-controller` from v1 to v4
+
+### Fixed
+- Remove dependency on broken and deprecated `web3-provider-engine` ([#219](https://github.com/MetaMask/swaps-controller/pull/219))
+- Replace legacy `ethjs` with `@metamask/ethjs` ([#219](https://github.com/MetaMask/swaps-controller/pull/219))
+- Replace legacy `ethjs-query` with `@metamask/ethjs-query` ([#219](https://github.com/MetaMask/swaps-controller/pull/219))
+- Upgrade deprecated and broken `eth-sig-util` to `@metamask/eth-sig-util` ([#219](https://github.com/MetaMask/swaps-controller/pull/219))
+- Upgrade legacy `ethjs` to `@metamask/ethjs` ([#219](https://github.com/MetaMask/swaps-controller/pull/219))
+
 ## [8.0.0]
 ### Changed
 - **BREAKING**: Replace `@metamask/controllers` with individual controller packages ([#193](https://github.com/MetaMask/swaps-controller/pull/193)) ([#214](https://github.com/MetaMask/swaps-controller/pull/214)) ([#215](https://github.com/MetaMask/swaps-controller/pull/215))
@@ -135,7 +149,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use standalone gas API endpoint ([#70](https://github.com/MetaMask/swaps-controller/pull/70))
 - Bump @metamask/controllers from 14.1.0 to 14.2.0 ([#69](https://github.com/MetaMask/swaps-controller/pull/69))
 
-[Unreleased]: https://github.com/MetaMask/swaps-controller/compare/v8.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/swaps-controller/compare/v9.0.0-rc1...HEAD
+[9.0.0-rc1]: https://github.com/MetaMask/swaps-controller/compare/v8.0.0...v9.0.0-rc1
 [8.0.0]: https://github.com/MetaMask/swaps-controller/compare/v7.0.1...v8.0.0
 [7.0.1]: https://github.com/MetaMask/swaps-controller/compare/v7.0.0...v7.0.1
 [7.0.0]: https://github.com/MetaMask/swaps-controller/compare/v6.9.3...v7.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/swaps-controller",
-  "version": "8.0.0",
+  "version": "9.0.0-rc1",
   "description": "MetaMask Swaps controller module",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -32,22 +32,26 @@
     "build": "tsc --project ."
   },
   "peerDependencies": {
-    "@metamask/composable-controller": "^1.0.2",
+    "@metamask/composable-controller": "^4.0.0",
     "@metamask/network-controller": "^3.0.0"
   },
   "devDependencies": {
+    "@babel/runtime": "^7.0.0",
     "@lavamoat/allow-scripts": "^3.0.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/composable-controller": "^1.0.2",
+    "@metamask/composable-controller": "^4.0.0",
     "@metamask/eslint-config": "^12.2.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
-    "@metamask/transaction-controller": "^3.0.0",
+    "@metamask/approval-controller": "^5.1.1",
+    "@metamask/network-controller": "^17.1.0",
+    "@metamask/transaction-controller": "^19.0.1",
     "@types/jest": "^26.0.22",
     "@types/node": "^20.10.4",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
+    "babel-runtime": "^6.26.0",
     "eslint": "^8.55.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "~2.26.0",
@@ -66,10 +70,10 @@
     "typescript": "^5.1.0"
   },
   "dependencies": {
-    "@metamask/base-controller": "^1.1.2",
+    "@metamask/base-controller": "^4.1.1",
     "@metamask/controller-utils": "^8.0.2",
     "@metamask/eth-query": "^4.0.0",
-    "@metamask/gas-fee-controller": "^3.0.0",
+    "@metamask/gas-fee-controller": "^12.0.0",
     "@metamask/utils": "^8.3.0",
     "abort-controller": "^3.0.0",
     "async-mutex": "^0.4.1",
@@ -81,9 +85,12 @@
   "lavamoat": {
     "allowScripts": {
       "@lavamoat/preinstall-always-fail": false,
-      "@metamask/gas-fee-controller>babel-runtime>core-js": false,
       "@metamask/gas-fee-controller>ethereumjs-util>ethereum-cryptography>keccak": false,
-      "@metamask/gas-fee-controller>ethereumjs-util>ethereum-cryptography>secp256k1": false
+      "@metamask/gas-fee-controller>ethereumjs-util>ethereum-cryptography>secp256k1": false,
+      "@metamask/transaction-controller>babel-runtime>core-js": false,
+      "babel-runtime>core-js": false,
+      "@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>secp256k1": false
     }
   }
 }

src/SwapsController.test.ts

@@ -496,37 +496,47 @@ describe('SwapsController', () => {
 
   describe('tokens cache', () => {
     it('should fetch tokens when no tokens in state', async () => {
-      swapsController.state.tokens = null;
+      swapsController.update({
+        tokens: [],
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).toHaveBeenCalled();
     });
 
     it('should fetch tokens when last fetched is 0', async () => {
-      swapsController.state.tokens = [];
-      swapsController.state.tokensLastFetched = 0;
+      swapsController.update({
+        tokens: [],
+        tokensLastFetched: 0,
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).toHaveBeenCalled();
     });
 
     it('should fetch tokens when last fetched is over threshold', async () => {
       const threshold = 5000;
       swapsController.configure({ fetchTokensThreshold: threshold });
-      swapsController.state.tokens = [];
-      swapsController.state.tokensLastFetched = Date.now() - threshold - 1;
+      swapsController.update({
+        tokens: [],
+        tokensLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).toHaveBeenCalled();
     });
 
     it('should not fetch tokens when no threshold reached', async () => {
-      swapsController.state.tokens = [];
-      swapsController.state.tokensLastFetched = Date.now();
+      swapsController.update({
+        tokens: [],
+        tokensLastFetched: Date.now(),
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).not.toHaveBeenCalled();
     });
 
     it('should not fetch tokens when no threshold reached or tokens are available', async () => {
-      swapsController.state.tokens = [];
-      swapsController.state.tokensLastFetched = Date.now();
+      swapsController.update({
+        tokens: [],
+        tokensLastFetched: Date.now(),
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).not.toHaveBeenCalled();
     });
@@ -537,8 +547,10 @@ describe('SwapsController', () => {
       });
       const threshold = 5000;
       swapsController.configure({ fetchTokensThreshold: threshold });
-      swapsController.state.tokens = [];
-      swapsController.state.tokensLastFetched = Date.now() - threshold - 1;
+      swapsController.update({
+        tokens: [],
+        tokensLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchTokenWithCache();
       expect(swapsUtilFetchTokens).toHaveBeenCalled();
       expect(swapsController.state.tokensLastFetched).toBe(0);
@@ -547,37 +559,47 @@ describe('SwapsController', () => {
 
   describe('top assets cache', () => {
     it('should fetch top assets when no top assets in state', async () => {
-      swapsController.state.topAssets = null;
+      swapsController.update({
+        topAssets: null,
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).toHaveBeenCalled();
     });
 
     it('should fetch top assets when last fetched is 0', async () => {
-      swapsController.state.topAssets = [];
-      swapsController.state.topAssetsLastFetched = 0;
+      swapsController.update({
+        topAssets: [],
+        topAssetsLastFetched: 0,
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).toHaveBeenCalled();
     });
 
     it('should fetch top assets when last fetched is over threshold', async () => {
       const threshold = 5000;
       swapsController.configure({ fetchTopAssetsThreshold: threshold });
-      swapsController.state.topAssets = [];
-      swapsController.state.topAssetsLastFetched = Date.now() - threshold - 1;
+      swapsController.update({
+        topAssets: [],
+        topAssetsLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).toHaveBeenCalled();
     });
 
     it('should not fetch top assets when no threshold reached', async () => {
-      swapsController.state.topAssets = [];
-      swapsController.state.topAssetsLastFetched = Date.now();
+      swapsController.update({
+        topAssets: [],
+        topAssetsLastFetched: Date.now(),
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).not.toHaveBeenCalled();
     });
 
     it('should not fetch top assets when no threshold reached or tokens are available', async () => {
-      swapsController.state.topAssets = [];
-      swapsController.state.topAssetsLastFetched = Date.now();
+      swapsController.update({
+        topAssets: [],
+        topAssetsLastFetched: Date.now(),
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).not.toHaveBeenCalled();
     });
@@ -588,8 +610,10 @@ describe('SwapsController', () => {
       });
       const threshold = 5000;
       swapsController.configure({ fetchTopAssetsThreshold: threshold });
-      swapsController.state.topAssets = [];
-      swapsController.state.topAssetsLastFetched = Date.now() - threshold - 1;
+      swapsController.update({
+        topAssets: [],
+        topAssetsLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchTopAssetsWithCache();
       expect(swapsUtilFetchTopAssets).toHaveBeenCalled();
       expect(swapsController.state.topAssetsLastFetched).toBe(0);
@@ -598,14 +622,18 @@ describe('SwapsController', () => {
 
   describe('aggregator metadata cache', () => {
     it('should fetch aggregator metadata when no aggregator metadata in state', async () => {
-      swapsController.state.aggregatorMetadata = null;
+      swapsController.update({
+        aggregatorMetadata: null,
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).toHaveBeenCalled();
     });
 
     it('should fetch aggregator metadata when last fetched is 0', async () => {
-      swapsController.state.aggregatorMetadata = {};
-      swapsController.state.aggregatorMetadataLastFetched = 0;
+      swapsController.update({
+        aggregatorMetadata: {},
+        aggregatorMetadataLastFetched: 0,
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).toHaveBeenCalled();
     });
@@ -615,23 +643,28 @@ describe('SwapsController', () => {
       swapsController.configure({
         fetchAggregatorMetadataThreshold: threshold,
       });
-      swapsController.state.aggregatorMetadata = {};
-      swapsController.state.aggregatorMetadataLastFetched =
-        Date.now() - threshold - 1;
+      swapsController.update({
+        aggregatorMetadata: {},
+        aggregatorMetadataLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).toHaveBeenCalled();
     });
 
     it('should not fetch aggregator metadata when no threshold reached', async () => {
-      swapsController.state.aggregatorMetadata = {};
-      swapsController.state.aggregatorMetadataLastFetched = Date.now();
+      swapsController.update({
+        aggregatorMetadata: {},
+        aggregatorMetadataLastFetched: Date.now(),
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).not.toHaveBeenCalled();
     });
 
     it('should not fetch aggregator metadata when no threshold reached or tokens are available', async () => {
-      swapsController.state.aggregatorMetadata = {};
-      swapsController.state.aggregatorMetadataLastFetched = Date.now();
+      swapsController.update({
+        aggregatorMetadata: {},
+        aggregatorMetadataLastFetched: Date.now(),
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).not.toHaveBeenCalled();
     });
@@ -644,9 +677,10 @@ describe('SwapsController', () => {
       swapsController.configure({
         fetchAggregatorMetadataThreshold: threshold,
       });
-      swapsController.state.aggregatorMetadata = {};
-      swapsController.state.aggregatorMetadataLastFetched =
-        Date.now() - threshold - 1;
+      swapsController.update({
+        aggregatorMetadata: {},
+        aggregatorMetadataLastFetched: Date.now() - threshold - 1,
+      });
       await swapsController.fetchAggregatorMetadataWithCache();
       expect(swapsUtilFetchAggregatorMetadata).toHaveBeenCalled();
       expect(swapsController.state.aggregatorMetadataLastFetched).toBe(0);

src/SwapsController.ts

@@ -1,5 +1,5 @@
 import type { BaseConfig, BaseState } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
+import { BaseControllerV1 } from '@metamask/base-controller';
 import {
   gweiDecToWEIBN,
   query,
@@ -16,7 +16,7 @@ import type {
   GasFeeStateLegacy,
 } from '@metamask/gas-fee-controller';
 import { GAS_ESTIMATE_TYPES } from '@metamask/gas-fee-controller';
-import type { Transaction } from '@metamask/transaction-controller';
+import type { TransactionParams } from '@metamask/transaction-controller';
 import type { Hex } from '@metamask/utils';
 import { Mutex } from 'async-mutex';
 import { BigNumber } from 'bignumber.js';
@@ -162,7 +162,7 @@ export type SwapsState = {
   topAggId: null | string;
   isInPolling: boolean;
   pollingCyclesLeft: number;
-  approvalTransaction: Transaction | null;
+  approvalTransaction: TransactionParams | null;
   quoteValues: { [key: string]: QuoteValues } | null;
   quoteRefreshSeconds: number | null;
   usedGasEstimate: EthGasPriceEstimate | GasFeeEstimates | null;
@@ -179,7 +179,7 @@ export type SwapsState = {
 type SwapsNextState = {
   quotes: { [key: string]: Quote };
   quotesLastFetched: null | number;
-  approvalTransaction: Transaction | null;
+  approvalTransaction: TransactionParams | null;
   topAggId: null | string;
   topAggSavings?: QuoteSavings | null;
   quoteValues: { [key: string]: QuoteValues } | null;
@@ -216,7 +216,7 @@ function getNewChainCache(
   };
 }
 
-export default class SwapsController extends BaseController<
+export default class SwapsController extends BaseControllerV1<
   SwapsConfig,
   SwapsState
 > {
@@ -239,7 +239,7 @@ export default class SwapsController extends BaseController<
   private readonly fetchEstimatedMultiLayerL1Fee?: (
     eth: any,
     options: {
-      txParams: Transaction;
+      txParams: TransactionParams;
       chainId: Hex;
     },
   ) => Promise<string | undefined>;
@@ -573,7 +573,7 @@ export default class SwapsController extends BaseController<
 
   /* istanbul ignore next */
   private async timedoutGasReturn(
-    tradeTxParams: Transaction | null,
+    tradeTxParams: TransactionParams | null,
   ): Promise<{ gas: string | null }> {
     if (!tradeTxParams) {
       return { gas: null };
@@ -835,7 +835,7 @@ export default class SwapsController extends BaseController<
       fetchEstimatedMultiLayerL1Fee?: (
         eth: EthQuery,
         options: {
-          txParams: Transaction;
+          txParams: TransactionParams;
           chainId: Hex;
         },
       ) => Promise<string | undefined>;