@metamask-previews/delegation-controller 0.1.0-preview-c67b57f2

package/CHANGELOG.md

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

package/LICENSE

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

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/delegation-controller`
+
+Centralized place to store and sign delegations.
+
+## Installation
+
+`yarn add @metamask/delegation-controller`
+
+or
+
+`npm install @metamask/delegation-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/DelegationController.cjs

@@ -0,0 +1,177 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DelegationController = exports.getDefaultDelegationControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const keyring_controller_1 = require("@metamask/keyring-controller");
+const constants_1 = require("./constants.cjs");
+const utils_1 = require("./utils.cjs");
+exports.controllerName = 'DelegationController';
+const delegationControllerMetadata = {
+    delegations: {
+        persist: true,
+        anonymous: false,
+    },
+};
+/**
+ * Constructs the default {@link DelegationController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link DelegationController} state.
+ */
+function getDefaultDelegationControllerState() {
+    return {
+        delegations: {},
+    };
+}
+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, }) {
+        super({
+            messenger,
+            metadata: delegationControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultDelegationControllerState(),
+                ...state,
+            },
+        });
+    }
+    /**
+     * 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,
+        });
+        // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
+        // Waiting on confirmations team to implement this.
+        const signature = await this.messagingSystem.call('KeyringController:signTypedMessage', data, keyring_controller_1.SignTypedDataVersion.V4);
+        return signature;
+    }
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param hash - The hash of the delegation to store.
+     * @param entry - The delegation entry to store.
+     */
+    store(hash, entry) {
+        // 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]) {
+            throw new Error('Invalid authority');
+        }
+        this.update((state) => {
+            state.delegations[hash] = entry;
+        });
+    }
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter) {
+        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
+        const requester = account.address;
+        let list = Object.values(this.state.delegations);
+        if (filter?.from) {
+            list = list.filter((entry) => (0, utils_1.isAddressEqual)(entry.data.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));
+        }
+        if (filter?.chainId) {
+            list = list.filter((entry) => entry.chainId === filter.chainId);
+        }
+        const tags = filter?.tags;
+        if (tags && tags.length > 0) {
+            // Filter entries that contain all of the filter tags
+            list = list.filter((entry) => tags.every((tag) => entry.tags.includes(tag)));
+        }
+        return list;
+    }
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash) {
+        return this.state.delegations[hash] ?? null;
+    }
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash) {
+        const chain = [];
+        const entry = this.retrieve(hash);
+        if (!entry) {
+            return null;
+        }
+        chain.push(entry);
+        for (let _hash = entry.data.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;
+        }
+        return chain;
+    }
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash) {
+        const root = this.retrieve(hash);
+        if (!root) {
+            return 0;
+        }
+        const entries = Object.entries(this.state.delegations);
+        let count = 0;
+        const nextHashes = [hash];
+        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);
+            // 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;
+        }
+        return count;
+    }
+}
+exports.DelegationController = DelegationController;
+//# sourceMappingURL=DelegationController.cjs.map

package/dist/DelegationController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.cjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAC3D,qEAAoE;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"]}

package/dist/DelegationController.d.cts

@@ -0,0 +1,73 @@
+import { BaseController } from "@metamask/base-controller";
+import type { Address, Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, Hex } 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, }: {
+        messenger: DelegationControllerMessenger;
+        state?: Partial<DelegationControllerState>;
+    });
+    /**
+     * 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;
+    }): Promise<string>;
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param hash - The hash of the delegation to store.
+     * @param entry - The delegation entry to store.
+     */
+    store(hash: Hex, entry: DelegationEntry): void;
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter?: DelegationFilter): DelegationEntry[];
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash: Hex): DelegationEntry;
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash: Hex): DelegationEntry[] | null;
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash: Hex): number;
+}
+//# sourceMappingURL=DelegationController.d.cts.map

package/dist/DelegationController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.d.cts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;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"}

package/dist/DelegationController.d.mts

