Skip to content
New issue

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

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

Already on GitHub? # to your account

[bugfix][protocol] fix settled funding event emission #1051

Merged
merged 2 commits into from
Feb 6, 2024

Conversation

lucas-dydx
Copy link
Contributor

Changelist

Update the event key for subaccount number. Bug was found since downstream event indexers broke.

Note this shouldn't be consensus-breaking since this only changes event emissions.

Test Plan

N/A since trying to get this in next release.

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Feb 6, 2024

Warning

Rate Limit Exceeded

@lucas-dydx has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 15 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 4d84355 and dd642c5.

Walkthrough

The recent update involves a modification in the naming convention of an attribute key within the NewCreateSettledFundingEvent function. Specifically, the attribute key previously named AttributeKeySubaccount has been updated to AttributeKeySubaccountNumber, enhancing clarity and specificity in the codebase.

Changes

File Path Change Summary
.../x/subaccounts/types/events.go Renamed AttributeKeySubaccount to AttributeKeySubaccountNumber in NewCreateSettledFundingEvent function.

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.
  • 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 from git 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.

@lucas-dydx lucas-dydx marked this pull request as ready for review February 6, 2024 18:54
Copy link
Contributor

@vincentwschau vincentwschau left a comment

Choose a reason for hiding this comment

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

non-blocking nit:
How hard is it to update a test for this?

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 30d3608 and 4d84355.
Files selected for processing (1)
  • protocol/x/subaccounts/types/events.go (1 hunks)
Additional comments: 1
protocol/x/subaccounts/types/events.go (1)
  • 30-30: The change from AttributeKeySubaccount to AttributeKeySubaccountNumber in the NewCreateSettledFundingEvent function correctly addresses the bug affecting event indexers. Ensure all downstream systems expecting AttributeKeySubaccount are updated to handle AttributeKeySubaccountNumber.

@roy-dydx roy-dydx merged commit ab6a65c into main Feb 6, 2024
17 checks passed
@roy-dydx roy-dydx deleted the lucas-dydx/protocol/bugfix/fix-funding-event branch February 6, 2024 21:00
mergify bot pushed a commit that referenced this pull request Feb 6, 2024
* [bugfix][protocol] fix settled funding event emission

* add TODO

(cherry picked from commit ab6a65c)
roy-dydx pushed a commit that referenced this pull request Feb 6, 2024
* [bugfix][protocol] fix settled funding event emission

* add TODO

(cherry picked from commit ab6a65c)

Co-authored-by: lucas-dydx <76970939+lucas-dydx@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Development

Successfully merging this pull request may close these issues.

3 participants