ci: add slither integration

[fbac]

• Add slither analysis to CI

Summary by CodeRabbit

• Chores
  • Introduced a GitHub Actions workflow named "Slither" for analyzing contracts.
  • Added configuration settings for contract analysis with slither.config.json.

[coderabbitai]

Walkthrough

The changes introduce a GitHub Actions workflow for running Slither static analysis on smart contracts in two specific projects (zeta-app-contracts and zevm-app-contracts). Additionally, a configuration file for Slither is included to tailor the analysis process. These updates automate the security checks, ensuring consistency and efficiency.

Changes

File	Change Summary
.github/workflows/slither.yaml	Added a GitHub Actions workflow for Slither analysis on push and pull requests for two contract projects.
slither.config.json	Introduced configuration settings for Slither, including detectors exclusion and path filtering.

Poem

In the land of code, a new dance begins,
Slither's keen eye for security wins.
Contracts are checked with automated grace,
Ensuring our code's in a safer place.
With each commit, a guardian so bright,
Safeguards our work, day and night.
🌟 By the rabbit's whiskers, all is 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.

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 432ed72 and 453506f.

Files selected for processing (2)

• .github/workflows/slither.yaml (1 hunks)
• slither.config.json (1 hunks)

Files skipped from review due to trivial changes (1)

• slither.config.json

Additional comments not posted (3)

.github/workflows/slither.yaml (3)

1-15: Verify the necessity of wildcard branch specifier in pull_request.

The wildcard branch specifier (*) in the pull_request trigger might cause the workflow to run for all branches, which may not be desirable. Consider narrowing it down to specific branches if appropriate.

---

16-28: Verify matrix strategy and permissions.

Ensure that the matrix strategy, which includes zeta-app-contracts and zevm-app-contracts, covers all necessary projects. Also, verify that the permissions for contents (read) and security-events (write) are appropriate for the intended analysis.

---

30-59: Verify continue-on-error setting and step configurations.

Ensure that the continue-on-error setting for the Compile contracts and Run Slither steps is appropriate for the workflow. Verify that each step, including checking out the code, setting up Node.js, installing dependencies, compiling contracts, running Slither analysis, and uploading SARIF files, is necessary and correctly configured.