chore: adding query for all auctions with rewards #2564

gsk967 · 2024-06-27T11:17:09Z

Description

adding new grpc-web get api for return all auctions with rewards and bids

{
  "auctions": [
    {
      "id": 1,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:19:47.034661Z"
    },
    {
      "id": 2,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:21:47.399658Z"
    },
    {
      "id": 3,
      "bidder": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "bid": {
        "denom": "uumee",
        "amount": "50000000"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:23:47.747732Z"
    },
    {
      "id": 4,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:25:48.088442Z"
    },
    {
      "id": 5,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:27:48.537993Z"
    },
    {
      "id": 6,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:29:48.956311Z"
    },
    {
      "id": 7,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:31:49.321515Z"
    },
    {
      "id": 8,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:33:49.794959Z"
    },
    {
      "id": 9,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T13:35:50.321163Z"
    },
    {
      "id": 10,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "3"
        }
      ],
      "ends_at": "2024-06-28T13:38:28.377823Z"
    },
    {
      "id": 11,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "3"
        }
      ],
      "ends_at": "2024-06-28T13:40:28.750212Z"
    },
    {
      "id": 12,
      "bidder": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "bid": {
        "denom": "uumee",
        "amount": "50000000"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "3"
        }
      ],
      "ends_at": "2024-06-28T13:42:29.594468Z"
    },
    {
      "id": 13,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:44:30.042558Z"
    },
    {
      "id": 14,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:46:30.766057Z"
    },
    {
      "id": 15,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:48:31.351419Z"
    },
    {
      "id": 16,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:50:32.352737Z"
    },
    {
      "id": 17,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:52:32.417297Z"
    },
    {
      "id": 18,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:54:33.374402Z"
    },
    {
      "id": 19,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:56:34.394Z"
    },
    {
      "id": 20,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T13:58:35.016056Z"
    },
    {
      "id": 21,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T14:00:35.960621Z"
    },
    {
      "id": 22,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "1"
        }
      ],
      "ends_at": "2024-06-28T14:02:36.606983Z"
    },
    {
      "id": 23,
      "bidder": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "bid": {
        "denom": "uumee",
        "amount": "50000000"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "2"
        }
      ],
      "ends_at": "2024-06-28T14:04:36.749320Z"
    },
    {
      "id": 24,
      "bidder": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "bid": {
        "denom": "uumee",
        "amount": "50000000"
      },
      "rewards": [],
      "ends_at": "2024-06-28T14:06:36.881209Z"
    },
    {
      "id": 25,
      "bidder": "umee1y6xz2ggfc0pcsmyjlekh0j9pxh6hk87ymc9due",
      "bid": {
        "denom": "uumee",
        "amount": "60000000"
      },
      "rewards": [],
      "ends_at": "2024-06-28T14:08:37.236519Z"
    },
    {
      "id": 26,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T14:10:37.365598Z"
    },
    {
      "id": 27,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T14:12:37.528126Z"
    },
    {
      "id": 28,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [],
      "ends_at": "2024-06-28T14:14:37.624987Z"
    },
    {
      "id": 29,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "20"
        }
      ],
      "ends_at": "2024-06-28T14:20:25.951961Z"
    },
    {
      "id": 30,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "20"
        }
      ],
      "ends_at": "2024-06-28T14:22:26.445218Z"
    },
    {
      "id": 31,
      "bidder": "",
      "bid": {
        "denom": "",
        "amount": "0"
      },
      "rewards": [
        {
          "denom": "uumee",
          "amount": "20"
        }
      ],
      "ends_at": "2024-06-28T14:24:26.643708Z"
    }
  ],
  "pagination": {
    "next_key": null,
    "total": "0"
  }
}

Author Checklist

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.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

Summary by CodeRabbit

New Features
- Introduced reward auction querying capabilities with two new RPC methods: RewardsAuctions and RewardsAuction.
- Added commands to query all reward auctions using the CLI, with support for pagination.
- Expanded backend functionality to retrieve and display auction details and associated bids.

coderabbitai · 2024-06-27T11:17:14Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce enhanced querying capabilities in the Umee auction module by adding two new RPC methods: RewardsAuctions and RewardsAuction. These methods, along with associated message types and HTTP endpoints, provide users the ability to query and retrieve detailed information on reward auctions and specific reward auction details. The CLI and keeper functionalities have been updated to support these new querying options.

Changes

