@metamask-previews/rate-limit-controller 7.0.1-preview-3866c0ff1 → 7.0.1-preview-e3275932a

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/messenger` from `^1.0.0` to `^2.0.0` ([#8364](https://github.com/MetaMask/core/pull/8364), [#8373](https://github.com/MetaMask/core/pull/8373), [#8632](https://github.com/MetaMask/core/pull/8632), [#9392](https://github.com/MetaMask/core/pull/9392))
 - Bump `@metamask/base-controller` from `^9.0.1` to `^9.1.0` ([#8457](https://github.com/MetaMask/core/pull/8457))

package/dist/RateLimitController.cjs

@@ -0,0 +1,111 @@
+"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 _RateLimitController_instances, _RateLimitController_implementations, _RateLimitController_rateLimitTimeout, _RateLimitController_rateLimitCount, _RateLimitController_isRateLimited, _RateLimitController_recordRequest, _RateLimitController_resetRequestCount;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const utils_1 = require("@metamask/utils");
+const controllerName = 'RateLimitController';
+const metadata = {
+    requests: {
+        includeInStateLogs: false,
+        persist: false,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+/**
+ * Controller with logic for rate-limiting API endpoints per requesting origin.
+ */
+class RateLimitController extends base_controller_1.BaseController {
+    /**
+     * Creates a RateLimitController instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - A reference to the messaging system.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.implementations - Mapping from API type to API implementation.
+     * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).
+     * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.
+     */
+    constructor({ rateLimitTimeout = 5000, rateLimitCount = 1, messenger, state, implementations, }) {
+        const defaultState = {
+            requests: (0, utils_1.getKnownPropertyNames)(implementations).reduce((acc, key) => ({ ...acc, [key]: {} }), {}),
+        };
+        super({
+            name: controllerName,
+            metadata,
+            messenger,
+            state: { ...defaultState, ...state },
+        });
+        _RateLimitController_instances.add(this);
+        _RateLimitController_implementations.set(this, void 0);
+        _RateLimitController_rateLimitTimeout.set(this, void 0);
+        _RateLimitController_rateLimitCount.set(this, void 0);
+        __classPrivateFieldSet(this, _RateLimitController_implementations, implementations, "f");
+        __classPrivateFieldSet(this, _RateLimitController_rateLimitTimeout, rateLimitTimeout, "f");
+        __classPrivateFieldSet(this, _RateLimitController_rateLimitCount, rateLimitCount, "f");
+        this.messenger.registerActionHandler(`${controllerName}:call`, (origin, type, ...args) => this.call(origin, type, ...args));
+    }
+    /**
+     * Calls an API if the requesting origin is not rate-limited.
+     *
+     * @param origin - The requesting origin.
+     * @param type - The type of API call to make.
+     * @param args - Arguments for the API call.
+     * @returns The result of the API call.
+     */
+    async call(origin, type, ...args) {
+        if (__classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_isRateLimited).call(this, type, origin)) {
+            throw rpc_errors_1.rpcErrors.limitExceeded({
+                message: `"${type.toString()}" is currently rate-limited. Please try again later.`,
+            });
+        }
+        __classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_recordRequest).call(this, type, origin);
+        const implementation = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[type].method;
+        if (!implementation) {
+            throw new Error('Invalid api type');
+        }
+        return implementation(...args);
+    }
+}
+exports.RateLimitController = RateLimitController;
+_RateLimitController_implementations = new WeakMap(), _RateLimitController_rateLimitTimeout = new WeakMap(), _RateLimitController_rateLimitCount = new WeakMap(), _RateLimitController_instances = new WeakSet(), _RateLimitController_isRateLimited = function _RateLimitController_isRateLimited(api, origin) {
+    const rateLimitCount = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[api].rateLimitCount ?? __classPrivateFieldGet(this, _RateLimitController_rateLimitCount, "f");
+    return this.state.requests[api][origin] >= rateLimitCount;
+}, _RateLimitController_recordRequest = function _RateLimitController_recordRequest(api, origin) {
+    const rateLimitTimeout = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[api].rateLimitTimeout ?? __classPrivateFieldGet(this, _RateLimitController_rateLimitTimeout, "f");
+    const previous = this.state.requests[api][origin] ?? 0;
+    this.update((state) => {
+        if (previous === 0) {
+            setTimeout(() => __classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_resetRequestCount).call(this, api, origin), rateLimitTimeout);
+        }
+        Object.assign(state, {
+            requests: {
+                ...state.requests,
+                [api]: { [origin]: previous + 1 },
+            },
+        });
+    });
+}, _RateLimitController_resetRequestCount = function _RateLimitController_resetRequestCount(api, origin) {
+    this.update((state) => {
+        Object.assign(state, {
+            requests: {
+                ...state.requests,
+                [api]: { [origin]: 0 },
+            },
+        });
+    });
+};
+//# sourceMappingURL=RateLimitController.cjs.map

package/dist/RateLimitController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitController.cjs","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAM3D,qDAAiD;AACjD,2CAAwD;AAsCxD,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAwC7C,MAAM,QAAQ,GAAG;IACf,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAEF;;GAEG;AACH,MAAa,mBAEX,SAAQ,gCAIT;IAOC;;;;;;;;;OASG;IACH,YAAY,EACV,gBAAgB,GAAG,IAAI,EACvB,cAAc,GAAG,CAAC,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAOhB;QACC,MAAM,YAAY,GAAG;YACnB,QAAQ,EAAE,IAAA,6BAAqB,EAAC,eAAe,CAAC,CAAC,MAAM,CAErD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAW,CAAC;SACtD,CAAC;QACF,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAvCI,uDAAiB;QAEjB,wDAAkB;QAElB,sDAAgB;QAoCvB,uBAAA,IAAI,wCAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,yCAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QAEtC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,OAAO,EACxB,CACE,MAAc,EACd,IAA2B,EAC3B,GAAG,IAAwD,EAC3D,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,MAAc,EACd,IAAa,EACb,GAAG,IAAoD;QAEvD,IAAI,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EAAgB,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,sDAAsD;aACnF,CAAC,CAAC;QACL,CAAC;QACD,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EAAgB,IAAI,EAAE,MAAM,CAAC,CAAC;QAElC,MAAM,cAAc,GAAG,uBAAA,IAAI,4CAAiB,CAAC,IAAI,CAAC,CAAC,MAEA,CAAC;QAEpD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;CAyDF;AAnJD,kDAmJC;mSAhDgB,GAA0B,EAAE,MAAc;IACvD,MAAM,cAAc,GAClB,uBAAA,IAAI,4CAAiB,CAAC,GAAG,CAAC,CAAC,cAAc,IAAI,uBAAA,IAAI,2CAAgB,CAAC;IACpE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC;AAC5D,CAAC,mFAQc,GAA0B,EAAE,MAAc;IACvD,MAAM,gBAAgB,GACpB,uBAAA,IAAI,4CAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,IAAI,uBAAA,IAAI,6CAAkB,CAAC;IACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,UAAU,CACR,GAAG,EAAE,CAAC,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,GAAG,EAAE,MAAM,CAAC,EAC1C,gBAAgB,CACjB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;YACnB,QAAQ,EAAE;gBACR,GAAI,KAAK,CAAC,QAAiD;gBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE;aAClC;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,2FAQkB,GAA0B,EAAE,MAAc;IAC3D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;YACnB,QAAQ,EAAE;gBACR,GAAI,KAAK,CAAC,QAAiD;gBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;aACvB;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger, ActionConstraint } from '@metamask/messenger';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { getKnownPropertyNames } from '@metamask/utils';\n\n/**\n * A rate-limited API endpoint.\n *\n * @property method - The method that is rate-limited.\n * @property rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n * @property rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n */\nexport type RateLimitedApi = {\n  method: ActionConstraint['handler'];\n  rateLimitTimeout?: number;\n  rateLimitCount?: number;\n};\n\n/**\n * A map of rate-limited API types to APIs.\n */\nexport type RateLimitedApiMap = Record<string, RateLimitedApi>;\n\n/**\n * A map of rate-limited API types to the number of requests made in a given interval for each origin and api type combination.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n */\nexport type RateLimitedRequests<RateLimitedApis extends RateLimitedApiMap> =\n  Record<keyof RateLimitedApis, Record<string, number>>;\n\n/**\n * The state of the {@link RateLimitController}.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n * @property requests - An object containing the number of requests made in a given interval for each origin and api type combination.\n */\nexport type RateLimitState<RateLimitedApis extends RateLimitedApiMap> = {\n  requests: RateLimitedRequests<RateLimitedApis>;\n};\n\nconst controllerName = 'RateLimitController';\n\nexport type RateLimitControllerStateChangeEvent<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerStateChangeEvent<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerGetStateAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerGetStateAction<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerCallApiAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = {\n  type: `${typeof controllerName}:call`;\n  handler: RateLimitController<RateLimitedApis>['call'];\n};\n\nexport type RateLimitControllerActions<\n  RateLimitedApis extends RateLimitedApiMap,\n> =\n  | RateLimitControllerGetStateAction<RateLimitedApis>\n  | RateLimitControllerCallApiAction<RateLimitedApis>;\n\nexport type RateLimitControllerEvents<\n  RateLimitedApis extends RateLimitedApiMap,\n> = RateLimitControllerStateChangeEvent<RateLimitedApis>;\n\nexport type RateLimitMessenger<RateLimitedApis extends RateLimitedApiMap> =\n  Messenger<\n    typeof controllerName,\n    RateLimitControllerActions<RateLimitedApis>,\n    RateLimitControllerEvents<RateLimitedApis>\n  >;\n\nconst metadata = {\n  requests: {\n    includeInStateLogs: false,\n    persist: false,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n};\n\n/**\n * Controller with logic for rate-limiting API endpoints per requesting origin.\n */\nexport class RateLimitController<\n  RateLimitedApis extends RateLimitedApiMap,\n> extends BaseController<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>,\n  RateLimitMessenger<RateLimitedApis>\n> {\n  readonly #implementations;\n\n  readonly #rateLimitTimeout;\n\n  readonly #rateLimitCount;\n\n  /**\n   * Creates a RateLimitController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.implementations - Mapping from API type to API implementation.\n   * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n   * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n   */\n  constructor({\n    rateLimitTimeout = 5000,\n    rateLimitCount = 1,\n    messenger,\n    state,\n    implementations,\n  }: {\n    rateLimitTimeout?: number;\n    rateLimitCount?: number;\n    messenger: RateLimitMessenger<RateLimitedApis>;\n    state?: Partial<RateLimitState<RateLimitedApis>>;\n    implementations: RateLimitedApis;\n  }) {\n    const defaultState = {\n      requests: getKnownPropertyNames(implementations).reduce<\n        RateLimitedRequests<RateLimitedApis>\n      >((acc, key) => ({ ...acc, [key]: {} }), {} as never),\n    };\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#implementations = implementations;\n    this.#rateLimitTimeout = rateLimitTimeout;\n    this.#rateLimitCount = rateLimitCount;\n\n    this.messenger.registerActionHandler(\n      `${controllerName}:call`,\n      (\n        origin: string,\n        type: keyof RateLimitedApis,\n        ...args: Parameters<RateLimitedApis[typeof type]['method']>\n      ) => this.call(origin, type, ...args),\n    );\n  }\n\n  /**\n   * Calls an API if the requesting origin is not rate-limited.\n   *\n   * @param origin - The requesting origin.\n   * @param type - The type of API call to make.\n   * @param args - Arguments for the API call.\n   * @returns The result of the API call.\n   */\n  async call<ApiType extends keyof RateLimitedApis>(\n    origin: string,\n    type: ApiType,\n    ...args: Parameters<RateLimitedApis[ApiType]['method']>\n  ): Promise<ReturnType<RateLimitedApis[ApiType]['method']>> {\n    if (this.#isRateLimited(type, origin)) {\n      throw rpcErrors.limitExceeded({\n        message: `\"${type.toString()}\" is currently rate-limited. Please try again later.`,\n      });\n    }\n    this.#recordRequest(type, origin);\n\n    const implementation = this.#implementations[type].method as (\n      ...args: Parameters<RateLimitedApis[ApiType]['method']>\n    ) => ReturnType<RateLimitedApis[ApiType]['method']>;\n\n    if (!implementation) {\n      throw new Error('Invalid api type');\n    }\n\n    return implementation(...args);\n  }\n\n  /**\n   * Checks whether an origin is rate limited for a specific API.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   * @returns `true` if rate-limited, and `false` otherwise.\n   */\n  #isRateLimited(api: keyof RateLimitedApis, origin: string): boolean {\n    const rateLimitCount =\n      this.#implementations[api].rateLimitCount ?? this.#rateLimitCount;\n    return this.state.requests[api][origin] >= rateLimitCount;\n  }\n\n  /**\n   * Records that an origin has made a request to call an API, for rate-limiting purposes.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   */\n  #recordRequest(api: keyof RateLimitedApis, origin: string): void {\n    const rateLimitTimeout =\n      this.#implementations[api].rateLimitTimeout ?? this.#rateLimitTimeout;\n    const previous = this.state.requests[api][origin] ?? 0;\n    this.update((state) => {\n      if (previous === 0) {\n        setTimeout(\n          () => this.#resetRequestCount(api, origin),\n          rateLimitTimeout,\n        );\n      }\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: previous + 1 },\n        },\n      });\n    });\n  }\n\n  /**\n   * Resets the request count for a given origin and API combination, for rate-limiting purposes.\n   *\n   * @param api - The API in question.\n   * @param origin - The origin in question.\n   */\n  #resetRequestCount(api: keyof RateLimitedApis, origin: string): void {\n    this.update((state) => {\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: 0 },\n        },\n      });\n    });\n  }\n}\n"]}

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

