chore: switch over to @ethersproject packages at 5.7.0 for mobile compat (#5416)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

Mobile uses Ethers v5 libs so in order to align better with that we will
be downgrading from v6 to v5 in the `BridgeController`.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/bridge-controller`

- **BREAKING**: Change `ethers` v6 dependency to `@ethersproject`
subpackages at v5 for better Mobile compatibility. This changes the
`ethers` v6 native JS `bigint` return values to `ethers` v5 `BigNumber`
values.

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: infiniteflower

packages/bridge-controller/package.json

@@ -47,12 +47,16 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
+    "@ethersproject/address": "^5.7.0",
+    "@ethersproject/bignumber": "^5.7.0",
+    "@ethersproject/constants": "^5.7.0",
+    "@ethersproject/contracts": "^5.7.0",
+    "@ethersproject/providers": "^5.7.0",
     "@metamask/base-controller": "^8.0.0",
     "@metamask/controller-utils": "^11.5.0",
     "@metamask/metamask-eth-abis": "^3.1.1",
     "@metamask/polling-controller": "^12.0.3",
-    "@metamask/utils": "^11.2.0",
-    "ethers": "^6.12.0"
+    "@metamask/utils": "^11.2.0"
   },
   "devDependencies": {
     "@metamask/accounts-controller": "^24.1.0",

packages/bridge-controller/src/bridge-controller.test.ts

@@ -1,6 +1,6 @@
+import { Contract } from '@ethersproject/contracts';
 import type { Hex } from '@metamask/utils';
 import { bigIntToHex } from '@metamask/utils';
-import { Contract } from 'ethers';
 import nock from 'nock';
 
 import { BridgeController } from './bridge-controller';
@@ -29,13 +29,13 @@ const messengerMock = {
   publish: jest.fn(),
 } as unknown as jest.Mocked<BridgeControllerMessenger>;
 
-jest.mock('ethers', () => {
+jest.mock('@ethersproject/contracts', () => {
   return {
-    ...jest.requireActual('ethers'),
+    ...jest.requireActual('@ethersproject/contracts'),
     Contract: jest.fn(),
-    BrowserProvider: jest.fn(),
   };
 });
+
 const getLayer1GasFeeMock = jest.fn();
 const mockFetchFn = handleFetch;
 

packages/bridge-controller/src/bridge-controller.ts

@@ -1,3 +1,6 @@
+import type { BigNumber } from '@ethersproject/bignumber';
+import { Contract } from '@ethersproject/contracts';
+import { Web3Provider } from '@ethersproject/providers';
 import type { StateMetadata } from '@metamask/base-controller';
 import type { ChainId } from '@metamask/controller-utils';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
@@ -6,7 +9,6 @@ import { StaticIntervalPollingController } from '@metamask/polling-controller';
 import type { TransactionParams } from '@metamask/transaction-controller';
 import { numberToHex } from '@metamask/utils';
 import type { Hex } from '@metamask/utils';
-import { BrowserProvider, Contract } from 'ethers';
 
 import type { BridgeClientId } from './constants/bridge';
 import {
@@ -400,10 +402,10 @@ export class BridgeController extends StaticIntervalPollingController<BridgePoll
       throw new Error('No provider found');
     }
 
-    const ethersProvider = new BrowserProvider(provider);
+    const ethersProvider = new Web3Provider(provider);
     const contract = new Contract(contractAddress, abiERC20, ethersProvider);
     const { address: walletAddress } = this.#getSelectedAccount();
-    const allowance: bigint = await contract.allowance(
+    const allowance: BigNumber = await contract.allowance(
       walletAddress,
       METABRIDGE_CHAIN_TO_ADDRESS_MAP[chainId],
     );

packages/bridge-controller/src/constants/bridge.ts

@@ -1,5 +1,5 @@
+import { AddressZero } from '@ethersproject/constants';
 import type { Hex } from '@metamask/utils';
-import { ZeroAddress } from 'ethers';
 
 import { CHAIN_IDS } from './chains';
 import type { BridgeControllerState } from '../types';
@@ -55,7 +55,7 @@ export const DEFAULT_BRIDGE_CONTROLLER_STATE: BridgeControllerState = {
     [BridgeFeatureFlagsKey.MOBILE_CONFIG]: DEFAULT_FEATURE_FLAG_CONFIG,
   },
   quoteRequest: {
-    srcTokenAddress: ZeroAddress,
+    srcTokenAddress: AddressZero,
     slippage: BRIDGE_DEFAULT_SLIPPAGE,
   },
   quotesInitialLoadTime: null,

packages/bridge-controller/src/utils/balance.test.ts

@@ -1,7 +1,9 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import { AddressZero } from '@ethersproject/constants';
+import { Contract } from '@ethersproject/contracts';
+import { Web3Provider } from '@ethersproject/providers';
 import type { SafeEventEmitterProvider } from '@metamask/eth-json-rpc-provider';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
-import { ZeroAddress } from 'ethers';
-import { BrowserProvider, Contract } from 'ethers';
 
 import * as balanceUtils from './balance';
 import { fetchTokenBalance } from './balance';
@@ -12,11 +14,17 @@ declare global {
   var ethereumProvider: SafeEventEmitterProvider;
 }
 
-jest.mock('ethers', () => {
+jest.mock('@ethersproject/contracts', () => {
   return {
-    ...jest.requireActual('ethers'),
+    ...jest.requireActual('@ethersproject/contracts'),
     Contract: jest.fn(),
-    BrowserProvider: jest.fn(),
+  };
+});
+
+jest.mock('@ethersproject/providers', () => {
+  return {
+    ...jest.requireActual('@ethersproject/providers'),
+    Web3Provider: jest.fn(),
   };
 });
 
@@ -28,7 +36,9 @@ describe('balance', () => {
 
   describe('calcLatestSrcBalance', () => {
     it('should return the ERC20 token balance', async () => {
-      const mockBalanceOf = jest.fn().mockResolvedValueOnce(BigInt(100));
+      const mockBalanceOf = jest
+        .fn()
+        .mockResolvedValueOnce(BigNumber.from(100));
       (Contract as unknown as jest.Mock).mockImplementation(() => ({
         balanceOf: mockBalanceOf,
       }));
@@ -40,16 +50,16 @@ describe('balance', () => {
           '0x456',
           '0x789',
         ),
-      ).toStrictEqual(BigInt(100));
+      ).toStrictEqual(BigNumber.from(100));
       expect(mockBalanceOf).toHaveBeenCalledTimes(1);
       expect(mockBalanceOf).toHaveBeenCalledWith('0x123');
     });
 
     it('should return the native asset balance', async () => {
       const mockGetBalance = jest.fn().mockImplementation(() => {
-        return BigInt(100);
+        return BigNumber.from(100);
       });
-      (BrowserProvider as unknown as jest.Mock).mockImplementation(() => {
+      (Web3Provider as unknown as jest.Mock).mockImplementation(() => {
         return {
           getBalance: mockGetBalance,
         };
@@ -59,10 +69,10 @@ describe('balance', () => {
         await balanceUtils.calcLatestSrcBalance(
           global.ethereumProvider,
           '0x141d32a89a1e0a5Ef360034a2f60a4B917c18838',
-          ZeroAddress,
+          AddressZero,
           '0x789',
         ),
-      ).toStrictEqual(BigInt(100));
+      ).toStrictEqual(BigNumber.from(100));
       expect(mockGetBalance).toHaveBeenCalledTimes(1);
       expect(mockGetBalance).toHaveBeenCalledWith(
         '0x141d32a89a1e0a5Ef360034a2f60a4B917c18838',
@@ -71,7 +81,7 @@ describe('balance', () => {
 
     it('should return undefined if token address and chainId are undefined', async () => {
       const mockGetBalance = jest.fn();
-      (BrowserProvider as unknown as jest.Mock).mockImplementation(() => {
+      (Web3Provider as unknown as jest.Mock).mockImplementation(() => {
         return {
           getBalance: mockGetBalance,
         };
@@ -97,19 +107,19 @@ describe('balance', () => {
   describe('hasSufficientBalance', () => {
     it('should return true if user has sufficient balance', async () => {
       const mockGetBalance = jest.fn();
-      (BrowserProvider as unknown as jest.Mock).mockImplementation(() => {
+      (Web3Provider as unknown as jest.Mock).mockImplementation(() => {
         return {
           getBalance: mockGetBalance,
         };
       });
 
       mockGetBalance.mockImplementation(() => {
-        return BigInt(10000000000000000000);
+        return BigNumber.from('10000000000000000000');
       });
 
       const mockBalanceOf = jest
         .fn()
-        .mockResolvedValueOnce(BigInt('10000000000000000001'));
+        .mockResolvedValueOnce(BigNumber.from('10000000000000000001'));
       (Contract as unknown as jest.Mock).mockImplementation(() => ({
         balanceOf: mockBalanceOf,
       }));
@@ -118,7 +128,7 @@ describe('balance', () => {
         await balanceUtils.hasSufficientBalance(
           global.ethereumProvider,
           '0x141d32a89a1e0a5ef360034a2f60a4b917c18838',
-          ZeroAddress,
+          AddressZero,
           '10000000000000000000',
           '0x1',
         ),
@@ -137,20 +147,22 @@ describe('balance', () => {
 
     it('should return false if user has native assets but insufficient ERC20 src tokens', async () => {
       const mockGetBalance = jest.fn();
-      (BrowserProvider as unknown as jest.Mock).mockImplementation(() => {
+      (Web3Provider as unknown as jest.Mock).mockImplementation(() => {
         return {
           getBalance: mockGetBalance,
         };
       });
 
       mockGetBalance.mockImplementation(() => {
-        return BigInt(10000000000000000000);
+        return BigNumber.from('10000000000000000000');
       });
       const mockFetchTokenBalance = jest.spyOn(
         balanceUtils,
         'fetchTokenBalance',
       );
-      mockFetchTokenBalance.mockResolvedValueOnce(BigInt(9000000000000000000));
+      mockFetchTokenBalance.mockResolvedValueOnce(
+        BigNumber.from('9000000000000000000'),
+      );
 
       expect(
         await balanceUtils.hasSufficientBalance(
@@ -188,25 +200,25 @@ describe('balance', () => {
 });
 
 describe('fetchTokenBalance', () => {
-  let mockProvider: SafeEventEmitterProvider;
+  let mockProvider: FakeProvider;
   const mockAddress = '0x1234567890123456789012345678901234567890';
   const mockUserAddress = '0x9876543210987654321098765432109876543210';
-  const mockBalance = BigInt(1000);
+  const mockBalance = BigNumber.from(1000);
 
   beforeEach(() => {
     jest.clearAllMocks();
     mockProvider = new FakeProvider();
 
-    // Mock BrowserProvider
-    (BrowserProvider as jest.Mock).mockImplementation(() => ({
+    // Mock Web3Provider
+    (Web3Provider as unknown as jest.Mock).mockImplementation(() => ({
       // Add any provider methods needed
     }));
   });
 
   it('should fetch token balance when contract is valid', async () => {
     // Mock Contract
     const mockBalanceOf = jest.fn().mockResolvedValue(mockBalance);
-    (Contract as jest.Mock).mockImplementation(() => ({
+    (Contract as unknown as jest.Mock).mockImplementation(() => ({
       balanceOf: mockBalanceOf,
     }));
 
@@ -216,7 +228,7 @@ describe('fetchTokenBalance', () => {
       mockProvider,
     );
 
-    expect(BrowserProvider).toHaveBeenCalledWith(mockProvider);
+    expect(Web3Provider).toHaveBeenCalledWith(mockProvider);
     expect(Contract).toHaveBeenCalledWith(
       mockAddress,
       abiERC20,
@@ -228,7 +240,7 @@ describe('fetchTokenBalance', () => {
 
   it('should return undefined when contract is invalid', async () => {
     // Mock Contract to return an object without balanceOf method
-    (Contract as jest.Mock).mockImplementation(() => ({
+    (Contract as unknown as jest.Mock).mockImplementation(() => ({
       // Empty object without balanceOf method
     }));
 
@@ -238,7 +250,7 @@ describe('fetchTokenBalance', () => {
       mockProvider,
     );
 
-    expect(BrowserProvider).toHaveBeenCalledWith(mockProvider);
+    expect(Web3Provider).toHaveBeenCalledWith(mockProvider);
     expect(Contract).toHaveBeenCalledWith(
       mockAddress,
       abiERC20,

packages/bridge-controller/src/utils/balance.ts

@@ -1,14 +1,18 @@
+import { getAddress } from '@ethersproject/address';
+import type { BigNumber } from '@ethersproject/bignumber';
+import { AddressZero } from '@ethersproject/constants';
+import { Contract } from '@ethersproject/contracts';
+import { Web3Provider } from '@ethersproject/providers';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
 import type { Provider } from '@metamask/network-controller';
 import type { Hex } from '@metamask/utils';
-import { BrowserProvider, Contract, getAddress, ZeroAddress } from 'ethers';
 
 export const fetchTokenBalance = async (
   address: string,
   userAddress: string,
   provider: Provider,
-): Promise<bigint | undefined> => {
-  const ethersProvider = new BrowserProvider(provider);
+): Promise<BigNumber | undefined> => {
+  const ethersProvider = new Web3Provider(provider);
   const tokenContract = new Contract(address, abiERC20, ethersProvider);
   const tokenBalancePromise =
     typeof tokenContract?.balanceOf === 'function'
@@ -22,10 +26,10 @@ export const calcLatestSrcBalance = async (
   selectedAddress: string,
   tokenAddress: string,
   chainId: Hex,
-): Promise<bigint | undefined> => {
+): Promise<BigNumber | undefined> => {
   if (tokenAddress && chainId) {
-    if (tokenAddress === ZeroAddress) {
-      const ethersProvider = new BrowserProvider(provider);
+    if (tokenAddress === AddressZero) {
+      const ethersProvider = new Web3Provider(provider);
       return await ethersProvider.getBalance(getAddress(selectedAddress));
     }
     return await fetchTokenBalance(tokenAddress, selectedAddress, provider);
@@ -47,5 +51,5 @@ export const hasSufficientBalance = async (
     chainId,
   );
 
-  return srcTokenBalance ? srcTokenBalance >= BigInt(fromTokenAmount) : false;
+  return srcTokenBalance ? srcTokenBalance.gte(fromTokenAmount) : false;
 };

packages/bridge-controller/src/utils/bridge.test.ts

@@ -1,7 +1,7 @@
 /* eslint-disable n/no-process-env */
+import { Contract } from '@ethersproject/contracts';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
 import type { Hex } from '@metamask/utils';
-import { Contract } from 'ethers';
 
 import {
   getEthUsdtResetData,

packages/bridge-controller/src/utils/bridge.ts

@@ -1,6 +1,6 @@
+import { Contract } from '@ethersproject/contracts';
 import { abiERC20 } from '@metamask/metamask-eth-abis';
 import type { Hex } from '@metamask/utils';
-import { Contract } from 'ethers';
 
 import {
   DEFAULT_BRIDGE_CONTROLLER_STATE,

packages/bridge-controller/src/utils/fetch.test.ts

@@ -1,4 +1,4 @@
-import { ZeroAddress } from 'ethers';
+import { AddressZero } from '@ethersproject/constants';
 
 import {
   fetchBridgeFeatureFlags,
@@ -248,8 +248,8 @@ describe('fetch', () => {
           walletAddress: '0x123',
           srcChainId: 1,
           destChainId: 10,
-          srcTokenAddress: ZeroAddress,
-          destTokenAddress: ZeroAddress,
+          srcTokenAddress: AddressZero,
+          destTokenAddress: AddressZero,
           srcTokenAmount: '20000',
           slippage: 0.5,
         },
@@ -282,8 +282,8 @@ describe('fetch', () => {
           walletAddress: '0x123',
           srcChainId: 1,
           destChainId: 10,
-          srcTokenAddress: ZeroAddress,
-          destTokenAddress: ZeroAddress,
+          srcTokenAddress: AddressZero,
+          destTokenAddress: AddressZero,
           srcTokenAmount: '20000',
           slippage: 0.5,
         },
@@ -335,8 +335,8 @@ describe('fetch', () => {
           walletAddress: '0x123',
           srcChainId: 1,
           destChainId: 10,
-          srcTokenAddress: ZeroAddress,
-          destTokenAddress: ZeroAddress,
+          srcTokenAddress: AddressZero,
+          destTokenAddress: AddressZero,
           srcTokenAmount: '20000',
           slippage: 0.5,
         },