Don't call makePermissionDecoder in each of the permission type files, just return the config.

Author: jeffsmale90

packages/gator-permissions-controller/src/decodePermission/decoders/erc20TokenAllowance.ts

@@ -4,7 +4,6 @@ import type {
   ChecksumCaveat,
   ChecksumEnforcersByChainId,
   DecodedPermission,
-  PermissionDecoder,
 } from '../types';
 import {
   getByteLength,
@@ -15,22 +14,22 @@ import {
 } from '../utils';
 import { erc20PayeeRule } from './erc20PayeeRule';
 import { expiryRule } from './expiryRule';
-import { makePermissionDecoder } from './makePermissionDecoder';
+import type { MakePermissionDecoderConfig } from './makePermissionDecoder';
 import { redeemerRule } from './redeemerRule';
 
 /**
- * Creates the erc20-token-allowance permission decoder.
+ * Builds the configuration for the erc20-token-allowance permission decoder.
  *
  * This permission shares the same enforcer set as `erc20-token-periodic` but
  * is distinguished by a `periodDuration` of `UINT256_MAX`, which effectively
  * disables the periodic reset and turns the caveat into a one-off allowance.
  *
  * @param contractAddresses - Checksummed enforcer addresses for the chain.
- * @returns The erc20-token-allowance permission decoder.
+ * @returns The erc20-token-allowance permission decoder configuration.
  */
-export function makeErc20TokenAllowanceDecoder(
+export function makeErc20TokenAllowanceDecoderConfig(
   contractAddresses: ChecksumEnforcersByChainId,
-): PermissionDecoder {
+): MakePermissionDecoderConfig {
   const {
     timestampEnforcer,
     erc20PeriodicEnforcer,
@@ -40,7 +39,7 @@ export function makeErc20TokenAllowanceDecoder(
     redeemerEnforcer,
   } = contractAddresses;
 
-  return makePermissionDecoder({
+  return {
     permissionType: 'erc20-token-allowance',
     contractAddresses,
     optionalEnforcers: [
@@ -55,7 +54,7 @@ export function makeErc20TokenAllowanceDecoder(
     },
     rules: [expiryRule, redeemerRule, erc20PayeeRule],
     validateAndDecodeData,
-  });
+  };
 }
 
 /**

packages/gator-permissions-controller/src/decodePermission/decoders/erc20TokenPeriodic.ts

@@ -4,7 +4,6 @@ import type {
   ChecksumCaveat,
   ChecksumEnforcersByChainId,
   DecodedPermission,
-  PermissionDecoder,
 } from '../types';
 import {
   getByteLength,
@@ -15,18 +14,18 @@ import {
 } from '../utils';
 import { erc20PayeeRule } from './erc20PayeeRule';
 import { expiryRule } from './expiryRule';
-import { makePermissionDecoder } from './makePermissionDecoder';
+import type { MakePermissionDecoderConfig } from './makePermissionDecoder';
 import { redeemerRule } from './redeemerRule';
 
 /**
- * Creates the erc20-token-periodic permission decoder.
+ * Builds the configuration for the erc20-token-periodic permission decoder.
  *
  * @param contractAddresses - Checksummed enforcer addresses for the chain.
- * @returns The erc20-token-periodic permission decoder.
+ * @returns The erc20-token-periodic permission decoder configuration.
  */
-export function makeErc20TokenPeriodicDecoder(
+export function makeErc20TokenPeriodicDecoderConfig(
   contractAddresses: ChecksumEnforcersByChainId,
-): PermissionDecoder {
+): MakePermissionDecoderConfig {
   const {
     timestampEnforcer,
     erc20PeriodicEnforcer,
@@ -36,7 +35,7 @@ export function makeErc20TokenPeriodicDecoder(
     redeemerEnforcer,
   } = contractAddresses;
 
-  return makePermissionDecoder({
+  return {
     permissionType: 'erc20-token-periodic',
     contractAddresses,
     optionalEnforcers: [
@@ -51,7 +50,7 @@ export function makeErc20TokenPeriodicDecoder(
     },
     rules: [expiryRule, redeemerRule, erc20PayeeRule],
     validateAndDecodeData,
-  });
+  };
 }
 
 /**

packages/gator-permissions-controller/src/decodePermission/decoders/erc20TokenRevocation.ts

@@ -2,7 +2,6 @@ import type {
   ChecksumCaveat,
   ChecksumEnforcersByChainId,
   DecodedPermission,
-  PermissionDecoder,
 } from '../types';
 import {
   ERC20_APPROVE_SELECTOR_TERMS,
@@ -11,23 +10,23 @@ import {
   ZERO_32_BYTES,
 } from '../utils';
 import { expiryRule } from './expiryRule';
-import { makePermissionDecoder } from './makePermissionDecoder';
+import type { MakePermissionDecoderConfig } from './makePermissionDecoder';
 import { redeemerRule } from './redeemerRule';
 
 /**
- * Creates the erc20-token-revocation permission decoder.
+ * Builds the configuration for the erc20-token-revocation permission decoder.
  *
  * Revocation permissions intentionally do not support a payee rule: the
  * AllowedCalldataEnforcer is required (with count=2) to encode both the
  * `approve` selector and the zero-amount constraint, so it cannot also be
  * used to extract a payee address.
  *
  * @param contractAddresses - Checksummed enforcer addresses for the chain.
- * @returns The erc20-token-revocation permission decoder.
+ * @returns The erc20-token-revocation permission decoder configuration.
  */
-export function makeErc20TokenRevocationDecoder(
+export function makeErc20TokenRevocationDecoderConfig(
   contractAddresses: ChecksumEnforcersByChainId,
-): PermissionDecoder {
+): MakePermissionDecoderConfig {
   const {
     timestampEnforcer,
     allowedCalldataEnforcer,
@@ -36,7 +35,7 @@ export function makeErc20TokenRevocationDecoder(
     redeemerEnforcer,
   } = contractAddresses;
 
-  return makePermissionDecoder({
+  return {
     permissionType: 'erc20-token-revocation',
     contractAddresses,
     optionalEnforcers: [
@@ -50,7 +49,7 @@ export function makeErc20TokenRevocationDecoder(
     },
     rules: [expiryRule, redeemerRule],
     validateAndDecodeData,
-  });
+  };
 }
 
 /**

packages/gator-permissions-controller/src/decodePermission/decoders/erc20TokenStream.ts

@@ -4,7 +4,6 @@ import type {
   ChecksumCaveat,
   ChecksumEnforcersByChainId,
   DecodedPermission,
-  PermissionDecoder,
 } from '../types';
 import {
   getByteLength,
@@ -14,18 +13,18 @@ import {
 } from '../utils';
 import { erc20PayeeRule } from './erc20PayeeRule';
 import { expiryRule } from './expiryRule';
-import { makePermissionDecoder } from './makePermissionDecoder';
+import type { MakePermissionDecoderConfig } from './makePermissionDecoder';
 import { redeemerRule } from './redeemerRule';
 
 /**
- * Creates the erc20-token-stream permission decoder.
+ * Builds the configuration for the erc20-token-stream permission decoder.
  *
  * @param contractAddresses - Checksummed enforcer addresses for the chain.
- * @returns The erc20-token-stream permission decoder.
+ * @returns The erc20-token-stream permission decoder configuration.
  */
-export function makeErc20TokenStreamDecoder(
+export function makeErc20TokenStreamDecoderConfig(
   contractAddresses: ChecksumEnforcersByChainId,
-): PermissionDecoder {
+): MakePermissionDecoderConfig {
   const {
     timestampEnforcer,
     erc20StreamingEnforcer,
@@ -35,7 +34,7 @@ export function makeErc20TokenStreamDecoder(
     redeemerEnforcer,
   } = contractAddresses;
 
-  return makePermissionDecoder({
+  return {
     permissionType: 'erc20-token-stream',
     contractAddresses,
     optionalEnforcers: [
@@ -50,7 +49,7 @@ export function makeErc20TokenStreamDecoder(
     },
     rules: [expiryRule, redeemerRule, erc20PayeeRule],
     validateAndDecodeData,
-  });
+  };
 }
 
 /**

packages/gator-permissions-controller/src/decodePermission/decoders/index.ts

@@ -1,12 +1,13 @@
 import type { DeployedContractsByName, PermissionDecoder } from '../types';
 import { getChecksumEnforcersByChainId } from '../utils';
-import { makeErc20TokenAllowanceDecoder } from './erc20TokenAllowance';
-import { makeErc20TokenPeriodicDecoder } from './erc20TokenPeriodic';
-import { makeErc20TokenRevocationDecoder } from './erc20TokenRevocation';
-import { makeErc20TokenStreamDecoder } from './erc20TokenStream';
-import { makeNativeTokenAllowanceDecoder } from './nativeTokenAllowance';
-import { makeNativeTokenPeriodicDecoder } from './nativeTokenPeriodic';
-import { makeNativeTokenStreamDecoder } from './nativeTokenStream';
+import { makeErc20TokenAllowanceDecoderConfig } from './erc20TokenAllowance';
+import { makeErc20TokenPeriodicDecoderConfig } from './erc20TokenPeriodic';
+import { makeErc20TokenRevocationDecoderConfig } from './erc20TokenRevocation';
+import { makeErc20TokenStreamDecoderConfig } from './erc20TokenStream';
+import { makePermissionDecoder } from './makePermissionDecoder';
+import { makeNativeTokenAllowanceDecoderConfig } from './nativeTokenAllowance';
+import { makeNativeTokenPeriodicDecoderConfig } from './nativeTokenPeriodic';
+import { makeNativeTokenStreamDecoderConfig } from './nativeTokenStream';
 
 /**
  * Builds the canonical set of permission decoders for a chain.
@@ -24,12 +25,12 @@ export const createPermissionDecodersForContracts = (
 ): PermissionDecoder[] => {
   const contractAddresses = getChecksumEnforcersByChainId(contracts);
   return [
-    makeNativeTokenStreamDecoder(contractAddresses),
-    makeNativeTokenPeriodicDecoder(contractAddresses),
-    makeNativeTokenAllowanceDecoder(contractAddresses),
-    makeErc20TokenStreamDecoder(contractAddresses),
-    makeErc20TokenPeriodicDecoder(contractAddresses),
-    makeErc20TokenAllowanceDecoder(contractAddresses),
-    makeErc20TokenRevocationDecoder(contractAddresses),
-  ];
+    makeNativeTokenStreamDecoderConfig(contractAddresses),
+    makeNativeTokenPeriodicDecoderConfig(contractAddresses),
+    makeNativeTokenAllowanceDecoderConfig(contractAddresses),
+    makeErc20TokenStreamDecoderConfig(contractAddresses),
+    makeErc20TokenPeriodicDecoderConfig(contractAddresses),
+    makeErc20TokenAllowanceDecoderConfig(contractAddresses),
+    makeErc20TokenRevocationDecoderConfig(contractAddresses),
+  ].map(makePermissionDecoder);
 };

packages/gator-permissions-controller/src/decodePermission/decoders/makePermissionDecoder.ts

@@ -15,23 +15,31 @@ import type {
 } from '../types';
 import { buildEnforcerCountsAndSet, enforcersMatchRule } from '../utils';
 
+/**
+ * Configuration object describing how to decode a single permission type.
+ *
+ * Returned by each `make<PermissionType>DecoderConfig` factory and consumed by
+ * {@link makePermissionDecoder} to produce a {@link PermissionDecoder}.
+ */
+export type MakePermissionDecoderConfig = {
+  permissionType: PermissionType;
+  contractAddresses: ChecksumEnforcersByChainId;
+  optionalEnforcers: Hex[];
+  requiredEnforcers: Record<Hex, number>;
+  rules: RuleDecoder[];
+  validateAndDecodeData: (
+    caveats: ChecksumCaveat[],
+    contractAddresses: ChecksumEnforcersByChainId,
+  ) => DecodedPermission['permission']['data'];
+};
+
 /**
  * Creates a single {@link PermissionDecoder} with the given type, enforcer
  * sets, rule decoders, and decode/validate callback.
  *
- * @param args - The arguments to this function.
- * @param args.permissionType - The permission type identifier.
- * @param args.contractAddresses - Checksummed enforcer addresses for the chain.
- * @param args.optionalEnforcers - Enforcer addresses that may appear in addition
- * to the required ones.
- * @param args.requiredEnforcers - Map of required enforcer address to required
- * count.
- * @param args.rules - Rule decoder functions invoked to decode rules (e.g.
- * `redeemer`, `payee`, `expiry`) from the caveats. Each may emit a {@link Rule}
- * to append to the decoded permission's `rules` array. The `expiry` rule is
- * additionally hoisted onto the top-level `expiry` field of the result.
- * @param args.validateAndDecodeData - Callback to decode the permission's
- * `data` payload from the caveats; may throw on invalid input.
+ * @param config - The configuration describing the permission type's
+ * enforcers, rule decoders, and data decoder. See
+ * {@link MakePermissionDecoderConfig} for field documentation.
  * @returns A {@link PermissionDecoder} with `caveatAddressesMatch` and
  * `validateAndDecodePermission`.
  */
@@ -42,17 +50,7 @@ export function makePermissionDecoder({
   requiredEnforcers,
   rules,
   validateAndDecodeData,
-}: {
-  permissionType: PermissionType;
-  contractAddresses: ChecksumEnforcersByChainId;
-  optionalEnforcers: Hex[];
-  requiredEnforcers: Record<Hex, number>;
-  rules: RuleDecoder[];
-  validateAndDecodeData: (
-    caveats: ChecksumCaveat[],
-    contractAddresses: ChecksumEnforcersByChainId,
-  ) => DecodedPermission['permission']['data'];
-}): PermissionDecoder {
+}: MakePermissionDecoderConfig): PermissionDecoder {
   const optionalEnforcersSet = new Set(optionalEnforcers);
   const requiredEnforcersMap = new Map(
     Object.entries(requiredEnforcers),

packages/gator-permissions-controller/src/decodePermission/decoders/nativeTokenAllowance.ts

@@ -4,7 +4,6 @@ import type {
   ChecksumCaveat,
   ChecksumEnforcersByChainId,
   DecodedPermission,
-  PermissionDecoder,
 } from '../types';
 import {
   getByteLength,
@@ -14,23 +13,23 @@ import {
   ZERO_32_BYTES,
 } from '../utils';
 import { expiryRule } from './expiryRule';
-import { makePermissionDecoder } from './makePermissionDecoder';
+import type { MakePermissionDecoderConfig } from './makePermissionDecoder';
 import { nativePayeeRule } from './nativePayeeRule';
 import { redeemerRule } from './redeemerRule';
 
 /**
- * Creates the native-token-allowance permission decoder.
+ * Builds the configuration for the native-token-allowance permission decoder.
  *
  * This permission shares the same enforcer set as `native-token-periodic` but
  * is distinguished by a `periodDuration` of `UINT256_MAX`, which effectively
  * disables the periodic reset and turns the caveat into a one-off allowance.
  *
  * @param contractAddresses - Checksummed enforcer addresses for the chain.
- * @returns The native-token-allowance permission decoder.
+ * @returns The native-token-allowance permission decoder configuration.
  */
-export function makeNativeTokenAllowanceDecoder(
+export function makeNativeTokenAllowanceDecoderConfig(
   contractAddresses: ChecksumEnforcersByChainId,
-): PermissionDecoder {
+): MakePermissionDecoderConfig {
   const {
     timestampEnforcer,
     nativeTokenPeriodicEnforcer,
@@ -40,7 +39,7 @@ export function makeNativeTokenAllowanceDecoder(
     redeemerEnforcer,
   } = contractAddresses;
 
-  return makePermissionDecoder({
+  return {
     permissionType: 'native-token-allowance',
     contractAddresses,
     optionalEnforcers: [
@@ -55,7 +54,7 @@ export function makeNativeTokenAllowanceDecoder(
     },
     rules: [expiryRule, redeemerRule, nativePayeeRule],
     validateAndDecodeData,
-  });
+  };
 }
 
 /**