Skip to content

docs(audit): close ~44 LOW NatSpec / contract-doc findings in one sweep#229

Closed
hardyjosh wants to merge 1 commit into
test/audit-coverage-sweepfrom
docs/audit-low-natspec-sweep
Closed

docs(audit): close ~44 LOW NatSpec / contract-doc findings in one sweep#229
hardyjosh wants to merge 1 commit into
test/audit-coverage-sweepfrom
docs/audit-low-natspec-sweep

Conversation

@hardyjosh

Copy link
Copy Markdown
Collaborator

Bundles the documentation-only LOW audit findings:

  • 9 events get @notice + @param per parameter (was @dev only)
  • 5 ICloneableV2 typed-overload initialisers get full NatSpec
  • 4 setters / view functions get missing @param
  • 9 contract/function NatSpec blocks rewritten to match actual behaviour
  • 3 error definitions get better param names and docs
  • 4 LibProdDeploy constants get per-constant role docs
  • 1 setAdmin block gets a one-step-transfer lockout warning
  • 1 PassthroughProtocolAdapter PRECONDITION on registered-oracle decimals
  • 2 BeaconSetDeployer @param admin docs expand on conferred authority
  • 3 AGENTS.md / CLAUDE.md process-doc refinements
  • 3 SPEC.md drift fixes (§9 newOracleRegistry signature, §10 example call, §10 returns)

No executable code or test changes. nix CI green (test/static/legal).

Closes #30, #31, #32, #78, #79, #80, #84, #88, #92, #93, #95, #96, #97, #98, #99, #100, #101, #102, #103, #104, #105, #120, #147, #157, #160, #161, #165, #166, #167, #169, #170, #174, #178, #182, #189, #190, #191, #192, #202, #204, #211, #217, #219.

Co-Authored-By: Claude Opus 4.7 noreply@anthropic.com

@coderabbitai

coderabbitai Bot commented May 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 67f89aca-83e5-4b32-9955-dbfc7d9a823c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/audit-low-natspec-sweep

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.

hardyjosh commented May 11, 2026

Copy link
Copy Markdown
Collaborator Author

@hardyjosh hardyjosh force-pushed the test/audit-coverage-sweep branch from bf9e11e to c6e2975 Compare May 11, 2026 21:52
@hardyjosh hardyjosh force-pushed the docs/audit-low-natspec-sweep branch from b023f80 to 6d10a1d Compare May 11, 2026 22:09
Bundles the documentation-only LOW audit findings:
- 9 events get @notice + @param per parameter (was @dev only)
- 5 ICloneableV2 typed-overload initialisers get full NatSpec
- 4 setters / view functions get missing @param
- 9 contract/function NatSpec blocks rewritten to match actual behaviour
- 3 error definitions get better param names and docs
- 4 LibProdDeploy constants get per-constant role docs
- 1 setAdmin block gets a one-step-transfer lockout warning
- 1 PassthroughProtocolAdapter PRECONDITION on registered-oracle decimals
- 2 BeaconSetDeployer @param admin docs expand on conferred authority
- 3 AGENTS.md / CLAUDE.md process-doc refinements
- 3 SPEC.md drift fixes (§9 newOracleRegistry signature, §10 example call, §10 returns)

No executable code or test changes. nix CI green (test/static/legal).

Closes #30, #31, #32, #78, #79, #80, #84, #88, #92, #93, #95, #96, #97, #98, #99, #100, #101, #102, #103, #104, #105, #120, #147, #157, #160, #161, #165, #166, #167, #169, #170, #174, #178, #182, #189, #190, #191, #192, #202, #204, #211, #217, #219.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@hardyjosh hardyjosh force-pushed the test/audit-coverage-sweep branch from 173b4a3 to 7a76b2b Compare May 11, 2026 22:27
@hardyjosh hardyjosh force-pushed the docs/audit-low-natspec-sweep branch from 6d10a1d to 536621f Compare May 11, 2026 22:27
@hardyjosh

Copy link
Copy Markdown
Collaborator Author

Deferred for Euler launch. Pure-docs sweep across 44 LOW NatSpec issues; addresses no functional concern.

@hardyjosh hardyjosh closed this May 26, 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.

1 participant