search

PeggyJV / steward

Eth Contract Monitor
Apache License 2.0
31 stars 18 forks source link

feat:invalidation scope in ScheduleCork response #239

Closed cbrit closed 3 months ago

cbrit commented 10 months ago

This is a feature needed for the proposed relayer changes to allow strategists to request gas limits.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes involve significant updates to several components, primarily focusing on enhancing address validation and transaction handling. Key modifications include the introduction of a new invalidation_scope field in the ScheduleResponse, and improvements to the to_checksum_address function, which now returns additional data. These alterations improve data processing capabilities, provide more context for transaction invalidation, and ensure better error handling across various modules.

Changes

File Change Summary
proto/steward/v4/steward.proto Added a new field invalidation_scope to ScheduleResponse, enhancing transaction invalidation context.
src/cellars.rs, src/cork.rs, src/cork/client.rs, src/pubsub.rs Updated to_checksum_address function to return a tuple, altering the handling of cellar_id in related functions. Improved error handling and control flow.
src/cork.rs Introduced a new invalidation_scope function for calculating the scope based on contract address and encoded call.
src/cork.rs Updated ContractCallService to include invalidation_scope in ScheduleResponse, improving response context.
src/cork.rs Added tests for the new invalidation_scope function to ensure correctness.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between d56a5c74febdcc528c72d8805f78a2f1a2b12270 and 2db667e349d16e7b4e83fb315bfef9afb1a31de2.
Files ignored due to path filters (3) * `crates/steward-proto/src/gen/descriptor.bin` is excluded by `!**/*.bin`, `!**/*.bin`, `!**/gen/**` * `crates/steward-proto/src/gen/steward.v4.rs` is excluded by `!**/gen/**` * `src/gen/proto/descriptor.bin` is excluded by `!**/*.bin`, `!**/*.bin`, `!**/gen/**`
Files selected for processing (6) * hash_proto (1 hunks) * proto/steward/v4/steward.proto (1 hunks) * src/cellars.rs (3 hunks) * src/cork.rs (4 hunks) * src/cork/client.rs (2 hunks) * src/pubsub.rs (1 hunks)
Files skipped from review due to trivial changes (1) * hash_proto
Additional comments not posted (10)
proto/steward/v4/steward.proto (1)
`71-72`: **Ensure the new field `invalidation_scope` is correctly documented and integrated.** The new field `invalidation_scope` is added to the `ScheduleResponse` message. Ensure that this field is correctly documented and integrated into the system.
src/cork/client.rs (2)
`49-52`: **Verify the handling of the tuple returned by `to_checksum_address`.** The `to_checksum_address` function now returns a tuple. Ensure that the unused second value is handled appropriately and does not introduce any issues. --- `64-67`: **Verify the handling of the tuple returned by `to_checksum_address`.** The `to_checksum_address` function now returns a tuple. Ensure that the unused second value is handled appropriately and does not introduce any issues.
src/pubsub.rs (1)
`92-94`: **Verify the handling of the tuple returned by `to_checksum_address`.** The `to_checksum_address` function now returns a tuple. Ensure that the unused second value is handled appropriately and does not introduce any issues.
src/cork.rs (4)
`306-311`: **LGTM!** The test case for `invalidation_scope` is well-written and ensures the correctness of the function. --- `50-50`: **Ensure proper handling of `to_checksum_address` output.** The `to_checksum_address` function now returns a tuple. Ensure that both elements of the tuple are correctly utilized.
Verification successful --- **Ensure proper handling of `to_checksum_address` output.** The `to_checksum_address` function's tuple output is correctly handled in all instances found. Each usage assigns the tuple to variables and uses the first element or explicitly ignores the second element. - `src/pubsub.rs`: Line 50 - `src/cork.rs`: Line 50 - `src/cellars.rs`: Line 50 - `src/cork/client.rs`: Line 50
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all usages of `to_checksum_address` to ensure they handle the tuple output correctly. # Test: Search for the function usage. Expect: Proper handling of the tuple elements. rg --type rust -A 5 $'to_checksum_address' ``` Length of output: 3380
--- `275-284`: **LGTM! But verify the function usage in the codebase.** The code changes are approved. However, ensure that all function calls to `invalidation_scope` match the new signature.
Verification successful --- The function `invalidation_scope` is used in multiple places in `src/cork.rs`. The occurrences in the output appear to be consistent with the new signature. The occurrence in `crates/steward-proto/src/gen/steward.v4.rs` is a field in a struct and not related to the function. **All function calls to `invalidation_scope` match the new signature.** - `src/cork.rs`: Function usage and test case are consistent with the new signature.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all function calls to `invalidation_scope` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type rust -A 5 $'invalidation_scope' ``` Length of output: 1727
--- `95-105`: **LGTM! But verify the function usage in the codebase.** The code changes are approved. However, ensure that all function calls to `invalidation_scope` match the new signature.
Verification successful --- **Verification successful!** All function calls to `invalidation_scope` match the new signature. - `src/cork.rs`: The calls to `invalidation_scope` correctly use the new signature.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all function calls to `invalidation_scope` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type rust -A 5 $'invalidation_scope' ``` Length of output: 1727
src/cellars.rs (2)
Line range hint `397-409`: **LGTM! But verify the function usage in the codebase.** The code changes are approved. However, ensure that all function calls to `to_checksum_address` match the new signature.
Verification successful --- **Function usage verification complete and correct** The function `to_checksum_address` is used in multiple files, and all instances correctly handle the new tuple return type by destructuring the result into two variables. - `src/cellars.rs`: Line 403 - `src/cork.rs`: Line 397 - `src/pubsub.rs`: Line 403 - `src/cork/client.rs`: Lines 397, 403
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all function calls to `to_checksum_address` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type rust -A 5 $'to_checksum_address' ``` Length of output: 3380
--- `375-375`: **Ensure proper handling of `to_checksum_address` output.** The `to_checksum_address` function now returns a tuple. Ensure that both elements of the tuple are correctly utilized.
Verification successful --- **Ensure proper handling of `to_checksum_address` output.** The `to_checksum_address` function now returns a tuple, and the code correctly handles both elements of the tuple across different files. The first element is always used, and the second element is either utilized or explicitly ignored as needed. - `src/pubsub.rs`: Correctly handles the tuple. - `src/cellars.rs`: Correctly handles the tuple. - `src/cork.rs`: Correctly handles the tuple. - `src/cork/client.rs`: Correctly handles the tuple.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify all usages of `to_checksum_address` to ensure they handle the tuple output correctly. # Test: Search for the function usage. Expect: Proper handling of the tuple elements. rg --type rust -A 5 $'to_checksum_address' ``` Length of output: 3380
--- 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): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.