Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add config flag to disable precompilation for scriptMaster #962

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

0xDEnYO
Copy link
Contributor

@0xDEnYO 0xDEnYO commented Jan 29, 2025

Which Jira task belongs to this PR?

Why did I implement it this way?

Checklist before requesting a review

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

  • I have checked that any arbitrary calls to external contracts are validated and or restricted
  • I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
  • I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

Sorry, something went wrong.

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request introduces two new configuration variables in the script/config.example.sh file. WHITELIST_PERIPHERY is a comma-separated list of periphery contracts to be automatically whitelisted during deployment, while COMPILE_ON_STARTUP is a boolean flag that controls whether the script compiles contracts on startup. The changes modify the scriptMaster.sh script to conditionally execute forge build based on the COMPILE_ON_STARTUP environment variable, providing more flexibility in contract deployment and compilation processes.

Changes

File Change Summary
script/config.example.sh Added two new configuration variables:
- WHITELIST_PERIPHERY with default value "FeeCollector,LiFuelFeeCollector,TokenWrapper,LiFiDEXAggregator"
- COMPILE_ON_STARTUP set to false
script/scriptMaster.sh Modified to conditionally execute forge build only when COMPILE_ON_STARTUP is "true"

Possibly related PRs

Suggested labels

AuditNotRequired

Suggested reviewers

  • mirooon
  • ezynda3

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@lifi-action-bot lifi-action-bot marked this pull request as draft January 29, 2025 04:29
@0xDEnYO 0xDEnYO marked this pull request as ready for review January 29, 2025 04:29
@0xDEnYO 0xDEnYO enabled auto-merge (squash) January 29, 2025 04:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
script/config.example.sh (2)

101-102: Consider exporting the WHITELIST_PERIPHERY variable.

The variable is likely used by other deployment scripts. To ensure proper visibility across the deployment pipeline, consider adding the export keyword.

-WHITELIST_PERIPHERY="FeeCollector,LiFuelFeeCollector,TokenWrapper,LiFiDEXAggregator"
+export WHITELIST_PERIPHERY="FeeCollector,LiFuelFeeCollector,TokenWrapper,LiFiDEXAggregator"
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 102-102: WHITELIST_PERIPHERY appears unused. Verify use (or export if used externally).

(SC2034)


104-105: Consider exporting the COMPILE_ON_STARTUP variable.

The variable controls compilation behavior in scriptMaster.sh. To ensure proper visibility, consider adding the export keyword.

-COMPILE_ON_STARTUP=false
+export COMPILE_ON_STARTUP=false
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 105-105: COMPILE_ON_STARTUP appears unused. Verify use (or export if used externally).

(SC2034)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 305600c and 4faf319.

📒 Files selected for processing (2)
  • script/config.example.sh (1 hunks)
  • script/scriptMaster.sh (2 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
script/config.example.sh

[warning] 102-102: WHITELIST_PERIPHERY appears unused. Verify use (or export if used externally).

(SC2034)


[warning] 105-105: COMPILE_ON_STARTUP appears unused. Verify use (or export if used externally).

(SC2034)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: enforce-min-test-coverage
  • GitHub Check: run-unit-tests
  • GitHub Check: run-unit-tests
  • GitHub Check: enforce-min-test-coverage
  • GitHub Check: generate-tag
  • GitHub Check: analyze
🔇 Additional comments (1)
script/scriptMaster.sh (1)

46-48: LGTM! The conditional compilation is properly implemented.

The implementation correctly checks the COMPILE_ON_STARTUP flag before running forge build, which aligns with the configuration changes.

@lifi-action-bot
Copy link
Collaborator

Test Coverage Report

Line Coverage: 78.66% (2238 / 2845 lines)
Function Coverage: 84.71% ( 388 / 458 functions)
Branch Coverage: 39.60% ( 221 / 558 branches)
Test coverage (78.66%) is above min threshold (76%). Check passed.

@0xDEnYO 0xDEnYO merged commit 11ab3fd into main Jan 29, 2025
34 of 39 checks passed
@0xDEnYO 0xDEnYO deleted the add-option-to-disable-compilation-for-scripts branch January 29, 2025 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants