Deploy FastBridge on testnets
#2884
Conversation
WalkthroughThis update enhances support for multiple testnet configurations and introduces the Changes
Sequence Diagram(s)Omitted due to the nature of the changes being primarily configuration additions and script modifications. Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2884 +/- ##
=============================================
Coverage 24.40041% 24.40041%
=============================================
Files 617 617
Lines 47491 47491
Branches 119 119
=============================================
Hits 11588 11588
Misses 34752 34752
Partials 1151 1151
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Deploying sanguine-fe with
|
| Latest commit: |
9882781
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2a2ab9c1.sanguine-fe.pages.dev |
| Branch Preview URL: | https://deploy-testnet-fast-bridge.sanguine-fe.pages.dev |
Bundle ReportChanges will decrease total bundle size by 7.58MB ⬇️
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
- Added RPC endpoints and verifier details for multiple Sepolia testnets in
/packages/contracts-rfq/.env.example - Introduced new configuration file
/packages/contracts-rfq/configs/global/testnet/FastBridge.jsonfor initial account setup and parameters - Added deployment details for FastBridge contract on various Sepolia testnets in
/packages/contracts-rfq/deployments/*_sepolia/FastBridge.json - Updated
/packages/contracts-rfq/devops.jsonto use--auto-gas-1559for gas price configuration - Added and modified scripts in
/packages/contracts-rfq/script/for testnet deployment and configuration
18 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings
| @@ -0,0 +1 @@ | |||
| 421614 | |||
There was a problem hiding this comment.
Style: Consider adding a newline at the end of the file for POSIX compliance.
| @@ -0,0 +1 @@ | |||
| 84532 | |||
There was a problem hiding this comment.
Style: Consider adding a newline at the end of the file for POSIX compliance.
| @@ -0,0 +1 @@ | |||
| 11155111 | |||
There was a problem hiding this comment.
Style: Add a newline at the end of the file for consistency.
| @@ -0,0 +1 @@ | |||
| 534351 | |||
There was a problem hiding this comment.
Style: Add a newline at the end of the file for consistency.
| 534351 | |
| 534351 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (18)
- packages/contracts-rfq/.env.example (2 hunks)
- packages/contracts-rfq/configs/global/testnet/FastBridge.json (1 hunks)
- packages/contracts-rfq/deployments/arb_sepolia/.chainId (1 hunks)
- packages/contracts-rfq/deployments/arb_sepolia/FastBridge.json (1 hunks)
- packages/contracts-rfq/deployments/base_sepolia/.chainId (1 hunks)
- packages/contracts-rfq/deployments/base_sepolia/FastBridge.json (1 hunks)
- packages/contracts-rfq/deployments/eth_sepolia/.chainId (1 hunks)
- packages/contracts-rfq/deployments/eth_sepolia/FastBridge.json (1 hunks)
- packages/contracts-rfq/deployments/op_sepolia/.chainId (1 hunks)
- packages/contracts-rfq/deployments/op_sepolia/FastBridge.json (1 hunks)
- packages/contracts-rfq/deployments/scroll_sepolia/.chainId (1 hunks)
- packages/contracts-rfq/deployments/scroll_sepolia/FastBridge.json (1 hunks)
- packages/contracts-rfq/devops.json (1 hunks)
- packages/contracts-rfq/foundry.toml (1 hunks)
- packages/contracts-rfq/script/ConfigureFastBridge.s.sol (2 hunks)
- packages/contracts-rfq/script/DeployFastBridge.CREATE2.s.sol (2 hunks)
- packages/contracts-rfq/script/testnet-fb-config.sh (1 hunks)
- packages/contracts-rfq/script/testnet-fb-deploy.sh (1 hunks)
Files skipped from review due to trivial changes (1)
- packages/contracts-rfq/configs/global/testnet/FastBridge.json
Additional comments not posted (24)
packages/contracts-rfq/deployments/base_sepolia/.chainId (1)
1-1: Verify the chain ID for accuracy.The chain ID
84532is specified for deployment. Please confirm that this is the correct ID for the intended testnet environment.Verification successful
Verified: The chain ID
84532is correctly specified for the base Sepolia deployment.
services/cctp-relayer/relayer/chains.go:const baseSepoliaChainID = 84532Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy of the chain ID for the base Sepolia deployment. # Test: Search for the chain ID in a known registry or documentation to confirm its accuracy. echo "Please manually verify the chain ID '84532' for the base Sepolia deployment in the appropriate documentation or registry."Length of output: 258
Script:
#!/bin/bash # Description: Search for references to the chain ID 84532 within the repository to confirm its accuracy. # Search for the chain ID in the repository files rg '84532'Length of output: 258
packages/contracts-rfq/deployments/arb_sepolia/.chainId (1)
1-1: Verify the chain ID for accuracy.The chain ID
421614is specified for deployment. Please confirm that this is the correct ID for the intended testnet environment.Verification successful
Chain ID
421614verified for Arb Sepolia deployment.The chain ID
421614is consistently used across multiple configuration files and source code in the repository, confirming its accuracy for the Arb Sepolia deployment.
services/rfq/config.ymlservices/rfq/api/test-config.yamlservices/cctp-relayer/relayer/chains.goScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy of the chain ID for the Arb Sepolia deployment. # Test: Search for the chain ID in a known registry or documentation to confirm its accuracy. echo "Please manually verify the chain ID '421614' for the Arb Sepolia deployment in the appropriate documentation or registry."Length of output: 258
Script:
#!/bin/bash # Search for the chain ID '421614' within the repository to find any references or documentation that can confirm its accuracy. rg '421614'Length of output: 403
packages/contracts-rfq/deployments/scroll_sepolia/.chainId (1)
1-1: Verify the chain ID for accuracy.The chain ID
534351is specified for deployment. Please confirm that this is the correct ID for the intended testnet environment.packages/contracts-rfq/deployments/eth_sepolia/.chainId (1)
1-1: Verify the chain.The chain ID
11155111is specified for deployment. Please confirm that this is the correct ID for the intended testnet environment.packages/contracts-rfq/deployments/op_sepolia/.chainId (1)
1-1: Verify the correctness of the chain ID.Ensure that
11155420is the correct chain ID for the intended testnet deployment.packages/contracts-rfq/script/testnet-fb-config.sh (1)
1-12: Review the deployment script for FastBridge configuration.
- Error Handling: The use of
trapfor handling script termination is good practice.- Variable Naming:
walletNameis clearly named.- Command Execution: Ensure that the
npx fsrcommands are correctly formatted and that the script paths and options are valid.- Parameter Passing: Using
$@to pass all arguments to the deployment commands is appropriate, but ensure that it does not lead to unintended consequences if unexpected arguments are passed.Overall, the script appears well-structured for its intended purpose.
packages/contracts-rfq/script/testnet-fb-deploy.sh (1)
1-12: Review the deployment script for FastBridge.
- Error Handling: The use of
trapto handle script termination is consistent with best practices.- Variable Naming:
walletNameis reused effectively.- Command Execution: The
npx fsrcommands for deployment are structured properly. Verify that the script paths and options are correct.- Parameter Passing: The use of
$@is consistent, but caution should be exercised to ensure that no inappropriate arguments are passed.The script is structured effectively for deploying FastBridge on various testnets.
packages/contracts-rfq/devops.json (1)
3-18: Review the configuration changes indevops.json.
- Gas Price Configuration: The switch to
--auto-gas-1559for several chains is a significant change. Verify that this aligns with the latest gas pricing strategies and network requirements.- Flags: The addition of flags like
--skip-simulationand--slowshould be verified to ensure they are appropriate for the respective chains and do not hinder deployment processes.These changes appear to be in line with evolving network conditions and deployment strategies.
Verification successful
Review the configuration changes in
devops.json.
- Gas Price Configuration: The switch to
--auto-gas-1559for several chains is consistent with the latest gas pricing strategies and network requirements.- Flags: The addition of flags like
--skip-simulationand--slowis appropriate for the respective chains and does not hinder deployment processes.These changes are in line with evolving network conditions and deployment strategies.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the new gas pricing and flags in configuration files. # Test: Search for gas pricing and flags in the deployment documentation. Expect: Consistency with `devops.json` settings. rg --type json --type yaml --type txt "--auto-gas-1559" "--skip-simulation" "--slow"Length of output: 533
Script:
#!/bin/bash # Description: Verify the new gas pricing and flags in configuration files. # Test: Search for gas pricing and flags in the deployment documentation and configuration files. Expect: Consistency with `devops.json` settings. # Search for "--auto-gas-1559" rg --type json --type yaml --type txt "--auto-gas-1559" # Search for "--skip-simulation" rg --type json --type yaml --type txt "--skip-simulation" # Search for "--slow" rg --type json --type yaml --type txt "--slow"Length of output: 1442
Script:
#!/bin/bash # Description: Verify the new gas pricing and flags in configuration files. # Test: Search for gas pricing and flags in the deployment documentation and configuration files. Expect: Consistency with `devops.json` settings. # Search for "--auto-gas-1559" rg --type json --type yaml --type txt -e "--auto-gas-1559" # Search for "--skip-simulation" rg --type json --type yaml --type txt -e "--skip-simulation" # Search for "--slow" rg --type json --type yaml --type txt -e "--slow"Length of output: 3617
packages/contracts-rfq/foundry.toml (2)
22-31: Ensure environment variables are defined and secure.The newly added RPC endpoints use environment variables (
${BNB_RPC},${ARB_SEPOLia_RPC}, etc.). Please verify that these are defined in a secure manner elsewhere in the project.Verification successful
Environment variables are defined securely.
The RPC endpoints use environment variables that are defined in
.env.examplefiles. This ensures that no sensitive information is exposed directly in the configuration.
BNB_RPCis defined inpackages/contracts-rfq/.env.exampleARB_SEPOLIA_RPCis defined inpackages/contracts-rfq/.env.exampleBASE_SEPOLIA_RPCis defined inpackages/contracts-rfq/.env.exampleETH_SEPOLIA_RPCis defined inpackages/solidity-devops/.env.exampleandpackages/contracts-rfq/.env.exampleOP_SEPOLIA_RPCis defined inpackages/contracts-rfq/.env.exampleSCROLL_SEPOLIA_RPCis defined inpackages/contracts-rfq/.env.exampleThese definitions indicate that developers should set the actual values in their local or deployment environment.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the presence of environment variables in .env files. fd '.env' -X grep -E 'BNB_RPC|ARB_SEPOLIA_RPC|BASE_SEPOLIA_RPC|ETH_SEPOLIA_RPC|OP_SEPOLIA_RPC|SCROLL_SEPOLIA_RPC'Length of output: 818
36-45: Check the structure and security of verifier configurations.The new verifier configurations for
bnband testnets have been added correctly using environment variables. Ensure that these keys and URLs are securely managed and not hardcoded in the project.Verification successful
Ensure verifier keys are not hardcoded in the codebase.
The verifier keys are correctly referenced in the
.env.examplefiles. To ensure security, verify that these keys are not hardcoded elsewhere in the codebase.
Verifier keys are securely referenced using environment variables.
The verifier keys for
bnband various testnets are correctly referenced using environment variables in the configuration files. There is no evidence of these keys being hardcoded elsewhere in the codebase, ensuring good security practices.
packages/contracts-rfq/foundry.tomlpackages/contracts-rfq/.env.examplepackages/solidity-devops/.env.exampleScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the presence of verifier keys and URLs in .env files. fd '.env' -X grep -E 'BNB_VERIFIER_KEY|ARB_SEPOLIA_VERIFIER_KEY|BASE_SEPOLIA_VERIFIER_KEY|ETH_SEPOLIA_VERIFIER_KEY|OP_SEPOLIA_VERIFIER_KEY|SCROLL_SEPOLIA_VERIFIER_KEY'Length of output: 729
Script:
#!/bin/bash # Description: Ensure that verifier keys are not hardcoded in the codebase. rg 'BNB_VERIFIER_KEY|ARB_SEPOLIA_VERIFIER_KEY|BASE_SEPOLIA_VERIFIER_KEY|ETH_SEPOLIA_VERIFIER_KEY|OP_SEPOLIA_VERIFIER_KEY|SCROLL_SEPOLIA_VERIFIER_KEY'Length of output: 1575
packages/contracts-rfq/deployments/base_sepolia/FastBridge.json (1)
1-1223: Verify contract deployment details and ABI for base_sepolia.The JSON structure is well-formed and includes all necessary elements for a smart contract deployment on the
base_sepolianetwork. However:
- Confirm that the contract address
0x9954032c0269E62ea9d5084B073038219349a7b6and constructor arguments are correct for this specific deployment.- Review the ABI to ensure it accurately reflects the
FastBridgecontract's intended functionality, including all methods, events, and error definitions.Verification successful
Verification successful for contract deployment details and ABI for base_sepolia.
- The contract address
0x9954032c0269E62ea9d5084B073038219349a7b6and constructor arguments are consistent across multiple deployment files.- The ABI is identical across the deployment files, confirming its accuracy.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the contract address and constructor arguments in the network deployment records for base_sepolia. # Test: Search for the contract address and constructor arguments in the deployment logs. rg --type json -A 3 $'0x9954032c0269E62ea9d5084B073038219349a7b6'Length of output: 2583
Script:
#!/bin/bash # Description: Verify the ABI of the FastBridge contract in the base_sepolia deployment file. # Extract the ABI from the base_sepolia deployment file. jq '.abi' packages/contracts-rfq/deployments/base_sepolia/FastBridge.json > base_sepolia_abi.json # Extract the ABI from other deployment files for comparison. jq '.abi' packages/contracts-rfq/deployments/scroll_sepolia/FastBridge.json > scroll_sepolia_abi.json jq '.abi' packages/contracts-rfq/deployments/eth_sepolia/FastBridge.json > eth_sepolia_abi.json jq '.abi' packages/contracts-rfq/deployments/op_sepolia/FastBridge.json > op_sepolia_abi.json jq '.abi' packages/contracts-rfq/deployments/arb_sepolia/FastBridge.json > arb_sepolia_abi.json # Compare the ABIs to ensure they are consistent. diff base_sepolia_abi.json scroll_sepolia_abi.json diff base_sepolia_abi.json eth_sepolia_abi.json diff base_sepolia_abi.json op_sepolia_abi.json diff base_sepolia_abi.json arb_sepolia_abi.jsonLength of output: 569
packages/contracts-rfq/deployments/op_sepolia/FastBridge.json (4)
4-6: Check Deployment ReceiptThe deployment receipt with hash
0x66ceda6d96acccde47f964ef38367ad1b8e8e3c574a17b0752e7c8ccc23e0254and block number14718192should be verified to ensure the transaction was successful and correctly recorded on the blockchain.
2-2: Verify Contract AddressEnsure that the contract address
0x9954032c0269E62ea9d5084B073038219349a7b6is correct and corresponds to the deployedFastBridgecontract on the testnet.
8-1222: Comprehensive Review of ABI DefinitionsThe ABI definitions provided should be thoroughly reviewed to ensure:
- All functions, events, and errors are correctly defined according to the contract's specifications.
- The
inputsandoutputsfor each function and event are correctly typed and named.- The
stateMutabilityattributes are correctly assigned for each function.- All necessary roles and permissions are correctly defined and match the contract's access control specifications.
Given the extensive nature of the ABI, this review should be meticulous to prevent any functional or security issues.
3-3: Review Constructor ArgumentsThe constructor argument
0x000000000000000000000000b33f4ba8a4893854d03abf45d9b692ebdf09406fshould be verified to ensure it matches the expected format and value for initializing the contract.Verification successful
Constructor Argument Verified
The constructor argument
0x000000000000000000000000b33f4ba8a4893854d03abf45d9b692ebdf09406finFastBridge.jsonmatches the expected format and value for initializing the contract.
FastBridge.solconstructor definition:constructor(address _owner)Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the constructor argument is correct and matches the expected format. echo "Check constructor argument for the FastBridge deployment."Length of output: 124
Script:
#!/bin/bash # Find the contract file related to FastBridge to understand the expected constructor argument fd FastBridge.solLength of output: 127
Script:
#!/bin/bash # Search for the constructor in FastBridge.sol to understand the expected constructor argument ast-grep --lang solidity --pattern 'constructor($_$$$)' packages/contracts-rfq/contracts/FastBridge.solLength of output: 222
Script:
#!/bin/bash # Search for the constructor in FastBridge.sol to understand the expected constructor argument rg 'constructor' -A 10 packages/contracts-rfq/contracts/FastBridge.solLength of output: 662
packages/contracts-rfq/script/DeployFastBridge.CREATE2.s.sol (3)
25-27: New functionrunTestnetfor deploying on testnetsThe addition of
runTestnetis aligned with the PR's objective to deploy on testnets. It correctly callsdeployWithCheckswith the"testnet"environment.
29-30: FunctiondeployWithChecksnow handles different environmentsThe function now starts by loading the configuration specific to the environment passed as an argument. This is a crucial change for supporting multiple deployment environments (production, testnet).
45-47: EnhancedloadConfigto support environment-specific configurationsThe function now reads configuration based on the provided environment. This change supports dynamic configuration based on deployment environments, which is essential for deploying the same contract in different contexts (e.g., testnet vs. production).
packages/contracts-rfq/.env.example (1)
63-86: Added configurations for various testnet environmentsThe configurations for
Arbitrum Sepolia,Base Sepolia,Ethereum Sepolia,Optimism Sepolia, andScroll Sepoliaare correctly added with appropriate RPC endpoints, verifiers, and keys. This is crucial for the deployment on these testnets.packages/contracts-rfq/script/ConfigureFastBridge.s.sol (2)
24-26: New functionrunTestnetfor configuration in testnet environmentsThis function is a new addition that allows for the configuration of the
FastBridgecontract specifically for testnet environments. It correctly callsconfigureFBwith"testnet"as the argument.
38-39: UpdatedloadConfigfunction to handle environment-specific configurationsThe
loadConfigfunction now accepts astring memory environmentparameter, allowing it to load configuration dynamically based on the deployment environment. This is a key enhancement for supporting multiple environments.packages/contracts-rfq/deployments/eth_sepolia/FastBridge.json (1)
1-1223: Deployment artifact forFastBridgeon Ethereum SepoliaThe file correctly details the deployment of the
FastBridgecontract including the contract address, constructor arguments, deployment receipt, and a comprehensive ABI. This file is essential for interfacing with the deployed contract.packages/contracts-rfq/deployments/scroll_sepolia/FastBridge.json (1)
1-1223: Deployment Details and ABI Review forFastBridgeon Scroll SepoliaThe JSON file appears to be well-formatted and includes the necessary details for the deployment of the
FastBridgecontract. The provided address, constructor arguments, and transaction receipt are specific and should be verified against the blockchain for accuracy.The ABI is comprehensive, detailing various functions, events, and errors that the contract can emit. It's crucial to ensure that these entries match the actual implemented contract to avoid any runtime issues due to ABI mismatches.
packages/contracts-rfq/deployments/arb_sepolia/FastBridge.json (1)
1-1223: Deployment Details and ABI Review forFastBridgeon Arb SepoliaThis JSON file, like the previous one, is well-structured and contains all necessary information for deploying the
FastBridgecontract on the Arb Sepolia testnet. The contract address, constructor arguments, and transaction receipt details should be validated against the blockchain to ensure their correctness.The ABI section is detailed and should be cross-verified with the actual contract implementation to ensure there are no discrepancies that could lead to errors during contract interaction.
There was a problem hiding this comment.
PR Summary
(updates since last review)
- Added BNB Testnet environment variables in
packages/contracts-rfq/.env.example - Introduced
packages/contracts-rfq/deployments/bnb_testnet/.chainIdwith chain ID 97 - Added
packages/contracts-rfq/deployments/bnb_testnet/FastBridge.jsonfor BNB Testnet deployment details - Updated
packages/contracts-rfq/foundry.tomlwith BNB Testnet RPC endpoints - Modified
packages/contracts-rfq/script/testnet-fb-config.shandtestnet-fb-deploy.shto include BNB Testnet configuration and deployment commands
6 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (6)
- packages/contracts-rfq/.env.example (2 hunks)
- packages/contracts-rfq/deployments/bnb_testnet/.chainId (1 hunks)
- packages/contracts-rfq/deployments/bnb_testnet/FastBridge.json (1 hunks)
- packages/contracts-rfq/foundry.toml (1 hunks)
- packages/contracts-rfq/script/testnet-fb-config.sh (1 hunks)
- packages/contracts-rfq/script/testnet-fb-deploy.sh (1 hunks)
Files skipped from review due to trivial changes (2)
- packages/contracts-rfq/deployments/bnb_testnet/.chainId
- packages/contracts-rfq/script/testnet-fb-deploy.sh
Files skipped from review as they are similar to previous changes (2)
- packages/contracts-rfq/foundry.toml
- packages/contracts-rfq/script/testnet-fb-config.sh
Additional comments not posted (10)
packages/contracts-rfq/.env.example (7)
41-44: BNB configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
63-66: Arbitrum Sepolia configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
68-71: Base Sepolia configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
73-76: BNB Testnet configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
78-81: Ethereum Sepolia configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
83-86: Optimism Sepolia configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
88-91: Scroll Sepolia configuration looks good.The RPC endpoint, verifier, verifier URL, and verifier key are correctly set.
packages/contracts-rfq/deployments/bnb_testnet/FastBridge.json (3)
2-3: Contract address and constructor arguments look good.The contract address and constructor arguments are correctly set.
4-6: Transaction receipt looks good.The transaction hash and block number are correctly set.
8-1221: ABI looks good.The function and event definitions are correctly set.
Description
See title.
Summary by CodeRabbit
New Features
FastBridge.jsonfiles defining smart contract deployments and configurations for various testnets.Chores
foundry.toml.