search

open-ibc / vibc-core-smart-contracts

Apache License 2.0
29 stars 23 forks source link

Raunak/sequencer signer light client #199

Closed RnkSngh closed 1 month ago

RnkSngh commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces several modifications across various smart contracts and their corresponding bindings. Key changes include the addition of new functions such as getLightClientType and consensusStates in the DummyLightClient contract and its Go bindings; updates to the ABI; and the introduction of new contracts like SequencerSignatureVerifier and SequencerSoloClient. Additionally, existing contracts have been updated to enhance proof loading mechanisms and improve testing capabilities for state updates and sequencer signatures.

Changes

File Path Change Summary
bindings/go/dummylightclient/DummyLightClient.go Added getLightClientType and consensusStates functions to the DummyLightClient ABI and Go bindings; updated method signatures.
contracts/core/SequencerSignatureVerifier.sol Introduced a new contract for verifying sequencer signatures with methods for state update verification.
contracts/core/SequencerSoloClient.sol Added a light client contract for sequencer operations with multiple key functions for state management.
contracts/interfaces/ISignatureVerifier.sol Introduced a new interface for signature verification specific to light clients.
contracts/utils/DummyLightClient.sol Added getLightClientType function to retrieve the light client type.
src/evm/contracts/DummyLightClient.ts Updated interface and contract to include getLightClientType and consensusStates methods.
src/evm/contracts/factories/DummyLightClient__factory.ts Added consensusStates and getLightClientType to the factory ABI.
test/Dispatcher/Dispatcher.multiclient.sol Updated proof loading to include specific light client addresses.
test/Dispatcher/Dispatcher.proof.t.sol Enhanced IBC protocol tests with new channels and connection logic.
test/Fork/Dispatcher.deploy.t.sol Modified proof loading to include light client address.
test/SequencerVerifier.t.sol Introduced tests for the sigVerifier contract focusing on sequencer signature verification.
test/utils/Dispatcher.base.t.sol Updated proof loading method to accept different light client addresses.
test/utils/Proof.base.t.sol Added state variables for sequencer address and private key.
test/utils/SigningClient.base.t.sol Introduced a new contract for testing signing processes with sequencer interactions.

Possibly related PRs

Suggested labels

bug

Poem

🐇 In the meadow where the code does play,
New functions hop and dance all day.
Light clients prance with types so bright,
Sequencers sing, bringing joy and light.
With every change, our code takes flight,
A rabbit's cheer for a future so bright! 🌟

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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
i-norden commented 2 months ago

This also made me realize that I don't think we need the L1StateRoot in the SignedData.

When doing origin consistency check in the future we will do it by either proving that the L1BlockHash in the SignedData is the same blockHash that the destination chain has in its L1BlockInfo contract or that it is an ancestor of the destination chain L1BlockInfo (provide headers linking back from the L1BlockInfo in destination chain to the L1BlockHash in peptide's SignedData) or by providing that the EIP-4788 contract on the destination EVM chain has as a member a beacon root that commits to the L1BlockHash in the SignedData).

I don't think we need to access the L1StateRoot in either case.

RnkSngh commented 2 months ago

sure thing, can get rid of the L1StateRoot

RnkSngh commented 1 month ago

merging this to unblock @nicopernas