Skip to content

rewrite Flow contract NatSpec to match current architecture#464

Open
thedavidmeister wants to merge 1 commit into
mainfrom
2026-05-07-issue-348-flow-contract-natspec
Open

rewrite Flow contract NatSpec to match current architecture#464
thedavidmeister wants to merge 1 commit into
mainfrom
2026-05-07-issue-348-flow-contract-natspec

Conversation

@thedavidmeister

Copy link
Copy Markdown
Contributor

Summary

The previous Flow contract NatSpec described it as an abstract base inherited by ERC20/721/1155 mint-burn variants — the architecture before V5 consolidated to a single non-mint flow contract. The text contradicted the implementation:

  • "Common functionality for flows" — Flow is concrete and is the only flow contract in src/concrete/.
  • "This does NOT implement the preview and flow logic directly" — Flow directly implements both flow(...) and stackToFlow(...).

Rewrote to describe the concrete IFlowV5 implementation, the clone / factory pattern, per-clone isolation, and the Multicall + msg.value hazard that motivated removing native flows.

Closes #348.

Test plan

  • build clean (NatSpec-only)

🤖 Generated with Claude Code

The previous NatSpec described `Flow` as an abstract base inherited by
ERC20/721/1155 mint-burn variants — a previous architecture before V5
consolidated to a single non-mint flow contract. The text contradicted
the implementation:

- "Common functionality for flows" — `Flow` is concrete and is the only
  flow contract in src/concrete/.
- "This does NOT implement the preview and flow logic directly" —
  `Flow` directly implements both `flow(...)` and `stackToFlow(...)`.

Rewrote to describe the concrete `IFlowV5` implementation, the clone /
factory pattern, per-clone isolation, and the Multicall + msg.value
hazard that motivated removing native flows.

Closes #348.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented May 7, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@thedavidmeister has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 21 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: aec00806-3db0-44e6-98cf-6ebfd88eafd2

📥 Commits

Reviewing files that changed from the base of the PR and between ceaea3c and 6e93fdc.

📒 Files selected for processing (1)
  • src/concrete/Flow.sol
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-05-07-issue-348-flow-contract-natspec

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

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

@thedavidmeister thedavidmeister self-assigned this May 9, 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.

[A01-4] [INFO] Flow contract NatSpec contradicts implementation

1 participant