Skip to content

contracts: add documentation for audit findings #3, #7, #12, #15, #16#19271

Merged
smartcontracts merged 1 commit intodevelopfrom
chore/audit-feb2026-docs
Mar 3, 2026
Merged

contracts: add documentation for audit findings #3, #7, #12, #15, #16#19271
smartcontracts merged 1 commit intodevelopfrom
chore/audit-feb2026-docs

Conversation

@smartcontracts
Copy link
Copy Markdown
Contributor

Address informational audit findings with improved inline documentation:

  • Document that guardian pause blocks interop upgrades (acceptable for dev feature)
  • Document migrate() is exclusively for N pre-interop chains merging into one set
  • Document that re-migration and partial migration are not supported
  • Document intentional use of chainSystemConfigs[0] for shared contracts
  • Fix inaccurate PERMIT_ALL_CONTRACTS_INSTRUCTION comment

@smartcontracts smartcontracts requested a review from a team as a code owner February 22, 2026 20:24
…16

Add missing @param blueprint NatSpec to OpcmContractRef struct (#2).
Add comments about pause blocking interop upgrades (#3). Document
migrate() scope limitations and re-migration risks (#7, #15). Update
PERMIT_ALL_CONTRACTS_INSTRUCTION comment (#12). Document intentional
use of chainSystemConfigs[0] for shared contracts (#16).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@smartcontracts smartcontracts force-pushed the chore/audit-feb2026-docs branch from 6b4f557 to 8d80aac Compare February 22, 2026 20:39
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.2%. Comparing base (4980b92) to head (8d80aac).
⚠️ Report is 35 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #19271      +/-   ##
===========================================
+ Coverage     76.3%    80.2%    +3.8%     
===========================================
  Files          725      135     -590     
  Lines        79472     6936   -72536     
===========================================
- Hits         60658     5564   -55094     
+ Misses       18668     1372   -17296     
+ Partials       146        0     -146     
Flag Coverage Δ
cannon-go-tests-64 ?
contracts-bedrock-tests 80.2% <100.0%> (-1.4%) ⬇️
unit ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...bedrock/src/L1/opcm/OPContractsManagerMigrator.sol 95.7% <ø> (ø)
...racts-bedrock/src/L1/opcm/OPContractsManagerV2.sol 97.2% <100.0%> (ø)
...ages/contracts-bedrock/src/libraries/Constants.sol 100.0% <ø> (ø)

... and 593 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@maurelian maurelian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@0xiamflux 0xiamflux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@smartcontracts smartcontracts added this pull request to the merge queue Mar 3, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Mar 3, 2026
@smartcontracts smartcontracts added this pull request to the merge queue Mar 3, 2026
Merged via the queue into develop with commit 5161204 Mar 3, 2026
226 of 227 checks passed
@smartcontracts smartcontracts deleted the chore/audit-feb2026-docs branch March 3, 2026 21:30
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.

4 participants