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

feat(x/distribution): add rewards-by-validator autocli config #19707

Merged
merged 2 commits into from
Mar 11, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 8, 2024

Description

DelegationTotalRewards had no autocli config, giving it a weird ux: delegation-total-rewards --delegator-address [addr].
This makes the UX more consistent with v0.47.


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
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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, API design and naming, documentation is accurate, tests and test coverage

@julienrbrt julienrbrt requested a review from a team as a code owner March 8, 2024 16:34
Copy link
Contributor

coderabbitai bot commented Mar 8, 2024

Walkthrough

The update introduces a new RPC method DelegationTotalRewards to the AutoCLIOptions in the AppModule struct, aimed at querying comprehensive distribution rewards for delegators. Additionally, the DelegationRewards RPC method now specifically targets rewards from a singular validator, with its usage updated to rewards-by-validator. This refines the querying capabilities for distribution delegator rewards, offering both a broad and specific perspective on rewards.

Changes

File(s) Change Summary
x/distribution/autocli.go Added DelegationTotalRewards RPC method; Updated DelegationRewards usage to rewards-by-validator.

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.

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Mar 8, 2024
@github-actions github-actions bot added the C:x/distribution distribution module related label Mar 8, 2024
Copy link
Contributor

github-actions bot commented Mar 8, 2024

@julienrbrt your pull request is missing a changelog!

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: 1

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 2bf7e9f and 6529d0a.
Files selected for processing (1)
  • x/distribution/autocli.go (1 hunks)
Additional comments: 1
x/distribution/autocli.go (1)
  • 64-65: The usage of the DelegationRewards RPC method has been updated to "rewards-by-validator [delegator-addr] [validator-addr]", and the short description has been modified accordingly. This change aligns with the PR's objective to enhance the user experience by making the querying process more intuitive.
  • Ensure that the documentation and any related user guides are updated to reflect this change in usage.
  • Verify that existing scripts or automation tools that rely on the old DelegationRewards usage are identified and updated accordingly to prevent breaking changes.

x/distribution/autocli.go Show resolved Hide resolved
@julienrbrt
Copy link
Member Author

julienrbrt commented Mar 8, 2024

@julienrbrt your pull request is missing a changelog!

will add in v0.50 backport (x/distribution isn't split there so it should be in the main changelog, but here needs to be added in x/distribution/changelog)

@tac0turtle tac0turtle added this pull request to the merge queue Mar 11, 2024
Merged via the queue into main with commit 0091851 Mar 11, 2024
54 of 59 checks passed
@tac0turtle tac0turtle deleted the julien/distr-autocli branch March 11, 2024 10:55
mergify bot pushed a commit that referenced this pull request Mar 11, 2024
tac0turtle pushed a commit that referenced this pull request Mar 11, 2024
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Mar 27, 2024
…0.50.5

* fix: in-place-testnet edgecases (backport cosmos#19516) (cosmos#19526)

Co-authored-by: Adam Tucker <[email protected]>

* fix(simapp): typo in GetStoreKeys (cosmos#19544)

* build(deps): Bump cosmossdk.io/math from 1.2.0 to 1.3.0 (cosmos#19562)

* fix(depinject): Authtx was not accepting custom signers (backport cosmos#19549) (cosmos#19551)

Co-authored-by: Devon Bear <[email protected]>
Co-authored-by: Qt <[email protected]>
Co-authored-by: Julien Robert <[email protected]>

* build(deps): Bump github.com/cosmos/cosmos-db from 1.0.0 to 1.0.2 (cosmos#19566)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <[email protected]>

* Merge pull request from GHSA-86h5-xcpx-cfqc

* fix slashing hole with test

* release notes + changelog

* word

* date

* updates

---------

Co-authored-by: Julien Robert <[email protected]>

* ci: run test pipeline on merge v0.50 branch (cosmos#19582)

* fix(staking): fix impossible conditions (cosmos#19621)

* docs: add section on creating a testnets from mainnet exports (backport cosmos#19475) (cosmos#19648)

Co-authored-by: Marko <[email protected]>

* build(deps): Bump cosmossdk.io/x/tx from 0.13.0 to 0.13.1 (cosmos#19665)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(client/v2): marshal enum as string (cosmos#19653)

* refactor(x/auth): allow empty public keys for GetSignBytesAdapter (backport cosmos#19651) (cosmos#19675)

Co-authored-by: mmsqe <[email protected]>
Co-authored-by: Julien Robert <[email protected]>

* fix(types): check for HasABCIGenesis in CoreAppModuleBasicAdaptor (cosmos#19709)

* build(deps): Bump deps (backport cosmos#19655) (cosmos#19711)

Co-authored-by: Julien Robert <[email protected]>

* Merge pull request from GHSA-95rx-m9m5-m94v

* validate ExtendedCommit against LastCommit

test cases

* account for core.comet types

* logging

* linting

* cherry-pick staking fix

* nits

* linting fix

* run tests

---------

Co-authored-by: Marko <[email protected]>
Co-authored-by: Marko Baricevic <[email protected]>

* feat(baseapp): add option to disable block gas meter (cosmos#19626)

* feat(x/distribution): add rewards-by-validator autocli config (backport cosmos#19707) (cosmos#19714)

Co-authored-by: Julien Robert <[email protected]>

* fix(x/gov): grpc query tally for failed proposal (backport cosmos#19725) (cosmos#19727)

Co-authored-by: David Tumcharoen <[email protected]>
Co-authored-by: Julien Robert <[email protected]>

* chore: prepare v0.50.5 (cosmos#19715)

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Adam Tucker <[email protected]>
Co-authored-by: yihuang <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Devon Bear <[email protected]>
Co-authored-by: Qt <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: khanh <[email protected]>
Co-authored-by: Tom <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: mmsqe <[email protected]>
Co-authored-by: Nikhil Vasan <[email protected]>
Co-authored-by: Marko Baricevic <[email protected]>
Co-authored-by: David Tumcharoen <[email protected]>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/distribution distribution module related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants