@metamask-previews/delegation-controller 0.7.0-preview-9a5f096 → 0.7.0-preview-f3f2e8c8

package/CHANGELOG.md

@@ -7,14 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
-
-- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6531](https://github.com/MetaMask/core/pull/6531))
-
-### Changed
-
-- Bump `@metamask/base-controller` from `^8.1.0` to `^8.3.0` ([#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))
-
 ## [0.7.0]
 
 ### Changed

package/dist/DelegationController.cjs

@@ -21,10 +21,8 @@ const utils_2 = require("./utils.cjs");
 exports.controllerName = 'DelegationController';
 const delegationControllerMetadata = {
     delegations: {
-        includeInStateLogs: false,
         persist: true,
         anonymous: false,
-        usedInUi: false,
     },
 };
 /**

package/dist/DelegationController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.cjs","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAC3D,qEAAoE;AACpE,2CAA8C;AAE9C,+CAA6C;AAY7C,uCAA+D;AAElD,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,4BAA4B,GAAG;IACnC,WAAW,EAAE;QACX,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;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    includeInStateLogs: false,\n    persist: true,\n    anonymous: false,\n    usedInUi: 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"]}
+{"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.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.d.cts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,GAAG,EACH,kBAAkB,EACnB,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAyBrD;;;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"}
+{"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.map

@@ -1 +1 @@
-{"version":3,"file":"DelegationController.d.mts","sourceRoot":"","sources":["../src/DelegationController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,UAAU,EACV,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,GAAG,EACH,kBAAkB,EACnB,oBAAgB;AAGjB,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAyBrD;;;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"}
+{"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

@@ -18,10 +18,8 @@ import { createTypedMessageParams, isHexEqual } from "./utils.mjs";
 export const controllerName = 'DelegationController';
 const delegationControllerMetadata = {
     delegations: {
-        includeInStateLogs: false,
         persist: true,
         anonymous: false,
-        usedInUi: false,
     },
 };
 /**

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;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,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;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    includeInStateLogs: false,\n    persist: true,\n    anonymous: false,\n    usedInUi: 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"]}
+{"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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/delegation-controller",
-  "version": "0.7.0-preview-9a5f096",
+  "version": "0.7.0-preview-f3f2e8c8",
   "description": "Manages delegations for MetaMask",
   "keywords": [
     "MetaMask",
@@ -47,7 +47,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.3.0",
+    "@metamask/base-controller": "^8.1.0",
     "@metamask/utils": "^11.4.2"
   },
   "devDependencies": {