@metamask-previews/name-controller 9.1.2-preview-4f4c98e → 9.1.2-preview-eb263b0ee

package/CHANGELOG.md

@@ -9,7 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Bump minimum Node.js version to 22 ([#9168](https://github.com/MetaMask/core/pull/9168))
 - Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
 - Bump `@metamask/controller-utils` from `^12.0.0` to `^12.3.0` ([#8774](https://github.com/MetaMask/core/pull/8774), [#9058](https://github.com/MetaMask/core/pull/9058), [#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
 - Bump `@metamask/messenger` from `^1.2.0` to `^2.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392))

package/dist/NameController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NameController-method-action-types.cjs.map

package/dist/NameController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController-method-action-types.cjs","sourceRoot":"","sources":["../src/NameController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NameController } from './NameController.js';\n\n/**\n * Set the user specified name for a value.\n *\n * @param request - Request object.\n * @param request.name - Name to set.\n * @param request.sourceId - Optional ID of the source of the proposed name.\n * @param request.type - Type of value to set the name for.\n * @param request.value - Value to set the name for.\n * @param request.variation - Variation of the raw value to set the name for. The chain ID if the type is Ethereum address.\n */\nexport type NameControllerSetNameAction = {\n  type: `NameController:setName`;\n  handler: NameController['setName'];\n};\n\n/**\n * Generate the proposed names for a value using the name providers and store them in the state.\n *\n * @param request - Request object.\n * @param request.value - Value to update the proposed names for.\n * @param request.type - Type of value to update the proposed names for.\n * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.\n * @param request.variation - Variation of the raw value to update proposed names for. The chain ID if the type is Ethereum address.\n * @returns The updated proposed names for the value.\n */\nexport type NameControllerUpdateProposedNamesAction = {\n  type: `NameController:updateProposedNames`;\n  handler: NameController['updateProposedNames'];\n};\n\n/**\n * Union of all NameController action types.\n */\nexport type NameControllerMethodActions =\n  | NameControllerSetNameAction\n  | NameControllerUpdateProposedNamesAction;\n"]}

package/dist/{NameController-method-action-types.d.ts → NameController-method-action-types.d.cts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { NameController } from './NameController.js';
+import type { NameController } from "./NameController.cjs";
 /**
  * Set the user specified name for a value.
  *
@@ -35,4 +35,4 @@ export type NameControllerUpdateProposedNamesAction = {
  * Union of all NameController action types.
  */
 export type NameControllerMethodActions = NameControllerSetNameAction | NameControllerUpdateProposedNamesAction;
-//# sourceMappingURL=NameController-method-action-types.d.ts.map
+//# sourceMappingURL=NameController-method-action-types.d.cts.map

package/dist/NameController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController-method-action-types.d.cts","sourceRoot":"","sources":["../src/NameController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,6BAA4B;AAE1D;;;;;;;;;GASG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,2BAA2B,GAC3B,uCAAuC,CAAC"}

package/dist/NameController-method-action-types.d.mts

@@ -0,0 +1,38 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { NameController } from "./NameController.mjs";
+/**
+ * Set the user specified name for a value.
+ *
+ * @param request - Request object.
+ * @param request.name - Name to set.
+ * @param request.sourceId - Optional ID of the source of the proposed name.
+ * @param request.type - Type of value to set the name for.
+ * @param request.value - Value to set the name for.
+ * @param request.variation - Variation of the raw value to set the name for. The chain ID if the type is Ethereum address.
+ */
+export type NameControllerSetNameAction = {
+    type: `NameController:setName`;
+    handler: NameController['setName'];
+};
+/**
+ * Generate the proposed names for a value using the name providers and store them in the state.
+ *
+ * @param request - Request object.
+ * @param request.value - Value to update the proposed names for.
+ * @param request.type - Type of value to update the proposed names for.
+ * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.
+ * @param request.variation - Variation of the raw value to update proposed names for. The chain ID if the type is Ethereum address.
+ * @returns The updated proposed names for the value.
+ */
+export type NameControllerUpdateProposedNamesAction = {
+    type: `NameController:updateProposedNames`;
+    handler: NameController['updateProposedNames'];
+};
+/**
+ * Union of all NameController action types.
+ */
+export type NameControllerMethodActions = NameControllerSetNameAction | NameControllerUpdateProposedNamesAction;
+//# sourceMappingURL=NameController-method-action-types.d.mts.map

package/dist/NameController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController-method-action-types.d.mts","sourceRoot":"","sources":["../src/NameController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,6BAA4B;AAE1D;;;;;;;;;GASG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,2BAA2B,GAC3B,uCAAuC,CAAC"}

package/dist/{NameController-method-action-types.js → NameController-method-action-types.mjs}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=NameController-method-action-types.js.map
+//# sourceMappingURL=NameController-method-action-types.mjs.map

package/dist/NameController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController-method-action-types.mjs","sourceRoot":"","sources":["../src/NameController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NameController } from './NameController.js';\n\n/**\n * Set the user specified name for a value.\n *\n * @param request - Request object.\n * @param request.name - Name to set.\n * @param request.sourceId - Optional ID of the source of the proposed name.\n * @param request.type - Type of value to set the name for.\n * @param request.value - Value to set the name for.\n * @param request.variation - Variation of the raw value to set the name for. The chain ID if the type is Ethereum address.\n */\nexport type NameControllerSetNameAction = {\n  type: `NameController:setName`;\n  handler: NameController['setName'];\n};\n\n/**\n * Generate the proposed names for a value using the name providers and store them in the state.\n *\n * @param request - Request object.\n * @param request.value - Value to update the proposed names for.\n * @param request.type - Type of value to update the proposed names for.\n * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.\n * @param request.variation - Variation of the raw value to update proposed names for. The chain ID if the type is Ethereum address.\n * @returns The updated proposed names for the value.\n */\nexport type NameControllerUpdateProposedNamesAction = {\n  type: `NameController:updateProposedNames`;\n  handler: NameController['updateProposedNames'];\n};\n\n/**\n * Union of all NameController action types.\n */\nexport type NameControllerMethodActions =\n  | NameControllerSetNameAction\n  | NameControllerUpdateProposedNamesAction;\n"]}

package/dist/NameController.cjs

@@ -0,0 +1,420 @@
+"use strict";
+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 __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 _NameController_instances, _NameController_providers, _NameController_updateDelay, _NameController_updateProposedNameState, _NameController_updateSourceState, _NameController_getUpdateProposedNamesResult, _NameController_getProviderResponse, _NameController_normalizeProviderResult, _NameController_normalizeProviderSourceResult, _NameController_normalizeValue, _NameController_normalizeVariation, _NameController_updateEntry, _NameController_getCurrentTimeSeconds, _NameController_validateSetNameRequest, _NameController_validateUpdateProposedNamesRequest, _NameController_validateValue, _NameController_validateType, _NameController_validateName, _NameController_validateSourceIds, _NameController_validateSourceId, _NameController_validateDuplicateSourceIds, _NameController_validateVariation, _NameController_validateOrigin, _NameController_getAllSourceIds, _NameController_getSourceIds, _NameController_removeDormantProposedNames, _NameController_removeExpiredEntries, _NameController_getEntriesList;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NameController = exports.NameOrigin = exports.PROPOSED_NAME_EXPIRE_DURATION = exports.FALLBACK_VARIATION = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const types_js_1 = require("./types.cjs");
+exports.FALLBACK_VARIATION = '*';
+exports.PROPOSED_NAME_EXPIRE_DURATION = 60 * 60 * 24; // 24 hours
+/**
+ * Enumerates the possible origins responsible for setting a petname.
+ */
+var NameOrigin;
+(function (NameOrigin) {
+    // Originated from an account identity.
+    NameOrigin["ACCOUNT_IDENTITY"] = "account-identity";
+    // Originated from an address book entry.
+    NameOrigin["ADDRESS_BOOK"] = "address-book";
+    // Originated from the API (NameController.setName). This is the default.
+    NameOrigin["API"] = "api";
+    // Originated from the user taking action in the UI.
+    NameOrigin["UI"] = "ui";
+})(NameOrigin || (exports.NameOrigin = NameOrigin = {}));
+const DEFAULT_UPDATE_DELAY = 60 * 2; // 2 Minutes
+const DEFAULT_VARIATION = '';
+const controllerName = 'NameController';
+const MESSENGER_EXPOSED_METHODS = ['setName', 'updateProposedNames'];
+const stateMetadata = {
+    names: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+    nameSources: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+};
+const getDefaultState = () => ({
+    names: {
+        [types_js_1.NameType.ETHEREUM_ADDRESS]: {},
+    },
+    nameSources: {},
+});
+/**
+ * Controller for storing and deriving names for values such as Ethereum addresses.
+ */
+class NameController extends base_controller_1.BaseController {
+    /**
+     * Construct a Name controller.
+     *
+     * @param options - Controller options.
+     * @param options.messenger - Restricted messenger for the name controller.
+     * @param options.providers - Array of name provider instances to propose names.
+     * @param options.state - Initial state to set on the controller.
+     * @param options.updateDelay - The delay in seconds before a new request to a source should be made.
+     */
+    constructor({ messenger, providers, state, updateDelay, }) {
+        super({
+            name: controllerName,
+            metadata: stateMetadata,
+            messenger,
+            state: { ...getDefaultState(), ...state },
+        });
+        _NameController_instances.add(this);
+        _NameController_providers.set(this, void 0);
+        _NameController_updateDelay.set(this, void 0);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        __classPrivateFieldSet(this, _NameController_providers, providers, "f");
+        __classPrivateFieldSet(this, _NameController_updateDelay, updateDelay ?? DEFAULT_UPDATE_DELAY, "f");
+    }
+    /**
+     * Set the user specified name for a value.
+     *
+     * @param request - Request object.
+     * @param request.name - Name to set.
+     * @param request.sourceId - Optional ID of the source of the proposed name.
+     * @param request.type - Type of value to set the name for.
+     * @param request.value - Value to set the name for.
+     * @param request.variation - Variation of the raw value to set the name for. The chain ID if the type is Ethereum address.
+     */
+    setName(request) {
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSetNameRequest).call(this, request);
+        const { value, type, name, sourceId: requestSourceId, origin: requestOrigin, variation, } = request;
+        const sourceId = requestSourceId ?? null;
+        // If the name is being cleared, the fallback origin should be cleared as well.
+        const fallbackOrigin = name === null ? null : NameOrigin.API;
+        const origin = requestOrigin ?? fallbackOrigin;
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, variation, (entry) => {
+            entry.name = name;
+            entry.sourceId = sourceId;
+            entry.origin = origin;
+        });
+    }
+    /**
+     * Generate the proposed names for a value using the name providers and store them in the state.
+     *
+     * @param request - Request object.
+     * @param request.value - Value to update the proposed names for.
+     * @param request.type - Type of value to update the proposed names for.
+     * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.
+     * @param request.variation - Variation of the raw value to update proposed names for. The chain ID if the type is Ethereum address.
+     * @returns The updated proposed names for the value.
+     */
+    async updateProposedNames(request) {
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateUpdateProposedNamesRequest).call(this, request);
+        const providerResponses = (await Promise.all(__classPrivateFieldGet(this, _NameController_providers, "f").map((provider) => __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getProviderResponse).call(this, request, provider)))).filter((response) => Boolean(response));
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateProposedNameState).call(this, request, providerResponses);
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateSourceState).call(this, __classPrivateFieldGet(this, _NameController_providers, "f"));
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_removeExpiredEntries).call(this);
+        return __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getUpdateProposedNamesResult).call(this, providerResponses);
+    }
+}
+exports.NameController = NameController;
+_NameController_providers = new WeakMap(), _NameController_updateDelay = new WeakMap(), _NameController_instances = new WeakSet(), _NameController_updateProposedNameState = function _NameController_updateProposedNameState(request, providerResponses) {
+    const { value, type, variation } = request;
+    const currentTime = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getCurrentTimeSeconds).call(this);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, variation, (entry) => {
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_removeDormantProposedNames).call(this, entry.proposedNames, type);
+        for (const providerResponse of providerResponses) {
+            const { results } = providerResponse;
+            for (const sourceId of Object.keys(providerResponse.results)) {
+                const result = results[sourceId];
+                const { proposedNames, updateDelay } = result;
+                const proposedNameEntry = entry.proposedNames[sourceId] ?? {
+                    proposedNames: [],
+                    lastRequestTime: null,
+                    updateDelay: null,
+                };
+                entry.proposedNames[sourceId] = proposedNameEntry;
+                if (proposedNames) {
+                    proposedNameEntry.proposedNames = proposedNames;
+                }
+                proposedNameEntry.lastRequestTime = currentTime;
+                proposedNameEntry.updateDelay = updateDelay ?? null;
+            }
+        }
+    });
+}, _NameController_updateSourceState = function _NameController_updateSourceState(providers) {
+    const newNameSources = { ...this.state.nameSources };
+    for (const provider of providers) {
+        const { sourceLabels } = provider.getMetadata();
+        for (const sourceId of Object.keys(sourceLabels)) {
+            newNameSources[sourceId] = {
+                label: sourceLabels[sourceId],
+            };
+        }
+    }
+    this.update((state) => {
+        state.nameSources = newNameSources;
+    });
+}, _NameController_getUpdateProposedNamesResult = function _NameController_getUpdateProposedNamesResult(providerResponses) {
+    return providerResponses.reduce((acc, providerResponse) => {
+        const { results } = providerResponse;
+        for (const sourceId of Object.keys(results)) {
+            const { proposedNames, error } = results[sourceId];
+            acc.results[sourceId] = {
+                proposedNames,
+                error,
+            };
+        }
+        return acc;
+    }, { results: {} });
+}, _NameController_getProviderResponse = async function _NameController_getProviderResponse(request, provider) {
+    const { value, type, sourceIds: requestedSourceIds, onlyUpdateAfterDelay, variation, } = request;
+    /* istanbul ignore next */
+    const variationKey = variation ?? DEFAULT_VARIATION;
+    const supportedSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getSourceIds).call(this, provider, type);
+    const currentTime = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getCurrentTimeSeconds).call(this);
+    const normalizedValue = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeValue).call(this, value, type);
+    const matchingSourceIds = supportedSourceIds.filter((sourceId) => {
+        if (requestedSourceIds && !requestedSourceIds.includes(sourceId)) {
+            return false;
+        }
+        if (onlyUpdateAfterDelay) {
+            const entry = this.state.names[type]?.[normalizedValue]?.[variationKey] ?? {};
+            const proposedNamesEntry = entry.proposedNames?.[sourceId] ?? {};
+            const lastRequestTime = proposedNamesEntry.lastRequestTime ?? 0;
+            const updateDelay = proposedNamesEntry.updateDelay ?? __classPrivateFieldGet(this, _NameController_updateDelay, "f");
+            if (currentTime - lastRequestTime < updateDelay) {
+                return false;
+            }
+        }
+        return true;
+    });
+    if (!matchingSourceIds.length) {
+        return undefined;
+    }
+    const providerRequest = {
+        value: __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeValue).call(this, value, type),
+        type,
+        sourceIds: requestedSourceIds ? matchingSourceIds : undefined,
+        variation: __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeVariation).call(this, variationKey, type),
+    };
+    let responseError;
+    let response;
+    try {
+        response = await provider.getProposedNames(providerRequest);
+        responseError = response.error;
+    }
+    catch (error) {
+        responseError = error;
+    }
+    return __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeProviderResult).call(this, response, responseError, matchingSourceIds);
+}, _NameController_normalizeProviderResult = function _NameController_normalizeProviderResult(result, responseError, matchingSourceIds) {
+    const error = responseError ?? undefined;
+    const results = matchingSourceIds.reduce((acc, sourceId) => {
+        const sourceResult = result?.results?.[sourceId];
+        const normalizedSourceResult = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeProviderSourceResult).call(this, sourceResult, responseError);
+        return {
+            ...acc,
+            [sourceId]: normalizedSourceResult,
+        };
+    }, {});
+    return { results, error };
+}, _NameController_normalizeProviderSourceResult = function _NameController_normalizeProviderSourceResult(result, responseError) {
+    const error = result?.error ?? responseError ?? undefined;
+    const updateDelay = result?.updateDelay ?? undefined;
+    let proposedNames = error
+        ? undefined
+        : (result?.proposedNames ?? undefined);
+    if (proposedNames) {
+        proposedNames = proposedNames.filter((proposedName) => proposedName?.length);
+    }
+    return {
+        proposedNames,
+        error,
+        updateDelay,
+    };
+}, _NameController_normalizeValue = function _NameController_normalizeValue(value, type) {
+    /* istanbul ignore next */
+    switch (type) {
+        case types_js_1.NameType.ETHEREUM_ADDRESS:
+            return value.toLowerCase();
+        default:
+            return value;
+    }
+}, _NameController_normalizeVariation = function _NameController_normalizeVariation(variation, type) {
+    /* istanbul ignore next */
+    switch (type) {
+        case types_js_1.NameType.ETHEREUM_ADDRESS:
+            return variation.toLowerCase();
+        default:
+            return variation;
+    }
+}, _NameController_updateEntry = function _NameController_updateEntry(value, type, variation, callback) {
+    /* istanbul ignore next */
+    const variationKey = variation ?? DEFAULT_VARIATION;
+    const normalizedValue = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeValue).call(this, value, type);
+    const normalizedVariation = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeVariation).call(this, variationKey, type);
+    if ([normalizedValue, normalizedVariation].some((key) => !(0, controller_utils_1.isSafeDynamicKey)(key))) {
+        return;
+    }
+    this.update((state) => {
+        const typeEntries = state.names[type] || {};
+        state.names[type] = typeEntries;
+        const variationEntries = typeEntries[normalizedValue] || {};
+        typeEntries[normalizedValue] = variationEntries;
+        const entry = variationEntries[normalizedVariation] ?? {
+            proposedNames: {},
+            name: null,
+            sourceId: null,
+            origin: null,
+        };
+        variationEntries[normalizedVariation] = entry;
+        callback(entry);
+    });
+}, _NameController_getCurrentTimeSeconds = function _NameController_getCurrentTimeSeconds() {
+    return Math.round(Date.now() / 1000);
+}, _NameController_validateSetNameRequest = function _NameController_validateSetNameRequest(request) {
+    const { name, value, type, sourceId, variation, origin } = request;
+    const errorMessages = [];
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateValue).call(this, value, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateType).call(this, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateName).call(this, name, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSourceId).call(this, sourceId, type, name, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateVariation).call(this, variation, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateOrigin).call(this, origin, name, errorMessages);
+    if (errorMessages.length) {
+        throw new Error(errorMessages.join(' '));
+    }
+}, _NameController_validateUpdateProposedNamesRequest = function _NameController_validateUpdateProposedNamesRequest(request) {
+    const { value, type, sourceIds, variation } = request;
+    const errorMessages = [];
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateValue).call(this, value, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateType).call(this, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSourceIds).call(this, sourceIds, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateDuplicateSourceIds).call(this, type, errorMessages);
+    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateVariation).call(this, variation, type, errorMessages);
+    if (errorMessages.length) {
+        throw new Error(errorMessages.join(' '));
+    }
+}, _NameController_validateValue = function _NameController_validateValue(value, errorMessages) {
+    if (!value?.length || typeof value !== 'string') {
+        errorMessages.push('Must specify a non-empty string for value.');
+    }
+}, _NameController_validateType = function _NameController_validateType(type, errorMessages) {
+    if (!Object.values(types_js_1.NameType).includes(type)) {
+        errorMessages.push(`Must specify one of the following types: ${Object.values(types_js_1.NameType).join(', ')}`);
+    }
+}, _NameController_validateName = function _NameController_validateName(name, errorMessages) {
+    if (name === null) {
+        return;
+    }
+    if (!name?.length || typeof name !== 'string') {
+        errorMessages.push('Must specify a non-empty string or null for name.');
+    }
+}, _NameController_validateSourceIds = function _NameController_validateSourceIds(sourceIds, type, errorMessages) {
+    if (!sourceIds) {
+        return;
+    }
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    const missingSourceIds = [];
+    for (const sourceId of sourceIds) {
+        if (!allSourceIds.includes(sourceId)) {
+            missingSourceIds.push(sourceId);
+            continue;
+        }
+    }
+    if (missingSourceIds.length) {
+        errorMessages.push(`Unknown source IDs for type '${type}': ${missingSourceIds.join(', ')}`);
+    }
+}, _NameController_validateSourceId = function _NameController_validateSourceId(sourceId, type, name, errorMessages) {
+    if (sourceId === null || sourceId === undefined) {
+        return;
+    }
+    if (name === null) {
+        errorMessages.push(`Cannot specify a source ID when clearing the saved name: ${sourceId}`);
+        return;
+    }
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    if (!sourceId.length || typeof sourceId !== 'string') {
+        errorMessages.push('Must specify a non-empty string for sourceId.');
+        return;
+    }
+    if (!allSourceIds.includes(sourceId)) {
+        errorMessages.push(`Unknown source ID for type '${type}': ${sourceId}`);
+    }
+}, _NameController_validateDuplicateSourceIds = function _NameController_validateDuplicateSourceIds(type, errorMessages) {
+    const allSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    const duplicateSourceIds = allSourceIds.filter((sourceId, index) => allSourceIds.indexOf(sourceId) !== index);
+    if (duplicateSourceIds.length) {
+        errorMessages.push(`Duplicate source IDs found for type '${type}': ${duplicateSourceIds.join(', ')}`);
+    }
+}, _NameController_validateVariation = function _NameController_validateVariation(variation, type, errorMessages) {
+    if (type !== types_js_1.NameType.ETHEREUM_ADDRESS) {
+        return;
+    }
+    if (!variation?.length ||
+        typeof variation !== 'string' ||
+        (!variation.match(/^0x[0-9A-Fa-f]+$/u) &&
+            variation !== exports.FALLBACK_VARIATION)) {
+        errorMessages.push(`Must specify a chain ID in hexadecimal format or the fallback, "${exports.FALLBACK_VARIATION}", for variation when using '${type}' type.`);
+    }
+}, _NameController_validateOrigin = function _NameController_validateOrigin(origin, name, errorMessages) {
+    if (!origin) {
+        return;
+    }
+    if (name === null) {
+        errorMessages.push(`Cannot specify an origin when clearing the saved name: ${origin}`);
+        return;
+    }
+    if (!Object.values(NameOrigin).includes(origin)) {
+        errorMessages.push(`Must specify one of the following origins: ${Object.values(NameOrigin).join(', ')}`);
+    }
+}, _NameController_getAllSourceIds = function _NameController_getAllSourceIds(type) {
+    return (__classPrivateFieldGet(this, _NameController_providers, "f")
+        /* istanbul ignore next */
+        .map((provider) => __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getSourceIds).call(this, provider, type))
+        .flat());
+}, _NameController_getSourceIds = function _NameController_getSourceIds(provider, type) {
+    return provider.getMetadata().sourceIds[type];
+}, _NameController_removeDormantProposedNames = function _NameController_removeDormantProposedNames(proposedNames, type) {
+    if (Object.keys(proposedNames).length === 0) {
+        return;
+    }
+    const typeSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getAllSourceIds).call(this, type);
+    const dormantSourceIds = Object.keys(proposedNames).filter((sourceId) => !typeSourceIds.includes(sourceId));
+    for (const dormantSourceId of dormantSourceIds) {
+        delete proposedNames[dormantSourceId];
+    }
+}, _NameController_removeExpiredEntries = function _NameController_removeExpiredEntries() {
+    const currentTime = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getCurrentTimeSeconds).call(this);
+    this.update((state) => {
+        const entries = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getEntriesList).call(this, state);
+        for (const { nameType, value, variation, entry } of entries) {
+            if (entry.name !== null) {
+                continue;
+            }
+            const proposedNames = Object.values(entry.proposedNames);
+            const allProposedNamesExpired = proposedNames.every((proposedName) => currentTime - (proposedName.lastRequestTime ?? 0) >=
+                exports.PROPOSED_NAME_EXPIRE_DURATION);
+            if (allProposedNamesExpired) {
+                delete state.names[nameType][value][variation];
+            }
+        }
+    });
+}, _NameController_getEntriesList = function _NameController_getEntriesList(state) {
+    return Object.entries(state.names).flatMap(([type, typeEntries]) => Object.entries(typeEntries).flatMap(([value, variationEntries]) => Object.entries(variationEntries).map(([variation, entry]) => ({
+        entry,
+        nameType: type,
+        value,
+        variation,
+    }))));
+};
+//# sourceMappingURL=NameController.cjs.map

package/dist/NameController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController.cjs","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,+DAA2D;AAC3D,iEAA8D;AAU9D,0CAAsC;AAEzB,QAAA,kBAAkB,GAAG,GAAG,CAAC;AACzB,QAAA,6BAA6B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,WAAW;AAEtE;;GAEG;AACH,IAAY,UASX;AATD,WAAY,UAAU;IACpB,uCAAuC;IACvC,mDAAqC,CAAA;IACrC,yCAAyC;IACzC,2CAA6B,CAAA;IAC7B,yEAAyE;IACzE,yBAAW,CAAA;IACX,oDAAoD;IACpD,uBAAS,CAAA;AACX,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAED,MAAM,oBAAoB,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,YAAY;AACjD,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAE7B,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAExC,MAAM,yBAAyB,GAAG,CAAC,SAAS,EAAE,qBAAqB,CAAU,CAAC;AAE9E,MAAM,aAAa,GAAG;IACpB,KAAK,EAAE;QACL,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,KAAK,EAAE;QACL,CAAC,mBAAQ,CAAC,gBAAgB,CAAC,EAAE,EAAE;KAChC;IACD,WAAW,EAAE,EAAE;CAChB,CAAC,CAAC;AAyEH;;GAEG;AACH,MAAa,cAAe,SAAQ,gCAInC;IAKC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,SAAS,EACT,KAAK,EACL,WAAW,GACW;QACtB,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,GAAG,KAAK,EAAE;SAC1C,CAAC,CAAC;;QAxBI,4CAA2B;QAE3B,8CAAqB;QAwB5B,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,+BAAgB,WAAW,IAAI,oBAAoB,MAAA,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAuB;QAC7B,uBAAA,IAAI,yEAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAAC;QAEtC,MAAM,EACJ,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,QAAQ,EAAE,eAAe,EACzB,MAAM,EAAE,aAAa,EACrB,SAAS,GACV,GAAG,OAAO,CAAC;QACZ,MAAM,QAAQ,GAAG,eAAe,IAAI,IAAI,CAAC;QACzC,+EAA+E;QAC/E,MAAM,cAAc,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;QAC7D,MAAM,MAAM,GAAG,aAAa,IAAI,cAAc,CAAC;QAE/C,uBAAA,IAAI,8DAAa,MAAjB,IAAI,EAAc,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAgB,EAAE,EAAE;YAC7D,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;YAClB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC1B,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAmC;QAEnC,uBAAA,IAAI,qFAAoC,MAAxC,IAAI,EAAqC,OAAO,CAAC,CAAC;QAElD,MAAM,iBAAiB,GAAG,CACxB,MAAM,OAAO,CAAC,GAAG,CACf,uBAAA,IAAI,iCAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/B,uBAAA,IAAI,sEAAqB,MAAzB,IAAI,EAAsB,OAAO,EAAE,QAAQ,CAAC,CAC7C,CACF,CACF,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAyB,CAAC;QAElE,uBAAA,IAAI,0EAAyB,MAA7B,IAAI,EAA0B,OAAO,EAAE,iBAAiB,CAAC,CAAC;QAC1D,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,uBAAA,IAAI,iCAAW,CAAC,CAAC;QACzC,uBAAA,IAAI,uEAAsB,MAA1B,IAAI,CAAwB,CAAC;QAE7B,OAAO,uBAAA,IAAI,+EAA8B,MAAlC,IAAI,EAA+B,iBAAiB,CAAC,CAAC;IAC/D,CAAC;CAsfF;AA3lBD,wCA2lBC;8NAnfG,OAAmC,EACnC,iBAAuC;IAEvC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAC3C,MAAM,WAAW,GAAG,uBAAA,IAAI,wEAAuB,MAA3B,IAAI,CAAyB,CAAC;IAElD,uBAAA,IAAI,8DAAa,MAAjB,IAAI,EAAc,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAgB,EAAE,EAAE;QAC7D,uBAAA,IAAI,6EAA4B,MAAhC,IAAI,EAA6B,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAE5D,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE,CAAC;YACjD,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC;YAErC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACjC,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;gBAE9C,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI;oBACzD,aAAa,EAAE,EAAE;oBACjB,eAAe,EAAE,IAAI;oBACrB,WAAW,EAAE,IAAI;iBAClB,CAAC;gBAEF,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC;gBAElD,IAAI,aAAa,EAAE,CAAC;oBAClB,iBAAiB,CAAC,aAAa,GAAG,aAAa,CAAC;gBAClD,CAAC;gBAED,iBAAiB,CAAC,eAAe,GAAG,WAAW,CAAC;gBAChD,iBAAiB,CAAC,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC;YACtD,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,iFAEkB,SAAyB;IAC1C,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAErD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;QAEhD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACjD,cAAc,CAAC,QAAQ,CAAC,GAAG;gBACzB,KAAK,EAAE,YAAY,CAAC,QAAQ,CAAC;aAC9B,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,WAAW,GAAG,cAAc,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uGAGC,iBAAuC;IAEvC,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAA8B,EAAE,gBAAgB,EAAE,EAAE;QACnD,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,CAAC;QAErC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEnD,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG;gBACtB,aAAa;gBACb,KAAK;aACN,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,OAAO,EAAE,EAAE,EAAE,CAChB,CAAC;AACJ,CAAC,wCAED,KAAK,8CACH,OAAmC,EACnC,QAAsB;IAEtB,MAAM,EACJ,KAAK,EACL,IAAI,EACJ,SAAS,EAAE,kBAAkB,EAC7B,oBAAoB,EACpB,SAAS,GACV,GAAG,OAAO,CAAC;IAEZ,0BAA0B;IAC1B,MAAM,YAAY,GAAG,SAAS,IAAI,iBAAiB,CAAC;IACpD,MAAM,kBAAkB,GAAG,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAG,uBAAA,IAAI,wEAAuB,MAA3B,IAAI,CAAyB,CAAC;IAClD,MAAM,eAAe,GAAG,uBAAA,IAAI,iEAAgB,MAApB,IAAI,EAAiB,KAAK,EAAE,IAAI,CAAC,CAAC;IAE1D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC/D,IAAI,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,oBAAoB,EAAE,CAAC;YACzB,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAClE,MAAM,kBAAkB,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACjE,MAAM,eAAe,GAAG,kBAAkB,CAAC,eAAe,IAAI,CAAC,CAAC;YAChE,MAAM,WAAW,GAAG,kBAAkB,CAAC,WAAW,IAAI,uBAAA,IAAI,mCAAa,CAAC;YAExE,IAAI,WAAW,GAAG,eAAe,GAAG,WAAW,EAAE,CAAC;gBAChD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,eAAe,GAAwB;QAC3C,KAAK,EAAE,uBAAA,IAAI,iEAAgB,MAApB,IAAI,EAAiB,KAAK,EAAE,IAAI,CAAC;QACxC,IAAI;QACJ,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;QAC7D,SAAS,EAAE,uBAAA,IAAI,qEAAoB,MAAxB,IAAI,EAAqB,YAAY,EAAE,IAAI,CAAC;KACxD,CAAC;IAEF,IAAI,aAAkC,CAAC;IACvC,IAAI,QAAwC,CAAC;IAE7C,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC5D,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,OAAO,uBAAA,IAAI,0EAAyB,MAA7B,IAAI,EACT,QAAQ,EACR,aAAa,EACb,iBAAiB,CAClB,CAAC;AACJ,CAAC,6FAGC,MAAsC,EACtC,aAAsB,EACtB,iBAA2B;IAE3B,MAAM,KAAK,GAAG,aAAa,IAAI,SAAS,CAAC;IAEzC,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;QACzD,MAAM,YAAY,GAAG,MAAM,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;QAEjD,MAAM,sBAAsB,GAAG,uBAAA,IAAI,gFAA+B,MAAnC,IAAI,EACjC,YAAY,EACZ,aAAa,CACd,CAAC;QAEF,OAAO;YACL,GAAG,GAAG;YACN,CAAC,QAAQ,CAAC,EAAE,sBAAsB;SACnC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC,yGAGC,MAA4C,EAC5C,aAAsB;IAEtB,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,aAAa,IAAI,SAAS,CAAC;IAC1D,MAAM,WAAW,GAAG,MAAM,EAAE,WAAW,IAAI,SAAS,CAAC;IACrD,IAAI,aAAa,GAAG,KAAK;QACvB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,CAAC,MAAM,EAAE,aAAa,IAAI,SAAS,CAAC,CAAC;IAEzC,IAAI,aAAa,EAAE,CAAC;QAClB,aAAa,GAAG,aAAa,CAAC,MAAM,CAClC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,EAAE,MAAM,CACvC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,aAAa;QACb,KAAK;QACL,WAAW;KACZ,CAAC;AACJ,CAAC,2EAEe,KAAa,EAAE,IAAc;IAC3C,0BAA0B;IAC1B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,mBAAQ,CAAC,gBAAgB;YAC5B,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;QAE7B;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC,mFAEmB,SAAiB,EAAE,IAAc;IACnD,0BAA0B;IAC1B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,mBAAQ,CAAC,gBAAgB;YAC5B,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC;QAEjC;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC,qEAGC,KAAa,EACb,IAAc,EACd,SAA6B,EAC7B,QAAoC;IAEpC,0BAA0B;IAC1B,MAAM,YAAY,GAAG,SAAS,IAAI,iBAAiB,CAAC;IACpD,MAAM,eAAe,GAAG,uBAAA,IAAI,iEAAgB,MAApB,IAAI,EAAiB,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1D,MAAM,mBAAmB,GAAG,uBAAA,IAAI,qEAAoB,MAAxB,IAAI,EAAqB,YAAY,EAAE,IAAI,CAAC,CAAC;IAEzE,IACE,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC,IAAI,CACzC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAA,mCAAgB,EAAC,GAAG,CAAC,CAChC,EACD,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5C,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;QAEhC,MAAM,gBAAgB,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;QAC5D,WAAW,CAAC,eAAe,CAAC,GAAG,gBAAgB,CAAC;QAEhD,MAAM,KAAK,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,IAAI;YACrD,aAAa,EAAE,EAAE;YACjB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC;QACF,gBAAgB,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC;QAE9C,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;IAGC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC,2FAEuB,OAAuB;IAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACnE,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,uBAAA,IAAI,gEAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,aAAa,CAAC,CAAC;IAC1C,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,mEAAkB,MAAtB,IAAI,EAAmB,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAC5D,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACxD,uBAAA,IAAI,iEAAgB,MAApB,IAAI,EAAiB,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAElD,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC,mHAEmC,OAAmC;IACrE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACtD,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,uBAAA,IAAI,gEAAe,MAAnB,IAAI,EAAgB,KAAK,EAAE,aAAa,CAAC,CAAC;IAC1C,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,IAAI,EAAE,aAAa,CAAC,CAAC;IACxC,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACxD,uBAAA,IAAI,6EAA4B,MAAhC,IAAI,EAA6B,IAAI,EAAE,aAAa,CAAC,CAAC;IACtD,uBAAA,IAAI,oEAAmB,MAAvB,IAAI,EAAoB,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IAExD,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC,yEAEc,KAAa,EAAE,aAAuB;IACnD,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,aAAa,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACnE,CAAC;AACH,CAAC,uEAEa,IAAc,EAAE,aAAuB;IACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,mBAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,aAAa,CAAC,IAAI,CAChB,4CAA4C,MAAM,CAAC,MAAM,CACvD,mBAAQ,CACT,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;IACJ,CAAC;AACH,CAAC,uEAEa,IAAmB,EAAE,aAAuB;IACxD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9C,aAAa,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,iFAGC,SAA+B,EAC/B,IAAc,EACd,aAAuB;IAEvB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,SAAS;QACX,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAC5B,aAAa,CAAC,IAAI,CAChB,gCAAgC,IAAI,MAAM,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxE,CAAC;IACJ,CAAC;AACH,CAAC,+EAGC,QAA4B,EAC5B,IAAc,EACd,IAAmB,EACnB,aAAuB;IAEvB,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChD,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,aAAa,CAAC,IAAI,CAChB,4DAA4D,QAAQ,EAAE,CACvE,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IAEjD,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACrD,aAAa,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QACpE,OAAO;IACT,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,aAAa,CAAC,IAAI,CAAC,+BAA+B,IAAI,MAAM,QAAQ,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,mGAE2B,IAAc,EAAE,aAAuB;IACjE,MAAM,YAAY,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IAEjD,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAC5C,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,KAAK,CAC9D,CAAC;IAEF,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAC9B,aAAa,CAAC,IAAI,CAChB,wCAAwC,IAAI,MAAM,kBAAkB,CAAC,IAAI,CACvE,IAAI,CACL,EAAE,CACJ,CAAC;IACJ,CAAC;AACH,CAAC,iFAGC,SAA6B,EAC7B,IAAY,EACZ,aAAuB;IAEvB,IAAI,IAAI,KAAK,mBAAQ,CAAC,gBAAgB,EAAE,CAAC;QACvC,OAAO;IACT,CAAC;IAED,IACE,CAAC,SAAS,EAAE,MAAM;QAClB,OAAO,SAAS,KAAK,QAAQ;QAC7B,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,mBAAmB,CAAC;YACpC,SAAS,KAAK,0BAAkB,CAAC,EACnC,CAAC;QACD,aAAa,CAAC,IAAI,CAChB,mEAAmE,0BAAkB,gCAAgC,IAAI,SAAS,CACnI,CAAC;IACJ,CAAC;AACH,CAAC,2EAGC,MAAqC,EACrC,IAAmB,EACnB,aAAuB;IAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,aAAa,CAAC,IAAI,CAChB,0DAA0D,MAAM,EAAE,CACnE,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,aAAa,CAAC,IAAI,CAChB,8CAA8C,MAAM,CAAC,MAAM,CACzD,UAAU,CACX,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;IACJ,CAAC;AACH,CAAC,6EAEgB,IAAc;IAC7B,OAAO,CACL,uBAAA,IAAI,iCAAW;QACb,0BAA0B;SACzB,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,uBAAA,IAAI,+DAAc,MAAlB,IAAI,EAAe,QAAQ,EAAE,IAAI,CAAC,CAAC;SACrD,IAAI,EAAE,CACV,CAAC;AACJ,CAAC,uEAEa,QAAsB,EAAE,IAAc;IAClD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC,mGAGC,aAAiD,EACjD,IAAc;IAEd,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5C,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG,uBAAA,IAAI,kEAAiB,MAArB,IAAI,EAAkB,IAAI,CAAC,CAAC;IAElD,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CACxD,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAChD,CAAC;IAEF,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;QAC/C,OAAO,aAAa,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC;AACH,CAAC;IAGC,MAAM,WAAW,GAAG,uBAAA,IAAI,wEAAuB,MAA3B,IAAI,CAAyB,CAAC;IAElD,IAAI,CAAC,MAAM,CAAC,CAAC,KAA0B,EAAE,EAAE;QACzC,MAAM,OAAO,GAAG,uBAAA,IAAI,iEAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,CAAC;QAC5C,KAAK,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,OAAO,EAAE,CAAC;YAC5D,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACzD,MAAM,uBAAuB,GAAG,aAAa,CAAC,KAAK,CACjD,CAAC,YAAgC,EAAE,EAAE,CACnC,WAAW,GAAG,CAAC,YAAY,CAAC,eAAe,IAAI,CAAC,CAAC;gBACjD,qCAA6B,CAChC,CAAC;YAEF,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,2EAEe,KAA0B;IAMxC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,CACjE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,EAAE,EAAE,CAChE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5D,KAAK;QACL,QAAQ,EAAE,IAAgB;QAC1B,KAAK;QACL,SAAS;KACV,CAAC,CAAC,CACJ,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { isSafeDynamicKey } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { NameControllerMethodActions } from './NameController-method-action-types.js';\nimport type {\n  NameProvider,\n  NameProviderRequest,\n  NameProviderResult,\n  NameProviderSourceResult,\n} from './types.js';\nimport { NameType } from './types.js';\n\nexport const FALLBACK_VARIATION = '*';\nexport const PROPOSED_NAME_EXPIRE_DURATION = 60 * 60 * 24; // 24 hours\n\n/**\n * Enumerates the possible origins responsible for setting a petname.\n */\nexport enum NameOrigin {\n  // Originated from an account identity.\n  ACCOUNT_IDENTITY = 'account-identity',\n  // Originated from an address book entry.\n  ADDRESS_BOOK = 'address-book',\n  // Originated from the API (NameController.setName). This is the default.\n  API = 'api',\n  // Originated from the user taking action in the UI.\n  UI = 'ui',\n}\n\nconst DEFAULT_UPDATE_DELAY = 60 * 2; // 2 Minutes\nconst DEFAULT_VARIATION = '';\n\nconst controllerName = 'NameController';\n\nconst MESSENGER_EXPOSED_METHODS = ['setName', 'updateProposedNames'] as const;\n\nconst stateMetadata = {\n  names: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n  nameSources: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n};\n\nconst getDefaultState = () => ({\n  names: {\n    [NameType.ETHEREUM_ADDRESS]: {},\n  },\n  nameSources: {},\n});\n\nexport type ProposedNamesEntry = {\n  proposedNames: string[];\n  lastRequestTime: number | null;\n  updateDelay: number | null;\n};\n\nexport type NameEntry = {\n  name: string | null;\n  sourceId: string | null;\n  origin: NameOrigin | null;\n  proposedNames: Record<string, ProposedNamesEntry>;\n};\n\nexport type SourceEntry = {\n  label: string;\n};\n\nexport type NameControllerState = {\n  // Type > Value > Variation > Entry\n  names: Record<NameType, Record<string, Record<string, NameEntry>>>;\n  nameSources: Record<string, SourceEntry>;\n};\n\nexport type GetNameState = ControllerGetStateAction<\n  typeof controllerName,\n  NameControllerState\n>;\n\nexport type NameStateChange = ControllerStateChangeEvent<\n  typeof controllerName,\n  NameControllerState\n>;\n\nexport type NameControllerActions = GetNameState | NameControllerMethodActions;\n\nexport type NameControllerEvents = NameStateChange;\n\nexport type NameControllerMessenger = Messenger<\n  typeof controllerName,\n  NameControllerActions,\n  NameControllerEvents\n>;\n\nexport type NameControllerOptions = {\n  messenger: NameControllerMessenger;\n  providers: NameProvider[];\n  state?: Partial<NameControllerState>;\n  updateDelay?: number;\n};\n\nexport type UpdateProposedNamesRequest = {\n  value: string;\n  type: NameType;\n  sourceIds?: string[];\n  onlyUpdateAfterDelay?: boolean;\n  variation?: string;\n};\n\nexport type UpdateProposedNamesResult = {\n  results: Record<string, { proposedNames?: string[]; error?: unknown }>;\n};\n\nexport type SetNameRequest = {\n  value: string;\n  type: NameType;\n  name: string | null;\n  sourceId?: string;\n  variation?: string;\n  origin?: NameOrigin;\n};\n\n/**\n * Controller for storing and deriving names for values such as Ethereum addresses.\n */\nexport class NameController extends BaseController<\n  typeof controllerName,\n  NameControllerState,\n  NameControllerMessenger\n> {\n  readonly #providers: NameProvider[];\n\n  readonly #updateDelay: number;\n\n  /**\n   * Construct a Name controller.\n   *\n   * @param options - Controller options.\n   * @param options.messenger - Restricted messenger for the name controller.\n   * @param options.providers - Array of name provider instances to propose names.\n   * @param options.state - Initial state to set on the controller.\n   * @param options.updateDelay - The delay in seconds before a new request to a source should be made.\n   */\n  constructor({\n    messenger,\n    providers,\n    state,\n    updateDelay,\n  }: NameControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: stateMetadata,\n      messenger,\n      state: { ...getDefaultState(), ...state },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.#providers = providers;\n    this.#updateDelay = updateDelay ?? DEFAULT_UPDATE_DELAY;\n  }\n\n  /**\n   * Set the user specified name for a value.\n   *\n   * @param request - Request object.\n   * @param request.name - Name to set.\n   * @param request.sourceId - Optional ID of the source of the proposed name.\n   * @param request.type - Type of value to set the name for.\n   * @param request.value - Value to set the name for.\n   * @param request.variation - Variation of the raw value to set the name for. The chain ID if the type is Ethereum address.\n   */\n  setName(request: SetNameRequest) {\n    this.#validateSetNameRequest(request);\n\n    const {\n      value,\n      type,\n      name,\n      sourceId: requestSourceId,\n      origin: requestOrigin,\n      variation,\n    } = request;\n    const sourceId = requestSourceId ?? null;\n    // If the name is being cleared, the fallback origin should be cleared as well.\n    const fallbackOrigin = name === null ? null : NameOrigin.API;\n    const origin = requestOrigin ?? fallbackOrigin;\n\n    this.#updateEntry(value, type, variation, (entry: NameEntry) => {\n      entry.name = name;\n      entry.sourceId = sourceId;\n      entry.origin = origin;\n    });\n  }\n\n  /**\n   * Generate the proposed names for a value using the name providers and store them in the state.\n   *\n   * @param request - Request object.\n   * @param request.value - Value to update the proposed names for.\n   * @param request.type - Type of value to update the proposed names for.\n   * @param request.sourceIds - Optional array of source IDs to limit which sources are used by the providers. If not provided, all sources in all providers will be used.\n   * @param request.variation - Variation of the raw value to update proposed names for. The chain ID if the type is Ethereum address.\n   * @returns The updated proposed names for the value.\n   */\n  async updateProposedNames(\n    request: UpdateProposedNamesRequest,\n  ): Promise<UpdateProposedNamesResult> {\n    this.#validateUpdateProposedNamesRequest(request);\n\n    const providerResponses = (\n      await Promise.all(\n        this.#providers.map((provider) =>\n          this.#getProviderResponse(request, provider),\n        ),\n      )\n    ).filter((response) => Boolean(response)) as NameProviderResult[];\n\n    this.#updateProposedNameState(request, providerResponses);\n    this.#updateSourceState(this.#providers);\n    this.#removeExpiredEntries();\n\n    return this.#getUpdateProposedNamesResult(providerResponses);\n  }\n\n  #updateProposedNameState(\n    request: UpdateProposedNamesRequest,\n    providerResponses: NameProviderResult[],\n  ) {\n    const { value, type, variation } = request;\n    const currentTime = this.#getCurrentTimeSeconds();\n\n    this.#updateEntry(value, type, variation, (entry: NameEntry) => {\n      this.#removeDormantProposedNames(entry.proposedNames, type);\n\n      for (const providerResponse of providerResponses) {\n        const { results } = providerResponse;\n\n        for (const sourceId of Object.keys(providerResponse.results)) {\n          const result = results[sourceId];\n          const { proposedNames, updateDelay } = result;\n\n          const proposedNameEntry = entry.proposedNames[sourceId] ?? {\n            proposedNames: [],\n            lastRequestTime: null,\n            updateDelay: null,\n          };\n\n          entry.proposedNames[sourceId] = proposedNameEntry;\n\n          if (proposedNames) {\n            proposedNameEntry.proposedNames = proposedNames;\n          }\n\n          proposedNameEntry.lastRequestTime = currentTime;\n          proposedNameEntry.updateDelay = updateDelay ?? null;\n        }\n      }\n    });\n  }\n\n  #updateSourceState(providers: NameProvider[]) {\n    const newNameSources = { ...this.state.nameSources };\n\n    for (const provider of providers) {\n      const { sourceLabels } = provider.getMetadata();\n\n      for (const sourceId of Object.keys(sourceLabels)) {\n        newNameSources[sourceId] = {\n          label: sourceLabels[sourceId],\n        };\n      }\n    }\n\n    this.update((state) => {\n      state.nameSources = newNameSources;\n    });\n  }\n\n  #getUpdateProposedNamesResult(\n    providerResponses: NameProviderResult[],\n  ): UpdateProposedNamesResult {\n    return providerResponses.reduce(\n      (acc: UpdateProposedNamesResult, providerResponse) => {\n        const { results } = providerResponse;\n\n        for (const sourceId of Object.keys(results)) {\n          const { proposedNames, error } = results[sourceId];\n\n          acc.results[sourceId] = {\n            proposedNames,\n            error,\n          };\n        }\n\n        return acc;\n      },\n      { results: {} },\n    );\n  }\n\n  async #getProviderResponse(\n    request: UpdateProposedNamesRequest,\n    provider: NameProvider,\n  ): Promise<NameProviderResult | undefined> {\n    const {\n      value,\n      type,\n      sourceIds: requestedSourceIds,\n      onlyUpdateAfterDelay,\n      variation,\n    } = request;\n\n    /* istanbul ignore next */\n    const variationKey = variation ?? DEFAULT_VARIATION;\n    const supportedSourceIds = this.#getSourceIds(provider, type);\n    const currentTime = this.#getCurrentTimeSeconds();\n    const normalizedValue = this.#normalizeValue(value, type);\n\n    const matchingSourceIds = supportedSourceIds.filter((sourceId) => {\n      if (requestedSourceIds && !requestedSourceIds.includes(sourceId)) {\n        return false;\n      }\n\n      if (onlyUpdateAfterDelay) {\n        const entry =\n          this.state.names[type]?.[normalizedValue]?.[variationKey] ?? {};\n        const proposedNamesEntry = entry.proposedNames?.[sourceId] ?? {};\n        const lastRequestTime = proposedNamesEntry.lastRequestTime ?? 0;\n        const updateDelay = proposedNamesEntry.updateDelay ?? this.#updateDelay;\n\n        if (currentTime - lastRequestTime < updateDelay) {\n          return false;\n        }\n      }\n\n      return true;\n    });\n\n    if (!matchingSourceIds.length) {\n      return undefined;\n    }\n\n    const providerRequest: NameProviderRequest = {\n      value: this.#normalizeValue(value, type),\n      type,\n      sourceIds: requestedSourceIds ? matchingSourceIds : undefined,\n      variation: this.#normalizeVariation(variationKey, type),\n    };\n\n    let responseError: unknown | undefined;\n    let response: NameProviderResult | undefined;\n\n    try {\n      response = await provider.getProposedNames(providerRequest);\n      responseError = response.error;\n    } catch (error) {\n      responseError = error;\n    }\n\n    return this.#normalizeProviderResult(\n      response,\n      responseError,\n      matchingSourceIds,\n    );\n  }\n\n  #normalizeProviderResult(\n    result: NameProviderResult | undefined,\n    responseError: unknown,\n    matchingSourceIds: string[],\n  ): NameProviderResult {\n    const error = responseError ?? undefined;\n\n    const results = matchingSourceIds.reduce((acc, sourceId) => {\n      const sourceResult = result?.results?.[sourceId];\n\n      const normalizedSourceResult = this.#normalizeProviderSourceResult(\n        sourceResult,\n        responseError,\n      );\n\n      return {\n        ...acc,\n        [sourceId]: normalizedSourceResult,\n      };\n    }, {});\n\n    return { results, error };\n  }\n\n  #normalizeProviderSourceResult(\n    result: NameProviderSourceResult | undefined,\n    responseError: unknown,\n  ): NameProviderSourceResult | undefined {\n    const error = result?.error ?? responseError ?? undefined;\n    const updateDelay = result?.updateDelay ?? undefined;\n    let proposedNames = error\n      ? undefined\n      : (result?.proposedNames ?? undefined);\n\n    if (proposedNames) {\n      proposedNames = proposedNames.filter(\n        (proposedName) => proposedName?.length,\n      );\n    }\n\n    return {\n      proposedNames,\n      error,\n      updateDelay,\n    };\n  }\n\n  #normalizeValue(value: string, type: NameType): string {\n    /* istanbul ignore next */\n    switch (type) {\n      case NameType.ETHEREUM_ADDRESS:\n        return value.toLowerCase();\n\n      default:\n        return value;\n    }\n  }\n\n  #normalizeVariation(variation: string, type: NameType): string {\n    /* istanbul ignore next */\n    switch (type) {\n      case NameType.ETHEREUM_ADDRESS:\n        return variation.toLowerCase();\n\n      default:\n        return variation;\n    }\n  }\n\n  #updateEntry(\n    value: string,\n    type: NameType,\n    variation: string | undefined,\n    callback: (entry: NameEntry) => void,\n  ) {\n    /* istanbul ignore next */\n    const variationKey = variation ?? DEFAULT_VARIATION;\n    const normalizedValue = this.#normalizeValue(value, type);\n    const normalizedVariation = this.#normalizeVariation(variationKey, type);\n\n    if (\n      [normalizedValue, normalizedVariation].some(\n        (key) => !isSafeDynamicKey(key),\n      )\n    ) {\n      return;\n    }\n\n    this.update((state) => {\n      const typeEntries = state.names[type] || {};\n      state.names[type] = typeEntries;\n\n      const variationEntries = typeEntries[normalizedValue] || {};\n      typeEntries[normalizedValue] = variationEntries;\n\n      const entry = variationEntries[normalizedVariation] ?? {\n        proposedNames: {},\n        name: null,\n        sourceId: null,\n        origin: null,\n      };\n      variationEntries[normalizedVariation] = entry;\n\n      callback(entry);\n    });\n  }\n\n  #getCurrentTimeSeconds(): number {\n    return Math.round(Date.now() / 1000);\n  }\n\n  #validateSetNameRequest(request: SetNameRequest) {\n    const { name, value, type, sourceId, variation, origin } = request;\n    const errorMessages: string[] = [];\n\n    this.#validateValue(value, errorMessages);\n    this.#validateType(type, errorMessages);\n    this.#validateName(name, errorMessages);\n    this.#validateSourceId(sourceId, type, name, errorMessages);\n    this.#validateVariation(variation, type, errorMessages);\n    this.#validateOrigin(origin, name, errorMessages);\n\n    if (errorMessages.length) {\n      throw new Error(errorMessages.join(' '));\n    }\n  }\n\n  #validateUpdateProposedNamesRequest(request: UpdateProposedNamesRequest) {\n    const { value, type, sourceIds, variation } = request;\n    const errorMessages: string[] = [];\n\n    this.#validateValue(value, errorMessages);\n    this.#validateType(type, errorMessages);\n    this.#validateSourceIds(sourceIds, type, errorMessages);\n    this.#validateDuplicateSourceIds(type, errorMessages);\n    this.#validateVariation(variation, type, errorMessages);\n\n    if (errorMessages.length) {\n      throw new Error(errorMessages.join(' '));\n    }\n  }\n\n  #validateValue(value: string, errorMessages: string[]) {\n    if (!value?.length || typeof value !== 'string') {\n      errorMessages.push('Must specify a non-empty string for value.');\n    }\n  }\n\n  #validateType(type: NameType, errorMessages: string[]) {\n    if (!Object.values(NameType).includes(type)) {\n      errorMessages.push(\n        `Must specify one of the following types: ${Object.values(\n          NameType,\n        ).join(', ')}`,\n      );\n    }\n  }\n\n  #validateName(name: string | null, errorMessages: string[]) {\n    if (name === null) {\n      return;\n    }\n\n    if (!name?.length || typeof name !== 'string') {\n      errorMessages.push('Must specify a non-empty string or null for name.');\n    }\n  }\n\n  #validateSourceIds(\n    sourceIds: string[] | undefined,\n    type: NameType,\n    errorMessages: string[],\n  ) {\n    if (!sourceIds) {\n      return;\n    }\n\n    const allSourceIds = this.#getAllSourceIds(type);\n    const missingSourceIds = [];\n\n    for (const sourceId of sourceIds) {\n      if (!allSourceIds.includes(sourceId)) {\n        missingSourceIds.push(sourceId);\n        continue;\n      }\n    }\n\n    if (missingSourceIds.length) {\n      errorMessages.push(\n        `Unknown source IDs for type '${type}': ${missingSourceIds.join(', ')}`,\n      );\n    }\n  }\n\n  #validateSourceId(\n    sourceId: string | undefined,\n    type: NameType,\n    name: string | null,\n    errorMessages: string[],\n  ) {\n    if (sourceId === null || sourceId === undefined) {\n      return;\n    }\n\n    if (name === null) {\n      errorMessages.push(\n        `Cannot specify a source ID when clearing the saved name: ${sourceId}`,\n      );\n      return;\n    }\n\n    const allSourceIds = this.#getAllSourceIds(type);\n\n    if (!sourceId.length || typeof sourceId !== 'string') {\n      errorMessages.push('Must specify a non-empty string for sourceId.');\n      return;\n    }\n\n    if (!allSourceIds.includes(sourceId)) {\n      errorMessages.push(`Unknown source ID for type '${type}': ${sourceId}`);\n    }\n  }\n\n  #validateDuplicateSourceIds(type: NameType, errorMessages: string[]) {\n    const allSourceIds = this.#getAllSourceIds(type);\n\n    const duplicateSourceIds = allSourceIds.filter(\n      (sourceId, index) => allSourceIds.indexOf(sourceId) !== index,\n    );\n\n    if (duplicateSourceIds.length) {\n      errorMessages.push(\n        `Duplicate source IDs found for type '${type}': ${duplicateSourceIds.join(\n          ', ',\n        )}`,\n      );\n    }\n  }\n\n  #validateVariation(\n    variation: string | undefined,\n    type: string,\n    errorMessages: string[],\n  ) {\n    if (type !== NameType.ETHEREUM_ADDRESS) {\n      return;\n    }\n\n    if (\n      !variation?.length ||\n      typeof variation !== 'string' ||\n      (!variation.match(/^0x[0-9A-Fa-f]+$/u) &&\n        variation !== FALLBACK_VARIATION)\n    ) {\n      errorMessages.push(\n        `Must specify a chain ID in hexadecimal format or the fallback, \"${FALLBACK_VARIATION}\", for variation when using '${type}' type.`,\n      );\n    }\n  }\n\n  #validateOrigin(\n    origin: NameOrigin | null | undefined,\n    name: string | null,\n    errorMessages: string[],\n  ) {\n    if (!origin) {\n      return;\n    }\n\n    if (name === null) {\n      errorMessages.push(\n        `Cannot specify an origin when clearing the saved name: ${origin}`,\n      );\n      return;\n    }\n\n    if (!Object.values(NameOrigin).includes(origin)) {\n      errorMessages.push(\n        `Must specify one of the following origins: ${Object.values(\n          NameOrigin,\n        ).join(', ')}`,\n      );\n    }\n  }\n\n  #getAllSourceIds(type: NameType): string[] {\n    return (\n      this.#providers\n        /* istanbul ignore next */\n        .map((provider) => this.#getSourceIds(provider, type))\n        .flat()\n    );\n  }\n\n  #getSourceIds(provider: NameProvider, type: NameType): string[] {\n    return provider.getMetadata().sourceIds[type];\n  }\n\n  #removeDormantProposedNames(\n    proposedNames: Record<string, ProposedNamesEntry>,\n    type: NameType,\n  ) {\n    if (Object.keys(proposedNames).length === 0) {\n      return;\n    }\n\n    const typeSourceIds = this.#getAllSourceIds(type);\n\n    const dormantSourceIds = Object.keys(proposedNames).filter(\n      (sourceId) => !typeSourceIds.includes(sourceId),\n    );\n\n    for (const dormantSourceId of dormantSourceIds) {\n      delete proposedNames[dormantSourceId];\n    }\n  }\n\n  #removeExpiredEntries(): void {\n    const currentTime = this.#getCurrentTimeSeconds();\n\n    this.update((state: NameControllerState) => {\n      const entries = this.#getEntriesList(state);\n      for (const { nameType, value, variation, entry } of entries) {\n        if (entry.name !== null) {\n          continue;\n        }\n\n        const proposedNames = Object.values(entry.proposedNames);\n        const allProposedNamesExpired = proposedNames.every(\n          (proposedName: ProposedNamesEntry) =>\n            currentTime - (proposedName.lastRequestTime ?? 0) >=\n            PROPOSED_NAME_EXPIRE_DURATION,\n        );\n\n        if (allProposedNamesExpired) {\n          delete state.names[nameType][value][variation];\n        }\n      }\n    });\n  }\n\n  #getEntriesList(state: NameControllerState): {\n    nameType: NameType;\n    value: string;\n    variation: string;\n    entry: NameEntry;\n  }[] {\n    return Object.entries(state.names).flatMap(([type, typeEntries]) =>\n      Object.entries(typeEntries).flatMap(([value, variationEntries]) =>\n        Object.entries(variationEntries).map(([variation, entry]) => ({\n          entry,\n          nameType: type as NameType,\n          value,\n          variation,\n        })),\n      ),\n    );\n  }\n}\n"]}

package/dist/{NameController.d.ts → NameController.d.cts}

@@ -1,9 +1,9 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { Messenger } from '@metamask/messenger';
-import type { NameControllerMethodActions } from './NameController-method-action-types.js';
-import type { NameProvider } from './types.js';
-import { NameType } from './types.js';
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { NameControllerMethodActions } from "./NameController-method-action-types.cjs";
+import type { NameProvider } from "./types.cjs";
+import { NameType } from "./types.cjs";
 export declare const FALLBACK_VARIATION = "*";
 export declare const PROPOSED_NAME_EXPIRE_DURATION: number;
 /**
@@ -105,4 +105,4 @@ export declare class NameController extends BaseController<typeof controllerName
     updateProposedNames(request: UpdateProposedNamesRequest): Promise<UpdateProposedNamesResult>;
 }
 export {};
-//# sourceMappingURL=NameController.d.ts.map
+//# sourceMappingURL=NameController.d.cts.map

package/dist/NameController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NameController.d.cts","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,2BAA2B,EAAE,iDAAgD;AAC3F,OAAO,KAAK,EACV,YAAY,EAIb,oBAAmB;AACpB,OAAO,EAAE,QAAQ,EAAE,oBAAmB;AAEtC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,6BAA6B,QAAe,CAAC;AAE1D;;GAEG;AACH,oBAAY,UAAU;IAEpB,gBAAgB,qBAAqB;IAErC,YAAY,iBAAiB;IAE7B,GAAG,QAAQ;IAEX,EAAE,OAAO;CACV;AAKD,QAAA,MAAM,cAAc,mBAAmB,CAAC;AA0BxC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACnE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,wBAAwB,CACjD,OAAO,cAAc,EACrB,mBAAmB,CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,0BAA0B,CACtD,OAAO,cAAc,EACrB,mBAAmB,CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,2BAA2B,CAAC;AAE/E,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAEnD,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAC7C,OAAO,cAAc,EACrB,qBAAqB,EACrB,oBAAoB,CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,uBAAuB,CAAC;IACnC,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACxE,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,qBAAa,cAAe,SAAQ,cAAc,CAChD,OAAO,cAAc,EACrB,mBAAmB,EACnB,uBAAuB,CACxB;;IAKC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,SAAS,EACT,KAAK,EACL,WAAW,GACZ,EAAE,qBAAqB;IAiBxB;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc;IAuB/B;;;;;;;;;OASG;IACG,mBAAmB,CACvB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yBAAyB,CAAC;CAsgBtC"}