@@ -1,6 +1,6 @@
-import { BaseController } from '@metamask/base-controller';
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
-import type { Messenger, ActionConstraint } from '@metamask/messenger';
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { Messenger, ActionConstraint } from "@metamask/messenger";
 /**
  * A rate-limited API endpoint.
  *
@@ -75,4 +75,4 @@ export declare class RateLimitController<RateLimitedApis extends RateLimitedApiM
     call<ApiType extends keyof RateLimitedApis>(origin: string, type: ApiType, ...args: Parameters<RateLimitedApis[ApiType]['method']>): Promise<ReturnType<RateLimitedApis[ApiType]['method']>>;
 }
 export {};
-//# sourceMappingURL=RateLimitController.d.ts.map
+//# sourceMappingURL=RateLimitController.d.cts.map

package/dist/RateLimitController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitController.d.cts","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,4BAA4B;AAIvE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,eAAe,SAAS,iBAAiB,IACvE,MAAM,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,iBAAiB,IAAI;IACtE,QAAQ,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;CAChD,CAAC;AAEF,QAAA,MAAM,cAAc,wBAAwB,CAAC;AAE7C,MAAM,MAAM,mCAAmC,CAC7C,eAAe,SAAS,iBAAiB,IACvC,0BAA0B,CAC5B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,iCAAiC,CAC3C,eAAe,SAAS,iBAAiB,IACvC,wBAAwB,CAC1B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,gCAAgC,CAC1C,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,0BAA0B,CACpC,eAAe,SAAS,iBAAiB,IAEvC,iCAAiC,CAAC,eAAe,CAAC,GAClD,gCAAgC,CAAC,eAAe,CAAC,CAAC;AAEtD,MAAM,MAAM,yBAAyB,CACnC,eAAe,SAAS,iBAAiB,IACvC,mCAAmC,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,MAAM,kBAAkB,CAAC,eAAe,SAAS,iBAAiB,IACtE,SAAS,CACP,OAAO,cAAc,EACrB,0BAA0B,CAAC,eAAe,CAAC,EAC3C,yBAAyB,CAAC,eAAe,CAAC,CAC3C,CAAC;AAWJ;;GAEG;AACH,qBAAa,mBAAmB,CAC9B,eAAe,SAAS,iBAAiB,CACzC,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,EAC/B,kBAAkB,CAAC,eAAe,CAAC,CACpC;;IAOC;;;;;;;;;OASG;gBACS,EACV,gBAAuB,EACvB,cAAkB,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAChB,EAAE;QACD,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC;QACjD,eAAe,EAAE,eAAe,CAAC;KAClC;IA0BD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,SAAS,MAAM,eAAe,EAC9C,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,GAAG,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,GACtD,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CA0E3D"}

package/dist/RateLimitController.d.mts

@@ -0,0 +1,78 @@
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import type { Messenger, ActionConstraint } from "@metamask/messenger";
+/**
+ * A rate-limited API endpoint.
+ *
+ * @property method - The method that is rate-limited.
+ * @property rateLimitTimeout - The time window in which the rate limit is applied (in ms).
+ * @property rateLimitCount - The amount of calls an origin can make in the rate limit time window.
+ */
+export type RateLimitedApi = {
+    method: ActionConstraint['handler'];
+    rateLimitTimeout?: number;
+    rateLimitCount?: number;
+};
+/**
+ * A map of rate-limited API types to APIs.
+ */
+export type RateLimitedApiMap = Record<string, RateLimitedApi>;
+/**
+ * A map of rate-limited API types to the number of requests made in a given interval for each origin and api type combination.
+ *
+ * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.
+ */
+export type RateLimitedRequests<RateLimitedApis extends RateLimitedApiMap> = Record<keyof RateLimitedApis, Record<string, number>>;
+/**
+ * The state of the {@link RateLimitController}.
+ *
+ * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.
+ * @property requests - An object containing the number of requests made in a given interval for each origin and api type combination.
+ */
+export type RateLimitState<RateLimitedApis extends RateLimitedApiMap> = {
+    requests: RateLimitedRequests<RateLimitedApis>;
+};
+declare const controllerName = "RateLimitController";
+export type RateLimitControllerStateChangeEvent<RateLimitedApis extends RateLimitedApiMap> = ControllerStateChangeEvent<typeof controllerName, RateLimitState<RateLimitedApis>>;
+export type RateLimitControllerGetStateAction<RateLimitedApis extends RateLimitedApiMap> = ControllerGetStateAction<typeof controllerName, RateLimitState<RateLimitedApis>>;
+export type RateLimitControllerCallApiAction<RateLimitedApis extends RateLimitedApiMap> = {
+    type: `${typeof controllerName}:call`;
+    handler: RateLimitController<RateLimitedApis>['call'];
+};
+export type RateLimitControllerActions<RateLimitedApis extends RateLimitedApiMap> = RateLimitControllerGetStateAction<RateLimitedApis> | RateLimitControllerCallApiAction<RateLimitedApis>;
+export type RateLimitControllerEvents<RateLimitedApis extends RateLimitedApiMap> = RateLimitControllerStateChangeEvent<RateLimitedApis>;
+export type RateLimitMessenger<RateLimitedApis extends RateLimitedApiMap> = Messenger<typeof controllerName, RateLimitControllerActions<RateLimitedApis>, RateLimitControllerEvents<RateLimitedApis>>;
+/**
+ * Controller with logic for rate-limiting API endpoints per requesting origin.
+ */
+export declare class RateLimitController<RateLimitedApis extends RateLimitedApiMap> extends BaseController<typeof controllerName, RateLimitState<RateLimitedApis>, RateLimitMessenger<RateLimitedApis>> {
+    #private;
+    /**
+     * Creates a RateLimitController instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - A reference to the messaging system.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.implementations - Mapping from API type to API implementation.
+     * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).
+     * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.
+     */
+    constructor({ rateLimitTimeout, rateLimitCount, messenger, state, implementations, }: {
+        rateLimitTimeout?: number;
+        rateLimitCount?: number;
+        messenger: RateLimitMessenger<RateLimitedApis>;
+        state?: Partial<RateLimitState<RateLimitedApis>>;
+        implementations: RateLimitedApis;
+    });
+    /**
+     * Calls an API if the requesting origin is not rate-limited.
+     *
+     * @param origin - The requesting origin.
+     * @param type - The type of API call to make.
+     * @param args - Arguments for the API call.
+     * @returns The result of the API call.
+     */
+    call<ApiType extends keyof RateLimitedApis>(origin: string, type: ApiType, ...args: Parameters<RateLimitedApis[ApiType]['method']>): Promise<ReturnType<RateLimitedApis[ApiType]['method']>>;
+}
+export {};
+//# sourceMappingURL=RateLimitController.d.mts.map

