feat: add redeemer rule support across permissions by mj-kiwi · Pull Request #297 · MetaMask/snap-7715-permissions

mj-kiwi · 2026-04-21T08:16:24Z

Description

Add a redeemer rule

{
  "type": "redeemer",
  "data: {
    "addresses": Address[]
  }
}

Get Supported Permissions

{
  "native-token-stream": {
    "chainIds": [
      1,
      4114,
      4217,
      80002,
      80069,
      80094,
      5115,
      84532,
      338,
      6342,
      25,
      8453,
      10143,
      10200,
      56,
      14601,
      1301,
      1328,
      1329,
      97,
      100,
      421614,
      130,
      560048,
      137,
      143,
      146,
      10,
      42161,
      42170,
      42220,
      42431,
      11142220,
      11155111,
      11155420,
      59144
    ],
    "ruleTypes": [
      "expiry",
      "redeemer"
    ]
  },
  "native-token-periodic": {
    "chainIds": [
      1,
      4114,
      4217,
      80002,
      80069,
      80094,
      5115,
      84532,
      338,
      6342,
      25,
      8453,
      10143,
      10200,
      56,
      14601,
      1301,
      1328,
      1329,
      97,
      100,
      421614,
      130,
      560048,
      137,
      143,
      146,
      10,
      42161,
      42170,
      42220,
      42431,
      11142220,
      11155111,
      11155420,
      59144
    ],
    "ruleTypes": [
      "expiry",
      "redeemer"
    ]
  },
  "erc20-token-stream": {
    "chainIds": [
      1,
      4114,
      4217,
      80002,
      80069,
      80094,
      5115,
      84532,
      338,
      6342,
      25,
      8453,
      10143,
      10200,
      56,
      14601,
      1301,
      1328,
      1329,
      97,
      100,
      421614,
      130,
      560048,
      137,
      143,
      146,
      10,
      42161,
      42170,
      42220,
      42431,
      11142220,
      11155111,
      11155420,
      59144
    ],
    "ruleTypes": [
      "expiry",
      "redeemer"
    ]
  },
  "erc20-token-periodic": {
    "chainIds": [
      1,
      4114,
      4217,
      80002,
      80069,
      80094,
      5115,
      84532,
      338,
      6342,
      25,
      8453,
      10143,
      10200,
      56,
      14601,
      1301,
      1328,
      1329,
      97,
      100,
      421614,
      130,
      560048,
      137,
      143,
      146,
      10,
      42161,
      42170,
      42220,
      42431,
      11142220,
      11155111,
      11155420,
      59144
    ],
    "ruleTypes": [
      "expiry",
      "redeemer"
    ]
  },
  "erc20-token-revocation": {
    "chainIds": [
      1,
      4114,
      4217,
      80002,
      80069,
      80094,
      5115,
      84532,
      338,
      6342,
      25,
      8453,
      10143,
      10200,
      56,
      14601,
      1301,
      1328,
      1329,
      97,
      100,
      421614,
      130,
      560048,
      137,
      143,
      146,
      10,
      42161,
      42170,
      42220,
      42431,
      11142220,
      11155111,
      11155420,
      59144
    ],
    "ruleTypes": [
      "expiry",
      "redeemer"
    ]
  }
}

Related issues

Fixes:

Manual testing steps

Go to this page...

Screenshots/Recordings

Before

After

redeemer.snap.mp4

Pre-merge author checklist

I've followed MetaMask 7715 Permissions Snaps Contributor Docs and MetaMask 7715 Permissions Snaps Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Note

Medium Risk
Touches permission validation and delegation caveat generation (including a new enforcer address) and upgrades @metamask/delegation-core, so incorrect rule handling could change who can redeem granted permissions.

Overview
Adds a new redeemer rule (list of allowed redeemer addresses) across supported permission types, including schema validation, RPC-supported rule type reporting, and end-to-end tests.

In gator-permissions-snap, the grant flow now preserves the dapp-provided redeemer constraint (applyRedeemerRule), surfaces redeemer addresses as read-only in confirmation UI (RedeemerField + new i18n strings), and converts the rule into an on-chain RedeemerEnforcer caveat (new redeemerEnforcer contract address + appendRedeemerCaveatIfPresent). Expiry caveat construction is refactored into appendExpiryCaveatIfPresent and updated for the newer createTimestampTerms parameter names.

In the demo site, permission request forms gain an optional redeemer-addresses input (parsed/deduped to checksum addresses) and requests send redeemer to requestExecutionPermissions; clipboard JSON output is updated to safely stringify bigint values. Dependency bumps include @metamask/delegation-core and @metamask/smart-accounts-kit (lockfile updated accordingly).

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

- Introduced a new redeemer rule for ERC20 token revocation, token streams, and native token periodic permissions. - Updated types to include validation for redeemer errors. - Enhanced caveat creation functions to append redeemer caveats if present. - Modified context and rules to handle redeemer addresses and ensure they are included in permission requests. - Updated tests to cover new redeemer rule functionality and validation.

… deprecated formatExecutionPermissionRequestForWallet utility

