@metamask/ens-controller 8.0.0 → 10.0.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,61 +7,110 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [10.0.0]
+
+### Added
+
+- **BREAKING**: Add ESM build ([#3998](https://github.com/MetaMask/core/pull/3998))
+  - It's no longer possible to import files from `./dist` directly.
+- Add support for Holesky and Sepolia registries ([#4006](https://github.com/MetaMask/core/pull/4006))
+- Add optional constructor option `registriesByChainId`, which allows overriding the default ENS network map ([#4006](https://github.com/MetaMask/core/pull/4006))
+- Update default value of `ensEntries` state property to include entry for `.` ([#4006](https://github.com/MetaMask/core/pull/4006))
+- Update `get` so that it now returns registry address for chain when queried for the name `.` ([#4006](https://github.com/MetaMask/core/pull/4006))
+- Update `delete` so that entry for `.` can be removed ([#4006](https://github.com/MetaMask/core/pull/4006))
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/base-controller` to `^5.0.0` ([#4039](https://github.com/MetaMask/core/pull/4039))
+  - This version has a number of breaking changes. See the changelog for more.
+- **BREAKING:** Bump peer dependency on `@metamask/network-controller` to `^18.0.0` ([#4039](https://github.com/MetaMask/core/pull/4039))
+- Bump `@metamask/controller-utils` to `^9.0.0` ([#4039](https://github.com/MetaMask/core/pull/4039))
+
+## [9.0.0]
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/network-controller` peer dependency to `^17.2.0` ([#3821](https://github.com/MetaMask/core/pull/3821))
+- Bump `@metamask/utils` to `^8.3.0` ([#3769](https://github.com/MetaMask/core/pull/3769))
+- Bump `@metamask/base-controller` to `^4.1.1` ([#3760](https://github.com/MetaMask/core/pull/3760), [#3821](https://github.com/MetaMask/core/pull/3821))
+- Bump `@metamask/controller-utils` to `^8.0.2` ([#3821](https://github.com/MetaMask/core/pull/3821))
+
 ## [8.0.0]
+
 ### Changed
+
 - **BREAKING:** Replace constructor parameter `onNetworkStateChange` with `onNetworkDidChange` ([#3610](https://github.com/MetaMask/core/pull/3610))
 - **BREAKING:** Bump `@metamask/network-controller` peer dependency from `^17.0.0` to `^17.1.0` ([#3695](https://github.com/MetaMask/core/pull/3695))
 - Bump `@metamask/controller-utils` to `^8.0.1` ([#3695](https://github.com/MetaMask/core/pull/3695), [#3678](https://github.com/MetaMask/core/pull/3678), [#3667](https://github.com/MetaMask/core/pull/3667), [#3580](https://github.com/MetaMask/core/pull/3580))
 - Bump `@metamask/base-controller` to `^4.0.1` ([#3695](https://github.com/MetaMask/core/pull/3695))
 
 ### Fixed
+
 - Remove `@metamask/network-controller` dependency ([#3607](https://github.com/MetaMask/core/pull/3607))
 
 ## [7.0.0]
+
 ### Changed
+
 - **BREAKING:** Bump `@metamask/base-controller` to ^4.0.0 ([#2063](https://github.com/MetaMask/core/pull/2063))
   - This is breaking because the type of the `messenger` has backward-incompatible changes. See the changelog for this package for more.
 - Bump `@metamask/controller-utils` to ^6.0.0 ([#2063](https://github.com/MetaMask/core/pull/2063))
 - Bump `@metamask/network-controller` to ^17.0.0 ([#2063](https://github.com/MetaMask/core/pull/2063))
 
 ## [6.0.1]
+
 ### Changed
+
 - **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^16.0.0
 - Bump @metamask/utils from 8.1.0 to 8.2.0 ([#1957](https://github.com/MetaMask/core/pull/1957))
 
 ## [6.0.0]
+
 ### Changed
+
 - **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^15.0.0
 
 ## [5.0.2]
+
 ### Changed
+
 - Bump dependency on `@metamask/utils` to ^8.1.0 ([#1639](https://github.com/MetaMask/core/pull/1639))
 - Bump dependency on `@metamask/base-controller` to ^3.2.3
 - Bump dependency on `@metamask/controller-utils` to ^5.0.2
 - Bump dependency and peer dependency on `@metamask/network-controller` to ^14.0.0
 
 ## [5.0.1]
+
 ### Changed
+
 - Update TypeScript to v4.8.x ([#1718](https://github.com/MetaMask/core/pull/1718))
 
 ## [5.0.0]
+
 ### Changed
+
 - **BREAKING**: Bump peer dependency on `@metamask/network-controller` to ^13.0.0 ([#1633](https://github.com/MetaMask/core/pull/1633))
 - Use `providerConfig.chainId` instead of `providerConfig.networkId` to determine ENS compatability ([#1633](https://github.com/MetaMask/core/pull/1633))
 - Bump dependency on `@metamask/controller-utils` to ^5.0.0 ([#1633](https://github.com/MetaMask/core/pull/1633))
 
 ## [4.1.1]
+
 ### Changed
+
 - Bump dependency on `@metamask/base-controller` to ^3.2.1
 - Bump dependency on `@metamask/controller-utils` to ^4.3.2
 - Bump dependency and peer dependency on `@metamask/network-controller` to ^12.1.2
 
 ## [4.1.0]
+
 ### Changed
+
 - Update `@metamask/utils` to `^6.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
 
 ## [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))
@@ -69,41 +119,58 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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))
 
 ## [2.0.0]
+
 ### Removed
+
 - **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
   - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
 
 ## [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))
 
 ## [1.0.1]
+
 ### Changed
+
 - Relax dependencies on `@metamask/base-controller` and `@metamask/controller-utils` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
 
 ## [1.0.0]
+
 ### Added
+
 - Initial release
+
   - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/tree/v33.0.0), namely:
+
     - `src/third-party/EnsController.ts`
     - `src/third-party/EnsController.test.ts`
 
     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@8.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@10.0.0...HEAD
+[10.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@9.0.0...@metamask/ens-controller@10.0.0
+[9.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@8.0.0...@metamask/ens-controller@9.0.0
 [8.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@7.0.0...@metamask/ens-controller@8.0.0
 [7.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@6.0.1...@metamask/ens-controller@7.0.0
 [6.0.1]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@6.0.0...@metamask/ens-controller@6.0.1

package/dist/EnsController.js

@@ -1,231 +1,11 @@
-"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_getChainEnsSupport;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnsController = void 0;
-const providers_1 = require("@ethersproject/providers");
-const base_controller_1 = require("@metamask/base-controller");
-const controller_utils_1 = require("@metamask/controller-utils");
-const utils_1 = require("@metamask/utils");
-const ethereum_ens_network_map_1 = __importDefault(require("ethereum-ens-network-map"));
-const punycode_1 = require("punycode/");
-const log = (0, utils_1.createProjectLogger)('ens-controller');
-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.
- */
-class EnsController extends base_controller_1.BaseController {
-    /**
-     * 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.onNetworkDidChange - Allows subscribing to network controller networkDidChange events.
-     */
-    constructor({ messenger, state = {}, provider, onNetworkDidChange, }) {
-        super({
-            name,
-            metadata,
-            messenger,
-            state: Object.assign(Object.assign({}, defaultState), state),
-        });
-        _EnsController_instances.add(this);
-        _EnsController_ethProvider.set(this, null);
-        if (provider && onNetworkDidChange) {
-            onNetworkDidChange((networkState) => {
-                this.resetState();
-                const currentChainId = networkState.providerConfig.chainId;
-                if (__classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_getChainEnsSupport).call(this, currentChainId)) {
-                    __classPrivateFieldSet(this, _EnsController_ethProvider, new providers_1.Web3Provider(provider, {
-                        chainId: (0, controller_utils_1.convertHexToDecimal)(currentChainId),
-                        name: controller_utils_1.CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[currentChainId],
-                        ensAddress: ethereum_ens_network_map_1.default[parseInt(currentChainId, 16)],
-                    }), "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.
-     */
-    clear() {
-        this.update((state) => {
-            state.ensEntries = {};
-        });
-    }
-    /**
-     * Delete an ENS entry.
-     *
-     * @param chainId - Parent chain of the ENS entry to delete.
-     * @param ensName - Name of the ENS entry to delete.
-     * @returns Boolean indicating if the entry was deleted.
-     */
-    delete(chainId, ensName) {
-        const normalizedEnsName = (0, controller_utils_1.normalizeEnsName)(ensName);
-        if (!normalizedEnsName ||
-            !this.state.ensEntries[chainId] ||
-            !this.state.ensEntries[chainId][normalizedEnsName]) {
-            return false;
-        }
-        this.update((state) => {
-            delete state.ensEntries[chainId][normalizedEnsName];
-            if (Object.keys(state.ensEntries[chainId]).length === 0) {
-                delete state.ensEntries[chainId];
-            }
-        });
-        return true;
-    }
-    /**
-     * Retrieve a DNS entry.
-     *
-     * @param chainId - Parent chain of the ENS entry to retrieve.
-     * @param ensName - Name of the ENS entry to retrieve.
-     * @returns The EnsEntry or null if it does not exist.
-     */
-    get(chainId, ensName) {
-        const normalizedEnsName = (0, controller_utils_1.normalizeEnsName)(ensName);
-        // TODO Explicitly handle the case where `normalizedEnsName` is `null`
-        // eslint-disable-next-line no-implicit-coercion
-        return !!normalizedEnsName && this.state.ensEntries[chainId]
-            ? this.state.ensEntries[chainId][normalizedEnsName] || null
-            : null;
-    }
-    /**
-     * Add or update an ENS entry by chainId and ensName.
-     *
-     * A null address indicates that the ENS name does not resolve.
-     *
-     * @param chainId - Id of the associated chain.
-     * @param ensName - The ENS name.
-     * @param address - Associated address (or null) to add or update.
-     * @returns Boolean indicating if the entry was set.
-     */
-    set(chainId, ensName, address) {
-        if (!Number.isInteger(Number.parseInt(chainId, 10)) ||
-            !ensName ||
-            typeof ensName !== 'string' ||
-            (address && !(0, controller_utils_1.isValidHexAddress)(address))) {
-            throw new Error(`Invalid ENS entry: { chainId:${chainId}, ensName:${ensName}, address:${address}}`);
-        }
-        const normalizedEnsName = (0, controller_utils_1.normalizeEnsName)(ensName);
-        if (!normalizedEnsName) {
-            throw new Error(`Invalid ENS name: ${ensName}`);
-        }
-        const normalizedAddress = address ? (0, controller_utils_1.toChecksumHexAddress)(address) : null;
-        const subState = this.state.ensEntries[chainId];
-        if ((subState === null || subState === void 0 ? void 0 : subState[normalizedEnsName]) &&
-            subState[normalizedEnsName].address === normalizedAddress) {
-            return false;
-        }
-        this.update((state) => {
-            state.ensEntries = Object.assign(Object.assign({}, this.state.ensEntries), { [chainId]: Object.assign(Object.assign({}, this.state.ensEntries[chainId]), { [normalizedEnsName]: {
-                        address: normalizedAddress,
-                        chainId,
-                        ensName: normalizedEnsName,
-                    } }) });
-        });
-        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_getChainEnsSupport = function _EnsController_getChainEnsSupport(chainId) {
-    return Boolean(ethereum_ens_network_map_1.default[parseInt(chainId, 16)]);
-};
-exports.default = EnsController;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkS7KH3XXUjs = require('./chunk-S7KH3XXU.js');
+
+
+
+
+exports.DEFAULT_ENS_NETWORK_MAP = _chunkS7KH3XXUjs.DEFAULT_ENS_NETWORK_MAP; exports.EnsController = _chunkS7KH3XXUjs.EnsController; exports.default = _chunkS7KH3XXUjs.EnsController_default;
 //# sourceMappingURL=EnsController.js.map

package/dist/EnsController.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnsController.js","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,wDAAwD;AAExD,+DAA2D;AAE3D,iEAMoC;AAGpC,2CAAsD;AACtD,wFAAqD;AACrD,wCAAoC;AAEpC,MAAM,GAAG,GAAG,IAAA,2BAAmB,EAAC,gBAAgB,CAAC,CAAC;AAElD,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,gCAIlC;IAGC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,QAAQ,EACR,kBAAkB,GAQnB;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCACA,YAAY,GACZ,KAAK,CACT;SACF,CAAC,CAAC;;QAhCL,qCAAoC,IAAI,EAAC;QAkCvC,IAAI,QAAQ,IAAI,kBAAkB,EAAE;YAClC,kBAAkB,CAAC,CAAC,YAAY,EAAE,EAAE;gBAClC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,MAAM,cAAc,GAAG,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC3D,IAAI,uBAAA,IAAI,mEAAoB,MAAxB,IAAI,EAAqB,cAAc,CAAC,EAAE;oBAC5C,uBAAA,IAAI,8BAAgB,IAAI,wBAAY,CAAC,QAAQ,EAAE;wBAC7C,OAAO,EAAE,IAAA,sCAAmB,EAAC,cAAc,CAAC;wBAC5C,IAAI,EAAE,sDAAmC,CACvC,cAAyB,CAC1B;wBACD,UAAU,EAAE,kCAAa,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;qBACxD,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;AA/OD,sCA+OC;qKA5DqB,OAAe;IACjC,OAAO,OAAO,CAAC,kCAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC;AA4DH,kBAAe,aAAa,CAAC","sourcesContent":["import type {\n  ExternalProvider,\n  JsonRpcFetchFunc,\n} from '@ethersproject/providers';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { ChainId } from '@metamask/controller-utils';\nimport {\n  normalizeEnsName,\n  isValidHexAddress,\n  toChecksumHexAddress,\n  CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,\n  convertHexToDecimal,\n} from '@metamask/controller-utils';\nimport type { NetworkState } from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\nimport { createProjectLogger } from '@metamask/utils';\nimport ensNetworkMap from 'ethereum-ens-network-map';\nimport { toASCII } from 'punycode/';\n\nconst log = createProjectLogger('ens-controller');\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 BaseController<\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.onNetworkDidChange - Allows subscribing to network controller networkDidChange events.\n   */\n  constructor({\n    messenger,\n    state = {},\n    provider,\n    onNetworkDidChange,\n  }: {\n    messenger: EnsControllerMessenger;\n    state?: Partial<EnsControllerState>;\n    provider?: ExternalProvider | JsonRpcFetchFunc;\n    onNetworkDidChange?: (\n      listener: (networkState: Pick<NetworkState, 'providerConfig'>) => void,\n    ) => void;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: {\n        ...defaultState,\n        ...state,\n      },\n    });\n\n    if (provider && onNetworkDidChange) {\n      onNetworkDidChange((networkState) => {\n        this.resetState();\n        const currentChainId = networkState.providerConfig.chainId;\n        if (this.#getChainEnsSupport(currentChainId)) {\n          this.#ethProvider = new Web3Provider(provider, {\n            chainId: convertHexToDecimal(currentChainId),\n            name: CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[\n              currentChainId as ChainId\n            ],\n            ensAddress: ensNetworkMap[parseInt(currentChainId, 16)],\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 the chain supports ENS.\n   *\n   * @param chainId - chain id.\n   * @returns Boolean indicating if the chain supports ENS.\n   */\n  #getChainEnsSupport(chainId: string) {\n    return Boolean(ensNetworkMap[parseInt(chainId, 16)]);\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"]}
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/EnsController.mjs

@@ -0,0 +1,11 @@
+import {
+  DEFAULT_ENS_NETWORK_MAP,
+  EnsController,
+  EnsController_default
+} from "./chunk-LQYXJTIO.mjs";
+export {
+  DEFAULT_ENS_NETWORK_MAP,
+  EnsController,
+  EnsController_default as default
+};
+//# sourceMappingURL=EnsController.mjs.map

package/dist/EnsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}