QuokkaStake / cosmos-validators-exporter

A Prometheus exporter to fetch data about your validators in Cosmos-based blockchains.
GNU General Public License v3.0
12 stars 13 forks source link

feat: add consumer commission #69

Closed freak12techno closed 2 months ago

freak12techno commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The update introduces functionalities to handle consumer commission data for validators. It adds new fetchers and generators, enhances configuration constants, and modifies Tendermint RPC interactions. Additionally, tests for both fetchers and generators ensure the new processes work correctly. A new JSON file sets a default commission rate. The update refines existing functionalities by removing unnecessary metrics and adjusts suitable test expectations accordingly.

Changes

File/Path Summary
assets/consumer-commission.json Introduces a key-value pair defining a commission rate of 0.1.
pkg/app.go Adds fetchers and generators for handling consumer commission and validator commission rate, respectively.
pkg/constants/constants.go Adds constant FetcherNameConsumerCommission.
pkg/fetchers/consumer_commission.go Introduces ConsumerCommissionFetcher struct and related methods for fetching commission data.
pkg/fetchers/consumer_commission_test.go Adds test functions for ConsumerCommissionFetcher.
pkg/generators/single_validator_info.go Removes commissionGauge metric from SingleValidatorInfoGenerator.
pkg/generators/single_validator_info_test.go Updates expected results length and indexing in tests.
pkg/generators/validator_commission_rate.go Introduces ValidatorCommissionRateGenerator struct and related methods.
pkg/generators/validator_commission_rate_test.go Adds test functions for ValidatorCommissionRateGenerator.
pkg/tendermint/rpc.go Adds GetConsumerCommission method to RPC struct.
pkg/types/tendermint.go Adds ConsumerCommissionResponse type.

Sequence Diagram(s)

Below is the sequence diagram representing the interaction between fetching and generating consumer commission rates:

sequenceDiagram
    participant App as App
    participant Fetcher as ConsumerCommissionFetcher
    participant Generator as ValidatorCommissionRateGenerator
    participant RPC as Tendermint RPC
    participant State as State

    App->>Fetcher: NewConsumerCommissionFetcher(logger, appConfig.Chains, rpcs, tracer)
    Fetcher->>RPC: fetchConsumerCommission(valcons, chainID)
    RPC-->>Fetcher: ConsumerCommissionResponse

    App->>Generator: NewValidatorCommissionRateGenerator(appConfig.Chains, logger)
    Generator->>State: Generate(state)
    State-->>Generator: Commission rates data
    Generator-->>App: Prometheus metrics

Poem

In the digital meadow, data flows with grace,
Fetching commissions from each validator's place.
With new generators, metrics shine anew,
Reflecting rates in a dashboard view.
Through code we weave a structured scene,
Validators' work now clear and clean.
Hopping forward, we build and dream! 🌟🐇


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 98.29060% with 2 lines in your changes missing coverage. Please review.

Project coverage is 91.01%. Comparing base (95d607b) to head (407edd0).

Files Patch % Lines
pkg/app.go 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #69 +/- ## ========================================== + Coverage 90.71% 91.01% +0.30% ========================================== Files 61 63 +2 Lines 2455 2560 +105 ========================================== + Hits 2227 2330 +103 - Misses 227 229 +2 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.