fix: sync ERC20FlashMint with implementation

[zeroprooff]

Update the inline note for maxFlashLoan so it mentions the actual limit (type(uint256).max - totalSupply()) used by the implementation.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 01b3f6c

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]

Walkthrough

The pull request updates the inline documentation for the maxFlashLoan function in the ERC20FlashMint contract. The documentation now describes how to integrate a supply cap by using type(uint256).max - totalSupply() instead of type(uint256).max for the calculation. This clarifies the expected behavior when a cap extension is in use. The change is purely documentation-focused with no modifications to the actual function implementation, logic, or control flow. No public function signatures were added, removed, or modified.

Suggested labels

ignore-changeset

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'fix: sync ERC20FlashMint with implementation' accurately reflects the main change: updating documentation to match the actual implementation behavior.
Description check	✅ Passed	The description is directly related to the changeset, clearly explaining that the inline note for maxFlashLoan is being updated to mention the actual limit used by the implementation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb97fd3 and 01b3f6c.

📒 Files selected for processing (1)

• contracts/token/ERC20/extensions/ERC20FlashMint.sol (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: slither
• GitHub Check: tests-foundry
• GitHub Check: coverage
• GitHub Check: tests-upgradeable
• GitHub Check: halmos
• GitHub Check: tests
• GitHub Check: Redirect rules - solidity-contracts
• GitHub Check: Header rules - solidity-contracts
• GitHub Check: Pages changed - solidity-contracts

🔇 Additional comments (1)

contracts/token/ERC20/extensions/ERC20FlashMint.sol (1)

44-46: Documentation now correctly reflects the implementation.

The updated note now accurately describes the default calculation used in the maxFlashLoan implementation (line 49), making it clear to developers what the baseline is when overriding the function for supply-cap extensions. This improves clarity for integrations with ERC20Capped or similar constraints.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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