@metamask-previews/permission-log-controller 0.0.0-preview.3fbb6b41

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright ConsenSys Software Inc. 2022. All rights reserved.
+
+You acknowledge and agree that ConsenSys Software Inc. (“ConsenSys”) (or ConsenSys’s licensors) own all legal right, title and interest in and to the work, software, application, source code, documentation and any other documents in this repository (collectively, the “Program”), including any intellectual property rights which subsist in the Program (whether those rights happen to be registered or not, and wherever in the world those rights may exist), whether in source code or any other form.
+
+Subject to the limited license below, you may not (and you may not permit anyone else to) distribute, publish, copy, modify, merge, combine with another program, create derivative works of, reverse engineer, decompile or otherwise attempt to extract the source code of, the Program or any part thereof, except that you may contribute to this repository.
+
+You are granted a non-exclusive, non-transferable, non-sublicensable license to distribute, publish, copy, modify, merge, combine with another program or create derivative works of the Program (such resulting program, collectively, the “Resulting Program”) solely for Non-Commercial Use as long as you:
+ 1. give prominent notice (“Notice”) with each copy of the Resulting Program that the Program is used in the Resulting Program and that the Program is the copyright of ConsenSys; and
+ 2. subject the Resulting Program and any distribution, publication, copy, modification, merger therewith, combination with another program or derivative works thereof to the same Notice requirement and Non-Commercial Use restriction set forth herein.
+
+“Non-Commercial Use” means each use as described in clauses (1)-(3) below, as reasonably determined by ConsenSys in its sole discretion:
+ 1. personal use for research, personal study, private entertainment, hobby projects or amateur pursuits, in each case without any anticipated commercial application;
+ 2. use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization or government institution; or
+ 3. the number of monthly active users of the Resulting Program across all versions thereof and platforms globally do not exceed 10,000 at any time.
+
+You will not use any trade mark, service mark, trade name, logo of ConsenSys or any other company or organization in a way that is likely or intended to cause confusion about the owner or authorized user of such marks, names or logos.
+
+If you have any questions, comments or interest in pursuing any other use cases, please reach out to us at communications@metamask.io.

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/permission-log-controller`
+
+Controller with middleware for logging requests and responses to restricted and permissions-related methods.
+
+## Installation
+
+`yarn add @metamask/permission-log-controller`
+
+or
+
+`npm install @metamask/permission-log-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/PermissionLogController.d.ts

