Skip to content

Add 4626 unsupported fee note#6428

Open
james-toussaint wants to merge 3 commits intoOpenZeppelin:masterfrom
james-toussaint:chore/4626-unsupported-fee-note
Open

Add 4626 unsupported fee note#6428
james-toussaint wants to merge 3 commits intoOpenZeppelin:masterfrom
james-toussaint:chore/4626-unsupported-fee-note

Conversation

@james-toussaint
Copy link
Copy Markdown
Contributor

Fixes M-10.

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 23, 2026

⚠️ No Changeset found

Latest commit: 3690447

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@james-toussaint james-toussaint marked this pull request as ready for review March 23, 2026 11:01
@james-toussaint james-toussaint requested a review from a team as a code owner March 23, 2026 11:01
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 23, 2026

Walkthrough

This pull request updates the documentation in the ERC4626 vault implementation to clarify assumptions about asset transfers. The changes document that deposit, mint, redeem, and burn operations assume the full requested underlying amount is received during transfer. Additionally, the documentation specifies that fee-on-transfer tokens and other non-standard tokens that deliver less than the transferred amount are not supported by this implementation. No function signatures or code logic were modified.

Suggested labels

meta

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation about ERC-4626's lack of support for fee-on-transfer tokens.
Description check ✅ Passed The description references the fix to M-10 and is related to the documentation change, though brief and high-level.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@contracts/token/ERC20/extensions/ERC4626.sol`:
- Around line 21-23: Update the comment in the ERC4626 contract that currently
states the transfer assumption applies to "{deposit}, {mint}, {redeem} and
{burn}": include "{withdraw}" in the list of user-facing workflows and remove or
clarify "burn" as an internal share operation (e.g., say "burn (internal)") so
the wording aligns with the public ERC-4626 API; ensure references use the exact
function names deposit, mint, redeem, withdraw and mention burn only as an
internal mechanic.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 85310720-d072-466a-967a-b87b78a68524

📥 Commits

Reviewing files that changed from the base of the PR and between 45f032d and 92e6f66.

📒 Files selected for processing (1)
  • contracts/token/ERC20/extensions/ERC4626.sol

Comment thread contracts/token/ERC20/extensions/ERC4626.sol Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant