Add flash mint note

[james-toussaint]

Fixes L-50.

PR Checklist

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: adae278

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 8f88c644-e4d5-4972-ad6e-9fe2e936a33b

📥 Commits

Reviewing files that changed from the base of the PR and between 9cfdccd and adae278.

📒 Files selected for processing (1)

• contracts/token/ERC20/extensions/ERC20FlashMint.sol

---

Walkthrough

The ERC20FlashMint.sol file's flashLoan documentation comment was updated to clarify the invariant underlying mint/burn correctness. The documentation now explicitly states that the minted amount is recovered and burned at the end only if _mint and _burn are symmetric, such as when no native fee is charged inside _burn. If this condition is not met, the entire operation reverts. This is a documentation-only change with no modifications to the actual code logic, control flow, or error handling behavior.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add flash mint note' directly relates to the changeset, which updates documentation comments in the ERC20FlashMint contract to clarify the invariant underlying mint/burn correctness.
Description check	✅ Passed	The description references 'Fixes L-50' and mentions documentation changes, which aligns with the PR's purpose of updating the flashLoan documentation comment in ERC20FlashMint.sol.
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.}