Add `makePermissionDecoderConfigs` to resolve the `PermissionDecoderConfig`s to be used with @metamask/gator-permissions-controller by jeffsmale90 · Pull Request #259 · MetaMask/smart-accounts-kit

jeffsmale90 · 2026-06-03T02:07:58Z

📝 Description

This PR relocates the PermissionDecoderConfigs from @metamask/gator-permissions-controller into @metamask/7715-permission-types.

🔄 What Changed?

Adds the following to @metamask/7715-permission-types:

makePermissionDecoderConfigs function to resolve the PermissionDecodeConfigs
ExpiryRule, PayeeRule, and RedeemerRule types
Permission decoders now use caveat terms decoders from @metamask/delegation-core instead of implementing this logic themselves

Note: erc20-token-allowance and native-token-allowance still have bespoke implementations as they use periodic caveats with UINT256_MAX as the period duration, which is decoded as a number. These will be replaced with basic allowance caveats, at which point these bespoke decodes can be discarded.

🚀 Why?

Presently in order to add a new permission type, changes must be made to @metamask/smart-accounts-kit, @metamask/7715-permission-types, @metamask/gator-permissions-snap, @metamask/gator-permissions-controller.

By moving all of the logic to define the permission types into @metamask/7715-permission-types, and importing these into the various packages that need these definitions, the bulk of the changes will be made in this one place.

🧪 How to Test?

Describe how to test these changes:

⚠️ Breaking Changes

List any breaking changes:

No breaking changes
Breaking changes (describe below):

📋 Checklist

Check off completed items:

🔗 Related Issues

Link to related issues:
Closes #
Related to #

📚 Additional Notes

Any additional information, concerns, or context:

Note

Medium Risk
Relocates delegation caveat decoding and validation used to interpret execution permissions; incorrect decoding could misread limits, payees, or redeemers, though behavior is heavily tested and mostly delegated to delegation-core.

Overview
Moves permission decoder configuration from @metamask/gator-permissions-controller into @metamask/7715-permission-types, so consumers can build chain-specific decoders from one shared package.

makePermissionDecoderConfigs takes deployed delegation contracts, resolves checksummed enforcer addresses, and returns seven PermissionDecoderConfig entries (native/ERC-20 stream, periodic, allowance, plus token-approval-revocation). The package now exports ExpiryRule, PayeeRule, and RedeemerRule alongside that factory.

Each config wires required/optional enforcers, rule decoders (expiry, redeemer, ERC-20 or native payee), and validateAndDecodeData that turns on-chain caveats into typed permission payloads. Most types use @metamask/delegation-core term decoders; erc20/native-token-allowance still use custom parsing for periodic enforcer terms with UINT256_MAX period duration.

Adds runtime dependencies on delegation-core, delegation-deployments, and utils, Vitest coverage for decoders and rules, and test-focused ESLint/tsconfig updates.

^{Reviewed by Cursor Bugbot for commit 1930bd9. Bugbot is set up for automated code reviews on this repo. Configure here.}

socket-security · 2026-06-03T02:08:57Z

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

…figuration objects

…ing returned data is appropriately typed.

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 1930bd9. Configure here.}

mj-kiwi

LGTM, tiny nits to fix.

mj-kiwi · 2026-06-11T03:34:37Z

+    periodDuration?: number;
+    startDate?: number;
+  } = {}): Hex =>
+    createERC20TokenPeriodTransferTerms(


makeTerms currently uses createERC20TokenPeriodTransferTerms, which validates inputs before producing the encoded terms. That means the zero periodAmount / zero periodDuration tests are exercising delegation-core validation rather than this decoder's validation branches.

Can we construct the raw hex terms manually here, like nativeTokenPeriodic.test.ts does, so the test actually reaches the decoder checks in this package?

Good call - I've updated this.

mj-kiwi · 2026-06-11T03:36:31Z

+
+  if (matchingCaveats.length === 0) {
+    if (throwIfNotFound ?? true) {
+      throw new Error('Invalid caveats');


The missing/duplicate caveat error from getTermsByEnforcer is currently just Invalid caveats, which makes debugging pretty hard. Could we include the enforcer address and distinguish missing vs duplicate matches?

Something like:
Invalid caveats: missing terms for enforcer ${enforcer}
Invalid caveats: multiple caveats found for enforcer ${enforcer}

I've refactored this function to improve readability, and updated the error messages as you suggested.

mj-kiwi · 2026-06-11T03:39:35Z

+import type { ChecksumCaveat } from '../../../src/permissions/types';
+import { getChecksumEnforcersByChainId } from '../../../src/permissions/utils';
+
+describe('expiryRule', () => {


The expiry rule has several explicit error paths that are not covered by tests yet:

invalid terms length

timestampBeforeThreshold <= 0

timestampAfterThreshold !== 0

Can we add tests for those branches so the validation behavior is locked down?

Added tests to cover these cases

mj-kiwi · 2026-06-11T03:42:38Z

+  }
+
+  const [caveat] = matchingCaveats;
+  if (!caveat) {


This if (!caveat) branch appears unreachable: the code already returned when there were zero matches and already throws when there is more than one match. Also, the error message here says “multiple” even though this branch would imply no caveat.

Can we remove this dead branch?

It's actually reimplementing the functionality in getTermsByEnforcer, so I've updated it to use that utility.

…tamask/delegation-core encoders

Update payeeRuleDecoder to use getTermsByEnforcer utility

mj-kiwi

Some nits may need to be addressed before merging.

mj-kiwi · 2026-06-17T05:29:38Z

+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "@metamask/delegation-core": "^2.2.1",


Move @metamask/delegation-deployments to devDependencies. I think it’s only used for tests.

👍

I think we could potentially remove the dependency entirely - we don't strictly need the dependency, as we could make up environment values, but it's easier to import 🤷

mj-kiwi · 2026-06-17T05:33:02Z

makePermissionDecoderConfigs returns PermissionDecoderConfig[] and accepts DeployedContractsByName, but neither type is exported from src/index.ts. Consumers who want to annotate a variable or write a helper that accepts/returns these types have no way to reference them. Please export both.

Good call! These are the types that I mentioned this morning :)

Updated!

mj-kiwi · 2026-06-17T05:34:42Z

+    throw new Error('Invalid native-token-allowance terms: expected 96 bytes');
+  }
+
+  const [allowanceAmount, periodDurationRaw, startTimeRaw] = splitHex(


splitHex always prepends 0x to every segment, so every returned value is truthy — the if (!tokenAddress || !allowanceAmount || ...) guard can never fire. The byte-length check above it is the real defence. Please remove this dead guard

splitHex returns Hex[] of indeterminate length, meaning each of the destructured values is Hex | undefined.

i've updated splitHex to return a Hex[] of the same length as the specified lengths array, meaning we can remove the guard as you suggest 👍

mj-kiwi · 2026-06-17T05:34:54Z

+
+  const [tokenAddress, allowanceAmount, periodDurationRaw, startTimeRaw] =
+    splitHex(terms, [20, 32, 32, 32]);
+  if (


splitHex always prepends 0x to every segment, so every returned value is truthy — the if (!tokenAddress || !allowanceAmount || ...) guard can never fire. The byte-length check above it is the real defence. Please remove this dead guard

as above - fixed with an update to splitHex 👍

mj-kiwi

LGTM

jeffsmale90 force-pushed the feat/permission-decoders branch 8 times, most recently from 92f2173 to cbda271 Compare June 9, 2026 02:31

jeffsmale90 added 5 commits June 9, 2026 14:34

First pass at permission decoders

c2c1b68

Shuffle permission decoding logic

251a766

Switch to use terms decoders from @metamask/delegation-core

2c4a780

Remove makePermissionDecoder and update tests to correctly verify con…

1285930

…figuration objects

Remove more cruft

e37bee7

jeffsmale90 force-pushed the feat/permission-decoders branch from cbda271 to e37bee7 Compare June 9, 2026 02:37

Add changelog

64b1713

jeffsmale90 changed the title ~~First pass at permission decoders~~ Add makePermissionDecoderConfigs to resolve the PermissionDecoderConfigs to be used with @metamask/gator-permissions-controller Jun 9, 2026

jeffsmale90 marked this pull request as ready for review June 9, 2026 03:17

jeffsmale90 requested a review from a team as a code owner June 9, 2026 03:17

cursor Bot reviewed Jun 9, 2026

View reviewed changes

Comment thread packages/7715-permission-types/src/permissions/caveats/erc20TokenAllowance.ts Outdated

All permission decoders are now permission-type specific typed, ensur…

09f520e

…ing returned data is appropriately typed.

cursor Bot reviewed Jun 9, 2026

View reviewed changes

Comment thread packages/7715-permission-types/src/permissions/caveats/erc20TokenAllowance.ts Outdated

Use hexToNumber to parse startTime in erc20TokenAllowance decoder

1930bd9

jeffsmale90 force-pushed the feat/permission-decoders branch from 7b75406 to 1930bd9 Compare June 9, 2026 23:17

cursor Bot reviewed Jun 9, 2026

View reviewed changes

Comment thread packages/7715-permission-types/src/permissions/caveats/erc20TokenStream.ts

mj-kiwi previously approved these changes Jun 11, 2026

View reviewed changes

jeffsmale90 added 3 commits June 15, 2026 08:58

Construct valid terms directly in tests, rather than depending on @me…

0e9745c

…tamask/delegation-core encoders

Rename expiryRule to expiryRuleDecoder

60e34c6

Update payeeRuleDecoder to use getTermsByEnforcer utility

Refactor getTermsByEnforcer for readability

862842f

jeffsmale90 dismissed mj-kiwi’s stale review via 862842f June 14, 2026 22:13

jeffsmale90 added 2 commits June 15, 2026 10:25

Tidy up redeemerDecoder

7243adc

Normalize tests a little bit

20aabd3

jeffsmale90 requested a review from mj-kiwi June 14, 2026 22:31

mj-kiwi reviewed Jun 17, 2026

View reviewed changes

jeffsmale90 added 3 commits June 18, 2026 12:22

Move @metamask/delegation-deployments to devDependencies

5227579

splitHex now returns a correctly sized Hex[] array

2c7dbd9

Export DeployedContractsByName and PermissionDecoderConfig types

ec575ac

jeffsmale90 requested a review from mj-kiwi June 18, 2026 03:18

mj-kiwi approved these changes Jun 18, 2026

View reviewed changes

jeffsmale90 merged commit f059043 into main Jun 18, 2026
17 checks passed

jeffsmale90 deleted the feat/permission-decoders branch June 18, 2026 20:46

jeffsmale90 mentioned this pull request Jul 14, 2026

refactor: Use permission decoders from @metamask/7715-permission-types MetaMask/core#9164

Open

4 tasks

Uh oh!

Uh oh!

Conversation

jeffsmale90 commented Jun 3, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

🔄 What Changed?

🚀 Why?

🧪 How to Test?

⚠️ Breaking Changes

📋 Checklist

🔗 Related Issues

📚 Additional Notes

Uh oh!

socket-security Bot commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mj-kiwi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffsmale90 Jun 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffsmale90 Jun 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mj-kiwi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mj-kiwi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jeffsmale90 commented Jun 3, 2026 •

edited by cursor Bot

Loading

socket-security Bot commented Jun 3, 2026 •

edited

Loading

jeffsmale90 Jun 14, 2026 •

edited

Loading

jeffsmale90 Jun 14, 2026 •

edited

Loading