package/dist/RateLimitController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitController.d.mts","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,4BAA4B;AAIvE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,eAAe,SAAS,iBAAiB,IACvE,MAAM,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,iBAAiB,IAAI;IACtE,QAAQ,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;CAChD,CAAC;AAEF,QAAA,MAAM,cAAc,wBAAwB,CAAC;AAE7C,MAAM,MAAM,mCAAmC,CAC7C,eAAe,SAAS,iBAAiB,IACvC,0BAA0B,CAC5B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,iCAAiC,CAC3C,eAAe,SAAS,iBAAiB,IACvC,wBAAwB,CAC1B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,gCAAgC,CAC1C,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,0BAA0B,CACpC,eAAe,SAAS,iBAAiB,IAEvC,iCAAiC,CAAC,eAAe,CAAC,GAClD,gCAAgC,CAAC,eAAe,CAAC,CAAC;AAEtD,MAAM,MAAM,yBAAyB,CACnC,eAAe,SAAS,iBAAiB,IACvC,mCAAmC,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,MAAM,kBAAkB,CAAC,eAAe,SAAS,iBAAiB,IACtE,SAAS,CACP,OAAO,cAAc,EACrB,0BAA0B,CAAC,eAAe,CAAC,EAC3C,yBAAyB,CAAC,eAAe,CAAC,CAC3C,CAAC;AAWJ;;GAEG;AACH,qBAAa,mBAAmB,CAC9B,eAAe,SAAS,iBAAiB,CACzC,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,EAC/B,kBAAkB,CAAC,eAAe,CAAC,CACpC;;IAOC;;;;;;;;;OASG;gBACS,EACV,gBAAuB,EACvB,cAAkB,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAChB,EAAE;QACD,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC;QACjD,eAAe,EAAE,eAAe,CAAC;KAClC;IA0BD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,SAAS,MAAM,eAAe,EAC9C,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,GAAG,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,GACtD,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CA0E3D"}

