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

Update zksync deploy script naming #942

Merged
merged 12 commits into from
Jan 30, 2025

Conversation

0xDEnYO
Copy link
Contributor

@0xDEnYO 0xDEnYO commented Jan 22, 2025

Which Jira task belongs to this PR?

https://lifi.atlassian.net/browse/LF-11177

Why did I implement it this way?

to prevent having files in the same repo with the same name (but different content)

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>

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Warning

Rate limit exceeded

@0xDEnYO has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 6e0ef89 and 319e72f.

📒 Files selected for processing (1)
  • script/scriptMaster.sh (1 hunks)

Walkthrough

The pull request modifies the deploySingleContract.sh and scriptMaster.sh scripts to enhance deployment handling for the "zksync" network. It introduces conditional logic for selecting deployment script paths based on the specified network, allowing for a specialized script suffix when "zksync" is chosen. Additionally, the scriptMaster.sh file updates the handling of deployment scripts by consolidating logic and clarifying the contract extraction process. These changes improve the flexibility and clarity of the deployment scripts without altering existing error handling.

Changes

File Change Summary
script/deploy/deploySingleContract.sh Introduced conditional logic for deployment script path based on network type, specifically for "zksync". Updated script suffix handling to use .zksync.s.sol for zksync scripts.
script/scriptMaster.sh Updated handling of deployment scripts for "zksync", clarified contract name extraction, and removed redundant lines for non-"zksync" networks.

Possibly related PRs

Suggested reviewers

  • ezynda3
  • mirooon

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.

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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 748cbe2 and 990bc61.

📒 Files selected for processing (1)
  • script/deploy/deploySingleContract.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
script/deploy/deploySingleContract.sh

[error] 121-121: Did you forget the 'then' for this 'elif'?

(SC1049)


[error] 121-121: Couldn't parse this elif clause. Fix to allow more checks.

(SC1073)


[error] 123-123: Unexpected keyword/token. Fix any mentioned problems and try again.

(SC1072)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: enforce-min-test-coverage
  • GitHub Check: run-unit-tests

script/deploy/deploySingleContract.sh Outdated Show resolved Hide resolved
@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.

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 990bc61 and 2a1330d.

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

[warning] 126-126: The surrounding quotes actually unquote this. Remove or escape them.

(SC2027)


[warning] 126-126: The surrounding quotes actually unquote this. Remove or escape them.

(SC2027)


[warning] 126-126: Word is of the form "A"B"C" (B indicated). Did you mean "ABC" or "A"B"C"?

(SC2140)


[warning] 128-128: The surrounding quotes actually unquote this. Remove or escape them.

(SC2027)


[warning] 128-128: The surrounding quotes actually unquote this. Remove or escape them.

(SC2027)


[warning] 128-128: Word is of the form "A"B"C" (B indicated). Did you mean "ABC" or "A"B"C"?

(SC2140)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: analyze
  • GitHub Check: generate-tag
🔇 Additional comments (5)
script/deploy/deploySingleContract.sh (2)

97-98: LGTM!

The code correctly updates the deploy script directory for zksync network.


102-108: LGTM!

The code properly handles script selection based on network type, using the correct file extension filtering.

script/scriptMaster.sh (3)

135-139: LGTM!

The code correctly updates the deploy script directory and ensures foundry-zksync is installed before proceeding.


140-145: LGTM!

The code properly handles script selection based on network type, using the correct file extension filtering.


146-146: LGTM!

The code correctly extracts the contract name from the script name.

script/deploy/deploySingleContract.sh Outdated Show resolved Hide resolved
@0xDEnYO 0xDEnYO marked this pull request as ready for review January 28, 2025 02:49
@0xDEnYO 0xDEnYO enabled auto-merge (squash) January 28, 2025 02:49
@0xDEnYO 0xDEnYO changed the title Update zksync deploy script naming lf 11177 Update zksync deploy script naming Jan 28, 2025
script/deploy/deploySingleContract.sh Outdated Show resolved Hide resolved
script/deploy/deploySingleContract.sh Outdated Show resolved Hide resolved
script/scriptMaster.sh Show resolved Hide resolved
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aad48df and 6e0ef89.

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

[warning] 107-107: Declare and assign separately to avoid masking return values.

(SC2155)

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

93-94: LGTM! Good separation of concerns.

The introduction of FILE_EXTENSION variable improves maintainability by centralizing the extension management.


99-101: LGTM! Clear network-specific handling.

The zksync-specific directory and file extension updates are well-organized and clearly documented.


113-115: LGTM! Clean path construction.

The script path construction using proper shell parameter expansion is clear and secure.

script/deploy/deploySingleContract.sh Show resolved Hide resolved
mirooon
mirooon previously approved these changes Jan 29, 2025
ezynda3
ezynda3 previously approved these changes Jan 29, 2025
@0xDEnYO 0xDEnYO dismissed stale reviews from ezynda3 and mirooon via 319e72f January 30, 2025 02:11
@0xDEnYO 0xDEnYO disabled auto-merge January 30, 2025 02:11
@0xDEnYO 0xDEnYO enabled auto-merge (squash) January 30, 2025 02:11
@0xDEnYO 0xDEnYO merged commit c3cd303 into main Jan 30, 2025
16 checks passed
@0xDEnYO 0xDEnYO deleted the update-zksync-deploy-script-naming-lf-11177 branch January 30, 2025 07:46
@coderabbitai coderabbitai bot mentioned this pull request Feb 3, 2025
8 tasks
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.

4 participants