@metamask-previews/delegation-controller 0.1.0-preview-c67b57f2 → 0.1.0-preview-6c44e568

package/CHANGELOG.md

@@ -7,4 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/MetaMask/core/
+## [0.1.0]
+
+### Added
+
+- Initial release ([#5592](https://github.com/MetaMask/core/pull/5592))
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/delegation-controller@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/delegation-controller@0.1.0

package/dist/DelegationController.cjs

@@ -1,10 +1,23 @@
 "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.getDefaultDelegationControllerState = exports.controllerName = void 0;
+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_1 = require("./utils.cjs");
+const utils_2 = require("./utils.cjs");
 exports.controllerName = 'DelegationController';
 const delegationControllerMetadata = {
     delegations: {
@@ -25,13 +38,21 @@ function getDefaultDelegationControllerState() {
         delegations: {},
     };
 }
-exports.getDefaultDelegationControllerState = getDefaultDelegationControllerState;
 /**
  * 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 {
-    constructor({ messenger, state, }) {
+    /**
+     * 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,
@@ -41,24 +62,30 @@ class DelegationController extends base_controller_1.BaseController {
                 ...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.verifyingContract - The address of the verifying contract (DelegationManager).
      * @param params.chainId - The chainId of the chain to sign the delegation for.
      * @returns The signature of the delegation.
      */
-    async sign(params) {
-        const { delegation, verifyingContract, chainId } = params;
-        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
-        const data = (0, utils_1.createTypedMessageParams)({
-            chainId,
-            from: account.address,
-            delegation,
-            verifyingContract,
+    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.
@@ -68,14 +95,16 @@ class DelegationController extends base_controller_1.BaseController {
     /**
      * Stores a delegation in storage.
      *
-     * @param hash - The hash of the delegation to store.
-     * @param entry - The delegation entry to store.
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
      */
-    store(hash, entry) {
+    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_1.isAddressEqual)(entry.data.authority, constants_1.ROOT_AUTHORITY) &&
-            !this.state.delegations[entry.data.authority]) {
+        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) => {
@@ -93,14 +122,15 @@ class DelegationController extends base_controller_1.BaseController {
         const requester = account.address;
         let list = Object.values(this.state.delegations);
         if (filter?.from) {
-            list = list.filter((entry) => (0, utils_1.isAddressEqual)(entry.data.delegator, filter.from));
+            list = list.filter((entry) => (0, utils_2.isHexEqual)(entry.delegation.delegator, filter.from));
         }
         if (!filter?.from ||
-            (filter?.from && !(0, utils_1.isAddressEqual)(filter.from, requester))) {
-            list = list.filter((entry) => (0, utils_1.isAddressEqual)(entry.data.delegate, requester));
+            (filter?.from && !(0, utils_2.isHexEqual)(filter.from, requester))) {
+            list = list.filter((entry) => (0, utils_2.isHexEqual)(entry.delegation.delegate, requester));
         }
-        if (filter?.chainId) {
-            list = list.filter((entry) => entry.chainId === filter.chainId);
+        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) {
@@ -131,13 +161,13 @@ class DelegationController extends base_controller_1.BaseController {
             return null;
         }
         chain.push(entry);
-        for (let _hash = entry.data.authority; _hash !== constants_1.ROOT_AUTHORITY;) {
+        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.data.authority;
+            _hash = parent.delegation.authority;
         }
         return chain;
     }
@@ -154,24 +184,27 @@ class DelegationController extends base_controller_1.BaseController {
             return 0;
         }
         const entries = Object.entries(this.state.delegations);
-        let count = 0;
         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.data.authority === currentHash);
+            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);
             });
-            // Delete the current delegation
-            this.update((state) => {
-                delete state.delegations[currentHash];
-            });
-            count += 1;
+            deletedHashes.push(currentHash);
         }
-        return count;
+        // 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

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.cjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAC3D,qEAAoE;AAEpE,+CAA6C;AAU7C,uCAAmE;AAEtD,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,SAAgB,mCAAmC;IACjD,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC;AAJD,kFAIC;AAED;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,gCAIzC;IACC,YAAY,EACV,SAAS,EACT,KAAK,GAIN;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;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,MAIV;QACC,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAE1D,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACvC,uCAAuC,CACxC,CAAC;QAEF,MAAM,IAAI,GAAG,IAAA,gCAAwB,EAAC;YACpC,OAAO;YACP,IAAI,EAAE,OAAO,CAAC,OAAkB;YAChC,UAAU;YACV,iBAAiB;SAClB,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,IAAS,EAAE,KAAsB;QACrC,gEAAgE;QAChE,2BAA2B;QAC3B,IACE,CAAC,IAAA,sBAAc,EAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,0BAAc,CAAC;YACrD,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAC7C;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,sBAAc,EAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,IAAe,CAAC,CAC7D,CAAC;SACH;QAED,IACE,CAAC,MAAM,EAAE,IAAI;YACb,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAA,sBAAc,EAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACzD;YACA,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,IAAA,sBAAc,EAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAC/C,CAAC;SACH;QAED,IAAI,MAAM,EAAE,OAAO,EAAE;YACnB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC;SACjE;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,IAAI,CAAC,SAAS,EAAE,KAAK,KAAK,0BAAc,GAAI;YACjE,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,IAAI,CAAC,SAAS,CAAC;SAC/B;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,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,UAAU,GAAU,CAAC,IAAI,CAAC,CAAC;QAEjC,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,IAAI,CAAC,SAAS,KAAK,WAAW,CAC7C,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,gCAAgC;YAChC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YACH,KAAK,IAAI,CAAC,CAAC;SACZ;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAzMD,oDAyMC","sourcesContent":["import type { StateMetadata } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { SignTypedDataVersion } from '@metamask/keyring-controller';\n\nimport { ROOT_AUTHORITY } from './constants';\nimport type {\n  Address,\n  Delegation,\n  DelegationControllerMessenger,\n  DelegationControllerState,\n  DelegationEntry,\n  DelegationFilter,\n  Hex,\n} from './types';\nimport { createTypedMessageParams, isAddressEqual } 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 */\nexport function 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  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: DelegationControllerMessenger;\n    state?: Partial<DelegationControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: delegationControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultDelegationControllerState(),\n        ...state,\n      },\n    });\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.verifyingContract - The address of the verifying contract (DelegationManager).\n   * @param params.chainId - The chainId of the chain to sign the delegation for.\n   * @returns The signature of the delegation.\n   */\n  async sign(params: {\n    delegation: Delegation;\n    verifyingContract: Address;\n    chainId: number;\n  }) {\n    const { delegation, verifyingContract, chainId } = params;\n\n    const account = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const data = createTypedMessageParams({\n      chainId,\n      from: account.address as Address,\n      delegation,\n      verifyingContract,\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 hash - The hash of the delegation to store.\n   * @param entry - The delegation entry to store.\n   */\n  store(hash: Hex, entry: DelegationEntry) {\n    // If the authority is not the root authority, validate that the\n    // parent entry does exist.\n    if (\n      !isAddressEqual(entry.data.authority, ROOT_AUTHORITY) &&\n      !this.state.delegations[entry.data.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        isAddressEqual(entry.data.delegator, filter.from as Address),\n      );\n    }\n\n    if (\n      !filter?.from ||\n      (filter?.from && !isAddressEqual(filter.from, requester))\n    ) {\n      list = list.filter((entry) =>\n        isAddressEqual(entry.data.delegate, requester),\n      );\n    }\n\n    if (filter?.chainId) {\n      list = list.filter((entry) => entry.chainId === filter.chainId);\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.data.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.data.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    let count = 0;\n    const nextHashes: Hex[] = [hash];\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.data.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      // Delete the current delegation\n      this.update((state) => {\n        delete state.delegations[currentHash];\n      });\n      count += 1;\n    }\n\n    return count;\n  }\n}\n"]}
+{"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

@@ -1,45 +1,48 @@
 import { BaseController } from "@metamask/base-controller";
-import type { Address, Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, Hex } from "./types.cjs";
+import type { Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, DeleGatorEnvironment, Hex, UnsignedDelegation } from "./types.cjs";
 export declare const controllerName = "DelegationController";
-/**
- * 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.
- */
-export declare function getDefaultDelegationControllerState(): DelegationControllerState;
 /**
  * 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> {
-    constructor({ messenger, state, }: {
+    #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.verifyingContract - The address of the verifying contract (DelegationManager).
      * @param params.chainId - The chainId of the chain to sign the delegation for.
      * @returns The signature of the delegation.
      */
-    sign(params: {
-        delegation: Delegation;
-        verifyingContract: Address;
-        chainId: number;
+    signDelegation(params: {
+        delegation: UnsignedDelegation;
+        chainId: Hex;
     }): Promise<string>;
     /**
      * Stores a delegation in storage.
      *
-     * @param hash - The hash of the delegation to store.
-     * @param entry - The delegation entry to store.
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
      */
-    store(hash: Hex, entry: DelegationEntry): void;
+    store(params: {
+        entry: DelegationEntry;
+    }): void;
     /**
      * Lists delegation entries.
      *

package/dist/DelegationController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.d.cts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAI3D,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,GAAG,EACJ,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AASrD;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,IAAI,yBAAyB,CAI/E;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;gBACa,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAYD;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,EAAE;QACjB,UAAU,EAAE,UAAU,CAAC;QACvB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,OAAO,EAAE,MAAM,CAAC;KACjB;IAyBD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe;IAcvC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB;IAsC9B;;;;;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;CAgC1B"}
+{"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

@@ -1,45 +1,48 @@
 import { BaseController } from "@metamask/base-controller";
-import type { Address, Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, Hex } from "./types.mjs";
+import type { Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, DeleGatorEnvironment, Hex, UnsignedDelegation } from "./types.mjs";
 export declare const controllerName = "DelegationController";
-/**
- * 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.
- */
-export declare function getDefaultDelegationControllerState(): DelegationControllerState;
 /**
  * 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> {
-    constructor({ messenger, state, }: {
+    #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.verifyingContract - The address of the verifying contract (DelegationManager).
      * @param params.chainId - The chainId of the chain to sign the delegation for.
      * @returns The signature of the delegation.
      */
-    sign(params: {
-        delegation: Delegation;
-        verifyingContract: Address;
-        chainId: number;
+    signDelegation(params: {
+        delegation: UnsignedDelegation;
+        chainId: Hex;
     }): Promise<string>;
     /**
      * Stores a delegation in storage.
      *
-     * @param hash - The hash of the delegation to store.
-     * @param entry - The delegation entry to store.
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
      */
-    store(hash: Hex, entry: DelegationEntry): void;
+    store(params: {
+        entry: DelegationEntry;
+    }): void;
     /**
      * Lists delegation entries.
      *

package/dist/DelegationController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.d.mts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAI3D,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,GAAG,EACJ,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AASrD;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,IAAI,yBAAyB,CAI/E;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;gBACa,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,6BAA6B,CAAC;QACzC,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAYD;;;;;;;;OAQG;IACG,IAAI,CAAC,MAAM,EAAE;QACjB,UAAU,EAAE,UAAU,CAAC;QACvB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,OAAO,EAAE,MAAM,CAAC;KACjB;IAyBD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe;IAcvC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB;IAsC9B;;;;;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;CAgC1B"}
+{"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

@@ -1,7 +1,20 @@
+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, isAddressEqual } from "./utils.mjs";
+import { createTypedMessageParams, isHexEqual } from "./utils.mjs";
 export const controllerName = 'DelegationController';
 const delegationControllerMetadata = {
     delegations: {
@@ -17,7 +30,7 @@ const delegationControllerMetadata = {
  *
  * @returns The default {@link DelegationController} state.
  */
-export function getDefaultDelegationControllerState() {
+function getDefaultDelegationControllerState() {
     return {
         delegations: {},
     };
@@ -27,7 +40,16 @@ export function getDefaultDelegationControllerState() {
  * This controller is meant to be a centralized place to store and sign delegations.
  */
 export class DelegationController extends BaseController {
-    constructor({ messenger, state, }) {
+    /**
+     * 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,
@@ -37,24 +59,30 @@ export class DelegationController extends BaseController {
                 ...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.verifyingContract - The address of the verifying contract (DelegationManager).
      * @param params.chainId - The chainId of the chain to sign the delegation for.
      * @returns The signature of the delegation.
      */
-    async sign(params) {
-        const { delegation, verifyingContract, chainId } = params;
-        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
+    async signDelegation(params) {
+        const { delegation, chainId } = params;
+        const { DelegationManager } = __classPrivateFieldGet(this, _DelegationController_getDelegationEnvironment, "f").call(this, chainId);
         const data = createTypedMessageParams({
-            chainId,
-            from: account.address,
-            delegation,
-            verifyingContract,
+            chainId: hexToNumber(chainId),
+            from: delegation.delegator,
+            delegation: {
+                ...delegation,
+                signature: '0x',
+            },
+            verifyingContract: DelegationManager,
         });
         // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
         // Waiting on confirmations team to implement this.
@@ -64,14 +92,16 @@ export class DelegationController extends BaseController {
     /**
      * Stores a delegation in storage.
      *
-     * @param hash - The hash of the delegation to store.
-     * @param entry - The delegation entry to store.
+     * @param params - The parameters for storing the delegation.
+     * @param params.entry - The delegation entry to store.
      */
-    store(hash, entry) {
+    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 (!isAddressEqual(entry.data.authority, ROOT_AUTHORITY) &&
-            !this.state.delegations[entry.data.authority]) {
+        if (!isHexEqual(entry.delegation.authority, ROOT_AUTHORITY) &&
+            !this.state.delegations[entry.delegation.authority]) {
             throw new Error('Invalid authority');
         }
         this.update((state) => {
@@ -89,14 +119,15 @@ export class DelegationController extends BaseController {
         const requester = account.address;
         let list = Object.values(this.state.delegations);
         if (filter?.from) {
-            list = list.filter((entry) => isAddressEqual(entry.data.delegator, filter.from));
+            list = list.filter((entry) => isHexEqual(entry.delegation.delegator, filter.from));
         }
         if (!filter?.from ||
-            (filter?.from && !isAddressEqual(filter.from, requester))) {
-            list = list.filter((entry) => isAddressEqual(entry.data.delegate, requester));
+            (filter?.from && !isHexEqual(filter.from, requester))) {
+            list = list.filter((entry) => isHexEqual(entry.delegation.delegate, requester));
         }
-        if (filter?.chainId) {
-            list = list.filter((entry) => entry.chainId === filter.chainId);
+        const filterChainId = filter?.chainId;
+        if (filterChainId) {
+            list = list.filter((entry) => isHexEqual(entry.chainId, filterChainId));
         }
         const tags = filter?.tags;
         if (tags && tags.length > 0) {
@@ -127,13 +158,13 @@ export class DelegationController extends BaseController {
             return null;
         }
         chain.push(entry);
-        for (let _hash = entry.data.authority; _hash !== ROOT_AUTHORITY;) {
+        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.data.authority;
+            _hash = parent.delegation.authority;
         }
         return chain;
     }
@@ -150,23 +181,26 @@ export class DelegationController extends BaseController {
             return 0;
         }
         const entries = Object.entries(this.state.delegations);
-        let count = 0;
         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.data.authority === currentHash);
+            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);
             });
-            // Delete the current delegation
-            this.update((state) => {
-                delete state.delegations[currentHash];
-            });
-            count += 1;
+            deletedHashes.push(currentHash);
         }
-        return count;
+        // 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

package/dist/DelegationController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.mjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,qCAAqC;AAEpE,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAU7C,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,oBAAgB;AAEnE,MAAM,CAAC,MAAM,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,MAAM,UAAU,mCAAmC;IACjD,OAAO;QACL,WAAW,EAAE,EAAE;KAChB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAIzC;IACC,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,4BAA4B;YACtC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,mCAAmC,EAAE;gBACxC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,MAIV;QACC,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAE1D,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACvC,uCAAuC,CACxC,CAAC;QAEF,MAAM,IAAI,GAAG,wBAAwB,CAAC;YACpC,OAAO;YACP,IAAI,EAAE,OAAO,CAAC,OAAkB;YAChC,UAAU;YACV,iBAAiB;SAClB,CAAC,CAAC;QAEH,qEAAqE;QACrE,mDAAmD;QACnD,MAAM,SAAS,GAAW,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACvD,oCAAoC,EACpC,IAAI,EACJ,oBAAoB,CAAC,EAAE,CACxB,CAAC;QAEF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAS,EAAE,KAAsB;QACrC,gEAAgE;QAChE,2BAA2B;QAC3B,IACE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC;YACrD,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAC7C;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,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,IAAe,CAAC,CAC7D,CAAC;SACH;QAED,IACE,CAAC,MAAM,EAAE,IAAI;YACb,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACzD;YACA,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAC/C,CAAC;SACH;QAED,IAAI,MAAM,EAAE,OAAO,EAAE;YACnB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC;SACjE;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,IAAI,CAAC,SAAS,EAAE,KAAK,KAAK,cAAc,GAAI;YACjE,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,IAAI,CAAC,SAAS,CAAC;SAC/B;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,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,UAAU,GAAU,CAAC,IAAI,CAAC,CAAC;QAEjC,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,IAAI,CAAC,SAAS,KAAK,WAAW,CAC7C,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,gCAAgC;YAChC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YACH,KAAK,IAAI,CAAC,CAAC;SACZ;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["import type { StateMetadata } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport { SignTypedDataVersion } from '@metamask/keyring-controller';\n\nimport { ROOT_AUTHORITY } from './constants';\nimport type {\n  Address,\n  Delegation,\n  DelegationControllerMessenger,\n  DelegationControllerState,\n  DelegationEntry,\n  DelegationFilter,\n  Hex,\n} from './types';\nimport { createTypedMessageParams, isAddressEqual } 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 */\nexport function 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  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: DelegationControllerMessenger;\n    state?: Partial<DelegationControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: delegationControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultDelegationControllerState(),\n        ...state,\n      },\n    });\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.verifyingContract - The address of the verifying contract (DelegationManager).\n   * @param params.chainId - The chainId of the chain to sign the delegation for.\n   * @returns The signature of the delegation.\n   */\n  async sign(params: {\n    delegation: Delegation;\n    verifyingContract: Address;\n    chainId: number;\n  }) {\n    const { delegation, verifyingContract, chainId } = params;\n\n    const account = this.messagingSystem.call(\n      'AccountsController:getSelectedAccount',\n    );\n\n    const data = createTypedMessageParams({\n      chainId,\n      from: account.address as Address,\n      delegation,\n      verifyingContract,\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 hash - The hash of the delegation to store.\n   * @param entry - The delegation entry to store.\n   */\n  store(hash: Hex, entry: DelegationEntry) {\n    // If the authority is not the root authority, validate that the\n    // parent entry does exist.\n    if (\n      !isAddressEqual(entry.data.authority, ROOT_AUTHORITY) &&\n      !this.state.delegations[entry.data.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        isAddressEqual(entry.data.delegator, filter.from as Address),\n      );\n    }\n\n    if (\n      !filter?.from ||\n      (filter?.from && !isAddressEqual(filter.from, requester))\n    ) {\n      list = list.filter((entry) =>\n        isAddressEqual(entry.data.delegate, requester),\n      );\n    }\n\n    if (filter?.chainId) {\n      list = list.filter((entry) => entry.chainId === filter.chainId);\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.data.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.data.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    let count = 0;\n    const nextHashes: Hex[] = [hash];\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.data.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      // Delete the current delegation\n      this.update((state) => {\n        delete state.delegations[currentHash];\n      });\n      count += 1;\n    }\n\n    return count;\n  }\n}\n"]}
+{"version":3,"file":"DelegationController.mjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,qCAAqC;AACpE,OAAO,EAAE,WAAW,EAAE,wBAAwB;AAE9C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAY7C,OAAO,EAAE,wBAAwB,EAAE,UAAU,EAAE,oBAAgB;AAE/D,MAAM,CAAC,MAAM,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,MAAM,OAAO,oBAAqB,SAAQ,cAIzC;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,cAAc;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,wBAAwB,CAAC;YACpC,OAAO,EAAE,WAAW,CAAC,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,oBAAoB,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,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,cAAc,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,UAAU,CAAC,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,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,EACrD;YACA,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,UAAU,CAAC,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,UAAU,CAAC,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,cAAc,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","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/index.cjs

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

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,mEAGgC;AAF9B,4HAAA,oBAAoB,OAAA;AACpB,2IAAA,mCAAmC,OAAA","sourcesContent":["export type {\n  DelegationControllerActions,\n  DelegationControllerEvents,\n  DelegationControllerMessenger,\n  DelegationEntry,\n  DelegationFilter,\n} from './types';\n\nexport {\n  DelegationController,\n  getDefaultDelegationControllerState,\n} from './DelegationController';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAcA,mEAA8D;AAArD,4HAAA,oBAAoB,OAAA","sourcesContent":["export type {\n  DelegationControllerSignDelegationAction,\n  DelegationControllerStoreAction,\n  DelegationControllerListAction,\n  DelegationControllerRetrieveAction,\n  DelegationControllerChainAction,\n  DelegationControllerDeleteAction,\n  DelegationControllerActions,\n  DelegationControllerEvents,\n  DelegationControllerMessenger,\n  DelegationEntry,\n  DelegationFilter,\n} from './types';\n\nexport { DelegationController } from './DelegationController';\n"]}

package/dist/index.d.cts

@@ -1,3 +1,3 @@
-export type { DelegationControllerActions, DelegationControllerEvents, DelegationControllerMessenger, DelegationEntry, DelegationFilter, } from "./types.cjs";
-export { DelegationController, getDefaultDelegationControllerState, } from "./DelegationController.cjs";
+export type { DelegationControllerSignDelegationAction, DelegationControllerStoreAction, DelegationControllerListAction, DelegationControllerRetrieveAction, DelegationControllerChainAction, DelegationControllerDeleteAction, DelegationControllerActions, DelegationControllerEvents, DelegationControllerMessenger, DelegationEntry, DelegationFilter, } from "./types.cjs";
+export { DelegationController } from "./DelegationController.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,GACjB,oBAAgB;AAEjB,OAAO,EACL,oBAAoB,EACpB,mCAAmC,GACpC,mCAA+B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,wCAAwC,EACxC,+BAA+B,EAC/B,8BAA8B,EAC9B,kCAAkC,EAClC,+BAA+B,EAC/B,gCAAgC,EAChC,2BAA2B,EAC3B,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,GACjB,oBAAgB;AAEjB,OAAO,EAAE,oBAAoB,EAAE,mCAA+B"}

package/dist/index.d.mts

@@ -1,3 +1,3 @@
-export type { DelegationControllerActions, DelegationControllerEvents, DelegationControllerMessenger, DelegationEntry, DelegationFilter, } from "./types.mjs";
-export { DelegationController, getDefaultDelegationControllerState, } from "./DelegationController.mjs";
+export type { DelegationControllerSignDelegationAction, DelegationControllerStoreAction, DelegationControllerListAction, DelegationControllerRetrieveAction, DelegationControllerChainAction, DelegationControllerDeleteAction, DelegationControllerActions, DelegationControllerEvents, DelegationControllerMessenger, DelegationEntry, DelegationFilter, } from "./types.mjs";
+export { DelegationController } from "./DelegationController.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,GACjB,oBAAgB;AAEjB,OAAO,EACL,oBAAoB,EACpB,mCAAmC,GACpC,mCAA+B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,wCAAwC,EACxC,+BAA+B,EAC/B,8BAA8B,EAC9B,kCAAkC,EAClC,+BAA+B,EAC/B,gCAAgC,EAChC,2BAA2B,EAC3B,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,EACf,gBAAgB,GACjB,oBAAgB;AAEjB,OAAO,EAAE,oBAAoB,EAAE,mCAA+B"}

package/dist/index.mjs

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

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,oBAAoB,EACpB,mCAAmC,EACpC,mCAA+B","sourcesContent":["export type {\n  DelegationControllerActions,\n  DelegationControllerEvents,\n  DelegationControllerMessenger,\n  DelegationEntry,\n  DelegationFilter,\n} from './types';\n\nexport {\n  DelegationController,\n  getDefaultDelegationControllerState,\n} from './DelegationController';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,oBAAoB,EAAE,mCAA+B","sourcesContent":["export type {\n  DelegationControllerSignDelegationAction,\n  DelegationControllerStoreAction,\n  DelegationControllerListAction,\n  DelegationControllerRetrieveAction,\n  DelegationControllerChainAction,\n  DelegationControllerDeleteAction,\n  DelegationControllerActions,\n  DelegationControllerEvents,\n  DelegationControllerMessenger,\n  DelegationEntry,\n  DelegationFilter,\n} from './types';\n\nexport { DelegationController } from './DelegationController';\n"]}

package/dist/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type { KeyringControllerSignTypedMessageAction } from '@metamask/keyring-controller';\n\nimport type {\n  controllerName,\n  DelegationController,\n} from './DelegationController';\n\ntype Hex = `0x${string}`;\ntype Address = `0x${string}`;\n\nexport type { Address, Hex };\n\nexport type Caveat = {\n  enforcer: Hex;\n  terms: Hex;\n  args: Hex;\n};\n\nexport type Delegation = {\n  delegate: Hex;\n  delegator: Hex;\n  authority: Hex;\n  caveats: Caveat[];\n  salt: Hex;\n  signature: Hex;\n};\n\nexport type DelegationStruct = Omit<Delegation, 'salt'> & {\n  salt: bigint;\n};\n\nexport type DelegationEntry = {\n  tags: string[];\n  chainId: number;\n  data: Delegation;\n  meta?: string;\n};\n\nexport type DelegationFilter = {\n  chainId?: number;\n  tags?: string[];\n  from?: Address;\n};\n\nexport type DelegationControllerState = {\n  delegations: {\n    [hash: Hex]: DelegationEntry;\n  };\n};\n\nexport type DelegationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerStoreAction = {\n  type: `${typeof controllerName}:store`;\n  handler: DelegationController['store'];\n};\n\nexport type DelegationControllerSignAction = {\n  type: `${typeof controllerName}:sign`;\n  handler: DelegationController['sign'];\n};\n\nexport type DelegationControllerActions =\n  | DelegationControllerGetStateAction\n  | DelegationControllerStoreAction\n  | DelegationControllerSignAction;\n\nexport type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerEvents = DelegationControllerStateChangeEvent;\n\ntype AllowedActions =\n  | KeyringControllerSignTypedMessageAction\n  | AccountsControllerGetSelectedAccountAction;\n\ntype AllowedEvents = never;\n\nexport type DelegationControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  DelegationControllerActions | AllowedActions,\n  DelegationControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type { KeyringControllerSignTypedMessageAction } from '@metamask/keyring-controller';\n\nimport type {\n  controllerName,\n  DelegationController,\n} from './DelegationController';\n\ntype Hex = `0x${string}`;\ntype Address = `0x${string}`;\n\nexport type { Address, Hex };\n\n/**\n * A version agnostic blob of contract addresses required for the DeleGator system to function.\n */\nexport type DeleGatorEnvironment = {\n  DelegationManager: Hex;\n  EntryPoint: Hex;\n  SimpleFactory: Hex;\n  implementations: {\n    [implementation: string]: Hex;\n  };\n  caveatEnforcers: {\n    [enforcer: string]: Hex;\n  };\n};\n\n/**\n * A delegation caveat is a condition that must be met in order for a delegation\n * to be valid. The caveat is defined by an enforcer, terms, and arguments.\n *\n * @see https://docs.gator.metamask.io/concepts/caveat-enforcers\n */\nexport type Caveat = {\n  enforcer: Hex;\n  terms: Hex;\n  args: Hex;\n};\n\n/**\n * A delegation is a signed statement that gives a delegate permission to\n * act on behalf of a delegator. The permissions are defined by a set of caveats.\n * The caveats are a set of conditions that must be met in order for the delegation\n * to be valid.\n *\n * @see https://docs.gator.metamask.io/concepts/delegation\n */\nexport type Delegation = {\n  /** The address of the delegate. */\n  delegate: Hex;\n  /** The address of the delegator. */\n  delegator: Hex;\n  /** The hash of the parent delegation, or the root authority if this is the root delegation. */\n  authority: Hex;\n  /** The terms of the delegation. */\n  caveats: Caveat[];\n  /** The salt used to generate the delegation signature. */\n  salt: Hex;\n  /** The signature of the delegation. */\n  signature: Hex;\n};\n\n/** An unsigned delegation is a delegation without a signature. */\nexport type UnsignedDelegation = Omit<Delegation, 'signature'>;\n\nexport type DelegationStruct = Omit<Delegation, 'salt'> & {\n  salt: bigint;\n};\n\nexport type DelegationEntry = {\n  tags: string[];\n  chainId: Hex;\n  delegation: Delegation;\n  meta?: string;\n};\n\nexport type DelegationFilter = {\n  chainId?: Hex;\n  tags?: string[];\n  from?: Address;\n};\n\nexport type DelegationControllerState = {\n  delegations: {\n    [hash: Hex]: DelegationEntry;\n  };\n};\n\nexport type DelegationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerSignDelegationAction = {\n  type: `${typeof controllerName}:signDelegation`;\n  handler: DelegationController['signDelegation'];\n};\n\nexport type DelegationControllerStoreAction = {\n  type: `${typeof controllerName}:store`;\n  handler: DelegationController['store'];\n};\n\nexport type DelegationControllerListAction = {\n  type: `${typeof controllerName}:list`;\n  handler: DelegationController['list'];\n};\n\nexport type DelegationControllerRetrieveAction = {\n  type: `${typeof controllerName}:retrieve`;\n  handler: DelegationController['retrieve'];\n};\n\nexport type DelegationControllerChainAction = {\n  type: `${typeof controllerName}:chain`;\n  handler: DelegationController['chain'];\n};\n\nexport type DelegationControllerDeleteAction = {\n  type: `${typeof controllerName}:delete`;\n  handler: DelegationController['delete'];\n};\n\nexport type DelegationControllerActions =\n  | DelegationControllerGetStateAction\n  | DelegationControllerSignDelegationAction\n  | DelegationControllerStoreAction\n  | DelegationControllerListAction\n  | DelegationControllerRetrieveAction\n  | DelegationControllerChainAction\n  | DelegationControllerDeleteAction;\n\nexport type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerEvents = DelegationControllerStateChangeEvent;\n\ntype AllowedActions =\n  | KeyringControllerSignTypedMessageAction\n  | AccountsControllerGetSelectedAccountAction;\n\ntype AllowedEvents = never;\n\nexport type DelegationControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  DelegationControllerActions | AllowedActions,\n  DelegationControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n"]}

package/dist/types.d.cts

@@ -5,30 +5,66 @@ import type { controllerName, DelegationController } from "./DelegationControlle
 type Hex = `0x${string}`;
 type Address = `0x${string}`;
 export type { Address, Hex };
+/**
+ * A version agnostic blob of contract addresses required for the DeleGator system to function.
+ */
+export type DeleGatorEnvironment = {
+    DelegationManager: Hex;
+    EntryPoint: Hex;
+    SimpleFactory: Hex;
+    implementations: {
+        [implementation: string]: Hex;
+    };
+    caveatEnforcers: {
+        [enforcer: string]: Hex;
+    };
+};
+/**
+ * A delegation caveat is a condition that must be met in order for a delegation
+ * to be valid. The caveat is defined by an enforcer, terms, and arguments.
+ *
+ * @see https://docs.gator.metamask.io/concepts/caveat-enforcers
+ */
 export type Caveat = {
     enforcer: Hex;
     terms: Hex;
     args: Hex;
 };
+/**
+ * A delegation is a signed statement that gives a delegate permission to
+ * act on behalf of a delegator. The permissions are defined by a set of caveats.
+ * The caveats are a set of conditions that must be met in order for the delegation
+ * to be valid.
+ *
+ * @see https://docs.gator.metamask.io/concepts/delegation
+ */
 export type Delegation = {
+    /** The address of the delegate. */
     delegate: Hex;
+    /** The address of the delegator. */
     delegator: Hex;
+    /** The hash of the parent delegation, or the root authority if this is the root delegation. */
     authority: Hex;
+    /** The terms of the delegation. */
     caveats: Caveat[];
+    /** The salt used to generate the delegation signature. */
     salt: Hex;
+    /** The signature of the delegation. */
     signature: Hex;
 };
+/** An unsigned delegation is a delegation without a signature. */
+export type UnsignedDelegation = Omit<Delegation, 'signature'>;
 export type DelegationStruct = Omit<Delegation, 'salt'> & {
     salt: bigint;
 };
 export type DelegationEntry = {
     tags: string[];
-    chainId: number;
-    data: Delegation;
+    chainId: Hex;
+    delegation: Delegation;
     meta?: string;
 };
 export type DelegationFilter = {
-    chainId?: number;
+    chainId?: Hex;
     tags?: string[];
     from?: Address;
 };
@@ -38,15 +74,31 @@ export type DelegationControllerState = {
     };
 };
 export type DelegationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerSignDelegationAction = {
+    type: `${typeof controllerName}:signDelegation`;
+    handler: DelegationController['signDelegation'];
+};
 export type DelegationControllerStoreAction = {
     type: `${typeof controllerName}:store`;
     handler: DelegationController['store'];
 };
-export type DelegationControllerSignAction = {
-    type: `${typeof controllerName}:sign`;
-    handler: DelegationController['sign'];
+export type DelegationControllerListAction = {
+    type: `${typeof controllerName}:list`;
+    handler: DelegationController['list'];
+};
+export type DelegationControllerRetrieveAction = {
+    type: `${typeof controllerName}:retrieve`;
+    handler: DelegationController['retrieve'];
+};
+export type DelegationControllerChainAction = {
+    type: `${typeof controllerName}:chain`;
+    handler: DelegationController['chain'];
+};
+export type DelegationControllerDeleteAction = {
+    type: `${typeof controllerName}:delete`;
+    handler: DelegationController['delete'];
 };
-export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerStoreAction | DelegationControllerSignAction;
+export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerSignDelegationAction | DelegationControllerStoreAction | DelegationControllerListAction | DelegationControllerRetrieveAction | DelegationControllerChainAction | DelegationControllerDeleteAction;
 export type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, DelegationControllerState>;
 export type DelegationControllerEvents = DelegationControllerStateChangeEvent;
 type AllowedActions = KeyringControllerSignTypedMessageAction | AccountsControllerGetSelectedAccountAction;

package/dist/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EAAE,uCAAuC,EAAE,qCAAqC;AAE5F,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACrB,mCAA+B;AAEhC,KAAK,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AACzB,KAAK,OAAO,GAAG,KAAK,MAAM,EAAE,CAAC;AAE7B,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAE7B,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,GAAG,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,EAAE,GAAG,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IACxD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE;QACX,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,+BAA+B,GAC/B,8BAA8B,CAAC;AAEnC,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,KAAK,cAAc,GACf,uCAAuC,GACvC,0CAA0C,CAAC;AAE/C,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAC7D,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,EAC1C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EAAE,uCAAuC,EAAE,qCAAqC;AAE5F,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACrB,mCAA+B;AAEhC,KAAK,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AACzB,KAAK,OAAO,GAAG,KAAK,MAAM,EAAE,CAAC;AAE7B,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iBAAiB,EAAE,GAAG,CAAC;IACvB,UAAU,EAAE,GAAG,CAAC;IAChB,aAAa,EAAE,GAAG,CAAC;IACnB,eAAe,EAAE;QACf,CAAC,cAAc,EAAE,MAAM,GAAG,GAAG,CAAC;KAC/B,CAAC;IACF,eAAe,EAAE;QACf,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,mCAAmC;IACnC,QAAQ,EAAE,GAAG,CAAC;IACd,oCAAoC;IACpC,SAAS,EAAE,GAAG,CAAC;IACf,+FAA+F;IAC/F,SAAS,EAAE,GAAG,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,0DAA0D;IAC1D,IAAI,EAAE,GAAG,CAAC;IACV,uCAAuC;IACvC,SAAS,EAAE,GAAG,CAAC;CAChB,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;AAE/D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IACxD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE;QACX,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,GAAG,OAAO,cAAc,WAAW,CAAC;IAC1C,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,GAAG,OAAO,cAAc,SAAS,CAAC;IACxC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,wCAAwC,GACxC,+BAA+B,GAC/B,8BAA8B,GAC9B,kCAAkC,GAClC,+BAA+B,GAC/B,gCAAgC,CAAC;AAErC,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,KAAK,cAAc,GACf,uCAAuC,GACvC,0CAA0C,CAAC;AAE/C,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAC7D,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,EAC1C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC"}

package/dist/types.d.mts

@@ -5,30 +5,66 @@ import type { controllerName, DelegationController } from "./DelegationControlle
 type Hex = `0x${string}`;
 type Address = `0x${string}`;
 export type { Address, Hex };
+/**
+ * A version agnostic blob of contract addresses required for the DeleGator system to function.
+ */
+export type DeleGatorEnvironment = {
+    DelegationManager: Hex;
+    EntryPoint: Hex;
+    SimpleFactory: Hex;
+    implementations: {
+        [implementation: string]: Hex;
+    };
+    caveatEnforcers: {
+        [enforcer: string]: Hex;
+    };
+};
+/**
+ * A delegation caveat is a condition that must be met in order for a delegation
+ * to be valid. The caveat is defined by an enforcer, terms, and arguments.
+ *
+ * @see https://docs.gator.metamask.io/concepts/caveat-enforcers
+ */
 export type Caveat = {
     enforcer: Hex;
     terms: Hex;
     args: Hex;
 };
+/**
+ * A delegation is a signed statement that gives a delegate permission to
+ * act on behalf of a delegator. The permissions are defined by a set of caveats.
+ * The caveats are a set of conditions that must be met in order for the delegation
+ * to be valid.
+ *
+ * @see https://docs.gator.metamask.io/concepts/delegation
+ */
 export type Delegation = {
+    /** The address of the delegate. */
     delegate: Hex;
+    /** The address of the delegator. */
     delegator: Hex;
+    /** The hash of the parent delegation, or the root authority if this is the root delegation. */
     authority: Hex;
+    /** The terms of the delegation. */
     caveats: Caveat[];
+    /** The salt used to generate the delegation signature. */
     salt: Hex;
+    /** The signature of the delegation. */
     signature: Hex;
 };
+/** An unsigned delegation is a delegation without a signature. */
+export type UnsignedDelegation = Omit<Delegation, 'signature'>;
 export type DelegationStruct = Omit<Delegation, 'salt'> & {
     salt: bigint;
 };
 export type DelegationEntry = {
     tags: string[];
-    chainId: number;
-    data: Delegation;
+    chainId: Hex;
+    delegation: Delegation;
     meta?: string;
 };
 export type DelegationFilter = {
-    chainId?: number;
+    chainId?: Hex;
     tags?: string[];
     from?: Address;
 };
@@ -38,15 +74,31 @@ export type DelegationControllerState = {
     };
 };
 export type DelegationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerSignDelegationAction = {
+    type: `${typeof controllerName}:signDelegation`;
+    handler: DelegationController['signDelegation'];
+};
 export type DelegationControllerStoreAction = {
     type: `${typeof controllerName}:store`;
     handler: DelegationController['store'];
 };
-export type DelegationControllerSignAction = {
-    type: `${typeof controllerName}:sign`;
-    handler: DelegationController['sign'];
+export type DelegationControllerListAction = {
+    type: `${typeof controllerName}:list`;
+    handler: DelegationController['list'];
+};
+export type DelegationControllerRetrieveAction = {
+    type: `${typeof controllerName}:retrieve`;
+    handler: DelegationController['retrieve'];
+};
+export type DelegationControllerChainAction = {
+    type: `${typeof controllerName}:chain`;
+    handler: DelegationController['chain'];
+};
+export type DelegationControllerDeleteAction = {
+    type: `${typeof controllerName}:delete`;
+    handler: DelegationController['delete'];
 };
-export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerStoreAction | DelegationControllerSignAction;
+export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerSignDelegationAction | DelegationControllerStoreAction | DelegationControllerListAction | DelegationControllerRetrieveAction | DelegationControllerChainAction | DelegationControllerDeleteAction;
 export type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, DelegationControllerState>;
 export type DelegationControllerEvents = DelegationControllerStateChangeEvent;
 type AllowedActions = KeyringControllerSignTypedMessageAction | AccountsControllerGetSelectedAccountAction;

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EAAE,uCAAuC,EAAE,qCAAqC;AAE5F,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACrB,mCAA+B;AAEhC,KAAK,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AACzB,KAAK,OAAO,GAAG,KAAK,MAAM,EAAE,CAAC;AAE7B,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAE7B,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,GAAG,CAAC;IACd,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,GAAG,CAAC;IACf,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,EAAE,GAAG,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IACxD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE;QACX,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,+BAA+B,GAC/B,8BAA8B,CAAC;AAEnC,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,KAAK,cAAc,GACf,uCAAuC,GACvC,0CAA0C,CAAC;AAE/C,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAC7D,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,EAC1C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0CAA0C,EAAE,sCAAsC;AAChG,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EAAE,uCAAuC,EAAE,qCAAqC;AAE5F,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACrB,mCAA+B;AAEhC,KAAK,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AACzB,KAAK,OAAO,GAAG,KAAK,MAAM,EAAE,CAAC;AAE7B,YAAY,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,iBAAiB,EAAE,GAAG,CAAC;IACvB,UAAU,EAAE,GAAG,CAAC;IAChB,aAAa,EAAE,GAAG,CAAC;IACnB,eAAe,EAAE;QACf,CAAC,cAAc,EAAE,MAAM,GAAG,GAAG,CAAC;KAC/B,CAAC;IACF,eAAe,EAAE;QACf,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,EAAE,GAAG,CAAC;CACX,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,mCAAmC;IACnC,QAAQ,EAAE,GAAG,CAAC;IACd,oCAAoC;IACpC,SAAS,EAAE,GAAG,CAAC;IACf,+FAA+F;IAC/F,SAAS,EAAE,GAAG,CAAC;IACf,mCAAmC;IACnC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,0DAA0D;IAC1D,IAAI,EAAE,GAAG,CAAC;IACV,uCAAuC;IACvC,SAAS,EAAE,GAAG,CAAC;CAChB,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;AAE/D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IACxD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE;QACX,CAAC,IAAI,EAAE,GAAG,GAAG,eAAe,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,CACvE,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,GAAG,OAAO,cAAc,OAAO,CAAC;IACtC,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,GAAG,OAAO,cAAc,WAAW,CAAC;IAC1C,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,cAAc,QAAQ,CAAC;IACvC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,GAAG,OAAO,cAAc,SAAS,CAAC;IACxC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,wCAAwC,GACxC,+BAA+B,GAC/B,8BAA8B,GAC9B,kCAAkC,GAClC,+BAA+B,GAC/B,gCAAgC,CAAC;AAErC,MAAM,MAAM,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,KAAK,cAAc,GACf,uCAAuC,GACvC,0CAA0C,CAAC;AAE/C,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAC7D,OAAO,cAAc,EACrB,2BAA2B,GAAG,cAAc,EAC5C,0BAA0B,GAAG,aAAa,EAC1C,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC"}

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type { KeyringControllerSignTypedMessageAction } from '@metamask/keyring-controller';\n\nimport type {\n  controllerName,\n  DelegationController,\n} from './DelegationController';\n\ntype Hex = `0x${string}`;\ntype Address = `0x${string}`;\n\nexport type { Address, Hex };\n\nexport type Caveat = {\n  enforcer: Hex;\n  terms: Hex;\n  args: Hex;\n};\n\nexport type Delegation = {\n  delegate: Hex;\n  delegator: Hex;\n  authority: Hex;\n  caveats: Caveat[];\n  salt: Hex;\n  signature: Hex;\n};\n\nexport type DelegationStruct = Omit<Delegation, 'salt'> & {\n  salt: bigint;\n};\n\nexport type DelegationEntry = {\n  tags: string[];\n  chainId: number;\n  data: Delegation;\n  meta?: string;\n};\n\nexport type DelegationFilter = {\n  chainId?: number;\n  tags?: string[];\n  from?: Address;\n};\n\nexport type DelegationControllerState = {\n  delegations: {\n    [hash: Hex]: DelegationEntry;\n  };\n};\n\nexport type DelegationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerStoreAction = {\n  type: `${typeof controllerName}:store`;\n  handler: DelegationController['store'];\n};\n\nexport type DelegationControllerSignAction = {\n  type: `${typeof controllerName}:sign`;\n  handler: DelegationController['sign'];\n};\n\nexport type DelegationControllerActions =\n  | DelegationControllerGetStateAction\n  | DelegationControllerStoreAction\n  | DelegationControllerSignAction;\n\nexport type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerEvents = DelegationControllerStateChangeEvent;\n\ntype AllowedActions =\n  | KeyringControllerSignTypedMessageAction\n  | AccountsControllerGetSelectedAccountAction;\n\ntype AllowedEvents = never;\n\nexport type DelegationControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  DelegationControllerActions | AllowedActions,\n  DelegationControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { AccountsControllerGetSelectedAccountAction } from '@metamask/accounts-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type { KeyringControllerSignTypedMessageAction } from '@metamask/keyring-controller';\n\nimport type {\n  controllerName,\n  DelegationController,\n} from './DelegationController';\n\ntype Hex = `0x${string}`;\ntype Address = `0x${string}`;\n\nexport type { Address, Hex };\n\n/**\n * A version agnostic blob of contract addresses required for the DeleGator system to function.\n */\nexport type DeleGatorEnvironment = {\n  DelegationManager: Hex;\n  EntryPoint: Hex;\n  SimpleFactory: Hex;\n  implementations: {\n    [implementation: string]: Hex;\n  };\n  caveatEnforcers: {\n    [enforcer: string]: Hex;\n  };\n};\n\n/**\n * A delegation caveat is a condition that must be met in order for a delegation\n * to be valid. The caveat is defined by an enforcer, terms, and arguments.\n *\n * @see https://docs.gator.metamask.io/concepts/caveat-enforcers\n */\nexport type Caveat = {\n  enforcer: Hex;\n  terms: Hex;\n  args: Hex;\n};\n\n/**\n * A delegation is a signed statement that gives a delegate permission to\n * act on behalf of a delegator. The permissions are defined by a set of caveats.\n * The caveats are a set of conditions that must be met in order for the delegation\n * to be valid.\n *\n * @see https://docs.gator.metamask.io/concepts/delegation\n */\nexport type Delegation = {\n  /** The address of the delegate. */\n  delegate: Hex;\n  /** The address of the delegator. */\n  delegator: Hex;\n  /** The hash of the parent delegation, or the root authority if this is the root delegation. */\n  authority: Hex;\n  /** The terms of the delegation. */\n  caveats: Caveat[];\n  /** The salt used to generate the delegation signature. */\n  salt: Hex;\n  /** The signature of the delegation. */\n  signature: Hex;\n};\n\n/** An unsigned delegation is a delegation without a signature. */\nexport type UnsignedDelegation = Omit<Delegation, 'signature'>;\n\nexport type DelegationStruct = Omit<Delegation, 'salt'> & {\n  salt: bigint;\n};\n\nexport type DelegationEntry = {\n  tags: string[];\n  chainId: Hex;\n  delegation: Delegation;\n  meta?: string;\n};\n\nexport type DelegationFilter = {\n  chainId?: Hex;\n  tags?: string[];\n  from?: Address;\n};\n\nexport type DelegationControllerState = {\n  delegations: {\n    [hash: Hex]: DelegationEntry;\n  };\n};\n\nexport type DelegationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerSignDelegationAction = {\n  type: `${typeof controllerName}:signDelegation`;\n  handler: DelegationController['signDelegation'];\n};\n\nexport type DelegationControllerStoreAction = {\n  type: `${typeof controllerName}:store`;\n  handler: DelegationController['store'];\n};\n\nexport type DelegationControllerListAction = {\n  type: `${typeof controllerName}:list`;\n  handler: DelegationController['list'];\n};\n\nexport type DelegationControllerRetrieveAction = {\n  type: `${typeof controllerName}:retrieve`;\n  handler: DelegationController['retrieve'];\n};\n\nexport type DelegationControllerChainAction = {\n  type: `${typeof controllerName}:chain`;\n  handler: DelegationController['chain'];\n};\n\nexport type DelegationControllerDeleteAction = {\n  type: `${typeof controllerName}:delete`;\n  handler: DelegationController['delete'];\n};\n\nexport type DelegationControllerActions =\n  | DelegationControllerGetStateAction\n  | DelegationControllerSignDelegationAction\n  | DelegationControllerStoreAction\n  | DelegationControllerListAction\n  | DelegationControllerRetrieveAction\n  | DelegationControllerChainAction\n  | DelegationControllerDeleteAction;\n\nexport type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  DelegationControllerState\n>;\n\nexport type DelegationControllerEvents = DelegationControllerStateChangeEvent;\n\ntype AllowedActions =\n  | KeyringControllerSignTypedMessageAction\n  | AccountsControllerGetSelectedAccountAction;\n\ntype AllowedEvents = never;\n\nexport type DelegationControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  DelegationControllerActions | AllowedActions,\n  DelegationControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n"]}

package/dist/utils.cjs

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTypedMessageParams = exports.toDelegationStruct = exports.isAddressEqual = void 0;
+exports.createTypedMessageParams = exports.toDelegationStruct = exports.isHexEqual = void 0;
 const utils_1 = require("@metamask/utils");
 const constants_1 = require("./constants.cjs");
 /**
- * Checks if two addresses are equal.
+ * Checks if two hex strings are equal.
  *
- * @param a - The first address.
- * @param b - The second address.
- * @returns True if the addresses are equal, false otherwise.
+ * @param a - The first hex string.
+ * @param b - The second hex string.
+ * @returns True if the hex strings are equal, false otherwise.
  */
-function isAddressEqual(a, b) {
+function isHexEqual(a, b) {
     return a.toLowerCase() === b.toLowerCase();
 }
-exports.isAddressEqual = isAddressEqual;
+exports.isHexEqual = isHexEqual;
 /**
  * Converts a Delegation to a DelegationStruct.
  * The DelegationStruct is the format used in the Delegation Framework.

package/dist/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AACA,2CAAqD;AAErD,+CAA6D;AAG7D;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,CAAU,EAAE,CAAU;IACnD,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AAFD,wCAEC;AASD;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,UAAsB,EACJ,EAAE;IACpB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAClD,QAAQ,EAAE,IAAA,0BAAkB,EAAC,MAAM,CAAC,QAAQ,CAAC;QAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC,CAAC;IAEJ,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAErE,OAAO;QACL,QAAQ,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,SAAS,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC,SAAS,CAAC;QACnD,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,OAAO;QACP,IAAI;QACJ,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,kBAAkB,sBAmB7B;AAEF;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,IAAqC;IAErC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAE9D,MAAM,IAAI,GAAuB;QAC/B,IAAI,EAAE;YACJ,KAAK,EAAE,0CAA8B;YACrC,WAAW,EAAE,YAAY;YACzB,MAAM,EAAE;gBACN,OAAO;gBACP,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,GAAG;gBACZ,iBAAiB;aAClB;YACD,OAAO,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC;SACxC;QACD,IAAI;KACL,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AArBD,4DAqBC","sourcesContent":["import type { TypedMessageParams } from '@metamask/keyring-controller';\nimport { getChecksumAddress } from '@metamask/utils';\n\nimport { SIGNABLE_DELEGATION_TYPED_DATA } from './constants';\nimport type { Address, Delegation, DelegationStruct } from './types';\n\n/**\n * Checks if two addresses are equal.\n *\n * @param a - The first address.\n * @param b - The second address.\n * @returns True if the addresses are equal, false otherwise.\n */\nexport function isAddressEqual(a: Address, b: Address) {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\ntype CreateTypedMessageParamsOptions = {\n  chainId: number;\n  from: Address;\n  delegation: Delegation;\n  verifyingContract: Address;\n};\n\n/**\n * Converts a Delegation to a DelegationStruct.\n * The DelegationStruct is the format used in the Delegation Framework.\n *\n * @param delegation the delegation to format\n * @returns the formatted delegation\n */\nexport const toDelegationStruct = (\n  delegation: Delegation,\n): DelegationStruct => {\n  const caveats = delegation.caveats.map((caveat) => ({\n    enforcer: getChecksumAddress(caveat.enforcer),\n    terms: caveat.terms,\n    args: caveat.args,\n  }));\n\n  const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);\n\n  return {\n    delegate: getChecksumAddress(delegation.delegate),\n    delegator: getChecksumAddress(delegation.delegator),\n    authority: delegation.authority,\n    caveats,\n    salt,\n    signature: delegation.signature,\n  };\n};\n\n/**\n *\n * @param opts - The options for creating typed message params.\n * @returns The typed message params.\n */\nexport function createTypedMessageParams(\n  opts: CreateTypedMessageParamsOptions,\n): TypedMessageParams {\n  const { chainId, from, delegation, verifyingContract } = opts;\n\n  const data: TypedMessageParams = {\n    data: {\n      types: SIGNABLE_DELEGATION_TYPED_DATA,\n      primaryType: 'Delegation',\n      domain: {\n        chainId,\n        name: 'DelegationManager',\n        version: '1',\n        verifyingContract,\n      },\n      message: toDelegationStruct(delegation),\n    },\n    from,\n  };\n\n  return data;\n}\n"]}
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AACA,2CAAqD;AAErD,+CAA6D;AAG7D;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,CAAM,EAAE,CAAM;IACvC,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AAFD,gCAEC;AASD;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,UAAsB,EACJ,EAAE;IACpB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAClD,QAAQ,EAAE,IAAA,0BAAkB,EAAC,MAAM,CAAC,QAAQ,CAAC;QAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC,CAAC;IAEJ,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAErE,OAAO;QACL,QAAQ,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,SAAS,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC,SAAS,CAAC;QACnD,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,OAAO;QACP,IAAI;QACJ,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,kBAAkB,sBAmB7B;AAEF;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,IAAqC;IAErC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAE9D,MAAM,IAAI,GAAuB;QAC/B,IAAI,EAAE;YACJ,KAAK,EAAE,0CAA8B;YACrC,WAAW,EAAE,YAAY;YACzB,MAAM,EAAE;gBACN,OAAO;gBACP,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,GAAG;gBACZ,iBAAiB;aAClB;YACD,OAAO,EAAE,IAAA,0BAAkB,EAAC,UAAU,CAAC;SACxC;QACD,IAAI;KACL,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AArBD,4DAqBC","sourcesContent":["import type { TypedMessageParams } from '@metamask/keyring-controller';\nimport { getChecksumAddress } from '@metamask/utils';\n\nimport { SIGNABLE_DELEGATION_TYPED_DATA } from './constants';\nimport type { Address, Delegation, DelegationStruct, Hex } from './types';\n\n/**\n * Checks if two hex strings are equal.\n *\n * @param a - The first hex string.\n * @param b - The second hex string.\n * @returns True if the hex strings are equal, false otherwise.\n */\nexport function isHexEqual(a: Hex, b: Hex) {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\ntype CreateTypedMessageParamsOptions = {\n  chainId: number;\n  from: Address;\n  delegation: Delegation;\n  verifyingContract: Address;\n};\n\n/**\n * Converts a Delegation to a DelegationStruct.\n * The DelegationStruct is the format used in the Delegation Framework.\n *\n * @param delegation the delegation to format\n * @returns the formatted delegation\n */\nexport const toDelegationStruct = (\n  delegation: Delegation,\n): DelegationStruct => {\n  const caveats = delegation.caveats.map((caveat) => ({\n    enforcer: getChecksumAddress(caveat.enforcer),\n    terms: caveat.terms,\n    args: caveat.args,\n  }));\n\n  const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);\n\n  return {\n    delegate: getChecksumAddress(delegation.delegate),\n    delegator: getChecksumAddress(delegation.delegator),\n    authority: delegation.authority,\n    caveats,\n    salt,\n    signature: delegation.signature,\n  };\n};\n\n/**\n *\n * @param opts - The options for creating typed message params.\n * @returns The typed message params.\n */\nexport function createTypedMessageParams(\n  opts: CreateTypedMessageParamsOptions,\n): TypedMessageParams {\n  const { chainId, from, delegation, verifyingContract } = opts;\n\n  const data: TypedMessageParams = {\n    data: {\n      types: SIGNABLE_DELEGATION_TYPED_DATA,\n      primaryType: 'Delegation',\n      domain: {\n        chainId,\n        name: 'DelegationManager',\n        version: '1',\n        verifyingContract,\n      },\n      message: toDelegationStruct(delegation),\n    },\n    from,\n  };\n\n  return data;\n}\n"]}

package/dist/utils.d.cts

@@ -1,13 +1,13 @@
 import type { TypedMessageParams } from "@metamask/keyring-controller";
-import type { Address, Delegation, DelegationStruct } from "./types.cjs";
+import type { Address, Delegation, DelegationStruct, Hex } from "./types.cjs";
 /**
- * Checks if two addresses are equal.
+ * Checks if two hex strings are equal.
  *
- * @param a - The first address.
- * @param b - The second address.
- * @returns True if the addresses are equal, false otherwise.
+ * @param a - The first hex string.
+ * @param b - The second hex string.
+ * @returns True if the hex strings are equal, false otherwise.
  */
-export declare function isAddressEqual(a: Address, b: Address): boolean;
+export declare function isHexEqual(a: Hex, b: Hex): boolean;
 type CreateTypedMessageParamsOptions = {
     chainId: number;
     from: Address;

package/dist/utils.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qCAAqC;AAIvE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,oBAAgB;AAErE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,WAEpD;AAED,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,eACjB,UAAU,KACrB,gBAiBF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,+BAA+B,GACpC,kBAAkB,CAmBpB"}
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qCAAqC;AAIvE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,EAAE,oBAAgB;AAE1E;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,WAExC;AAED,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,eACjB,UAAU,KACrB,gBAiBF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,+BAA+B,GACpC,kBAAkB,CAmBpB"}

package/dist/utils.d.mts

@@ -1,13 +1,13 @@
 import type { TypedMessageParams } from "@metamask/keyring-controller";
-import type { Address, Delegation, DelegationStruct } from "./types.mjs";
+import type { Address, Delegation, DelegationStruct, Hex } from "./types.mjs";
 /**
- * Checks if two addresses are equal.
+ * Checks if two hex strings are equal.
  *
- * @param a - The first address.
- * @param b - The second address.
- * @returns True if the addresses are equal, false otherwise.
+ * @param a - The first hex string.
+ * @param b - The second hex string.
+ * @returns True if the hex strings are equal, false otherwise.
  */
-export declare function isAddressEqual(a: Address, b: Address): boolean;
+export declare function isHexEqual(a: Hex, b: Hex): boolean;
 type CreateTypedMessageParamsOptions = {
     chainId: number;
     from: Address;

package/dist/utils.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qCAAqC;AAIvE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,oBAAgB;AAErE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,WAEpD;AAED,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,eACjB,UAAU,KACrB,gBAiBF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,+BAA+B,GACpC,kBAAkB,CAmBpB"}
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,qCAAqC;AAIvE,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,EAAE,oBAAgB;AAE1E;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,WAExC;AAED,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,eACjB,UAAU,KACrB,gBAiBF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,+BAA+B,GACpC,kBAAkB,CAmBpB"}

package/dist/utils.mjs

@@ -1,13 +1,13 @@
 import { getChecksumAddress } from "@metamask/utils";
 import { SIGNABLE_DELEGATION_TYPED_DATA } from "./constants.mjs";
 /**
- * Checks if two addresses are equal.
+ * Checks if two hex strings are equal.
  *
- * @param a - The first address.
- * @param b - The second address.
- * @returns True if the addresses are equal, false otherwise.
+ * @param a - The first hex string.
+ * @param b - The second hex string.
+ * @returns True if the hex strings are equal, false otherwise.
  */
-export function isAddressEqual(a, b) {
+export function isHexEqual(a, b) {
     return a.toLowerCase() === b.toLowerCase();
 }
 /**

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAErD,OAAO,EAAE,8BAA8B,EAAE,wBAAoB;AAG7D;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,CAAU,EAAE,CAAU;IACnD,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AASD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,UAAsB,EACJ,EAAE;IACpB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAClD,QAAQ,EAAE,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC,CAAC;IAEJ,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAErE,OAAO;QACL,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC,SAAS,CAAC;QACnD,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,OAAO;QACP,IAAI;QACJ,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAqC;IAErC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAE9D,MAAM,IAAI,GAAuB;QAC/B,IAAI,EAAE;YACJ,KAAK,EAAE,8BAA8B;YACrC,WAAW,EAAE,YAAY;YACzB,MAAM,EAAE;gBACN,OAAO;gBACP,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,GAAG;gBACZ,iBAAiB;aAClB;YACD,OAAO,EAAE,kBAAkB,CAAC,UAAU,CAAC;SACxC;QACD,IAAI;KACL,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { TypedMessageParams } from '@metamask/keyring-controller';\nimport { getChecksumAddress } from '@metamask/utils';\n\nimport { SIGNABLE_DELEGATION_TYPED_DATA } from './constants';\nimport type { Address, Delegation, DelegationStruct } from './types';\n\n/**\n * Checks if two addresses are equal.\n *\n * @param a - The first address.\n * @param b - The second address.\n * @returns True if the addresses are equal, false otherwise.\n */\nexport function isAddressEqual(a: Address, b: Address) {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\ntype CreateTypedMessageParamsOptions = {\n  chainId: number;\n  from: Address;\n  delegation: Delegation;\n  verifyingContract: Address;\n};\n\n/**\n * Converts a Delegation to a DelegationStruct.\n * The DelegationStruct is the format used in the Delegation Framework.\n *\n * @param delegation the delegation to format\n * @returns the formatted delegation\n */\nexport const toDelegationStruct = (\n  delegation: Delegation,\n): DelegationStruct => {\n  const caveats = delegation.caveats.map((caveat) => ({\n    enforcer: getChecksumAddress(caveat.enforcer),\n    terms: caveat.terms,\n    args: caveat.args,\n  }));\n\n  const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);\n\n  return {\n    delegate: getChecksumAddress(delegation.delegate),\n    delegator: getChecksumAddress(delegation.delegator),\n    authority: delegation.authority,\n    caveats,\n    salt,\n    signature: delegation.signature,\n  };\n};\n\n/**\n *\n * @param opts - The options for creating typed message params.\n * @returns The typed message params.\n */\nexport function createTypedMessageParams(\n  opts: CreateTypedMessageParamsOptions,\n): TypedMessageParams {\n  const { chainId, from, delegation, verifyingContract } = opts;\n\n  const data: TypedMessageParams = {\n    data: {\n      types: SIGNABLE_DELEGATION_TYPED_DATA,\n      primaryType: 'Delegation',\n      domain: {\n        chainId,\n        name: 'DelegationManager',\n        version: '1',\n        verifyingContract,\n      },\n      message: toDelegationStruct(delegation),\n    },\n    from,\n  };\n\n  return data;\n}\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAErD,OAAO,EAAE,8BAA8B,EAAE,wBAAoB;AAG7D;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,CAAM,EAAE,CAAM;IACvC,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AASD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,UAAsB,EACJ,EAAE;IACpB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAClD,QAAQ,EAAE,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC7C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC,CAAC;IAEJ,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAErE,OAAO;QACL,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjD,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC,SAAS,CAAC;QACnD,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,OAAO;QACP,IAAI;QACJ,SAAS,EAAE,UAAU,CAAC,SAAS;KAChC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAqC;IAErC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAE9D,MAAM,IAAI,GAAuB;QAC/B,IAAI,EAAE;YACJ,KAAK,EAAE,8BAA8B;YACrC,WAAW,EAAE,YAAY;YACzB,MAAM,EAAE;gBACN,OAAO;gBACP,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,GAAG;gBACZ,iBAAiB;aAClB;YACD,OAAO,EAAE,kBAAkB,CAAC,UAAU,CAAC;SACxC;QACD,IAAI;KACL,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { TypedMessageParams } from '@metamask/keyring-controller';\nimport { getChecksumAddress } from '@metamask/utils';\n\nimport { SIGNABLE_DELEGATION_TYPED_DATA } from './constants';\nimport type { Address, Delegation, DelegationStruct, Hex } from './types';\n\n/**\n * Checks if two hex strings are equal.\n *\n * @param a - The first hex string.\n * @param b - The second hex string.\n * @returns True if the hex strings are equal, false otherwise.\n */\nexport function isHexEqual(a: Hex, b: Hex) {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\ntype CreateTypedMessageParamsOptions = {\n  chainId: number;\n  from: Address;\n  delegation: Delegation;\n  verifyingContract: Address;\n};\n\n/**\n * Converts a Delegation to a DelegationStruct.\n * The DelegationStruct is the format used in the Delegation Framework.\n *\n * @param delegation the delegation to format\n * @returns the formatted delegation\n */\nexport const toDelegationStruct = (\n  delegation: Delegation,\n): DelegationStruct => {\n  const caveats = delegation.caveats.map((caveat) => ({\n    enforcer: getChecksumAddress(caveat.enforcer),\n    terms: caveat.terms,\n    args: caveat.args,\n  }));\n\n  const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);\n\n  return {\n    delegate: getChecksumAddress(delegation.delegate),\n    delegator: getChecksumAddress(delegation.delegator),\n    authority: delegation.authority,\n    caveats,\n    salt,\n    signature: delegation.signature,\n  };\n};\n\n/**\n *\n * @param opts - The options for creating typed message params.\n * @returns The typed message params.\n */\nexport function createTypedMessageParams(\n  opts: CreateTypedMessageParamsOptions,\n): TypedMessageParams {\n  const { chainId, from, delegation, verifyingContract } = opts;\n\n  const data: TypedMessageParams = {\n    data: {\n      types: SIGNABLE_DELEGATION_TYPED_DATA,\n      primaryType: 'Delegation',\n      domain: {\n        chainId,\n        name: 'DelegationManager',\n        version: '1',\n        verifyingContract,\n      },\n      message: toDelegationStruct(delegation),\n    },\n    from,\n  };\n\n  return data;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/delegation-controller",
-  "version": "0.1.0-preview-c67b57f2",
+  "version": "0.1.0-preview-6c44e568",
   "description": "Manages delegations for MetaMask",
   "keywords": [
     "MetaMask",
@@ -48,12 +48,12 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.0.0",
-    "@metamask/keyring-controller": "^21.0.2",
     "@metamask/utils": "^11.2.0"
   },
   "devDependencies": {
     "@metamask/accounts-controller": "^27.0.0",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-controller": "^21.0.3",
     "@ts-bridge/cli": "^0.6.1",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
@@ -64,7 +64,8 @@
     "typescript": "~5.2.2"
   },
   "peerDependencies": {
-    "@metamask/accounts-controller": "^27.0.0"
+    "@metamask/accounts-controller": "^27.0.0",
+    "@metamask/keyring-controller": "^21.0.2"
   },
   "engines": {
     "node": "^18.18 || >=20"