feat: reards auction proto #2469

robert-zaremba · 2024-03-22T13:29:46Z

Description

Summary by CodeRabbit

New Features
- Enhanced the rewards auction feature, enabling users to bid on protocol rewards.
- Improved visibility of the genesis state and rewards parameters for auctions.
- Enhanced events to display detailed results post-auction, showcasing the highest bidder and auctioned tokens.

coderabbitai · 2024-03-22T13:29:53Z

Walkthrough

The recent updates introduce a rewards auction mechanism within the umee.auction.v1 package. These changes encompass the establishment of auction parameters, the genesis state of the auction module, event definitions for auction results, and transaction protocols for bidding and parameter adjustments. This enhancement facilitates a structured approach to protocol reward distributions through auctions.

Changes

File Path	Change Summary
`.../auction/v1/auction.proto`	Introduces `RewardsParams` for auction parameters.
`.../auction/v1/genesis.proto`	Defines `GenesisState` with auction genesis details.
`.../auction/v1/events.proto`	Adds `EventRewardsAuctionResult` for auction result events.
`.../auction/v1/tx.proto`	Introduces transaction messages for bidding and updating rewards parameters.

🐰✨
In the world of code, where auctions are bold,
A rabbit hopped in, with a story untold.
"To bid or not," it pondered with glee,
For rewards aplenty, as far as eyes see.
With a hop and a skip, it went on its way,
Celebrating the changes, in the blockchain fray.
🌟🎉

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-tests 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 tests 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 tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 8

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6dccda9 and cd38047.

Files ignored due to path filters (5)

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

Files selected for processing (5)

proto/umee/auction/v1/auction.proto (1 hunks)
proto/umee/auction/v1/genesis.proto (1 hunks)
proto/umee/auction/v1/query.proto (1 hunks)
proto/umee/auction/v1/tx.proto (1 hunks)
proto/umee/ugov/v1/tx.proto (1 hunks)

Files skipped from review due to trivial changes (1)

proto/umee/ugov/v1/tx.proto

Additional comments: 2

proto/umee/auction/v1/auction.proto (1)

9-15: LGTM! The RewardsParams message is clearly defined and well-documented.

proto/umee/auction/v1/genesis.proto (1)

13-19: LGTM! The GenesisState message is clearly defined and well-documented, with appropriate use of gogoproto.nullable = false for non-nullable fields.

proto/umee/auction/v1/query.proto

proto/umee/auction/v1/tx.proto

proto/umee/auction/v1/auction.proto

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cd38047 and 8963b1a.

Files ignored due to path filters (2)

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

Files selected for processing (2)

proto/umee/auction/v1/query.proto (1 hunks)
proto/umee/auction/v1/tx.proto (1 hunks)

Files skipped from review as they are similar to previous changes (2)

proto/umee/auction/v1/query.proto
proto/umee/auction/v1/tx.proto

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8963b1a and 8dee4f2.

Files ignored due to path filters (2)

x/auction/genesis.pb.go is excluded by: !**/*.pb.go
x/auction/tx.pb.go is excluded by: !**/*.pb.go

Files selected for processing (2)

proto/umee/auction/v1/genesis.proto (1 hunks)
proto/umee/auction/v1/tx.proto (1 hunks)

Files skipped from review as they are similar to previous changes (2)

proto/umee/auction/v1/genesis.proto
proto/umee/auction/v1/tx.proto

codecov · 2024-03-22T16:46:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.38%. Comparing base (7f05ad4) to head (75c4953).
Report is 416 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2469      +/-   ##
==========================================
- Coverage   75.38%   69.38%   -6.01%     
==========================================
  Files         100      185      +85     
  Lines        8025    10909    +2884     
==========================================
+ Hits         6050     7569    +1519     
- Misses       1589     2712    +1123     
- Partials      386      628     +242

see 178 files with indirect coverage changes

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8dee4f2 and d6de406.

Files ignored due to path filters (1)

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

Files selected for processing (1)

proto/umee/auction/v1/query.proto (1 hunks)

Files skipped from review as they are similar to previous changes (1)

proto/umee/auction/v1/query.proto

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d6de406 and a3e3a8f.

Files ignored due to path filters (2)

x/auction/auction.pb.go is excluded by: !**/*.pb.go
x/auction/genesis.pb.go is excluded by: !**/*.pb.go

Files selected for processing (2)

proto/umee/auction/v1/auction.proto (1 hunks)
proto/umee/auction/v1/genesis.proto (1 hunks)

Files skipped from review as they are similar to previous changes (2)

proto/umee/auction/v1/auction.proto
proto/umee/auction/v1/genesis.proto

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a3e3a8f and f0e86d8.

Files ignored due to path filters (3)