socket-security · 2026-04-23T23:29:02Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@metamask/smart-accounts-kit@0.4.0-beta.0 ⏵ 1.3.0	⁺³		⁺⁶	⁺⁴
	@metamask/delegation-core@0.3.0 ⏵ 1.1.0	⁺¹		⁺¹	⁺⁵

View full report

socket-security · 2026-04-23T23:29:04Z

Caution

MetaMask internal reviewing guidelines:

Do not ignore-all
Each alert has instructions on how to review if you don't know what it means. If lost, ask your Security Liaison or the supply-chain group
Copy-paste ignore lines for specific packages or a group of one kind with a note on what research you did to deem it safe.
@SocketSecurity ignore npm/PACKAGE@VERSION

Action	Severity	Alert (click "▶" to expand/collapse)
Block		Network access: npm `openapi-fetch` in module globalThis["fetch"] Module: globalThis["fetch"] Location: Package overview From: `?` → `npm/@metamask/smart-accounts-kit@1.3.0` → `npm/openapi-fetch@0.13.8` ℹ Read more on: This package \| This alert \| What is network access? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `support@socket.dev`. Suggestion: Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/openapi-fetch@0.13.8`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

Co-authored-by: Copilot <copilot@github.com>

…gint handling

Co-authored-by: Copilot <copilot@github.com>

jeffsmale90

I reviewed the first half - will get back to the other half shortly!

…caveat files

jeffsmale90

Looking super good!

…redeemer terms encoding

…m metadata types

…uest orchestrator

…component

…e orchestrator

…ss permissions

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 ec69bde. Configure here.}

… and update test cases to use null

jeffsmale90

Looking great!

mj-kiwi · 2026-04-30T06:26:07Z

@SocketSecurity ignore npm/openapi-fetch@0.13.8

mj-kiwi added 4 commits April 21, 2026 20:15

feat: implement redeemer addresses functionality across permission forms

bc82646

feat: add RedeemerField component and update permissions to utilize it

4fc3e31

feat: update @metamask/smart-accounts-kit to version 1.3.0 and remove…

c46a5bd

… deprecated formatExecutionPermissionRequestForWallet utility

mj-kiwi and others added 3 commits April 24, 2026 11:51

feat: remove debug log from RedeemerField component

eb1511d

feat: update redeemer address handling to set null if empty

02254f7

Co-authored-by: Copilot <copilot@github.com>

feat: refactor JSON.stringify calls to use stringifyWithBigInt for bi…

e0513df

…gint handling

mj-kiwi marked this pull request as ready for review April 27, 2026 08:49

mj-kiwi requested a review from a team as a code owner April 27, 2026 08:49

cursor Bot reviewed Apr 27, 2026

View reviewed changes

Comment thread packages/gator-permissions-snap/src/core/chainMetadata.ts Outdated

Comment thread packages/gator-permissions-snap/src/permissions/rules.ts Outdated

mj-kiwi and others added 2 commits April 28, 2026 09:56

feat: normalize redeemerEnforcer address casing in chainMetadata

9a74343

feat: add redeemer rule support for periodic and stream permissions

98d73ee

Co-authored-by: Copilot <copilot@github.com>

jeffsmale90 reviewed Apr 28, 2026

View reviewed changes

feat: remove rules parameter from createPermissionCaveats in various …

f15af50

…caveat files

cursor Bot reviewed Apr 28, 2026

View reviewed changes

Comment thread packages/gator-permissions-snap/src/ui/components/RedeemerField.tsx

jeffsmale90 reviewed Apr 28, 2026

View reviewed changes

mj-kiwi added 2 commits April 29, 2026 14:14

feat: update @metamask/delegation-core to version 1.1.0 and refactor …

5d1d664

…redeemer terms encoding

feat: implement redeemer rule validation and remove redeemerError fro…

ddeb612

…m metadata types

cursor Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread packages/gator-permissions-snap/src/core/rules.tsx Outdated

mj-kiwi added 4 commits April 29, 2026 16:49

feat: rename timestamp terms parameters for clarity in permission req…

3326b31

…uest orchestrator

feat: optimize redeemer address handling in PermissionHandlerContent …

0677470

…component

feat: implement expiry caveat handling in permission request lifecycl…

7395444

…e orchestrator

feat: remove redeemer rule implementation and related references acro…

ec69bde

…ss permissions

cursor Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread packages/gator-permissions-snap/src/core/permissionHandlerContent.tsx Outdated

feat: simplify redeemer address rendering in PermissionHandlerContent…

9886549

… and update test cases to use null

jeffsmale90 approved these changes Apr 30, 2026

View reviewed changes

mj-kiwi merged commit 56644fd into main Apr 30, 2026
15 of 16 checks passed

mj-kiwi deleted the feat/redeemer-rule branch April 30, 2026 06:26

Uh oh!

Conversation

mj-kiwi commented Apr 21, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Get Supported Permissions

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeffsmale90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeffsmale90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jeffsmale90 left a comment

Choose a reason for hiding this comment

Uh oh!

mj-kiwi commented Apr 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mj-kiwi commented Apr 21, 2026 •

edited by cursor Bot

Loading

socket-security Bot commented Apr 23, 2026 •

edited

Loading

socket-security Bot commented Apr 23, 2026 •

edited

Loading