polymerdao / monomer

Build Cosmos SDK applications on the OP Stack.
http://monomer.nethermind.io/
Apache License 2.0
23 stars 16 forks source link

Fix op-proposer behavior in e2e tests #196

Closed natebeauregard closed 1 month ago

natebeauregard commented 1 month ago

Closes https://github.com/polymerdao/monomer/issues/190

Best to review commit by commit to make the review as easy as possible

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request introduces significant enhancements to the MonomerClient and OPStack functionalities, including the addition of a gethclient field and a new GetProof method for retrieving account proofs. Changes to transaction management streamline the configuration process, and test coverage for the GetProof method is improved. The eth/get_proof.go file is refactored to support flexible block references, and new struct types for results are introduced in the API. Overall, the modifications aim to improve modularity, usability, and maintainability.

Changes

Files Change Summary
e2e/clients.go, e2e/op_stack.go - Added gethclient field and GetProof method to MonomerClient.
- Introduced newTxManagerConfig method for transaction manager configuration in OPStack.
- Enhanced private key retrieval using hdwallet.
eth/eth_test.go - Updated TestGetProof to use rpc.BlockNumberOrHash for the block number parameter.
eth/get_proof.go - Refactored GetProof method to accept rpc.BlockNumberOrHash.
- Introduced getState method for block state retrieval.
- Migrated AccountResult and StorageResult types to ethapi package.
eth/internal/ethapi/api.go - Added AccountResult and StorageResult structs for structured data representation.
go.mod - Added dependency on github.com/ethereum-optimism/go-ethereum-hdwallet at version v0.1.3.

Sequence Diagram(s)

sequenceDiagram
    participant Client as MonomerClient
    participant Geth as gethclient.Client
    participant ProofProvider as ProofProvider
    participant StateDB as StateDB

    Client->>Geth: Initialize with rpc.Client
    Client->>ProofProvider: Call GetProof(address, keys, blockNrOrHash)
    ProofProvider->>StateDB: Retrieve state for blockNrOrHash
    StateDB-->>ProofProvider: Return state data
    ProofProvider-->>Client: Return AccountResult, StorageResult

Assessment against linked issues

Objective Addressed Explanation
Fix proposer config in e2e test (#190)
Add test coverage for eth_getProof (#195)
Return pointer type from ProofProvider.getState (#110)

Possibly related issues

Possibly related PRs

Poem

🐇 In the meadow where bunnies play,
New features hop in, brightening the day.
With proofs and clients, oh what a sight,
Code's now more clever, and testing feels right!
Let's dance with joy, for changes are here,
Hopping along, spreading good cheer! 🌼

[!TIP]

New features Walkthrough comment now includes: - Possibly related PRs: A list of potentially related PRs to help you recall past context. - Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file. Notes: - Please share any feedback in the [discussion post](https://discordapp.com/channels/1134356397673414807/1282535539299323995) on our Discord. - Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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