Add privacy setting to disable external name sources

app/scripts/controllers/metametrics.js

@@ -11,6 +11,7 @@ import {
 import { ObservableStore } from '@metamask/obs-store';
 import { bufferToHex, keccak } from 'ethereumjs-util';
 import { v4 as uuidv4 } from 'uuid';
+import { NameType } from '@metamask/name-controller';
 import { ENVIRONMENT_TYPE_BACKGROUND } from '../../../shared/constants/app';
 import {
   METAMETRICS_ANONYMOUS_ID,
@@ -800,6 +801,10 @@ export default class MetaMetricsController {
       ///: END:ONLY_INCLUDE_IN
       [MetaMetricsUserTrait.SecurityProviders]:
         metamaskState.transactionSecurityCheckEnabled ? ['opensea'] : [],
+      ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+      [MetaMetricsUserTrait.PetnameAddressCount]:
+        this._getPetnameAddressCount(metamaskState),
+      ///: END:ONLY_INCLUDE_IN
     };
 
     if (!previousUserTraits) {
@@ -1076,4 +1081,29 @@ export default class MetaMetricsController {
     };
     this.segment[eventType](modifiedPayload, modifiedCallback);
   }
+
+  /**
+   * Returns the total number of Ethereum addresses with saved petnames,
+   * including all chain ID variations.
+   *
+   * @param {object} metamaskState
+   * @returns {number}
+   */
+  _getPetnameAddressCount(metamaskState) {
+    const addressNames = metamaskState.names?.[NameType.ETHEREUM_ADDRESS] ?? {};
+
+    return Object.keys(addressNames).reduce((totalCount, address) => {
+      const addressEntry = addressNames[address];
+
+      const addressNameCount = Object.keys(addressEntry).reduce(
+        (count, chainId) => {
+          const hasName = Boolean(addressEntry[chainId].name?.length);
+          return count + (hasName ? 1 : 0);
+        },
+        0,
+      );
+
+      return totalCount + addressNameCount;
+    }, 0);
+  }
 }

app/scripts/controllers/metametrics.test.js

@@ -1,6 +1,7 @@
 import { strict as assert } from 'assert';
 import sinon from 'sinon';
 import { toHex } from '@metamask/controller-utils';
+import { NameType } from '@metamask/name-controller';
 import { ENVIRONMENT_TYPE_BACKGROUND } from '../../../shared/constants/app';
 import { createSegmentMock } from '../lib/segment';
 import {
@@ -1028,6 +1029,38 @@ describe('MetaMetricsController', function () {
         useTokenDetection: true,
         desktopEnabled: false,
         security_providers: [],
+        names: {
+          [NameType.ETHEREUM_ADDRESS]: {
+            '0x123': {
+              '0x1': {
+                name: 'Test 1',
+              },
+              '0x2': {
+                name: 'Test 2',
+              },
+              '0x3': {
+                name: null,
+              },
+            },
+            '0x456': {
+              '0x1': {
+                name: 'Test 3',
+              },
+            },
+            '0x789': {
+              '0x1': {
+                name: null,
+              },
+            },
+          },
+          otherType: {
+            otherValue: {
+              otherVariation: {
+                name: 'Test 4',
+              },
+            },
+          },
+        },
       });
 
       assert.deepEqual(traits, {
@@ -1056,6 +1089,9 @@ describe('MetaMetricsController', function () {
         [MetaMetricsUserTrait.MmiAccountAddress]: null,
         [MetaMetricsUserTrait.MmiIsCustodian]: false,
         ///: END:ONLY_INCLUDE_IN
+        ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+        [MetaMetricsUserTrait.PetnameAddressCount]: 3,
+        ///: END:ONLY_INCLUDE_IN
       });
     });
 

app/scripts/controllers/preferences.js

@@ -106,6 +106,9 @@ export default class PreferencesController {
       snapsAddSnapAccountModalDismissed: false,
       ///: END:ONLY_INCLUDE_IN
       isLineaMainnetReleased: false,
+      ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+      useExternalNameSources: true,
+      ///: END:ONLY_INCLUDE_IN
       ...opts.initState,
     };
 
@@ -261,6 +264,19 @@ export default class PreferencesController {
   }
   ///: END:ONLY_INCLUDE_IN
 
+  ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+  /**
+   * Setter for the `useExternalNameSources` property
+   *
+   * @param {boolean} useExternalNameSources - Whether or not to use external name providers in the name controller.
+   */
+  setUseExternalNameSources(useExternalNameSources) {
+    this.store.updateState({
+      useExternalNameSources,
+    });
+  }
+  ///: END:ONLY_INCLUDE_IN
+
   /**
    * Setter for the `advancedGasFee` property
    *

app/scripts/controllers/preferences.test.js

@@ -419,4 +419,21 @@ describe('preferences controller', () => {
       });
     });
   });
+
+  ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+  describe('setUseExternalNameSources', () => {
+    it('should default to true', () => {
+      expect(
+        preferencesController.store.getState().useExternalNameSources,
+      ).toStrictEqual(true);
+    });
+
+    it('should set the useExternalNameSources property in state', () => {
+      preferencesController.setUseExternalNameSources(false);
+      expect(
+        preferencesController.store.getState().useExternalNameSources,
+      ).toStrictEqual(false);
+    });
+  });
+  ///: END:ONLY_INCLUDE_IN
 });

app/scripts/lib/SnapsNameProvider.test.ts

@@ -139,7 +139,7 @@ describe('SnapsNameProvider', () => {
       const response = await provider.getProposedNames({
         value: VALUE_MOCK,
         type: NameType.ETHEREUM_ADDRESS,
-        chainId: CHAIN_ID_MOCK,
+        variation: CHAIN_ID_MOCK,
       });
 
       expect(response).toStrictEqual({
@@ -193,7 +193,7 @@ describe('SnapsNameProvider', () => {
       const response = await provider.getProposedNames({
         value: VALUE_MOCK,
         type: NameType.ETHEREUM_ADDRESS,
-        chainId: CHAIN_ID_MOCK,
+        variation: CHAIN_ID_MOCK,
       });
 
       expect(response).toStrictEqual({
@@ -224,7 +224,7 @@ describe('SnapsNameProvider', () => {
       const response = await provider.getProposedNames({
         value: VALUE_MOCK,
         type: NameType.ETHEREUM_ADDRESS,
-        chainId: CHAIN_ID_MOCK,
+        variation: CHAIN_ID_MOCK,
       });
 
       expect(response).toStrictEqual({

app/scripts/lib/SnapsNameProvider.ts

@@ -107,7 +107,7 @@ export class SnapsNameProvider implements NameProvider {
     snap: TruncatedSnap,
     request: NameProviderRequest,
   ): Promise<{ sourceId: string; result: NameProviderSourceResult }> {
-    const { chainId: chainIdHex, value } = request;
+    const { variation: chainIdHex, value } = request;
     const sourceId = snap.id;
     const chainIdDecimal = parseInt(chainIdHex, 16);
 

app/scripts/metamask-controller.js

@@ -1538,8 +1538,10 @@ export default class MetamaskController extends EventEmitter {
     );
 
     ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+    const isExternalNameSourcesEnabled = () =>
+      this.preferencesController.store.getState().useExternalNameSources;
+
     this.nameController = new NameController({
-      getChainId: () => this.networkController.state.providerConfig.chainId,
       messenger: this.controllerMessenger.getRestricted({
         name: 'NameController',
         allowedActions: [],
@@ -1550,9 +1552,9 @@ export default class MetamaskController extends EventEmitter {
             this.ensController,
           ),
         }),
-        new EtherscanNameProvider({}),
-        new TokenNameProvider({}),
-        new LensNameProvider(),
+        new EtherscanNameProvider({ isEnabled: isExternalNameSourcesEnabled }),
+        new TokenNameProvider({ isEnabled: isExternalNameSourcesEnabled }),
+        new LensNameProvider({ isEnabled: isExternalNameSourcesEnabled }),
         new SnapsNameProvider({
           messenger: this.controllerMessenger.getRestricted({
             name: 'SnapsNameProvider',
@@ -2403,6 +2405,12 @@ export default class MetamaskController extends EventEmitter {
           preferencesController,
         ),
       ///: END:ONLY_INCLUDE_IN
+      ///: BEGIN:ONLY_INCLUDE_IN(petnames)
+      setUseExternalNameSources:
+        preferencesController.setUseExternalNameSources.bind(
+          preferencesController,
+        ),
+      ///: END:ONLY_INCLUDE_IN
       setIpfsGateway: preferencesController.setIpfsGateway.bind(
         preferencesController,
       ),

lavamoat/browserify/beta/policy.json

@@ -1771,7 +1771,22 @@
         "fetch": true
       },
       "packages": {
-        "@metamask/base-controller": true
+        "@metamask/base-controller": true,
+        "@metamask/name-controller>@metamask/utils": true,
+        "eth-json-rpc-filters>async-mutex": true
+      }
+    },
+    "@metamask/name-controller>@metamask/utils": {
+      "globals": {
+        "TextDecoder": true,
+        "TextEncoder": true
+      },
+      "packages": {
+        "@metamask/key-tree>@noble/hashes": true,
+        "browserify>buffer": true,
+        "nock>debug": true,
+        "semver": true,
+        "superstruct": true
       }
     },
     "@metamask/network-controller": {

lavamoat/browserify/desktop/policy.json

@@ -1912,7 +1912,22 @@
         "fetch": true
       },
       "packages": {
-        "@metamask/base-controller": true
+        "@metamask/base-controller": true,
+        "@metamask/name-controller>@metamask/utils": true,
+        "eth-json-rpc-filters>async-mutex": true
+      }
+    },
+    "@metamask/name-controller>@metamask/utils": {
+      "globals": {
+        "TextDecoder": true,
+        "TextEncoder": true
+      },
+      "packages": {
+        "@metamask/key-tree>@noble/hashes": true,
+        "browserify>buffer": true,
+        "nock>debug": true,
+        "semver": true,
+        "superstruct": true
       }
     },
     "@metamask/network-controller": {

lavamoat/browserify/flask/policy.json

@@ -1912,7 +1912,22 @@
         "fetch": true
       },
       "packages": {
-        "@metamask/base-controller": true
+        "@metamask/base-controller": true,
+        "@metamask/name-controller>@metamask/utils": true,
+        "eth-json-rpc-filters>async-mutex": true
+      }
+    },
+    "@metamask/name-controller>@metamask/utils": {
+      "globals": {
+        "TextDecoder": true,
+        "TextEncoder": true
+      },
+      "packages": {
+        "@metamask/key-tree>@noble/hashes": true,
+        "browserify>buffer": true,
+        "nock>debug": true,
+        "semver": true,
+        "superstruct": true
       }
     },
     "@metamask/network-controller": {

lavamoat/browserify/main/policy.json

@@ -1771,7 +1771,22 @@
         "fetch": true
       },
       "packages": {
-        "@metamask/base-controller": true
+        "@metamask/base-controller": true,
+        "@metamask/name-controller>@metamask/utils": true,
+        "eth-json-rpc-filters>async-mutex": true
+      }
+    },
+    "@metamask/name-controller>@metamask/utils": {
+      "globals": {
+        "TextDecoder": true,
+        "TextEncoder": true
+      },
+      "packages": {
+        "@metamask/key-tree>@noble/hashes": true,
+        "browserify>buffer": true,
+        "nock>debug": true,
+        "semver": true,
+        "superstruct": true
       }
     },
     "@metamask/network-controller": {

lavamoat/browserify/mmi/policy.json

@@ -1911,7 +1911,22 @@
         "fetch": true
       },
       "packages": {
-        "@metamask/base-controller": true
+        "@metamask/base-controller": true,
+        "@metamask/name-controller>@metamask/utils": true,
+        "eth-json-rpc-filters>async-mutex": true
+      }
+    },
+    "@metamask/name-controller>@metamask/utils": {
+      "globals": {
+        "TextDecoder": true,
+        "TextEncoder": true
+      },
+      "packages": {
+        "@metamask/key-tree>@noble/hashes": true,
+        "browserify>buffer": true,
+        "nock>debug": true,
+        "semver": true,
+        "superstruct": true
       }
     },
     "@metamask/network-controller": {

package.json

@@ -261,7 +261,7 @@
     "@metamask/logo": "^3.1.1",
     "@metamask/message-manager": "^7.3.0",
     "@metamask/metamask-eth-abis": "^3.0.0",
-    "@metamask/name-controller": "^1.0.0",
+    "@metamask/name-controller": "^3.0.0",
     "@metamask/network-controller": "^12.2.0",
     "@metamask/notification-controller": "^3.0.0",
     "@metamask/obs-store": "^8.1.0",