Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: adding events to msg bid txn #2570

Merged
merged 3 commits into from
Jul 8, 2024
Merged

chore: adding events to msg bid txn #2570

merged 3 commits into from
Jul 8, 2024

Conversation

gsk967
Copy link
Collaborator

@gsk967 gsk967 commented Jul 8, 2024

Description

closes: #XXXX


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

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

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 a new event to notify users when they place a bid on an auction reward.

@gsk967 gsk967 requested a review from a team as a code owner July 8, 2024 14:06
@gsk967 gsk967 added the skip-e2e-test Skip the e2e tests label Jul 8, 2024
Copy link
Contributor

coderabbitai bot commented Jul 8, 2024

Warning

Rate limit exceeded

@gsk967 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 0 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 0c0f802 and 1f072b1.

Walkthrough

A new message EventRewardsBid has been added to the Umee auction module to capture events when users place bids on auction rewards. Additionally, the RewardsBid method in the msgServer struct now emits this event, providing structured details about the bids.

Changes

File(s) Change Summary
proto/umee/auction/v1/events.proto Added EventRewardsBid message to represent auction reward bids.
x/auction/keeper/msg_server.go Emitted EventRewardsBid event in the RewardsBid method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MsgServer
    participant AuctionModule
    participant Events

    User->>MsgServer: RewardsBid(MsgRewardsBid)
    MsgServer->>AuctionModule: Process bid
    Note right of AuctionModule: Validate and handle bid
    AuctionModule->>MsgServer: Bid successful
    MsgServer->>Events: Emit EventRewardsBid(sender, id, amount)
    Events-->>User: Event notification
Loading

Poem

In the code of Umee, a change does reside,
With bids on rewards, events now abide.
Auctions made clear with each coin that's cast,
Bid with delight, an event unsurpassed.
CodeRabbit quips, in bytes we trust,
For progress and clarity, changes robust. 🐇✨


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.

Copy link

codecov bot commented Jul 8, 2024

Codecov Report

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

Project coverage is 62.55%. Comparing base (7f05ad4) to head (1f072b1).
Report is 513 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2570       +/-   ##
===========================================
- Coverage   75.38%   62.55%   -12.84%     
===========================================
  Files         100      275      +175     
  Lines        8025    16035     +8010     
===========================================
+ Hits         6050    10031     +3981     
- Misses       1589     5231     +3642     
- Partials      386      773      +387     
Files Coverage Δ
x/auction/keeper/msg_server.go 0.00% <0.00%> (ø)

... and 239 files with indirect coverage changes

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2966992 and 0c0f802.

Files ignored due to path filters (1)
  • x/auction/events.pb.go is excluded by !**/*.pb.go
Files selected for processing (2)
  • proto/umee/auction/v1/events.proto (1 hunks)
  • x/auction/keeper/msg_server.go (1 hunks)
Additional context used
GitHub Check: codecov/patch
x/auction/keeper/msg_server.go

[warning] 57-61: x/auction/keeper/msg_server.go#L57-L61
Added lines #L57 - L61 were not covered by tests

Additional comments not posted (1)
proto/umee/auction/v1/events.proto (1)

23-28: LGTM!

The EventRewardsBid message definition is correct and follows best practices. It includes fields for the sender's address, bid ID, and bid amount with appropriate annotations.

x/auction/keeper/msg_server.go Show resolved Hide resolved
proto/umee/auction/v1/events.proto Outdated Show resolved Hide resolved
x/auction/events.pb.go Outdated Show resolved Hide resolved
x/auction/events.pb.go Show resolved Hide resolved
@gsk967 gsk967 enabled auto-merge July 8, 2024 14:34
@gsk967 gsk967 requested a review from hoffmabc July 8, 2024 14:34
@gsk967 gsk967 added this pull request to the merge queue Jul 8, 2024
Merged via the queue into main with commit 17328ba Jul 8, 2024
23 of 27 checks passed
@gsk967 gsk967 deleted the sai/add_events_to_bid_msg branch July 8, 2024 14:59
Copy link
Member

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason we didn't make this event was the transaction itself is easy to index, and the event is a copy of the transaction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-e2e-test Skip the e2e tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants