chore(26921): bump @metamask/address-book-controller to 6.0.0

MetaMask · Sep 13, 2024 · fea045f · fea045f
1 parent ca6fd53
commit fea045f
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 82 deletions.
diff --git a/app/scripts/lib/AbstractPetnamesBridge.test.ts b/app/scripts/lib/AbstractPetnamesBridge.test.ts
@@ -94,9 +94,7 @@ function createNameControllerMock(state: NameControllerState) {
 function createMessengerMock(): jest.Mocked<PetnamesBridgeMessenger> {
   return {
     subscribe: jest.fn(),
-    // TODO: Replace `any` with type
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
+  } as unknown as jest.Mocked<PetnamesBridgeMessenger>;
 }
 
 describe('AbstractPetnamesBridge', () => {

diff --git a/app/scripts/lib/AddressBookPetnamesBridge.test.ts b/app/scripts/lib/AddressBookPetnamesBridge.test.ts
@@ -7,9 +7,14 @@ import {
 } from '@metamask/name-controller';
 import {
   AddressBookController,
-  AddressBookState,
+  AddressBookControllerState,
 } from '@metamask/address-book-controller';
-import { AddressBookPetnamesBridge } from './AddressBookPetnamesBridge';
+import {
+  AddressBookPetnamesBridge,
+  AddressBookPetnamesBridgeActions,
+  AddressBookPetnamesBridgeEvens,
+  AddressBookPetnamesBridgeMessenger,
+} from './AddressBookPetnamesBridge';
 import { PetnamesBridgeMessenger } from './AbstractPetnamesBridge';
 
 const ADDRESS_MOCK = '0xabc';
@@ -18,10 +23,9 @@ const NAME_2_MOCK = 'testName2';
 const CHAIN_ID_MOCK = '0x1';
 
 function createAddressBookControllerMock(
-  state: AddressBookState,
+  state: AddressBookControllerState,
 ): jest.Mocked<AddressBookController> & {
-  // Override the definition of state. Otherwise state is readonly.
-  state: AddressBookState;
+  state: AddressBookControllerState;
 } {
   return {
     state,
@@ -37,17 +41,13 @@ function createNameControllerMock(
   return {
     state,
     setName: jest.fn(),
-    // TODO: Replace `any` with type
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
+  } as unknown as jest.Mocked<NameController>;
 }
 
-function createMessengerMock(): jest.Mocked<PetnamesBridgeMessenger> {
+function createMessengerMock(): jest.Mocked<AddressBookPetnamesBridgeMessenger> {
   return {
     subscribe: jest.fn(),
-    // TODO: Replace `any` with type
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } as any;
+  } as unknown as jest.Mocked<AddressBookPetnamesBridgeMessenger>;
 }
 
 const EMPTY_NAME_STATE: NameControllerState = {
@@ -81,7 +81,7 @@ function createNameState(address: string, name: string): NameControllerState {
   };
 }
 
-const EMPTY_ADDRESS_BOOK_STATE: AddressBookState = {
+const EMPTY_ADDRESS_BOOK_STATE: AddressBookControllerState = {
   addressBook: {},
 };
 
@@ -96,7 +96,7 @@ function createAddressBookState(
   address: string,
   name: string,
   isEns: boolean,
-): AddressBookState {
+): AddressBookControllerState {
   return {
     ...EMPTY_ADDRESS_BOOK_STATE,
     addressBook: {
@@ -114,14 +114,22 @@ function createAddressBookState(
 }
 
 describe('AddressBookPetnamesBridge', () => {
-  let messenger: jest.Mocked<PetnamesBridgeMessenger>;
+  let messenger: jest.Mocked<
+    PetnamesBridgeMessenger<
+      AddressBookPetnamesBridgeEvens,
+      AddressBookPetnamesBridgeActions
+    >
+  >;
 
   beforeEach(() => {
     jest.resetAllMocks();
-
     messenger = createMessengerMock();
   });
 
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
   describe('NameController', () => {
     it('adds entry when address book entry added', () => {
       const addressBookController = createAddressBookControllerMock(
@@ -139,8 +147,8 @@ describe('AddressBookPetnamesBridge', () => {
         NAME_MOCK,
         true,
       );
-      const listener = addressBookController.subscribe.mock
-        .calls[0][0] as () => void;
+
+      const listener = messenger.subscribe.mock.calls[1][1] as () => void;
       listener();
 
       expect(nameController.setName).toHaveBeenCalledTimes(1);
@@ -173,8 +181,7 @@ describe('AddressBookPetnamesBridge', () => {
         NAME_2_MOCK,
         false,
       );
-      const listener = addressBookController.subscribe.mock
-        .calls[0][0] as () => void;
+      const listener = messenger.subscribe.mock.calls[1][1] as () => void;
       listener();
 
       expect(nameController.setName).toHaveBeenCalledTimes(1);
@@ -203,8 +210,7 @@ describe('AddressBookPetnamesBridge', () => {
 
       addressBookController.state = EMPTY_ADDRESS_BOOK_STATE;
 
-      const listener = addressBookController.subscribe.mock
-        .calls[0][0] as () => void;
+      const listener = messenger.subscribe.mock.calls[1][1] as () => void;
       listener();
 
       expect(nameController.setName).toHaveBeenCalledTimes(1);

diff --git a/app/scripts/lib/AddressBookPetnamesBridge.ts b/app/scripts/lib/AddressBookPetnamesBridge.ts
@@ -1,17 +1,34 @@
-import { AddressBookController } from '@metamask/address-book-controller';
+import {
+  AddressBookController,
+  AddressBookControllerStateChangeEvent,
+  AddressBookControllerActions,
+} from '@metamask/address-book-controller';
 import {
   NameController,
   NameType,
   NameOrigin,
 } from '@metamask/name-controller';
+import type { Hex } from '@metamask/utils';
 import {
   AbstractPetnamesBridge,
   PetnamesBridgeMessenger,
   ChangeType,
   PetnameEntry,
 } from './AbstractPetnamesBridge';
 
-export class AddressBookPetnamesBridge extends AbstractPetnamesBridge {
+export type AddressBookPetnamesBridgeEvens =
+  AddressBookControllerStateChangeEvent;
+export type AddressBookPetnamesBridgeActions = AddressBookControllerActions;
+
+export type AddressBookPetnamesBridgeMessenger = PetnamesBridgeMessenger<
+  AddressBookPetnamesBridgeEvens,
+  AddressBookPetnamesBridgeActions
+>;
+
+export class AddressBookPetnamesBridge extends AbstractPetnamesBridge<
+  AddressBookPetnamesBridgeEvens,
+  AddressBookPetnamesBridgeMessenger
+> {
   #addressBookController: AddressBookController;
 
   constructor({
@@ -21,7 +38,7 @@ export class AddressBookPetnamesBridge extends AbstractPetnamesBridge {
   }: {
     addressBookController: AddressBookController;
     nameController: NameController;
-    messenger: PetnamesBridgeMessenger<never, never>;
+    messenger: AddressBookPetnamesBridgeMessenger;
   }) {
     super({ isTwoWay: true, nameController, messenger });
 
@@ -35,9 +52,7 @@ export class AddressBookPetnamesBridge extends AbstractPetnamesBridge {
     const entries: PetnameEntry[] = [];
     const { state } = this.#addressBookController;
     for (const chainId of Object.keys(state.addressBook)) {
-      // TODO: Replace `any` with type
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const chainEntries = state.addressBook[chainId as any];
+      const chainEntries = state.addressBook[chainId as Hex];
 
       for (const address of Object.keys(chainEntries)) {
         // TODO: Replace `any` with type
@@ -88,6 +103,6 @@ export class AddressBookPetnamesBridge extends AbstractPetnamesBridge {
    * @override
    */
   onSourceChange(listener: () => void): void {
-    this.#addressBookController.subscribe(listener);
+    this.messenger.subscribe('AddressBookController:stateChange', listener);
   }
 }
diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
@@ -1683,10 +1683,17 @@ export default class MetamaskController extends EventEmitter {
       ),
     });
 
-    this.addressBookController = new AddressBookController(
-      undefined,
-      initState.AddressBookController,
-    );
+    const addressBookControllerMessenger =
+      this.controllerMessenger.getRestricted({
+        name: 'AddressBookController',
+        allowedActions: [],
+        allowedEvents: [],
+      });
+
+    this.addressBookController = new AddressBookController({
+      messenger: addressBookControllerMessenger,
+      state: initState.AddressBookController,
+    });
 
     this.alertController = new AlertController({
       initState: initState.AlertController,
@@ -2091,6 +2098,7 @@ export default class MetamaskController extends EventEmitter {
       allowedEvents: [
         'NameController:stateChange',
         'AccountsController:stateChange',
+        'AddressBookController:stateChange',
       ],
       allowedActions: ['AccountsController:listAccounts'],
     });

diff --git a/lavamoat/browserify/beta/policy.json b/lavamoat/browserify/beta/policy.json
@@ -784,18 +784,10 @@
     },
     "@metamask/address-book-controller": {
       "packages": {
-        "@metamask/address-book-controller>@metamask/base-controller": true,
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true
       }
     },
-    "@metamask/address-book-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/announcement-controller": {
       "packages": {
         "@metamask/announcement-controller>@metamask/base-controller": true

diff --git a/lavamoat/browserify/flask/policy.json b/lavamoat/browserify/flask/policy.json
@@ -784,18 +784,10 @@
     },
     "@metamask/address-book-controller": {
       "packages": {
-        "@metamask/address-book-controller>@metamask/base-controller": true,
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true
       }
     },
-    "@metamask/address-book-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/announcement-controller": {
       "packages": {
         "@metamask/announcement-controller>@metamask/base-controller": true

diff --git a/lavamoat/browserify/main/policy.json b/lavamoat/browserify/main/policy.json
@@ -784,18 +784,10 @@
     },
     "@metamask/address-book-controller": {
       "packages": {
-        "@metamask/address-book-controller>@metamask/base-controller": true,
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true
       }
     },
-    "@metamask/address-book-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/announcement-controller": {
       "packages": {
         "@metamask/announcement-controller>@metamask/base-controller": true

diff --git a/lavamoat/browserify/mmi/policy.json b/lavamoat/browserify/mmi/policy.json
@@ -876,18 +876,10 @@
     },
     "@metamask/address-book-controller": {
       "packages": {
-        "@metamask/address-book-controller>@metamask/base-controller": true,
+        "@metamask/base-controller": true,
         "@metamask/controller-utils": true
       }
     },
-    "@metamask/address-book-controller>@metamask/base-controller": {
-      "globals": {
-        "setTimeout": true
-      },
-      "packages": {
-        "immer": true
-      }
-    },
     "@metamask/announcement-controller": {
       "packages": {
         "@metamask/announcement-controller>@metamask/base-controller": true

diff --git a/lavamoat/build-system/policy.json b/lavamoat/build-system/policy.json
@@ -2117,7 +2117,8 @@
         "chokidar>normalize-path": true,
         "chokidar>readdirp": true,
         "del>is-glob": true,
-        "eslint>glob-parent": true
+        "eslint>glob-parent": true,
+        "tsx>fsevents": true
       }
     },
     "chokidar>anymatch": {
@@ -8893,6 +8894,13 @@
         "typescript": true
       }
     },
+    "tsx>fsevents": {
+      "globals": {
+        "console.assert": true,
+        "process.platform": true
+      },
+      "native": true
+    },
     "typescript": {
       "builtin": {
         "buffer.Buffer": true,

diff --git a/package.json b/package.json
@@ -301,7 +301,7 @@
     "@metamask/abi-utils": "^2.0.2",
     "@metamask/account-watcher": "^4.1.0",
     "@metamask/accounts-controller": "^18.2.0",
-    "@metamask/address-book-controller": "^5.0.0",
+    "@metamask/address-book-controller": "^6.0.0",
     "@metamask/announcement-controller": "^7.0.0",
     "@metamask/approval-controller": "^7.0.0",
     "@metamask/assets-controllers": "^36.0.0",

diff --git a/yarn.lock b/yarn.lock
@@ -4765,14 +4765,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/address-book-controller@npm:^5.0.0":
-  version: 5.0.0
-  resolution: "@metamask/address-book-controller@npm:5.0.0"
+"@metamask/address-book-controller@npm:^6.0.0":
+  version: 6.0.0
+  resolution: "@metamask/address-book-controller@npm:6.0.0"
   dependencies:
-    "@metamask/base-controller": "npm:^6.0.0"
-    "@metamask/controller-utils": "npm:^11.0.0"
-    "@metamask/utils": "npm:^8.3.0"
-  checksum: 10/f4f3ec2c569457243cc4771c2d146a91227114431ecf8bb0d74e42b2e93fcc4d10545c32f865c918c9f1586379016d3ea2d7f2bc056a6b10b6cfd985f2b3c432
+    "@metamask/base-controller": "npm:^7.0.0"
+    "@metamask/controller-utils": "npm:^11.2.0"
+    "@metamask/utils": "npm:^9.1.0"
+  checksum: 10/e699b97fc798a363390d673b766737dc10f82a1eefcf119823d8f4370846d6708b3b2eadd177c8b2cb826afa7e38b51cf978a0d55cd51e92e7a9ffe83f5f0803
   languageName: node
   linkType: hard
 
@@ -25970,7 +25970,7 @@ __metadata:
     "@metamask/abi-utils": "npm:^2.0.2"
     "@metamask/account-watcher": "npm:^4.1.0"
     "@metamask/accounts-controller": "npm:^18.2.0"
-    "@metamask/address-book-controller": "npm:^5.0.0"
+    "@metamask/address-book-controller": "npm:^6.0.0"
     "@metamask/announcement-controller": "npm:^7.0.0"
     "@metamask/api-specs": "npm:^0.9.3"
     "@metamask/approval-controller": "npm:^7.0.0"