Skip to content

Conversation

@jeffsmale90
Copy link
Contributor

@jeffsmale90 jeffsmale90 commented Feb 2, 2026

Description

It's critically important that the caveats are encoded correctly. This PR adds an explainer comment to the caveats file outlining the terms encoding, and how they relate to the abi encoding of the allowed function.

Pre-merge author checklist

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

Low Risk
Documentation-only updates in caveat builders; no changes to term construction or enforcement logic, so runtime behavior should be unchanged.

Overview
Adds/expands in-file JSDoc explainers across ERC-20 and native-token permission caveat builders (periodic, streaming, and ERC-20 allowance revocation) to clarify what each enforcer restricts.

For erc20TokenRevocation, documents the ABI calldata layout for approve(address,uint256) and how AllowedCalldataEnforcer uses startIndex to pin the selector and zero amount, plus comments clarifying ValueLteEnforcer usage.

Written by Cursor Bugbot for commit 3b77826. This will update automatically on new commits. Configure here.

…ctly how the terms are encoded and what they enforce
@jeffsmale90 jeffsmale90 requested a review from a team as a code owner February 2, 2026 22:48
…g exactly how the terms are encoded and what they enforce
@jeffsmale90 jeffsmale90 changed the title chore: Add explainer comment to erc20-token-revocation caveats chore: Add explainer comment to each permission type caveats.ts Feb 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants