dymensionxyz / dymension

Dymension Hub
https://dymension.xyz
Other
363 stars 327 forks source link

feat(eibc): add filter by fulfillment to demand orders #929

Closed zale144 closed 3 weeks ago

zale144 commented 3 weeks ago

Description

I'm not sure I like that the args have to be ordered


Closes #831

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow-up issues.

PR review checkboxes:

I have...

SDK Checklist

Full security checklist here

----;

For Reviewer:

---;

After reviewer approval:

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The updates add a FulfillmentState enum for demand orders, allowing queries based on fulfillment status (FULFILLED, UNFULFILLED). Changes affect proto definitions, command-line interface, gRPC queries, and relevant test cases. This extension enhances the granularity of order status queries, streamlining filtering for demand order fulfillment states in the eIBC module.

Changes

File Path Change Summary
proto/dymension/eibc/query.proto Added FulfillmentState enum and integrated fulfillment_state field in QueryDemandOrdersByStatusRequest.
x/eibc/client/cli/query_command_orders.go Extended list-demand-orders CLI command to include fulfillment parameter for filtering.
x/eibc/keeper/grpc_query.go Introduced isFulfillmentState function to filter demand orders based on fulfillment state.
x/eibc/keeper/grpc_query_test.go Updated tests to include fulfillment state checks and added cases for FULFILLED and UNFULFILLED.
x/eibc/keeper/keeper.go Modified control flow with an outer: label in ListDemandOrdersByStatus function.

Sequence Diagram(s)

Query Demand Orders by Fulfillment State

sequenceDiagram
    participant User
    participant CLI
    participant Keeper
    participant QueryServer

    User->>CLI: Execute `list-demand-orders status [params]`
    CLI->>QueryServer: ListDemandOrdersByStatusRequest
    QueryServer->>Keeper: Validate request and filter by FulfillmentState
    Keeper->>QueryServer: Return filtered DemandOrders
    QueryServer->>CLI: Return response
    CLI->>User: Display DemandOrders

Assessment against linked issues

Objective Addressed Explanation
eIBC should allow queries by fulfillment state (#831)

Poem

In fields of code where logic plays,
New states emerge in querying ways,
Fulfillment now can shine so bright,
In orders' statuses, clear as light.
Our CLI dances, filters in place,
While tests ensure there's no disgrace.
Here's to code that strides ahead,
With eIBC, well-fed! 🐇✨


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