@@ -0,0 +1,73 @@
+import { BaseController } from "@metamask/base-controller";
+import type { Address, Delegation, DelegationControllerMessenger, DelegationControllerState, DelegationEntry, DelegationFilter, Hex } 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, }: {
+        messenger: DelegationControllerMessenger;
+        state?: Partial<DelegationControllerState>;
+    });
+    /**
+     * 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;
+    }): Promise<string>;
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param hash - The hash of the delegation to store.
+     * @param entry - The delegation entry to store.
+     */
+    store(hash: Hex, entry: DelegationEntry): void;
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter?: DelegationFilter): DelegationEntry[];
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash: Hex): DelegationEntry;
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash: Hex): DelegationEntry[] | null;
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash: Hex): number;
+}
+//# sourceMappingURL=DelegationController.d.mts.map

package/dist/DelegationController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegationController.d.mts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;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"}

package/dist/DelegationController.mjs

@@ -0,0 +1,172 @@
+import { BaseController } from "@metamask/base-controller";
+import { SignTypedDataVersion } from "@metamask/keyring-controller";
+import { ROOT_AUTHORITY } from "./constants.mjs";
+import { createTypedMessageParams, isAddressEqual } from "./utils.mjs";
+export const controllerName = 'DelegationController';
+const delegationControllerMetadata = {
+    delegations: {
+        persist: true,
+        anonymous: false,
+    },
+};
+/**
+ * Constructs the default {@link DelegationController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link DelegationController} state.
+ */
+export function getDefaultDelegationControllerState() {
+    return {
+        delegations: {},
+    };
+}
+/**
+ * The {@link DelegationController} class.
+ * This controller is meant to be a centralized place to store and sign delegations.
+ */
+export class DelegationController extends BaseController {
+    constructor({ messenger, state, }) {
+        super({
+            messenger,
+            metadata: delegationControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultDelegationControllerState(),
+                ...state,
+            },
+        });
+    }
+    /**
+     * 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 = createTypedMessageParams({
+            chainId,
+            from: account.address,
+            delegation,
+            verifyingContract,
+        });
+        // TODO:: Replace with `SignatureController:newUnsignedTypedMessage`.
+        // Waiting on confirmations team to implement this.
+        const signature = await this.messagingSystem.call('KeyringController:signTypedMessage', data, SignTypedDataVersion.V4);
+        return signature;
+    }
+    /**
+     * Stores a delegation in storage.
+     *
+     * @param hash - The hash of the delegation to store.
+     * @param entry - The delegation entry to store.
+     */
+    store(hash, entry) {
+        // 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]) {
+            throw new Error('Invalid authority');
+        }
+        this.update((state) => {
+            state.delegations[hash] = entry;
+        });
+    }
+    /**
+     * Lists delegation entries.
+     *
+     * @param filter - The filter to use to list the delegation entries.
+     * @returns A list of delegation entries that match the filter.
+     */
+    list(filter) {
+        const account = this.messagingSystem.call('AccountsController:getSelectedAccount');
+        const requester = account.address;
+        let list = Object.values(this.state.delegations);
+        if (filter?.from) {
+            list = list.filter((entry) => isAddressEqual(entry.data.delegator, filter.from));
+        }
+        if (!filter?.from ||
+            (filter?.from && !isAddressEqual(filter.from, requester))) {
+            list = list.filter((entry) => isAddressEqual(entry.data.delegate, requester));
+        }
+        if (filter?.chainId) {
+            list = list.filter((entry) => entry.chainId === filter.chainId);
+        }
+        const tags = filter?.tags;
+        if (tags && tags.length > 0) {
+            // Filter entries that contain all of the filter tags
+            list = list.filter((entry) => tags.every((tag) => entry.tags.includes(tag)));
+        }
+        return list;
+    }
+    /**
+     * Retrieves the delegation entry for a given delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation entry, or null if not found.
+     */
+    retrieve(hash) {
+        return this.state.delegations[hash] ?? null;
+    }
+    /**
+     * Retrieves a delegation chain from a delegation hash.
+     *
+     * @param hash - The hash of the delegation to retrieve.
+     * @returns The delegation chain, or null if not found.
+     */
+    chain(hash) {
+        const chain = [];
+        const entry = this.retrieve(hash);
+        if (!entry) {
+            return null;
+        }
+        chain.push(entry);
+        for (let _hash = entry.data.authority; _hash !== ROOT_AUTHORITY;) {
+            const parent = this.retrieve(_hash);
+            if (!parent) {
+                throw new Error('Invalid delegation chain');
+            }
+            chain.push(parent);
+            _hash = parent.data.authority;
+        }
+        return chain;
+    }
+    /**
+     * Deletes a delegation entrie from storage, along with any other entries
+     * that are redelegated from it.
+     *
+     * @param hash - The hash of the delegation to delete.
+     * @returns The number of entries deleted.
+     */
+    delete(hash) {
+        const root = this.retrieve(hash);
+        if (!root) {
+            return 0;
+        }
+        const entries = Object.entries(this.state.delegations);
+        let count = 0;
+        const nextHashes = [hash];
+        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);
+            // 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;
+        }
+        return count;
+    }
+}
+//# sourceMappingURL=DelegationController.mjs.map

package/dist/DelegationController.mjs.map

@@ -0,0 +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"]}

package/dist/constants.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SIGNABLE_DELEGATION_TYPED_DATA = exports.ROOT_AUTHORITY = void 0;
+exports.ROOT_AUTHORITY = '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff';
+const EIP712Domain = [
+    { name: 'name', type: 'string' },
+    { name: 'version', type: 'string' },
+    { name: 'chainId', type: 'uint256' },
+    { name: 'verifyingContract', type: 'address' },
+];
+const SDK_SIGNABLE_DELEGATION_TYPED_DATA = {
+    Caveat: [
+        { name: 'enforcer', type: 'address' },
+        { name: 'terms', type: 'bytes' },
+    ],
+    Delegation: [
+        { name: 'delegate', type: 'address' },
+        { name: 'delegator', type: 'address' },
+        { name: 'authority', type: 'bytes32' },
+        { name: 'caveats', type: 'Caveat[]' },
+        { name: 'salt', type: 'uint256' },
+    ],
+};
+exports.SIGNABLE_DELEGATION_TYPED_DATA = {
+    EIP712Domain,
+    ...SDK_SIGNABLE_DELEGATION_TYPED_DATA,
+};
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GACzB,oEAA2E,CAAC;AAE9E,MAAM,YAAY,GAAG;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;IACnC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;CAC/C,CAAC;AAEF,MAAM,kCAAkC,GAAG;IACzC,MAAM,EAAE;QACN,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE;KACjC;IACD,UAAU,EAAE;QACV,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;QACrC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;KAClC;CACO,CAAC;AAEE,QAAA,8BAA8B,GAAG;IAC5C,YAAY;IACZ,GAAG,kCAAkC;CACtC,CAAC","sourcesContent":["import type { Hex } from './types';\n\nexport const ROOT_AUTHORITY =\n  '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff' as Hex;\n\nconst EIP712Domain = [\n  { name: 'name', type: 'string' },\n  { name: 'version', type: 'string' },\n  { name: 'chainId', type: 'uint256' },\n  { name: 'verifyingContract', type: 'address' },\n];\n\nconst SDK_SIGNABLE_DELEGATION_TYPED_DATA = {\n  Caveat: [\n    { name: 'enforcer', type: 'address' },\n    { name: 'terms', type: 'bytes' },\n  ],\n  Delegation: [\n    { name: 'delegate', type: 'address' },\n    { name: 'delegator', type: 'address' },\n    { name: 'authority', type: 'bytes32' },\n    { name: 'caveats', type: 'Caveat[]' },\n    { name: 'salt', type: 'uint256' },\n  ],\n} as const;\n\nexport const SIGNABLE_DELEGATION_TYPED_DATA = {\n  EIP712Domain,\n  ...SDK_SIGNABLE_DELEGATION_TYPED_DATA,\n};\n"]}

