@metamask-previews/delegation-controller 0.0.0-preview-31a5eea2

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 ([#5592](https://github.com/MetaMask/core/pull/5592))
+
+[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,15 @@
+# `@metamask/delegation-controller`
+
+Centralized place to store and sign delegations.
+
+## Installation
+
+`yarn add @metamask/delegation-controller`
+
+or
+
+`npm install @metamask/delegation-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/DelegationController.cjs

@@ -0,0 +1,210 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DelegationController_hashDelegation, _DelegationController_getDelegationEnvironment;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DelegationController = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const keyring_controller_1 = require("@metamask/keyring-controller");
+const utils_1 = require("@metamask/utils");
+const constants_1 = require("./constants.cjs");
+const utils_2 = require("./utils.cjs");
+exports.controllerName = 'DelegationController';
+const delegationControllerMetadata = {
+    delegations: {
+        persist: true,
+        anonymous: false,
+    },
+};
+/**
+ * Constructs the default {@link DelegationController} 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 DelegationController} state.
+ */
+function getDefaultDelegationControllerState() {
+    return {
+        delegations: {},
+    };
+}
+/**
+ * The {@link DelegationController} class.
+ * This controller is meant to be a centralized place to store and sign delegations.
+ */
+class DelegationController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link DelegationController} instance.
+     *
+     * @param params - The parameters for constructing the controller.
+     * @param params.messenger - The messenger instance to use for the controller.
+     * @param params.state - The initial state for the controller.
+     * @param params.hashDelegation - A function to hash delegations.
+     * @param params.getDelegationEnvironment - A function to get the delegation environment for a given chainId.
+     */
+    constructor({ messenger, state, hashDelegation, getDelegationEnvironment, }) {
+        super({
+            messenger,
+            metadata: delegationControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultDelegationControllerState(),
+                ...state,
+            },
+        });
+        _DelegationController_hashDelegation.set(this, void 0);
+        _DelegationController_getDelegationEnvironment.set(this, void 0);
+        __classPrivateFieldSet(this, _DelegationController_hashDelegation, hashDelegation, "f");
+        __classPrivateFieldSet(this, _DelegationController_getDelegationEnvironment, getDelegationEnvironment, "f");
+    }
+    /**
+     * Signs a delegation.
+     *
+     * @param params - The parameters for signing the delegation.
+     * @param params.delegation - The delegation to sign.
+     * @param params.chainId - The chainId of the chain to sign the delegation for.
+     * @returns The signature of the delegation.
+     */
+    async signDelegation(params) {
+        const { delegation, chainId } = params;
+        const { DelegationManager } = __classPrivateFieldGet(this, _DelegationController_getDelegationEnvironment, "f").call(this, chainId);
+        const data = (0, utils_2.createTypedMessageParams)({
+            chainId: (0, utils_1.hexToNumber)(chainId),
+            from: delegation.delegator,
+            delegation: {
+                ...delegation,
+                signature: '0x',
+            },
+            verifyingContract: DelegationManager,
+        });
+        // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
+        // Waiting on confirmations team to implement this.
+        const signature = await this.messagingSystem.call('KeyringController:signTypedMessage', data, keyring_controller_1.SignTypedDataVersion.V4);
+        return signature;
+    }
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
+     */
+    store(params) {
+        const { entry } = params;
+        const hash = __classPrivateFieldGet(this, _DelegationController_hashDelegation, "f").call(this, entry.delegation);
+        // If the authority is not the root authority, validate that the
+        // parent entry does exist.
+        if (!(0, utils_2.isHexEqual)(entry.delegation.authority, constants_1.ROOT_AUTHORITY) &&
+            !this.state.delegations[entry.delegation.authority]) {
+            throw new Error('Invalid authority');
+        }
+        this.update((state) => {
+            state.delegations[hash] = entry;
+        });
+    }
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter) {
+        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
+        const requester = account.address;
+        let list = Object.values(this.state.delegations);
+        if (filter?.from) {
+            list = list.filter((entry) => (0, utils_2.isHexEqual)(entry.delegation.delegator, filter.from));
+        }
+        if (!filter?.from ||
+            (filter?.from && !(0, utils_2.isHexEqual)(filter.from, requester))) {
+            list = list.filter((entry) => (0, utils_2.isHexEqual)(entry.delegation.delegate, requester));
+        }
+        const filterChainId = filter?.chainId;
+        if (filterChainId) {
+            list = list.filter((entry) => (0, utils_2.isHexEqual)(entry.chainId, filterChainId));
+        }
+        const tags = filter?.tags;
+        if (tags && tags.length > 0) {
+            // Filter entries that contain all of the filter tags
+            list = list.filter((entry) => tags.every((tag) => entry.tags.includes(tag)));
+        }
+        return list;
+    }
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash) {
+        return this.state.delegations[hash] ?? null;
+    }
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash) {
+        const chain = [];
+        const entry = this.retrieve(hash);
+        if (!entry) {
+            return null;
+        }
+        chain.push(entry);
+        for (let _hash = entry.delegation.authority; _hash !== constants_1.ROOT_AUTHORITY;) {
+            const parent = this.retrieve(_hash);
+            if (!parent) {
+                throw new Error('Invalid delegation chain');
+            }
+            chain.push(parent);
+            _hash = parent.delegation.authority;
+        }
+        return chain;
+    }
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash) {
+        const root = this.retrieve(hash);
+        if (!root) {
+            return 0;
+        }
+        const entries = Object.entries(this.state.delegations);
+        const nextHashes = [hash];
+        const deletedHashes = [];
+        while (nextHashes.length > 0) {
+            const currentHash = nextHashes.pop();
+            // Find all delegations that have this hash as their authority
+            const children = entries.filter(([_, v]) => v.delegation.authority === currentHash);
+            // Add the hashes of all child delegations to be processed next
+            children.forEach(([k]) => {
+                nextHashes.push(k);
+            });
+            deletedHashes.push(currentHash);
+        }
+        // Delete delegations
+        this.update((state) => {
+            deletedHashes.forEach((h) => {
+                delete state.delegations[h];
+            });
+        });
+        return deletedHashes.length;
+    }
+}
+exports.DelegationController = DelegationController;
+_DelegationController_hashDelegation = new WeakMap(), _DelegationController_getDelegationEnvironment = new WeakMap();
+//# sourceMappingURL=DelegationController.cjs.map

package/dist/DelegationController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.cjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAC3D,qEAAoE;AACpE,2CAA8C;AAE9C,+CAA6C;AAY7C,uCAA+D;AAElD,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,4BAA4B,GAAG;IACnC,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACiD,CAAC;AAErD;;;;;;;GAOG;AACH,SAAS,mCAAmC;IAC1C,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,gCAIzC;IAKC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,cAAc,EACd,wBAAwB,GAMzB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,mCAAmC,EAAE;gBACxC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAhCI,uDAAiD;QAEjD,iEAAkE;QA+BzE,uBAAA,IAAI,wCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,kDAA6B,wBAAwB,MAAA,CAAC;IAC5D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,MAGpB;QACC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QACvC,MAAM,EAAE,iBAAiB,EAAE,GAAG,uBAAA,IAAI,sDAA0B,MAA9B,IAAI,EAA2B,OAAO,CAAC,CAAC;QAEtE,MAAM,IAAI,GAAG,IAAA,gCAAwB,EAAC;YACpC,OAAO,EAAE,IAAA,mBAAW,EAAC,OAAO,CAAC;YAC7B,IAAI,EAAE,UAAU,CAAC,SAAS;YAC1B,UAAU,EAAE;gBACV,GAAG,UAAU;gBACb,SAAS,EAAE,IAAI;aAChB;YACD,iBAAiB,EAAE,iBAAiB;SACrC,CAAC,CAAC;QAEH,qEAAqE;QACrE,mDAAmD;QACnD,MAAM,SAAS,GAAW,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACvD,oCAAoC,EACpC,IAAI,EACJ,yCAAoB,CAAC,EAAE,CACxB,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAkC;QACtC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,MAAM,IAAI,GAAG,uBAAA,IAAI,4CAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,UAAU,CAAC,CAAC;QAEpD,gEAAgE;QAChE,2BAA2B;QAC3B,IACE,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,0BAAc,CAAC;YACvD,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EACnD;YACA,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAyB;QAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACvC,uCAAuC,CACxC,CAAC;QACF,MAAM,SAAS,GAAG,OAAO,CAAC,OAAkB,CAAC;QAE7C,IAAI,IAAI,GAAsB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEpE,IAAI,MAAM,EAAE,IAAI,EAAE;YAChB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,IAAA,kBAAU,EAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,IAAe,CAAC,CAC/D,CAAC;SACH;QAED,IACE,CAAC,MAAM,EAAE,IAAI;YACb,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAA,kBAAU,EAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACrD;YACA,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,IAAA,kBAAU,EAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAC,CACjD,CAAC;SACH;QAED,MAAM,aAAa,GAAG,MAAM,EAAE,OAAO,CAAC;QACtC,IAAI,aAAa,EAAE;YACjB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;SACzE;QAED,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC;QAC1B,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3B,qDAAqD;YACrD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAC9C,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAAS;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAS;QACb,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,IAAI,CAAC;SACb;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElB,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,KAAK,0BAAc,GAAI;YACvE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;aAC7C;YACD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnB,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC;SACrC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAS;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,CAAC,CAAC;SACV;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvD,MAAM,UAAU,GAAU,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,aAAa,GAAU,EAAE,CAAC;QAEhC,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5B,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,EAAS,CAAC;YAE5C,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAC7B,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,KAAK,WAAW,CACnD,CAAC;YAEF,+DAA+D;YAC/D,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE;gBACvB,UAAU,CAAC,IAAI,CAAC,CAAQ,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACjC;QAED,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC1B,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC,MAAM,CAAC;IAC9B,CAAC;CACF;AAjOD,oDAiOC","sourcesContent":["import type { StateMetadata } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { SignTypedDataVersion } from '@metamask/keyring-controller';\nimport { hexToNumber } from '@metamask/utils';\n\nimport { ROOT_AUTHORITY } from './constants';\nimport type {\n  Address,\n  Delegation,\n  DelegationControllerMessenger,\n  DelegationControllerState,\n  DelegationEntry,\n  DelegationFilter,\n  DeleGatorEnvironment,\n  Hex,\n  UnsignedDelegation,\n} from './types';\nimport { createTypedMessageParams, isHexEqual } from './utils';\n\nexport const controllerName = 'DelegationController';\n\nconst delegationControllerMetadata = {\n  delegations: {\n    persist: true,\n    anonymous: false,\n  },\n} satisfies StateMetadata<DelegationControllerState>;\n\n/**\n * Constructs the default {@link DelegationController} 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 DelegationController} state.\n */\nfunction getDefaultDelegationControllerState(): DelegationControllerState {\n  return {\n    delegations: {},\n  };\n}\n\n/**\n * The {@link DelegationController} class.\n * This controller is meant to be a centralized place to store and sign delegations.\n */\nexport class DelegationController extends BaseController<\n  typeof controllerName,\n  DelegationControllerState,\n  DelegationControllerMessenger\n> {\n  readonly #hashDelegation: (delegation: Delegation) => Hex;\n\n  readonly #getDelegationEnvironment: (chainId: Hex) => DeleGatorEnvironment;\n\n  /**\n   * Constructs a new {@link DelegationController} instance.\n   *\n   * @param params - The parameters for constructing the controller.\n   * @param params.messenger - The messenger instance to use for the controller.\n   * @param params.state - The initial state for the controller.\n   * @param params.hashDelegation - A function to hash delegations.\n   * @param params.getDelegationEnvironment - A function to get the delegation environment for a given chainId.\n   */\n  constructor({\n    messenger,\n    state,\n    hashDelegation,\n    getDelegationEnvironment,\n  }: {\n    messenger: DelegationControllerMessenger;\n    state?: Partial<DelegationControllerState>;\n    hashDelegation: (delegation: Delegation) => Hex;\n    getDelegationEnvironment: (chainId: Hex) => DeleGatorEnvironment;\n  }) {\n    super({\n      messenger,\n      metadata: delegationControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultDelegationControllerState(),\n        ...state,\n      },\n    });\n    this.#hashDelegation = hashDelegation;\n    this.#getDelegationEnvironment = getDelegationEnvironment;\n  }\n\n  /**\n   * Signs a delegation.\n   *\n   * @param params - The parameters for signing the delegation.\n   * @param params.delegation - The delegation to sign.\n   * @param params.chainId - The chainId of the chain to sign the delegation for.\n   * @returns The signature of the delegation.\n   */\n  async signDelegation(params: {\n    delegation: UnsignedDelegation;\n    chainId: Hex;\n  }) {\n    const { delegation, chainId } = params;\n    const { DelegationManager } = this.#getDelegationEnvironment(chainId);\n\n    const data = createTypedMessageParams({\n      chainId: hexToNumber(chainId),\n      from: delegation.delegator,\n      delegation: {\n        ...delegation,\n        signature: '0x',\n      },\n      verifyingContract: DelegationManager,\n    });\n\n    // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.\n    // Waiting on confirmations team to implement this.\n    const signature: string = await this.messagingSystem.call(\n      'KeyringController:signTypedMessage',\n      data,\n      SignTypedDataVersion.V4,\n    );\n\n    return signature;\n  }\n\n  /**\n   * Stores a delegation in storage.\n   *\n   * @param params - The parameters for storing the delegation.\n   * @param params.entry - The delegation entry to store.\n   */\n  store(params: { entry: DelegationEntry }) {\n    const { entry } = params;\n    const hash = this.#hashDelegation(entry.delegation);\n\n    // If the authority is not the root authority, validate that the\n    // parent entry does exist.\n    if (\n      !isHexEqual(entry.delegation.authority, ROOT_AUTHORITY) &&\n      !this.state.delegations[entry.delegation.authority]\n    ) {\n      throw new Error('Invalid authority');\n    }\n    this.update((state) => {\n      state.delegations[hash] = entry;\n    });\n  }\n\n  /**\n   * Lists delegation entries.\n   *\n   * @param filter - The filter to use to list the delegation entries.\n   * @returns A list of delegation entries that match the filter.\n   */\n  list(filter?: DelegationFilter) {\n    const account = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n    const requester = account.address as Address;\n\n    let list: DelegationEntry[] = Object.values(this.state.delegations);\n\n    if (filter?.from) {\n      list = list.filter((entry) =>\n        isHexEqual(entry.delegation.delegator, filter.from as Address),\n      );\n    }\n\n    if (\n      !filter?.from ||\n      (filter?.from && !isHexEqual(filter.from, requester))\n    ) {\n      list = list.filter((entry) =>\n        isHexEqual(entry.delegation.delegate, requester),\n      );\n    }\n\n    const filterChainId = filter?.chainId;\n    if (filterChainId) {\n      list = list.filter((entry) => isHexEqual(entry.chainId, filterChainId));\n    }\n\n    const tags = filter?.tags;\n    if (tags && tags.length > 0) {\n      // Filter entries that contain all of the filter tags\n      list = list.filter((entry) =>\n        tags.every((tag) => entry.tags.includes(tag)),\n      );\n    }\n\n    return list;\n  }\n\n  /**\n   * Retrieves the delegation entry for a given delegation hash.\n   *\n   * @param hash - The hash of the delegation to retrieve.\n   * @returns The delegation entry, or null if not found.\n   */\n  retrieve(hash: Hex) {\n    return this.state.delegations[hash] ?? null;\n  }\n\n  /**\n   * Retrieves a delegation chain from a delegation hash.\n   *\n   * @param hash - The hash of the delegation to retrieve.\n   * @returns The delegation chain, or null if not found.\n   */\n  chain(hash: Hex) {\n    const chain: DelegationEntry[] = [];\n\n    const entry = this.retrieve(hash);\n    if (!entry) {\n      return null;\n    }\n    chain.push(entry);\n\n    for (let _hash = entry.delegation.authority; _hash !== ROOT_AUTHORITY; ) {\n      const parent = this.retrieve(_hash);\n      if (!parent) {\n        throw new Error('Invalid delegation chain');\n      }\n      chain.push(parent);\n      _hash = parent.delegation.authority;\n    }\n\n    return chain;\n  }\n\n  /**\n   * Deletes a delegation entrie from storage, along with any other entries\n   * that are redelegated from it.\n   *\n   * @param hash - The hash of the delegation to delete.\n   * @returns The number of entries deleted.\n   */\n  delete(hash: Hex): number {\n    const root = this.retrieve(hash);\n    if (!root) {\n      return 0;\n    }\n\n    const entries = Object.entries(this.state.delegations);\n    const nextHashes: Hex[] = [hash];\n    const deletedHashes: Hex[] = [];\n\n    while (nextHashes.length > 0) {\n      const currentHash = nextHashes.pop() as Hex;\n\n      // Find all delegations that have this hash as their authority\n      const children = entries.filter(\n        ([_, v]) => v.delegation.authority === currentHash,\n      );\n\n      // Add the hashes of all child delegations to be processed next\n      children.forEach(([k]) => {\n        nextHashes.push(k as Hex);\n      });\n\n      deletedHashes.push(currentHash);\n    }\n\n    // Delete delegations\n    this.update((state) => {\n      deletedHashes.forEach((h) => {\n        delete state.delegations[h];\n      });\n    });\n\n    return deletedHashes.length;\n  }\n}\n"]}

package/dist/DelegationController.d.cts

@@ -0,0 +1,76 @@
+import { BaseController } from "@metamask/base-controller";
+import type { Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, DeleGatorEnvironment, Hex, UnsignedDelegation } from "./types.cjs";
+export declare const controllerName = "DelegationController";
+/**
+ * The {@link DelegationController} class.
+ * This controller is meant to be a centralized place to store and sign delegations.
+ */
+export declare class DelegationController extends BaseController<typeof controllerName, DelegationControllerState, DelegationControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new {@link DelegationController} instance.
+     *
+     * @param params - The parameters for constructing the controller.
+     * @param params.messenger - The messenger instance to use for the controller.
+     * @param params.state - The initial state for the controller.
+     * @param params.hashDelegation - A function to hash delegations.
+     * @param params.getDelegationEnvironment - A function to get the delegation environment for a given chainId.
+     */
+    constructor({ messenger, state, hashDelegation, getDelegationEnvironment, }: {
+        messenger: DelegationControllerMessenger;
+        state?: Partial<DelegationControllerState>;
+        hashDelegation: (delegation: Delegation) => Hex;
+        getDelegationEnvironment: (chainId: Hex) => DeleGatorEnvironment;
+    });
+    /**
+     * Signs a delegation.
+     *
+     * @param params - The parameters for signing the delegation.
+     * @param params.delegation - The delegation to sign.
+     * @param params.chainId - The chainId of the chain to sign the delegation for.
+     * @returns The signature of the delegation.
+     */
+    signDelegation(params: {
+        delegation: UnsignedDelegation;
+        chainId: Hex;
+    }): Promise<string>;
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
+     */
+    store(params: {
+        entry: DelegationEntry;
+    }): void;
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter?: DelegationFilter): DelegationEntry[];
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash: Hex): DelegationEntry;
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash: Hex): DelegationEntry[] | null;
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash: Hex): number;
+}
+//# sourceMappingURL=DelegationController.d.cts.map

package/dist/DelegationController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.d.cts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,GAAG,EACH,kBAAkB,EACnB,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAuBrD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;;IAKC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,KAAK,EACL,cAAc,EACd,wBAAwB,GACzB,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAC3C,cAAc,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,GAAG,CAAC;QAChD,wBAAwB,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,oBAAoB,CAAC;KAClE;IAcD;;;;;;;OAOG;IACG,cAAc,CAAC,MAAM,EAAE;QAC3B,UAAU,EAAE,kBAAkB,CAAC;QAC/B,OAAO,EAAE,GAAG,CAAC;KACd;IAyBD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,eAAe,CAAA;KAAE;IAiBxC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB;IAuC9B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG;IAIlB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,GAAG;IAqBf;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM;CAmC1B"}

package/dist/DelegationController.d.mts

@@ -0,0 +1,76 @@
+import { BaseController } from "@metamask/base-controller";
+import type { Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, DeleGatorEnvironment, Hex, UnsignedDelegation } from "./types.mjs";
+export declare const controllerName = "DelegationController";
+/**
+ * The {@link DelegationController} class.
+ * This controller is meant to be a centralized place to store and sign delegations.
+ */
+export declare class DelegationController extends BaseController<typeof controllerName, DelegationControllerState, DelegationControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new {@link DelegationController} instance.
+     *
+     * @param params - The parameters for constructing the controller.
+     * @param params.messenger - The messenger instance to use for the controller.
+     * @param params.state - The initial state for the controller.
+     * @param params.hashDelegation - A function to hash delegations.
+     * @param params.getDelegationEnvironment - A function to get the delegation environment for a given chainId.
+     */
+    constructor({ messenger, state, hashDelegation, getDelegationEnvironment, }: {
+        messenger: DelegationControllerMessenger;
+        state?: Partial<DelegationControllerState>;
+        hashDelegation: (delegation: Delegation) => Hex;
+        getDelegationEnvironment: (chainId: Hex) => DeleGatorEnvironment;
+    });
+    /**
+     * Signs a delegation.
+     *
+     * @param params - The parameters for signing the delegation.
+     * @param params.delegation - The delegation to sign.
+     * @param params.chainId - The chainId of the chain to sign the delegation for.
+     * @returns The signature of the delegation.
+     */
+    signDelegation(params: {
+        delegation: UnsignedDelegation;
+        chainId: Hex;
+    }): Promise<string>;
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
+     */
+    store(params: {
+        entry: DelegationEntry;
+    }): void;
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter?: DelegationFilter): DelegationEntry[];
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash: Hex): DelegationEntry;
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash: Hex): DelegationEntry[] | null;
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash: Hex): number;
+}
+//# sourceMappingURL=DelegationController.d.mts.map

package/dist/DelegationController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.d.mts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,GAAG,EACH,kBAAkB,EACnB,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAuBrD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;;IAKC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,KAAK,EACL,cAAc,EACd,wBAAwB,GACzB,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAC3C,cAAc,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,GAAG,CAAC;QAChD,wBAAwB,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,oBAAoB,CAAC;KAClE;IAcD;;;;;;;OAOG;IACG,cAAc,CAAC,MAAM,EAAE;QAC3B,UAAU,EAAE,kBAAkB,CAAC;QAC/B,OAAO,EAAE,GAAG,CAAC;KACd;IAyBD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,eAAe,CAAA;KAAE;IAiBxC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB;IAuC9B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,GAAG;IAIlB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,GAAG;IAqBf;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM;CAmC1B"}

package/dist/DelegationController.mjs

@@ -0,0 +1,206 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DelegationController_hashDelegation, _DelegationController_getDelegationEnvironment;
+import { BaseController } from "@metamask/base-controller";
+import { SignTypedDataVersion } from "@metamask/keyring-controller";
+import { hexToNumber } from "@metamask/utils";
+import { ROOT_AUTHORITY } from "./constants.mjs";
+import { createTypedMessageParams, isHexEqual } from "./utils.mjs";
+export const controllerName = 'DelegationController';
+const delegationControllerMetadata = {
+    delegations: {
+        persist: true,
+        anonymous: false,
+    },
+};
+/**
+ * Constructs the default {@link DelegationController} 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 DelegationController} state.
+ */
+function getDefaultDelegationControllerState() {
+    return {
+        delegations: {},
+    };
+}
+/**
+ * The {@link DelegationController} class.
+ * This controller is meant to be a centralized place to store and sign delegations.
+ */
+export class DelegationController extends BaseController {
+    /**
+     * Constructs a new {@link DelegationController} instance.
+     *
+     * @param params - The parameters for constructing the controller.
+     * @param params.messenger - The messenger instance to use for the controller.
+     * @param params.state - The initial state for the controller.
+     * @param params.hashDelegation - A function to hash delegations.
+     * @param params.getDelegationEnvironment - A function to get the delegation environment for a given chainId.
+     */
+    constructor({ messenger, state, hashDelegation, getDelegationEnvironment, }) {
+        super({
+            messenger,
+            metadata: delegationControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultDelegationControllerState(),
+                ...state,
+            },
+        });
+        _DelegationController_hashDelegation.set(this, void 0);
+        _DelegationController_getDelegationEnvironment.set(this, void 0);
+        __classPrivateFieldSet(this, _DelegationController_hashDelegation, hashDelegation, "f");
+        __classPrivateFieldSet(this, _DelegationController_getDelegationEnvironment, getDelegationEnvironment, "f");
+    }
+    /**
+     * Signs a delegation.
+     *
+     * @param params - The parameters for signing the delegation.
+     * @param params.delegation - The delegation to sign.
+     * @param params.chainId - The chainId of the chain to sign the delegation for.
+     * @returns The signature of the delegation.
+     */
+    async signDelegation(params) {
+        const { delegation, chainId } = params;
+        const { DelegationManager } = __classPrivateFieldGet(this, _DelegationController_getDelegationEnvironment, "f").call(this, chainId);
+        const data = createTypedMessageParams({
+            chainId: hexToNumber(chainId),
+            from: delegation.delegator,
+            delegation: {
+                ...delegation,
+                signature: '0x',
+            },
+            verifyingContract: DelegationManager,
+        });
+        // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
+        // Waiting on confirmations team to implement this.
+        const signature = await this.messagingSystem.call('KeyringController:signTypedMessage', data, SignTypedDataVersion.V4);
+        return signature;
+    }
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
+     */
+    store(params) {
+        const { entry } = params;
+        const hash = __classPrivateFieldGet(this, _DelegationController_hashDelegation, "f").call(this, entry.delegation);
+        // If the authority is not the root authority, validate that the
+        // parent entry does exist.
+        if (!isHexEqual(entry.delegation.authority, ROOT_AUTHORITY) &&
+            !this.state.delegations[entry.delegation.authority]) {
+            throw new Error('Invalid authority');
+        }
+        this.update((state) => {
+            state.delegations[hash] = entry;
+        });
+    }
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter) {
+        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
+        const requester = account.address;
+        let list = Object.values(this.state.delegations);
+        if (filter?.from) {
+            list = list.filter((entry) => isHexEqual(entry.delegation.delegator, filter.from));
+        }
+        if (!filter?.from ||
+            (filter?.from && !isHexEqual(filter.from, requester))) {
+            list = list.filter((entry) => isHexEqual(entry.delegation.delegate, requester));
+        }
+        const filterChainId = filter?.chainId;
+        if (filterChainId) {
+            list = list.filter((entry) => isHexEqual(entry.chainId, filterChainId));
+        }
+        const tags = filter?.tags;
+        if (tags && tags.length > 0) {
+            // Filter entries that contain all of the filter tags
+            list = list.filter((entry) => tags.every((tag) => entry.tags.includes(tag)));
+        }
+        return list;
+    }
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash) {
+        return this.state.delegations[hash] ?? null;
+    }
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash) {
+        const chain = [];
+        const entry = this.retrieve(hash);
+        if (!entry) {
+            return null;
+        }
+        chain.push(entry);
+        for (let _hash = entry.delegation.authority; _hash !== ROOT_AUTHORITY;) {
+            const parent = this.retrieve(_hash);
+            if (!parent) {
+                throw new Error('Invalid delegation chain');
+            }
+            chain.push(parent);
+            _hash = parent.delegation.authority;
+        }
+        return chain;
+    }
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash) {
+        const root = this.retrieve(hash);
+        if (!root) {
+            return 0;
+        }
+        const entries = Object.entries(this.state.delegations);
+        const nextHashes = [hash];
+        const deletedHashes = [];
+        while (nextHashes.length > 0) {
+            const currentHash = nextHashes.pop();
+            // Find all delegations that have this hash as their authority
+            const children = entries.filter(([_, v]) => v.delegation.authority === currentHash);
+            // Add the hashes of all child delegations to be processed next
+            children.forEach(([k]) => {
+                nextHashes.push(k);
+            });
+            deletedHashes.push(currentHash);
+        }
+        // Delete delegations
+        this.update((state) => {
+            deletedHashes.forEach((h) => {
+                delete state.delegations[h];
+            });
+        });
+        return deletedHashes.length;
+    }
+}
+_DelegationController_hashDelegation = new WeakMap(), _DelegationController_getDelegationEnvironment = new WeakMap();
+//# sourceMappingURL=DelegationController.mjs.map