feat(ci): add forge fmt and solhint jobs

[MaxMustermann2]

Refactored

• Have BootstrapStorage implement ITokenWhitelister so that the code for whitelisting can be shared between Bootstrap and ClientChainGateway. In addition, make the getWhitelistedTokensCount be part of the interface.
• Validate ClientChainGateway logic address and implementation data in Bootstrap.setClientChainGatewayLogic
• Use modifiers instead of require(func) where possible

Workflow changes

• Set up forge-ci.yml workflow which contains caching (of binaries and build artifacts) across jobs, and runs them in parallel, where possible
• Set up solhint workflow

Formatting and linting changes

• Update foundry.toml's fmt section with some rules
• Set up solhint config
• Run forge fmt
• Run solhint

Summary by CodeRabbit

• Chores

  • Introduced GitHub Actions workflows for formatting and linting code.
  • Updated test workflow message for better clarity.
  • Added .solhintignore to exclude specific directories from linting.

• Refactor

  • Reformatted and improved readability of several Solidity scripts and contracts.
  • Updated function signatures and logic for better clarity and maintainability.

• New Features

  • Configured solhint settings for Solidity code linting.
  • Made BEACON_PROXY_BYTECODE constant publicly accessible.

• Bug Fixes

  • Improved error handling and validation in various contract functions.

These changes aim to enhance code quality, maintainability, and overall project workflow.

[coderabbitai]

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

34 files out of 92 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

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

Walkthrough

The changes encompass a variety of improvements and new features across multiple files, primarily focusing on code formatting, readability, and maintainability. These include the introduction of GitHub Actions workflows for formatting and linting, numerous formatting adjustments in Solidity scripts, and enhancements to contract logic and control flow. Additionally, several files have been updated to improve error handling, parameter validation, and overall code organization.

Changes

File(s)	Change Summary
.github/workflows/fmt.yml	Introduced a GitHub Actions workflow for formatting code using forge fmt.
.github/workflows/lint.yml	Set up a GitHub Actions workflow to run the solhint linter.
.github/workflows/test.yml	Updated the failure message for clarity.
.solhintignore	Specified that all Solidity files in the src/lzApp/ directory should be ignored by Solhint.
script/10_DeployExocoreGatewayOnly.s.sol, script/11_SetPeers.s.sol, script/12_RedeployClientChainGateway.s.sol, script/2_DeployBoth.s.sol, script/7_DeployBootstrap.s.sol, script/8_DepositValidator.s.sol, script/8_RegisterOperatorsAndDelegate.s.sol, script/9_ExtendBootstrapTime.s.sol, script/BaseScript.sol, script/TestPrecompileErrorFixed_Deploy.s.sol, script/deployBeaconOracle.s.sol, script/integration/1_DeployBootstrap.s.sol	Various formatting adjustments for better readability and maintainability.
src/.solhint.json	Introduced configuration settings for Solhint.
src/core/BaseRestakingController.sol	Adjusted function formatting and updated logic for processing requests and messaging.
src/core/BeaconProxyBytecode.sol	Changed BEACON_PROXY_BYTECODE constant visibility to public and added a solhint directive.
src/core/Bootstrap.sol	Significant changes to contract logic and control flow, including error handling and validations.
src/core/BootstrapLzReceiver.sol	Simplified contract structure and adjusted variable names for consistency.
src/core/ClientChainGateway.sol	Significant changes in import statements, constructor initialization, function signatures, and logic restructuring.
src/core/ClientGatewayLzReceiver.sol	Updated the onlyCalledFromThis modifier and a comparison value in _lzReceive function.
src/core/CustomProxyAdmin.sol	Updated import statements and refactored the changeImplementation function.
src/core/ExoCapsule.sol	Reformatting and enhancing function declarations and comments for better readability and security.
src/storage/BootstrapStorage.sol	Added ITokenWhitelister interface, new state variables, mappings, events, and modifiers.

Sequence Diagram(s) (Beta)

Silently ignored as the changes are too varied to generate a meaningful diagram.

Poem

In the land of code where rabbits hop,
Formatting flows without a stop.
Linting checks and tests refined,
Solidity scripts, all aligned.
Contracts polished, logic clear,
Enhancements made with no fear.
🐇✨ Code’s a garden, growing bright,
Thanks to changes, all feels right!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[MaxMustermann2]

The changes between #16 and #17 can be viewed here lint-workflow...solhint-workflow

[wewecalibrate]

@MaxMustermann2 this will be only linting changes, correct?

[adu-web3]

LGTM