rewrite Flow contract NatSpec to match current architecture#464
rewrite Flow contract NatSpec to match current architecture#464thedavidmeister wants to merge 1 commit into
Conversation
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>
|
Warning Rate limit exceeded
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 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 configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
The previous
Flowcontract 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:Flowis concrete and is the only flow contract insrc/concrete/.Flowdirectly implements bothflow(...)andstackToFlow(...).Rewrote to describe the concrete
IFlowV5implementation, the clone / factory pattern, per-clone isolation, and theMulticall+msg.valuehazard that motivated removing native flows.Closes #348.
Test plan
🤖 Generated with Claude Code