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

Deploy: blast SynapseRouter with verification #319

Merged
merged 6 commits into from
Mar 29, 2024

Conversation

ChiTimesChi
Copy link
Collaborator

@ChiTimesChi ChiTimesChi commented Mar 6, 2024

Description

Redeploys SynapseRouter on Blast, as due to the Foundry bug the previously deployed bytecode wasn't matching the compiled bytecode during verification.

Checklist

  • New Contracts have been tested
  • Lint has been run
  • I have checked my code and corrected any misspellings

Summary by CodeRabbit

  • New Features
    • Enhanced the deployment process of the SynapseRouter contract for improved efficiency and reliability.
    • Introduced a new contract deployment method using the CREATE2 opcode for deterministic contract addresses.
    • Added functionality to retrieve and deploy contracts using bytecode generated by Solidity compiler (solc).
  • Refactor
    • Updated the Solidity version to 0.8.17 for all relevant scripts and contracts.
    • Improved deployment scripts to support reusing existing deployments and ensure address uniqueness.
  • Chores
    • Updated the solc script to save contract bytecode in a specific directory for easier access.

Copy link

coderabbitai bot commented Mar 6, 2024

Walkthrough

The recent updates focus on enhancing the deployment process for the SynapseRouter contract, incorporating Solidity 0.8.17, and introducing methods for both traditional and deterministic (CREATE2) contract deployments. These changes streamline the deployment on specified blockchains, improve the handling of constructor arguments, and facilitate the retrieval of contract bytecode. The modifications span across scripts and Solidity templates, aiming to optimize and clarify the deployment procedures.

Changes

Files Change Summary
script/router/DeployRouterV1.s.sol Updated Solidity version; modified deployment process; added getConstructorArgs()
script/router/DeployRouterV1CREATE2.s.sol New contract for CREATE2 deployment; inherits BasicSynapseScript; deployment methods added
script/router/deploy-router.sh, script/sh/solc.sh Deployment facilitation; updated script usage; saves bytecode
script/templates/BasicSynapse.s.sol, script/templates/BasicUtils.sol Added functions for contract deployment using solc bytecode; updated error message

🐇✨
In the realm of code, where the smart contracts play,
A rabbit hopped in, with updates to convey.
"Let's streamline," it said, with a twinkle in its eye,
Deployments now swift, like a code-laden sky.
With CREATE2 and solc, our contracts take flight,
In the blockchain's embrace, they shimmer at night.
🌟📜🚀

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>.
    • Generate unit-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 47fe6e8 and 35dc24f.
Files ignored due to path filters (5)
  • deployments/blast/SynapseRouter.json is excluded by: !**/*.json
  • script/bytecode/SwapQuoter.json is excluded by: !**/*.json
  • script/configs/Create2Factory.salts.json is excluded by: !**/*.json
  • script/configs/blast/SynapseRouter.dc.json is excluded by: !**/*.json
  • script/solc/SynapseRouter.json is excluded by: !**/*.json
Files selected for processing (6)
  • script/router/DeployRouterV1.CREATE2.s.sol (1 hunks)
  • script/router/DeployRouterV1.s.sol (3 hunks)
  • script/router/deploy-router.sh (1 hunks)
  • script/sh/solc.sh (2 hunks)
  • script/templates/BasicSynapse.s.sol (2 hunks)
  • script/templates/BasicUtils.sol (1 hunks)
Additional comments: 9
script/router/deploy-router.sh (1)
  • 8-11: The script includes a temporary fix for a Foundry bug and uses solc.sh for compiling SynapseRouter. Ensure that the solc.sh script correctly handles the compilation and bytecode generation as expected. Additionally, verify that the DeployRouterV1.s.sol script is correctly set up to receive and process the passed arguments for deployment.
script/sh/solc.sh (1)
  • 23-23: The script saves the bytecode in a new directory (./script/solc/). Ensure that all references to bytecode files in other scripts or parts of the project have been updated to reflect this change in directory structure.
script/router/DeployRouterV1.CREATE2.s.sol (1)
  • 6-25: The DeployRouterV1CREATE2 contract uses the deployAndSave method with a callback to deploy the SynapseRouter contract using CREATE2. Ensure that the getConstructorArgs function correctly encodes the constructor arguments for SynapseRouter. Additionally, verify that the deployment salt and address uniqueness are properly managed to avoid collisions or unintended overwrites.
script/router/DeployRouterV1.s.sol (2)
  • 14-19: The deployAndSave method is used to deploy the SynapseRouter contract with constructor arguments obtained from getConstructorArgs. Ensure that the deploySolcGenerated method correctly deploys the contract using bytecode generated by solc. Additionally, verify that the constructor arguments are correctly encoded and passed to the contract.
  • 41-41: The getConstructorArgs function is introduced to handle the constructor arguments for SynapseRouter. Ensure that the addresses for SynapseBridge and OWNER_ADDR are correctly retrieved and encoded. This is crucial for the correct initialization of the SynapseRouter contract.
script/templates/BasicUtils.sol (1)
  • 120-125: The getSolcBytecode function is added to retrieve contract bytecode generated by solc. Ensure that the path constructed (script/solc/) matches the directory structure used by the solc.sh script for saving bytecode files. Additionally, verify that the JSON structure of the saved bytecode files correctly matches the expected format for reading the .bytecode key.
script/templates/BasicSynapse.s.sol (3)
  • 115-126: The deploySolcGenerated function is a valuable addition, enabling deployment using solc-generated bytecode. This aligns with the PR's objectives to improve the deployment process. However, consider the following:
  • Ensure that getSolcBytecode securely retrieves the bytecode and handles errors gracefully.
  • Verify that the constructor arguments are correctly formatted and encoded with the bytecode.
  • Confirm that this method of deployment has been thoroughly tested, especially for contracts with complex constructor arguments.
  • 156-170: The deploySolcGeneratedCreate2 function introduces deterministic deployment using create2 and solc-generated bytecode, which is a significant enhancement. Consider the following:
  • Ensure that getSolcBytecode is secure and error-resistant.
  • Validate the handling and generation of nextDeploymentSalt for predictability and uniqueness.
  • It's important to test this function extensively, particularly for contracts that might have edge cases in their constructor arguments or deployment logic.
  • 136-136: The updated error message in the deployCode function to "Deployment failed" is a minor but positive change, enhancing clarity on deployment issues. Ensure that this message is consistent with other error handling practices throughout the deployment scripts.

Comment on lines +2 to +3
# This script saves bytecode for a contract into "./script/solc/<contract>.json"
# Usage: ./script/sh/solc.sh <contract>
Copy link

Choose a reason for hiding this comment

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

The script's purpose is clearly stated, and the usage message is helpful. However, ensure that the directory ./script/solc/ is created before attempting to save bytecode files to it, as the script does not currently check for or create the directory if it does not exist.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 8174755715

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 12.934%

Totals Coverage Status
Change from base Build 8163211251: 0.0%
Covered Lines: 664
Relevant Lines: 4684

💛 - Coveralls

@ChiTimesChi ChiTimesChi merged commit bcb9f78 into master Mar 29, 2024
10 checks passed
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.

3 participants