@metamask-previews/permission-log-controller 5.1.0-preview-8bfa290fb → 6.0.0-preview-0a30e47

package/CHANGELOG.md

@@ -7,12 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.0]
+
 ### Changed
 
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
 - Bump `@metamask/utils` from `^11.9.0` to `^11.12.0` ([#9074](https://github.com/MetaMask/core/pull/9074), [#10076](https://github.com/MetaMask/core/pull/10076))
-- Bump `@metamask/json-rpc-engine` from `^10.2.4` to `^10.5.0` ([#8661](https://github.com/MetaMask/core/pull/8661), [#8746](https://github.com/MetaMask/core/pull/8746), [#8753](https://github.com/MetaMask/core/pull/8753))
-- 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))
+- Bump `@metamask/json-rpc-engine` from `^10.2.4` to `^11.0.0` ([#8661](https://github.com/MetaMask/core/pull/8661), [#8746](https://github.com/MetaMask/core/pull/8746), [#8753](https://github.com/MetaMask/core/pull/8753), [#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/messenger` from `^1.0.0` to `^3.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), [#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/base-controller` from `^9.0.1` to `^10.0.0` ([#8457](https://github.com/MetaMask/core/pull/8457), [#10160](https://github.com/MetaMask/core/pull/10160))
 
 ## [5.1.0]
 
@@ -77,9 +84,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Bump `@metamask/base-controller` from `^7.0.0` to `^8.0.0` ([#5079](https://github.com/MetaMask/core/pull/5079)), ([#5135](https://github.com/MetaMask/core/pull/5135)), ([#5305](https://github.com/MetaMask/core/pull/5305))
-- Bump `@metamask/json-rpc-engine` from `^10.0.1` to `^10.0.3` ([#5082](https://github.com/MetaMask/core/pull/5082)), ([#5272](https://github.com/MetaMask/core/pull/5272))
-- Bump `@metamask/utils` from `^10.0.0` to `^11.1.0` ([#5080](https://github.com/MetaMask/core/pull/5080)), ([#5223](https://github.com/MetaMask/core/pull/5223))
+- Bump `@metamask/base-controller` from `^7.0.0` to `^8.0.0` ([#5079](https://github.com/MetaMask/core/pull/5079), [#5135](https://github.com/MetaMask/core/pull/5135), [#5305](https://github.com/MetaMask/core/pull/5305))
+- Bump `@metamask/json-rpc-engine` from `^10.0.1` to `^10.0.3` ([#5082](https://github.com/MetaMask/core/pull/5082), [#5272](https://github.com/MetaMask/core/pull/5272))
+- Bump `@metamask/utils` from `^10.0.0` to `^11.1.0` ([#5080](https://github.com/MetaMask/core/pull/5080), [#5223](https://github.com/MetaMask/core/pull/5223))
 - Bump `nanoid` from `^3.1.31` to `^3.3.8` ([#5073](https://github.com/MetaMask/core/pull/5073))
 
 ## [3.0.2]
@@ -113,7 +120,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as
     ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md).
     All of the ATTW checks now pass.
-- Remove chunk files ([#4648](https://github.com/MetaMask/core/pull/4648)).
+- Remove chunk files. ([#4648](https://github.com/MetaMask/core/pull/4648))
   - Previously, the build tool we used to generate JavaScript files extracted
     common code to "chunk" files. While this was intended to make this package
     more tree-shakeable, it also made debugging more difficult for our
@@ -159,7 +166,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@5.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@6.0.0...HEAD
+[6.0.0]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@5.1.0...@metamask/permission-log-controller@6.0.0
 [5.1.0]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@5.0.0...@metamask/permission-log-controller@5.1.0
 [5.0.0]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@4.1.1...@metamask/permission-log-controller@5.0.0
 [4.1.1]: https://github.com/MetaMask/core/compare/@metamask/permission-log-controller@4.1.0...@metamask/permission-log-controller@4.1.1

package/dist/{PermissionLogController-method-action-types.d.mts → PermissionLogController-method-action-types.d.ts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { PermissionLogController } from "./PermissionLogController.mjs";
+import type { PermissionLogController } from './PermissionLogController.js';
 /**
  * Updates the exposed account history for the given origin.
  * Sets the 'last seen' time to Date.now() for the given accounts.
@@ -34,4 +34,4 @@ export type PermissionLogControllerCreateMiddlewareAction = {
  * Union of all PermissionLogController action types.
  */
 export type PermissionLogControllerMethodActions = PermissionLogControllerUpdateAccountsHistoryAction | PermissionLogControllerCreateMiddlewareAction;
-//# sourceMappingURL=PermissionLogController-method-action-types.d.mts.map
+//# sourceMappingURL=PermissionLogController-method-action-types.d.ts.map

package/dist/PermissionLogController-method-action-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionLogController-method-action-types.d.ts","sourceRoot":"","sources":["../src/PermissionLogController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;CACtD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,kDAAkD,GAClD,6CAA6C,CAAC"}

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

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

package/dist/PermissionLogController-method-action-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionLogController-method-action-types.js","sourceRoot":"","sources":["../src/PermissionLogController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PermissionLogController } from './PermissionLogController.js';\n\n/**\n * Updates the exposed account history for the given origin.\n * Sets the 'last seen' time to Date.now() for the given accounts.\n * Does **not** update the 'lastApproved' time for the permission itself.\n * Returns if the accounts array is empty.\n *\n * @param origin - The origin that the accounts are exposed to.\n * @param accounts - The accounts.\n */\nexport type PermissionLogControllerUpdateAccountsHistoryAction = {\n  type: `PermissionLogController:updateAccountsHistory`;\n  handler: PermissionLogController['updateAccountsHistory'];\n};\n\n/**\n * Create a permissions log middleware. Records permissions activity and history:\n *\n * Activity: requests and responses for restricted and most wallet_ methods.\n *\n * History: for each origin, the last time a permission was granted, including\n * which accounts were exposed, if any.\n *\n * @returns The permissions log middleware.\n */\nexport type PermissionLogControllerCreateMiddlewareAction = {\n  type: `PermissionLogController:createMiddleware`;\n  handler: PermissionLogController['createMiddleware'];\n};\n\n/**\n * Union of all PermissionLogController action types.\n */\nexport type PermissionLogControllerMethodActions =\n  | PermissionLogControllerUpdateAccountsHistoryAction\n  | PermissionLogControllerCreateMiddlewareAction;\n"]}

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

@@ -1,10 +1,10 @@
-import { BaseController } from "@metamask/base-controller";
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import type { JsonRpcMiddleware } from "@metamask/json-rpc-engine";
-import type { Messenger } from "@metamask/messenger";
-import type { Json, JsonRpcRequest, JsonRpcParams } from "@metamask/utils";
-import { LOG_METHOD_TYPES } from "./enums.cjs";
-import type { PermissionLogControllerMethodActions } from "./PermissionLogController-method-action-types.cjs";
+import { BaseController } from '@metamask/base-controller';
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import type { Messenger } from '@metamask/messenger';
+import type { Json, JsonRpcRequest, JsonRpcParams } from '@metamask/utils';
+import { LOG_METHOD_TYPES } from './enums.js';
+import type { PermissionLogControllerMethodActions } from './PermissionLogController-method-action-types.js';
 export type JsonRpcRequestWithOrigin<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcRequest<Params> & {
     origin?: string;
 };
@@ -83,4 +83,4 @@ export declare class PermissionLogController extends BaseController<typeof name,
     createMiddleware(): JsonRpcMiddleware<JsonRpcParams, Json>;
 }
 export {};
-//# sourceMappingURL=PermissionLogController.d.cts.map
+//# sourceMappingURL=PermissionLogController.d.ts.map

package/dist/PermissionLogController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionLogController.d.ts","sourceRoot":"","sources":["../src/PermissionLogController.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,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,aAAa,EAEd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAGL,gBAAgB,EAGjB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AAE7G,MAAM,MAAM,wBAAwB,CAClC,MAAM,SAAS,aAAa,GAAG,aAAa,IAC1C,cAAc,CAAC,MAAM,CAAC,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAE5D,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,qBAAqB,EAAE,qBAAqB,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAC9C,SAAS,EAAE,gCAAgC,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,wBAAwB,CAC1E,OAAO,IAAI,EACX,4BAA4B,CAC7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACtC,qCAAqC,GACrC,oCAAoC,CAAC;AAEzC,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CAAC,OAAO,IAAI,EAAE,4BAA4B,CAAC,CAAC;AAExE,MAAM,MAAM,6BAA6B,GACvC,uCAAuC,CAAC;AAE1C,MAAM,MAAM,gCAAgC,GAAG,SAAS,CACtD,OAAO,IAAI,EACX,8BAA8B,EAC9B,6BAA6B,CAC9B,CAAC;AAOF,QAAA,MAAM,IAAI,4BAA4B,CAAC;AAOvC;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc,CACzD,OAAO,IAAI,EACX,4BAA4B,EAC5B,gCAAgC,CACjC;;IAGC,YAAY,EACV,SAAS,EACT,iBAAiB,EACjB,KAAK,GACN,EAAE,8BAA8B,EAyBhC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAU9D;IAED;;;;;;;;;OASG;IACH,gBAAgB,IAAI,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAqCzD;CA+PF"}

package/dist/PermissionLogController.js

@@ -0,0 +1,310 @@
+import { BaseController } from '@metamask/base-controller';
+import { hasProperty } from '@metamask/utils';
+import { LOG_IGNORE_METHODS, LOG_LIMIT, LOG_METHOD_TYPES, WALLET_PREFIX, CAVEAT_TYPES, } from './enums.js';
+const defaultState = {
+    permissionHistory: {},
+    permissionActivityLog: [],
+};
+const name = 'PermissionLogController';
+const MESSENGER_EXPOSED_METHODS = [
+    'updateAccountsHistory',
+    'createMiddleware',
+];
+/**
+ * Controller with middleware for logging requests and responses to restricted
+ * and permissions-related methods.
+ */
+export class PermissionLogController extends BaseController {
+    #restrictedMethods;
+    constructor({ messenger, restrictedMethods, state, }) {
+        super({
+            messenger,
+            name,
+            metadata: {
+                permissionHistory: {
+                    includeInStateLogs: true,
+                    persist: true,
+                    includeInDebugSnapshot: false,
+                    usedInUi: true,
+                },
+                permissionActivityLog: {
+                    includeInStateLogs: true,
+                    persist: false,
+                    includeInDebugSnapshot: false,
+                    usedInUi: false,
+                },
+            },
+            state: { ...defaultState, ...state },
+        });
+        this.#restrictedMethods = restrictedMethods;
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Updates the exposed account history for the given origin.
+     * Sets the 'last seen' time to Date.now() for the given accounts.
+     * Does **not** update the 'lastApproved' time for the permission itself.
+     * Returns if the accounts array is empty.
+     *
+     * @param origin - The origin that the accounts are exposed to.
+     * @param accounts - The accounts.
+     */
+    updateAccountsHistory(origin, accounts) {
+        if (accounts.length === 0) {
+            return;
+        }
+        const newEntries = {
+            eth_accounts: {
+                accounts: this.#getAccountToTimeMap(accounts, Date.now()),
+            },
+        };
+        this.#commitNewHistory(origin, newEntries);
+    }
+    /**
+     * Create a permissions log middleware. Records permissions activity and history:
+     *
+     * Activity: requests and responses for restricted and most wallet_ methods.
+     *
+     * History: for each origin, the last time a permission was granted, including
+     * which accounts were exposed, if any.
+     *
+     * @returns The permissions log middleware.
+     */
+    createMiddleware() {
+        return (req, res, next) => {
+            const { origin, method } = req;
+            const isInternal = method.startsWith(WALLET_PREFIX);
+            const isEthRequestAccounts = method === 'eth_requestAccounts';
+            // Determine if the method should be logged
+            if ((!LOG_IGNORE_METHODS.includes(method) &&
+                (isInternal || this.#restrictedMethods.has(method))) ||
+                isEthRequestAccounts) {
+                const activityEntry = this.#logRequest(req, isInternal);
+                const requestedMethods = this.#getRequestedMethods(req);
+                // Call next with a return handler for capturing the response
+                next((callback) => {
+                    const time = Date.now();
+                    this.#logResponse(activityEntry, res, time);
+                    if (requestedMethods && !res.error && res.result && origin) {
+                        this.#logPermissionsHistory(requestedMethods, origin, res.result, time, isEthRequestAccounts);
+                    }
+                    callback();
+                });
+                return;
+            }
+            next();
+        };
+    }
+    /**
+     * Get a map from account addresses to the given time.
+     *
+     * @param accounts - An array of addresses.
+     * @param time - A time, e.g. Date.now().
+     * @returns A string:number map of addresses to time.
+     */
+    #getAccountToTimeMap(accounts, time) {
+        return accounts.reduce((acc, account) => ({
+            ...acc,
+            [account]: time,
+        }), {});
+    }
+    /**
+     * Creates and commits an activity log entry, without response data.
+     *
+     * @param request - The request object.
+     * @param isInternal - Whether the request is internal.
+     * @returns new added activity entry
+     */
+    #logRequest(request, isInternal) {
+        const activityEntry = {
+            id: request.id,
+            method: request.method,
+            methodType: isInternal
+                ? LOG_METHOD_TYPES.internal
+                : LOG_METHOD_TYPES.restricted,
+            origin: request.origin,
+            requestTime: Date.now(),
+            responseTime: null,
+            success: null,
+        };
+        this.update((state) => {
+            const newLogs = [...state.permissionActivityLog, activityEntry];
+            state.permissionActivityLog =
+                // remove oldest log if exceeding size limit
+                newLogs.length > LOG_LIMIT ? newLogs.slice(1) : newLogs;
+        });
+        return activityEntry;
+    }
+    /**
+     * Adds response data to an existing activity log entry.
+     * Entry assumed already committed (i.e., in the log).
+     *
+     * @param entry - The entry to add a response to.
+     * @param response - The response object.
+     * @param time - Output from Date.now()
+     */
+    #logResponse(entry, response, time) {
+        if (!entry || !response) {
+            return;
+        }
+        // The JSON-RPC 2.0 specification defines "success" by the presence of
+        // either the "result" or "error" property. The specification forbids
+        // both properties from being present simultaneously, and our JSON-RPC
+        // stack is spec-compliant at the time of writing.
+        this.update((state) => {
+            state.permissionActivityLog = state.permissionActivityLog.map((log) => {
+                // Update the log entry that matches the given entry id
+                if (log.id === entry.id) {
+                    return {
+                        ...log,
+                        success: hasProperty(response, 'result'),
+                        responseTime: time,
+                    };
+                }
+                return log;
+            });
+        });
+    }
+    /**
+     * Create new permissions history log entries, if any, and commit them.
+     *
+     * @param requestedMethods - The method names corresponding to the requested permissions.
+     * @param origin - The origin of the permissions request.
+     * @param result - The permissions request response.result.
+     * @param time - The time of the request, i.e. Date.now().
+     * @param isEthRequestAccounts - Whether the permissions request was 'eth_requestAccounts'.
+     */
+    #logPermissionsHistory(requestedMethods, origin, result, time, isEthRequestAccounts) {
+        let newEntries;
+        if (isEthRequestAccounts) {
+            // Type assertion: We are assuming that the response data contains
+            // a set of accounts if the RPC method is "eth_requestAccounts".
+            const accounts = result;
+            newEntries = {
+                eth_accounts: {
+                    accounts: this.#getAccountToTimeMap(accounts, time),
+                    lastApproved: time,
+                },
+            };
+        }
+        else {
+            // Records new "lastApproved" times for the granted permissions, if any.
+            // Special handling for eth_accounts, in order to record the time the
+            // accounts were last seen or approved by the origin.
+            // Type assertion: We are assuming that the response data contains
+            // a set of permissions if the RPC method is "eth_requestPermissions".
+            const permissions = result;
+            newEntries = permissions.reduce((acc, permission) => {
+                const method = permission.parentCapability;
+                if (!requestedMethods.includes(method)) {
+                    return acc;
+                }
+                if (method === 'eth_accounts') {
+                    const accounts = this.#getAccountsFromPermission(permission);
+                    return {
+                        ...acc,
+                        [method]: {
+                            lastApproved: time,
+                            accounts: this.#getAccountToTimeMap(accounts, time),
+                        },
+                    };
+                }
+                return {
+                    ...acc,
+                    [method]: {
+                        lastApproved: time,
+                    },
+                };
+            }, {});
+        }
+        if (Object.keys(newEntries).length > 0) {
+            this.#commitNewHistory(origin, newEntries);
+        }
+    }
+    /**
+     * Commit new entries to the permissions history log.
+     * Merges the history for the given origin, overwriting existing entries
+     * with the same key (permission name).
+     *
+     * @param origin - The requesting origin.
+     * @param newEntries - The new entries to commit.
+     */
+    #commitNewHistory(origin, newEntries) {
+        const { permissionHistory } = this.state;
+        // a simple merge updates most permissions
+        const oldOriginHistory = permissionHistory[origin] ?? {};
+        const newOriginHistory = {
+            ...oldOriginHistory,
+            ...newEntries,
+        };
+        // eth_accounts requires special handling, because of information
+        // we store about the accounts
+        const existingEthAccountsEntry = oldOriginHistory.eth_accounts;
+        const newEthAccountsEntry = newEntries.eth_accounts;
+        if (existingEthAccountsEntry && newEthAccountsEntry) {
+            // we may intend to update just the accounts, not the permission
+            // itself
+            const lastApproved = newEthAccountsEntry.lastApproved ??
+                existingEthAccountsEntry.lastApproved;
+            // merge old and new eth_accounts history entries
+            newOriginHistory.eth_accounts = {
+                lastApproved,
+                accounts: {
+                    ...existingEthAccountsEntry.accounts,
+                    ...newEthAccountsEntry.accounts,
+                },
+            };
+        }
+        this.update((state) => {
+            state.permissionHistory = {
+                ...permissionHistory,
+                [origin]: newOriginHistory,
+            };
+        });
+    }
+    /**
+     * Get all requested methods from a permissions request.
+     *
+     * @param request - The request object.
+     * @returns The names of the requested permissions.
+     */
+    #getRequestedMethods(request) {
+        const { method, params } = request;
+        if (method === 'eth_requestAccounts') {
+            return ['eth_accounts'];
+        }
+        else if (method === `${WALLET_PREFIX}requestPermissions` &&
+            params &&
+            Array.isArray(params) &&
+            params[0] &&
+            typeof params[0] === 'object' &&
+            !Array.isArray(params[0])) {
+            return Object.keys(params[0]);
+        }
+        return null;
+    }
+    /**
+     * Get the permitted accounts from an eth_accounts permissions object.
+     * Returns an empty array if the permission is not eth_accounts.
+     *
+     * @param permission - The permissions object.
+     * @param permission.parentCapability - The permissions parentCapability.
+     * @param permission.caveats - The permissions caveats.
+     * @returns The permitted accounts.
+     */
+    #getAccountsFromPermission(permission) {
+        if (permission.parentCapability !== 'eth_accounts' || !permission.caveats) {
+            return [];
+        }
+        const accounts = new Set();
+        for (const caveat of permission.caveats) {
+            if (caveat.type === CAVEAT_TYPES.restrictReturnedAccounts &&
+                Array.isArray(caveat.value)) {
+                for (const value of caveat.value) {
+                    accounts.add(value);
+                }
+            }
+        }
+        return [...accounts];
+    }
+}
+//# sourceMappingURL=PermissionLogController.js.map

package/dist/PermissionLogController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionLogController.js","sourceRoot":"","sources":["../src/PermissionLogController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO3D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAQ9C,OAAO,EACL,kBAAkB,EAClB,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,YAAY,GACb,MAAM,YAAY,CAAC;AA4EpB,MAAM,YAAY,GAAiC;IACjD,iBAAiB,EAAE,EAAE;IACrB,qBAAqB,EAAE,EAAE;CAC1B,CAAC;AAEF,MAAM,IAAI,GAAG,yBAAyB,CAAC;AAEvC,MAAM,yBAAyB,GAAG;IAChC,uBAAuB;IACvB,kBAAkB;CACV,CAAC;AAEX;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAI5C;IACU,kBAAkB,CAAc;IAEzC,YAAY,EACV,SAAS,EACT,iBAAiB,EACjB,KAAK,GAC0B;QAC/B,KAAK,CAAC;YACJ,SAAS;YACT,IAAI;YACJ,QAAQ,EAAE;gBACR,iBAAiB,EAAE;oBACjB,kBAAkB,EAAE,IAAI;oBACxB,OAAO,EAAE,IAAI;oBACb,sBAAsB,EAAE,KAAK;oBAC7B,QAAQ,EAAE,IAAI;iBACf;gBACD,qBAAqB,EAAE;oBACrB,kBAAkB,EAAE,IAAI;oBACxB,OAAO,EAAE,KAAK;oBACd,sBAAsB,EAAE,KAAK;oBAC7B,QAAQ,EAAE,KAAK;iBAChB;aACF;YACD,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAc,EAAE,QAAkB;QACtD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QACD,MAAM,UAAU,GAAG;YACjB,YAAY,EAAE;gBACZ,QAAQ,EAAE,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;aAC1D;SACF,CAAC;QACF,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB;QACd,OAAO,CAAC,GAA6B,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAClD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;YAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YACpD,MAAM,oBAAoB,GAAG,MAAM,KAAK,qBAAqB,CAAC;YAE9D,2CAA2C;YAC3C,IACE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACnC,CAAC,UAAU,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtD,oBAAoB,EACpB,CAAC;gBACD,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;gBAExD,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;gBAExD,6DAA6D;gBAC7D,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAChB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACxB,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;oBAE5C,IAAI,gBAAgB,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;wBAC3D,IAAI,CAAC,sBAAsB,CACzB,gBAAgB,EAChB,MAAM,EACN,GAAG,CAAC,MAAM,EACV,IAAI,EACJ,oBAAoB,CACrB,CAAC;oBACJ,CAAC;oBACD,QAAQ,EAAE,CAAC;gBACb,CAAC,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YAED,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,oBAAoB,CAClB,QAAkB,EAClB,IAAY;QAEZ,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YACjB,GAAG,GAAG;YACN,CAAC,OAAO,CAAC,EAAE,IAAI;SAChB,CAAC,EACF,EAAE,CACH,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CACT,OAAiC,EACjC,UAAmB;QAEnB,MAAM,aAAa,GAA0B;YAC3C,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,UAAU;gBACpB,CAAC,CAAC,gBAAgB,CAAC,QAAQ;gBAC3B,CAAC,CAAC,gBAAgB,CAAC,UAAU;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;YACvB,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,IAAI;SACd,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,qBAAqB,EAAE,aAAa,CAAC,CAAC;YAChE,KAAK,CAAC,qBAAqB;gBACzB,4CAA4C;gBAC5C,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5D,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,KAA4B,EAC5B,QAAgC,EAChC,IAAY;QAEZ,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,sEAAsE;QACtE,qEAAqE;QACrE,sEAAsE;QACtE,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACpE,uDAAuD;gBACvD,IAAI,GAAG,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,EAAE,CAAC;oBACxB,OAAO;wBACL,GAAG,GAAG;wBACN,OAAO,EAAE,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC;wBACxC,YAAY,EAAE,IAAI;qBACnB,CAAC;gBACJ,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB,CACpB,gBAA0B,EAC1B,MAAc,EACd,MAAY,EACZ,IAAY,EACZ,oBAA6B;QAE7B,IAAI,UAA2B,CAAC;QAEhC,IAAI,oBAAoB,EAAE,CAAC;YACzB,kEAAkE;YAClE,gEAAgE;YAChE,MAAM,QAAQ,GAAG,MAAkB,CAAC;YACpC,UAAU,GAAG;gBACX,YAAY,EAAE;oBACZ,QAAQ,EAAE,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC;oBACnD,YAAY,EAAE,IAAI;iBACnB;aACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,wEAAwE;YACxE,qEAAqE;YACrE,qDAAqD;YACrD,kEAAkE;YAClE,sEAAsE;YACtE,MAAM,WAAW,GAAG,MAAsB,CAAC;YAC3C,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAoB,EAAE,UAAU,EAAE,EAAE;gBACnE,MAAM,MAAM,GAAG,UAAU,CAAC,gBAAgB,CAAC;gBAE3C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACvC,OAAO,GAAG,CAAC;gBACb,CAAC;gBAED,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;oBAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;oBAC7D,OAAO;wBACL,GAAG,GAAG;wBACN,CAAC,MAAM,CAAC,EAAE;4BACR,YAAY,EAAE,IAAI;4BAClB,QAAQ,EAAE,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC;yBACpD;qBACF,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,GAAG,GAAG;oBACN,CAAC,MAAM,CAAC,EAAE;wBACR,YAAY,EAAE,IAAI;qBACnB;iBACF,CAAC;YACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB,CAAC,MAAc,EAAE,UAA2B;QAC3D,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEzC,0CAA0C;QAC1C,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACzD,MAAM,gBAAgB,GAAG;YACvB,GAAG,gBAAgB;YACnB,GAAG,UAAU;SACd,CAAC;QAEF,iEAAiE;QACjE,8BAA8B;QAC9B,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAC/D,MAAM,mBAAmB,GAAG,UAAU,CAAC,YAAY,CAAC;QAEpD,IAAI,wBAAwB,IAAI,mBAAmB,EAAE,CAAC;YACpD,gEAAgE;YAChE,SAAS;YACT,MAAM,YAAY,GAChB,mBAAmB,CAAC,YAAY;gBAChC,wBAAwB,CAAC,YAAY,CAAC;YAExC,iDAAiD;YACjD,gBAAgB,CAAC,YAAY,GAAG;gBAC9B,YAAY;gBACZ,QAAQ,EAAE;oBACR,GAAG,wBAAwB,CAAC,QAAQ;oBACpC,GAAG,mBAAmB,CAAC,QAAQ;iBAChC;aACF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,iBAAiB,GAAG;gBACxB,GAAG,iBAAiB;gBACpB,CAAC,MAAM,CAAC,EAAE,gBAAgB;aAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,OAAiC;QACpD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QACnC,IAAI,MAAM,KAAK,qBAAqB,EAAE,CAAC;YACrC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,CAAC;aAAM,IACL,MAAM,KAAK,GAAG,aAAa,oBAAoB;YAC/C,MAAM;YACN,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACrB,MAAM,CAAC,CAAC,CAAC;YACT,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;YAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EACzB,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,0BAA0B,CAAC,UAAsB;QAC/C,IAAI,UAAU,CAAC,gBAAgB,KAAK,cAAc,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC1E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YACxC,IACE,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,wBAAwB;gBACrD,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAC3B,CAAC;gBACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;oBACjC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC;IACvB,CAAC;CACF","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport { hasProperty } from '@metamask/utils';\nimport type {\n  Json,\n  JsonRpcRequest,\n  JsonRpcParams,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nimport {\n  LOG_IGNORE_METHODS,\n  LOG_LIMIT,\n  LOG_METHOD_TYPES,\n  WALLET_PREFIX,\n  CAVEAT_TYPES,\n} from './enums.js';\nimport type { PermissionLogControllerMethodActions } from './PermissionLogController-method-action-types.js';\n\nexport type JsonRpcRequestWithOrigin<\n  Params extends JsonRpcParams = JsonRpcParams,\n> = JsonRpcRequest<Params> & {\n  origin?: string;\n};\n\nexport type Caveat = {\n  type: string;\n  value: string[];\n};\n\nexport type Permission = {\n  parentCapability: string;\n  caveats?: Caveat[];\n};\n\nexport type PermissionActivityLog = {\n  id: string | number | null;\n  method: string;\n  methodType: LOG_METHOD_TYPES;\n  origin?: string;\n  requestTime: number;\n  responseTime: number | null;\n  success: boolean | null;\n};\n\nexport type PermissionLog = {\n  accounts?: Record<string, number>;\n  lastApproved?: number;\n};\nexport type PermissionEntry = Record<string, PermissionLog>;\n\nexport type PermissionHistory = Record<string, PermissionEntry>;\n\n/**\n *\n * Permission log controller state\n *\n * @property permissionHistory - permission history\n * @property permissionActivityLog - permission activity logs\n */\nexport type PermissionLogControllerState = {\n  permissionHistory: PermissionHistory;\n  permissionActivityLog: PermissionActivityLog[];\n};\n\nexport type PermissionLogControllerOptions = {\n  restrictedMethods: Set<string>;\n  state?: Partial<PermissionLogControllerState>;\n  messenger: PermissionLogControllerMessenger;\n};\n\nexport type PermissionLogControllerGetStateAction = ControllerGetStateAction<\n  typeof name,\n  PermissionLogControllerState\n>;\n\nexport type PermissionLogControllerActions =\n  | PermissionLogControllerGetStateAction\n  | PermissionLogControllerMethodActions;\n\nexport type PermissionLogControllerStateChangeEvent =\n  ControllerStateChangeEvent<typeof name, PermissionLogControllerState>;\n\nexport type PermissionLogControllerEvents =\n  PermissionLogControllerStateChangeEvent;\n\nexport type PermissionLogControllerMessenger = Messenger<\n  typeof name,\n  PermissionLogControllerActions,\n  PermissionLogControllerEvents\n>;\n\nconst defaultState: PermissionLogControllerState = {\n  permissionHistory: {},\n  permissionActivityLog: [],\n};\n\nconst name = 'PermissionLogController';\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'updateAccountsHistory',\n  'createMiddleware',\n] as const;\n\n/**\n * Controller with middleware for logging requests and responses to restricted\n * and permissions-related methods.\n */\nexport class PermissionLogController extends BaseController<\n  typeof name,\n  PermissionLogControllerState,\n  PermissionLogControllerMessenger\n> {\n  readonly #restrictedMethods: Set<string>;\n\n  constructor({\n    messenger,\n    restrictedMethods,\n    state,\n  }: PermissionLogControllerOptions) {\n    super({\n      messenger,\n      name,\n      metadata: {\n        permissionHistory: {\n          includeInStateLogs: true,\n          persist: true,\n          includeInDebugSnapshot: false,\n          usedInUi: true,\n        },\n        permissionActivityLog: {\n          includeInStateLogs: true,\n          persist: false,\n          includeInDebugSnapshot: false,\n          usedInUi: false,\n        },\n      },\n      state: { ...defaultState, ...state },\n    });\n    this.#restrictedMethods = restrictedMethods;\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Updates the exposed account history for the given origin.\n   * Sets the 'last seen' time to Date.now() for the given accounts.\n   * Does **not** update the 'lastApproved' time for the permission itself.\n   * Returns if the accounts array is empty.\n   *\n   * @param origin - The origin that the accounts are exposed to.\n   * @param accounts - The accounts.\n   */\n  updateAccountsHistory(origin: string, accounts: string[]): void {\n    if (accounts.length === 0) {\n      return;\n    }\n    const newEntries = {\n      eth_accounts: {\n        accounts: this.#getAccountToTimeMap(accounts, Date.now()),\n      },\n    };\n    this.#commitNewHistory(origin, newEntries);\n  }\n\n  /**\n   * Create a permissions log middleware. Records permissions activity and history:\n   *\n   * Activity: requests and responses for restricted and most wallet_ methods.\n   *\n   * History: for each origin, the last time a permission was granted, including\n   * which accounts were exposed, if any.\n   *\n   * @returns The permissions log middleware.\n   */\n  createMiddleware(): JsonRpcMiddleware<JsonRpcParams, Json> {\n    return (req: JsonRpcRequestWithOrigin, res, next) => {\n      const { origin, method } = req;\n      const isInternal = method.startsWith(WALLET_PREFIX);\n      const isEthRequestAccounts = method === 'eth_requestAccounts';\n\n      // Determine if the method should be logged\n      if (\n        (!LOG_IGNORE_METHODS.includes(method) &&\n          (isInternal || this.#restrictedMethods.has(method))) ||\n        isEthRequestAccounts\n      ) {\n        const activityEntry = this.#logRequest(req, isInternal);\n\n        const requestedMethods = this.#getRequestedMethods(req);\n\n        // Call next with a return handler for capturing the response\n        next((callback) => {\n          const time = Date.now();\n          this.#logResponse(activityEntry, res, time);\n\n          if (requestedMethods && !res.error && res.result && origin) {\n            this.#logPermissionsHistory(\n              requestedMethods,\n              origin,\n              res.result,\n              time,\n              isEthRequestAccounts,\n            );\n          }\n          callback();\n        });\n        return;\n      }\n\n      next();\n    };\n  }\n\n  /**\n   * Get a map from account addresses to the given time.\n   *\n   * @param accounts - An array of addresses.\n   * @param time - A time, e.g. Date.now().\n   * @returns A string:number map of addresses to time.\n   */\n  #getAccountToTimeMap(\n    accounts: string[],\n    time: number,\n  ): Record<string, number> {\n    return accounts.reduce(\n      (acc, account) => ({\n        ...acc,\n        [account]: time,\n      }),\n      {},\n    );\n  }\n\n  /**\n   * Creates and commits an activity log entry, without response data.\n   *\n   * @param request - The request object.\n   * @param isInternal - Whether the request is internal.\n   * @returns new added activity entry\n   */\n  #logRequest(\n    request: JsonRpcRequestWithOrigin,\n    isInternal: boolean,\n  ): PermissionActivityLog {\n    const activityEntry: PermissionActivityLog = {\n      id: request.id,\n      method: request.method,\n      methodType: isInternal\n        ? LOG_METHOD_TYPES.internal\n        : LOG_METHOD_TYPES.restricted,\n      origin: request.origin,\n      requestTime: Date.now(),\n      responseTime: null,\n      success: null,\n    };\n    this.update((state) => {\n      const newLogs = [...state.permissionActivityLog, activityEntry];\n      state.permissionActivityLog =\n        // remove oldest log if exceeding size limit\n        newLogs.length > LOG_LIMIT ? newLogs.slice(1) : newLogs;\n    });\n    return activityEntry;\n  }\n\n  /**\n   * Adds response data to an existing activity log entry.\n   * Entry assumed already committed (i.e., in the log).\n   *\n   * @param entry - The entry to add a response to.\n   * @param response - The response object.\n   * @param time - Output from Date.now()\n   */\n  #logResponse(\n    entry: PermissionActivityLog,\n    response: PendingJsonRpcResponse,\n    time: number,\n  ): void {\n    if (!entry || !response) {\n      return;\n    }\n\n    // The JSON-RPC 2.0 specification defines \"success\" by the presence of\n    // either the \"result\" or \"error\" property. The specification forbids\n    // both properties from being present simultaneously, and our JSON-RPC\n    // stack is spec-compliant at the time of writing.\n    this.update((state) => {\n      state.permissionActivityLog = state.permissionActivityLog.map((log) => {\n        // Update the log entry that matches the given entry id\n        if (log.id === entry.id) {\n          return {\n            ...log,\n            success: hasProperty(response, 'result'),\n            responseTime: time,\n          };\n        }\n        return log;\n      });\n    });\n  }\n\n  /**\n   * Create new permissions history log entries, if any, and commit them.\n   *\n   * @param requestedMethods - The method names corresponding to the requested permissions.\n   * @param origin - The origin of the permissions request.\n   * @param result - The permissions request response.result.\n   * @param time - The time of the request, i.e. Date.now().\n   * @param isEthRequestAccounts - Whether the permissions request was 'eth_requestAccounts'.\n   */\n  #logPermissionsHistory(\n    requestedMethods: string[],\n    origin: string,\n    result: Json,\n    time: number,\n    isEthRequestAccounts: boolean,\n  ): void {\n    let newEntries: PermissionEntry;\n\n    if (isEthRequestAccounts) {\n      // Type assertion: We are assuming that the response data contains\n      // a set of accounts if the RPC method is \"eth_requestAccounts\".\n      const accounts = result as string[];\n      newEntries = {\n        eth_accounts: {\n          accounts: this.#getAccountToTimeMap(accounts, time),\n          lastApproved: time,\n        },\n      };\n    } else {\n      // Records new \"lastApproved\" times for the granted permissions, if any.\n      // Special handling for eth_accounts, in order to record the time the\n      // accounts were last seen or approved by the origin.\n      // Type assertion: We are assuming that the response data contains\n      // a set of permissions if the RPC method is \"eth_requestPermissions\".\n      const permissions = result as Permission[];\n      newEntries = permissions.reduce((acc: PermissionEntry, permission) => {\n        const method = permission.parentCapability;\n\n        if (!requestedMethods.includes(method)) {\n          return acc;\n        }\n\n        if (method === 'eth_accounts') {\n          const accounts = this.#getAccountsFromPermission(permission);\n          return {\n            ...acc,\n            [method]: {\n              lastApproved: time,\n              accounts: this.#getAccountToTimeMap(accounts, time),\n            },\n          };\n        }\n\n        return {\n          ...acc,\n          [method]: {\n            lastApproved: time,\n          },\n        };\n      }, {});\n    }\n\n    if (Object.keys(newEntries).length > 0) {\n      this.#commitNewHistory(origin, newEntries);\n    }\n  }\n\n  /**\n   * Commit new entries to the permissions history log.\n   * Merges the history for the given origin, overwriting existing entries\n   * with the same key (permission name).\n   *\n   * @param origin - The requesting origin.\n   * @param newEntries - The new entries to commit.\n   */\n  #commitNewHistory(origin: string, newEntries: PermissionEntry): void {\n    const { permissionHistory } = this.state;\n\n    // a simple merge updates most permissions\n    const oldOriginHistory = permissionHistory[origin] ?? {};\n    const newOriginHistory = {\n      ...oldOriginHistory,\n      ...newEntries,\n    };\n\n    // eth_accounts requires special handling, because of information\n    // we store about the accounts\n    const existingEthAccountsEntry = oldOriginHistory.eth_accounts;\n    const newEthAccountsEntry = newEntries.eth_accounts;\n\n    if (existingEthAccountsEntry && newEthAccountsEntry) {\n      // we may intend to update just the accounts, not the permission\n      // itself\n      const lastApproved =\n        newEthAccountsEntry.lastApproved ??\n        existingEthAccountsEntry.lastApproved;\n\n      // merge old and new eth_accounts history entries\n      newOriginHistory.eth_accounts = {\n        lastApproved,\n        accounts: {\n          ...existingEthAccountsEntry.accounts,\n          ...newEthAccountsEntry.accounts,\n        },\n      };\n    }\n\n    this.update((state) => {\n      state.permissionHistory = {\n        ...permissionHistory,\n        [origin]: newOriginHistory,\n      };\n    });\n  }\n\n  /**\n   * Get all requested methods from a permissions request.\n   *\n   * @param request - The request object.\n   * @returns The names of the requested permissions.\n   */\n  #getRequestedMethods(request: JsonRpcRequestWithOrigin): string[] | null {\n    const { method, params } = request;\n    if (method === 'eth_requestAccounts') {\n      return ['eth_accounts'];\n    } else if (\n      method === `${WALLET_PREFIX}requestPermissions` &&\n      params &&\n      Array.isArray(params) &&\n      params[0] &&\n      typeof params[0] === 'object' &&\n      !Array.isArray(params[0])\n    ) {\n      return Object.keys(params[0]);\n    }\n    return null;\n  }\n\n  /**\n   * Get the permitted accounts from an eth_accounts permissions object.\n   * Returns an empty array if the permission is not eth_accounts.\n   *\n   * @param permission - The permissions object.\n   * @param permission.parentCapability - The permissions parentCapability.\n   * @param permission.caveats - The permissions caveats.\n   * @returns The permitted accounts.\n   */\n  #getAccountsFromPermission(permission: Permission): string[] {\n    if (permission.parentCapability !== 'eth_accounts' || !permission.caveats) {\n      return [];\n    }\n\n    const accounts = new Set<string>();\n    for (const caveat of permission.caveats) {\n      if (\n        caveat.type === CAVEAT_TYPES.restrictReturnedAccounts &&\n        Array.isArray(caveat.value)\n      ) {\n        for (const value of caveat.value) {\n          accounts.add(value);\n        }\n      }\n    }\n\n    return [...accounts];\n  }\n}\n"]}

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

@@ -1,6 +1,6 @@
 export declare const WALLET_PREFIX = "wallet_";
 export declare const CAVEAT_TYPES: Readonly<{
-    restrictReturnedAccounts: "restrictReturnedAccounts";
+    restrictReturnedAccounts: 'restrictReturnedAccounts';
 }>;
 export declare const LOG_IGNORE_METHODS: string[];
 export declare enum LOG_METHOD_TYPES {
@@ -11,4 +11,4 @@ export declare enum LOG_METHOD_TYPES {
  * The permission activity log size limit.
  */
 export declare const LOG_LIMIT = 100;
-//# sourceMappingURL=enums.d.cts.map
+//# sourceMappingURL=enums.d.ts.map

package/dist/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,YAAY,CAAC;AAEvC,eAAO,MAAM,YAAY;8BACG,0BAA0B;EACpD,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAG9B,CAAC;AAKF,oBAAY,gBAAgB;IAC1B,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAGD;;GAEG;AACH,eAAO,MAAM,SAAS,MAAM,CAAC"}

package/dist/{enums.mjs → enums.js}

@@ -19,4 +19,4 @@ export var LOG_METHOD_TYPES;
  * The permission activity log size limit.
  */
 export const LOG_LIMIT = 100;
-//# sourceMappingURL=enums.mjs.map
+//# sourceMappingURL=enums.js.map

package/dist/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AAEvC,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,wBAAwB,EAAE,0BAAmC;CAC9D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,2BAA2B;IAC3B,mBAAmB;CACpB,CAAC;AAEF,4EAA4E;AAC5E,qEAAqE;AACrE,yDAAyD;AACzD,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,yCAAqB,CAAA;AACvB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AACD,wDAAwD;AAExD;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC","sourcesContent":["export const WALLET_PREFIX = 'wallet_';\n\nexport const CAVEAT_TYPES = Object.freeze({\n  restrictReturnedAccounts: 'restrictReturnedAccounts' as const,\n});\n\nexport const LOG_IGNORE_METHODS = [\n  'wallet_registerOnboarding',\n  'wallet_watchAsset',\n];\n\n// This enum should be called `LogMethodTypes`, with PascalCase members, but\n// to maintain backwards compatibility, the rule is disabled for now.\n/* eslint-disable @typescript-eslint/naming-convention */\nexport enum LOG_METHOD_TYPES {\n  restricted = 'restricted',\n  internal = 'internal',\n}\n/* eslint-enable @typescript-eslint/naming-convention */\n\n/**\n * The permission activity log size limit.\n */\nexport const LOG_LIMIT = 100;\n"]}

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

@@ -1,4 +1,4 @@
-export { PermissionLogController } from "./PermissionLogController.cjs";
-export type { PermissionLogControllerUpdateAccountsHistoryAction, PermissionLogControllerCreateMiddlewareAction, } from "./PermissionLogController-method-action-types.cjs";
-export type { JsonRpcRequestWithOrigin, Caveat, Permission, PermissionActivityLog, PermissionLog, PermissionEntry, PermissionHistory, PermissionLogControllerActions, PermissionLogControllerGetStateAction, PermissionLogControllerStateChangeEvent, PermissionLogControllerEvents, PermissionLogControllerMessenger, PermissionLogControllerState, PermissionLogControllerOptions, } from "./PermissionLogController.cjs";
-//# sourceMappingURL=index.d.cts.map
+export { PermissionLogController } from './PermissionLogController.js';
+export type { PermissionLogControllerUpdateAccountsHistoryAction, PermissionLogControllerCreateMiddlewareAction, } from './PermissionLogController-method-action-types.js';
+export type { JsonRpcRequestWithOrigin, Caveat, Permission, PermissionActivityLog, PermissionLog, PermissionEntry, PermissionHistory, PermissionLogControllerActions, PermissionLogControllerGetStateAction, PermissionLogControllerStateChangeEvent, PermissionLogControllerEvents, PermissionLogControllerMessenger, PermissionLogControllerState, PermissionLogControllerOptions, } from './PermissionLogController.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,YAAY,EACV,kDAAkD,EAClD,6CAA6C,GAC9C,MAAM,kDAAkD,CAAC;AAC1D,YAAY,EACV,wBAAwB,EACxB,MAAM,EACN,UAAU,EACV,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,8BAA8B,EAC9B,qCAAqC,EACrC,uCAAuC,EACvC,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,GAC/B,MAAM,8BAA8B,CAAC"}

package/dist/index.js

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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["export { PermissionLogController } from './PermissionLogController.js';\nexport type {\n  PermissionLogControllerUpdateAccountsHistoryAction,\n  PermissionLogControllerCreateMiddlewareAction,\n} from './PermissionLogController-method-action-types.js';\nexport type {\n  JsonRpcRequestWithOrigin,\n  Caveat,\n  Permission,\n  PermissionActivityLog,\n  PermissionLog,\n  PermissionEntry,\n  PermissionHistory,\n  PermissionLogControllerActions,\n  PermissionLogControllerGetStateAction,\n  PermissionLogControllerStateChangeEvent,\n  PermissionLogControllerEvents,\n  PermissionLogControllerMessenger,\n  PermissionLogControllerState,\n  PermissionLogControllerOptions,\n} from './PermissionLogController.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/permission-log-controller",
-  "version": "5.1.0-preview-8bfa290fb",
+  "version": "6.0.0-preview-0a30e47",
   "description": "Controller with middleware for logging requests and responses to restricted and permissions-related methods",
   "keywords": [
     "Ethereum",
@@ -18,19 +18,12 @@
   "files": [
     "dist/"
   ],
+  "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -39,9 +32,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/permission-log-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-log-controller",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -55,27 +50,28 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^9.1.0",
-    "@metamask/json-rpc-engine": "^10.5.0",
-    "@metamask/messenger": "^2.0.0",
+    "@metamask/base-controller": "^10.0.0",
+    "@metamask/json-rpc-engine": "^11.0.0",
+    "@metamask/messenger": "^3.0.0",
     "@metamask/utils": "^11.12.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/deep-freeze-strict": "^1.1.0",
     "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deep-freeze-strict": "^1.1.1",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
     "nanoid": "^3.3.8",
+    "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": "~5.3.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"PermissionLogController-method-action-types.cjs","sourceRoot":"","sources":["../src/PermissionLogController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { PermissionLogController } from './PermissionLogController.js';\n\n/**\n * Updates the exposed account history for the given origin.\n * Sets the 'last seen' time to Date.now() for the given accounts.\n * Does **not** update the 'lastApproved' time for the permission itself.\n * Returns if the accounts array is empty.\n *\n * @param origin - The origin that the accounts are exposed to.\n * @param accounts - The accounts.\n */\nexport type PermissionLogControllerUpdateAccountsHistoryAction = {\n  type: `PermissionLogController:updateAccountsHistory`;\n  handler: PermissionLogController['updateAccountsHistory'];\n};\n\n/**\n * Create a permissions log middleware. Records permissions activity and history:\n *\n * Activity: requests and responses for restricted and most wallet_ methods.\n *\n * History: for each origin, the last time a permission was granted, including\n * which accounts were exposed, if any.\n *\n * @returns The permissions log middleware.\n */\nexport type PermissionLogControllerCreateMiddlewareAction = {\n  type: `PermissionLogController:createMiddleware`;\n  handler: PermissionLogController['createMiddleware'];\n};\n\n/**\n * Union of all PermissionLogController action types.\n */\nexport type PermissionLogControllerMethodActions =\n  | PermissionLogControllerUpdateAccountsHistoryAction\n  | PermissionLogControllerCreateMiddlewareAction;\n"]}