axone-protocol / axoned

⛓️ Axone blockchain 💫
https://axone.xyz
Apache License 2.0
162 stars 121 forks source link

Fix/logic gas limit #708

Closed amimart closed 1 month ago

amimart commented 1 month ago

Closes https://github.com/axone-protocol/axoned/issues/706

Details

Remove the max_gas limit in the logic module parameters, gas consumption are now constraints or not by the given sdk.Context.

I took the opportunity to reduce the gas consumption by decreasing the number of access to the module parameters during the initialisation of the prolog interpreter.

I also propose to change the behaviour of the max_result_count limitation by returning an error in case a ask query requests a higher number of results as it is invalid.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes primarily focus on improving the handling of gas consumption in the module, streamlining parameter management, and enhancing documentation. Key modifications include the removal of the max_gas parameter, updates to gas usage calculations, and refinements to the logic for executing queries. These adjustments aim to simplify resource management and provide clearer guidance for users, addressing concerns about gas limits in transaction contexts.

Changes

Files Change Summary
proto/logic/docs.yaml Enhanced documentation on query-gas-limit for managing gas usage.
proto/logic/v1beta2/params.proto Removed max_gas field from Limits message, indicating a shift in gas management.
x/logic/keeper/features/*.feature Updated expected gas_used values across multiple feature files.
x/logic/keeper/grpc_query_ask.go Replaced gas meter handling with a "safe" implementation, refactored limit checks.
x/logic/keeper/grpc_query_ask_test.go Added maxSize parameter to TestGRPCAsk, improved error handling.
x/logic/keeper/interpreter.go Removed limits function, updated execute method to accept params.
x/logic/types/genesis.go Removed constant DefaultIndex.
x/logic/types/params.go Removed KeyInterpreter, KeyLimits, DefaultBootstrap, and WithMaxGas.
x/logic/types/params_test.go Simplified TestValidateParams by removing gas limit configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RPC as RPC Provider
    participant Keeper as Logic Keeper

    User->>RPC: Send Ask Query
    RPC->>Keeper: Execute Query with Safe Gas Meter
    Keeper->>Keeper: Validate Limits
    Keeper->>RPC: Return Results
    RPC->>User: Deliver Response

Assessment against linked issues

Objective Addressed Explanation
Remove max_gas to prevent transaction gas limit override (#[706])
Enable unlimited gas consumption by default (#[706])
Maintain gas consumption tracking without max_gas (#[706])

Poem

🐰 In the meadow, changes spry,
Gas limits gone, we leap and fly!
Queries now can dance and play,
With safer paths to guide the way.
Hooray for tweaks, so bright and true,
A joyful hop, for me and you! 🌸


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 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.
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #708      +/-   ##
==========================================
+ Coverage   54.23%   54.37%   +0.14%     
==========================================
  Files          74       73       -1     
  Lines        2906     2893      -13     
==========================================
- Hits         1576     1573       -3     
+ Misses       1234     1226       -8     
+ Partials       96       94       -2     
Files Coverage Δ
x/logic/keeper/grpc_query_ask.go 91.17% <100.00%> (+11.17%) :arrow_up:
x/logic/keeper/interpreter.go 94.73% <100.00%> (+1.63%) :arrow_up:
x/logic/types/genesis.go 100.00% <ø> (ø)
x/logic/types/params.go 94.36% <ø> (-0.38%) :arrow_down: