feat/arb-sep-to-sep-testnet

mani99brar commented 1 month ago

PR-Codex overview

This PR introduces significant updates to the relayer-cli and validator-cli projects, enhancing functionality for both devnet and testnet operations. It adds new scripts, improves state management, and updates dependencies, particularly focusing on bridging and message relaying capabilities.

Detailed summary

Added start-testnet-relayer script to relayer-cli/package.json.
Added DEVNET_SENDER and VEAOUTBOX_CHAIN_ID to .env.dist.
Introduced new functions in relayer-cli/src/testnetRelayer.ts for testnet operations.
Updated @arbitrum/sdk dependency to version 4.0.1.
Enhanced bridgeRoutes.ts to include epoch management.
Refactored getVeaInbox and getVeaOutbox functions for better chain handling.
Improved error handling and logging in validator-cli/src/utils/arbMsgExecutor.ts.
Added batch processing capabilities in relayer-cli/src/utils/relay.ts.
Enhanced integration tests in contracts/test/integration/ArbToEth.ts for better coverage.
Updated the watcherArbToEth.ts to improve claim monitoring and dispute resolution.

The following files were skipped due to too many changes: validator-cli/src/ArbToEth/watcherArbToEth.ts, contracts/deployments/arbitrumSepolia/VeaInboxArbToEthTestnet.json, contracts/deployments/sepolia/VeaOutboxArbToEthTestnet.json

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

New Features
- Introduced a new smart contract deployment for VeaInboxArbToEth on the Arbitrum Sepolia testnet.
- Added new environment variables for enhanced configuration options, including RPC endpoints for Chiado and Arbitrum Sepolia testnets.
- Implemented a new script for starting the testnet relayer.
- Added the ShutdownManager class to manage shutdown states in the relayer.
- Enhanced relaying functionality with improved batching and error handling.
Bug Fixes
- Improved error messages and handling in the integration tests and various functions.
Documentation
- Updated environment variable declarations for better clarity and organization.
Chores
- Updated dependencies and scripts in the package configuration files.
- Added new utility functions and improved existing ones for better modularization and clarity.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new smart contract, VeaInboxArbToEth, deployed on the Arbitrum Sepolia testnet, along with its deployment details in a JSON file. Integration tests for the ArbToEth contract are updated to reflect new epoch timing parameters. Additionally, several utility functions and configuration scripts in the validator-cli and relayer-cli projects are modified or added to support enhanced functionality for message relaying and monitoring. New environment variables are introduced for configuration, and existing files are updated to improve clarity and maintainability.

Changes

File Path	Change Summary
`contracts/deployments/arbitrumSepolia/VeaInboxArbToEthTestnet.json`	New deployment file for `VeaInboxArbToEth` contract with address, ABI, and event details.
`contracts/test/integration/ArbToEth.ts`	Updated epoch and challenge periods; modified error messages and test assertions.
`validator-cli/package.json`	Updated `@arbitrum/sdk` dependency; added new script for Sepolia testnet.
`validator-cli/src/ArbToEth/watcherArbToEth.ts`	Revised `watch` function; updated provider methods and added new utility functions.
`validator-cli/src/utils/arbMsgExecutor.ts`	Introduced `messageExecutor` and `getMessageStatus` functions for processing messages.
`relayer-cli/package.json`	Added script for starting the testnet relayer.
`relayer-cli/src/devnetRelayExample.ts`	Introduced new `start` function; restructured initialization logic.
`relayer-cli/src/utils/ethers.ts`	Updated factory imports and function signatures for Vea inbox and outbox connections.
`relayer-cli/src/utils/relay.ts`	Enhanced relaying functions for dynamic batching and error handling.
`relayer-cli/src/utils/relayerHelpers.ts`	Added `ShutdownManager` class; updated `initialize` and `updateStateFile` functions.
`validator-cli/.env.dist`	Added new RPC endpoints and address variables for testnet configurations.
`relayer-cli/.env.dist`	Introduced `DEVNET_SENDER` and `VEAOUTBOX_CHAIN_ID` environment variables.
`relayer-cli/src/consts/bridgeRoutes.ts`	Updated `IBridge` interface; added new getter functions for epoch period and bridge config.
`relayer-cli/src/state/11155111.json`	Deleted file containing timestamp and nonce data.
`relayer-cli/src/testnetRelayer.ts`	New file with `start` function for managing message relaying on test network.

Possibly related PRs

#324: The changes in contracts/test/integration/ArbToEth.ts involve updates to the EPOCH_PERIOD and CHALLENGE_PERIOD, which are relevant to the epoch-related functions in the VeaInboxArbToEth contract introduced in the main PR.
#325: The introduction of the VeaInboxArbToGnosis contract in this PR includes similar functions and events as those in the VeaInboxArbToEth contract, such as sendMessage, saveSnapshot, and sendSnapshot, indicating a related focus on cross-chain messaging functionality.

Suggested labels

Package: Contracts

Suggested reviewers

alcercu
jaybuidl

Poem

🐰 In the meadow, contracts bloom,
With messages sent, dispelling the gloom.
Epochs and snapshots, all in a dance,
On Sepolia's testnet, they take their chance.
With each relay, a new tale to weave,
In the world of code, we believe! 🌼

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

netlify[bot] commented 1 month ago

Deploy Preview for veascan ready!

Name	Link
Latest commit	63c93b0cfd1e6b77ac9cd2ab2ec5baf7f25b5c7f
Latest deploy log	https://app.netlify.com/sites/veascan/deploys/670e4cd62d41ba0008510090
Deploy Preview	https://deploy-preview-344--veascan.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 1 month ago

Deploy Preview for veascan ready!

Name	Link
Latest commit	da4383ce39e6348de8dc9b3f12d222b09cd487ac
Latest deploy log	https://app.netlify.com/sites/veascan/deploys/6746a92f4bab880008702a3b
Deploy Preview	https://deploy-preview-344--veascan.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mani99brar commented 3 weeks ago

@coderabbitai summary

coderabbitai[bot] commented 3 weeks ago

:white_check_mark: Actions performed

Summary regeneration triggered.

sonarcloud[bot] commented 5 days ago

Quality Gate passed

Issues
16 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.6% Duplication on New Code

See analysis details on SonarQube Cloud

kleros / vea