@metamask/name-controller 1.0.0 → 3.0.0

package/CHANGELOG.md

@@ -6,9 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0]
+### Changed
+- **BREAKING**: Normalize addresses and chain IDs ([#1732](https://github.com/MetaMask/core/pull/1732))
+  - Save addresses and chain IDs as lowercase in state
+  - Remove `getChainId` constructor callback
+  - Require a `variation` property when calling `setName` or `updateProposedNames` with the `ethereumAddress` type
+
+## [2.0.0]
+### Changed
+- **BREAKING**: Support rate limiting in name providers ([#1715](https://github.com/MetaMask/core/pull/1715))
+  - Breaking changes:
+    - Change `proposedNames` property in `NameEntry` type from string array to new `ProposedNamesEntry` type
+    - Remove `proposedNamesLastUpdated` property from `NameEntry` type
+  - Add `onlyUpdateAfterDelay` option to `UpdateProposedNamesRequest` type
+  - Add `updateDelay` constructor option
+  - Add `updateDelay` property to `NameProviderSourceResult` type
+  - Add `isEnabled` callback option to `ENSNameProvider`, `EtherscanNameProvider`, `LensNameProvider`, and `TokenNameProvider`
+  - Existing proposed names in state are only updated if the `NameProvider` has no errors and the `proposedNames` property is not `undefined`
+- Dormant proposed names are automatically removed when calling `updateProposedNames` ([#1688](https://github.com/MetaMask/core/pull/1688))
+- The `setName` method accepts a `null` value for the `name` property to enable removing saved names ([#1688](https://github.com/MetaMask/core/pull/1688))
+- Update TypeScript to v4.8.x ([#1718](https://github.com/MetaMask/core/pull/1718))
+
 ## [1.0.0]
 ### Added
 - Initial Release ([#1647](https://github.com/MetaMask/core/pull/1647))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/name-controller@1.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/name-controller@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/name-controller@2.0.0...@metamask/name-controller@3.0.0
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/name-controller@1.0.0...@metamask/name-controller@2.0.0
 [1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/name-controller@1.0.0

package/dist/NameController.d.ts

@@ -4,11 +4,15 @@ import type { Patch } from 'immer';
 import type { NameProvider } from './types';
 import { NameType } from './types';
 declare const controllerName = "NameController";
+export declare type ProposedNamesEntry = {
+    proposedNames: string[];
+    lastRequestTime: number | null;
+    updateDelay: number | null;
+};
 export declare type NameEntry = {
     name: string | null;
     sourceId: string | null;
-    proposedNames: Record<string, string[] | null>;
-    proposedNamesLastUpdated: number | null;
+    proposedNames: Record<string, ProposedNamesEntry>;
 };
 export declare type SourceEntry = {
     label: string;
@@ -29,15 +33,17 @@ export declare type NameControllerActions = GetNameState;
 export declare type NameControllerEvents = NameStateChange;
 export declare type NameControllerMessenger = RestrictedControllerMessenger<typeof controllerName, NameControllerActions, NameControllerEvents, never, never>;
 export declare type NameControllerOptions = {
-    getChainId: () => string;
     messenger: NameControllerMessenger;
     providers: NameProvider[];
     state?: Partial<NameControllerState>;
+    updateDelay?: number;
 };
 export declare type UpdateProposedNamesRequest = {
     value: string;
     type: NameType;
     sourceIds?: string[];
+    onlyUpdateAfterDelay?: boolean;
+    variation?: string;
 };
 export declare type UpdateProposedNamesResult = {
     results: Record<string, {
@@ -48,8 +54,9 @@ export declare type UpdateProposedNamesResult = {
 export declare type SetNameRequest = {
     value: string;
     type: NameType;
-    name: string;
+    name: string | null;
     sourceId?: string;
+    variation?: string;
 };
 /**
  * Controller for storing and deriving names for values such as Ethereum addresses.
@@ -60,12 +67,12 @@ export declare class NameController extends BaseControllerV2<typeof controllerNa
      * Construct a Name controller.
      *
      * @param options - Controller options.
-     * @param options.getChainId - Callback that returns the chain ID of the current network.
      * @param options.messenger - Restricted controller 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({ getChainId, messenger, providers, state, }: NameControllerOptions);
+    constructor({ messenger, providers, state, updateDelay, }: NameControllerOptions);
     /**
      * Set the user specified name for a value.
      *
@@ -74,6 +81,7 @@ export declare class NameController extends BaseControllerV2<typeof controllerNa
      * @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: SetNameRequest): void;
     /**
@@ -83,6 +91,7 @@ export declare class NameController extends BaseControllerV2<typeof controllerNa
      * @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.
      */
     updateProposedNames(request: UpdateProposedNamesRequest): Promise<UpdateProposedNamesResult>;

package/dist/NameController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NameController.d.ts","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,EACV,YAAY,EAGb,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,QAAA,MAAM,cAAc,mBAAmB,CAAC;AAcxC,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/C,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,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,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,GAAG,OAAO,cAAc,WAAW,CAAC;IAC1C,OAAO,EAAE,MAAM,mBAAmB,CAAC;CACpC,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,CAAC,CAAC;CACzC,CAAC;AAEF,oBAAY,qBAAqB,GAAG,YAAY,CAAC;AAEjD,oBAAY,oBAAoB,GAAG,eAAe,CAAC;AAEnD,oBAAY,uBAAuB,GAAG,6BAA6B,CACjE,OAAO,cAAc,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,KAAK,EACL,KAAK,CACN,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,MAAM,CAAC;IACzB,SAAS,EAAE,uBAAuB,CAAC;IACnC,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACtC,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,oBAAY,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,oBAAY,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,qBAAa,cAAe,SAAQ,gBAAgB,CAClD,OAAO,cAAc,EACrB,mBAAmB,EACnB,uBAAuB,CACxB;;IAKC;;;;;;;;OAQG;gBACS,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,KAAK,GACN,EAAE,qBAAqB;IAYxB;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc;IAQ/B;;;;;;;;OAQG;IACG,mBAAmB,CACvB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yBAAyB,CAAC;CAgVtC"}
+{"version":3,"file":"NameController.d.ts","sourceRoot":"","sources":["../src/NameController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,EACV,YAAY,EAIb,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAKnC,QAAA,MAAM,cAAc,mBAAmB,CAAC;AAcxC,oBAAY,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,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CACnD,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,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,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,GAAG,OAAO,cAAc,WAAW,CAAC;IAC1C,OAAO,EAAE,MAAM,mBAAmB,CAAC;CACpC,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,CAAC,mBAAmB,EAAE,KAAK,EAAE,CAAC,CAAC;CACzC,CAAC;AAEF,oBAAY,qBAAqB,GAAG,YAAY,CAAC;AAEjD,oBAAY,oBAAoB,GAAG,eAAe,CAAC;AAEnD,oBAAY,uBAAuB,GAAG,6BAA6B,CACjE,OAAO,cAAc,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,KAAK,EACL,KAAK,CACN,CAAC;AAEF,oBAAY,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,oBAAY,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,oBAAY,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,oBAAY,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;CACpB,CAAC;AAEF;;GAEG;AACH,qBAAa,cAAe,SAAQ,gBAAgB,CAClD,OAAO,cAAc,EACrB,mBAAmB,EACnB,uBAAuB,CACxB;;IAKC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,SAAS,EACT,KAAK,EACL,WAAW,GACZ,EAAE,qBAAqB;IAYxB;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,EAAE,cAAc;IAY/B;;;;;;;;;OASG;IACG,mBAAmB,CACvB,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yBAAyB,CAAC;CAqbtC"}

package/dist/NameController.js

@@ -19,11 +19,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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_getChainId, _NameController_providers, _NameController_updateProposedNameState, _NameController_updateSourceState, _NameController_getUpdateProposedNamesResult, _NameController_getProviderResponse, _NameController_updateEntry, _NameController_getTypeVariationKey, _NameController_getCurrentTimeSeconds, _NameController_validateSetNameRequest, _NameController_validateUpdateProposedNamesRequest, _NameController_validateValue, _NameController_validateType, _NameController_validateName, _NameController_validateSourceIds, _NameController_validateSourceId, _NameController_validateDuplicateSourceIds, _NameController_getAllSourceIds, _NameController_getSourceIds;
+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_getAllSourceIds, _NameController_getSourceIds, _NameController_removeDormantProposedNames;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameController = void 0;
 const base_controller_1 = require("@metamask/base-controller");
 const types_1 = require("./types");
+const DEFAULT_UPDATE_DELAY = 60 * 2; // 2 Minutes
+const DEFAULT_VARIATION = '';
 const controllerName = 'NameController';
 const stateMetadata = {
     names: { persist: true, anonymous: false },
@@ -43,12 +45,12 @@ class NameController extends base_controller_1.BaseControllerV2 {
      * Construct a Name controller.
      *
      * @param options - Controller options.
-     * @param options.getChainId - Callback that returns the chain ID of the current network.
      * @param options.messenger - Restricted controller 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({ getChainId, messenger, providers, state, }) {
+    constructor({ messenger, providers, state, updateDelay, }) {
         super({
             name: controllerName,
             metadata: stateMetadata,
@@ -56,10 +58,10 @@ class NameController extends base_controller_1.BaseControllerV2 {
             state: Object.assign(Object.assign({}, getDefaultState()), state),
         });
         _NameController_instances.add(this);
-        _NameController_getChainId.set(this, void 0);
         _NameController_providers.set(this, void 0);
-        __classPrivateFieldSet(this, _NameController_getChainId, getChainId, "f");
+        _NameController_updateDelay.set(this, void 0);
         __classPrivateFieldSet(this, _NameController_providers, providers, "f");
+        __classPrivateFieldSet(this, _NameController_updateDelay, updateDelay !== null && updateDelay !== void 0 ? updateDelay : DEFAULT_UPDATE_DELAY, "f");
     }
     /**
      * Set the user specified name for a value.
@@ -69,11 +71,16 @@ class NameController extends base_controller_1.BaseControllerV2 {
      * @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 } = request;
-        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, { name, sourceId: sourceId !== null && sourceId !== void 0 ? sourceId : null });
+        const { value, type, name, sourceId: requestSourceId, variation } = request;
+        const sourceId = requestSourceId !== null && requestSourceId !== void 0 ? requestSourceId : null;
+        __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, variation, (entry) => {
+            entry.name = name;
+            entry.sourceId = sourceId;
+        });
     }
     /**
      * Generate the proposed names for a value using the name providers and store them in the state.
@@ -82,13 +89,13 @@ class NameController extends base_controller_1.BaseControllerV2 {
      * @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.
      */
     updateProposedNames(request) {
         return __awaiter(this, void 0, void 0, function* () {
             __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateUpdateProposedNamesRequest).call(this, request);
-            const chainId = __classPrivateFieldGet(this, _NameController_getChainId, "f").call(this);
-            const providerResponses = (yield Promise.all(__classPrivateFieldGet(this, _NameController_providers, "f").map((provider) => __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getProviderResponse).call(this, request, chainId, provider)))).filter((response) => Boolean(response));
+            const providerResponses = (yield 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"));
             return __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getUpdateProposedNamesResult).call(this, providerResponses);
@@ -96,30 +103,31 @@ class NameController extends base_controller_1.BaseControllerV2 {
     }
 }
 exports.NameController = NameController;
-_NameController_getChainId = new WeakMap(), _NameController_providers = new WeakMap(), _NameController_instances = new WeakSet(), _NameController_updateProposedNameState = function _NameController_updateProposedNameState(request, providerResponses) {
-    var _a, _b, _c;
-    const { value, type } = request;
-    const newProposedNames = {};
-    for (const providerResponse of providerResponses) {
-        const { results, error: responseError } = providerResponse;
-        if (responseError) {
-            continue;
-        }
-        for (const sourceId of Object.keys(providerResponse.results)) {
-            const result = results[sourceId];
-            const { proposedNames } = result;
-            let finalProposedNames = result.error ? null : proposedNames !== null && proposedNames !== void 0 ? proposedNames : [];
-            if (finalProposedNames) {
-                finalProposedNames = finalProposedNames.filter((proposedName) => proposedName === null || proposedName === void 0 ? void 0 : proposedName.length);
+_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) => {
+        var _a;
+        __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 = (_a = entry.proposedNames[sourceId]) !== null && _a !== void 0 ? _a : {
+                    proposedNames: [],
+                    lastRequestTime: null,
+                    updateDelay: null,
+                };
+                entry.proposedNames[sourceId] = proposedNameEntry;
+                if (proposedNames) {
+                    proposedNameEntry.proposedNames = proposedNames;
+                }
+                proposedNameEntry.lastRequestTime = currentTime;
+                proposedNameEntry.updateDelay = updateDelay !== null && updateDelay !== void 0 ? updateDelay : null;
             }
-            newProposedNames[sourceId] = finalProposedNames;
         }
-    }
-    const variationKey = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getTypeVariationKey).call(this, type);
-    const existingProposedNames = (_c = (_b = (_a = this.state.names[type]) === null || _a === void 0 ? void 0 : _a[value]) === null || _b === void 0 ? void 0 : _b[variationKey]) === null || _c === void 0 ? void 0 : _c.proposedNames;
-    const proposedNames = Object.assign(Object.assign({}, existingProposedNames), newProposedNames);
-    const proposedNamesLastUpdated = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getCurrentTimeSeconds).call(this);
-    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_updateEntry).call(this, value, type, { proposedNames, proposedNamesLastUpdated });
+    });
 }, _NameController_updateSourceState = function _NameController_updateSourceState(providers) {
     const newNameSources = Object.assign({}, this.state.nameSources);
     for (const provider of providers) {
@@ -137,34 +145,46 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
     return providerResponses.reduce((acc, providerResponse) => {
         const { results } = providerResponse;
         for (const sourceId of Object.keys(results)) {
-            const { proposedNames: resultProposedNames, error: resultError } = results[sourceId];
-            let proposedNames = resultError
-                ? undefined
-                : resultProposedNames !== null && resultProposedNames !== void 0 ? resultProposedNames : [];
-            if (proposedNames) {
-                proposedNames = proposedNames.filter((proposedName) => proposedName === null || proposedName === void 0 ? void 0 : proposedName.length);
-            }
+            const { proposedNames, error } = results[sourceId];
             acc.results[sourceId] = {
                 proposedNames,
-                error: resultError,
+                error,
             };
         }
         return acc;
     }, { results: {} });
-}, _NameController_getProviderResponse = function _NameController_getProviderResponse(request, chainId, provider) {
-    var _a;
+}, _NameController_getProviderResponse = function _NameController_getProviderResponse(request, provider) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { value, type, sourceIds: requestedSourceIds } = request;
+        const { value, type, sourceIds: requestedSourceIds, onlyUpdateAfterDelay, variation, } = request;
+        /* istanbul ignore next */
+        const variationKey = variation !== null && variation !== void 0 ? variation : DEFAULT_VARIATION;
         const supportedSourceIds = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getSourceIds).call(this, provider, type);
-        const matchingSourceIds = (_a = requestedSourceIds === null || requestedSourceIds === void 0 ? void 0 : requestedSourceIds.filter((sourceId) => supportedSourceIds.includes(sourceId))) !== null && _a !== void 0 ? _a : supportedSourceIds;
-        if (requestedSourceIds && !matchingSourceIds.length) {
+        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) => {
+            var _a, _b, _c, _d, _e, _f, _g;
+            if (requestedSourceIds && !requestedSourceIds.includes(sourceId)) {
+                return false;
+            }
+            if (onlyUpdateAfterDelay) {
+                const entry = (_c = (_b = (_a = this.state.names[type]) === null || _a === void 0 ? void 0 : _a[normalizedValue]) === null || _b === void 0 ? void 0 : _b[variationKey]) !== null && _c !== void 0 ? _c : {};
+                const proposedNamesEntry = (_e = (_d = entry.proposedNames) === null || _d === void 0 ? void 0 : _d[sourceId]) !== null && _e !== void 0 ? _e : {};
+                const lastRequestTime = (_f = proposedNamesEntry.lastRequestTime) !== null && _f !== void 0 ? _f : 0;
+                const updateDelay = (_g = proposedNamesEntry.updateDelay) !== null && _g !== void 0 ? _g : __classPrivateFieldGet(this, _NameController_updateDelay, "f");
+                if (currentTime - lastRequestTime < updateDelay) {
+                    return false;
+                }
+            }
+            return true;
+        });
+        if (!matchingSourceIds.length) {
             return undefined;
         }
         const providerRequest = {
-            chainId,
-            value,
+            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;
@@ -175,65 +195,86 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
         catch (error) {
             responseError = error;
         }
-        let results = {};
-        if (response === null || response === void 0 ? void 0 : response.results) {
-            results = Object.keys(response.results).reduce((acc, sourceId) => {
-                if (!requestedSourceIds || requestedSourceIds.includes(sourceId)) {
-                    acc[sourceId] = response.results[sourceId];
-                }
-                return acc;
-            }, {});
-        }
-        if (responseError) {
-            results = supportedSourceIds.reduce((acc, sourceId) => {
-                acc[sourceId] = { proposedNames: [], error: responseError };
-                return acc;
-            }, {});
-        }
-        return { results, error: responseError };
+        return __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeProviderResult).call(this, response, responseError, matchingSourceIds);
     });
-}, _NameController_updateEntry = function _NameController_updateEntry(value, type, data) {
-    const variationKey = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_getTypeVariationKey).call(this, type);
+}, _NameController_normalizeProviderResult = function _NameController_normalizeProviderResult(result, responseError, matchingSourceIds) {
+    const error = responseError !== null && responseError !== void 0 ? responseError : undefined;
+    const results = matchingSourceIds.reduce((acc, sourceId) => {
+        var _a;
+        const sourceResult = (_a = result === null || result === void 0 ? void 0 : result.results) === null || _a === void 0 ? void 0 : _a[sourceId];
+        const normalizedSourceResult = __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_normalizeProviderSourceResult).call(this, sourceResult, responseError);
+        return Object.assign(Object.assign({}, acc), { [sourceId]: normalizedSourceResult });
+    }, {});
+    return { results, error };
+}, _NameController_normalizeProviderSourceResult = function _NameController_normalizeProviderSourceResult(result, responseError) {
+    var _a, _b, _c, _d;
+    const error = (_b = (_a = result === null || result === void 0 ? void 0 : result.error) !== null && _a !== void 0 ? _a : responseError) !== null && _b !== void 0 ? _b : undefined;
+    const updateDelay = (_c = result === null || result === void 0 ? void 0 : result.updateDelay) !== null && _c !== void 0 ? _c : undefined;
+    let proposedNames = error ? undefined : (_d = result === null || result === void 0 ? void 0 : result.proposedNames) !== null && _d !== void 0 ? _d : undefined;
+    if (proposedNames) {
+        proposedNames = proposedNames.filter((proposedName) => proposedName === null || proposedName === void 0 ? void 0 : proposedName.length);
+    }
+    return {
+        proposedNames,
+        error,
+        updateDelay,
+    };
+}, _NameController_normalizeValue = function _NameController_normalizeValue(value, type) {
+    /* istanbul ignore next */
+    switch (type) {
+        case types_1.NameType.ETHEREUM_ADDRESS:
+            return value.toLowerCase();
+        default:
+            return value;
+    }
+}, _NameController_normalizeVariation = function _NameController_normalizeVariation(variation, type) {
+    /* istanbul ignore next */
+    switch (type) {
+        case types_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 !== null && variation !== void 0 ? 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);
     this.update((state) => {
         var _a;
         const typeEntries = state.names[type] || {};
         state.names[type] = typeEntries;
-        const variationEntries = typeEntries[value] || {};
-        typeEntries[value] = variationEntries;
-        const currentEntry = (_a = variationEntries[variationKey]) !== null && _a !== void 0 ? _a : {
+        const variationEntries = typeEntries[normalizedValue] || {};
+        typeEntries[normalizedValue] = variationEntries;
+        const entry = (_a = variationEntries[normalizedVariation]) !== null && _a !== void 0 ? _a : {
             proposedNames: {},
-            proposedNamesLastUpdated: null,
             name: null,
             sourceId: null,
         };
-        const updatedEntry = Object.assign(Object.assign({}, currentEntry), data);
-        variationEntries[variationKey] = updatedEntry;
+        variationEntries[normalizedVariation] = entry;
+        callback(entry);
     });
-}, _NameController_getTypeVariationKey = function _NameController_getTypeVariationKey(type) {
-    switch (type) {
-        default: {
-            return __classPrivateFieldGet(this, _NameController_getChainId, "f").call(this);
-        }
-    }
 }, _NameController_getCurrentTimeSeconds = function _NameController_getCurrentTimeSeconds() {
     return Math.round(Date.now() / 1000);
 }, _NameController_validateSetNameRequest = function _NameController_validateSetNameRequest(request) {
-    const { name, value, type, sourceId } = request;
+    const { name, value, type, sourceId, 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_validateName).call(this, name, errorMessages);
-    __classPrivateFieldGet(this, _NameController_instances, "m", _NameController_validateSourceId).call(this, sourceId, type, 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);
     if (errorMessages.length) {
         throw new Error(errorMessages.join(' '));
     }
 }, _NameController_validateUpdateProposedNamesRequest = function _NameController_validateUpdateProposedNamesRequest(request) {
-    const { value, type, sourceIds } = 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(' '));
     }
@@ -246,8 +287,11 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
         errorMessages.push(`Must specify one of the following types: ${Object.values(types_1.NameType).join(', ')}`);
     }
 }, _NameController_validateName = function _NameController_validateName(name, errorMessages) {
+    if (name === null) {
+        return;
+    }
     if (!(name === null || name === void 0 ? void 0 : name.length) || typeof name !== 'string') {
-        errorMessages.push('Must specify a non-empty string for name.');
+        errorMessages.push('Must specify a non-empty string or null for name.');
     }
 }, _NameController_validateSourceIds = function _NameController_validateSourceIds(sourceIds, type, errorMessages) {
     if (!sourceIds) {
@@ -264,10 +308,14 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
     if (missingSourceIds.length) {
         errorMessages.push(`Unknown source IDs for type '${type}': ${missingSourceIds.join(', ')}`);
     }
-}, _NameController_validateSourceId = function _NameController_validateSourceId(sourceId, type, errorMessages) {
+}, _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.');
@@ -282,6 +330,15 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
     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_1.NameType.ETHEREUM_ADDRESS) {
+        return;
+    }
+    if (!(variation === null || variation === void 0 ? void 0 : variation.length) ||
+        typeof variation !== 'string' ||
+        !variation.match(/^0x[0-9A-Fa-f]+$/u)) {
+        errorMessages.push(`Must specify a chain ID in hexidecimal format for variation when using '${type}' type.`);
+    }
 }, _NameController_getAllSourceIds = function _NameController_getAllSourceIds(type) {
     return (__classPrivateFieldGet(this, _NameController_providers, "f")
         /* istanbul ignore next */
@@ -289,5 +346,14 @@ _NameController_getChainId = new WeakMap(), _NameController_providers = new Weak
         .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];
+    }
 };
 //# sourceMappingURL=NameController.js.map