@metamask-previews/gator-permissions-controller 0.0.0-preview-541d905c

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 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]
+
+### Added
+
+- Initial release ([#6033](https://github.com/MetaMask/core/pull/6033))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,38 @@
+# `@metamask/gator-permissions-controller`
+
+A dedicated controller for reading gator permissions from profile sync storage. This controller fetches data from the encrypted user storage database and caches it locally, providing fast access to permissions across devices while maintaining privacy through client-side encryption.
+
+## Installation
+
+`yarn add @metamask/gator-permissions-controller`
+
+or
+
+`npm install @metamask/gator-permissions-controller`
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { GatorPermissionsController } from '@metamask/gator-permissions-controller';
+
+// Create the controller
+const gatorPermissionsController = new GatorPermissionsController({
+  messenger: yourMessenger,
+});
+
+// Enable the feature (requires authentication)
+gatorPermissionsController.enableGatorPermissions();
+```
+
+### Fetch from Profile Sync
+
+```typescript
+const permissions =
+  await gatorPermissionsController.fetchAndUpdateGatorPermissions();
+```
+
+## 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/GatorPermissionsController.cjs

@@ -0,0 +1,238 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GatorPermissionsController_instances, _GatorPermissionsController_setIsFetchingGatorPermissions, _GatorPermissionsController_setIsGatorPermissionsEnabled, _GatorPermissionsController_registerMessageHandlers, _GatorPermissionsController_assertGatorPermissionsEnabled, _GatorPermissionsController_handleSnapRequestToGatorPermissionsProvider, _GatorPermissionsController_sanitizeStoredGatorPermission, _GatorPermissionsController_categorizePermissionsDataByTypeAndChainId;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultGatorPermissionsControllerState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const errors_1 = require("./errors.cjs");
+const logger_1 = require("./logger.cjs");
+const types_1 = require("./types.cjs");
+const utils_1 = require("./utils.cjs");
+// === GENERAL ===
+// Unique name for the controller
+const controllerName = 'GatorPermissionsController';
+// Default value for the gator permissions provider snap id
+const defaultGatorPermissionsProviderSnapId = '@metamask/gator-permissions-snap';
+const defaultGatorPermissionsMap = {
+    'native-token-stream': {},
+    'native-token-periodic': {},
+    'erc20-token-stream': {},
+    'erc20-token-periodic': {},
+    other: {},
+};
+const gatorPermissionsControllerMetadata = {
+    isGatorPermissionsEnabled: {
+        persist: true,
+        anonymous: false,
+    },
+    gatorPermissionsMapSerialized: {
+        persist: true,
+        anonymous: false,
+    },
+    isFetchingGatorPermissions: {
+        persist: false,
+        anonymous: false,
+    },
+    gatorPermissionsProviderSnapId: {
+        persist: false,
+        anonymous: false,
+    },
+};
+/**
+ * Constructs the default {@link GatorPermissionsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link GatorPermissionsController} state.
+ */
+function getDefaultGatorPermissionsControllerState() {
+    return {
+        isGatorPermissionsEnabled: false,
+        gatorPermissionsMapSerialized: (0, utils_1.serializeGatorPermissionsMap)(defaultGatorPermissionsMap),
+        isFetchingGatorPermissions: false,
+        gatorPermissionsProviderSnapId: defaultGatorPermissionsProviderSnapId,
+    };
+}
+exports.getDefaultGatorPermissionsControllerState = getDefaultGatorPermissionsControllerState;
+/**
+ * Controller that manages gator permissions by reading from profile sync
+ */
+class GatorPermissionsController extends base_controller_1.BaseController {
+    /**
+     * Creates a GatorPermissionsController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }) {
+        super({
+            name: controllerName,
+            metadata: gatorPermissionsControllerMetadata,
+            messenger,
+            state: {
+                ...getDefaultGatorPermissionsControllerState(),
+                ...state,
+                isFetchingGatorPermissions: false,
+            },
+        });
+        _GatorPermissionsController_instances.add(this);
+        __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_registerMessageHandlers).call(this);
+    }
+    /**
+     * Gets the gator permissions map from the state.
+     *
+     * @returns The gator permissions map.
+     */
+    get gatorPermissionsMap() {
+        return (0, utils_1.deserializeGatorPermissionsMap)(this.state.gatorPermissionsMapSerialized);
+    }
+    /**
+     * Gets the gator permissions provider snap id that is used to fetch gator permissions.
+     *
+     * @returns The gator permissions provider snap id.
+     */
+    get permissionsProviderSnapId() {
+        return this.state.gatorPermissionsProviderSnapId;
+    }
+    /**
+     * Enables gator permissions for the user.
+     */
+    async enableGatorPermissions() {
+        __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_setIsGatorPermissionsEnabled).call(this, true);
+    }
+    /**
+     * Clears the gator permissions map and disables the feature.
+     */
+    async disableGatorPermissions() {
+        this.update((state) => {
+            state.isGatorPermissionsEnabled = false;
+            state.gatorPermissionsMapSerialized = (0, utils_1.serializeGatorPermissionsMap)(defaultGatorPermissionsMap);
+        });
+    }
+    /**
+     * Fetches the gator permissions from profile sync and updates the state.
+     *
+     * @returns A promise that resolves to the gator permissions map.
+     * @throws {GatorPermissionsFetchError} If the gator permissions fetch fails.
+     */
+    async fetchAndUpdateGatorPermissions() {
+        try {
+            __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_setIsFetchingGatorPermissions).call(this, true);
+            __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_assertGatorPermissionsEnabled).call(this);
+            const permissionsData = await __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_handleSnapRequestToGatorPermissionsProvider).call(this, {
+                snapId: this.state.gatorPermissionsProviderSnapId,
+            });
+            const gatorPermissionsMap = __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_categorizePermissionsDataByTypeAndChainId).call(this, permissionsData);
+            this.update((state) => {
+                state.gatorPermissionsMapSerialized =
+                    (0, utils_1.serializeGatorPermissionsMap)(gatorPermissionsMap);
+            });
+            return gatorPermissionsMap;
+        }
+        catch (error) {
+            (0, logger_1.controllerLog)('Failed to fetch gator permissions', error);
+            throw new errors_1.GatorPermissionsFetchError({
+                message: 'Failed to fetch gator permissions',
+                cause: error,
+            });
+        }
+        finally {
+            __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_setIsFetchingGatorPermissions).call(this, false);
+        }
+    }
+}
+_GatorPermissionsController_instances = new WeakSet(), _GatorPermissionsController_setIsFetchingGatorPermissions = function _GatorPermissionsController_setIsFetchingGatorPermissions(isFetchingGatorPermissions) {
+    this.update((state) => {
+        state.isFetchingGatorPermissions = isFetchingGatorPermissions;
+    });
+}, _GatorPermissionsController_setIsGatorPermissionsEnabled = function _GatorPermissionsController_setIsGatorPermissionsEnabled(isGatorPermissionsEnabled) {
+    this.update((state) => {
+        state.isGatorPermissionsEnabled = isGatorPermissionsEnabled;
+    });
+}, _GatorPermissionsController_registerMessageHandlers = function _GatorPermissionsController_registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler(`${controllerName}:fetchAndUpdateGatorPermissions`, this.fetchAndUpdateGatorPermissions.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:enableGatorPermissions`, this.enableGatorPermissions.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:disableGatorPermissions`, this.disableGatorPermissions.bind(this));
+}, _GatorPermissionsController_assertGatorPermissionsEnabled = function _GatorPermissionsController_assertGatorPermissionsEnabled() {
+    if (!this.state.isGatorPermissionsEnabled) {
+        throw new errors_1.GatorPermissionsNotEnabledError();
+    }
+}, _GatorPermissionsController_handleSnapRequestToGatorPermissionsProvider = 
+/**
+ * Forwards a Snap request to the SnapController.
+ *
+ * @param args - The request parameters.
+ * @param args.snapId - The ID of the Snap of the gator permissions provider snap.
+ * @returns A promise that resolves with the gator permissions.
+ */
+async function _GatorPermissionsController_handleSnapRequestToGatorPermissionsProvider({ snapId, }) {
+    try {
+        const response = (await this.messagingSystem.call('SnapController:handleRequest', {
+            snapId,
+            origin: 'metamask',
+            handler: snaps_utils_1.HandlerType.OnRpcRequest,
+            request: {
+                jsonrpc: '2.0',
+                method: types_1.GatorPermissionsSnapRpcMethod.PermissionProviderGetGrantedPermissions,
+            },
+        }));
+        return response;
+    }
+    catch (error) {
+        (0, logger_1.controllerLog)('Failed to handle snap request to gator permissions provider', error);
+        throw new errors_1.GatorPermissionsProviderError({
+            method: types_1.GatorPermissionsSnapRpcMethod.PermissionProviderGetGrantedPermissions,
+            cause: error,
+        });
+    }
+}, _GatorPermissionsController_sanitizeStoredGatorPermission = function _GatorPermissionsController_sanitizeStoredGatorPermission(storedGatorPermission) {
+    const { permissionResponse } = storedGatorPermission;
+    const { isAdjustmentAllowed, accountMeta, signer, ...rest } = permissionResponse;
+    return {
+        ...storedGatorPermission,
+        permissionResponse: { ...rest },
+    };
+}, _GatorPermissionsController_categorizePermissionsDataByTypeAndChainId = function _GatorPermissionsController_categorizePermissionsDataByTypeAndChainId(storedGatorPermissions) {
+    if (!storedGatorPermissions) {
+        return defaultGatorPermissionsMap;
+    }
+    return storedGatorPermissions.reduce((gatorPermissionsMap, storedGatorPermission) => {
+        const { permissionResponse } = storedGatorPermission;
+        const permissionType = permissionResponse.permission.type;
+        const { chainId } = permissionResponse;
+        const sanitizedStoredGatorPermission = __classPrivateFieldGet(this, _GatorPermissionsController_instances, "m", _GatorPermissionsController_sanitizeStoredGatorPermission).call(this, storedGatorPermission);
+        switch (permissionType) {
+            case 'native-token-stream':
+            case 'native-token-periodic':
+            case 'erc20-token-stream':
+            case 'erc20-token-periodic':
+                if (!gatorPermissionsMap[permissionType][chainId]) {
+                    gatorPermissionsMap[permissionType][chainId] = [];
+                }
+                gatorPermissionsMap[permissionType][chainId].push(sanitizedStoredGatorPermission);
+                break;
+            default:
+                if (!gatorPermissionsMap.other[chainId]) {
+                    gatorPermissionsMap.other[chainId] = [];
+                }
+                gatorPermissionsMap.other[chainId].push(sanitizedStoredGatorPermission);
+                break;
+        }
+        return gatorPermissionsMap;
+    }, {
+        'native-token-stream': {},
+        'native-token-periodic': {},
+        'erc20-token-stream': {},
+        'erc20-token-periodic': {},
+        other: {},
+    });
+};
+exports.default = GatorPermissionsController;
+//# sourceMappingURL=GatorPermissionsController.cjs.map

package/dist/GatorPermissionsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatorPermissionsController.cjs","sourceRoot":"","sources":["../src/GatorPermissionsController.ts"],"names":[],"mappings":";;;;;;;;;AAMA,+DAA2D;AAG3D,uDAAoD;AAEpD,yCAIkB;AAClB,yCAAyC;AAEzC,uCAMiB;AACjB,uCAGiB;AAEjB,kBAAkB;AAElB,iCAAiC;AACjC,MAAM,cAAc,GAAG,4BAA4B,CAAC;AAEpD,2DAA2D;AAC3D,MAAM,qCAAqC,GACzC,kCAA4C,CAAC;AAE/C,MAAM,0BAA0B,GAAwB;IACtD,qBAAqB,EAAE,EAAE;IACzB,uBAAuB,EAAE,EAAE;IAC3B,oBAAoB,EAAE,EAAE;IACxB,sBAAsB,EAAE,EAAE;IAC1B,KAAK,EAAE,EAAE;CACV,CAAC;AA+BF,MAAM,kCAAkC,GAAG;IACzC,yBAAyB,EAAE;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,6BAA6B,EAAE;QAC7B,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,0BAA0B,EAAE;QAC1B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;IACD,8BAA8B,EAAE;QAC9B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;KACjB;CACuD,CAAC;AAE3D;;;;;;;GAOG;AACH,SAAgB,yCAAyC;IACvD,OAAO;QACL,yBAAyB,EAAE,KAAK;QAChC,6BAA6B,EAAE,IAAA,oCAA4B,EACzD,0BAA0B,CAC3B;QACD,0BAA0B,EAAE,KAAK;QACjC,8BAA8B,EAAE,qCAAqC;KACtE,CAAC;AACJ,CAAC;AATD,8FASC;AAuFD;;GAEG;AACH,MAAqB,0BAA2B,SAAQ,gCAIvD;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,kCAAkC;YAC5C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,yCAAyC,EAAE;gBAC9C,GAAG,KAAK;gBACR,0BAA0B,EAAE,KAAK;aAClC;SACF,CAAC,CAAC;;QAEH,uBAAA,IAAI,kGAAyB,MAA7B,IAAI,CAA2B,CAAC;IAClC,CAAC;IA2KD;;;;OAIG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAA,sCAA8B,EACnC,IAAI,CAAC,KAAK,CAAC,6BAA6B,CACzC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,sBAAsB;QACjC,uBAAA,IAAI,uGAA8B,MAAlC,IAAI,EAA+B,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,uBAAuB;QAClC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,yBAAyB,GAAG,KAAK,CAAC;YACxC,KAAK,CAAC,6BAA6B,GAAG,IAAA,oCAA4B,EAChE,0BAA0B,CAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,8BAA8B;QACzC,IAAI;YACF,uBAAA,IAAI,wGAA+B,MAAnC,IAAI,EAAgC,IAAI,CAAC,CAAC;YAC1C,uBAAA,IAAI,wGAA+B,MAAnC,IAAI,CAAiC,CAAC;YAEtC,MAAM,eAAe,GACnB,MAAM,uBAAA,IAAI,sHAA6C,MAAjD,IAAI,EAA8C;gBACtD,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,8BAA8B;aAClD,CAAC,CAAC;YAEL,MAAM,mBAAmB,GACvB,uBAAA,IAAI,oHAA2C,MAA/C,IAAI,EAA4C,eAAe,CAAC,CAAC;YAEnE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,6BAA6B;oBACjC,IAAA,oCAA4B,EAAC,mBAAmB,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;YAEH,OAAO,mBAAmB,CAAC;SAC5B;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,sBAAa,EAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;YAC1D,MAAM,IAAI,mCAA0B,CAAC;gBACnC,OAAO,EAAE,mCAAmC;gBAC5C,KAAK,EAAE,KAAc;aACtB,CAAC,CAAC;SACJ;gBAAS;YACR,uBAAA,IAAI,wGAA+B,MAAnC,IAAI,EAAgC,KAAK,CAAC,CAAC;SAC5C;IACH,CAAC;CACF;sLAnPgC,0BAAmC;IAChE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,0BAA0B,GAAG,0BAA0B,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,+HAE6B,yBAAkC;IAC9D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC;IAGC,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,iCAAiC,EAClD,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/C,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,yBAAyB,EAC1C,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,cAAc,0BAA0B,EAC3C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACxC,CAAC;AACJ,CAAC;IAQC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE;QACzC,MAAM,IAAI,wCAA+B,EAAE,CAAC;KAC7C;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,kFAA8C,EACjD,MAAM,GAGP;IACC,IAAI;QACF,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAC/C,8BAA8B,EAC9B;YACE,MAAM;YACN,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,yBAAW,CAAC,YAAY;YACjC,OAAO,EAAE;gBACP,OAAO,EAAE,KAAK;gBACd,MAAM,EACJ,qCAA6B,CAAC,uCAAuC;aACxE;SACF,CACF,CAAiE,CAAC;QAEnE,OAAO,QAAQ,CAAC;KACjB;IAAC,OAAO,KAAK,EAAE;QACd,IAAA,sBAAa,EACX,6DAA6D,EAC7D,KAAK,CACN,CAAC;QACF,MAAM,IAAI,sCAA6B,CAAC;YACtC,MAAM,EACJ,qCAA6B,CAAC,uCAAuC;YACvE,KAAK,EAAE,KAAc;SACtB,CAAC,CAAC;KACJ;AACH,CAAC,iIASC,qBAA0E;IAE1E,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAC;IACrD,MAAM,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GACzD,kBAAkB,CAAC;IACrB,OAAO;QACL,GAAG,qBAAqB;QACxB,kBAAkB,EAAE,EAAE,GAAG,IAAI,EAAE;KAChC,CAAC;AACJ,CAAC,yJASC,sBAEQ;IAER,IAAI,CAAC,sBAAsB,EAAE;QAC3B,OAAO,0BAA0B,CAAC;KACnC;IAED,OAAO,sBAAsB,CAAC,MAAM,CAClC,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,EAAE;QAC7C,MAAM,EAAE,kBAAkB,EAAE,GAAG,qBAAqB,CAAC;QACrD,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,kBAAkB,CAAC;QAEvC,MAAM,8BAA8B,GAClC,uBAAA,IAAI,wGAA+B,MAAnC,IAAI,EAAgC,qBAAqB,CAAC,CAAC;QAE7D,QAAQ,cAAc,EAAE;YACtB,KAAK,qBAAqB,CAAC;YAC3B,KAAK,uBAAuB,CAAC;YAC7B,KAAK,oBAAoB,CAAC;YAC1B,KAAK,sBAAsB;gBACzB,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,EAAE;oBACjD,mBAAmB,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;iBACnD;gBAGC,mBAAmB,CAAC,cAAc,CAAC,CACjC,OAAO,CAKV,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;gBACvC,MAAM;YACR;gBACE,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;oBACvC,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;iBACzC;gBAGC,mBAAmB,CAAC,KAAK,CACvB,OAAO,CAKV,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;gBACvC,MAAM;SACT;QAED,OAAO,mBAAmB,CAAC;IAC7B,CAAC,EACD;QACE,qBAAqB,EAAE,EAAE;QACzB,uBAAuB,EAAE,EAAE;QAC3B,oBAAoB,EAAE,EAAE;QACxB,sBAAsB,EAAE,EAAE;QAC1B,KAAK,EAAE,EAAE;KACa,CACzB,CAAC;AACJ,CAAC;kBAxMkB,0BAA0B","sourcesContent":["import type {\n  RestrictedMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { HandleSnapRequest, HasSnap } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\n\nimport {\n  GatorPermissionsFetchError,\n  GatorPermissionsNotEnabledError,\n  GatorPermissionsProviderError,\n} from './errors';\nimport { controllerLog } from './logger';\nimport type { StoredGatorPermissionSanitized } from './types';\nimport {\n  GatorPermissionsSnapRpcMethod,\n  type GatorPermissionsMap,\n  type PermissionTypes,\n  type SignerParam,\n  type StoredGatorPermission,\n} from './types';\nimport {\n  deserializeGatorPermissionsMap,\n  serializeGatorPermissionsMap,\n} from './utils';\n\n// === GENERAL ===\n\n// Unique name for the controller\nconst controllerName = 'GatorPermissionsController';\n\n// Default value for the gator permissions provider snap id\nconst defaultGatorPermissionsProviderSnapId =\n  '@metamask/gator-permissions-snap' as SnapId;\n\nconst defaultGatorPermissionsMap: GatorPermissionsMap = {\n  'native-token-stream': {},\n  'native-token-periodic': {},\n  'erc20-token-stream': {},\n  'erc20-token-periodic': {},\n  other: {},\n};\n\n// === STATE ===\n\n/**\n * State shape for GatorPermissionsController\n */\nexport type GatorPermissionsControllerState = {\n  /**\n   * Flag that indicates if the gator permissions feature is enabled\n   */\n  isGatorPermissionsEnabled: boolean;\n\n  /**\n   * JSON serialized object containing gator permissions fetched from profile sync\n   */\n  gatorPermissionsMapSerialized: string;\n\n  /**\n   * Flag that indicates that fetching permissions is in progress\n   * This is used to show a loading spinner in the UI\n   */\n  isFetchingGatorPermissions: boolean;\n\n  /**\n   * The ID of the Snap of the gator permissions provider snap\n   * Default value is `@metamask/gator-permissions-snap`\n   */\n  gatorPermissionsProviderSnapId: SnapId;\n};\n\nconst gatorPermissionsControllerMetadata = {\n  isGatorPermissionsEnabled: {\n    persist: true,\n    anonymous: false,\n  },\n  gatorPermissionsMapSerialized: {\n    persist: true,\n    anonymous: false,\n  },\n  isFetchingGatorPermissions: {\n    persist: false,\n    anonymous: false,\n  },\n  gatorPermissionsProviderSnapId: {\n    persist: false,\n    anonymous: false,\n  },\n} satisfies StateMetadata<GatorPermissionsControllerState>;\n\n/**\n * Constructs the default {@link GatorPermissionsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link GatorPermissionsController} state.\n */\nexport function getDefaultGatorPermissionsControllerState(): GatorPermissionsControllerState {\n  return {\n    isGatorPermissionsEnabled: false,\n    gatorPermissionsMapSerialized: serializeGatorPermissionsMap(\n      defaultGatorPermissionsMap,\n    ),\n    isFetchingGatorPermissions: false,\n    gatorPermissionsProviderSnapId: defaultGatorPermissionsProviderSnapId,\n  };\n}\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link GatorPermissionsController}.\n */\nexport type GatorPermissionsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  GatorPermissionsControllerState\n>;\n\n/**\n * The action which can be used to fetch and update gator permissions.\n */\nexport type GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction = {\n  type: `${typeof controllerName}:fetchAndUpdateGatorPermissions`;\n  handler: GatorPermissionsController['fetchAndUpdateGatorPermissions'];\n};\n\n/**\n * The action which can be used to enable gator permissions.\n */\nexport type GatorPermissionsControllerEnableGatorPermissionsAction = {\n  type: `${typeof controllerName}:enableGatorPermissions`;\n  handler: GatorPermissionsController['enableGatorPermissions'];\n};\n\n/**\n * The action which can be used to disable gator permissions.\n */\nexport type GatorPermissionsControllerDisableGatorPermissionsAction = {\n  type: `${typeof controllerName}:disableGatorPermissions`;\n  handler: GatorPermissionsController['disableGatorPermissions'];\n};\n\n/**\n * All actions that {@link GatorPermissionsController} registers, to be called\n * externally.\n */\nexport type GatorPermissionsControllerActions =\n  | GatorPermissionsControllerGetStateAction\n  | GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction\n  | GatorPermissionsControllerEnableGatorPermissionsAction\n  | GatorPermissionsControllerDisableGatorPermissionsAction;\n\n/**\n * All actions that {@link GatorPermissionsController} calls internally.\n *\n * SnapsController:handleRequest and SnapsController:has are allowed to be called\n * internally because they are used to fetch gator permissions from the Snap.\n */\ntype AllowedActions = HandleSnapRequest | HasSnap;\n\n/**\n * The event that {@link GatorPermissionsController} publishes when updating state.\n */\nexport type GatorPermissionsControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    GatorPermissionsControllerState\n  >;\n\n/**\n * All events that {@link GatorPermissionsController} publishes, to be subscribed to\n * externally.\n */\nexport type GatorPermissionsControllerEvents =\n  GatorPermissionsControllerStateChangeEvent;\n\n/**\n * Events that {@link GatorPermissionsController} is allowed to subscribe to internally.\n */\ntype AllowedEvents = GatorPermissionsControllerStateChangeEvent;\n\n/**\n * Messenger type for the GatorPermissionsController.\n */\nexport type GatorPermissionsControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  GatorPermissionsControllerActions | AllowedActions,\n  GatorPermissionsControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that manages gator permissions by reading from profile sync\n */\nexport default class GatorPermissionsController extends BaseController<\n  typeof controllerName,\n  GatorPermissionsControllerState,\n  GatorPermissionsControllerMessenger\n> {\n  /**\n   * Creates a GatorPermissionsController instance.\n   *\n   * @param args - The arguments to this function.\n   * @param args.messenger - Messenger used to communicate with BaseV2 controller.\n   * @param args.state - Initial state to set on this controller.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: GatorPermissionsControllerMessenger;\n    state?: Partial<GatorPermissionsControllerState>;\n  }) {\n    super({\n      name: controllerName,\n      metadata: gatorPermissionsControllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultGatorPermissionsControllerState(),\n        ...state,\n        isFetchingGatorPermissions: false,\n      },\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  #setIsFetchingGatorPermissions(isFetchingGatorPermissions: boolean) {\n    this.update((state) => {\n      state.isFetchingGatorPermissions = isFetchingGatorPermissions;\n    });\n  }\n\n  #setIsGatorPermissionsEnabled(isGatorPermissionsEnabled: boolean) {\n    this.update((state) => {\n      state.isGatorPermissionsEnabled = isGatorPermissionsEnabled;\n    });\n  }\n\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:fetchAndUpdateGatorPermissions`,\n      this.fetchAndUpdateGatorPermissions.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:enableGatorPermissions`,\n      this.enableGatorPermissions.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:disableGatorPermissions`,\n      this.disableGatorPermissions.bind(this),\n    );\n  }\n\n  /**\n   * Asserts that the gator permissions are enabled.\n   *\n   * @throws {GatorPermissionsNotEnabledError} If the gator permissions are not enabled.\n   */\n  #assertGatorPermissionsEnabled() {\n    if (!this.state.isGatorPermissionsEnabled) {\n      throw new GatorPermissionsNotEnabledError();\n    }\n  }\n\n  /**\n   * Forwards a Snap request to the SnapController.\n   *\n   * @param args - The request parameters.\n   * @param args.snapId - The ID of the Snap of the gator permissions provider snap.\n   * @returns A promise that resolves with the gator permissions.\n   */\n  async #handleSnapRequestToGatorPermissionsProvider({\n    snapId,\n  }: {\n    snapId: SnapId;\n  }): Promise<StoredGatorPermission<SignerParam, PermissionTypes>[] | null> {\n    try {\n      const response = (await this.messagingSystem.call(\n        'SnapController:handleRequest',\n        {\n          snapId,\n          origin: 'metamask',\n          handler: HandlerType.OnRpcRequest,\n          request: {\n            jsonrpc: '2.0',\n            method:\n              GatorPermissionsSnapRpcMethod.PermissionProviderGetGrantedPermissions,\n          },\n        },\n      )) as StoredGatorPermission<SignerParam, PermissionTypes>[] | null;\n\n      return response;\n    } catch (error) {\n      controllerLog(\n        'Failed to handle snap request to gator permissions provider',\n        error,\n      );\n      throw new GatorPermissionsProviderError({\n        method:\n          GatorPermissionsSnapRpcMethod.PermissionProviderGetGrantedPermissions,\n        cause: error as Error,\n      });\n    }\n  }\n\n  /**\n   * Sanitizes a stored gator permission by removing the fields that are not expose to MetaMask client.\n   *\n   * @param storedGatorPermission - The stored gator permission to sanitize.\n   * @returns The sanitized stored gator permission.\n   */\n  #sanitizeStoredGatorPermission(\n    storedGatorPermission: StoredGatorPermission<SignerParam, PermissionTypes>,\n  ): StoredGatorPermissionSanitized<SignerParam, PermissionTypes> {\n    const { permissionResponse } = storedGatorPermission;\n    const { isAdjustmentAllowed, accountMeta, signer, ...rest } =\n      permissionResponse;\n    return {\n      ...storedGatorPermission,\n      permissionResponse: { ...rest },\n    };\n  }\n\n  /**\n   * Categorizes stored gator permissions by type and chainId.\n   *\n   * @param storedGatorPermissions - An array of stored gator permissions.\n   * @returns The gator permissions map.\n   */\n  #categorizePermissionsDataByTypeAndChainId(\n    storedGatorPermissions:\n      | StoredGatorPermission<SignerParam, PermissionTypes>[]\n      | null,\n  ): GatorPermissionsMap {\n    if (!storedGatorPermissions) {\n      return defaultGatorPermissionsMap;\n    }\n\n    return storedGatorPermissions.reduce(\n      (gatorPermissionsMap, storedGatorPermission) => {\n        const { permissionResponse } = storedGatorPermission;\n        const permissionType = permissionResponse.permission.type;\n        const { chainId } = permissionResponse;\n\n        const sanitizedStoredGatorPermission =\n          this.#sanitizeStoredGatorPermission(storedGatorPermission);\n\n        switch (permissionType) {\n          case 'native-token-stream':\n          case 'native-token-periodic':\n          case 'erc20-token-stream':\n          case 'erc20-token-periodic':\n            if (!gatorPermissionsMap[permissionType][chainId]) {\n              gatorPermissionsMap[permissionType][chainId] = [];\n            }\n\n            (\n              gatorPermissionsMap[permissionType][\n                chainId\n              ] as StoredGatorPermissionSanitized<\n                SignerParam,\n                PermissionTypes\n              >[]\n            ).push(sanitizedStoredGatorPermission);\n            break;\n          default:\n            if (!gatorPermissionsMap.other[chainId]) {\n              gatorPermissionsMap.other[chainId] = [];\n            }\n\n            (\n              gatorPermissionsMap.other[\n                chainId\n              ] as StoredGatorPermissionSanitized<\n                SignerParam,\n                PermissionTypes\n              >[]\n            ).push(sanitizedStoredGatorPermission);\n            break;\n        }\n\n        return gatorPermissionsMap;\n      },\n      {\n        'native-token-stream': {},\n        'native-token-periodic': {},\n        'erc20-token-stream': {},\n        'erc20-token-periodic': {},\n        other: {},\n      } as GatorPermissionsMap,\n    );\n  }\n\n  /**\n   * Gets the gator permissions map from the state.\n   *\n   * @returns The gator permissions map.\n   */\n  get gatorPermissionsMap(): GatorPermissionsMap {\n    return deserializeGatorPermissionsMap(\n      this.state.gatorPermissionsMapSerialized,\n    );\n  }\n\n  /**\n   * Gets the gator permissions provider snap id that is used to fetch gator permissions.\n   *\n   * @returns The gator permissions provider snap id.\n   */\n  get permissionsProviderSnapId(): SnapId {\n    return this.state.gatorPermissionsProviderSnapId;\n  }\n\n  /**\n   * Enables gator permissions for the user.\n   */\n  public async enableGatorPermissions() {\n    this.#setIsGatorPermissionsEnabled(true);\n  }\n\n  /**\n   * Clears the gator permissions map and disables the feature.\n   */\n  public async disableGatorPermissions() {\n    this.update((state) => {\n      state.isGatorPermissionsEnabled = false;\n      state.gatorPermissionsMapSerialized = serializeGatorPermissionsMap(\n        defaultGatorPermissionsMap,\n      );\n    });\n  }\n\n  /**\n   * Fetches the gator permissions from profile sync and updates the state.\n   *\n   * @returns A promise that resolves to the gator permissions map.\n   * @throws {GatorPermissionsFetchError} If the gator permissions fetch fails.\n   */\n  public async fetchAndUpdateGatorPermissions(): Promise<GatorPermissionsMap> {\n    try {\n      this.#setIsFetchingGatorPermissions(true);\n      this.#assertGatorPermissionsEnabled();\n\n      const permissionsData =\n        await this.#handleSnapRequestToGatorPermissionsProvider({\n          snapId: this.state.gatorPermissionsProviderSnapId,\n        });\n\n      const gatorPermissionsMap =\n        this.#categorizePermissionsDataByTypeAndChainId(permissionsData);\n\n      this.update((state) => {\n        state.gatorPermissionsMapSerialized =\n          serializeGatorPermissionsMap(gatorPermissionsMap);\n      });\n\n      return gatorPermissionsMap;\n    } catch (error) {\n      controllerLog('Failed to fetch gator permissions', error);\n      throw new GatorPermissionsFetchError({\n        message: 'Failed to fetch gator permissions',\n        cause: error as Error,\n      });\n    } finally {\n      this.#setIsFetchingGatorPermissions(false);\n    }\n  }\n}\n"]}