package/dist/constants.d.cts

@@ -0,0 +1,31 @@
+export declare const ROOT_AUTHORITY: `0x${string}`;
+export declare const SIGNABLE_DELEGATION_TYPED_DATA: {
+    Caveat: readonly [{
+        readonly name: "enforcer";
+        readonly type: "address";
+    }, {
+        readonly name: "terms";
+        readonly type: "bytes";
+    }];
+    Delegation: readonly [{
+        readonly name: "delegate";
+        readonly type: "address";
+    }, {
+        readonly name: "delegator";
+        readonly type: "address";
+    }, {
+        readonly name: "authority";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "caveats";
+        readonly type: "Caveat[]";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    EIP712Domain: {
+        name: string;
+        type: string;
+    }[];
+};
+//# sourceMappingURL=constants.d.cts.map

package/dist/constants.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc,eACkD,CAAC;AAuB9E,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAG1C,CAAC"}

package/dist/constants.d.mts

@@ -0,0 +1,31 @@
+export declare const ROOT_AUTHORITY: `0x${string}`;
+export declare const SIGNABLE_DELEGATION_TYPED_DATA: {
+    Caveat: readonly [{
+        readonly name: "enforcer";
+        readonly type: "address";
+    }, {
+        readonly name: "terms";
+        readonly type: "bytes";
+    }];
+    Delegation: readonly [{
+        readonly name: "delegate";
+        readonly type: "address";
+    }, {
+        readonly name: "delegator";
+        readonly type: "address";
+    }, {
+        readonly name: "authority";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "caveats";
+        readonly type: "Caveat[]";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    EIP712Domain: {
+        name: string;
+        type: string;
+    }[];
+};
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc,eACkD,CAAC;AAuB9E,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAG1C,CAAC"}

package/dist/constants.mjs

@@ -0,0 +1,25 @@
+export const ROOT_AUTHORITY = '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff';
+const EIP712Domain = [
+    { name: 'name', type: 'string' },
+    { name: 'version', type: 'string' },
+    { name: 'chainId', type: 'uint256' },
+    { name: 'verifyingContract', type: 'address' },
+];
+const SDK_SIGNABLE_DELEGATION_TYPED_DATA = {
+    Caveat: [
+        { name: 'enforcer', type: 'address' },
+        { name: 'terms', type: 'bytes' },
+    ],
+    Delegation: [
+        { name: 'delegate', type: 'address' },
+        { name: 'delegator', type: 'address' },
+        { name: 'authority', type: 'bytes32' },
+        { name: 'caveats', type: 'Caveat[]' },
+        { name: 'salt', type: 'uint256' },
+    ],
+};
+export const SIGNABLE_DELEGATION_TYPED_DATA = {
+    EIP712Domain,
+    ...SDK_SIGNABLE_DELEGATION_TYPED_DATA,
+};
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,cAAc,GACzB,oEAA2E,CAAC;AAE9E,MAAM,YAAY,GAAG;IACnB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;IACnC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;CAC/C,CAAC;AAEF,MAAM,kCAAkC,GAAG;IACzC,MAAM,EAAE;QACN,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE;KACjC;IACD,UAAU,EAAE;QACV,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE;QACrC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;KAClC;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,YAAY;IACZ,GAAG,kCAAkC;CACtC,CAAC","sourcesContent":["import type { Hex } from './types';\n\nexport const ROOT_AUTHORITY =\n  '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff' as Hex;\n\nconst EIP712Domain = [\n  { name: 'name', type: 'string' },\n  { name: 'version', type: 'string' },\n  { name: 'chainId', type: 'uint256' },\n  { name: 'verifyingContract', type: 'address' },\n];\n\nconst SDK_SIGNABLE_DELEGATION_TYPED_DATA = {\n  Caveat: [\n    { name: 'enforcer', type: 'address' },\n    { name: 'terms', type: 'bytes' },\n  ],\n  Delegation: [\n    { name: 'delegate', type: 'address' },\n    { name: 'delegator', type: 'address' },\n    { name: 'authority', type: 'bytes32' },\n    { name: 'caveats', type: 'Caveat[]' },\n    { name: 'salt', type: 'uint256' },\n  ],\n} as const;\n\nexport const SIGNABLE_DELEGATION_TYPED_DATA = {\n  EIP712Domain,\n  ...SDK_SIGNABLE_DELEGATION_TYPED_DATA,\n};\n"]}

package/dist/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultDelegationControllerState = 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

@@ -0,0 +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"]}

package/dist/index.d.cts

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

package/dist/index.d.cts.map

@@ -0,0 +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"}

package/dist/index.d.mts

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

package/dist/index.d.mts.map

@@ -0,0 +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"}

package/dist/index.mjs

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

package/dist/index.mjs.map

@@ -0,0 +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"]}

package/dist/types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +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"]}

package/dist/types.d.cts

@@ -0,0 +1,55 @@
+import type { AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
+import type { KeyringControllerSignTypedMessageAction } from "@metamask/keyring-controller";
+import type { controllerName, DelegationController } from "./DelegationController.cjs";
+type Hex = `0x${string}`;
+type Address = `0x${string}`;
+export type { Address, Hex };
+export type Caveat = {
+    enforcer: Hex;
+    terms: Hex;
+    args: Hex;
+};
+export type Delegation = {
+    delegate: Hex;
+    delegator: Hex;
+    authority: Hex;
+    caveats: Caveat[];
+    salt: Hex;
+    signature: Hex;
+};
+export type DelegationStruct = Omit<Delegation, 'salt'> & {
+    salt: bigint;
+};
+export type DelegationEntry = {
+    tags: string[];
+    chainId: number;
+    data: Delegation;
+    meta?: string;
+};
+export type DelegationFilter = {
+    chainId?: number;
+    tags?: string[];
+    from?: Address;
+};
+export type DelegationControllerState = {
+    delegations: {
+        [hash: Hex]: DelegationEntry;
+    };
+};
+export type DelegationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerStoreAction = {
+    type: `${typeof controllerName}:store`;
+    handler: DelegationController['store'];
+};
+export type DelegationControllerSignAction = {
+    type: `${typeof controllerName}:sign`;
+    handler: DelegationController['sign'];
+};
+export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerStoreAction | DelegationControllerSignAction;
+export type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerEvents = DelegationControllerStateChangeEvent;
+type AllowedActions = KeyringControllerSignTypedMessageAction | AccountsControllerGetSelectedAccountAction;
+type AllowedEvents = never;
+export type DelegationControllerMessenger = RestrictedMessenger<typeof controllerName, DelegationControllerActions | AllowedActions, DelegationControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +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"}

package/dist/types.d.mts

@@ -0,0 +1,55 @@
+import type { AccountsControllerGetSelectedAccountAction } from "@metamask/accounts-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
+import type { KeyringControllerSignTypedMessageAction } from "@metamask/keyring-controller";
+import type { controllerName, DelegationController } from "./DelegationController.mjs";
+type Hex = `0x${string}`;
+type Address = `0x${string}`;
+export type { Address, Hex };
+export type Caveat = {
+    enforcer: Hex;
+    terms: Hex;
+    args: Hex;
+};
+export type Delegation = {
+    delegate: Hex;
+    delegator: Hex;
+    authority: Hex;
+    caveats: Caveat[];
+    salt: Hex;
+    signature: Hex;
+};
+export type DelegationStruct = Omit<Delegation, 'salt'> & {
+    salt: bigint;
+};
+export type DelegationEntry = {
+    tags: string[];
+    chainId: number;
+    data: Delegation;
+    meta?: string;
+};
+export type DelegationFilter = {
+    chainId?: number;
+    tags?: string[];
+    from?: Address;
+};
+export type DelegationControllerState = {
+    delegations: {
+        [hash: Hex]: DelegationEntry;
+    };
+};
+export type DelegationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerStoreAction = {
+    type: `${typeof controllerName}:store`;
+    handler: DelegationController['store'];
+};
+export type DelegationControllerSignAction = {
+    type: `${typeof controllerName}:sign`;
+    handler: DelegationController['sign'];
+};
+export type DelegationControllerActions = DelegationControllerGetStateAction | DelegationControllerStoreAction | DelegationControllerSignAction;
+export type DelegationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, DelegationControllerState>;
+export type DelegationControllerEvents = DelegationControllerStateChangeEvent;
+type AllowedActions = KeyringControllerSignTypedMessageAction | AccountsControllerGetSelectedAccountAction;
+type AllowedEvents = never;
+export type DelegationControllerMessenger = RestrictedMessenger<typeof controllerName, DelegationControllerActions | AllowedActions, DelegationControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +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"}

package/dist/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +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"]}

package/dist/utils.cjs

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTypedMessageParams = exports.toDelegationStruct = exports.isAddressEqual = void 0;
+const utils_1 = require("@metamask/utils");
+const constants_1 = require("./constants.cjs");
+/**
+ * Checks if two addresses are equal.
+ *
+ * @param a - The first address.
+ * @param b - The second address.
+ * @returns True if the addresses are equal, false otherwise.
+ */
+function isAddressEqual(a, b) {
+    return a.toLowerCase() === b.toLowerCase();
+}
+exports.isAddressEqual = isAddressEqual;
+/**
+ * Converts a Delegation to a DelegationStruct.
+ * The DelegationStruct is the format used in the Delegation Framework.
+ *
+ * @param delegation the delegation to format
+ * @returns the formatted delegation
+ */
+const toDelegationStruct = (delegation) => {
+    const caveats = delegation.caveats.map((caveat) => ({
+        enforcer: (0, utils_1.getChecksumAddress)(caveat.enforcer),
+        terms: caveat.terms,
+        args: caveat.args,
+    }));
+    const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);
+    return {
+        delegate: (0, utils_1.getChecksumAddress)(delegation.delegate),
+        delegator: (0, utils_1.getChecksumAddress)(delegation.delegator),
+        authority: delegation.authority,
+        caveats,
+        salt,
+        signature: delegation.signature,
+    };
+};
+exports.toDelegationStruct = toDelegationStruct;
+/**
+ *
+ * @param opts - The options for creating typed message params.
+ * @returns The typed message params.
+ */
+function createTypedMessageParams(opts) {
+    const { chainId, from, delegation, verifyingContract } = opts;
+    const data = {
+        data: {
+            types: constants_1.SIGNABLE_DELEGATION_TYPED_DATA,
+            primaryType: 'Delegation',
+            domain: {
+                chainId,
+                name: 'DelegationManager',
+                version: '1',
+                verifyingContract,
+            },
+            message: (0, exports.toDelegationStruct)(delegation),
+        },
+        from,
+    };
+    return data;
+}
+exports.createTypedMessageParams = createTypedMessageParams;
+//# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

@@ -0,0 +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"]}

package/dist/utils.d.cts

@@ -0,0 +1,32 @@
+import type { TypedMessageParams } from "@metamask/keyring-controller";
+import type { Address, Delegation, DelegationStruct } from "./types.cjs";
+/**
+ * Checks if two addresses are equal.
+ *
+ * @param a - The first address.
+ * @param b - The second address.
+ * @returns True if the addresses are equal, false otherwise.
+ */
+export declare function isAddressEqual(a: Address, b: Address): boolean;
+type CreateTypedMessageParamsOptions = {
+    chainId: number;
+    from: Address;
+    delegation: Delegation;
+    verifyingContract: Address;
+};
+/**
+ * Converts a Delegation to a DelegationStruct.
+ * The DelegationStruct is the format used in the Delegation Framework.
+ *
+ * @param delegation the delegation to format
+ * @returns the formatted delegation
+ */
+export declare const toDelegationStruct: (delegation: Delegation) => DelegationStruct;
+/**
+ *
+ * @param opts - The options for creating typed message params.
+ * @returns The typed message params.
+ */
+export declare function createTypedMessageParams(opts: CreateTypedMessageParamsOptions): TypedMessageParams;
+export {};
+//# sourceMappingURL=utils.d.cts.map

package/dist/utils.d.cts.map

@@ -0,0 +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"}

package/dist/utils.d.mts

@@ -0,0 +1,32 @@
+import type { TypedMessageParams } from "@metamask/keyring-controller";
+import type { Address, Delegation, DelegationStruct } from "./types.mjs";
+/**
+ * Checks if two addresses are equal.
+ *
+ * @param a - The first address.
+ * @param b - The second address.
+ * @returns True if the addresses are equal, false otherwise.
+ */
+export declare function isAddressEqual(a: Address, b: Address): boolean;
+type CreateTypedMessageParamsOptions = {
+    chainId: number;
+    from: Address;
+    delegation: Delegation;
+    verifyingContract: Address;
+};
+/**
+ * Converts a Delegation to a DelegationStruct.
+ * The DelegationStruct is the format used in the Delegation Framework.
+ *
+ * @param delegation the delegation to format
+ * @returns the formatted delegation
+ */
+export declare const toDelegationStruct: (delegation: Delegation) => DelegationStruct;
+/**
+ *
+ * @param opts - The options for creating typed message params.
+ * @returns The typed message params.
+ */
+export declare function createTypedMessageParams(opts: CreateTypedMessageParamsOptions): TypedMessageParams;
+export {};
+//# sourceMappingURL=utils.d.mts.map

package/dist/utils.d.mts.map

@@ -0,0 +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"}

package/dist/utils.mjs

@@ -0,0 +1,59 @@
+import { getChecksumAddress } from "@metamask/utils";
+import { SIGNABLE_DELEGATION_TYPED_DATA } from "./constants.mjs";
+/**
+ * Checks if two addresses are equal.
+ *
+ * @param a - The first address.
+ * @param b - The second address.
+ * @returns True if the addresses are equal, false otherwise.
+ */
+export function isAddressEqual(a, b) {
+    return a.toLowerCase() === b.toLowerCase();
+}
+/**
+ * Converts a Delegation to a DelegationStruct.
+ * The DelegationStruct is the format used in the Delegation Framework.
+ *
+ * @param delegation the delegation to format
+ * @returns the formatted delegation
+ */
+export const toDelegationStruct = (delegation) => {
+    const caveats = delegation.caveats.map((caveat) => ({
+        enforcer: getChecksumAddress(caveat.enforcer),
+        terms: caveat.terms,
+        args: caveat.args,
+    }));
+    const salt = delegation.salt === '0x' ? 0n : BigInt(delegation.salt);
+    return {
+        delegate: getChecksumAddress(delegation.delegate),
+        delegator: getChecksumAddress(delegation.delegator),
+        authority: delegation.authority,
+        caveats,
+        salt,
+        signature: delegation.signature,
+    };
+};
+/**
+ *
+ * @param opts - The options for creating typed message params.
+ * @returns The typed message params.
+ */
+export function createTypedMessageParams(opts) {
+    const { chainId, from, delegation, verifyingContract } = opts;
+    const data = {
+        data: {
+            types: SIGNABLE_DELEGATION_TYPED_DATA,
+            primaryType: 'Delegation',
+            domain: {
+                chainId,
+                name: 'DelegationManager',
+                version: '1',
+                verifyingContract,
+            },
+            message: toDelegationStruct(delegation),
+        },
+        from,
+    };
+    return data;
+}
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +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"]}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@metamask-previews/delegation-controller",
+  "version": "0.1.0-preview-c67b57f2",
+  "description": "Manages delegations for MetaMask",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/delegation-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/delegation-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/delegation-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "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",
+    "@ts-bridge/cli": "^0.6.1",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "peerDependencies": {
+    "@metamask/accounts-controller": "^27.0.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}