Use name component in signature requests

app/scripts/metamask-controller.js

@@ -101,6 +101,16 @@ import {
 } from '@metamask/controller-utils';
 import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english';
 
+///: BEGIN:ONLY_INCLUDE_IN(petnames)
+import {
+  NameController,
+  ENSNameProvider,
+  EtherscanNameProvider,
+  TokenNameProvider,
+  LensNameProvider,
+} from '@metamask/name-controller';
+///: END:ONLY_INCLUDE_IN
+
 ///: BEGIN:ONLY_INCLUDE_IN(build-mmi)
 import { toChecksumHexAddress } from '../../shared/modules/hexstring-utils';
 ///: END:ONLY_INCLUDE_IN
@@ -1511,6 +1521,27 @@ export default class MetamaskController extends EventEmitter {
       initState.SmartTransactionsController,
     );
 
+    ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+    this.nameController = new NameController({
+      getChainId: () => this.networkController.state.providerConfig.chainId,
+      messenger: this.controllerMessenger.getRestricted({
+        name: 'NameController',
+        allowedActions: [],
+      }),
+      providers: [
+        new ENSNameProvider({
+          reverseLookup: this.ensController.reverseResolveAddress.bind(
+            this.ensController,
+          ),
+        }),
+        new EtherscanNameProvider({}),
+        new TokenNameProvider({}),
+        new LensNameProvider(),
+      ],
+      state: initState.NameController,
+    });
+    ///: END:ONLY_INCLUDE_IN
+
     this.txController.on('newSwapApproval', (txMeta) => {
       this.swapsController.setApproveTxId(txMeta.id);
     });
@@ -1716,6 +1747,9 @@ export default class MetamaskController extends EventEmitter {
       ///: BEGIN:ONLY_INCLUDE_IN(blockaid)
       PPOMController: this.ppomController,
       ///: END:ONLY_INCLUDE_IN
+      ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+      NameController: this.nameController,
+      ///: END:ONLY_INCLUDE_IN
       ...resetOnRestartStore,
     });
 
@@ -1751,13 +1785,15 @@ export default class MetamaskController extends EventEmitter {
         ///: BEGIN:ONLY_INCLUDE_IN(desktop)
         DesktopController: this.desktopController.store,
         ///: END:ONLY_INCLUDE_IN
-
         ///: BEGIN:ONLY_INCLUDE_IN(build-mmi)
         CustodyController: this.custodyController.store,
         InstitutionalFeaturesController:
           this.institutionalFeaturesController.store,
         MmiConfigurationController: this.mmiConfigurationController.store,
         ///: END:ONLY_INCLUDE_IN
+        ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+        NameController: this.nameController,
+        ///: END:ONLY_INCLUDE_IN
         ...resetOnRestartStore,
       },
       controllerMessenger: this.controllerMessenger,
@@ -2854,6 +2890,13 @@ export default class MetamaskController extends EventEmitter {
 
       // E2E testing
       throwTestError: this.throwTestError.bind(this),
+
+      ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+      updateProposedNames: this.nameController.updateProposedNames.bind(
+        this.nameController,
+      ),
+      setName: this.nameController.setName.bind(this.nameController),
+      ///: END:ONLY_INCLUDE_IN
     };
   }
 

builds.yml

@@ -52,6 +52,7 @@ buildTypes:
       - build-flask
       - keyring-snaps
       - blockaid
+      - petnames
     env:
       - INFURA_FLASK_PROJECT_ID
       - SEGMENT_FLASK_WRITE_KEY
@@ -125,6 +126,7 @@ features:
     env:
       - BLOCKAID_FILE_CDN: static.metafi.codefi.network/api/v1/confirmations/ppom
       - BLOCKAID_PUBLIC_KEY: 066ad3e8af5583385e312c156d238055215d5f25247c1e91055afa756cb98a88
+  petnames:
 
   ###
   # Build Type code extensions. Things like different support links, warning pages, banners

test/e2e/fixture-builder.js

@@ -1405,6 +1405,20 @@ class FixtureBuilder {
     });
   }
 
+  withNameController(data) {
+    merge(
+      this.fixture.data.NameController
+        ? this.fixture.data.NameController
+        : (this.fixture.data.NameController = {}),
+      data,
+    );
+    return this;
+  }
+
+  withNoNames() {
+    return this.withNameController({ names: {} });
+  }
+
   build() {
     this.fixture.meta = {
       version: 74,

test/e2e/mock-e2e.js

@@ -388,7 +388,61 @@ async function setupMocking(server, testSpecificMock, { chainId }) {
       };
     });
 
+  await mockLensNameProvider(server);
+  await mockTokenNameProvider(server, chainId);
+
   return mockedEndpoint;
 }
 
+async function mockLensNameProvider(server) {
+  const handlesByAddress = {
+    '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826': 'test.lens',
+    '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB': 'test2.lens',
+    '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC': 'test3.lens',
+  };
+
+  await server.forPost('https://api.lens.dev').thenCallback((request) => {
+    const address = request.body?.json?.variables?.address;
+    const handle = handlesByAddress[address];
+
+    return {
+      statusCode: 200,
+      json: {
+        data: {
+          profiles: {
+            items: [
+              {
+                handle,
+              },
+            ],
+          },
+        },
+      },
+    };
+  });
+}
+
+async function mockTokenNameProvider(server) {
+  const namesByAddress = {
+    '0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF': 'Test Token',
+    '0xB0BdaBea57B0BDABeA57b0bdABEA57b0BDabEa57': 'Test Token 2',
+  };
+
+  for (const address of Object.keys(namesByAddress)) {
+    const name = namesByAddress[address];
+
+    await server
+      .forGet(/https:\/\/token-api\.metaswap\.codefi\.network\/token\/.*/gu)
+      .withQuery({ address })
+      .thenCallback(() => {
+        return {
+          statusCode: 200,
+          json: {
+            name,
+          },
+        };
+      });
+  }
+}
+
 module.exports = { setupMocking };

test/e2e/run-all.js

@@ -109,6 +109,7 @@ async function main() {
         'test-snap-rpc.spec.js',
         'test-snap-lifecycle.spec.js',
         'ppom-toggle-settings.spec.js',
+        'petnames.spec.js',
       ];
       testPaths = testPaths.filter((p) =>
         filteredTests.every((filteredTest) => !p.endsWith(filteredTest)),