@@ -0,0 +1,167 @@
+import { BaseController, type RestrictedControllerMessenger } from '@metamask/base-controller';
+import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';
+import type { Json, JsonRpcRequest, JsonRpcParams, PendingJsonRpcResponse } from '@metamask/utils';
+import { LOG_METHOD_TYPES } from './enums';
+export declare type JsonRpcRequestWithOrigin<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcRequest<Params> & {
+    origin?: string;
+};
+export declare type Caveat = {
+    type: string;
+    value: string[];
+};
+export declare type Permission = {
+    parentCapability: string;
+    caveats?: Caveat[];
+};
+export declare type PermissionActivityLog = {
+    id: string | number | null;
+    method: string;
+    methodType: LOG_METHOD_TYPES;
+    origin?: string;
+    requestTime: number;
+    responseTime: number | null;
+    success: boolean | null;
+};
+export declare type PermissionName = string;
+export declare type PermissionLog = {
+    accounts?: Record<string, number>;
+    lastApproved: number;
+};
+export declare type PermissionEntry = Record<PermissionName, PermissionLog>;
+export declare type PermissionOrigin = string;
+export declare type PermissionHistory = Record<PermissionOrigin, PermissionEntry>;
+/**
+ *
+ * Permission log controller state
+ * @property permissionHistory - permission history
+ * @property permissionActivityLog - permission activity logs
+ */
+export declare type PermissionLogControllerState = {
+    permissionHistory: PermissionHistory;
+    permissionActivityLog: PermissionActivityLog[];
+};
+export declare type PermissionLogControllerOptions = {
+    restrictedMethods: Set<string>;
+    state?: Partial<PermissionLogControllerState>;
+    messenger: PermissionLogControllerMessenger;
+};
+export declare type PermissionLogControllerMessenger = RestrictedControllerMessenger<typeof name, never, never, never, never>;
+/**
+ * The name of the {@link PermissionController}.
+ */
+declare const name = "PermissionLogController";
+/**
+ * Controller with middleware for logging requests and responses to restricted
+ * and permissions-related methods.
+ */
+export declare class PermissionLogController extends BaseController<typeof name, PermissionLogControllerState, PermissionLogControllerMessenger> {
+    restrictedMethods: Set<string>;
+    constructor({ messenger, restrictedMethods, state, }: PermissionLogControllerOptions);
+    /**
+     * Get the restricted method activity log.
+     *
+     * @returns The activity log.
+     */
+    getActivityLog(): PermissionActivityLog[];
+    /**
+     * Update the restricted method activity log.
+     *
+     * @param logs - The new activity log array.
+     */
+    updateActivityLog(logs: PermissionActivityLog[]): void;
+    /**
+     * Get the permission history log.
+     *
+     * @returns The permissions history log.
+     */
+    getHistory(): PermissionHistory;
+    /**
+     * Update the permission history log.
+     *
+     * @param history - The new permissions history log object.
+     */
+    updateHistory(history: PermissionHistory): void;
+    /**
+     * 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: string, accounts: string[]): void;
+    /**
+     * 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(): JsonRpcMiddleware<JsonRpcParams, Json>;
+    /**
+     * 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: JsonRpcRequestWithOrigin, isInternal: boolean): PermissionActivityLog;
+    /**
+     * 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: PermissionActivityLog, response: PendingJsonRpcResponse<Json>, time: number): void;
+    /**
+     * Commit a new entry to the activity log.
+     * Removes the oldest entry from the log if it exceeds the log limit.
+     *
+     * @param entry - The activity log entry.
+     */
+    commitNewActivity(entry: PermissionActivityLog): void;
+    /**
+     * 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: string[], origin: string, result: Json, time: number, isEthRequestAccounts: boolean): void;
+    /**
+     * 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: string, newEntries: Record<PermissionName, Partial<PermissionLog>>): void;
+    /**
+     * Get all requested methods from a permissions request.
+     *
+     * @param request - The request object.
+     * @returns The names of the requested permissions.
+     */
+    getRequestedMethods(request: JsonRpcRequestWithOrigin<any>): string[] | null;
+    /**
+     * Get the permitted accounts from an eth_accounts permissions object.
+     * Returns an empty array if the permission is not eth_accounts.
+     *
+     * @param perm - The permissions object.
+     * @param perm.parentCapability - The permissions parentCapability.
+     * @param perm.caveats - The permissions caveats.
+     * @returns The permitted accounts.
+     */
+    getAccountsFromPermission(perm: Permission): string[];
+}
+export {};
+//# 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,EACL,cAAc,EACd,KAAK,6BAA6B,EACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EACV,IAAI,EACJ,cAAc,EACd,aAAa,EACb,sBAAsB,EACvB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAGL,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AAEjB,oBAAY,wBAAwB,CAClC,MAAM,SAAS,aAAa,GAAG,aAAa,IAC1C,cAAc,CAAC,MAAM,CAAC,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,oBAAY,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,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC,oBAAY,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AACF,oBAAY,eAAe,GAAG,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;AAEpE,oBAAY,gBAAgB,GAAG,MAAM,CAAC;AACtC,oBAAY,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AAE1E;;;;;GAKG;AACH,oBAAY,4BAA4B,GAAG;IACzC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,qBAAqB,EAAE,qBAAqB,EAAE,CAAC;CAChD,CAAC;AAEF,oBAAY,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,oBAAY,gCAAgC,GAAG,6BAA6B,CAC1E,OAAO,IAAI,EACX,KAAK,EACL,KAAK,EACL,KAAK,EACL,KAAK,CACN,CAAC;AAOF;;GAEG;AACH,QAAA,MAAM,IAAI,4BAA4B,CAAC;AAEvC;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,cAAc,CACzD,OAAO,IAAI,EACX,4BAA4B,EAC5B,gCAAgC,CACjC;IACC,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBAEnB,EACV,SAAS,EACT,iBAAiB,EACjB,KAAK,GACN,EAAE,8BAA8B;IAmBjC;;;;OAIG;IACH,cAAc,IAAI,qBAAqB,EAAE;IAIzC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,EAAE;IAM/C;;;;OAIG;IACH,UAAU,IAAI,iBAAiB;IAI/B;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,iBAAiB;IAMxC;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE;IAcxD;;;;;;;;;OASG;IACH,gBAAgB,IAAI,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC;IAmD1D;;;;;;OAMG;IACH,UAAU,CACR,OAAO,EAAE,wBAAwB,EACjC,UAAU,EAAE,OAAO,GAClB,qBAAqB;IAgBxB;;;;;;;OAOG;IACH,WAAW,CACT,KAAK,EAAE,qBAAqB,EAC5B,QAAQ,EAAE,sBAAsB,CAAC,IAAI,CAAC,EACtC,IAAI,EAAE,MAAM;IAuBd;;;;;OAKG;IACH,iBAAiB,CAAC,KAAK,EAAE,qBAAqB;IAW9C;;;;;;;;OAQG;IACH,qBAAqB,CACnB,gBAAgB,EAAE,MAAM,EAAE,EAC1B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,IAAI,EACZ,IAAI,EAAE,MAAM,EACZ,oBAAoB,EAAE,OAAO;IAyD/B;;;;;;;OAOG;IACH,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAsC5D;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,EAAE,wBAAwB,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI;IAY5E;;;;;;;;OAQG;IACH,yBAAyB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE;CAkBtD"}

package/dist/PermissionLogController.js

@@ -0,0 +1,339 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionLogController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const enums_1 = require("./enums");
+const defaultState = {
+    permissionHistory: {},
+    permissionActivityLog: [],
+};
+/**
+ * The name of the {@link PermissionController}.
+ */
+const name = 'PermissionLogController';
+/**
+ * Controller with middleware for logging requests and responses to restricted
+ * and permissions-related methods.
+ */
+class PermissionLogController extends base_controller_1.BaseController {
+    constructor({ messenger, restrictedMethods, state, }) {
+        super({
+            messenger,
+            name,
+            metadata: {
+                permissionHistory: {
+                    persist: true,
+                    anonymous: false,
+                },
+                permissionActivityLog: {
+                    persist: true,
+                    anonymous: false,
+                },
+            },
+            state: Object.assign(Object.assign({}, defaultState), state),
+        });
+        this.restrictedMethods = restrictedMethods;
+    }
+    /**
+     * Get the restricted method activity log.
+     *
+     * @returns The activity log.
+     */
+    getActivityLog() {
+        return this.state.permissionActivityLog;
+    }
+    /**
+     * Update the restricted method activity log.
+     *
+     * @param logs - The new activity log array.
+     */
+    updateActivityLog(logs) {
+        this.update((state) => {
+            state.permissionActivityLog = logs;
+        });
+    }
+    /**
+     * Get the permission history log.
+     *
+     * @returns The permissions history log.
+     */
+    getHistory() {
+        return this.state.permissionHistory;
+    }
+    /**
+     * Update the permission history log.
+     *
+     * @param history - The new permissions history log object.
+     */
+    updateHistory(history) {
+        this.update((state) => {
+            state.permissionHistory = history;
+        });
+    }
+    /**
+     * 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 accountToTimeMap = getAccountToTimeMap(accounts, Date.now());
+        this.commitNewHistory(origin, {
+            eth_accounts: {
+                accounts: accountToTimeMap,
+            },
+        });
+    }
+    /**
+     * 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) => {
+            let activityEntry, requestedMethods;
+            const { origin, method } = req;
+            const isInternal = method.startsWith(enums_1.WALLET_PREFIX);
+            // we only log certain methods
+            if (!enums_1.LOG_IGNORE_METHODS.includes(method) &&
+                (isInternal || this.restrictedMethods.has(method))) {
+                activityEntry = this.logRequest(req, isInternal);
+                if (method === `${enums_1.WALLET_PREFIX}requestPermissions`) {
+                    // get the corresponding methods from the requested permissions so
+                    // that we can record permissions history
+                    requestedMethods = this.getRequestedMethods(req);
+                }
+            }
+            else if (method === 'eth_requestAccounts') {
+                // eth_requestAccounts is a special case; we need to extract the accounts
+                // from it
+                activityEntry = this.logRequest(req, isInternal);
+                requestedMethods = ['eth_accounts'];
+            }
+            else {
+                // no-op
+                next();
+                return;
+            }
+            // call next with a return handler for capturing the response
+            next((cb) => {
+                const time = Date.now();
+                this.logResponse(activityEntry, res, time);
+                if (requestedMethods && !res.error && res.result && origin) {
+                    // any permissions or accounts changes will be recorded on the response,
+                    // so we only log permissions history here
+                    this.logPermissionsHistory(requestedMethods, origin, res.result, time, method === 'eth_requestAccounts');
+                }
+                cb();
+            });
+        };
+    }
+    /**
+     * 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
+                ? enums_1.LOG_METHOD_TYPES.internal
+                : enums_1.LOG_METHOD_TYPES.restricted,
+            origin: request.origin,
+            requestTime: Date.now(),
+            responseTime: null,
+            success: null,
+        };
+        this.commitNewActivity(activityEntry);
+        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) => {
+            const targetPermissionActivyLogIndex = state.permissionActivityLog.findIndex((pActivityLog) => pActivityLog.id === entry.id);
+            state.permissionActivityLog[targetPermissionActivyLogIndex] = Object.assign(Object.assign({}, entry), { success: Object.hasOwnProperty.call(response, 'result'), responseTime: time });
+        });
+    }
+    /**
+     * Commit a new entry to the activity log.
+     * Removes the oldest entry from the log if it exceeds the log limit.
+     *
+     * @param entry - The activity log entry.
+     */
+    commitNewActivity(entry) {
+        const logs = [...this.getActivityLog(), entry];
+        // remove oldest log if exceeding size limit
+        if (logs.length > enums_1.LOG_LIMIT) {
+            logs.shift();
+        }
+        this.updateActivityLog(logs);
+    }
+    /**
+     * 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 accounts;
+        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".
+            accounts = result;
+            const accountToTimeMap = getAccountToTimeMap(accounts, time);
+            newEntries = {
+                eth_accounts: {
+                    accounts: accountToTimeMap,
+                    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".
+            newEntries = result
+                .map((perm) => {
+                if (perm.parentCapability === 'eth_accounts') {
+                    accounts = this.getAccountsFromPermission(perm);
+                }
+                return perm.parentCapability;
+            })
+                .reduce((acc, method) => {
+                // all approved permissions will be included in the response,
+                // not just the newly requested ones
+                if (requestedMethods.includes(method)) {
+                    if (method === 'eth_accounts') {
+                        const accountToTimeMap = getAccountToTimeMap(accounts, time);
+                        acc[method] = {
+                            lastApproved: time,
+                            accounts: accountToTimeMap,
+                        };
+                    }
+                    else {
+                        acc[method] = { lastApproved: time };
+                    }
+                }
+                return acc;
+            }, {});
+        }
+        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) {
+        var _a;
+        // a simple merge updates most permissions
+        const history = this.getHistory();
+        const newOriginHistory = Object.assign(Object.assign({}, history[origin]), newEntries);
+        // eth_accounts requires special handling, because of information
+        // we store about the accounts
+        const existingEthAccountsEntry = history[origin] && history[origin].eth_accounts;
+        const newEthAccountsEntry = newEntries.eth_accounts;
+        if (existingEthAccountsEntry && newEthAccountsEntry) {
+            // we may intend to update just the accounts, not the permission
+            // itself
+            const lastApproved = (_a = newEthAccountsEntry.lastApproved) !== null && _a !== void 0 ? _a : existingEthAccountsEntry.lastApproved;
+            // merge old and new eth_accounts history entries
+            newOriginHistory.eth_accounts = {
+                lastApproved,
+                accounts: Object.assign(Object.assign({}, existingEthAccountsEntry.accounts), newEthAccountsEntry.accounts),
+            };
+        }
+        this.updateHistory(Object.assign(Object.assign({}, history), { [origin]: newOriginHistory }));
+    }
+    /**
+     * Get all requested methods from a permissions request.
+     *
+     * @param request - The request object.
+     * @returns The names of the requested permissions.
+     */
+    getRequestedMethods(request) {
+        if (!request.params ||
+            !request.params[0] ||
+            typeof request.params[0] !== 'object' ||
+            Array.isArray(request.params[0])) {
+            return null;
+        }
+        return Object.keys(request.params[0]);
+    }
+    /**
+     * Get the permitted accounts from an eth_accounts permissions object.
+     * Returns an empty array if the permission is not eth_accounts.
+     *
+     * @param perm - The permissions object.
+     * @param perm.parentCapability - The permissions parentCapability.
+     * @param perm.caveats - The permissions caveats.
+     * @returns The permitted accounts.
+     */
+    getAccountsFromPermission(perm) {
+        if (perm.parentCapability !== 'eth_accounts' || !perm.caveats) {
+            return [];
+        }
+        const accounts = new Set();
+        for (const caveat of perm.caveats) {
+            if (caveat.type === enums_1.CAVEAT_TYPES.restrictReturnedAccounts &&
+                Array.isArray(caveat.value)) {
+                for (const value of caveat.value) {
+                    accounts.add(value);
+                }
+            }
+        }
+        return [...accounts];
+    }
+}
+exports.PermissionLogController = PermissionLogController;
+// helper functions
+/**
+ * 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.
+ */
+function getAccountToTimeMap(accounts, time) {
+    return accounts.reduce((acc, account) => (Object.assign(Object.assign({}, acc), { [account]: time })), {});
+}
+//# 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,+DAGmC;AASnC,mCAMiB;AA+DjB,MAAM,YAAY,GAAiC;IACjD,iBAAiB,EAAE,EAAE;IACrB,qBAAqB,EAAE,EAAE;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,IAAI,GAAG,yBAAyB,CAAC;AAEvC;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,gCAI5C;IAGC,YAAY,EACV,SAAS,EACT,iBAAiB,EACjB,KAAK,GAC0B;QAC/B,KAAK,CAAC;YACJ,SAAS;YACT,IAAI;YACJ,QAAQ,EAAE;gBACR,iBAAiB,EAAE;oBACjB,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,qBAAqB,EAAE;oBACrB,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;aACF;YACD,KAAK,kCAAO,YAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,IAA6B;QAC7C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAA0B;QACtC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAc,EAAE,QAAkB;QACtD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,OAAO;SACR;QAED,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAEnE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC5B,YAAY,EAAE;gBACZ,QAAQ,EAAE,gBAAgB;aAC3B;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB;QACd,OAAO,CAAC,GAA6B,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAClD,IAAI,aAAoC,EACtC,gBAAiC,CAAC;YACpC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;YAC/B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,qBAAa,CAAC,CAAC;YAEpD,8BAA8B;YAC9B,IACE,CAAC,0BAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpC,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAClD;gBACA,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;gBAEjD,IAAI,MAAM,KAAK,GAAG,qBAAa,oBAAoB,EAAE;oBACnD,kEAAkE;oBAClE,yCAAyC;oBACzC,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;iBAClD;aACF;iBAAM,IAAI,MAAM,KAAK,qBAAqB,EAAE;gBAC3C,yEAAyE;gBACzE,UAAU;gBACV,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;gBACjD,gBAAgB,GAAG,CAAC,cAAc,CAAC,CAAC;aACrC;iBAAM;gBACL,QAAQ;gBACR,IAAI,EAAE,CAAC;gBACP,OAAO;aACR;YAED,6DAA6D;YAC7D,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;gBACV,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACxB,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;gBAE3C,IAAI,gBAAgB,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,IAAI,MAAM,EAAE;oBAC1D,wEAAwE;oBACxE,0CAA0C;oBAC1C,IAAI,CAAC,qBAAqB,CACxB,gBAAgB,EAChB,MAAM,EACN,GAAG,CAAC,MAAM,EACV,IAAI,EACJ,MAAM,KAAK,qBAAqB,CACjC,CAAC;iBACH;gBACD,EAAE,EAAE,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,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,wBAAgB,CAAC,QAAQ;gBAC3B,CAAC,CAAC,wBAAgB,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,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CACT,KAA4B,EAC5B,QAAsC,EACtC,IAAY;QAEZ,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE;YACvB,OAAO;SACR;QAED,sEAAsE;QACtE,qEAAqE;QACrE,sEAAsE;QACtE,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,8BAA8B,GAClC,KAAK,CAAC,qBAAqB,CAAC,SAAS,CACnC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAC/C,CAAC;YACJ,KAAK,CAAC,qBAAqB,CAAC,8BAA8B,CAAC,mCACtD,KAAK,KACR,OAAO,EAAE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EACvD,YAAY,EAAE,IAAI,GACnB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,KAA4B;QAC5C,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,EAAE,EAAE,KAAK,CAAC,CAAC;QAE/C,4CAA4C;QAC5C,IAAI,IAAI,CAAC,MAAM,GAAG,iBAAS,EAAE;YAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CACnB,gBAA0B,EAC1B,MAAc,EACd,MAAY,EACZ,IAAY,EACZ,oBAA6B;QAE7B,IAAI,QAAkB,CAAC;QACvB,IAAI,UAA2B,CAAC;QAEhC,IAAI,oBAAoB,EAAE;YACxB,kEAAkE;YAClE,gEAAgE;YAChE,QAAQ,GAAG,MAAkB,CAAC;YAC9B,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE7D,UAAU,GAAG;gBACX,YAAY,EAAE;oBACZ,QAAQ,EAAE,gBAAgB;oBAC1B,YAAY,EAAE,IAAI;iBACnB;aACF,CAAC;SACH;aAAM;YACL,wEAAwE;YACxE,qEAAqE;YACrE,qDAAqD;YAErD,kEAAkE;YAClE,sEAAsE;YACtE,UAAU,GAAI,MAAuB;iBAClC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACZ,IAAI,IAAI,CAAC,gBAAgB,KAAK,cAAc,EAAE;oBAC5C,QAAQ,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;iBACjD;gBAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;YAC/B,CAAC,CAAC;iBACD,MAAM,CAAC,CAAC,GAAoB,EAAE,MAAM,EAAE,EAAE;gBACvC,6DAA6D;gBAC7D,oCAAoC;gBACpC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;oBACrC,IAAI,MAAM,KAAK,cAAc,EAAE;wBAC7B,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;wBAE7D,GAAG,CAAC,MAAM,CAAC,GAAG;4BACZ,YAAY,EAAE,IAAI;4BAClB,QAAQ,EAAE,gBAAgB;yBAC3B,CAAC;qBACH;yBAAM;wBACL,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;qBACtC;iBACF;gBAED,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAAE,CAAC,CAAC;SACV;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACtC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;SAC3C;IACH,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CACd,MAAc,EACd,UAA0D;;QAE1D,0CAA0C;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,gBAAgB,mCACjB,OAAO,CAAC,MAAM,CAAC,GACf,UAAU,CACd,CAAC;QAEF,iEAAiE;QACjE,8BAA8B;QAC9B,MAAM,wBAAwB,GAC5B,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC;QAClD,MAAM,mBAAmB,GAAG,UAAU,CAAC,YAAY,CAAC;QAEpD,IAAI,wBAAwB,IAAI,mBAAmB,EAAE;YACnD,gEAAgE;YAChE,SAAS;YACT,MAAM,YAAY,GAChB,MAAA,mBAAmB,CAAC,YAAY,mCAChC,wBAAwB,CAAC,YAAY,CAAC;YAExC,iDAAiD;YACjD,gBAAgB,CAAC,YAAY,GAAG;gBAC9B,YAAY;gBACZ,QAAQ,kCACH,wBAAwB,CAAC,QAAQ,GACjC,mBAAmB,CAAC,QAAQ,CAChC;aACF,CAAC;SACH;QAED,IAAI,CAAC,aAAa,iCACb,OAAO,KACV,CAAC,MAAM,CAAC,EAAE,gBAAmC,IAC7C,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,OAAsC;QACxD,IACE,CAAC,OAAO,CAAC,MAAM;YACf,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAClB,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ;YACrC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAChC;YACA,OAAO,IAAI,CAAC;SACb;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,yBAAyB,CAAC,IAAgB;QACxC,IAAI,IAAI,CAAC,gBAAgB,KAAK,cAAc,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YAC7D,OAAO,EAAE,CAAC;SACX;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,IACE,MAAM,CAAC,IAAI,KAAK,oBAAY,CAAC,wBAAwB;gBACrD,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAC3B;gBACA,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;oBAChC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;iBACrB;aACF;SACF;QACD,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC;IACvB,CAAC;CACF;AA3YD,0DA2YC;AAED,mBAAmB;AAEnB;;;;;;GAMG;AACH,SAAS,mBAAmB,CAC1B,QAAkB,EAClB,IAAY;IAEZ,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,iCAAM,GAAG,KAAE,CAAC,OAAO,CAAC,EAAE,IAAI,IAAG,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC","sourcesContent":["import {\n  BaseController,\n  type RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\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';\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 PermissionName = string;\nexport type PermissionLog = {\n  accounts?: Record<string, number>;\n  lastApproved: number;\n};\nexport type PermissionEntry = Record<PermissionName, PermissionLog>;\n\nexport type PermissionOrigin = string;\nexport type PermissionHistory = Record<PermissionOrigin, PermissionEntry>;\n\n/**\n *\n * Permission log controller state\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 PermissionLogControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  never,\n  never,\n  never,\n  never\n>;\n\nconst defaultState: PermissionLogControllerState = {\n  permissionHistory: {},\n  permissionActivityLog: [],\n};\n\n/**\n * The name of the {@link PermissionController}.\n */\nconst name = 'PermissionLogController';\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  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          persist: true,\n          anonymous: false,\n        },\n        permissionActivityLog: {\n          persist: true,\n          anonymous: false,\n        },\n      },\n      state: { ...defaultState, ...state },\n    });\n    this.restrictedMethods = restrictedMethods;\n  }\n\n  /**\n   * Get the restricted method activity log.\n   *\n   * @returns The activity log.\n   */\n  getActivityLog(): PermissionActivityLog[] {\n    return this.state.permissionActivityLog;\n  }\n\n  /**\n   * Update the restricted method activity log.\n   *\n   * @param logs - The new activity log array.\n   */\n  updateActivityLog(logs: PermissionActivityLog[]) {\n    this.update((state) => {\n      state.permissionActivityLog = logs;\n    });\n  }\n\n  /**\n   * Get the permission history log.\n   *\n   * @returns The permissions history log.\n   */\n  getHistory(): PermissionHistory {\n    return this.state.permissionHistory;\n  }\n\n  /**\n   * Update the permission history log.\n   *\n   * @param history - The new permissions history log object.\n   */\n  updateHistory(history: PermissionHistory) {\n    this.update((state) => {\n      state.permissionHistory = history;\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[]) {\n    if (accounts.length === 0) {\n      return;\n    }\n\n    const accountToTimeMap = getAccountToTimeMap(accounts, Date.now());\n\n    this.commitNewHistory(origin, {\n      eth_accounts: {\n        accounts: accountToTimeMap,\n      },\n    });\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      let activityEntry: PermissionActivityLog,\n        requestedMethods: string[] | null;\n      const { origin, method } = req;\n      const isInternal = method.startsWith(WALLET_PREFIX);\n\n      // we only log certain methods\n      if (\n        !LOG_IGNORE_METHODS.includes(method) &&\n        (isInternal || this.restrictedMethods.has(method))\n      ) {\n        activityEntry = this.logRequest(req, isInternal);\n\n        if (method === `${WALLET_PREFIX}requestPermissions`) {\n          // get the corresponding methods from the requested permissions so\n          // that we can record permissions history\n          requestedMethods = this.getRequestedMethods(req);\n        }\n      } else if (method === 'eth_requestAccounts') {\n        // eth_requestAccounts is a special case; we need to extract the accounts\n        // from it\n        activityEntry = this.logRequest(req, isInternal);\n        requestedMethods = ['eth_accounts'];\n      } else {\n        // no-op\n        next();\n        return;\n      }\n\n      // call next with a return handler for capturing the response\n      next((cb) => {\n        const time = Date.now();\n        this.logResponse(activityEntry, res, time);\n\n        if (requestedMethods && !res.error && res.result && origin) {\n          // any permissions or accounts changes will be recorded on the response,\n          // so we only log permissions history here\n          this.logPermissionsHistory(\n            requestedMethods,\n            origin,\n            res.result,\n            time,\n            method === 'eth_requestAccounts',\n          );\n        }\n        cb();\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.commitNewActivity(activityEntry);\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<Json>,\n    time: number,\n  ) {\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      const targetPermissionActivyLogIndex =\n        state.permissionActivityLog.findIndex(\n          (pActivityLog) => pActivityLog.id === entry.id,\n        );\n      state.permissionActivityLog[targetPermissionActivyLogIndex] = {\n        ...entry,\n        success: Object.hasOwnProperty.call(response, 'result'),\n        responseTime: time,\n      };\n    });\n  }\n\n  /**\n   * Commit a new entry to the activity log.\n   * Removes the oldest entry from the log if it exceeds the log limit.\n   *\n   * @param entry - The activity log entry.\n   */\n  commitNewActivity(entry: PermissionActivityLog) {\n    const logs = [...this.getActivityLog(), entry];\n\n    // remove oldest log if exceeding size limit\n    if (logs.length > LOG_LIMIT) {\n      logs.shift();\n    }\n\n    this.updateActivityLog(logs);\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  ) {\n    let accounts: string[];\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      accounts = result as string[];\n      const accountToTimeMap = getAccountToTimeMap(accounts, time);\n\n      newEntries = {\n        eth_accounts: {\n          accounts: accountToTimeMap,\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\n      // Type assertion: We are assuming that the response data contains\n      // a set of permissions if the RPC method is \"eth_requestPermissions\".\n      newEntries = (result as Permission[])\n        .map((perm) => {\n          if (perm.parentCapability === 'eth_accounts') {\n            accounts = this.getAccountsFromPermission(perm);\n          }\n\n          return perm.parentCapability;\n        })\n        .reduce((acc: PermissionEntry, method) => {\n          // all approved permissions will be included in the response,\n          // not just the newly requested ones\n          if (requestedMethods.includes(method)) {\n            if (method === 'eth_accounts') {\n              const accountToTimeMap = getAccountToTimeMap(accounts, time);\n\n              acc[method] = {\n                lastApproved: time,\n                accounts: accountToTimeMap,\n              };\n            } else {\n              acc[method] = { lastApproved: time };\n            }\n          }\n\n          return acc;\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(\n    origin: string,\n    newEntries: Record<PermissionName, Partial<PermissionLog>>,\n  ) {\n    // a simple merge updates most permissions\n    const history = this.getHistory();\n    const newOriginHistory = {\n      ...history[origin],\n      ...newEntries,\n    };\n\n    // eth_accounts requires special handling, because of information\n    // we store about the accounts\n    const existingEthAccountsEntry =\n      history[origin] && history[origin].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.updateHistory({\n      ...history,\n      [origin]: newOriginHistory as PermissionEntry,\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<any>): string[] | null {\n    if (\n      !request.params ||\n      !request.params[0] ||\n      typeof request.params[0] !== 'object' ||\n      Array.isArray(request.params[0])\n    ) {\n      return null;\n    }\n    return Object.keys(request.params[0]);\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 perm - The permissions object.\n   * @param perm.parentCapability - The permissions parentCapability.\n   * @param perm.caveats - The permissions caveats.\n   * @returns The permitted accounts.\n   */\n  getAccountsFromPermission(perm: Permission): string[] {\n    if (perm.parentCapability !== 'eth_accounts' || !perm.caveats) {\n      return [];\n    }\n\n    const accounts = new Set<string>();\n    for (const caveat of perm.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    return [...accounts];\n  }\n}\n\n// helper functions\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 */\nfunction getAccountToTimeMap(\n  accounts: string[],\n  time: number,\n): Record<string, number> {\n  return accounts.reduce((acc, account) => ({ ...acc, [account]: time }), {});\n}\n"]}

