@metamask-previews/address-book-controller 6.0.3-preview-7bb49dcb → 6.0.3-preview-c47fa49d

package/CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `AddressBookControllerContactUpdatedEvent` and `AddressBookControllerContactDeletedEvent` types for contact events ([#5779](https://github.com/MetaMask/core/pull/5779))
+- Add `list` method on `AddressBookController` to get all address book entries as an array ([#5779](https://github.com/MetaMask/core/pull/5779))
+- Register message handlers for `list`, `set`, and `delete` actions ([#5779](https://github.com/MetaMask/core/pull/5779))
+
 ### Changed
 
 - Bump `@metamask/base-controller` from ^8.0.0 to ^8.0.1 ([#5722](https://github.com/MetaMask/core/pull/5722))
 - Bump `@metamask/controller-utils` to `^11.9.0` ([#5583](https://github.com/MetaMask/core/pull/5583), [#5765](https://github.com/MetaMask/core/pull/5765), [#5812](https://github.com/MetaMask/core/pull/5812))
+- Modified `delete` method to clean up empty chainId objects ([#5779](https://github.com/MetaMask/core/pull/5779))
 
 ## [6.0.3]
 

package/dist/AddressBookController.cjs

@@ -1,4 +1,10 @@
 "use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AddressBookController_instances, _AddressBookController_registerMessageHandlers;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AddressBookController = exports.getDefaultAddressBookControllerState = exports.controllerName = exports.AddressType = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -8,14 +14,8 @@ const controller_utils_1 = require("@metamask/controller-utils");
  */
 var AddressType;
 (function (AddressType) {
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["externallyOwnedAccounts"] = "EXTERNALLY_OWNED_ACCOUNTS";
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["contractAccounts"] = "CONTRACT_ACCOUNTS";
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["nonAccounts"] = "NON_ACCOUNTS";
 })(AddressType || (exports.AddressType = AddressType = {}));
 /**
@@ -55,6 +55,25 @@ class AddressBookController extends base_controller_1.BaseController {
             name: exports.controllerName,
             state: mergedState,
         });
+        _AddressBookController_instances.add(this);
+        __classPrivateFieldGet(this, _AddressBookController_instances, "m", _AddressBookController_registerMessageHandlers).call(this);
+    }
+    /**
+     * Returns all address book entries as an array.
+     *
+     * @returns Array of all address book entries.
+     */
+    list() {
+        const { addressBook } = this.state;
+        const contacts = [];
+        Object.keys(addressBook).forEach((chainId) => {
+            const chainIdHex = chainId;
+            Object.keys(addressBook[chainIdHex]).forEach((address) => {
+                const contact = addressBook[chainIdHex][address];
+                contacts.push(contact);
+            });
+        });
+        return contacts;
     }
     /**
      * Remove all contract entries.
@@ -79,12 +98,20 @@ class AddressBookController extends base_controller_1.BaseController {
             !this.state.addressBook[chainId][address]) {
             return false;
         }
+        const deletedEntry = { ...this.state.addressBook[chainId][address] };
         this.update((state) => {
-            delete state.addressBook[chainId][address];
-            if (Object.keys(state.addressBook[chainId]).length === 0) {
-                delete state.addressBook[chainId];
+            if (state.addressBook[chainId] && state.addressBook[chainId][address]) {
+                delete state.addressBook[chainId][address];
+                // Clean up empty chainId objects
+                if (Object.keys(state.addressBook[chainId]).length === 0) {
+                    delete state.addressBook[chainId];
+                }
             }
         });
+        // Skip sending delete event for global contacts with chainId '*'
+        if (String(chainId) !== '*') {
+            this.messagingSystem.publish('AddressBookController:contactDeleted', deletedEntry);
+        }
         return true;
     }
     /**
@@ -109,6 +136,7 @@ class AddressBookController extends base_controller_1.BaseController {
             memo,
             name,
             addressType,
+            lastUpdatedAt: Date.now(),
         };
         const ensName = (0, controller_utils_1.normalizeEnsName)(name);
         if (ensName) {
@@ -124,9 +152,18 @@ class AddressBookController extends base_controller_1.BaseController {
                 },
             };
         });
+        // Skip sending update event for global contacts with chainId '*'
+        if (String(chainId) !== '*') {
+            this.messagingSystem.publish('AddressBookController:contactUpdated', entry);
+        }
         return true;
     }
 }
 exports.AddressBookController = AddressBookController;
+_AddressBookController_instances = new WeakSet(), _AddressBookController_registerMessageHandlers = function _AddressBookController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler(`${exports.controllerName}:list`, this.list.bind(this));
+    this.messagingSystem.registerActionHandler(`${exports.controllerName}:set`, this.set.bind(this));
+    this.messagingSystem.registerActionHandler(`${exports.controllerName}:delete`, this.delete.bind(this));
+};
 exports.default = AddressBookController;
 //# sourceMappingURL=AddressBookController.cjs.map

package/dist/AddressBookController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AddressBookController.cjs","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAC3D,iEAMoC;AAiBpC;;GAEG;AACH,IAAY,WAUX;AAVD,WAAY,WAAW;IACrB,gFAAgF;IAChF,gEAAgE;IAChE,oEAAqD,CAAA;IACrD,gFAAgF;IAChF,gEAAgE;IAChE,qDAAsC,CAAA;IACtC,gFAAgF;IAChF,gEAAgE;IAChE,2CAA4B,CAAA;AAC9B,CAAC,EAVW,WAAW,2BAAX,WAAW,QAUtB;AAgCD;;GAEG;AACU,QAAA,cAAc,GAAG,uBAAuB,CAAC;AA4BtD,MAAM,6BAA6B,GAAG;IACpC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACjD,CAAC;AAEF;;;;GAIG;AACI,MAAM,oCAAoC,GAC/C,GAA+B,EAAE;IAC/B,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC,CAAC;AALS,QAAA,oCAAoC,wCAK7C;AAaJ;;GAEG;AACH,MAAa,qBAAsB,SAAQ,gCAI1C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,MAAM,WAAW,GAAG,EAAE,GAAG,IAAA,4CAAoC,GAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QAC5E,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,IACE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,mCAAgB,EAAC,GAAG,CAAC,CAAC;YACzD,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC;YAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EACzC;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxD,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aACnC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,OAAe,EACf,IAAY,EACZ,OAAO,GAAG,IAAA,wBAAK,EAAC,CAAC,CAAC,EAClB,IAAI,GAAG,EAAE,EACT,WAAyB;QAEzB,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SACd;QAED,MAAM,KAAK,GAAG;YACZ,OAAO;YACP,OAAO;YACP,KAAK,EAAE,KAAK;YACZ,IAAI;YACJ,IAAI;YACJ,WAAW;SACZ,CAAC;QAEF,MAAM,OAAO,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;YACrB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;SACpB;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG;gBAClB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW;gBACzB,CAAC,OAAO,CAAC,EAAE;oBACT,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;oBAClC,CAAC,OAAO,CAAC,EAAE,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlHD,sDAkHC;AAED,kBAAe,qBAAqB,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  isSafeDynamicKey,\n  toChecksumHexAddress,\n  toHex,\n} from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * @type ContactEntry\n *\n * ContactEntry representation\n * @property address - Hex address of a recipient account\n * @property name - Nickname associated with this address\n * @property importTime - Data time when an account as created/imported\n */\nexport type ContactEntry = {\n  address: string;\n  name: string;\n  importTime?: number;\n};\n\n/**\n * The type of address.\n */\nexport enum AddressType {\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  externallyOwnedAccounts = 'EXTERNALLY_OWNED_ACCOUNTS',\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  contractAccounts = 'CONTRACT_ACCOUNTS',\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  nonAccounts = 'NON_ACCOUNTS',\n}\n\n/**\n * @type AddressBookEntry\n *\n * AddressBookEntry representation\n * @property address - Hex address of a recipient account\n * @property name - Nickname associated with this address\n * @property chainId - Chain id identifies the current chain\n * @property memo - User's note about address\n * @property isEns - is the entry an ENS name\n * @property addressType - is the type of this address\n */\nexport type AddressBookEntry = {\n  address: string;\n  name: string;\n  chainId: Hex;\n  memo: string;\n  isEns: boolean;\n  addressType?: AddressType;\n};\n\n/**\n * @type AddressBookState\n *\n * Address book controller state\n * @property addressBook - Array of contact entry objects\n */\nexport type AddressBookControllerState = {\n  addressBook: { [chainId: Hex]: { [address: string]: AddressBookEntry } };\n};\n\n/**\n * The name of the {@link AddressBookController}.\n */\nexport const controllerName = 'AddressBookController';\n\n/**\n * The action that can be performed to get the state of the {@link AddressBookController}.\n */\nexport type AddressBookControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The actions that can be performed using the {@link AddressBookController}.\n */\nexport type AddressBookControllerActions = AddressBookControllerGetStateAction;\n\n/**\n * The event that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The events that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerEvents = AddressBookControllerStateChangeEvent;\n\nconst addressBookControllerMetadata = {\n  addressBook: { persist: true, anonymous: false },\n};\n\n/**\n * Get the default {@link AddressBookController} state.\n *\n * @returns The default {@link AddressBookController} state.\n */\nexport const getDefaultAddressBookControllerState =\n  (): AddressBookControllerState => {\n    return {\n      addressBook: {},\n    };\n  };\n\n/**\n * The messenger of the {@link AddressBookController} for communication.\n */\nexport type AddressBookControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AddressBookControllerActions,\n  AddressBookControllerEvents,\n  never,\n  never\n>;\n\n/**\n * Controller that manages a list of recipient addresses associated with nicknames.\n */\nexport class AddressBookController extends BaseController<\n  typeof controllerName,\n  AddressBookControllerState,\n  AddressBookControllerMessenger\n> {\n  /**\n   * Creates an AddressBookController instance.\n   *\n   * @param args - The {@link AddressBookController} arguments.\n   * @param args.messenger - The controller messenger instance for communication.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AddressBookControllerMessenger;\n    state?: Partial<AddressBookControllerState>;\n  }) {\n    const mergedState = { ...getDefaultAddressBookControllerState(), ...state };\n    super({\n      messenger,\n      metadata: addressBookControllerMetadata,\n      name: controllerName,\n      state: mergedState,\n    });\n  }\n\n  /**\n   * Remove all contract entries.\n   */\n  clear() {\n    this.update((state) => {\n      state.addressBook = {};\n    });\n  }\n\n  /**\n   * Remove a contract entry by address.\n   *\n   * @param chainId - Chain id identifies the current chain.\n   * @param address - Recipient address to delete.\n   * @returns Whether the entry was deleted.\n   */\n  delete(chainId: Hex, address: string) {\n    address = toChecksumHexAddress(address);\n    if (\n      ![chainId, address].every((key) => isSafeDynamicKey(key)) ||\n      !isValidHexAddress(address) ||\n      !this.state.addressBook[chainId] ||\n      !this.state.addressBook[chainId][address]\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      delete state.addressBook[chainId][address];\n      if (Object.keys(state.addressBook[chainId]).length === 0) {\n        delete state.addressBook[chainId];\n      }\n    });\n\n    return true;\n  }\n\n  /**\n   * Add or update a contact entry by address.\n   *\n   * @param address - Recipient address to add or update.\n   * @param name - Nickname to associate with this address.\n   * @param chainId - Chain id identifies the current chain.\n   * @param memo - User's note about address.\n   * @param addressType - Contact's address type.\n   * @returns Boolean indicating if the address was successfully set.\n   */\n  set(\n    address: string,\n    name: string,\n    chainId = toHex(1),\n    memo = '',\n    addressType?: AddressType,\n  ) {\n    address = toChecksumHexAddress(address);\n    if (!isValidHexAddress(address)) {\n      return false;\n    }\n\n    const entry = {\n      address,\n      chainId,\n      isEns: false,\n      memo,\n      name,\n      addressType,\n    };\n\n    const ensName = normalizeEnsName(name);\n    if (ensName) {\n      entry.name = ensName;\n      entry.isEns = true;\n    }\n\n    this.update((state) => {\n      state.addressBook = {\n        ...this.state.addressBook,\n        [chainId]: {\n          ...this.state.addressBook[chainId],\n          [address]: entry,\n        },\n      };\n    });\n\n    return true;\n  }\n}\n\nexport default AddressBookController;\n"]}
+{"version":3,"file":"AddressBookController.cjs","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":";;;;;;;;;AAKA,+DAA2D;AAC3D,iEAMoC;AAGpC;;GAEG;AACH,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,oEAAqD,CAAA;IACrD,qDAAsC,CAAA;IACtC,2CAA4B,CAAA;AAC9B,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AA2DD;;GAEG;AACU,QAAA,cAAc,GAAG,uBAAuB,CAAC;AA2EtD,MAAM,6BAA6B,GAAG;IACpC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACjD,CAAC;AAEF;;;;GAIG;AACI,MAAM,oCAAoC,GAC/C,GAA+B,EAAE;IAC/B,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC,CAAC;AALS,QAAA,oCAAoC,wCAK7C;AAaJ;;GAEG;AACH,MAAa,qBAAsB,SAAQ,gCAI1C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,MAAM,WAAW,GAAG,EAAE,GAAG,IAAA,4CAAoC,GAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QAC5E,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;;QAEH,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACnC,MAAM,QAAQ,GAAuB,EAAE,CAAC;QAExC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3C,MAAM,UAAU,GAAG,OAAc,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvD,MAAM,OAAO,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;gBACjD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,IACE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,mCAAgB,EAAC,GAAG,CAAC,CAAC;YACzD,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC;YAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EACzC;YACA,OAAO,KAAK,CAAC;SACd;QAED,MAAM,YAAY,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAErE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE;gBACrE,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;gBAE3C,iCAAiC;gBACjC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oBACxD,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;iBACnC;aACF;QACH,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,sCAAsC,EACtC,YAAY,CACb,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,OAAe,EACf,IAAY,EACZ,OAAO,GAAG,IAAA,wBAAK,EAAC,CAAC,CAAC,EAClB,IAAI,GAAG,EAAE,EACT,WAAyB;QAEzB,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SACd;QAED,MAAM,KAAK,GAAG;YACZ,OAAO;YACP,OAAO;YACP,KAAK,EAAE,KAAK;YACZ,IAAI;YACJ,IAAI;YACJ,WAAW;YACX,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE;SAC1B,CAAC;QACF,MAAM,OAAO,GAAG,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;YACrB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;SACpB;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG;gBAClB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW;gBACzB,CAAC,OAAO,CAAC,EAAE;oBACT,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;oBAClC,CAAC,OAAO,CAAC,EAAE,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,sCAAsC,EACtC,KAAK,CACN,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CAmBF;AAhLD,sDAgLC;;IAbG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,sBAAc,OAAO,EACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CACrB,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,sBAAc,MAAM,EACvB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CACpB,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,sBAAc,SAAS,EAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CACvB,CAAC;AACJ,CAAC;AAGH,kBAAe,qBAAqB,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  isSafeDynamicKey,\n  toChecksumHexAddress,\n  toHex,\n} from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * The type of address.\n */\nexport enum AddressType {\n  externallyOwnedAccounts = 'EXTERNALLY_OWNED_ACCOUNTS',\n  contractAccounts = 'CONTRACT_ACCOUNTS',\n  nonAccounts = 'NON_ACCOUNTS',\n}\n\n/**\n * AddressBookEntry\n *\n * AddressBookEntry representation\n *\n * address - Hex address of a recipient account\n *\n * name - Nickname associated with this address\n *\n * chainId - Chain id identifies the current chain\n *\n * memo - User's note about address\n *\n * isEns - is the entry an ENS name\n *\n * addressType - is the type of this address\n *\n * lastUpdatedAt - timestamp of when this entry was last updated\n */\nexport type AddressBookEntry = {\n  address: string;\n  name: string;\n  chainId: Hex;\n  memo: string;\n  isEns: boolean;\n  addressType?: AddressType;\n  lastUpdatedAt?: number;\n};\n\n/**\n * Sync metadata interface used for contacts syncing.\n * This is used by the UserStorageController and not stored in address book.\n */\ntype SyncMetadata = {\n  deleted?: boolean;\n  deletedAt?: number;\n  lastUpdatedAt?: number;\n};\n\n/**\n * Address book entry with sync metadata\n */\nexport type AddressBookEntryWithSyncMetadata = {\n  _syncMetadata?: SyncMetadata;\n} & AddressBookEntry;\n\n/**\n * AddressBookState\n *\n * Address book controller state\n *\n * addressBook - Array of contact entry objects\n */\nexport type AddressBookControllerState = {\n  addressBook: { [chainId: Hex]: { [address: string]: AddressBookEntry } };\n};\n\n/**\n * The name of the {@link AddressBookController}.\n */\nexport const controllerName = 'AddressBookController';\n\n/**\n * The action that can be performed to get the state of the {@link AddressBookController}.\n */\nexport type AddressBookControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The action that can be performed to list contacts from the {@link AddressBookController}.\n */\nexport type AddressBookControllerListAction = {\n  type: `${typeof controllerName}:list`;\n  handler: AddressBookController['list'];\n};\n\n/**\n * The action that can be performed to set a contact in the {@link AddressBookController}.\n */\nexport type AddressBookControllerSetAction = {\n  type: `${typeof controllerName}:set`;\n  handler: AddressBookController['set'];\n};\n\n/**\n * The action that can be performed to delete a contact from the {@link AddressBookController}.\n */\nexport type AddressBookControllerDeleteAction = {\n  type: `${typeof controllerName}:delete`;\n  handler: AddressBookController['delete'];\n};\n\n/**\n * Event emitted when a contact is added or updated\n */\nexport type AddressBookControllerContactUpdatedEvent = {\n  type: `${typeof controllerName}:contactUpdated`;\n  payload: [AddressBookEntry];\n};\n\n/**\n * Event emitted when a contact is deleted\n */\nexport type AddressBookControllerContactDeletedEvent = {\n  type: `${typeof controllerName}:contactDeleted`;\n  payload: [AddressBookEntry];\n};\n\n/**\n * The actions that can be performed using the {@link AddressBookController}.\n */\nexport type AddressBookControllerActions =\n  | AddressBookControllerGetStateAction\n  | AddressBookControllerListAction\n  | AddressBookControllerSetAction\n  | AddressBookControllerDeleteAction;\n\n/**\n * The event that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The events that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerEvents =\n  | AddressBookControllerStateChangeEvent\n  | AddressBookControllerContactUpdatedEvent\n  | AddressBookControllerContactDeletedEvent;\n\nconst addressBookControllerMetadata = {\n  addressBook: { persist: true, anonymous: false },\n};\n\n/**\n * Get the default {@link AddressBookController} state.\n *\n * @returns The default {@link AddressBookController} state.\n */\nexport const getDefaultAddressBookControllerState =\n  (): AddressBookControllerState => {\n    return {\n      addressBook: {},\n    };\n  };\n\n/**\n * The messenger of the {@link AddressBookController} for communication.\n */\nexport type AddressBookControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AddressBookControllerActions,\n  AddressBookControllerEvents,\n  never,\n  never\n>;\n\n/**\n * Controller that manages a list of recipient addresses associated with nicknames.\n */\nexport class AddressBookController extends BaseController<\n  typeof controllerName,\n  AddressBookControllerState,\n  AddressBookControllerMessenger\n> {\n  /**\n   * Creates an AddressBookController instance.\n   *\n   * @param args - The {@link AddressBookController} arguments.\n   * @param args.messenger - The controller messenger instance for communication.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AddressBookControllerMessenger;\n    state?: Partial<AddressBookControllerState>;\n  }) {\n    const mergedState = { ...getDefaultAddressBookControllerState(), ...state };\n    super({\n      messenger,\n      metadata: addressBookControllerMetadata,\n      name: controllerName,\n      state: mergedState,\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Returns all address book entries as an array.\n   *\n   * @returns Array of all address book entries.\n   */\n  list(): AddressBookEntry[] {\n    const { addressBook } = this.state;\n    const contacts: AddressBookEntry[] = [];\n\n    Object.keys(addressBook).forEach((chainId) => {\n      const chainIdHex = chainId as Hex;\n      Object.keys(addressBook[chainIdHex]).forEach((address) => {\n        const contact = addressBook[chainIdHex][address];\n        contacts.push(contact);\n      });\n    });\n\n    return contacts;\n  }\n\n  /**\n   * Remove all contract entries.\n   */\n  clear() {\n    this.update((state) => {\n      state.addressBook = {};\n    });\n  }\n\n  /**\n   * Remove a contract entry by address.\n   *\n   * @param chainId - Chain id identifies the current chain.\n   * @param address - Recipient address to delete.\n   * @returns Whether the entry was deleted.\n   */\n  delete(chainId: Hex, address: string) {\n    address = toChecksumHexAddress(address);\n    if (\n      ![chainId, address].every((key) => isSafeDynamicKey(key)) ||\n      !isValidHexAddress(address) ||\n      !this.state.addressBook[chainId] ||\n      !this.state.addressBook[chainId][address]\n    ) {\n      return false;\n    }\n\n    const deletedEntry = { ...this.state.addressBook[chainId][address] };\n\n    this.update((state) => {\n      if (state.addressBook[chainId] && state.addressBook[chainId][address]) {\n        delete state.addressBook[chainId][address];\n\n        // Clean up empty chainId objects\n        if (Object.keys(state.addressBook[chainId]).length === 0) {\n          delete state.addressBook[chainId];\n        }\n      }\n    });\n\n    // Skip sending delete event for global contacts with chainId '*'\n    if (String(chainId) !== '*') {\n      this.messagingSystem.publish(\n        'AddressBookController:contactDeleted',\n        deletedEntry,\n      );\n    }\n\n    return true;\n  }\n\n  /**\n   * Add or update a contact entry by address.\n   *\n   * @param address - Recipient address to add or update.\n   * @param name - Nickname to associate with this address.\n   * @param chainId - Chain id identifies the current chain.\n   * @param memo - User's note about address.\n   * @param addressType - Contact's address type.\n   * @returns Boolean indicating if the address was successfully set.\n   */\n  set(\n    address: string,\n    name: string,\n    chainId = toHex(1),\n    memo = '',\n    addressType?: AddressType,\n  ) {\n    address = toChecksumHexAddress(address);\n    if (!isValidHexAddress(address)) {\n      return false;\n    }\n\n    const entry = {\n      address,\n      chainId,\n      isEns: false,\n      memo,\n      name,\n      addressType,\n      lastUpdatedAt: Date.now(),\n    };\n    const ensName = normalizeEnsName(name);\n    if (ensName) {\n      entry.name = ensName;\n      entry.isEns = true;\n    }\n\n    this.update((state) => {\n      state.addressBook = {\n        ...this.state.addressBook,\n        [chainId]: {\n          ...this.state.addressBook[chainId],\n          [address]: entry,\n        },\n      };\n    });\n\n    // Skip sending update event for global contacts with chainId '*'\n    if (String(chainId) !== '*') {\n      this.messagingSystem.publish(\n        'AddressBookController:contactUpdated',\n        entry,\n      );\n    }\n\n    return true;\n  }\n\n  /**\n   * Registers message handlers for the AddressBookController.\n   */\n  #registerMessageHandlers() {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:list`,\n      this.list.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:set`,\n      this.set.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:delete`,\n      this.delete.bind(this),\n    );\n  }\n}\n\nexport default AddressBookController;\n"]}

package/dist/AddressBookController.d.cts

@@ -1,19 +1,6 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
-/**
- * @type ContactEntry
- *
- * ContactEntry representation
- * @property address - Hex address of a recipient account
- * @property name - Nickname associated with this address
- * @property importTime - Data time when an account as created/imported
- */
-export type ContactEntry = {
-    address: string;
-    name: string;
-    importTime?: number;
-};
 /**
  * The type of address.
  */
@@ -23,15 +10,23 @@ export declare enum AddressType {
     nonAccounts = "NON_ACCOUNTS"
 }
 /**
- * @type AddressBookEntry
+ * AddressBookEntry
  *
  * AddressBookEntry representation
- * @property address - Hex address of a recipient account
- * @property name - Nickname associated with this address
- * @property chainId - Chain id identifies the current chain
- * @property memo - User's note about address
- * @property isEns - is the entry an ENS name
- * @property addressType - is the type of this address
+ *
+ * address - Hex address of a recipient account
+ *
+ * name - Nickname associated with this address
+ *
+ * chainId - Chain id identifies the current chain
+ *
+ * memo - User's note about address
+ *
+ * isEns - is the entry an ENS name
+ *
+ * addressType - is the type of this address
+ *
+ * lastUpdatedAt - timestamp of when this entry was last updated
  */
 export type AddressBookEntry = {
     address: string;
@@ -40,12 +35,29 @@ export type AddressBookEntry = {
     memo: string;
     isEns: boolean;
     addressType?: AddressType;
+    lastUpdatedAt?: number;
 };
 /**
- * @type AddressBookState
+ * Sync metadata interface used for contacts syncing.
+ * This is used by the UserStorageController and not stored in address book.
+ */
+type SyncMetadata = {
+    deleted?: boolean;
+    deletedAt?: number;
+    lastUpdatedAt?: number;
+};
+/**
+ * Address book entry with sync metadata
+ */
+export type AddressBookEntryWithSyncMetadata = {
+    _syncMetadata?: SyncMetadata;
+} & AddressBookEntry;
+/**
+ * AddressBookState
  *
  * Address book controller state
- * @property addressBook - Array of contact entry objects
+ *
+ * addressBook - Array of contact entry objects
  */
 export type AddressBookControllerState = {
     addressBook: {
@@ -62,10 +74,45 @@ export declare const controllerName = "AddressBookController";
  * The action that can be performed to get the state of the {@link AddressBookController}.
  */
 export type AddressBookControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AddressBookControllerState>;
+/**
+ * The action that can be performed to list contacts from the {@link AddressBookController}.
+ */
+export type AddressBookControllerListAction = {
+    type: `${typeof controllerName}:list`;
+    handler: AddressBookController['list'];
+};
+/**
+ * The action that can be performed to set a contact in the {@link AddressBookController}.
+ */
+export type AddressBookControllerSetAction = {
+    type: `${typeof controllerName}:set`;
+    handler: AddressBookController['set'];
+};
+/**
+ * The action that can be performed to delete a contact from the {@link AddressBookController}.
+ */
+export type AddressBookControllerDeleteAction = {
+    type: `${typeof controllerName}:delete`;
+    handler: AddressBookController['delete'];
+};
+/**
+ * Event emitted when a contact is added or updated
+ */
+export type AddressBookControllerContactUpdatedEvent = {
+    type: `${typeof controllerName}:contactUpdated`;
+    payload: [AddressBookEntry];
+};
+/**
+ * Event emitted when a contact is deleted
+ */
+export type AddressBookControllerContactDeletedEvent = {
+    type: `${typeof controllerName}:contactDeleted`;
+    payload: [AddressBookEntry];
+};
 /**
  * The actions that can be performed using the {@link AddressBookController}.
  */
-export type AddressBookControllerActions = AddressBookControllerGetStateAction;
+export type AddressBookControllerActions = AddressBookControllerGetStateAction | AddressBookControllerListAction | AddressBookControllerSetAction | AddressBookControllerDeleteAction;
 /**
  * The event that {@link AddressBookController} can emit.
  */
@@ -73,7 +120,7 @@ export type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<t
 /**
  * The events that {@link AddressBookController} can emit.
  */
-export type AddressBookControllerEvents = AddressBookControllerStateChangeEvent;
+export type AddressBookControllerEvents = AddressBookControllerStateChangeEvent | AddressBookControllerContactUpdatedEvent | AddressBookControllerContactDeletedEvent;
 /**
  * Get the default {@link AddressBookController} state.
  *
@@ -88,6 +135,7 @@ export type AddressBookControllerMessenger = RestrictedMessenger<typeof controll
  * Controller that manages a list of recipient addresses associated with nicknames.
  */
 export declare class AddressBookController extends BaseController<typeof controllerName, AddressBookControllerState, AddressBookControllerMessenger> {
+    #private;
     /**
      * Creates an AddressBookController instance.
      *
@@ -99,6 +147,12 @@ export declare class AddressBookController extends BaseController<typeof control
         messenger: AddressBookControllerMessenger;
         state?: Partial<AddressBookControllerState>;
     });
+    /**
+     * Returns all address book entries as an array.
+     *
+     * @returns Array of all address book entries.
+     */
+    list(): AddressBookEntry[];
     /**
      * Remove all contract entries.
      */

package/dist/AddressBookController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"AddressBookController.d.cts","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAQ3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW;IAGrB,uBAAuB,8BAA8B;IAGrD,gBAAgB,sBAAsB;IAGtC,WAAW,iBAAiB;CAC7B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;CAC1E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,mCAAmC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;AAMhF;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,QAC3C,0BAIH,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,EACL,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAUD;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;IAqBpC;;;;;;;;;OASG;IACH,GAAG,CACD,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,gBAAW,EAClB,IAAI,SAAK,EACT,WAAW,CAAC,EAAE,WAAW;CAkC5B;AAED,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"AddressBookController.d.cts","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAQ3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,WAAW;IACrB,uBAAuB,8BAA8B;IACrD,gBAAgB,sBAAsB;IACtC,WAAW,iBAAiB;CAC7B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,KAAK,YAAY,GAAG;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B,GAAG,gBAAgB,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;CAC1E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,MAAM,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,cAAc,SAAS,CAAC;IACxC,OAAO,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,mCAAmC,GACnC,+BAA+B,GAC/B,8BAA8B,GAC9B,iCAAiC,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,qCAAqC,GACrC,wCAAwC,GACxC,wCAAwC,CAAC;AAM7C;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,QAC3C,0BAIH,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,EACL,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAYD;;;;OAIG;IACH,IAAI,IAAI,gBAAgB,EAAE;IAe1B;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;IAmCpC;;;;;;;;;OASG;IACH,GAAG,CACD,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,gBAAW,EAClB,IAAI,SAAK,EACT,WAAW,CAAC,EAAE,WAAW;CA4D5B;AAED,eAAe,qBAAqB,CAAC"}

package/dist/AddressBookController.d.mts

@@ -1,19 +1,6 @@
 import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
 import { BaseController } from "@metamask/base-controller";
 import type { Hex } from "@metamask/utils";
-/**
- * @type ContactEntry
- *
- * ContactEntry representation
- * @property address - Hex address of a recipient account
- * @property name - Nickname associated with this address
- * @property importTime - Data time when an account as created/imported
- */
-export type ContactEntry = {
-    address: string;
-    name: string;
-    importTime?: number;
-};
 /**
  * The type of address.
  */
@@ -23,15 +10,23 @@ export declare enum AddressType {
     nonAccounts = "NON_ACCOUNTS"
 }
 /**
- * @type AddressBookEntry
+ * AddressBookEntry
  *
  * AddressBookEntry representation
- * @property address - Hex address of a recipient account
- * @property name - Nickname associated with this address
- * @property chainId - Chain id identifies the current chain
- * @property memo - User's note about address
- * @property isEns - is the entry an ENS name
- * @property addressType - is the type of this address
+ *
+ * address - Hex address of a recipient account
+ *
+ * name - Nickname associated with this address
+ *
+ * chainId - Chain id identifies the current chain
+ *
+ * memo - User's note about address
+ *
+ * isEns - is the entry an ENS name
+ *
+ * addressType - is the type of this address
+ *
+ * lastUpdatedAt - timestamp of when this entry was last updated
  */
 export type AddressBookEntry = {
     address: string;
@@ -40,12 +35,29 @@ export type AddressBookEntry = {
     memo: string;
     isEns: boolean;
     addressType?: AddressType;
+    lastUpdatedAt?: number;
 };
 /**
- * @type AddressBookState
+ * Sync metadata interface used for contacts syncing.
+ * This is used by the UserStorageController and not stored in address book.
+ */
+type SyncMetadata = {
+    deleted?: boolean;
+    deletedAt?: number;
+    lastUpdatedAt?: number;
+};
+/**
+ * Address book entry with sync metadata
+ */
+export type AddressBookEntryWithSyncMetadata = {
+    _syncMetadata?: SyncMetadata;
+} & AddressBookEntry;
+/**
+ * AddressBookState
  *
  * Address book controller state
- * @property addressBook - Array of contact entry objects
+ *
+ * addressBook - Array of contact entry objects
  */
 export type AddressBookControllerState = {
     addressBook: {
@@ -62,10 +74,45 @@ export declare const controllerName = "AddressBookController";
  * The action that can be performed to get the state of the {@link AddressBookController}.
  */
 export type AddressBookControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AddressBookControllerState>;
+/**
+ * The action that can be performed to list contacts from the {@link AddressBookController}.
+ */
+export type AddressBookControllerListAction = {
+    type: `${typeof controllerName}:list`;
+    handler: AddressBookController['list'];
+};
+/**
+ * The action that can be performed to set a contact in the {@link AddressBookController}.
+ */
+export type AddressBookControllerSetAction = {
+    type: `${typeof controllerName}:set`;
+    handler: AddressBookController['set'];
+};
+/**
+ * The action that can be performed to delete a contact from the {@link AddressBookController}.
+ */
+export type AddressBookControllerDeleteAction = {
+    type: `${typeof controllerName}:delete`;
+    handler: AddressBookController['delete'];
+};
+/**
+ * Event emitted when a contact is added or updated
+ */
+export type AddressBookControllerContactUpdatedEvent = {
+    type: `${typeof controllerName}:contactUpdated`;
+    payload: [AddressBookEntry];
+};
+/**
+ * Event emitted when a contact is deleted
+ */
+export type AddressBookControllerContactDeletedEvent = {
+    type: `${typeof controllerName}:contactDeleted`;
+    payload: [AddressBookEntry];
+};
 /**
  * The actions that can be performed using the {@link AddressBookController}.
  */
-export type AddressBookControllerActions = AddressBookControllerGetStateAction;
+export type AddressBookControllerActions = AddressBookControllerGetStateAction | AddressBookControllerListAction | AddressBookControllerSetAction | AddressBookControllerDeleteAction;
 /**
  * The event that {@link AddressBookController} can emit.
  */
@@ -73,7 +120,7 @@ export type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<t
 /**
  * The events that {@link AddressBookController} can emit.
  */
-export type AddressBookControllerEvents = AddressBookControllerStateChangeEvent;
+export type AddressBookControllerEvents = AddressBookControllerStateChangeEvent | AddressBookControllerContactUpdatedEvent | AddressBookControllerContactDeletedEvent;
 /**
  * Get the default {@link AddressBookController} state.
  *
@@ -88,6 +135,7 @@ export type AddressBookControllerMessenger = RestrictedMessenger<typeof controll
  * Controller that manages a list of recipient addresses associated with nicknames.
  */
 export declare class AddressBookController extends BaseController<typeof controllerName, AddressBookControllerState, AddressBookControllerMessenger> {
+    #private;
     /**
      * Creates an AddressBookController instance.
      *
@@ -99,6 +147,12 @@ export declare class AddressBookController extends BaseController<typeof control
         messenger: AddressBookControllerMessenger;
         state?: Partial<AddressBookControllerState>;
     });
+    /**
+     * Returns all address book entries as an array.
+     *
+     * @returns Array of all address book entries.
+     */
+    list(): AddressBookEntry[];
     /**
      * Remove all contract entries.
      */

package/dist/AddressBookController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"AddressBookController.d.mts","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAQ3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW;IAGrB,uBAAuB,8BAA8B;IAGrD,gBAAgB,sBAAsB;IAGtC,WAAW,iBAAiB;CAC7B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;CAC1E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,mCAAmC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;AAMhF;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,QAC3C,0BAIH,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,EACL,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAUD;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;IAqBpC;;;;;;;;;OASG;IACH,GAAG,CACD,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,gBAAW,EAClB,IAAI,SAAK,EACT,WAAW,CAAC,EAAE,WAAW;CAkC5B;AAED,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"AddressBookController.d.mts","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAQ3D,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;GAEG;AACH,oBAAY,WAAW;IACrB,uBAAuB,8BAA8B;IACrD,gBAAgB,sBAAsB;IACtC,WAAW,iBAAiB;CAC7B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,KAAK,YAAY,GAAG;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B,GAAG,gBAAgB,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,WAAW,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,CAAA;SAAE,CAAA;KAAE,CAAC;CAC1E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,0BAA0B,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,MAAM,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,cAAc,SAAS,CAAC;IACxC,OAAO,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,mCAAmC,GACnC,+BAA+B,GAC/B,8BAA8B,GAC9B,iCAAiC,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,cAAc,EACrB,0BAA0B,CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,qCAAqC,GACrC,wCAAwC,GACxC,wCAAwC,CAAC;AAM7C;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,QAC3C,0BAIH,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,CAC9D,OAAO,cAAc,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,EACL,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,cAAc,EACrB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;KAC7C;IAYD;;;;OAIG;IACH,IAAI,IAAI,gBAAgB,EAAE;IAe1B;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;IAmCpC;;;;;;;;;OASG;IACH,GAAG,CACD,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,gBAAW,EAClB,IAAI,SAAK,EACT,WAAW,CAAC,EAAE,WAAW;CA4D5B;AAED,eAAe,qBAAqB,CAAC"}

package/dist/AddressBookController.mjs

@@ -1,3 +1,9 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AddressBookController_instances, _AddressBookController_registerMessageHandlers;
 import { BaseController } from "@metamask/base-controller";
 import { normalizeEnsName, isValidHexAddress, isSafeDynamicKey, toChecksumHexAddress, toHex } from "@metamask/controller-utils";
 /**
@@ -5,14 +11,8 @@ import { normalizeEnsName, isValidHexAddress, isSafeDynamicKey, toChecksumHexAdd
  */
 export var AddressType;
 (function (AddressType) {
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["externallyOwnedAccounts"] = "EXTERNALLY_OWNED_ACCOUNTS";
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["contractAccounts"] = "CONTRACT_ACCOUNTS";
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/naming-convention
     AddressType["nonAccounts"] = "NON_ACCOUNTS";
 })(AddressType || (AddressType = {}));
 /**
@@ -51,6 +51,25 @@ export class AddressBookController extends BaseController {
             name: controllerName,
             state: mergedState,
         });
+        _AddressBookController_instances.add(this);
+        __classPrivateFieldGet(this, _AddressBookController_instances, "m", _AddressBookController_registerMessageHandlers).call(this);
+    }
+    /**
+     * Returns all address book entries as an array.
+     *
+     * @returns Array of all address book entries.
+     */
+    list() {
+        const { addressBook } = this.state;
+        const contacts = [];
+        Object.keys(addressBook).forEach((chainId) => {
+            const chainIdHex = chainId;
+            Object.keys(addressBook[chainIdHex]).forEach((address) => {
+                const contact = addressBook[chainIdHex][address];
+                contacts.push(contact);
+            });
+        });
+        return contacts;
     }
     /**
      * Remove all contract entries.
@@ -75,12 +94,20 @@ export class AddressBookController extends BaseController {
             !this.state.addressBook[chainId][address]) {
             return false;
         }
+        const deletedEntry = { ...this.state.addressBook[chainId][address] };
         this.update((state) => {
-            delete state.addressBook[chainId][address];
-            if (Object.keys(state.addressBook[chainId]).length === 0) {
-                delete state.addressBook[chainId];
+            if (state.addressBook[chainId] && state.addressBook[chainId][address]) {
+                delete state.addressBook[chainId][address];
+                // Clean up empty chainId objects
+                if (Object.keys(state.addressBook[chainId]).length === 0) {
+                    delete state.addressBook[chainId];
+                }
             }
         });
+        // Skip sending delete event for global contacts with chainId '*'
+        if (String(chainId) !== '*') {
+            this.messagingSystem.publish('AddressBookController:contactDeleted', deletedEntry);
+        }
         return true;
     }
     /**
@@ -105,6 +132,7 @@ export class AddressBookController extends BaseController {
             memo,
             name,
             addressType,
+            lastUpdatedAt: Date.now(),
         };
         const ensName = normalizeEnsName(name);
         if (ensName) {
@@ -120,8 +148,17 @@ export class AddressBookController extends BaseController {
                 },
             };
         });
+        // Skip sending update event for global contacts with chainId '*'
+        if (String(chainId) !== '*') {
+            this.messagingSystem.publish('AddressBookController:contactUpdated', entry);
+        }
         return true;
     }
 }
+_AddressBookController_instances = new WeakSet(), _AddressBookController_registerMessageHandlers = function _AddressBookController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler(`${controllerName}:list`, this.list.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:set`, this.set.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:delete`, this.delete.bind(this));
+};
 export default AddressBookController;
 //# sourceMappingURL=AddressBookController.mjs.map

package/dist/AddressBookController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AddressBookController.mjs","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACN,mCAAmC;AAiBpC;;GAEG;AACH,MAAM,CAAN,IAAY,WAUX;AAVD,WAAY,WAAW;IACrB,gFAAgF;IAChF,gEAAgE;IAChE,oEAAqD,CAAA;IACrD,gFAAgF;IAChF,gEAAgE;IAChE,qDAAsC,CAAA;IACtC,gFAAgF;IAChF,gEAAgE;IAChE,2CAA4B,CAAA;AAC9B,CAAC,EAVW,WAAW,KAAX,WAAW,QAUtB;AAgCD;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAuB,CAAC;AA4BtD,MAAM,6BAA6B,GAAG;IACpC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAC/C,GAA+B,EAAE;IAC/B,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC,CAAC;AAaJ;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAI1C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,MAAM,WAAW,GAAG,EAAE,GAAG,oCAAoC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QAC5E,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACxC,IACE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC,iBAAiB,CAAC,OAAO,CAAC;YAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EACzC;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxD,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;aACnC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,OAAe,EACf,IAAY,EACZ,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,EAClB,IAAI,GAAG,EAAE,EACT,WAAyB;QAEzB,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SACd;QAED,MAAM,KAAK,GAAG;YACZ,OAAO;YACP,OAAO;YACP,KAAK,EAAE,KAAK;YACZ,IAAI;YACJ,IAAI;YACJ,WAAW;SACZ,CAAC;QAEF,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;YACrB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;SACpB;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG;gBAClB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW;gBACzB,CAAC,OAAO,CAAC,EAAE;oBACT,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;oBAClC,CAAC,OAAO,CAAC,EAAE,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,eAAe,qBAAqB,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  isSafeDynamicKey,\n  toChecksumHexAddress,\n  toHex,\n} from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * @type ContactEntry\n *\n * ContactEntry representation\n * @property address - Hex address of a recipient account\n * @property name - Nickname associated with this address\n * @property importTime - Data time when an account as created/imported\n */\nexport type ContactEntry = {\n  address: string;\n  name: string;\n  importTime?: number;\n};\n\n/**\n * The type of address.\n */\nexport enum AddressType {\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  externallyOwnedAccounts = 'EXTERNALLY_OWNED_ACCOUNTS',\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  contractAccounts = 'CONTRACT_ACCOUNTS',\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  nonAccounts = 'NON_ACCOUNTS',\n}\n\n/**\n * @type AddressBookEntry\n *\n * AddressBookEntry representation\n * @property address - Hex address of a recipient account\n * @property name - Nickname associated with this address\n * @property chainId - Chain id identifies the current chain\n * @property memo - User's note about address\n * @property isEns - is the entry an ENS name\n * @property addressType - is the type of this address\n */\nexport type AddressBookEntry = {\n  address: string;\n  name: string;\n  chainId: Hex;\n  memo: string;\n  isEns: boolean;\n  addressType?: AddressType;\n};\n\n/**\n * @type AddressBookState\n *\n * Address book controller state\n * @property addressBook - Array of contact entry objects\n */\nexport type AddressBookControllerState = {\n  addressBook: { [chainId: Hex]: { [address: string]: AddressBookEntry } };\n};\n\n/**\n * The name of the {@link AddressBookController}.\n */\nexport const controllerName = 'AddressBookController';\n\n/**\n * The action that can be performed to get the state of the {@link AddressBookController}.\n */\nexport type AddressBookControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The actions that can be performed using the {@link AddressBookController}.\n */\nexport type AddressBookControllerActions = AddressBookControllerGetStateAction;\n\n/**\n * The event that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The events that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerEvents = AddressBookControllerStateChangeEvent;\n\nconst addressBookControllerMetadata = {\n  addressBook: { persist: true, anonymous: false },\n};\n\n/**\n * Get the default {@link AddressBookController} state.\n *\n * @returns The default {@link AddressBookController} state.\n */\nexport const getDefaultAddressBookControllerState =\n  (): AddressBookControllerState => {\n    return {\n      addressBook: {},\n    };\n  };\n\n/**\n * The messenger of the {@link AddressBookController} for communication.\n */\nexport type AddressBookControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AddressBookControllerActions,\n  AddressBookControllerEvents,\n  never,\n  never\n>;\n\n/**\n * Controller that manages a list of recipient addresses associated with nicknames.\n */\nexport class AddressBookController extends BaseController<\n  typeof controllerName,\n  AddressBookControllerState,\n  AddressBookControllerMessenger\n> {\n  /**\n   * Creates an AddressBookController instance.\n   *\n   * @param args - The {@link AddressBookController} arguments.\n   * @param args.messenger - The controller messenger instance for communication.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AddressBookControllerMessenger;\n    state?: Partial<AddressBookControllerState>;\n  }) {\n    const mergedState = { ...getDefaultAddressBookControllerState(), ...state };\n    super({\n      messenger,\n      metadata: addressBookControllerMetadata,\n      name: controllerName,\n      state: mergedState,\n    });\n  }\n\n  /**\n   * Remove all contract entries.\n   */\n  clear() {\n    this.update((state) => {\n      state.addressBook = {};\n    });\n  }\n\n  /**\n   * Remove a contract entry by address.\n   *\n   * @param chainId - Chain id identifies the current chain.\n   * @param address - Recipient address to delete.\n   * @returns Whether the entry was deleted.\n   */\n  delete(chainId: Hex, address: string) {\n    address = toChecksumHexAddress(address);\n    if (\n      ![chainId, address].every((key) => isSafeDynamicKey(key)) ||\n      !isValidHexAddress(address) ||\n      !this.state.addressBook[chainId] ||\n      !this.state.addressBook[chainId][address]\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      delete state.addressBook[chainId][address];\n      if (Object.keys(state.addressBook[chainId]).length === 0) {\n        delete state.addressBook[chainId];\n      }\n    });\n\n    return true;\n  }\n\n  /**\n   * Add or update a contact entry by address.\n   *\n   * @param address - Recipient address to add or update.\n   * @param name - Nickname to associate with this address.\n   * @param chainId - Chain id identifies the current chain.\n   * @param memo - User's note about address.\n   * @param addressType - Contact's address type.\n   * @returns Boolean indicating if the address was successfully set.\n   */\n  set(\n    address: string,\n    name: string,\n    chainId = toHex(1),\n    memo = '',\n    addressType?: AddressType,\n  ) {\n    address = toChecksumHexAddress(address);\n    if (!isValidHexAddress(address)) {\n      return false;\n    }\n\n    const entry = {\n      address,\n      chainId,\n      isEns: false,\n      memo,\n      name,\n      addressType,\n    };\n\n    const ensName = normalizeEnsName(name);\n    if (ensName) {\n      entry.name = ensName;\n      entry.isEns = true;\n    }\n\n    this.update((state) => {\n      state.addressBook = {\n        ...this.state.addressBook,\n        [chainId]: {\n          ...this.state.addressBook[chainId],\n          [address]: entry,\n        },\n      };\n    });\n\n    return true;\n  }\n}\n\nexport default AddressBookController;\n"]}
+{"version":3,"file":"AddressBookController.mjs","sourceRoot":"","sources":["../src/AddressBookController.ts"],"names":[],"mappings":";;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACN,mCAAmC;AAGpC;;GAEG;AACH,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,oEAAqD,CAAA;IACrD,qDAAsC,CAAA;IACtC,2CAA4B,CAAA;AAC9B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AA2DD;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAuB,CAAC;AA2EtD,MAAM,6BAA6B,GAAG;IACpC,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAC/C,GAA+B,EAAE;IAC/B,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC,CAAC;AAaJ;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAI1C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,MAAM,WAAW,GAAG,EAAE,GAAG,oCAAoC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;QAC5E,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;;QAEH,uBAAA,IAAI,wFAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACnC,MAAM,QAAQ,GAAuB,EAAE,CAAC;QAExC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3C,MAAM,UAAU,GAAG,OAAc,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvD,MAAM,OAAO,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;gBACjD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACxC,IACE,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC,iBAAiB,CAAC,OAAO,CAAC;YAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EACzC;YACA,OAAO,KAAK,CAAC;SACd;QAED,MAAM,YAAY,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAErE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE;gBACrE,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;gBAE3C,iCAAiC;gBACjC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oBACxD,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;iBACnC;aACF;QACH,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,sCAAsC,EACtC,YAAY,CACb,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,OAAe,EACf,IAAY,EACZ,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,EAClB,IAAI,GAAG,EAAE,EACT,WAAyB;QAEzB,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SACd;QAED,MAAM,KAAK,GAAG;YACZ,OAAO;YACP,OAAO;YACP,KAAK,EAAE,KAAK;YACZ,IAAI;YACJ,IAAI;YACJ,WAAW;YACX,aAAa,EAAE,IAAI,CAAC,GAAG,EAAE;SAC1B,CAAC;QACF,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,EAAE;YACX,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;YACrB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;SACpB;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG;gBAClB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW;gBACzB,CAAC,OAAO,CAAC,EAAE;oBACT,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC;oBAClC,CAAC,OAAO,CAAC,EAAE,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,sCAAsC,EACtC,KAAK,CACN,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CAmBF;;IAbG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,OAAO,EACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CACrB,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,MAAM,EACvB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CACpB,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,SAAS,EAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CACvB,CAAC;AACJ,CAAC;AAGH,eAAe,qBAAqB,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  isSafeDynamicKey,\n  toChecksumHexAddress,\n  toHex,\n} from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * The type of address.\n */\nexport enum AddressType {\n  externallyOwnedAccounts = 'EXTERNALLY_OWNED_ACCOUNTS',\n  contractAccounts = 'CONTRACT_ACCOUNTS',\n  nonAccounts = 'NON_ACCOUNTS',\n}\n\n/**\n * AddressBookEntry\n *\n * AddressBookEntry representation\n *\n * address - Hex address of a recipient account\n *\n * name - Nickname associated with this address\n *\n * chainId - Chain id identifies the current chain\n *\n * memo - User's note about address\n *\n * isEns - is the entry an ENS name\n *\n * addressType - is the type of this address\n *\n * lastUpdatedAt - timestamp of when this entry was last updated\n */\nexport type AddressBookEntry = {\n  address: string;\n  name: string;\n  chainId: Hex;\n  memo: string;\n  isEns: boolean;\n  addressType?: AddressType;\n  lastUpdatedAt?: number;\n};\n\n/**\n * Sync metadata interface used for contacts syncing.\n * This is used by the UserStorageController and not stored in address book.\n */\ntype SyncMetadata = {\n  deleted?: boolean;\n  deletedAt?: number;\n  lastUpdatedAt?: number;\n};\n\n/**\n * Address book entry with sync metadata\n */\nexport type AddressBookEntryWithSyncMetadata = {\n  _syncMetadata?: SyncMetadata;\n} & AddressBookEntry;\n\n/**\n * AddressBookState\n *\n * Address book controller state\n *\n * addressBook - Array of contact entry objects\n */\nexport type AddressBookControllerState = {\n  addressBook: { [chainId: Hex]: { [address: string]: AddressBookEntry } };\n};\n\n/**\n * The name of the {@link AddressBookController}.\n */\nexport const controllerName = 'AddressBookController';\n\n/**\n * The action that can be performed to get the state of the {@link AddressBookController}.\n */\nexport type AddressBookControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The action that can be performed to list contacts from the {@link AddressBookController}.\n */\nexport type AddressBookControllerListAction = {\n  type: `${typeof controllerName}:list`;\n  handler: AddressBookController['list'];\n};\n\n/**\n * The action that can be performed to set a contact in the {@link AddressBookController}.\n */\nexport type AddressBookControllerSetAction = {\n  type: `${typeof controllerName}:set`;\n  handler: AddressBookController['set'];\n};\n\n/**\n * The action that can be performed to delete a contact from the {@link AddressBookController}.\n */\nexport type AddressBookControllerDeleteAction = {\n  type: `${typeof controllerName}:delete`;\n  handler: AddressBookController['delete'];\n};\n\n/**\n * Event emitted when a contact is added or updated\n */\nexport type AddressBookControllerContactUpdatedEvent = {\n  type: `${typeof controllerName}:contactUpdated`;\n  payload: [AddressBookEntry];\n};\n\n/**\n * Event emitted when a contact is deleted\n */\nexport type AddressBookControllerContactDeletedEvent = {\n  type: `${typeof controllerName}:contactDeleted`;\n  payload: [AddressBookEntry];\n};\n\n/**\n * The actions that can be performed using the {@link AddressBookController}.\n */\nexport type AddressBookControllerActions =\n  | AddressBookControllerGetStateAction\n  | AddressBookControllerListAction\n  | AddressBookControllerSetAction\n  | AddressBookControllerDeleteAction;\n\n/**\n * The event that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AddressBookControllerState\n>;\n\n/**\n * The events that {@link AddressBookController} can emit.\n */\nexport type AddressBookControllerEvents =\n  | AddressBookControllerStateChangeEvent\n  | AddressBookControllerContactUpdatedEvent\n  | AddressBookControllerContactDeletedEvent;\n\nconst addressBookControllerMetadata = {\n  addressBook: { persist: true, anonymous: false },\n};\n\n/**\n * Get the default {@link AddressBookController} state.\n *\n * @returns The default {@link AddressBookController} state.\n */\nexport const getDefaultAddressBookControllerState =\n  (): AddressBookControllerState => {\n    return {\n      addressBook: {},\n    };\n  };\n\n/**\n * The messenger of the {@link AddressBookController} for communication.\n */\nexport type AddressBookControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  AddressBookControllerActions,\n  AddressBookControllerEvents,\n  never,\n  never\n>;\n\n/**\n * Controller that manages a list of recipient addresses associated with nicknames.\n */\nexport class AddressBookController extends BaseController<\n  typeof controllerName,\n  AddressBookControllerState,\n  AddressBookControllerMessenger\n> {\n  /**\n   * Creates an AddressBookController instance.\n   *\n   * @param args - The {@link AddressBookController} arguments.\n   * @param args.messenger - The controller messenger instance for communication.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: AddressBookControllerMessenger;\n    state?: Partial<AddressBookControllerState>;\n  }) {\n    const mergedState = { ...getDefaultAddressBookControllerState(), ...state };\n    super({\n      messenger,\n      metadata: addressBookControllerMetadata,\n      name: controllerName,\n      state: mergedState,\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Returns all address book entries as an array.\n   *\n   * @returns Array of all address book entries.\n   */\n  list(): AddressBookEntry[] {\n    const { addressBook } = this.state;\n    const contacts: AddressBookEntry[] = [];\n\n    Object.keys(addressBook).forEach((chainId) => {\n      const chainIdHex = chainId as Hex;\n      Object.keys(addressBook[chainIdHex]).forEach((address) => {\n        const contact = addressBook[chainIdHex][address];\n        contacts.push(contact);\n      });\n    });\n\n    return contacts;\n  }\n\n  /**\n   * Remove all contract entries.\n   */\n  clear() {\n    this.update((state) => {\n      state.addressBook = {};\n    });\n  }\n\n  /**\n   * Remove a contract entry by address.\n   *\n   * @param chainId - Chain id identifies the current chain.\n   * @param address - Recipient address to delete.\n   * @returns Whether the entry was deleted.\n   */\n  delete(chainId: Hex, address: string) {\n    address = toChecksumHexAddress(address);\n    if (\n      ![chainId, address].every((key) => isSafeDynamicKey(key)) ||\n      !isValidHexAddress(address) ||\n      !this.state.addressBook[chainId] ||\n      !this.state.addressBook[chainId][address]\n    ) {\n      return false;\n    }\n\n    const deletedEntry = { ...this.state.addressBook[chainId][address] };\n\n    this.update((state) => {\n      if (state.addressBook[chainId] && state.addressBook[chainId][address]) {\n        delete state.addressBook[chainId][address];\n\n        // Clean up empty chainId objects\n        if (Object.keys(state.addressBook[chainId]).length === 0) {\n          delete state.addressBook[chainId];\n        }\n      }\n    });\n\n    // Skip sending delete event for global contacts with chainId '*'\n    if (String(chainId) !== '*') {\n      this.messagingSystem.publish(\n        'AddressBookController:contactDeleted',\n        deletedEntry,\n      );\n    }\n\n    return true;\n  }\n\n  /**\n   * Add or update a contact entry by address.\n   *\n   * @param address - Recipient address to add or update.\n   * @param name - Nickname to associate with this address.\n   * @param chainId - Chain id identifies the current chain.\n   * @param memo - User's note about address.\n   * @param addressType - Contact's address type.\n   * @returns Boolean indicating if the address was successfully set.\n   */\n  set(\n    address: string,\n    name: string,\n    chainId = toHex(1),\n    memo = '',\n    addressType?: AddressType,\n  ) {\n    address = toChecksumHexAddress(address);\n    if (!isValidHexAddress(address)) {\n      return false;\n    }\n\n    const entry = {\n      address,\n      chainId,\n      isEns: false,\n      memo,\n      name,\n      addressType,\n      lastUpdatedAt: Date.now(),\n    };\n    const ensName = normalizeEnsName(name);\n    if (ensName) {\n      entry.name = ensName;\n      entry.isEns = true;\n    }\n\n    this.update((state) => {\n      state.addressBook = {\n        ...this.state.addressBook,\n        [chainId]: {\n          ...this.state.addressBook[chainId],\n          [address]: entry,\n        },\n      };\n    });\n\n    // Skip sending update event for global contacts with chainId '*'\n    if (String(chainId) !== '*') {\n      this.messagingSystem.publish(\n        'AddressBookController:contactUpdated',\n        entry,\n      );\n    }\n\n    return true;\n  }\n\n  /**\n   * Registers message handlers for the AddressBookController.\n   */\n  #registerMessageHandlers() {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:list`,\n      this.list.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:set`,\n      this.set.bind(this),\n    );\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:delete`,\n      this.delete.bind(this),\n    );\n  }\n}\n\nexport default AddressBookController;\n"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAWA,qEAGiC;AAF/B,6IAAA,oCAAoC,OAAA;AACpC,8HAAA,qBAAqB,OAAA","sourcesContent":["export type {\n  AddressType,\n  AddressBookEntry,\n  AddressBookControllerState,\n  AddressBookControllerGetStateAction,\n  AddressBookControllerActions,\n  AddressBookControllerStateChangeEvent,\n  AddressBookControllerEvents,\n  AddressBookControllerMessenger,\n  ContactEntry,\n} from './AddressBookController';\nexport {\n  getDefaultAddressBookControllerState,\n  AddressBookController,\n} from './AddressBookController';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAgBA,qEAGiC;AAF/B,6IAAA,oCAAoC,OAAA;AACpC,8HAAA,qBAAqB,OAAA","sourcesContent":["export type {\n  AddressType,\n  AddressBookEntry,\n  AddressBookControllerState,\n  AddressBookControllerGetStateAction,\n  AddressBookControllerListAction,\n  AddressBookControllerSetAction,\n  AddressBookControllerDeleteAction,\n  AddressBookControllerActions,\n  AddressBookControllerStateChangeEvent,\n  AddressBookControllerContactUpdatedEvent,\n  AddressBookControllerContactDeletedEvent,\n  AddressBookControllerEvents,\n  AddressBookControllerMessenger,\n  AddressBookEntryWithSyncMetadata,\n} from './AddressBookController';\nexport {\n  getDefaultAddressBookControllerState,\n  AddressBookController,\n} from './AddressBookController';\n"]}

package/dist/index.d.cts

@@ -1,3 +1,3 @@
-export type { AddressType, AddressBookEntry, AddressBookControllerState, AddressBookControllerGetStateAction, AddressBookControllerActions, AddressBookControllerStateChangeEvent, AddressBookControllerEvents, AddressBookControllerMessenger, ContactEntry, } from "./AddressBookController.cjs";
+export type { AddressType, AddressBookEntry, AddressBookControllerState, AddressBookControllerGetStateAction, AddressBookControllerListAction, AddressBookControllerSetAction, AddressBookControllerDeleteAction, AddressBookControllerActions, AddressBookControllerStateChangeEvent, AddressBookControllerContactUpdatedEvent, AddressBookControllerContactDeletedEvent, AddressBookControllerEvents, AddressBookControllerMessenger, AddressBookEntryWithSyncMetadata, } from "./AddressBookController.cjs";
 export { getDefaultAddressBookControllerState, AddressBookController, } from "./AddressBookController.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2BAA2B,EAC3B,8BAA8B,EAC9B,YAAY,GACb,oCAAgC;AACjC,OAAO,EACL,oCAAoC,EACpC,qBAAqB,GACtB,oCAAgC"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,0BAA0B,EAC1B,mCAAmC,EACnC,+BAA+B,EAC/B,8BAA8B,EAC9B,iCAAiC,EACjC,4BAA4B,EAC5B,qCAAqC,EACrC,wCAAwC,EACxC,wCAAwC,EACxC,2BAA2B,EAC3B,8BAA8B,EAC9B,gCAAgC,GACjC,oCAAgC;AACjC,OAAO,EACL,oCAAoC,EACpC,qBAAqB,GACtB,oCAAgC"}

package/dist/index.d.mts

@@ -1,3 +1,3 @@
-export type { AddressType, AddressBookEntry, AddressBookControllerState, AddressBookControllerGetStateAction, AddressBookControllerActions, AddressBookControllerStateChangeEvent, AddressBookControllerEvents, AddressBookControllerMessenger, ContactEntry, } from "./AddressBookController.mjs";
+export type { AddressType, AddressBookEntry, AddressBookControllerState, AddressBookControllerGetStateAction, AddressBookControllerListAction, AddressBookControllerSetAction, AddressBookControllerDeleteAction, AddressBookControllerActions, AddressBookControllerStateChangeEvent, AddressBookControllerContactUpdatedEvent, AddressBookControllerContactDeletedEvent, AddressBookControllerEvents, AddressBookControllerMessenger, AddressBookEntryWithSyncMetadata, } from "./AddressBookController.mjs";
 export { getDefaultAddressBookControllerState, AddressBookController, } from "./AddressBookController.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,0BAA0B,EAC1B,mCAAmC,EACnC,4BAA4B,EAC5B,qCAAqC,EACrC,2BAA2B,EAC3B,8BAA8B,EAC9B,YAAY,GACb,oCAAgC;AACjC,OAAO,EACL,oCAAoC,EACpC,qBAAqB,GACtB,oCAAgC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,0BAA0B,EAC1B,mCAAmC,EACnC,+BAA+B,EAC/B,8BAA8B,EAC9B,iCAAiC,EACjC,4BAA4B,EAC5B,qCAAqC,EACrC,wCAAwC,EACxC,wCAAwC,EACxC,2BAA2B,EAC3B,8BAA8B,EAC9B,gCAAgC,GACjC,oCAAgC;AACjC,OAAO,EACL,oCAAoC,EACpC,qBAAqB,GACtB,oCAAgC"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,OAAO,EACL,oCAAoC,EACpC,qBAAqB,EACtB,oCAAgC","sourcesContent":["export type {\n  AddressType,\n  AddressBookEntry,\n  AddressBookControllerState,\n  AddressBookControllerGetStateAction,\n  AddressBookControllerActions,\n  AddressBookControllerStateChangeEvent,\n  AddressBookControllerEvents,\n  AddressBookControllerMessenger,\n  ContactEntry,\n} from './AddressBookController';\nexport {\n  getDefaultAddressBookControllerState,\n  AddressBookController,\n} from './AddressBookController';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,oCAAoC,EACpC,qBAAqB,EACtB,oCAAgC","sourcesContent":["export type {\n  AddressType,\n  AddressBookEntry,\n  AddressBookControllerState,\n  AddressBookControllerGetStateAction,\n  AddressBookControllerListAction,\n  AddressBookControllerSetAction,\n  AddressBookControllerDeleteAction,\n  AddressBookControllerActions,\n  AddressBookControllerStateChangeEvent,\n  AddressBookControllerContactUpdatedEvent,\n  AddressBookControllerContactDeletedEvent,\n  AddressBookControllerEvents,\n  AddressBookControllerMessenger,\n  AddressBookEntryWithSyncMetadata,\n} from './AddressBookController';\nexport {\n  getDefaultAddressBookControllerState,\n  AddressBookController,\n} from './AddressBookController';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/address-book-controller",
-  "version": "6.0.3-preview-7bb49dcb",
+  "version": "6.0.3-preview-c47fa49d",
   "description": "Manages a list of recipient addresses associated with nicknames",
   "keywords": [
     "MetaMask",