Skip to content

fix(contracts): exclude yield storage layout from docgen#3065

Open
kyzooghost wants to merge 1 commit into
mainfrom
fix/docgen-yield-storage-layout
Open

fix(contracts): exclude yield storage layout from docgen#3065
kyzooghost wants to merge 1 commit into
mainfrom
fix/docgen-yield-storage-layout

Conversation

@kyzooghost
Copy link
Copy Markdown
Contributor

@kyzooghost kyzooghost commented May 12, 2026

This PR implements issue(s) # N/A

Summary

Excludes YieldManagerStorageLayout.sol from Solidity docgen output so docgen no longer evaluates the audited storage helper NatSpec that uses $ / $$ return variable names. This keeps audited Solidity untouched and fixes the solidity-docgen parser crash.

Verification

  • cd contracts && pnpm exec hardhat docgen
  • pnpm -F contracts run solidity:docgen
  • pnpm -F contracts run lint:ts

Checklist

  • I wrote new tests for my new core changes. N/A - tooling configuration only.
  • I have successfully ran tests, style checker and build against my new changes locally.
  • If this change is deployed to any environment (including Devnet), E2E test coverage exists or is included in this PR. N/A - not deployed.
  • I have informed the team of any breaking changes if there are any. N/A - no breaking changes.

Note

Low Risk
Low risk tooling/config change that only affects generated Solidity documentation output. No contract logic or deployment behavior is modified.

Overview
Updates contracts/hardhat.config.ts to exclude yield/YieldManagerStorageLayout.sol from solidity-docgen generation, avoiding docgen processing/parsing of that audited storage-layout helper and preventing docgen crashes.

Reviewed by Cursor Bugbot for commit 75729f8. Bugbot is set up for automated code reviews on this repo. Configure here.

@kyzooghost kyzooghost requested a review from a team as a code owner May 12, 2026 13:54
@github-actions
Copy link
Copy Markdown
Contributor

linea-besu Changelog Preview (informational)

[Unreleased] diff (commits touching linea-besu/** since latest releases/linea-besu/v* tag)

[unreleased]

🐛 Bug Fixes

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.19%. Comparing base (4f42a8a) to head (75729f8).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #3065   +/-   ##
=========================================
  Coverage     77.19%   77.19%           
  Complexity     7003     7003           
=========================================
  Files          1121     1121           
  Lines         44508    44508           
  Branches       5355     5355           
=========================================
  Hits          34356    34356           
  Misses         8785     8785           
  Partials       1367     1367           
Flag Coverage Δ *Carryforward flag
hardhat 96.17% <ø> (ø)
kotlin 55.86% <ø> (ø) Carriedforward from 4f42a8a
lido-governance-monitor 97.61% <ø> (ø) Carriedforward from 4f42a8a
linea-native-libs 90.69% <ø> (ø) Carriedforward from 4f42a8a
linea-shared-utils 96.18% <ø> (ø) Carriedforward from 4f42a8a
native-yield-automation-service 97.68% <ø> (ø) Carriedforward from 4f42a8a
postman 99.92% <ø> (ø) Carriedforward from 4f42a8a
sdk-core 98.09% <ø> (ø) Carriedforward from 4f42a8a
sdk-ethers 89.83% <ø> (ø) Carriedforward from 4f42a8a
sdk-viem 99.45% <ø> (ø) Carriedforward from 4f42a8a
tracer 88.56% <ø> (ø) Carriedforward from 4f42a8a

*This pull request uses carry forward flags. Click here to find out more.

🚀 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.

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.

2 participants