open-ibc / vibc-core-smart-contracts

Apache License 2.0
30 stars 23 forks source link

Raunak/sequencer client l1 origin check #227

Closed RnkSngh closed 1 month ago

RnkSngh commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request introduces significant changes to the contracts related to the SequencerSoloClient and SequencerSignatureVerifier. The OptimisticProofVerifier contract has been renamed to SequencerSignatureVerifier, reflecting its new purpose of verifying ECDSA signatures from a sequencer. The SequencerSoloClient contract has been updated to include new error handling, additional parameters, and validation logic for L1 block origins. New methods have been added to facilitate interaction with the L1 block provider, and corresponding tests have been introduced to validate these changes.

Changes

File Change Summary
contracts/core/SequencerSignatureVerifier.sol Contract renamed from OptimisticProofVerifier to SequencerSignatureVerifier. Documentation updated; no changes to internal logic or functionality.
contracts/core/SequencerSoloClient.sol New import for L1Block, added InvalidL1Origin error type, updated constructor to accept L1Block, modified updateClient function to include L1 block validation, and introduced _updateClient function.
src/evm/contracts/SequencerSoloClient.ts Added l1BlockProvider method to SequencerSoloClientInterface and SequencerSoloClient, updated getFunction, encodeFunctionData, and decodeFunctionResult methods.
src/evm/contracts/factories/SequencerSignatureVerifier__factory.ts Updated bytecode for SequencerSignatureVerifier, no changes to ABI or constructor parameters.
src/evm/contracts/factories/SequencerSoloClient__factory.ts Updated constructor and method signatures to include _l1BlockProvider, added l1BlockProvider method, and introduced InvalidL1Origin error type.
test/SequencerSoloClient.t.sol Added OptimisticLightClientWithRealVerifierTest contract to validate SequencerSoloClient functionality with tests for valid and invalid states.
test/payload/l1_block_ancestor.json New JSON file added for structured JSON-RPC response representing a blockchain block.
test/payload/l1_block_child.json New JSON file added for structured JSON-RPC response related to a blockchain block.
test/utils/Dispatcher.base.t.sol Updated instantiation of sequencerLightClient to include l1BlockProvider parameter in constructor.
test/utils/SigningClient.base.t.sol Introduced new state variables and public functions for handling L1 block data, updated constructor to initialize new variables.
bindings/go/sequencersoloclient/SequencerSoloClient.go Updated ABI to include new constructor parameter _l1BlockProvider and added l1BlockProvider function.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

Poem

🐇 In the meadow where contracts play,
A new verifier hops in today.
With L1 checks and signatures bright,
Sequencer's path is clearer in sight.
Hooray for changes, let’s dance and cheer,
For a future where blocks are crystal clear! 🌟


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 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` 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://coderabbit.ai/docs) 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.