package/dist/enums.d.ts

@@ -0,0 +1,14 @@
+export declare const WALLET_PREFIX = "wallet_";
+export declare const CAVEAT_TYPES: Readonly<{
+    restrictReturnedAccounts: "restrictReturnedAccounts";
+}>;
+export declare const LOG_IGNORE_METHODS: string[];
+export declare enum LOG_METHOD_TYPES {
+    restricted = "restricted",
+    internal = "internal"
+}
+/**
+ * The permission activity log size limit.
+ */
+export declare const LOG_LIMIT = 100;
+//# 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;;EAEvB,CAAC;AAEH,eAAO,MAAM,kBAAkB,UAG9B,CAAC;AAEF,oBAAY,gBAAgB;IAC1B,UAAU,eAAe;IACzB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,MAAM,CAAC"}

package/dist/enums.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG_LIMIT = exports.LOG_METHOD_TYPES = exports.LOG_IGNORE_METHODS = exports.CAVEAT_TYPES = exports.WALLET_PREFIX = void 0;
+exports.WALLET_PREFIX = 'wallet_';
+exports.CAVEAT_TYPES = Object.freeze({
+    restrictReturnedAccounts: 'restrictReturnedAccounts',
+});
+exports.LOG_IGNORE_METHODS = [
+    'wallet_registerOnboarding',
+    'wallet_watchAsset',
+];
+var LOG_METHOD_TYPES;
+(function (LOG_METHOD_TYPES) {
+    LOG_METHOD_TYPES["restricted"] = "restricted";
+    LOG_METHOD_TYPES["internal"] = "internal";
+})(LOG_METHOD_TYPES = exports.LOG_METHOD_TYPES || (exports.LOG_METHOD_TYPES = {}));
+/**
+ * The permission activity log size limit.
+ */
+exports.LOG_LIMIT = 100;
+//# 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,QAAA,aAAa,GAAG,SAAS,CAAC;AAE1B,QAAA,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,wBAAwB,EAAE,0BAAmC;CAC9D,CAAC,CAAC;AAEU,QAAA,kBAAkB,GAAG;IAChC,2BAA2B;IAC3B,mBAAmB;CACpB,CAAC;AAEF,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,yCAAqB,CAAA;AACvB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED;;GAEG;AACU,QAAA,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\nexport enum LOG_METHOD_TYPES {\n  restricted = 'restricted',\n  internal = 'internal',\n}\n\n/**\n * The permission activity log size limit.\n */\nexport const LOG_LIMIT = 100;\n"]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PermissionLogController';
+//# 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,cAAc,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PermissionLogController"), exports);
+//# 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,4DAA0C","sourcesContent":["export * from './PermissionLogController';\n"]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@metamask-previews/permission-log-controller",
+  "version": "0.0.0-preview.3fbb6b41",
+  "description": "Controller with middleware for logging requests and responses to restricted and permissions-related methods",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/permission-log-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/permission-log-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest --reporters=jest-silent-reporter",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^4.0.0",
+    "@metamask/json-rpc-engine": "^7.3.0",
+    "@metamask/utils": "^8.2.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.3",
+    "@types/deep-freeze-strict": "^1.1.0",
+    "@types/jest": "^27.4.1",
+    "deep-freeze-strict": "^1.1.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "nanoid": "^3.1.31",
+    "sinon": "^9.2.4",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~4.8.4"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}