package/dist/GatorPermissionsController.d.cts

@@ -0,0 +1,139 @@
+import type { RestrictedMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { HandleSnapRequest, HasSnap } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import { type GatorPermissionsMap } from "./types.cjs";
+declare const controllerName = "GatorPermissionsController";
+/**
+ * State shape for GatorPermissionsController
+ */
+export type GatorPermissionsControllerState = {
+    /**
+     * Flag that indicates if the gator permissions feature is enabled
+     */
+    isGatorPermissionsEnabled: boolean;
+    /**
+     * JSON serialized object containing gator permissions fetched from profile sync
+     */
+    gatorPermissionsMapSerialized: string;
+    /**
+     * Flag that indicates that fetching permissions is in progress
+     * This is used to show a loading spinner in the UI
+     */
+    isFetchingGatorPermissions: boolean;
+    /**
+     * The ID of the Snap of the gator permissions provider snap
+     * Default value is `@metamask/gator-permissions-snap`
+     */
+    gatorPermissionsProviderSnapId: SnapId;
+};
+/**
+ * Constructs the default {@link GatorPermissionsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link GatorPermissionsController} state.
+ */
+export declare function getDefaultGatorPermissionsControllerState(): GatorPermissionsControllerState;
+/**
+ * The action which can be used to retrieve the state of the
+ * {@link GatorPermissionsController}.
+ */
+export type GatorPermissionsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, GatorPermissionsControllerState>;
+/**
+ * The action which can be used to fetch and update gator permissions.
+ */
+export type GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction = {
+    type: `${typeof controllerName}:fetchAndUpdateGatorPermissions`;
+    handler: GatorPermissionsController['fetchAndUpdateGatorPermissions'];
+};
+/**
+ * The action which can be used to enable gator permissions.
+ */
+export type GatorPermissionsControllerEnableGatorPermissionsAction = {
+    type: `${typeof controllerName}:enableGatorPermissions`;
+    handler: GatorPermissionsController['enableGatorPermissions'];
+};
+/**
+ * The action which can be used to disable gator permissions.
+ */
+export type GatorPermissionsControllerDisableGatorPermissionsAction = {
+    type: `${typeof controllerName}:disableGatorPermissions`;
+    handler: GatorPermissionsController['disableGatorPermissions'];
+};
+/**
+ * All actions that {@link GatorPermissionsController} registers, to be called
+ * externally.
+ */
+export type GatorPermissionsControllerActions = GatorPermissionsControllerGetStateAction | GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction | GatorPermissionsControllerEnableGatorPermissionsAction | GatorPermissionsControllerDisableGatorPermissionsAction;
+/**
+ * All actions that {@link GatorPermissionsController} calls internally.
+ *
+ * SnapsController:handleRequest and SnapsController:has are allowed to be called
+ * internally because they are used to fetch gator permissions from the Snap.
+ */
+type AllowedActions = HandleSnapRequest | HasSnap;
+/**
+ * The event that {@link GatorPermissionsController} publishes when updating state.
+ */
+export type GatorPermissionsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, GatorPermissionsControllerState>;
+/**
+ * All events that {@link GatorPermissionsController} publishes, to be subscribed to
+ * externally.
+ */
+export type GatorPermissionsControllerEvents = GatorPermissionsControllerStateChangeEvent;
+/**
+ * Events that {@link GatorPermissionsController} is allowed to subscribe to internally.
+ */
+type AllowedEvents = GatorPermissionsControllerStateChangeEvent;
+/**
+ * Messenger type for the GatorPermissionsController.
+ */
+export type GatorPermissionsControllerMessenger = RestrictedMessenger<typeof controllerName, GatorPermissionsControllerActions | AllowedActions, GatorPermissionsControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Controller that manages gator permissions by reading from profile sync
+ */
+export default class GatorPermissionsController extends BaseController<typeof controllerName, GatorPermissionsControllerState, GatorPermissionsControllerMessenger> {
+    #private;
+    /**
+     * Creates a GatorPermissionsController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }: {
+        messenger: GatorPermissionsControllerMessenger;
+        state?: Partial<GatorPermissionsControllerState>;
+    });
+    /**
+     * Gets the gator permissions map from the state.
+     *
+     * @returns The gator permissions map.
+     */
+    get gatorPermissionsMap(): GatorPermissionsMap;
+    /**
+     * Gets the gator permissions provider snap id that is used to fetch gator permissions.
+     *
+     * @returns The gator permissions provider snap id.
+     */
+    get permissionsProviderSnapId(): SnapId;
+    /**
+     * Enables gator permissions for the user.
+     */
+    enableGatorPermissions(): Promise<void>;
+    /**
+     * Clears the gator permissions map and disables the feature.
+     */
+    disableGatorPermissions(): Promise<void>;
+    /**
+     * Fetches the gator permissions from profile sync and updates the state.
+     *
+     * @returns A promise that resolves to the gator permissions map.
+     * @throws {GatorPermissionsFetchError} If the gator permissions fetch fails.
+     */
+    fetchAndUpdateGatorPermissions(): Promise<GatorPermissionsMap>;
+}
+export {};
+//# sourceMappingURL=GatorPermissionsController.d.cts.map

package/dist/GatorPermissionsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatorPermissionsController.d.cts","sourceRoot":"","sources":["../src/GatorPermissionsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,oCAAoC;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAUlD,OAAO,EAEL,KAAK,mBAAmB,EAIzB,oBAAgB;AASjB,QAAA,MAAM,cAAc,+BAA+B,CAAC;AAgBpD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,8BAA8B,EAAE,MAAM,CAAC;CACxC,CAAC;AAqBF;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,IAAI,+BAA+B,CAS3F;AAID;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAAG,wBAAwB,CAC7E,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8DAA8D,GAAG;IAC3E,IAAI,EAAE,GAAG,OAAO,cAAc,iCAAiC,CAAC;IAChE,OAAO,EAAE,0BAA0B,CAAC,gCAAgC,CAAC,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;CAChE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GACzC,wCAAwC,GACxC,8DAA8D,GAC9D,sDAAsD,GACtD,uDAAuD,CAAC;AAE5D;;;;;GAKG;AACH,KAAK,cAAc,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,0BAA0B,CACxB,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAC1C,0CAA0C,CAAC;AAE7C;;GAEG;AACH,KAAK,aAAa,GAAG,0CAA0C,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,mBAAmB,CACnE,OAAO,cAAc,EACrB,iCAAiC,GAAG,cAAc,EAClD,gCAAgC,GAAG,aAAa,EAChD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,cAAc,CACpE,OAAO,cAAc,EACrB,+BAA+B,EAC/B,mCAAmC,CACpC;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,mCAAmC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAwLD;;;;OAIG;IACH,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED;;;;OAIG;IACH,IAAI,yBAAyB,IAAI,MAAM,CAEtC;IAED;;OAEG;IACU,sBAAsB;IAInC;;OAEG;IACU,uBAAuB;IASpC;;;;;OAKG;IACU,8BAA8B,IAAI,OAAO,CAAC,mBAAmB,CAAC;CA6B5E"}

package/dist/GatorPermissionsController.d.mts

@@ -0,0 +1,139 @@
+import type { RestrictedMessenger, ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { HandleSnapRequest, HasSnap } from "@metamask/snaps-controllers";
+import type { SnapId } from "@metamask/snaps-sdk";
+import { type GatorPermissionsMap } from "./types.mjs";
+declare const controllerName = "GatorPermissionsController";
+/**
+ * State shape for GatorPermissionsController
+ */
+export type GatorPermissionsControllerState = {
+    /**
+     * Flag that indicates if the gator permissions feature is enabled
+     */
+    isGatorPermissionsEnabled: boolean;
+    /**
+     * JSON serialized object containing gator permissions fetched from profile sync
+     */
+    gatorPermissionsMapSerialized: string;
+    /**
+     * Flag that indicates that fetching permissions is in progress
+     * This is used to show a loading spinner in the UI
+     */
+    isFetchingGatorPermissions: boolean;
+    /**
+     * The ID of the Snap of the gator permissions provider snap
+     * Default value is `@metamask/gator-permissions-snap`
+     */
+    gatorPermissionsProviderSnapId: SnapId;
+};
+/**
+ * Constructs the default {@link GatorPermissionsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link GatorPermissionsController} state.
+ */
+export declare function getDefaultGatorPermissionsControllerState(): GatorPermissionsControllerState;
+/**
+ * The action which can be used to retrieve the state of the
+ * {@link GatorPermissionsController}.
+ */
+export type GatorPermissionsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, GatorPermissionsControllerState>;
+/**
+ * The action which can be used to fetch and update gator permissions.
+ */
+export type GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction = {
+    type: `${typeof controllerName}:fetchAndUpdateGatorPermissions`;
+    handler: GatorPermissionsController['fetchAndUpdateGatorPermissions'];
+};
+/**
+ * The action which can be used to enable gator permissions.
+ */
+export type GatorPermissionsControllerEnableGatorPermissionsAction = {
+    type: `${typeof controllerName}:enableGatorPermissions`;
+    handler: GatorPermissionsController['enableGatorPermissions'];
+};
+/**
+ * The action which can be used to disable gator permissions.
+ */
+export type GatorPermissionsControllerDisableGatorPermissionsAction = {
+    type: `${typeof controllerName}:disableGatorPermissions`;
+    handler: GatorPermissionsController['disableGatorPermissions'];
+};
+/**
+ * All actions that {@link GatorPermissionsController} registers, to be called
+ * externally.
+ */
+export type GatorPermissionsControllerActions = GatorPermissionsControllerGetStateAction | GatorPermissionsControllerFetchAndUpdateGatorPermissionsAction | GatorPermissionsControllerEnableGatorPermissionsAction | GatorPermissionsControllerDisableGatorPermissionsAction;
+/**
+ * All actions that {@link GatorPermissionsController} calls internally.
+ *
+ * SnapsController:handleRequest and SnapsController:has are allowed to be called
+ * internally because they are used to fetch gator permissions from the Snap.
+ */
+type AllowedActions = HandleSnapRequest | HasSnap;
+/**
+ * The event that {@link GatorPermissionsController} publishes when updating state.
+ */
+export type GatorPermissionsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, GatorPermissionsControllerState>;
+/**
+ * All events that {@link GatorPermissionsController} publishes, to be subscribed to
+ * externally.
+ */
+export type GatorPermissionsControllerEvents = GatorPermissionsControllerStateChangeEvent;
+/**
+ * Events that {@link GatorPermissionsController} is allowed to subscribe to internally.
+ */
+type AllowedEvents = GatorPermissionsControllerStateChangeEvent;
+/**
+ * Messenger type for the GatorPermissionsController.
+ */
+export type GatorPermissionsControllerMessenger = RestrictedMessenger<typeof controllerName, GatorPermissionsControllerActions | AllowedActions, GatorPermissionsControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Controller that manages gator permissions by reading from profile sync
+ */
+export default class GatorPermissionsController extends BaseController<typeof controllerName, GatorPermissionsControllerState, GatorPermissionsControllerMessenger> {
+    #private;
+    /**
+     * Creates a GatorPermissionsController instance.
+     *
+     * @param args - The arguments to this function.
+     * @param args.messenger - Messenger used to communicate with BaseV2 controller.
+     * @param args.state - Initial state to set on this controller.
+     */
+    constructor({ messenger, state, }: {
+        messenger: GatorPermissionsControllerMessenger;
+        state?: Partial<GatorPermissionsControllerState>;
+    });
+    /**
+     * Gets the gator permissions map from the state.
+     *
+     * @returns The gator permissions map.
+     */
+    get gatorPermissionsMap(): GatorPermissionsMap;
+    /**
+     * Gets the gator permissions provider snap id that is used to fetch gator permissions.
+     *
+     * @returns The gator permissions provider snap id.
+     */
+    get permissionsProviderSnapId(): SnapId;
+    /**
+     * Enables gator permissions for the user.
+     */
+    enableGatorPermissions(): Promise<void>;
+    /**
+     * Clears the gator permissions map and disables the feature.
+     */
+    disableGatorPermissions(): Promise<void>;
+    /**
+     * Fetches the gator permissions from profile sync and updates the state.
+     *
+     * @returns A promise that resolves to the gator permissions map.
+     * @throws {GatorPermissionsFetchError} If the gator permissions fetch fails.
+     */
+    fetchAndUpdateGatorPermissions(): Promise<GatorPermissionsMap>;
+}
+export {};
+//# sourceMappingURL=GatorPermissionsController.d.mts.map

package/dist/GatorPermissionsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatorPermissionsController.d.mts","sourceRoot":"","sources":["../src/GatorPermissionsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,oCAAoC;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAUlD,OAAO,EAEL,KAAK,mBAAmB,EAIzB,oBAAgB;AASjB,QAAA,MAAM,cAAc,+BAA+B,CAAC;AAgBpD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,8BAA8B,EAAE,MAAM,CAAC;CACxC,CAAC;AAqBF;;;;;;;GAOG;AACH,wBAAgB,yCAAyC,IAAI,+BAA+B,CAS3F;AAID;;;GAGG;AACH,MAAM,MAAM,wCAAwC,GAAG,wBAAwB,CAC7E,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8DAA8D,GAAG;IAC3E,IAAI,EAAE,GAAG,OAAO,cAAc,iCAAiC,CAAC;IAChE,OAAO,EAAE,0BAA0B,CAAC,gCAAgC,CAAC,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;CAChE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GACzC,wCAAwC,GACxC,8DAA8D,GAC9D,sDAAsD,GACtD,uDAAuD,CAAC;AAE5D;;;;;GAKG;AACH,KAAK,cAAc,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,0BAA0B,CACxB,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAC1C,0CAA0C,CAAC;AAE7C;;GAEG;AACH,KAAK,aAAa,GAAG,0CAA0C,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,mBAAmB,CACnE,OAAO,cAAc,EACrB,iCAAiC,GAAG,cAAc,EAClD,gCAAgC,GAAG,aAAa,EAChD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,cAAc,CACpE,OAAO,cAAc,EACrB,+BAA+B,EAC/B,mCAAmC,CACpC;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,mCAAmC,CAAC;QAC/C,KAAK,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,CAAC;KAClD;IAwLD;;;;OAIG;IACH,IAAI,mBAAmB,IAAI,mBAAmB,CAI7C;IAED;;;;OAIG;IACH,IAAI,yBAAyB,IAAI,MAAM,CAEtC;IAED;;OAEG;IACU,sBAAsB;IAInC;;OAEG;IACU,uBAAuB;IASpC;;;;;OAKG;IACU,8BAA8B,IAAI,OAAO,CAAC,mBAAmB,CAAC;CA6B5E"}