test: rename the GanacheContractAddressRegistry class in preparatio…

…n for ganache migration (#28595)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**
The Contract Registry class, is going to be used as it is, in Anvil too.
In the efforts of making [the migration
PR](https://github.com/MetaMask/metamask-extension/pull/27246/files#diff-06cb4d4aa42b7e7467cb49bd17a4282672cc4a352ee698d122e566f25e906692)
smaller, this PR tackles the re-naming of this class
`GanacheContractAddressRegistry` to a more generic name that can be used
both by Ganache and Anvil `ContractAddressRegistry`.

Note: this PR doesn't introduce any functional change in the tests, so
we can skip the quality gate for sparing ci credits.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/28595?quickstart=1)

## **Related issues**

Fixes: MetaMask/MetaMask-planning#3662

## **Manual testing steps**

1. Check all tests continues to work fine

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

test/e2e/helpers.js

@@ -42,7 +42,7 @@ const convertETHToHexGwei = (eth) => convertToHexValue(eth * 10 ** 18);
 /**
  * @typedef {object} Fixtures
  * @property {import('./webdriver/driver').Driver} driver - The driver number.
- * @property {GanacheContractAddressRegistry | undefined} contractRegistry - The contract registry.
+ * @property {ContractAddressRegistry | undefined} contractRegistry - The contract registry.
  * @property {Ganache | undefined} ganacheServer - The Ganache server.
  * @property {Ganache | undefined} secondaryGanacheServer - The secondary Ganache server.
  * @property {mockttp.MockedEndpoint[]} mockedEndpoint - The mocked endpoint.

test/e2e/json-rpc/eth_call.spec.ts

@@ -4,7 +4,7 @@ import { defaultGanacheOptions, withFixtures } from '../helpers';
 import { Driver } from '../webdriver/driver';
 import FixtureBuilder from '../fixture-builder';
 import { Ganache } from '../seeder/ganache';
-import GanacheContractAddressRegistry from '../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../seeder/contract-address-registry';
 import { SMART_CONTRACTS } from '../seeder/smart-contracts';
 import { loginWithBalanceValidation } from '../page-objects/flows/login.flow';
 
@@ -28,7 +28,7 @@ describe('eth_call', function () {
       }: {
         driver: Driver;
         ganacheServer?: Ganache;
-        contractRegistry: GanacheContractAddressRegistry;
+        contractRegistry: ContractAddressRegistry;
       }) => {
         const contract = contractRegistry.getContractAddress(smartContract);
         await loginWithBalanceValidation(driver, ganacheServer);

test/e2e/seeder/ganache-contract-address-registry.js → test/e2e/seeder/contract-address-registry.js

@@ -1,8 +1,8 @@
 /*
  * Use this class to store pre-deployed smart contract addresses of the contracts deployed to
- * a local blockchain instance ran by Ganache.
+ * a local blockchain instance.
  */
-class GanacheContractAddressRegistry {
+class ContractAddressRegistry {
   #addresses = {};
 
   /**
@@ -25,4 +25,4 @@ class GanacheContractAddressRegistry {
   }
 }
 
-module.exports = GanacheContractAddressRegistry;
+module.exports = ContractAddressRegistry;

test/e2e/seeder/ganache-seeder.js

@@ -3,14 +3,14 @@ const { ContractFactory, Contract } = require('@ethersproject/contracts');
 
 const { ENTRYPOINT, GANACHE_ACCOUNT } = require('../constants');
 const { SMART_CONTRACTS, contractConfiguration } = require('./smart-contracts');
-const GanacheContractAddressRegistry = require('./ganache-contract-address-registry');
+const ContractAddressRegistry = require('./contract-address-registry');
 
 /*
  * Ganache seeder is used to seed initial smart contract or set initial blockchain state.
  */
 class GanacheSeeder {
   constructor(ganacheProvider) {
-    this.smartContractRegistry = new GanacheContractAddressRegistry();
+    this.smartContractRegistry = new ContractAddressRegistry();
     this.ganacheProvider = ganacheProvider;
   }
 
@@ -125,7 +125,7 @@ class GanacheSeeder {
   /**
    * Return an instance of the currently used smart contract registry.
    *
-   * @returns GanacheContractAddressRegistry
+   * @returns ContractAddressRegistry
    */
   getContractRegistry() {
     return this.smartContractRegistry;

test/e2e/tests/account/snap-account-contract-interaction.spec.ts

@@ -2,7 +2,7 @@ import { Suite } from 'mocha';
 import { Driver } from '../../webdriver/driver';
 import FixtureBuilder from '../../fixture-builder';
 import { Ganache } from '../../seeder/ganache';
-import GanacheContractAddressRegistry from '../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../seeder/contract-address-registry';
 import {
   multipleGanacheOptionsForType2Transactions,
   PRIVATE_KEY_TWO,
@@ -42,7 +42,7 @@ describe('Snap Account Contract interaction @no-mmi', function (this: Suite) {
         ganacheServer,
       }: {
         driver: Driver;
-        contractRegistry: GanacheContractAddressRegistry;
+        contractRegistry: ContractAddressRegistry;
         ganacheServer?: Ganache;
       }) => {
         await loginWithBalanceValidation(driver, ganacheServer);
@@ -62,7 +62,7 @@ describe('Snap Account Contract interaction @no-mmi', function (this: Suite) {
         // Open Dapp with contract
         const testDapp = new TestDapp(driver);
         const contractAddress = await (
-          contractRegistry as GanacheContractAddressRegistry
+          contractRegistry as ContractAddressRegistry
         ).getContractAddress(smartContract);
         await testDapp.openTestDappPage({ contractAddress });
         await testDapp.check_pageIsLoaded();

test/e2e/tests/confirmations/alerts/queued-confirmations.spec.ts

@@ -10,7 +10,7 @@ import {
   openDAppWithContract,
   TestSuiteArguments,
 } from '../transactions/shared';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 
 const FixtureBuilder = require('../../../fixture-builder');
 const {
@@ -168,7 +168,7 @@ describe('Queued Confirmations', function () {
           await openDAppWithContract(driver, contractRegistry, smartContract);
 
           const contractAddress = await (
-            contractRegistry as GanacheContractAddressRegistry
+            contractRegistry as ContractAddressRegistry
           ).getContractAddress(smartContract);
 
           await connectToDappTwoAndSwitchBackToOne(driver, contractAddress);
@@ -317,7 +317,7 @@ describe('Queued Confirmations', function () {
           await openDAppWithContract(driver, contractRegistry, smartContract);
 
           const contractAddress = await (
-            contractRegistry as GanacheContractAddressRegistry
+            contractRegistry as ContractAddressRegistry
           ).getContractAddress(smartContract);
 
           await connectToDappTwoAndSwitchBackToOne(driver, contractAddress);

test/e2e/tests/confirmations/transactions/contract-interaction-redesign.spec.ts

@@ -2,7 +2,7 @@
 import { Mockttp } from 'mockttp';
 import { openDapp, unlockWallet } from '../../../helpers';
 import { createDappTransaction } from '../../../page-objects/flows/transaction';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { MockedEndpoint } from '../../../mock-e2e';
 import {
@@ -165,7 +165,7 @@ describe('Confirmation Redesign Contract Interaction Component', function () {
           await createLayer2Transaction(driver);
 
           const contractAddress = await (
-            contractRegistry as GanacheContractAddressRegistry
+            contractRegistry as ContractAddressRegistry
           ).getContractAddress(smartContract);
 
           await openDapp(driver, contractAddress);

test/e2e/tests/confirmations/transactions/erc1155-revoke-set-approval-for-all-redesign.ts

@@ -5,7 +5,7 @@ import { unlockWallet, WINDOW_TITLES } from '../../../helpers';
 import { Mockttp } from '../../../mock-e2e';
 import SetApprovalForAllTransactionConfirmation from '../../../page-objects/pages/confirmations/redesign/set-approval-for-all-transaction-confirmation';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { mocked4BytesSetApprovalForAll } from './erc721-revoke-set-approval-for-all-redesign';
@@ -47,12 +47,12 @@ async function mocks(server: Mockttp) {
 
 async function createTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/erc1155-set-approval-for-all-redesign.spec.ts

@@ -4,7 +4,7 @@ import { DAPP_URL, unlockWallet, WINDOW_TITLES } from '../../../helpers';
 import { Mockttp } from '../../../mock-e2e';
 import SetApprovalForAllTransactionConfirmation from '../../../page-objects/pages/confirmations/redesign/set-approval-for-all-transaction-confirmation';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { TestSuiteArguments } from './shared';
@@ -75,12 +75,12 @@ export async function mocked4BytesSetApprovalForAll(mockServer: Mockttp) {
 
 async function createTransactionAssertDetailsAndConfirm(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/erc20-token-send-redesign.spec.ts

@@ -12,7 +12,7 @@ import TokenTransferTransactionConfirmation from '../../../page-objects/pages/co
 import HomePage from '../../../page-objects/pages/homepage';
 import SendTokenPage from '../../../page-objects/pages/send/send-token-page';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { TestSuiteArguments } from './shared';
@@ -115,12 +115,12 @@ export async function mockedSourcifyTokenSend(mockServer: Mockttp) {
 
 async function createWalletInitiatedTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.HST);
 
   const testDapp = new TestDapp(driver);
@@ -160,12 +160,12 @@ async function createWalletInitiatedTransactionAndAssertDetails(
 
 async function createDAppInitiatedTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.HST);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/erc721-revoke-set-approval-for-all-redesign.ts

@@ -5,7 +5,7 @@ import { unlockWallet, WINDOW_TITLES } from '../../../helpers';
 import { Mockttp } from '../../../mock-e2e';
 import SetApprovalForAllTransactionConfirmation from '../../../page-objects/pages/confirmations/redesign/set-approval-for-all-transaction-confirmation';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { TestSuiteArguments } from './shared';
@@ -70,12 +70,12 @@ export async function mocked4BytesSetApprovalForAll(mockServer: Mockttp) {
 
 async function createTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/erc721-set-approval-for-all-redesign.spec.ts

@@ -4,7 +4,7 @@ import { DAPP_URL, unlockWallet, WINDOW_TITLES } from '../../../helpers';
 import { Mockttp } from '../../../mock-e2e';
 import SetApprovalForAllTransactionConfirmation from '../../../page-objects/pages/confirmations/redesign/set-approval-for-all-transaction-confirmation';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { TestSuiteArguments } from './shared';
@@ -75,12 +75,12 @@ export async function mocked4BytesSetApprovalForAll(mockServer: Mockttp) {
 
 async function createTransactionAssertDetailsAndConfirm(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/increase-token-allowance-redesign.spec.ts

@@ -8,7 +8,7 @@ import {
   withFixtures,
 } from '../../../helpers';
 import { Mockttp } from '../../../mock-e2e';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { SMART_CONTRACTS } from '../../../seeder/smart-contracts';
 import { Driver } from '../../../webdriver/driver';
 import { scrollAndConfirmAndAssertConfirm } from '../helpers';
@@ -111,7 +111,7 @@ function generateFixtureOptionsForEIP1559Tx(mochaContext: Mocha.Context) {
 async function createAndAssertIncreaseAllowanceSubmission(
   driver: Driver,
   newSpendingCap: string,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await openDAppWithContract(driver, contractRegistry, SMART_CONTRACTS.HST);
 

test/e2e/tests/confirmations/transactions/nft-token-send-redesign.spec.ts

@@ -14,7 +14,7 @@ import HomePage from '../../../page-objects/pages/homepage';
 import NFTDetailsPage from '../../../page-objects/pages/nft-details-page';
 import SendTokenPage from '../../../page-objects/pages/send/send-token-page';
 import TestDapp from '../../../page-objects/pages/test-dapp';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 import { withRedesignConfirmationFixtures } from '../helpers';
 import { TestSuiteArguments } from './shared';
@@ -184,12 +184,12 @@ export async function mockedERC11554BytesNFTTokenSend(mockServer: Mockttp) {
 
 async function createERC721WalletInitiatedTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);
@@ -231,12 +231,12 @@ async function createERC721WalletInitiatedTransactionAndAssertDetails(
 
 async function createERC721DAppInitiatedTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.NFTS);
 
   const testDapp = new TestDapp(driver);
@@ -266,12 +266,12 @@ async function createERC721DAppInitiatedTransactionAndAssertDetails(
 
 async function createERC1155WalletInitiatedTransactionAndAssertDetails(
   driver: Driver,
-  contractRegistry?: GanacheContractAddressRegistry,
+  contractRegistry?: ContractAddressRegistry,
 ) {
   await unlockWallet(driver);
 
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(SMART_CONTRACTS.ERC1155);
 
   const testDapp = new TestDapp(driver);

test/e2e/tests/confirmations/transactions/shared.ts

@@ -2,7 +2,7 @@
 import { MockedEndpoint } from 'mockttp';
 import { veryLargeDelayMs } from '../../../helpers';
 import { Ganache } from '../../../seeder/ganache';
-import GanacheContractAddressRegistry from '../../../seeder/ganache-contract-address-registry';
+import ContractAddressRegistry from '../../../seeder/contract-address-registry';
 import { Driver } from '../../../webdriver/driver';
 
 const {
@@ -15,17 +15,17 @@ const { scrollAndConfirmAndAssertConfirm } = require('../helpers');
 export type TestSuiteArguments = {
   driver: Driver;
   ganacheServer?: Ganache;
-  contractRegistry?: GanacheContractAddressRegistry;
+  contractRegistry?: ContractAddressRegistry;
   mockedEndpoint?: MockedEndpoint | MockedEndpoint[];
 };
 
 export async function openDAppWithContract(
   driver: Driver,
-  contractRegistry: GanacheContractAddressRegistry | undefined,
+  contractRegistry: ContractAddressRegistry | undefined,
   smartContract: string,
 ) {
   const contractAddress = await (
-    contractRegistry as GanacheContractAddressRegistry
+    contractRegistry as ContractAddressRegistry
   ).getContractAddress(smartContract);
 
   await logInWithBalanceValidation(driver);