x/auction/events.pb.go is excluded by: !**/*.pb.go
x/auction/genesis.pb.go is excluded by: !**/*.pb.go
x/auction/tx.pb.go is excluded by: !**/*.pb.go

Files selected for processing (3)

proto/umee/auction/v1/events.proto (1 hunks)
proto/umee/auction/v1/genesis.proto (1 hunks)
proto/umee/auction/v1/tx.proto (1 hunks)

Files skipped from review as they are similar to previous changes (2)

proto/umee/auction/v1/genesis.proto
proto/umee/auction/v1/tx.proto

Additional comments: 5

proto/umee/auction/v1/events.proto (5)

1-1: The syntax declaration is correct and follows the standard for protobuf files.

2-2: The package name umee.auction.v1 is appropriately versioned, indicating a clear structure for future updates.

4-6: Imports are correctly specified, ensuring that necessary types and options from external packages are available.

8-8: The go_package option is correctly set to match the expected Go module path, facilitating proper code generation.

10-10: Disabling goproto_getters_all is a good practice for reducing boilerplate in the generated Go code, especially when getters are not needed for all fields.

proto/umee/auction/v1/events.proto

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f0e86d8 and 0f7b6e3.

Files ignored due to path filters (1)

x/auction/genesis.pb.go is excluded by: !**/*.pb.go

Files selected for processing (1)

proto/umee/auction/v1/genesis.proto (1 hunks)

Files skipped from review as they are similar to previous changes (1)

proto/umee/auction/v1/genesis.proto

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0f7b6e3 and b85e7e6.

Files ignored due to path filters (2)

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

Files selected for processing (2)

proto/umee/auction/v1/genesis.proto (1 hunks)
proto/umee/auction/v1/query.proto (1 hunks)

Files skipped from review as they are similar to previous changes (2)

proto/umee/auction/v1/genesis.proto
proto/umee/auction/v1/query.proto

gsk967

LGTM , pre-approving , small suggestions

proto/umee/auction/v1/genesis.proto

proto/umee/auction/v1/query.proto

Co-authored-by: Sai Kumar <17549398+gsk967@users.noreply.github.com>

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b85e7e6 and 75c4953.

Files selected for processing (2)

proto/umee/auction/v1/genesis.proto (1 hunks)
proto/umee/auction/v1/query.proto (1 hunks)

Files skipped from review as they are similar to previous changes (1)

proto/umee/auction/v1/query.proto

Additional comments: 1

proto/umee/auction/v1/genesis.proto (1)

20-20: The use of cosmos.AddressString for the highest_bidder field is appropriate for ensuring address format correctness in Cosmos SDK projects. However, ensure that the Cosmos SDK version used in the project supports this extension, as the static analysis tool flagged it as an unknown extension. This is likely a false positive, but verifying SDK compatibility is important.

feat: reards auction proto

cd38047

robert-zaremba requested a review from a team as a code owner March 22, 2024 13:29

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

gsk967 reviewed Mar 22, 2024

View reviewed changes

proto/umee/auction/v1/auction.proto Outdated Show resolved Hide resolved

robert-zaremba added 2 commits March 22, 2024 17:34

lint

8963b1a

update genesis

7417060

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

fix

8dee4f2

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

robert-zaremba requested a review from gsk967 March 22, 2024 17:49

add usd rewards

d6de406

robert-zaremba added the skip-e2e-test Skip the e2e tests label Mar 22, 2024

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

update params

a3e3a8f

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

add events

f0e86d8

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

proto/umee/auction/v1/events.proto Show resolved Hide resolved

robert-zaremba enabled auto-merge March 22, 2024 19:40

update genesis

0f7b6e3

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

update

b85e7e6

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

gsk967 approved these changes Mar 25, 2024

View reviewed changes

proto/umee/auction/v1/genesis.proto Outdated Show resolved Hide resolved

proto/umee/auction/v1/query.proto Outdated Show resolved Hide resolved

Apply suggestions from code review

75c4953

Co-authored-by: Sai Kumar <17549398+gsk967@users.noreply.github.com>

robert-zaremba added this pull request to the merge queue Mar 25, 2024

coderabbitai bot reviewed Mar 25, 2024

View reviewed changes

Merged via the queue into main with commit 6c5b613 Mar 25, 2024
23 of 26 checks passed

robert-zaremba deleted the robert/auction-proto branch March 25, 2024 15:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: reards auction proto #2469

feat: reards auction proto #2469

robert-zaremba commented Mar 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

codecov bot commented Mar 22, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

gsk967 left a comment

coderabbitai bot left a comment

feat: reards auction proto #2469

feat: reards auction proto #2469

Conversation

robert-zaremba commented Mar 22, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

coderabbitai bot commented Mar 22, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 22, 2024 • edited Loading

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

gsk967 left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

robert-zaremba commented Mar 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Mar 22, 2024 •

edited

Loading