@metamask-previews/gator-permissions-controller 0.7.0-preview-7cfbb337 → 0.7.0-preview-6c66772

package/dist/decodePermission/utils.mjs

@@ -11,6 +11,7 @@ const ENFORCER_CONTRACT_NAMES = {
     TimestampEnforcer: 'TimestampEnforcer',
     ValueLteEnforcer: 'ValueLteEnforcer',
     NonceEnforcer: 'NonceEnforcer',
+    AllowedCalldataEnforcer: 'AllowedCalldataEnforcer',
 };
 /**
  * Resolves and returns checksummed addresses of all known enforcer contracts
@@ -38,6 +39,7 @@ export const getChecksumEnforcersByChainId = (contracts) => {
     const valueLteEnforcer = getChecksumContractAddress(ENFORCER_CONTRACT_NAMES.ValueLteEnforcer);
     const timestampEnforcer = getChecksumContractAddress(ENFORCER_CONTRACT_NAMES.TimestampEnforcer);
     const nonceEnforcer = getChecksumContractAddress(ENFORCER_CONTRACT_NAMES.NonceEnforcer);
+    const allowedCalldataEnforcer = getChecksumContractAddress(ENFORCER_CONTRACT_NAMES.AllowedCalldataEnforcer);
     return {
         erc20StreamingEnforcer,
         erc20PeriodicEnforcer,
@@ -47,13 +49,14 @@ export const getChecksumEnforcersByChainId = (contracts) => {
         valueLteEnforcer,
         timestampEnforcer,
         nonceEnforcer,
+        allowedCalldataEnforcer,
     };
 };
 /**
  * Builds the canonical set of permission matching rules for a chain.
  *
  * Each rule specifies the `permissionType`, the set of `requiredEnforcers`
- * that must be present, and the set of `allowedEnforcers` that may appear in
+ * that must be present, and the set of `optionalEnforcers` that may appear in
  * addition to the required set.
  *
  * @param contracts - The deployed contracts for the chain.
@@ -61,46 +64,55 @@ export const getChecksumEnforcersByChainId = (contracts) => {
  * @throws Propagates any errors from resolving enforcer addresses.
  */
 export const createPermissionRulesForChainId = (contracts) => {
-    const { erc20StreamingEnforcer, erc20PeriodicEnforcer, nativeTokenStreamingEnforcer, nativeTokenPeriodicEnforcer, exactCalldataEnforcer, valueLteEnforcer, timestampEnforcer, nonceEnforcer, } = getChecksumEnforcersByChainId(contracts);
-    // the allowed enforcers are the same for all permission types
-    const allowedEnforcers = new Set([timestampEnforcer]);
+    const { erc20StreamingEnforcer, erc20PeriodicEnforcer, nativeTokenStreamingEnforcer, nativeTokenPeriodicEnforcer, exactCalldataEnforcer, valueLteEnforcer, timestampEnforcer, nonceEnforcer, allowedCalldataEnforcer, } = getChecksumEnforcersByChainId(contracts);
+    // the optional enforcers are the same for all permission types
+    const optionalEnforcers = new Set([timestampEnforcer]);
     const permissionRules = [
         {
-            requiredEnforcers: new Set([
-                nativeTokenStreamingEnforcer,
-                exactCalldataEnforcer,
-                nonceEnforcer,
+            requiredEnforcers: new Map([
+                [nativeTokenStreamingEnforcer, 1],
+                [exactCalldataEnforcer, 1],
+                [nonceEnforcer, 1],
             ]),
-            allowedEnforcers,
+            optionalEnforcers,
             permissionType: 'native-token-stream',
         },
         {
-            requiredEnforcers: new Set([
-                nativeTokenPeriodicEnforcer,
-                exactCalldataEnforcer,
-                nonceEnforcer,
+            requiredEnforcers: new Map([
+                [nativeTokenPeriodicEnforcer, 1],
+                [exactCalldataEnforcer, 1],
+                [nonceEnforcer, 1],
             ]),
-            allowedEnforcers,
+            optionalEnforcers,
             permissionType: 'native-token-periodic',
         },
         {
-            requiredEnforcers: new Set([
-                erc20StreamingEnforcer,
-                valueLteEnforcer,
-                nonceEnforcer,
+            requiredEnforcers: new Map([
+                [erc20StreamingEnforcer, 1],
+                [valueLteEnforcer, 1],
+                [nonceEnforcer, 1],
             ]),
-            allowedEnforcers,
+            optionalEnforcers,
             permissionType: 'erc20-token-stream',
         },
         {
-            requiredEnforcers: new Set([
-                erc20PeriodicEnforcer,
-                valueLteEnforcer,
-                nonceEnforcer,
+            requiredEnforcers: new Map([
+                [erc20PeriodicEnforcer, 1],
+                [valueLteEnforcer, 1],
+                [nonceEnforcer, 1],
             ]),
-            allowedEnforcers,
+            optionalEnforcers,
             permissionType: 'erc20-token-periodic',
         },
+        {
+            requiredEnforcers: new Map([
+                [allowedCalldataEnforcer, 2],
+                [valueLteEnforcer, 1],
+                [nonceEnforcer, 1],
+            ]),
+            optionalEnforcers,
+            permissionType: 'erc20-token-revocation',
+        },
     ];
     return permissionRules;
 };

package/dist/decodePermission/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/decodePermission/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAY,wBAAwB;AAa/D;;GAEG;AACH,MAAM,uBAAuB,GAAG;IAC9B,2BAA2B,EAAE,6BAA6B;IAC1D,sBAAsB,EAAE,wBAAwB;IAChD,qBAAqB,EAAE,uBAAuB;IAC9C,iCAAiC,EAAE,mCAAmC;IACtE,4BAA4B,EAAE,8BAA8B;IAC5D,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,aAAa,EAAE,eAAe;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,SAAkC,EAClC,EAAE;IACF,MAAM,0BAA0B,GAAG,CAAC,YAAoB,EAAE,EAAE;QAC1D,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAExC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,uBAAuB,YAAY,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,qCAAqC;IACrC,MAAM,sBAAsB,GAAG,0BAA0B,CACvD,uBAAuB,CAAC,sBAAsB,CAC/C,CAAC;IACF,MAAM,qBAAqB,GAAG,0BAA0B,CACtD,uBAAuB,CAAC,2BAA2B,CACpD,CAAC;IACF,MAAM,4BAA4B,GAAG,0BAA0B,CAC7D,uBAAuB,CAAC,4BAA4B,CACrD,CAAC;IACF,MAAM,2BAA2B,GAAG,0BAA0B,CAC5D,uBAAuB,CAAC,iCAAiC,CAC1D,CAAC;IAEF,oBAAoB;IACpB,MAAM,qBAAqB,GAAG,0BAA0B,CACtD,uBAAuB,CAAC,qBAAqB,CAC9C,CAAC;IACF,MAAM,gBAAgB,GAAG,0BAA0B,CACjD,uBAAuB,CAAC,gBAAgB,CACzC,CAAC;IACF,MAAM,iBAAiB,GAAG,0BAA0B,CAClD,uBAAuB,CAAC,iBAAiB,CAC1C,CAAC;IACF,MAAM,aAAa,GAAG,0BAA0B,CAC9C,uBAAuB,CAAC,aAAa,CACtC,CAAC;IAEF,OAAO;QACL,sBAAsB;QACtB,qBAAqB;QACrB,4BAA4B;QAC5B,2BAA2B;QAC3B,qBAAqB;QACrB,gBAAgB;QAChB,iBAAiB;QACjB,aAAa;KACd,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAEpB,CAAC,SAAkC,EAAE,EAAE;IAC7D,MAAM,EACJ,sBAAsB,EACtB,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,GACd,GAAG,6BAA6B,CAAC,SAAS,CAAC,CAAC;IAE7C,8DAA8D;IAC9D,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAE3D,MAAM,eAAe,GAAqB;QACxC;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAM;gBAC9B,4BAA4B;gBAC5B,qBAAqB;gBACrB,aAAa;aACd,CAAC;YACF,gBAAgB;YAChB,cAAc,EAAE,qBAAqB;SACtC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAM;gBAC9B,2BAA2B;gBAC3B,qBAAqB;gBACrB,aAAa;aACd,CAAC;YACF,gBAAgB;YAChB,cAAc,EAAE,uBAAuB;SACxC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAM;gBAC9B,sBAAsB;gBACtB,gBAAgB;gBAChB,aAAa;aACd,CAAC;YACF,gBAAgB;YAChB,cAAc,EAAE,oBAAoB;SACrC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAM;gBAC9B,qBAAqB;gBACrB,gBAAgB;gBAChB,aAAa;aACd,CAAC;YACF,gBAAgB;YAChB,cAAc,EAAE,sBAAsB;SACvC;KACF,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAI,MAAc,EAAE,QAAgB,EAAW,EAAE;IACvE,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAA0C,EAC1E,OAAO,EACP,QAAQ,EACR,eAAe,GAKhB;IACC,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CACpC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CACzC,CAAC;IAEF,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAwD,CAAC;IAClE,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAU,EAAE,OAAiB;IACpD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;QACjC,MAAM,cAAc,GAAG,UAAU,GAAG,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAAC,CAAC;QACxD,KAAK,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAW,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import type { Caveat } from '@metamask/delegation-core';\nimport { getChecksumAddress, type Hex } from '@metamask/utils';\n\nimport type { DeployedContractsByName, PermissionType } from './types';\n\n/**\n * A rule that defines the required and allowed enforcers for a permission type.\n */\nexport type PermissionRule = {\n  permissionType: PermissionType;\n  requiredEnforcers: Set<Hex>;\n  allowedEnforcers: Set<Hex>;\n};\n\n/**\n * The names of the enforcer contracts for each permission type.\n */\nconst ENFORCER_CONTRACT_NAMES = {\n  ERC20PeriodTransferEnforcer: 'ERC20PeriodTransferEnforcer',\n  ERC20StreamingEnforcer: 'ERC20StreamingEnforcer',\n  ExactCalldataEnforcer: 'ExactCalldataEnforcer',\n  NativeTokenPeriodTransferEnforcer: 'NativeTokenPeriodTransferEnforcer',\n  NativeTokenStreamingEnforcer: 'NativeTokenStreamingEnforcer',\n  TimestampEnforcer: 'TimestampEnforcer',\n  ValueLteEnforcer: 'ValueLteEnforcer',\n  NonceEnforcer: 'NonceEnforcer',\n};\n\n/**\n * Resolves and returns checksummed addresses of all known enforcer contracts\n * for a given `chainId` under the current delegation framework version.\n *\n * @param contracts - The deployed contracts for the chain.\n * @returns An object mapping enforcer names to checksummed contract addresses.\n * @throws If the chain or an expected enforcer contract is not found.\n */\nexport const getChecksumEnforcersByChainId = (\n  contracts: DeployedContractsByName,\n) => {\n  const getChecksumContractAddress = (contractName: string) => {\n    const address = contracts[contractName];\n\n    if (!address) {\n      throw new Error(`Contract not found: ${contractName}`);\n    }\n\n    return getChecksumAddress(address);\n  };\n\n  // permission type specific enforcers\n  const erc20StreamingEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ERC20StreamingEnforcer,\n  );\n  const erc20PeriodicEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ERC20PeriodTransferEnforcer,\n  );\n  const nativeTokenStreamingEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NativeTokenStreamingEnforcer,\n  );\n  const nativeTokenPeriodicEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NativeTokenPeriodTransferEnforcer,\n  );\n\n  // general enforcers\n  const exactCalldataEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ExactCalldataEnforcer,\n  );\n  const valueLteEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ValueLteEnforcer,\n  );\n  const timestampEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.TimestampEnforcer,\n  );\n  const nonceEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NonceEnforcer,\n  );\n\n  return {\n    erc20StreamingEnforcer,\n    erc20PeriodicEnforcer,\n    nativeTokenStreamingEnforcer,\n    nativeTokenPeriodicEnforcer,\n    exactCalldataEnforcer,\n    valueLteEnforcer,\n    timestampEnforcer,\n    nonceEnforcer,\n  };\n};\n\n/**\n * Builds the canonical set of permission matching rules for a chain.\n *\n * Each rule specifies the `permissionType`, the set of `requiredEnforcers`\n * that must be present, and the set of `allowedEnforcers` that may appear in\n * addition to the required set.\n *\n * @param contracts - The deployed contracts for the chain.\n * @returns A list of permission rules used to identify permission types.\n * @throws Propagates any errors from resolving enforcer addresses.\n */\nexport const createPermissionRulesForChainId: (\n  contracts: DeployedContractsByName,\n) => PermissionRule[] = (contracts: DeployedContractsByName) => {\n  const {\n    erc20StreamingEnforcer,\n    erc20PeriodicEnforcer,\n    nativeTokenStreamingEnforcer,\n    nativeTokenPeriodicEnforcer,\n    exactCalldataEnforcer,\n    valueLteEnforcer,\n    timestampEnforcer,\n    nonceEnforcer,\n  } = getChecksumEnforcersByChainId(contracts);\n\n  // the allowed enforcers are the same for all permission types\n  const allowedEnforcers = new Set<Hex>([timestampEnforcer]);\n\n  const permissionRules: PermissionRule[] = [\n    {\n      requiredEnforcers: new Set<Hex>([\n        nativeTokenStreamingEnforcer,\n        exactCalldataEnforcer,\n        nonceEnforcer,\n      ]),\n      allowedEnforcers,\n      permissionType: 'native-token-stream',\n    },\n    {\n      requiredEnforcers: new Set<Hex>([\n        nativeTokenPeriodicEnforcer,\n        exactCalldataEnforcer,\n        nonceEnforcer,\n      ]),\n      allowedEnforcers,\n      permissionType: 'native-token-periodic',\n    },\n    {\n      requiredEnforcers: new Set<Hex>([\n        erc20StreamingEnforcer,\n        valueLteEnforcer,\n        nonceEnforcer,\n      ]),\n      allowedEnforcers,\n      permissionType: 'erc20-token-stream',\n    },\n    {\n      requiredEnforcers: new Set<Hex>([\n        erc20PeriodicEnforcer,\n        valueLteEnforcer,\n        nonceEnforcer,\n      ]),\n      allowedEnforcers,\n      permissionType: 'erc20-token-periodic',\n    },\n  ];\n\n  return permissionRules;\n};\n\n/**\n * Determines whether all elements of `subset` are contained within `superset`.\n *\n * @param subset - The candidate subset to test.\n * @param superset - The set expected to contain all elements of `subset`.\n * @returns `true` if `subset` ⊆ `superset`, otherwise `false`.\n */\nexport const isSubset = <T>(subset: Set<T>, superset: Set<T>): boolean => {\n  for (const x of subset) {\n    if (!superset.has(x)) {\n      return false;\n    }\n  }\n  return true;\n};\n\n/**\n * Gets the terms for a given enforcer from a list of caveats.\n *\n * @param args - The arguments to this function.\n * @param  args.throwIfNotFound - Whether to throw an error if no matching enforcer is found. Default is true.\n * @param args.caveats - The list of caveats to search.\n * @param args.enforcer - The enforcer to search for.\n * @returns The terms for the given enforcer.\n */\nexport function getTermsByEnforcer<TThrowIfNotFound extends boolean = true>({\n  caveats,\n  enforcer,\n  throwIfNotFound,\n}: {\n  caveats: Caveat<Hex>[];\n  enforcer: Hex;\n  throwIfNotFound?: TThrowIfNotFound;\n}): TThrowIfNotFound extends true ? Hex : Hex | null {\n  const matchingCaveats = caveats.filter(\n    (caveat) => caveat.enforcer === enforcer,\n  );\n\n  if (matchingCaveats.length === 0) {\n    if (throwIfNotFound ?? true) {\n      throw new Error('Invalid caveats');\n    }\n    return null as TThrowIfNotFound extends true ? Hex : Hex | null;\n  }\n\n  if (matchingCaveats.length > 1) {\n    throw new Error('Invalid caveats');\n  }\n\n  return matchingCaveats[0].terms;\n}\n\n/**\n * Splits a 0x-prefixed hex string into parts according to the provided byte lengths.\n *\n * Each entry in `lengths` represents a part length in bytes; internally this is\n * multiplied by 2 to derive the number of hexadecimal characters to slice. The\n * returned substrings do not include the `0x` prefix and preserve leading zeros.\n *\n * Note: This function does not perform input validation (e.g., verifying the\n * payload length equals the sum of requested lengths). Callers are expected to\n * provide well-formed inputs.\n *\n * Example:\n * splitHex('0x12345678', [1, 3]) => ['0x12', '0x345678']\n *\n * @param value - The 0x-prefixed hex string to split.\n * @param lengths - The lengths of each part, in bytes.\n * @returns An array of hex substrings (each with `0x` prefix), one for each part.\n */\nexport function splitHex(value: Hex, lengths: number[]): Hex[] {\n  let start = 2;\n  const parts: Hex[] = [];\n  for (const partLength of lengths) {\n    const partCharLength = partLength * 2;\n    const part = value.slice(start, start + partCharLength);\n    start += partCharLength;\n    parts.push(`0x${part}` as const);\n  }\n  return parts;\n}\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/decodePermission/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,wBAAwB;AAcrD;;GAEG;AACH,MAAM,uBAAuB,GAAG;IAC9B,2BAA2B,EAAE,6BAA6B;IAC1D,sBAAsB,EAAE,wBAAwB;IAChD,qBAAqB,EAAE,uBAAuB;IAC9C,iCAAiC,EAAE,mCAAmC;IACtE,4BAA4B,EAAE,8BAA8B;IAC5D,iBAAiB,EAAE,mBAAmB;IACtC,gBAAgB,EAAE,kBAAkB;IACpC,aAAa,EAAE,eAAe;IAC9B,uBAAuB,EAAE,yBAAyB;CACnD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,SAAkC,EAClC,EAAE;IACF,MAAM,0BAA0B,GAAG,CAAC,YAAoB,EAAE,EAAE;QAC1D,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAExC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,uBAAuB,YAAY,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,qCAAqC;IACrC,MAAM,sBAAsB,GAAG,0BAA0B,CACvD,uBAAuB,CAAC,sBAAsB,CAC/C,CAAC;IACF,MAAM,qBAAqB,GAAG,0BAA0B,CACtD,uBAAuB,CAAC,2BAA2B,CACpD,CAAC;IACF,MAAM,4BAA4B,GAAG,0BAA0B,CAC7D,uBAAuB,CAAC,4BAA4B,CACrD,CAAC;IACF,MAAM,2BAA2B,GAAG,0BAA0B,CAC5D,uBAAuB,CAAC,iCAAiC,CAC1D,CAAC;IAEF,oBAAoB;IACpB,MAAM,qBAAqB,GAAG,0BAA0B,CACtD,uBAAuB,CAAC,qBAAqB,CAC9C,CAAC;IACF,MAAM,gBAAgB,GAAG,0BAA0B,CACjD,uBAAuB,CAAC,gBAAgB,CACzC,CAAC;IACF,MAAM,iBAAiB,GAAG,0BAA0B,CAClD,uBAAuB,CAAC,iBAAiB,CAC1C,CAAC;IACF,MAAM,aAAa,GAAG,0BAA0B,CAC9C,uBAAuB,CAAC,aAAa,CACtC,CAAC;IAEF,MAAM,uBAAuB,GAAG,0BAA0B,CACxD,uBAAuB,CAAC,uBAAuB,CAChD,CAAC;IAEF,OAAO;QACL,sBAAsB;QACtB,qBAAqB;QACrB,4BAA4B;QAC5B,2BAA2B;QAC3B,qBAAqB;QACrB,gBAAgB;QAChB,iBAAiB;QACjB,aAAa;QACb,uBAAuB;KACxB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAEpB,CAAC,SAAkC,EAAE,EAAE;IAC7D,MAAM,EACJ,sBAAsB,EACtB,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,uBAAuB,GACxB,GAAG,6BAA6B,CAAC,SAAS,CAAC,CAAC;IAE7C,+DAA+D;IAC/D,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAE5D,MAAM,eAAe,GAAqB;QACxC;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAc;gBACtC,CAAC,4BAA4B,EAAE,CAAC,CAAC;gBACjC,CAAC,qBAAqB,EAAE,CAAC,CAAC;gBAC1B,CAAC,aAAa,EAAE,CAAC,CAAC;aACnB,CAAC;YACF,iBAAiB;YACjB,cAAc,EAAE,qBAAqB;SACtC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAc;gBACtC,CAAC,2BAA2B,EAAE,CAAC,CAAC;gBAChC,CAAC,qBAAqB,EAAE,CAAC,CAAC;gBAC1B,CAAC,aAAa,EAAE,CAAC,CAAC;aACnB,CAAC;YACF,iBAAiB;YACjB,cAAc,EAAE,uBAAuB;SACxC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAc;gBACtC,CAAC,sBAAsB,EAAE,CAAC,CAAC;gBAC3B,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACrB,CAAC,aAAa,EAAE,CAAC,CAAC;aACnB,CAAC;YACF,iBAAiB;YACjB,cAAc,EAAE,oBAAoB;SACrC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAc;gBACtC,CAAC,qBAAqB,EAAE,CAAC,CAAC;gBAC1B,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACrB,CAAC,aAAa,EAAE,CAAC,CAAC;aACnB,CAAC;YACF,iBAAiB;YACjB,cAAc,EAAE,sBAAsB;SACvC;QACD;YACE,iBAAiB,EAAE,IAAI,GAAG,CAAc;gBACtC,CAAC,uBAAuB,EAAE,CAAC,CAAC;gBAC5B,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACrB,CAAC,aAAa,EAAE,CAAC,CAAC;aACnB,CAAC;YACF,iBAAiB;YACjB,cAAc,EAAE,wBAAwB;SACzC;KACF,CAAC;IAEF,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAI,MAAc,EAAE,QAAgB,EAAW,EAAE;IACvE,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAA0C,EAC1E,OAAO,EACP,QAAQ,EACR,eAAe,GAKhB;IACC,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CACpC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CACzC,CAAC;IAEF,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAwD,CAAC;IAClE,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAU,EAAE,OAAiB;IACpD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,KAAK,GAAU,EAAE,CAAC;IACxB,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;QACjC,MAAM,cAAc,GAAG,UAAU,GAAG,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,CAAC,CAAC;QACxD,KAAK,IAAI,cAAc,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAW,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import type { Caveat } from '@metamask/delegation-core';\nimport { getChecksumAddress } from '@metamask/utils';\nimport type { Hex } from '@metamask/utils';\n\nimport type { DeployedContractsByName, PermissionType } from './types';\n\n/**\n * A rule that defines the required and allowed enforcers for a permission type.\n */\nexport type PermissionRule = {\n  permissionType: PermissionType;\n  requiredEnforcers: Map<Hex, number>;\n  optionalEnforcers: Set<Hex>;\n};\n\n/**\n * The names of the enforcer contracts for each permission type.\n */\nconst ENFORCER_CONTRACT_NAMES = {\n  ERC20PeriodTransferEnforcer: 'ERC20PeriodTransferEnforcer',\n  ERC20StreamingEnforcer: 'ERC20StreamingEnforcer',\n  ExactCalldataEnforcer: 'ExactCalldataEnforcer',\n  NativeTokenPeriodTransferEnforcer: 'NativeTokenPeriodTransferEnforcer',\n  NativeTokenStreamingEnforcer: 'NativeTokenStreamingEnforcer',\n  TimestampEnforcer: 'TimestampEnforcer',\n  ValueLteEnforcer: 'ValueLteEnforcer',\n  NonceEnforcer: 'NonceEnforcer',\n  AllowedCalldataEnforcer: 'AllowedCalldataEnforcer',\n};\n\n/**\n * Resolves and returns checksummed addresses of all known enforcer contracts\n * for a given `chainId` under the current delegation framework version.\n *\n * @param contracts - The deployed contracts for the chain.\n * @returns An object mapping enforcer names to checksummed contract addresses.\n * @throws If the chain or an expected enforcer contract is not found.\n */\nexport const getChecksumEnforcersByChainId = (\n  contracts: DeployedContractsByName,\n) => {\n  const getChecksumContractAddress = (contractName: string) => {\n    const address = contracts[contractName];\n\n    if (!address) {\n      throw new Error(`Contract not found: ${contractName}`);\n    }\n\n    return getChecksumAddress(address);\n  };\n\n  // permission type specific enforcers\n  const erc20StreamingEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ERC20StreamingEnforcer,\n  );\n  const erc20PeriodicEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ERC20PeriodTransferEnforcer,\n  );\n  const nativeTokenStreamingEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NativeTokenStreamingEnforcer,\n  );\n  const nativeTokenPeriodicEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NativeTokenPeriodTransferEnforcer,\n  );\n\n  // general enforcers\n  const exactCalldataEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ExactCalldataEnforcer,\n  );\n  const valueLteEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.ValueLteEnforcer,\n  );\n  const timestampEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.TimestampEnforcer,\n  );\n  const nonceEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.NonceEnforcer,\n  );\n\n  const allowedCalldataEnforcer = getChecksumContractAddress(\n    ENFORCER_CONTRACT_NAMES.AllowedCalldataEnforcer,\n  );\n\n  return {\n    erc20StreamingEnforcer,\n    erc20PeriodicEnforcer,\n    nativeTokenStreamingEnforcer,\n    nativeTokenPeriodicEnforcer,\n    exactCalldataEnforcer,\n    valueLteEnforcer,\n    timestampEnforcer,\n    nonceEnforcer,\n    allowedCalldataEnforcer,\n  };\n};\n\n/**\n * Builds the canonical set of permission matching rules for a chain.\n *\n * Each rule specifies the `permissionType`, the set of `requiredEnforcers`\n * that must be present, and the set of `optionalEnforcers` that may appear in\n * addition to the required set.\n *\n * @param contracts - The deployed contracts for the chain.\n * @returns A list of permission rules used to identify permission types.\n * @throws Propagates any errors from resolving enforcer addresses.\n */\nexport const createPermissionRulesForChainId: (\n  contracts: DeployedContractsByName,\n) => PermissionRule[] = (contracts: DeployedContractsByName) => {\n  const {\n    erc20StreamingEnforcer,\n    erc20PeriodicEnforcer,\n    nativeTokenStreamingEnforcer,\n    nativeTokenPeriodicEnforcer,\n    exactCalldataEnforcer,\n    valueLteEnforcer,\n    timestampEnforcer,\n    nonceEnforcer,\n    allowedCalldataEnforcer,\n  } = getChecksumEnforcersByChainId(contracts);\n\n  // the optional enforcers are the same for all permission types\n  const optionalEnforcers = new Set<Hex>([timestampEnforcer]);\n\n  const permissionRules: PermissionRule[] = [\n    {\n      requiredEnforcers: new Map<Hex, number>([\n        [nativeTokenStreamingEnforcer, 1],\n        [exactCalldataEnforcer, 1],\n        [nonceEnforcer, 1],\n      ]),\n      optionalEnforcers,\n      permissionType: 'native-token-stream',\n    },\n    {\n      requiredEnforcers: new Map<Hex, number>([\n        [nativeTokenPeriodicEnforcer, 1],\n        [exactCalldataEnforcer, 1],\n        [nonceEnforcer, 1],\n      ]),\n      optionalEnforcers,\n      permissionType: 'native-token-periodic',\n    },\n    {\n      requiredEnforcers: new Map<Hex, number>([\n        [erc20StreamingEnforcer, 1],\n        [valueLteEnforcer, 1],\n        [nonceEnforcer, 1],\n      ]),\n      optionalEnforcers,\n      permissionType: 'erc20-token-stream',\n    },\n    {\n      requiredEnforcers: new Map<Hex, number>([\n        [erc20PeriodicEnforcer, 1],\n        [valueLteEnforcer, 1],\n        [nonceEnforcer, 1],\n      ]),\n      optionalEnforcers,\n      permissionType: 'erc20-token-periodic',\n    },\n    {\n      requiredEnforcers: new Map<Hex, number>([\n        [allowedCalldataEnforcer, 2],\n        [valueLteEnforcer, 1],\n        [nonceEnforcer, 1],\n      ]),\n      optionalEnforcers,\n      permissionType: 'erc20-token-revocation',\n    },\n  ];\n\n  return permissionRules;\n};\n\n/**\n * Determines whether all elements of `subset` are contained within `superset`.\n *\n * @param subset - The candidate subset to test.\n * @param superset - The set expected to contain all elements of `subset`.\n * @returns `true` if `subset` ⊆ `superset`, otherwise `false`.\n */\nexport const isSubset = <T>(subset: Set<T>, superset: Set<T>): boolean => {\n  for (const x of subset) {\n    if (!superset.has(x)) {\n      return false;\n    }\n  }\n  return true;\n};\n\n/**\n * Gets the terms for a given enforcer from a list of caveats.\n *\n * @param args - The arguments to this function.\n * @param  args.throwIfNotFound - Whether to throw an error if no matching enforcer is found. Default is true.\n * @param args.caveats - The list of caveats to search.\n * @param args.enforcer - The enforcer to search for.\n * @returns The terms for the given enforcer.\n */\nexport function getTermsByEnforcer<TThrowIfNotFound extends boolean = true>({\n  caveats,\n  enforcer,\n  throwIfNotFound,\n}: {\n  caveats: Caveat<Hex>[];\n  enforcer: Hex;\n  throwIfNotFound?: TThrowIfNotFound;\n}): TThrowIfNotFound extends true ? Hex : Hex | null {\n  const matchingCaveats = caveats.filter(\n    (caveat) => caveat.enforcer === enforcer,\n  );\n\n  if (matchingCaveats.length === 0) {\n    if (throwIfNotFound ?? true) {\n      throw new Error('Invalid caveats');\n    }\n    return null as TThrowIfNotFound extends true ? Hex : Hex | null;\n  }\n\n  if (matchingCaveats.length > 1) {\n    throw new Error('Invalid caveats');\n  }\n\n  return matchingCaveats[0].terms;\n}\n\n/**\n * Splits a 0x-prefixed hex string into parts according to the provided byte lengths.\n *\n * Each entry in `lengths` represents a part length in bytes; internally this is\n * multiplied by 2 to derive the number of hexadecimal characters to slice. The\n * returned substrings do not include the `0x` prefix and preserve leading zeros.\n *\n * Note: This function does not perform input validation (e.g., verifying the\n * payload length equals the sum of requested lengths). Callers are expected to\n * provide well-formed inputs.\n *\n * Example:\n * splitHex('0x12345678', [1, 3]) => ['0x12', '0x345678']\n *\n * @param value - The 0x-prefixed hex string to split.\n * @param lengths - The lengths of each part, in bytes.\n * @returns An array of hex substrings (each with `0x` prefix), one for each part.\n */\nexport function splitHex(value: Hex, lengths: number[]): Hex[] {\n  let start = 2;\n  const parts: Hex[] = [];\n  for (const partLength of lengths) {\n    const partCharLength = partLength * 2;\n    const part = value.slice(start, start + partCharLength);\n    start += partCharLength;\n    parts.push(`0x${part}` as const);\n  }\n  return parts;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/gator-permissions-controller",
-  "version": "0.7.0-preview-7cfbb337",
+  "version": "0.7.0-preview-6c66772",
   "description": "Controller for managing gator permissions with profile sync integration",
   "keywords": [
     "MetaMask",
@@ -48,7 +48,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/7715-permission-types": "^0.3.0",
+    "@metamask/7715-permission-types": "^0.4.0",
     "@metamask/base-controller": "^9.0.0",
     "@metamask/delegation-core": "^0.2.0",
     "@metamask/delegation-deployments": "^0.12.0",