package/dist/RateLimitController.mjs

@@ -0,0 +1,107 @@
+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 _RateLimitController_instances, _RateLimitController_implementations, _RateLimitController_rateLimitTimeout, _RateLimitController_rateLimitCount, _RateLimitController_isRateLimited, _RateLimitController_recordRequest, _RateLimitController_resetRequestCount;
+import { BaseController } from "@metamask/base-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { getKnownPropertyNames } from "@metamask/utils";
+const controllerName = 'RateLimitController';
+const metadata = {
+    requests: {
+        includeInStateLogs: false,
+        persist: false,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+/**
+ * Controller with logic for rate-limiting API endpoints per requesting origin.
+ */
+export class RateLimitController extends BaseController {
+    /**
+     * Creates a RateLimitController instance.
+     *
+     * @param options - Constructor options.
+     * @param options.messenger - A reference to the messaging system.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.implementations - Mapping from API type to API implementation.
+     * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).
+     * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.
+     */
+    constructor({ rateLimitTimeout = 5000, rateLimitCount = 1, messenger, state, implementations, }) {
+        const defaultState = {
+            requests: getKnownPropertyNames(implementations).reduce((acc, key) => ({ ...acc, [key]: {} }), {}),
+        };
+        super({
+            name: controllerName,
+            metadata,
+            messenger,
+            state: { ...defaultState, ...state },
+        });
+        _RateLimitController_instances.add(this);
+        _RateLimitController_implementations.set(this, void 0);
+        _RateLimitController_rateLimitTimeout.set(this, void 0);
+        _RateLimitController_rateLimitCount.set(this, void 0);
+        __classPrivateFieldSet(this, _RateLimitController_implementations, implementations, "f");
+        __classPrivateFieldSet(this, _RateLimitController_rateLimitTimeout, rateLimitTimeout, "f");
+        __classPrivateFieldSet(this, _RateLimitController_rateLimitCount, rateLimitCount, "f");
+        this.messenger.registerActionHandler(`${controllerName}:call`, (origin, type, ...args) => this.call(origin, type, ...args));
+    }
+    /**
+     * Calls an API if the requesting origin is not rate-limited.
+     *
+     * @param origin - The requesting origin.
+     * @param type - The type of API call to make.
+     * @param args - Arguments for the API call.
+     * @returns The result of the API call.
+     */
+    async call(origin, type, ...args) {
+        if (__classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_isRateLimited).call(this, type, origin)) {
+            throw rpcErrors.limitExceeded({
+                message: `"${type.toString()}" is currently rate-limited. Please try again later.`,
+            });
+        }
+        __classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_recordRequest).call(this, type, origin);
+        const implementation = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[type].method;
+        if (!implementation) {
+            throw new Error('Invalid api type');
+        }
+        return implementation(...args);
+    }
+}
+_RateLimitController_implementations = new WeakMap(), _RateLimitController_rateLimitTimeout = new WeakMap(), _RateLimitController_rateLimitCount = new WeakMap(), _RateLimitController_instances = new WeakSet(), _RateLimitController_isRateLimited = function _RateLimitController_isRateLimited(api, origin) {
+    const rateLimitCount = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[api].rateLimitCount ?? __classPrivateFieldGet(this, _RateLimitController_rateLimitCount, "f");
+    return this.state.requests[api][origin] >= rateLimitCount;
+}, _RateLimitController_recordRequest = function _RateLimitController_recordRequest(api, origin) {
+    const rateLimitTimeout = __classPrivateFieldGet(this, _RateLimitController_implementations, "f")[api].rateLimitTimeout ?? __classPrivateFieldGet(this, _RateLimitController_rateLimitTimeout, "f");
+    const previous = this.state.requests[api][origin] ?? 0;
+    this.update((state) => {
+        if (previous === 0) {
+            setTimeout(() => __classPrivateFieldGet(this, _RateLimitController_instances, "m", _RateLimitController_resetRequestCount).call(this, api, origin), rateLimitTimeout);
+        }
+        Object.assign(state, {
+            requests: {
+                ...state.requests,
+                [api]: { [origin]: previous + 1 },
+            },
+        });
+    });
+}, _RateLimitController_resetRequestCount = function _RateLimitController_resetRequestCount(api, origin) {
+    this.update((state) => {
+        Object.assign(state, {
+            requests: {
+                ...state.requests,
+                [api]: { [origin]: 0 },
+            },
+        });
+    });
+};
+//# sourceMappingURL=RateLimitController.mjs.map