File(s)	Change Summary
`proto/umee/auction/v1/query.proto`	Imported `pagination.proto` and added new RPC methods `RewardsAuctions` and `RewardsAuction`. Added message types to support these methods.
`x/auction/client/cli/query.go`	Introduced the `RewardsAuctions()` function to setup CLI command for querying rewards auctions.
`x/auction/keeper/grpc_query.go`	Added the `RewardsAuctions` function in the `Querier` struct to retrieve all auctions with bids and rewards. Imported necessary libraries.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant gRPC Server
    participant Keeper

    User->>CLI: Run rewards auctions query
    CLI->>gRPC Server: Request /umee/auction/v1/rewards
    gRPC Server->>Keeper: Invoke RewardsAuctions method
    Keeper-->>gRPC Server: Return auction details with rewards
    gRPC Server-->>CLI: Send response with rewards auctions data
    CLI-->>User: Display rewards auctions result

Poem

In the world of code, a tale to see,
Auctions now with rewards to glean,
New queries, fresh and bright,
Bring clarity to auction's light. 🌟
Code Rabbits hop and cheer,
For updates that are dear,
Through CLI and gRPC, let auctions appear! 🐇📜✨

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- 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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-06-27T11:22:40Z

Codecov Report

Attention: Patch coverage is 0% with 53 lines in your changes missing coverage. Please review.

Project coverage is 62.53%. Comparing base (7f05ad4) to head (54cacd6).
Report is 509 commits behind head on main.

❗ Current head 54cacd6 differs from pull request most recent head 28213b3

Please upload reports for the commit 28213b3 to get more accurate results.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #2564       +/-   ##
===========================================
- Coverage   75.38%   62.53%   -12.86%     
===========================================
  Files         100      275      +175     
  Lines        8025    16010     +7985     
===========================================
+ Hits         6050    10012     +3962     
- Misses       1589     5224     +3635     
- Partials      386      774      +388

Files	Coverage Δ
x/auction/client/cli/query.go	`0.00% <0.00%> (ø)`
x/auction/keeper/grpc_query.go	`0.00% <0.00%> (ø)`

... and 239 files with indirect coverage changes

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d4d2adc and 28213b3.

Files ignored due to path filters (2)

x/auction/query.pb.go is excluded by !**/*.pb.go
x/auction/query.pb.gw.go is excluded by !**/*.pb.gw.go

Files selected for processing (3)

proto/umee/auction/v1/query.proto (3 hunks)
x/auction/client/cli/query.go (2 hunks)
x/auction/keeper/grpc_query.go (2 hunks)

Additional comments not posted (6)

proto/umee/auction/v1/query.proto (4)

10-10: Approved the addition of pagination import.

This is essential for supporting pagination in the new RPC methods.

25-28: Approved the addition of the RewardsAuctions RPC method.

The method is correctly defined and follows the appropriate conventions for gRPC services.

57-61: Approved the message definition for QueryRewardsAuctions.

The structure is appropriate and includes necessary pagination support.

63-68: Approved the message definition for QueryRewardsAuctionsResponse.

The response structure is well-defined, including both the list of auctions and the pagination response.

x/auction/client/cli/query.go (1)

85-111: Approved the new CLI command for querying all rewards auctions.

The command is well-implemented with appropriate flags and error handling.

x/auction/keeper/grpc_query.go (1)

60-105: Approved the server-side implementation for querying all rewards auctions.

The function correctly implements pagination and handles errors appropriately.

adding query for all auctions with rewards

54cacd6

gsk967 and others added 2 commits June 28, 2024 19:51

fix: fix the results on query

c522b68

Merge branch 'main' into sai/add_rewards_auctions_query

28213b3

gsk967 marked this pull request as ready for review June 28, 2024 14:21

gsk967 requested a review from a team as a code owner June 28, 2024 14:21

gsk967 added the skip-e2e-test Skip the e2e tests label Jun 28, 2024

gsk967 requested review from hoffmabc and robert-zaremba June 28, 2024 14:21

coderabbitai bot reviewed Jun 28, 2024

View reviewed changes

robert-zaremba approved these changes Jun 30, 2024

View reviewed changes

hoffmabc approved these changes Jun 30, 2024

View reviewed changes

gsk967 added this pull request to the merge queue Jul 1, 2024

Merged via the queue into main with commit e8cb7b0 Jul 1, 2024
26 of 27 checks passed

gsk967 deleted the sai/add_rewards_auctions_query branch July 1, 2024 08:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: adding query for all auctions with rewards #2564

chore: adding query for all auctions with rewards #2564

gsk967 commented Jun 27, 2024 •

edited

Loading

coderabbitai bot commented Jun 27, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Jun 27, 2024 •

edited

Loading

coderabbitai bot left a comment

chore: adding query for all auctions with rewards #2564

chore: adding query for all auctions with rewards #2564

Conversation

gsk967 commented Jun 27, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Jun 27, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Jun 27, 2024 • edited Loading

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

gsk967 commented Jun 27, 2024 •

edited

Loading

coderabbitai bot commented Jun 27, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jun 27, 2024 •

edited

Loading