@metamask/ens-controller 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.0.0]
+### Changed
+- **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
+- **BREAKING:** Add `@metamask/network-controller` as a dependency and peer dependency ([#1367](https://github.com/MetaMask/core/pull/1367), [#1362](https://github.com/MetaMask/core/pull/1362))
+- **BREAKING:** The `ensEntries` state property is now keyed by `Hex` chain ID rather than `string`, and the `chainId` property of each ENS entry is also `Hex` rather than `string`. ([#1367](https://github.com/MetaMask/core/pull/1367))
+  - This requires a state migration
+- **BREAKING:** The methods `get`, `set`, and `delete` have been updated to accept and return chain IDs as 0x-prefixed hex strings, rather than decimal strings. ([#1367](https://github.com/MetaMask/core/pull/1367))
+- Bump @metamask/utils from 5.0.1 to 5.0.2 ([#1271](https://github.com/MetaMask/core/pull/1271))
+
+### Fixed
+- Fix ENS controller failure to initialize after switching networks ([#1362](https://github.com/MetaMask/core/pull/1362))
+
+## [3.1.0]
+### Changed
+- Add support for reverse ENS address resolution ([#1170](https://github.com/MetaMask/core/pull/1170))
+  - This controller can now resolve a network address to an ENS address. This feature was ported from the extension ENS controller.
+
 ## [3.0.0]
 ### Changed
 - **BREAKING:** Convert the ENS controller to the BaseController v2 API ([#1134](https://github.com/MetaMask/core/pull/1134))
@@ -18,7 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.2]
 ### Changed
 - Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
-- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041)) 
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
 
 ## [1.0.1]
 ### Changed
@@ -33,7 +50,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@3.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@4.0.0...HEAD
+[4.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@3.1.0...@metamask/ens-controller@4.0.0
+[3.1.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@3.0.0...@metamask/ens-controller@3.1.0
 [3.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@2.0.0...@metamask/ens-controller@3.0.0
 [2.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@1.0.2...@metamask/ens-controller@2.0.0
 [1.0.2]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@1.0.1...@metamask/ens-controller@1.0.2

package/dist/EnsController.d.ts

@@ -1,4 +1,7 @@
 import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
+import { ExternalProvider, JsonRpcFetchFunc } from '@ethersproject/providers';
+import { Hex } from '@metamask/utils';
+import type { NetworkState } from '@metamask/network-controller';
 declare const name = "EnsController";
 /**
  * @type EnsEntry
@@ -9,7 +12,7 @@ declare const name = "EnsController";
  * @property address - Hex address with the ENS name, or null
  */
 export declare type EnsEntry = {
-    chainId: string;
+    chainId: Hex;
     ensName: string;
     address: string | null;
 };
@@ -21,10 +24,13 @@ export declare type EnsEntry = {
  */
 export declare type EnsControllerState = {
     ensEntries: {
-        [chainId: string]: {
+        [chainId: Hex]: {
             [ensName: string]: EnsEntry;
         };
     };
+    ensResolutionsByAddress: {
+        [key: string]: string;
+    };
 };
 export declare type EnsControllerMessenger = RestrictedControllerMessenger<typeof name, never, never, never, never>;
 /**
@@ -32,17 +38,27 @@ export declare type EnsControllerMessenger = RestrictedControllerMessenger<typeo
  * by chainId. A null address indicates an unresolved ENS name.
  */
 export declare class EnsController extends BaseControllerV2<typeof name, EnsControllerState, EnsControllerMessenger> {
+    #private;
     /**
      * Creates an EnsController instance.
      *
      * @param options - Constructor options.
      * @param options.messenger - A reference to the messaging system.
      * @param options.state - Initial state to set on this controller.
+     * @param options.provider - Provider instance.
+     * @param options.onNetworkStateChange - Allows registering an event handler for
+     * when the network controller state updated.
      */
-    constructor({ messenger, state, }: {
+    constructor({ messenger, state, provider, onNetworkStateChange, }: {
         messenger: EnsControllerMessenger;
         state?: Partial<EnsControllerState>;
+        provider?: ExternalProvider | JsonRpcFetchFunc;
+        onNetworkStateChange?: (listener: (networkState: Pick<NetworkState, 'networkId' | 'providerConfig'>) => void) => void;
     });
+    /**
+     * Clears ensResolutionsByAddress state property.
+     */
+    resetState(): void;
     /**
      * Remove all chain Ids and ENS entries from state.
      */
@@ -54,7 +70,7 @@ export declare class EnsController extends BaseControllerV2<typeof name, EnsCont
      * @param ensName - Name of the ENS entry to delete.
      * @returns Boolean indicating if the entry was deleted.
      */
-    delete(chainId: string, ensName: string): boolean;
+    delete(chainId: Hex, ensName: string): boolean;
     /**
      * Retrieve a DNS entry.
      *
@@ -62,7 +78,7 @@ export declare class EnsController extends BaseControllerV2<typeof name, EnsCont
      * @param ensName - Name of the ENS entry to retrieve.
      * @returns The EnsEntry or null if it does not exist.
      */
-    get(chainId: string, ensName: string): EnsEntry | null;
+    get(chainId: Hex, ensName: string): EnsEntry | null;
     /**
      * Add or update an ENS entry by chainId and ensName.
      *
@@ -73,6 +89,14 @@ export declare class EnsController extends BaseControllerV2<typeof name, EnsCont
      * @param address - Associated address (or null) to add or update.
      * @returns Boolean indicating if the entry was set.
      */
-    set(chainId: string, ensName: string, address: string | null): boolean;
+    set(chainId: Hex, ensName: string, address: string | null): boolean;
+    /**
+     * Resolve ens by address.
+     *
+     * @param nonChecksummedAddress - address
+     * @returns ens resolution
+     */
+    reverseResolveAddress(nonChecksummedAddress: string): Promise<string | undefined>;
 }
 export default EnsController;
+//# sourceMappingURL=EnsController.d.ts.map

package/dist/EnsController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnsController.d.ts","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,GAAG,EAAoC,MAAM,iBAAiB,CAAC;AAQxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAqBjE,QAAA,MAAM,IAAI,kBAAkB,CAAC;AAE7B;;;;;;;GAOG;AACH,oBAAY,QAAQ,GAAG;IACrB,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG;IAC/B,UAAU,EAAE;QACV,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC;SAC7B,CAAC;KACH,CAAC;IACF,uBAAuB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACpD,CAAC;AAEF,oBAAY,sBAAsB,GAAG,6BAA6B,CAChE,OAAO,IAAI,EACX,KAAK,EACL,KAAK,EACL,KAAK,EACL,KAAK,CACN,CAAC;AAeF;;;GAGG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CACjD,OAAO,IAAI,EACX,kBAAkB,EAClB,sBAAsB,CACvB;;IAGC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,EAAE;QACD,SAAS,EAAE,sBAAsB,CAAC;QAClC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;QAC/C,oBAAoB,CAAC,EAAE,CACrB,QAAQ,EAAE,CACR,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,GAAG,gBAAgB,CAAC,KAC7D,IAAI,KACN,IAAI,CAAC;KACX;IA+BD;;OAEG;IACH,UAAU;IAMV;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAoB9C;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAUnD;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAqDnE;;;;;OAKG;IACG,qBAAqB,CAAC,qBAAqB,EAAE,MAAM;CAkD1D;AAED,eAAe,aAAa,CAAC"}

package/dist/EnsController.js

@@ -1,15 +1,58 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _EnsController_instances, _EnsController_ethProvider, _EnsController_getNetworkEnsSupport;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnsController = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+const providers_1 = require("@ethersproject/providers");
+const utils_1 = require("@metamask/utils");
 const controller_utils_1 = require("@metamask/controller-utils");
+const punycode_1 = require("punycode/");
+const ethereum_ens_network_map_1 = __importDefault(require("ethereum-ens-network-map"));
+const log = (0, utils_1.createProjectLogger)('ens-controller');
+/**
+ * Checks whether the given string is a known network ID.
+ *
+ * @param networkId - Network id.
+ * @returns Boolean indicating if the network ID is recognized.
+ */
+function isKnownNetworkId(networkId) {
+    return (networkId !== null &&
+        (0, utils_1.hasProperty)(controller_utils_1.NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId));
+}
 const name = 'EnsController';
 const metadata = {
     ensEntries: { persist: true, anonymous: false },
+    ensResolutionsByAddress: { persist: true, anonymous: false },
 };
 const defaultState = {
     ensEntries: {},
+    ensResolutionsByAddress: {},
 };
+const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';
+const ZERO_X_ERROR_ADDRESS = '0x';
 /**
  * Controller that manages a list ENS names and their resolved addresses
  * by chainId. A null address indicates an unresolved ENS name.
@@ -21,14 +64,44 @@ class EnsController extends base_controller_1.BaseControllerV2 {
      * @param options - Constructor options.
      * @param options.messenger - A reference to the messaging system.
      * @param options.state - Initial state to set on this controller.
+     * @param options.provider - Provider instance.
+     * @param options.onNetworkStateChange - Allows registering an event handler for
+     * when the network controller state updated.
      */
-    constructor({ messenger, state, }) {
+    constructor({ messenger, state = {}, provider, onNetworkStateChange, }) {
         super({
             name,
             metadata,
             messenger,
             state: Object.assign(Object.assign({}, defaultState), state),
         });
+        _EnsController_instances.add(this);
+        _EnsController_ethProvider.set(this, null);
+        if (provider && onNetworkStateChange) {
+            onNetworkStateChange((networkState) => {
+                this.resetState();
+                const currentNetwork = networkState.networkId;
+                if (isKnownNetworkId(currentNetwork) &&
+                    __classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_getNetworkEnsSupport).call(this, currentNetwork)) {
+                    __classPrivateFieldSet(this, _EnsController_ethProvider, new providers_1.Web3Provider(provider, {
+                        chainId: (0, controller_utils_1.convertHexToDecimal)(networkState.providerConfig.chainId),
+                        name: controller_utils_1.NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],
+                        ensAddress: ethereum_ens_network_map_1.default[currentNetwork],
+                    }), "f");
+                }
+                else {
+                    __classPrivateFieldSet(this, _EnsController_ethProvider, null, "f");
+                }
+            });
+        }
+    }
+    /**
+     * Clears ensResolutionsByAddress state property.
+     */
+    resetState() {
+        this.update((currentState) => {
+            currentState.ensResolutionsByAddress = {};
+        });
     }
     /**
      * Remove all chain Ids and ENS entries from state.
@@ -111,7 +184,60 @@ class EnsController extends base_controller_1.BaseControllerV2 {
         });
         return true;
     }
+    /**
+     * Resolve ens by address.
+     *
+     * @param nonChecksummedAddress - address
+     * @returns ens resolution
+     */
+    reverseResolveAddress(nonChecksummedAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!__classPrivateFieldGet(this, _EnsController_ethProvider, "f")) {
+                return undefined;
+            }
+            const address = (0, controller_utils_1.toChecksumHexAddress)(nonChecksummedAddress);
+            if (this.state.ensResolutionsByAddress[address]) {
+                return this.state.ensResolutionsByAddress[address];
+            }
+            let domain;
+            try {
+                domain = yield __classPrivateFieldGet(this, _EnsController_ethProvider, "f").lookupAddress(address);
+            }
+            catch (error) {
+                log(error);
+                return undefined;
+            }
+            if (!domain) {
+                return undefined;
+            }
+            let registeredAddress;
+            try {
+                registeredAddress = yield __classPrivateFieldGet(this, _EnsController_ethProvider, "f").resolveName(domain);
+            }
+            catch (error) {
+                log(error);
+                return undefined;
+            }
+            if (!registeredAddress) {
+                return undefined;
+            }
+            if (registeredAddress === ZERO_ADDRESS ||
+                registeredAddress === ZERO_X_ERROR_ADDRESS) {
+                return undefined;
+            }
+            if ((0, controller_utils_1.toChecksumHexAddress)(registeredAddress) !== address) {
+                return undefined;
+            }
+            this.update((state) => {
+                state.ensResolutionsByAddress[address] = (0, punycode_1.toASCII)(domain);
+            });
+            return domain;
+        });
+    }
 }
 exports.EnsController = EnsController;
+_EnsController_ethProvider = new WeakMap(), _EnsController_instances = new WeakSet(), _EnsController_getNetworkEnsSupport = function _EnsController_getNetworkEnsSupport(networkId) {
+    return Boolean(ethereum_ens_network_map_1.default[networkId]);
+};
 exports.default = EnsController;
 //# sourceMappingURL=EnsController.js.map

package/dist/EnsController.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnsController.js","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;AAAA,+DAGmC;AACnC,iEAIoC;AAEpC,MAAM,IAAI,GAAG,eAAe,CAAC;AAsC7B,MAAM,QAAQ,GAAG;IACf,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CAChD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,EAAE;CACf,CAAC;AAEF;;;GAGG;AACH,MAAa,aAAc,SAAQ,kCAIlC;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCACA,YAAY,GACZ,KAAK,CACT;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAe,EAAE,OAAe;QACrC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IACE,CAAC,iBAAiB;YAClB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC/B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,EAClD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC;YAEpD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvD,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,OAAe,EAAE,OAAe;QAClC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QAEpD,sEAAsE;QACtE,gDAAgD;QAChD,OAAO,CAAC,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,IAAI,IAAI;YAC3D,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAe,EAAE,OAAe,EAAE,OAAsB;QAC1D,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/C,CAAC,OAAO;YACR,OAAO,OAAO,KAAK,QAAQ;YAC3B,CAAC,OAAO,IAAI,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,CAAC,EACxC;YACA,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,aAAa,OAAO,aAAa,OAAO,GAAG,CACnF,CAAC;SACH;QAED,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SACjD;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IACE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,iBAAiB,CAAC;YAC7B,QAAQ,CAAC,iBAAiB,CAAC,CAAC,OAAO,KAAK,iBAAiB,EACzD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,mCACX,IAAI,CAAC,KAAK,CAAC,UAAU,KACxB,CAAC,OAAO,CAAC,kCACJ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KACjC,CAAC,iBAAiB,CAAC,EAAE;wBACnB,OAAO,EAAE,iBAAiB;wBAC1B,OAAO;wBACP,OAAO,EAAE,iBAAiB;qBAC3B,MAEJ,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAvID,sCAuIC;AAED,kBAAe,aAAa,CAAC","sourcesContent":["import {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  toChecksumHexAddress,\n} from '@metamask/controller-utils';\n\nconst name = 'EnsController';\n\n/**\n * @type EnsEntry\n *\n * ENS entry representation\n * @property chainId - Id of the associated chain\n * @property ensName - The ENS name\n * @property address - Hex address with the ENS name, or null\n */\nexport type EnsEntry = {\n  chainId: string;\n  ensName: string;\n  address: string | null;\n};\n\n/**\n * @type EnsControllerState\n *\n * ENS controller state\n * @property ensEntries - Object of ENS entry objects\n */\nexport type EnsControllerState = {\n  ensEntries: {\n    [chainId: string]: {\n      [ensName: string]: EnsEntry;\n    };\n  };\n};\n\nexport type EnsControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  never,\n  never,\n  never,\n  never\n>;\n\nconst metadata = {\n  ensEntries: { persist: true, anonymous: false },\n};\n\nconst defaultState = {\n  ensEntries: {},\n};\n\n/**\n * Controller that manages a list ENS names and their resolved addresses\n * by chainId. A null address indicates an unresolved ENS name.\n */\nexport class EnsController extends BaseControllerV2<\n  typeof name,\n  EnsControllerState,\n  EnsControllerMessenger\n> {\n  /**\n   * Creates an EnsController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: EnsControllerMessenger;\n    state?: Partial<EnsControllerState>;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: {\n        ...defaultState,\n        ...state,\n      },\n    });\n  }\n\n  /**\n   * Remove all chain Ids and ENS entries from state.\n   */\n  clear() {\n    this.update((state) => {\n      state.ensEntries = {};\n    });\n  }\n\n  /**\n   * Delete an ENS entry.\n   *\n   * @param chainId - Parent chain of the ENS entry to delete.\n   * @param ensName - Name of the ENS entry to delete.\n   * @returns Boolean indicating if the entry was deleted.\n   */\n  delete(chainId: string, ensName: string): boolean {\n    const normalizedEnsName = normalizeEnsName(ensName);\n    if (\n      !normalizedEnsName ||\n      !this.state.ensEntries[chainId] ||\n      !this.state.ensEntries[chainId][normalizedEnsName]\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      delete state.ensEntries[chainId][normalizedEnsName];\n\n      if (Object.keys(state.ensEntries[chainId]).length === 0) {\n        delete state.ensEntries[chainId];\n      }\n    });\n    return true;\n  }\n\n  /**\n   * Retrieve a DNS entry.\n   *\n   * @param chainId - Parent chain of the ENS entry to retrieve.\n   * @param ensName - Name of the ENS entry to retrieve.\n   * @returns The EnsEntry or null if it does not exist.\n   */\n  get(chainId: string, ensName: string): EnsEntry | null {\n    const normalizedEnsName = normalizeEnsName(ensName);\n\n    // TODO Explicitly handle the case where `normalizedEnsName` is `null`\n    // eslint-disable-next-line no-implicit-coercion\n    return !!normalizedEnsName && this.state.ensEntries[chainId]\n      ? this.state.ensEntries[chainId][normalizedEnsName] || null\n      : null;\n  }\n\n  /**\n   * Add or update an ENS entry by chainId and ensName.\n   *\n   * A null address indicates that the ENS name does not resolve.\n   *\n   * @param chainId - Id of the associated chain.\n   * @param ensName - The ENS name.\n   * @param address - Associated address (or null) to add or update.\n   * @returns Boolean indicating if the entry was set.\n   */\n  set(chainId: string, ensName: string, address: string | null): boolean {\n    if (\n      !Number.isInteger(Number.parseInt(chainId, 10)) ||\n      !ensName ||\n      typeof ensName !== 'string' ||\n      (address && !isValidHexAddress(address))\n    ) {\n      throw new Error(\n        `Invalid ENS entry: { chainId:${chainId}, ensName:${ensName}, address:${address}}`,\n      );\n    }\n\n    const normalizedEnsName = normalizeEnsName(ensName);\n    if (!normalizedEnsName) {\n      throw new Error(`Invalid ENS name: ${ensName}`);\n    }\n\n    const normalizedAddress = address ? toChecksumHexAddress(address) : null;\n    const subState = this.state.ensEntries[chainId];\n\n    if (\n      subState?.[normalizedEnsName] &&\n      subState[normalizedEnsName].address === normalizedAddress\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      state.ensEntries = {\n        ...this.state.ensEntries,\n        [chainId]: {\n          ...this.state.ensEntries[chainId],\n          [normalizedEnsName]: {\n            address: normalizedAddress,\n            chainId,\n            ensName: normalizedEnsName,\n          },\n        },\n      };\n    });\n    return true;\n  }\n}\n\nexport default EnsController;\n"]}
+{"version":3,"file":"EnsController.js","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAGmC;AACnC,wDAIkC;AAClC,2CAAwE;AACxE,iEAMoC;AAEpC,wCAAoC;AACpC,wFAAqD;AAErD,MAAM,GAAG,GAAG,IAAA,2BAAmB,EAAC,gBAAgB,CAAC,CAAC;AAElD;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,SAAwB;IAExB,OAAO,CACL,SAAS,KAAK,IAAI;QAClB,IAAA,mBAAW,EAAC,wDAAqC,EAAE,SAAS,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,MAAM,IAAI,GAAG,eAAe,CAAC;AAuC7B,MAAM,QAAQ,GAAG;IACf,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC/C,uBAAuB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CAC7D,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,EAAE;IACd,uBAAuB,EAAE,EAAE;CAC5B,CAAC;AAEF,MAAM,YAAY,GAAG,4CAA4C,CAAC;AAClE,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC;;;GAGG;AACH,MAAa,aAAc,SAAQ,kCAIlC;IAGC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,QAAQ,EACR,oBAAoB,GAUrB;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCACA,YAAY,GACZ,KAAK,CACT;SACF,CAAC,CAAC;;QAnCL,qCAAoC,IAAI,EAAC;QAqCvC,IAAI,QAAQ,IAAI,oBAAoB,EAAE;YACpC,oBAAoB,CAAC,CAAC,YAAY,EAAE,EAAE;gBACpC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC;gBAC9C,IACE,gBAAgB,CAAC,cAAc,CAAC;oBAChC,uBAAA,IAAI,qEAAsB,MAA1B,IAAI,EAAuB,cAAc,CAAC,EAC1C;oBACA,uBAAA,IAAI,8BAAgB,IAAI,wBAAY,CAAC,QAAQ,EAAE;wBAC7C,OAAO,EAAE,IAAA,sCAAmB,EAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC;wBACjE,IAAI,EAAE,wDAAqC,CAAC,cAAc,CAAC;wBAC3D,UAAU,EAAE,kCAAa,CAAC,cAAc,CAAC;qBAC1C,CAAC,MAAA,CAAC;iBACJ;qBAAM;oBACL,uBAAA,IAAI,8BAAgB,IAAI,MAAA,CAAC;iBAC1B;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3B,YAAY,CAAC,uBAAuB,GAAG,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IACE,CAAC,iBAAiB;YAClB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC/B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,EAClD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC;YAEpD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvD,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,OAAY,EAAE,OAAe;QAC/B,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QAEpD,sEAAsE;QACtE,gDAAgD;QAChD,OAAO,CAAC,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,IAAI,IAAI;YAC3D,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAY,EAAE,OAAe,EAAE,OAAsB;QACvD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/C,CAAC,OAAO;YACR,OAAO,OAAO,KAAK,QAAQ;YAC3B,CAAC,OAAO,IAAI,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,CAAC,EACxC;YACA,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,aAAa,OAAO,aAAa,OAAO,GAAG,CACnF,CAAC;SACH;QAED,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SACjD;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IACE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,iBAAiB,CAAC;YAC7B,QAAQ,CAAC,iBAAiB,CAAC,CAAC,OAAO,KAAK,iBAAiB,EACzD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,mCACX,IAAI,CAAC,KAAK,CAAC,UAAU,KACxB,CAAC,OAAO,CAAC,kCACJ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KACjC,CAAC,iBAAiB,CAAC,EAAE;wBACnB,OAAO,EAAE,iBAAiB;wBAC1B,OAAO;wBACP,OAAO,EAAE,iBAAiB;qBAC3B,MAEJ,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAYD;;;;;OAKG;IACG,qBAAqB,CAAC,qBAA6B;;YACvD,IAAI,CAAC,uBAAA,IAAI,kCAAa,EAAE;gBACtB,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,OAAO,GAAG,IAAA,uCAAoB,EAAC,qBAAqB,CAAC,CAAC;YAC5D,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE;gBAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;aACpD;YAED,IAAI,MAAqB,CAAC;YAC1B,IAAI;gBACF,MAAM,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aACzD;YAAC,OAAO,KAAK,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,CAAC;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,iBAAgC,CAAC;YACrC,IAAI;gBACF,iBAAiB,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;aACjE;YAAC,OAAO,KAAK,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,CAAC;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,iBAAiB,EAAE;gBACtB,OAAO,SAAS,CAAC;aAClB;YAED,IACE,iBAAiB,KAAK,YAAY;gBAClC,iBAAiB,KAAK,oBAAoB,EAC1C;gBACA,OAAO,SAAS,CAAC;aAClB;YACD,IAAI,IAAA,uCAAoB,EAAC,iBAAiB,CAAC,KAAK,OAAO,EAAE;gBACvD,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,GAAG,IAAA,kBAAO,EAAC,MAAgB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAnPD,sCAmPC;yKA5DuB,SAAiB;IACrC,OAAO,OAAO,CAAC,kCAAa,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3C,CAAC;AA4DH,kBAAe,aAAa,CAAC","sourcesContent":["import {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n  Web3Provider,\n  ExternalProvider,\n  JsonRpcFetchFunc,\n} from '@ethersproject/providers';\nimport { Hex, createProjectLogger, hasProperty } from '@metamask/utils';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  toChecksumHexAddress,\n  NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP,\n  convertHexToDecimal,\n} from '@metamask/controller-utils';\nimport type { NetworkState } from '@metamask/network-controller';\nimport { toASCII } from 'punycode/';\nimport ensNetworkMap from 'ethereum-ens-network-map';\n\nconst log = createProjectLogger('ens-controller');\n\n/**\n * Checks whether the given string is a known network ID.\n *\n * @param networkId - Network id.\n * @returns Boolean indicating if the network ID is recognized.\n */\nfunction isKnownNetworkId(\n  networkId: string | null,\n): networkId is keyof typeof NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP {\n  return (\n    networkId !== null &&\n    hasProperty(NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId)\n  );\n}\n\nconst name = 'EnsController';\n\n/**\n * @type EnsEntry\n *\n * ENS entry representation\n * @property chainId - Id of the associated chain\n * @property ensName - The ENS name\n * @property address - Hex address with the ENS name, or null\n */\nexport type EnsEntry = {\n  chainId: Hex;\n  ensName: string;\n  address: string | null;\n};\n\n/**\n * @type EnsControllerState\n *\n * ENS controller state\n * @property ensEntries - Object of ENS entry objects\n */\nexport type EnsControllerState = {\n  ensEntries: {\n    [chainId: Hex]: {\n      [ensName: string]: EnsEntry;\n    };\n  };\n  ensResolutionsByAddress: { [key: string]: string };\n};\n\nexport type EnsControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  never,\n  never,\n  never,\n  never\n>;\n\nconst metadata = {\n  ensEntries: { persist: true, anonymous: false },\n  ensResolutionsByAddress: { persist: true, anonymous: false },\n};\n\nconst defaultState = {\n  ensEntries: {},\n  ensResolutionsByAddress: {},\n};\n\nconst ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';\nconst ZERO_X_ERROR_ADDRESS = '0x';\n\n/**\n * Controller that manages a list ENS names and their resolved addresses\n * by chainId. A null address indicates an unresolved ENS name.\n */\nexport class EnsController extends BaseControllerV2<\n  typeof name,\n  EnsControllerState,\n  EnsControllerMessenger\n> {\n  #ethProvider: Web3Provider | null = null;\n\n  /**\n   * Creates an EnsController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.provider - Provider instance.\n   * @param options.onNetworkStateChange - Allows registering an event handler for\n   * when the network controller state updated.\n   */\n  constructor({\n    messenger,\n    state = {},\n    provider,\n    onNetworkStateChange,\n  }: {\n    messenger: EnsControllerMessenger;\n    state?: Partial<EnsControllerState>;\n    provider?: ExternalProvider | JsonRpcFetchFunc;\n    onNetworkStateChange?: (\n      listener: (\n        networkState: Pick<NetworkState, 'networkId' | 'providerConfig'>,\n      ) => void,\n    ) => void;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: {\n        ...defaultState,\n        ...state,\n      },\n    });\n\n    if (provider && onNetworkStateChange) {\n      onNetworkStateChange((networkState) => {\n        this.resetState();\n        const currentNetwork = networkState.networkId;\n        if (\n          isKnownNetworkId(currentNetwork) &&\n          this.#getNetworkEnsSupport(currentNetwork)\n        ) {\n          this.#ethProvider = new Web3Provider(provider, {\n            chainId: convertHexToDecimal(networkState.providerConfig.chainId),\n            name: NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],\n            ensAddress: ensNetworkMap[currentNetwork],\n          });\n        } else {\n          this.#ethProvider = null;\n        }\n      });\n    }\n  }\n\n  /**\n   * Clears ensResolutionsByAddress state property.\n   */\n  resetState() {\n    this.update((currentState) => {\n      currentState.ensResolutionsByAddress = {};\n    });\n  }\n\n  /**\n   * Remove all chain Ids and ENS entries from state.\n   */\n  clear() {\n    this.update((state) => {\n      state.ensEntries = {};\n    });\n  }\n\n  /**\n   * Delete an ENS entry.\n   *\n   * @param chainId - Parent chain of the ENS entry to delete.\n   * @param ensName - Name of the ENS entry to delete.\n   * @returns Boolean indicating if the entry was deleted.\n   */\n  delete(chainId: Hex, ensName: string): boolean {\n    const normalizedEnsName = normalizeEnsName(ensName);\n    if (\n      !normalizedEnsName ||\n      !this.state.ensEntries[chainId] ||\n      !this.state.ensEntries[chainId][normalizedEnsName]\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      delete state.ensEntries[chainId][normalizedEnsName];\n\n      if (Object.keys(state.ensEntries[chainId]).length === 0) {\n        delete state.ensEntries[chainId];\n      }\n    });\n    return true;\n  }\n\n  /**\n   * Retrieve a DNS entry.\n   *\n   * @param chainId - Parent chain of the ENS entry to retrieve.\n   * @param ensName - Name of the ENS entry to retrieve.\n   * @returns The EnsEntry or null if it does not exist.\n   */\n  get(chainId: Hex, ensName: string): EnsEntry | null {\n    const normalizedEnsName = normalizeEnsName(ensName);\n\n    // TODO Explicitly handle the case where `normalizedEnsName` is `null`\n    // eslint-disable-next-line no-implicit-coercion\n    return !!normalizedEnsName && this.state.ensEntries[chainId]\n      ? this.state.ensEntries[chainId][normalizedEnsName] || null\n      : null;\n  }\n\n  /**\n   * Add or update an ENS entry by chainId and ensName.\n   *\n   * A null address indicates that the ENS name does not resolve.\n   *\n   * @param chainId - Id of the associated chain.\n   * @param ensName - The ENS name.\n   * @param address - Associated address (or null) to add or update.\n   * @returns Boolean indicating if the entry was set.\n   */\n  set(chainId: Hex, ensName: string, address: string | null): boolean {\n    if (\n      !Number.isInteger(Number.parseInt(chainId, 10)) ||\n      !ensName ||\n      typeof ensName !== 'string' ||\n      (address && !isValidHexAddress(address))\n    ) {\n      throw new Error(\n        `Invalid ENS entry: { chainId:${chainId}, ensName:${ensName}, address:${address}}`,\n      );\n    }\n\n    const normalizedEnsName = normalizeEnsName(ensName);\n    if (!normalizedEnsName) {\n      throw new Error(`Invalid ENS name: ${ensName}`);\n    }\n\n    const normalizedAddress = address ? toChecksumHexAddress(address) : null;\n    const subState = this.state.ensEntries[chainId];\n\n    if (\n      subState?.[normalizedEnsName] &&\n      subState[normalizedEnsName].address === normalizedAddress\n    ) {\n      return false;\n    }\n\n    this.update((state) => {\n      state.ensEntries = {\n        ...this.state.ensEntries,\n        [chainId]: {\n          ...this.state.ensEntries[chainId],\n          [normalizedEnsName]: {\n            address: normalizedAddress,\n            chainId,\n            ensName: normalizedEnsName,\n          },\n        },\n      };\n    });\n    return true;\n  }\n\n  /**\n   * Check if network supports ENS.\n   *\n   * @param networkId - Network id.\n   * @returns Boolean indicating if the network supports ENS.\n   */\n  #getNetworkEnsSupport(networkId: string) {\n    return Boolean(ensNetworkMap[networkId]);\n  }\n\n  /**\n   * Resolve ens by address.\n   *\n   * @param nonChecksummedAddress - address\n   * @returns ens resolution\n   */\n  async reverseResolveAddress(nonChecksummedAddress: string) {\n    if (!this.#ethProvider) {\n      return undefined;\n    }\n\n    const address = toChecksumHexAddress(nonChecksummedAddress);\n    if (this.state.ensResolutionsByAddress[address]) {\n      return this.state.ensResolutionsByAddress[address];\n    }\n\n    let domain: string | null;\n    try {\n      domain = await this.#ethProvider.lookupAddress(address);\n    } catch (error) {\n      log(error);\n      return undefined;\n    }\n\n    if (!domain) {\n      return undefined;\n    }\n\n    let registeredAddress: string | null;\n    try {\n      registeredAddress = await this.#ethProvider.resolveName(domain);\n    } catch (error) {\n      log(error);\n      return undefined;\n    }\n\n    if (!registeredAddress) {\n      return undefined;\n    }\n\n    if (\n      registeredAddress === ZERO_ADDRESS ||\n      registeredAddress === ZERO_X_ERROR_ADDRESS\n    ) {\n      return undefined;\n    }\n    if (toChecksumHexAddress(registeredAddress) !== address) {\n      return undefined;\n    }\n\n    this.update((state) => {\n      state.ensResolutionsByAddress[address] = toASCII(domain as string);\n    });\n\n    return domain;\n  }\n}\n\nexport default EnsController;\n"]}

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './EnsController';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/ens-controller",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Maps ENS names to their resolved addresses by chain id",
   "keywords": [
     "MetaMask",
@@ -29,21 +29,29 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^2.0.0",
-    "@metamask/controller-utils": "^3.1.0"
+    "@ethersproject/providers": "^5.7.0",
+    "@metamask/base-controller": "^3.0.0",
+    "@metamask/controller-utils": "^4.0.0",
+    "@metamask/network-controller": "^9.0.0",
+    "@metamask/utils": "^5.0.2",
+    "ethereum-ens-network-map": "^1.0.2",
+    "punycode": "^2.1.1"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.1.0",
-    "@types/jest": "^26.0.22",
+    "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
-    "jest": "^26.4.2",
-    "ts-jest": "^26.5.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
     "typedoc": "^0.22.15",
     "typedoc-plugin-missing-exports": "^0.22.6",
     "typescript": "~4.6.3"
   },
+  "peerDependencies": {
+    "@metamask/network-controller": "^9.0.0"
+  },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "publishConfig": {
     "access": "public",