package/dist/RateLimitController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitController.mjs","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAM3D,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EAAE,qBAAqB,EAAE,wBAAwB;AAsCxD,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAwC7C,MAAM,QAAQ,GAAG;IACf,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,mBAEX,SAAQ,cAIT;IAOC;;;;;;;;;OASG;IACH,YAAY,EACV,gBAAgB,GAAG,IAAI,EACvB,cAAc,GAAG,CAAC,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAOhB;QACC,MAAM,YAAY,GAAG;YACnB,QAAQ,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC,MAAM,CAErD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAW,CAAC;SACtD,CAAC;QACF,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAvCI,uDAAiB;QAEjB,wDAAkB;QAElB,sDAAgB;QAoCvB,uBAAA,IAAI,wCAAoB,eAAe,MAAA,CAAC;QACxC,uBAAA,IAAI,yCAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QAEtC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,OAAO,EACxB,CACE,MAAc,EACd,IAA2B,EAC3B,GAAG,IAAwD,EAC3D,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,MAAc,EACd,IAAa,EACb,GAAG,IAAoD;QAEvD,IAAI,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EAAgB,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,sDAAsD;aACnF,CAAC,CAAC;QACL,CAAC;QACD,uBAAA,IAAI,0EAAe,MAAnB,IAAI,EAAgB,IAAI,EAAE,MAAM,CAAC,CAAC;QAElC,MAAM,cAAc,GAAG,uBAAA,IAAI,4CAAiB,CAAC,IAAI,CAAC,CAAC,MAEA,CAAC;QAEpD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;CAyDF;mSAhDgB,GAA0B,EAAE,MAAc;IACvD,MAAM,cAAc,GAClB,uBAAA,IAAI,4CAAiB,CAAC,GAAG,CAAC,CAAC,cAAc,IAAI,uBAAA,IAAI,2CAAgB,CAAC;IACpE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC;AAC5D,CAAC,mFAQc,GAA0B,EAAE,MAAc;IACvD,MAAM,gBAAgB,GACpB,uBAAA,IAAI,4CAAiB,CAAC,GAAG,CAAC,CAAC,gBAAgB,IAAI,uBAAA,IAAI,6CAAkB,CAAC;IACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;YACnB,UAAU,CACR,GAAG,EAAE,CAAC,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,GAAG,EAAE,MAAM,CAAC,EAC1C,gBAAgB,CACjB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;YACnB,QAAQ,EAAE;gBACR,GAAI,KAAK,CAAC,QAAiD;gBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE;aAClC;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,2FAQkB,GAA0B,EAAE,MAAc;IAC3D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;YACnB,QAAQ,EAAE;gBACR,GAAI,KAAK,CAAC,QAAiD;gBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;aACvB;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger, ActionConstraint } from '@metamask/messenger';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { getKnownPropertyNames } from '@metamask/utils';\n\n/**\n * A rate-limited API endpoint.\n *\n * @property method - The method that is rate-limited.\n * @property rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n * @property rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n */\nexport type RateLimitedApi = {\n  method: ActionConstraint['handler'];\n  rateLimitTimeout?: number;\n  rateLimitCount?: number;\n};\n\n/**\n * A map of rate-limited API types to APIs.\n */\nexport type RateLimitedApiMap = Record<string, RateLimitedApi>;\n\n/**\n * A map of rate-limited API types to the number of requests made in a given interval for each origin and api type combination.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n */\nexport type RateLimitedRequests<RateLimitedApis extends RateLimitedApiMap> =\n  Record<keyof RateLimitedApis, Record<string, number>>;\n\n/**\n * The state of the {@link RateLimitController}.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n * @property requests - An object containing the number of requests made in a given interval for each origin and api type combination.\n */\nexport type RateLimitState<RateLimitedApis extends RateLimitedApiMap> = {\n  requests: RateLimitedRequests<RateLimitedApis>;\n};\n\nconst controllerName = 'RateLimitController';\n\nexport type RateLimitControllerStateChangeEvent<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerStateChangeEvent<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerGetStateAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerGetStateAction<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerCallApiAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = {\n  type: `${typeof controllerName}:call`;\n  handler: RateLimitController<RateLimitedApis>['call'];\n};\n\nexport type RateLimitControllerActions<\n  RateLimitedApis extends RateLimitedApiMap,\n> =\n  | RateLimitControllerGetStateAction<RateLimitedApis>\n  | RateLimitControllerCallApiAction<RateLimitedApis>;\n\nexport type RateLimitControllerEvents<\n  RateLimitedApis extends RateLimitedApiMap,\n> = RateLimitControllerStateChangeEvent<RateLimitedApis>;\n\nexport type RateLimitMessenger<RateLimitedApis extends RateLimitedApiMap> =\n  Messenger<\n    typeof controllerName,\n    RateLimitControllerActions<RateLimitedApis>,\n    RateLimitControllerEvents<RateLimitedApis>\n  >;\n\nconst metadata = {\n  requests: {\n    includeInStateLogs: false,\n    persist: false,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n};\n\n/**\n * Controller with logic for rate-limiting API endpoints per requesting origin.\n */\nexport class RateLimitController<\n  RateLimitedApis extends RateLimitedApiMap,\n> extends BaseController<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>,\n  RateLimitMessenger<RateLimitedApis>\n> {\n  readonly #implementations;\n\n  readonly #rateLimitTimeout;\n\n  readonly #rateLimitCount;\n\n  /**\n   * Creates a RateLimitController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.implementations - Mapping from API type to API implementation.\n   * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n   * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n   */\n  constructor({\n    rateLimitTimeout = 5000,\n    rateLimitCount = 1,\n    messenger,\n    state,\n    implementations,\n  }: {\n    rateLimitTimeout?: number;\n    rateLimitCount?: number;\n    messenger: RateLimitMessenger<RateLimitedApis>;\n    state?: Partial<RateLimitState<RateLimitedApis>>;\n    implementations: RateLimitedApis;\n  }) {\n    const defaultState = {\n      requests: getKnownPropertyNames(implementations).reduce<\n        RateLimitedRequests<RateLimitedApis>\n      >((acc, key) => ({ ...acc, [key]: {} }), {} as never),\n    };\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#implementations = implementations;\n    this.#rateLimitTimeout = rateLimitTimeout;\n    this.#rateLimitCount = rateLimitCount;\n\n    this.messenger.registerActionHandler(\n      `${controllerName}:call`,\n      (\n        origin: string,\n        type: keyof RateLimitedApis,\n        ...args: Parameters<RateLimitedApis[typeof type]['method']>\n      ) => this.call(origin, type, ...args),\n    );\n  }\n\n  /**\n   * Calls an API if the requesting origin is not rate-limited.\n   *\n   * @param origin - The requesting origin.\n   * @param type - The type of API call to make.\n   * @param args - Arguments for the API call.\n   * @returns The result of the API call.\n   */\n  async call<ApiType extends keyof RateLimitedApis>(\n    origin: string,\n    type: ApiType,\n    ...args: Parameters<RateLimitedApis[ApiType]['method']>\n  ): Promise<ReturnType<RateLimitedApis[ApiType]['method']>> {\n    if (this.#isRateLimited(type, origin)) {\n      throw rpcErrors.limitExceeded({\n        message: `\"${type.toString()}\" is currently rate-limited. Please try again later.`,\n      });\n    }\n    this.#recordRequest(type, origin);\n\n    const implementation = this.#implementations[type].method as (\n      ...args: Parameters<RateLimitedApis[ApiType]['method']>\n    ) => ReturnType<RateLimitedApis[ApiType]['method']>;\n\n    if (!implementation) {\n      throw new Error('Invalid api type');\n    }\n\n    return implementation(...args);\n  }\n\n  /**\n   * Checks whether an origin is rate limited for a specific API.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   * @returns `true` if rate-limited, and `false` otherwise.\n   */\n  #isRateLimited(api: keyof RateLimitedApis, origin: string): boolean {\n    const rateLimitCount =\n      this.#implementations[api].rateLimitCount ?? this.#rateLimitCount;\n    return this.state.requests[api][origin] >= rateLimitCount;\n  }\n\n  /**\n   * Records that an origin has made a request to call an API, for rate-limiting purposes.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   */\n  #recordRequest(api: keyof RateLimitedApis, origin: string): void {\n    const rateLimitTimeout =\n      this.#implementations[api].rateLimitTimeout ?? this.#rateLimitTimeout;\n    const previous = this.state.requests[api][origin] ?? 0;\n    this.update((state) => {\n      if (previous === 0) {\n        setTimeout(\n          () => this.#resetRequestCount(api, origin),\n          rateLimitTimeout,\n        );\n      }\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: previous + 1 },\n        },\n      });\n    });\n  }\n\n  /**\n   * Resets the request count for a given origin and API combination, for rate-limiting purposes.\n   *\n   * @param api - The API in question.\n   * @param origin - The origin in question.\n   */\n  #resetRequestCount(api: keyof RateLimitedApis, origin: string): void {\n    this.update((state) => {\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: 0 },\n        },\n      });\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitController = void 0;
+var RateLimitController_js_1 = require("./RateLimitController.cjs");
+Object.defineProperty(exports, "RateLimitController", { enumerable: true, get: function () { return RateLimitController_js_1.RateLimitController; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAYA,oEAA+D;AAAtD,6HAAA,mBAAmB,OAAA","sourcesContent":["export type {\n  RateLimitedApi,\n  RateLimitedApiMap,\n  RateLimitedRequests,\n  RateLimitControllerActions,\n  RateLimitControllerCallApiAction,\n  RateLimitControllerGetStateAction,\n  RateLimitControllerEvents,\n  RateLimitControllerStateChangeEvent,\n  RateLimitMessenger,\n  RateLimitState,\n} from './RateLimitController.js';\nexport { RateLimitController } from './RateLimitController.js';\n"]}

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

@@ -1,3 +1,3 @@
-export type { RateLimitedApi, RateLimitedApiMap, RateLimitedRequests, RateLimitControllerActions, RateLimitControllerCallApiAction, RateLimitControllerGetStateAction, RateLimitControllerEvents, RateLimitControllerStateChangeEvent, RateLimitMessenger, RateLimitState, } from './RateLimitController.js';
-export { RateLimitController } from './RateLimitController.js';
-//# sourceMappingURL=index.d.ts.map
+export type { RateLimitedApi, RateLimitedApiMap, RateLimitedRequests, RateLimitControllerActions, RateLimitControllerCallApiAction, RateLimitControllerGetStateAction, RateLimitControllerEvents, RateLimitControllerStateChangeEvent, RateLimitMessenger, RateLimitState, } from "./RateLimitController.cjs";
+export { RateLimitController } from "./RateLimitController.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,gCAAgC,EAChC,iCAAiC,EACjC,yBAAyB,EACzB,mCAAmC,EACnC,kBAAkB,EAClB,cAAc,GACf,kCAAiC;AAClC,OAAO,EAAE,mBAAmB,EAAE,kCAAiC"}

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+export type { RateLimitedApi, RateLimitedApiMap, RateLimitedRequests, RateLimitControllerActions, RateLimitControllerCallApiAction, RateLimitControllerGetStateAction, RateLimitControllerEvents, RateLimitControllerStateChangeEvent, RateLimitMessenger, RateLimitState, } from "./RateLimitController.mjs";
+export { RateLimitController } from "./RateLimitController.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,gCAAgC,EAChC,iCAAiC,EACjC,yBAAyB,EACzB,mCAAmC,EACnC,kBAAkB,EAClB,cAAc,GACf,kCAAiC;AAClC,OAAO,EAAE,mBAAmB,EAAE,kCAAiC"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export { RateLimitController } from "./RateLimitController.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,mBAAmB,EAAE,kCAAiC","sourcesContent":["export type {\n  RateLimitedApi,\n  RateLimitedApiMap,\n  RateLimitedRequests,\n  RateLimitControllerActions,\n  RateLimitControllerCallApiAction,\n  RateLimitControllerGetStateAction,\n  RateLimitControllerEvents,\n  RateLimitControllerStateChangeEvent,\n  RateLimitMessenger,\n  RateLimitState,\n} from './RateLimitController.js';\nexport { RateLimitController } from './RateLimitController.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/rate-limit-controller",
-  "version": "7.0.1-preview-3866c0ff1",
+  "version": "7.0.1-preview-e3275932a",
   "description": "Contains logic for rate-limiting API endpoints by requesting origin",
   "keywords": [
     "Ethereum",
@@ -18,12 +18,19 @@
   "files": [
     "dist/"
   ],
-  "type": "module",
   "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./package.json": "./package.json"
   },
@@ -32,11 +39,9 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "build:all": "tsc --build tsconfig.build.json --verbose",
-    "build:clean": "yarn build:only-clean && yarn build",
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
     "build:docs": "typedoc",
-    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/rate-limit-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/rate-limit-controller",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -55,18 +60,17 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
+    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
-    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
-    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "npm:@typescript/typescript6@^6.0.2"
+    "typescript": "~5.3.3"
   },
   "engines": {
-    "node": "^22.14.0 || ^24"
+    "node": "^18.18 || >=20"
   }
 }

package/dist/RateLimitController.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RateLimitController.d.ts","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAIvE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,eAAe,SAAS,iBAAiB,IACvE,MAAM,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,iBAAiB,IAAI;IACtE,QAAQ,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;CAChD,CAAC;AAEF,QAAA,MAAM,cAAc,wBAAwB,CAAC;AAE7C,MAAM,MAAM,mCAAmC,CAC7C,eAAe,SAAS,iBAAiB,IACvC,0BAA0B,CAC5B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,iCAAiC,CAC3C,eAAe,SAAS,iBAAiB,IACvC,wBAAwB,CAC1B,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,CAChC,CAAC;AAEF,MAAM,MAAM,gCAAgC,CAC1C,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,0BAA0B,CACpC,eAAe,SAAS,iBAAiB,IAEvC,iCAAiC,CAAC,eAAe,CAAC,GAClD,gCAAgC,CAAC,eAAe,CAAC,CAAC;AAEtD,MAAM,MAAM,yBAAyB,CACnC,eAAe,SAAS,iBAAiB,IACvC,mCAAmC,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,MAAM,kBAAkB,CAAC,eAAe,SAAS,iBAAiB,IACtE,SAAS,CACP,OAAO,cAAc,EACrB,0BAA0B,CAAC,eAAe,CAAC,EAC3C,yBAAyB,CAAC,eAAe,CAAC,CAC3C,CAAC;AAWJ;;GAEG;AACH,qBAAa,mBAAmB,CAC9B,eAAe,SAAS,iBAAiB,CACzC,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,cAAc,CAAC,eAAe,CAAC,EAC/B,kBAAkB,CAAC,eAAe,CAAC,CACpC;;IAOC;;;;;;;;;OASG;IACH,YAAY,EACV,gBAAuB,EACvB,cAAkB,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAChB,EAAE;QACD,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAC;QACjD,eAAe,EAAE,eAAe,CAAC;KAClC,EAwBA;IAED;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,SAAS,MAAM,eAAe,EAC9C,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,GAAG,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,GACtD,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAiBzD;CAyDF"}

package/dist/RateLimitController.js

@@ -1,115 +0,0 @@
-import { BaseController } from '@metamask/base-controller';
-import { rpcErrors } from '@metamask/rpc-errors';
-import { getKnownPropertyNames } from '@metamask/utils';
-const controllerName = 'RateLimitController';
-const metadata = {
-    requests: {
-        includeInStateLogs: false,
-        persist: false,
-        includeInDebugSnapshot: false,
-        usedInUi: false,
-    },
-};
-/**
- * Controller with logic for rate-limiting API endpoints per requesting origin.
- */
-export class RateLimitController extends BaseController {
-    #implementations;
-    #rateLimitTimeout;
-    #rateLimitCount;
-    /**
-     * Creates a RateLimitController instance.
-     *
-     * @param options - Constructor options.
-     * @param options.messenger - A reference to the messaging system.
-     * @param options.state - Initial state to set on this controller.
-     * @param options.implementations - Mapping from API type to API implementation.
-     * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).
-     * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.
-     */
-    constructor({ rateLimitTimeout = 5000, rateLimitCount = 1, messenger, state, implementations, }) {
-        const defaultState = {
-            requests: getKnownPropertyNames(implementations).reduce((acc, key) => ({ ...acc, [key]: {} }), {}),
-        };
-        super({
-            name: controllerName,
-            metadata,
-            messenger,
-            state: { ...defaultState, ...state },
-        });
-        this.#implementations = implementations;
-        this.#rateLimitTimeout = rateLimitTimeout;
-        this.#rateLimitCount = rateLimitCount;
-        this.messenger.registerActionHandler(`${controllerName}:call`, (origin, type, ...args) => this.call(origin, type, ...args));
-    }
-    /**
-     * Calls an API if the requesting origin is not rate-limited.
-     *
-     * @param origin - The requesting origin.
-     * @param type - The type of API call to make.
-     * @param args - Arguments for the API call.
-     * @returns The result of the API call.
-     */
-    async call(origin, type, ...args) {
-        if (this.#isRateLimited(type, origin)) {
-            throw rpcErrors.limitExceeded({
-                message: `"${type.toString()}" is currently rate-limited. Please try again later.`,
-            });
-        }
-        this.#recordRequest(type, origin);
-        const implementation = this.#implementations[type].method;
-        if (!implementation) {
-            throw new Error('Invalid api type');
-        }
-        return implementation(...args);
-    }
-    /**
-     * Checks whether an origin is rate limited for a specific API.
-     *
-     * @param api - The API the origin is trying to access.
-     * @param origin - The origin trying to access the API.
-     * @returns `true` if rate-limited, and `false` otherwise.
-     */
-    #isRateLimited(api, origin) {
-        const rateLimitCount = this.#implementations[api].rateLimitCount ?? this.#rateLimitCount;
-        return this.state.requests[api][origin] >= rateLimitCount;
-    }
-    /**
-     * Records that an origin has made a request to call an API, for rate-limiting purposes.
-     *
-     * @param api - The API the origin is trying to access.
-     * @param origin - The origin trying to access the API.
-     */
-    #recordRequest(api, origin) {
-        const rateLimitTimeout = this.#implementations[api].rateLimitTimeout ?? this.#rateLimitTimeout;
-        const previous = this.state.requests[api][origin] ?? 0;
-        this.update((state) => {
-            if (previous === 0) {
-                setTimeout(() => this.#resetRequestCount(api, origin), rateLimitTimeout);
-            }
-            Object.assign(state, {
-                requests: {
-                    ...state.requests,
-                    [api]: { [origin]: previous + 1 },
-                },
-            });
-        });
-    }
-    /**
-     * Resets the request count for a given origin and API combination, for rate-limiting purposes.
-     *
-     * @param api - The API in question.
-     * @param origin - The origin in question.
-     */
-    #resetRequestCount(api, origin) {
-        this.update((state) => {
-            Object.assign(state, {
-                requests: {
-                    ...state.requests,
-                    [api]: { [origin]: 0 },
-                },
-            });
-        });
-    }
-}
-//# sourceMappingURL=RateLimitController.js.map

package/dist/RateLimitController.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RateLimitController.js","sourceRoot":"","sources":["../src/RateLimitController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAsCxD,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAwC7C,MAAM,QAAQ,GAAG;IACf,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,mBAEX,SAAQ,cAIT;IACU,gBAAgB,CAAC;IAEjB,iBAAiB,CAAC;IAElB,eAAe,CAAC;IAEzB;;;;;;;;;OASG;IACH,YAAY,EACV,gBAAgB,GAAG,IAAI,EACvB,cAAc,GAAG,CAAC,EAClB,SAAS,EACT,KAAK,EACL,eAAe,GAOhB;QACC,MAAM,YAAY,GAAG;YACnB,QAAQ,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAC,MAAM,CAErD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAW,CAAC;SACtD,CAAC;QACF,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QAEtC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,OAAO,EACxB,CACE,MAAc,EACd,IAA2B,EAC3B,GAAG,IAAwD,EAC3D,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CACtC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,MAAc,EACd,IAAa,EACb,GAAG,IAAoD;QAEvD,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE,sDAAsD;aACnF,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAElC,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAEA,CAAC;QAEpD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,GAA0B,EAAE,MAAc;QACvD,MAAM,cAAc,GAClB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,cAAc,IAAI,IAAI,CAAC,eAAe,CAAC;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,GAA0B,EAAE,MAAc;QACvD,MAAM,gBAAgB,GACpB,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,gBAAgB,IAAI,IAAI,CAAC,iBAAiB,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;gBACnB,UAAU,CACR,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,EAC1C,gBAAgB,CACjB,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;gBACnB,QAAQ,EAAE;oBACR,GAAI,KAAK,CAAC,QAAiD;oBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE;iBAClC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,GAA0B,EAAE,MAAc;QAC3D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;gBACnB,QAAQ,EAAE;oBACR,GAAI,KAAK,CAAC,QAAiD;oBAC3D,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;iBACvB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger, ActionConstraint } from '@metamask/messenger';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { getKnownPropertyNames } from '@metamask/utils';\n\n/**\n * A rate-limited API endpoint.\n *\n * @property method - The method that is rate-limited.\n * @property rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n * @property rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n */\nexport type RateLimitedApi = {\n  method: ActionConstraint['handler'];\n  rateLimitTimeout?: number;\n  rateLimitCount?: number;\n};\n\n/**\n * A map of rate-limited API types to APIs.\n */\nexport type RateLimitedApiMap = Record<string, RateLimitedApi>;\n\n/**\n * A map of rate-limited API types to the number of requests made in a given interval for each origin and api type combination.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n */\nexport type RateLimitedRequests<RateLimitedApis extends RateLimitedApiMap> =\n  Record<keyof RateLimitedApis, Record<string, number>>;\n\n/**\n * The state of the {@link RateLimitController}.\n *\n * @template RateLimitedApis - A {@link RateLimitedApiMap} containing the rate-limited API endpoints that is used by the {@link RateLimitController}.\n * @property requests - An object containing the number of requests made in a given interval for each origin and api type combination.\n */\nexport type RateLimitState<RateLimitedApis extends RateLimitedApiMap> = {\n  requests: RateLimitedRequests<RateLimitedApis>;\n};\n\nconst controllerName = 'RateLimitController';\n\nexport type RateLimitControllerStateChangeEvent<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerStateChangeEvent<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerGetStateAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = ControllerGetStateAction<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>\n>;\n\nexport type RateLimitControllerCallApiAction<\n  RateLimitedApis extends RateLimitedApiMap,\n> = {\n  type: `${typeof controllerName}:call`;\n  handler: RateLimitController<RateLimitedApis>['call'];\n};\n\nexport type RateLimitControllerActions<\n  RateLimitedApis extends RateLimitedApiMap,\n> =\n  | RateLimitControllerGetStateAction<RateLimitedApis>\n  | RateLimitControllerCallApiAction<RateLimitedApis>;\n\nexport type RateLimitControllerEvents<\n  RateLimitedApis extends RateLimitedApiMap,\n> = RateLimitControllerStateChangeEvent<RateLimitedApis>;\n\nexport type RateLimitMessenger<RateLimitedApis extends RateLimitedApiMap> =\n  Messenger<\n    typeof controllerName,\n    RateLimitControllerActions<RateLimitedApis>,\n    RateLimitControllerEvents<RateLimitedApis>\n  >;\n\nconst metadata = {\n  requests: {\n    includeInStateLogs: false,\n    persist: false,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n};\n\n/**\n * Controller with logic for rate-limiting API endpoints per requesting origin.\n */\nexport class RateLimitController<\n  RateLimitedApis extends RateLimitedApiMap,\n> extends BaseController<\n  typeof controllerName,\n  RateLimitState<RateLimitedApis>,\n  RateLimitMessenger<RateLimitedApis>\n> {\n  readonly #implementations;\n\n  readonly #rateLimitTimeout;\n\n  readonly #rateLimitCount;\n\n  /**\n   * Creates a RateLimitController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.implementations - Mapping from API type to API implementation.\n   * @param options.rateLimitTimeout - The time window in which the rate limit is applied (in ms).\n   * @param options.rateLimitCount - The amount of calls an origin can make in the rate limit time window.\n   */\n  constructor({\n    rateLimitTimeout = 5000,\n    rateLimitCount = 1,\n    messenger,\n    state,\n    implementations,\n  }: {\n    rateLimitTimeout?: number;\n    rateLimitCount?: number;\n    messenger: RateLimitMessenger<RateLimitedApis>;\n    state?: Partial<RateLimitState<RateLimitedApis>>;\n    implementations: RateLimitedApis;\n  }) {\n    const defaultState = {\n      requests: getKnownPropertyNames(implementations).reduce<\n        RateLimitedRequests<RateLimitedApis>\n      >((acc, key) => ({ ...acc, [key]: {} }), {} as never),\n    };\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#implementations = implementations;\n    this.#rateLimitTimeout = rateLimitTimeout;\n    this.#rateLimitCount = rateLimitCount;\n\n    this.messenger.registerActionHandler(\n      `${controllerName}:call`,\n      (\n        origin: string,\n        type: keyof RateLimitedApis,\n        ...args: Parameters<RateLimitedApis[typeof type]['method']>\n      ) => this.call(origin, type, ...args),\n    );\n  }\n\n  /**\n   * Calls an API if the requesting origin is not rate-limited.\n   *\n   * @param origin - The requesting origin.\n   * @param type - The type of API call to make.\n   * @param args - Arguments for the API call.\n   * @returns The result of the API call.\n   */\n  async call<ApiType extends keyof RateLimitedApis>(\n    origin: string,\n    type: ApiType,\n    ...args: Parameters<RateLimitedApis[ApiType]['method']>\n  ): Promise<ReturnType<RateLimitedApis[ApiType]['method']>> {\n    if (this.#isRateLimited(type, origin)) {\n      throw rpcErrors.limitExceeded({\n        message: `\"${type.toString()}\" is currently rate-limited. Please try again later.`,\n      });\n    }\n    this.#recordRequest(type, origin);\n\n    const implementation = this.#implementations[type].method as (\n      ...args: Parameters<RateLimitedApis[ApiType]['method']>\n    ) => ReturnType<RateLimitedApis[ApiType]['method']>;\n\n    if (!implementation) {\n      throw new Error('Invalid api type');\n    }\n\n    return implementation(...args);\n  }\n\n  /**\n   * Checks whether an origin is rate limited for a specific API.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   * @returns `true` if rate-limited, and `false` otherwise.\n   */\n  #isRateLimited(api: keyof RateLimitedApis, origin: string): boolean {\n    const rateLimitCount =\n      this.#implementations[api].rateLimitCount ?? this.#rateLimitCount;\n    return this.state.requests[api][origin] >= rateLimitCount;\n  }\n\n  /**\n   * Records that an origin has made a request to call an API, for rate-limiting purposes.\n   *\n   * @param api - The API the origin is trying to access.\n   * @param origin - The origin trying to access the API.\n   */\n  #recordRequest(api: keyof RateLimitedApis, origin: string): void {\n    const rateLimitTimeout =\n      this.#implementations[api].rateLimitTimeout ?? this.#rateLimitTimeout;\n    const previous = this.state.requests[api][origin] ?? 0;\n    this.update((state) => {\n      if (previous === 0) {\n        setTimeout(\n          () => this.#resetRequestCount(api, origin),\n          rateLimitTimeout,\n        );\n      }\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: previous + 1 },\n        },\n      });\n    });\n  }\n\n  /**\n   * Resets the request count for a given origin and API combination, for rate-limiting purposes.\n   *\n   * @param api - The API in question.\n   * @param origin - The origin in question.\n   */\n  #resetRequestCount(api: keyof RateLimitedApis, origin: string): void {\n    this.update((state) => {\n      Object.assign(state, {\n        requests: {\n          ...(state.requests as RateLimitedRequests<RateLimitedApis>),\n          [api]: { [origin]: 0 },\n        },\n      });\n    });\n  }\n}\n"]}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,gCAAgC,EAChC,iCAAiC,EACjC,yBAAyB,EACzB,mCAAmC,EACnC,kBAAkB,EAClB,cAAc,GACf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/index.js

@@ -1,2 +0,0 @@
-export { RateLimitController } from './RateLimitController.js';
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC","sourcesContent":["export type {\n  RateLimitedApi,\n  RateLimitedApiMap,\n  RateLimitedRequests,\n  RateLimitControllerActions,\n  RateLimitControllerCallApiAction,\n  RateLimitControllerGetStateAction,\n  RateLimitControllerEvents,\n  RateLimitControllerStateChangeEvent,\n  RateLimitMessenger,\n  RateLimitState,\n} from './RateLimitController.js';\nexport { RateLimitController } from './RateLimitController.js';\n"]}