Use account identities as default petnames

app/scripts/lib/setupAccountLabelsPetnamesBridge.test.ts

@@ -0,0 +1,153 @@
+import { NameController } from '@metamask/name-controller';
+import setupAccountLabelsPetnamesBridge, {
+  PertinentPreferencesController,
+  PertinentState,
+  ACCOUNT_LABEL_NAME_TYPE,
+  ACCOUNT_LABEL_VARIATION,
+} from './setupAccountLabelsPetnamesBridge';
+
+const ADDRESS_MOCK = '0xabc';
+const NAME_MOCK = 'testName';
+const NAME_2_MOCK = 'testName2';
+
+interface MockPreferencesController
+  extends jest.Mocked<PertinentPreferencesController> {
+  store: jest.Mocked<PertinentPreferencesController['store']>;
+}
+
+function createPreferencesControllerMock(
+  identities: PertinentState['identities'] = {},
+): MockPreferencesController {
+  return {
+    store: {
+      getState: jest.fn(() => ({ identities })),
+      subscribe: jest.fn(),
+    },
+  };
+}
+
+function createNameControllerMock(
+  state: any = {},
+): jest.Mocked<NameController> {
+  return {
+    state: {
+      names: {
+        ethereumAddress: state,
+      },
+    },
+    setName: jest.fn(),
+  } as any;
+}
+
+describe('setupAccountLabelsPetnamesBridge', () => {
+  let preferencesControllerDefault: MockPreferencesController;
+  let nameControllerDefault: NameController;
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+
+    preferencesControllerDefault = createPreferencesControllerMock();
+    nameControllerDefault = createNameControllerMock();
+  });
+
+  it('adds entry when account id entry added', () => {
+    setupAccountLabelsPetnamesBridge(
+      preferencesControllerDefault,
+      nameControllerDefault,
+    );
+
+    preferencesControllerDefault.store.subscribe.mock.calls[0][0]({
+      identities: {
+        [ADDRESS_MOCK]: {
+          address: ADDRESS_MOCK,
+          name: NAME_MOCK,
+        },
+      },
+    });
+
+    expect(nameControllerDefault.setName).toHaveBeenCalledTimes(1);
+    expect(nameControllerDefault.setName).toHaveBeenCalledWith({
+      value: ADDRESS_MOCK,
+      type: ACCOUNT_LABEL_NAME_TYPE,
+      variation: ACCOUNT_LABEL_VARIATION,
+      name: NAME_MOCK,
+    });
+  });
+
+  it('updates entry when account id is updated', () => {
+    nameControllerDefault = createNameControllerMock({
+      [ADDRESS_MOCK]: {
+        [ACCOUNT_LABEL_VARIATION]: {
+          name: NAME_MOCK,
+          proposedNames: {},
+        },
+      },
+    });
+
+    preferencesControllerDefault = createPreferencesControllerMock({
+      [ADDRESS_MOCK]: {
+        address: ADDRESS_MOCK,
+        name: NAME_MOCK,
+      },
+    });
+
+    setupAccountLabelsPetnamesBridge(
+      preferencesControllerDefault,
+      nameControllerDefault,
+    );
+
+    preferencesControllerDefault.store.subscribe.mock.calls[0][0]({
+      identities: {
+        [ADDRESS_MOCK]: {
+          address: ADDRESS_MOCK,
+          name: NAME_2_MOCK,
+        },
+      },
+    });
+
+    expect(nameControllerDefault.setName).toHaveBeenCalledTimes(1);
+    expect(nameControllerDefault.setName).toHaveBeenCalledWith({
+      value: ADDRESS_MOCK,
+      type: ACCOUNT_LABEL_NAME_TYPE,
+      name: NAME_2_MOCK,
+      sourceId: undefined,
+      variation: ACCOUNT_LABEL_VARIATION,
+    });
+  });
+
+  it('deletes entry when address book entry is deleted', () => {
+    nameControllerDefault = createNameControllerMock({
+      [ADDRESS_MOCK]: {
+        [ACCOUNT_LABEL_VARIATION]: {
+          name: NAME_MOCK,
+          proposedNames: {},
+        } as any,
+      },
+    });
+
+    preferencesControllerDefault = createPreferencesControllerMock({
+      [ADDRESS_MOCK]: {
+        address: ADDRESS_MOCK,
+        name: NAME_MOCK,
+      },
+    });
+
+    setupAccountLabelsPetnamesBridge(
+      preferencesControllerDefault,
+      nameControllerDefault,
+    );
+
+    preferencesControllerDefault.store.subscribe.mock.calls[0][0]({
+      identities: {},
+    });
+
+    expect(nameControllerDefault.setName).toHaveBeenCalledTimes(1);
+    expect(nameControllerDefault.setName).toHaveBeenCalledWith({
+      value: ADDRESS_MOCK,
+      type: ACCOUNT_LABEL_NAME_TYPE,
+      name: null,
+      sourceId: undefined,
+      variation: ACCOUNT_LABEL_VARIATION,
+    });
+  });
+});

app/scripts/lib/setupAccountLabelsPetnamesBridge.ts

@@ -0,0 +1,105 @@
+import { NameController, NameType } from '@metamask/name-controller';
+import { cloneDeep } from 'lodash';
+import log from 'loglevel';
+
+type IdentityEntry = {
+  address: string;
+  name: string;
+};
+
+export type PertinentState = {
+  identities: { [address: string]: IdentityEntry };
+};
+
+export type PertinentPreferencesController = {
+  store: {
+    getState: () => PertinentState;
+    subscribe: (callback: (state: PertinentState) => void) => void;
+  };
+};
+
+const MAINNET_CHAIN_ID = '0x1';
+export const ACCOUNT_LABEL_NAME_TYPE = NameType.ETHEREUM_ADDRESS;
+export const ACCOUNT_LABEL_VARIATION = MAINNET_CHAIN_ID;
+
+/**
+ * Groups the entries in the old and new entries arrays into added, updated and
+ * deleted entries, like a patch.
+ *
+ * @param oldEntries - The last seen IdentityEntries in the preferences controller.
+ * @param newEntries - The new IdentityEntries.
+ */
+function groupEntries(
+  oldEntries: IdentityEntry[],
+  newEntries: IdentityEntry[],
+): {
+  added: IdentityEntry[];
+  updated: IdentityEntry[];
+  deleted: IdentityEntry[];
+} {
+  const added = newEntries.filter(
+    (newEntry) =>
+      !oldEntries.some((oldEntry) => oldEntry.address === newEntry.address),
+  );
+
+  const updated = newEntries.filter((newEntry) =>
+    oldEntries.some(
+      (oldEntry) =>
+        oldEntry.address === newEntry.address &&
+        oldEntry.name !== newEntry.name,
+    ),
+  );
+
+  const deleted = oldEntries.filter(
+    (oldEntry) =>
+      !newEntries.some((newEntry) => newEntry.address === oldEntry.address),
+  );
+
+  return { added, updated, deleted };
+}
+
+/**
+ * Sets up a bridge between the account labels in the preferences controller and
+ * the petnames in the name controller.
+ *
+ * @param preferencesController - The preferences controller to listen to.
+ * @param nameController - The name controller to update.
+ */
+export default function setupAccountLabelsPetnamesBridge(
+  preferencesController: PertinentPreferencesController,
+  nameController: NameController,
+) {
+  const { identities } = preferencesController.store.getState();
+
+  let oldEntries = Object.values(identities);
+
+  preferencesController.store.subscribe(async (state) => {
+    const newEntries = Object.values(state.identities);
+
+    const { added, updated, deleted } = groupEntries(oldEntries, newEntries);
+
+    for (const entry of [...added, ...updated]) {
+      nameController.setName({
+        type: ACCOUNT_LABEL_NAME_TYPE,
+        variation: ACCOUNT_LABEL_VARIATION,
+        value: entry.address,
+        name: entry.name,
+      });
+
+      log.debug('Updated petname following account label update', entry);
+    }
+
+    for (const entry of deleted) {
+      nameController.setName({
+        type: ACCOUNT_LABEL_NAME_TYPE,
+        variation: ACCOUNT_LABEL_VARIATION,
+        value: entry.address,
+        name: null,
+      });
+
+      log.debug('Removed petname following account label removal', entry);
+    }
+
+    oldEntries = cloneDeep(newEntries);
+  });
+}

app/scripts/metamask-controller.js

@@ -288,6 +288,7 @@ import { IndexedDBPPOMStorage } from './lib/ppom/indexed-db-backend';
 import { updateCurrentLocale } from './translate';
 ///: BEGIN:ONLY_INCLUDE_IN(keyring-snaps)
 import { snapKeyringBuilder, getAccountsBySnapId } from './lib/snap-keyring';
+import setupAccountLabelsPetnamesBridge from './lib/setupAccountLabelsPetnamesBridge';
 ///: END:ONLY_INCLUDE_IN
 
 export const METAMASK_CONTROLLER_EVENTS = {
@@ -1775,6 +1776,11 @@ export default class MetamaskController extends EventEmitter {
         allowedEvents: ['NameController:stateChange'],
       }),
     }).init();
+
+    setupAccountLabelsPetnamesBridge(
+      this.preferencesController,
+      this.nameController,
+    );
     ///: END:ONLY_INCLUDE_IN
 
     // ensure accountTracker updates balances after network change