search

lavanet / lava

Apache License 2.0
404 stars 207 forks source link

feat: CNS-tracked-cu-queries #1613

Closed Yaroms closed 1 month ago

Yaroms commented 1 month ago

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

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

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates to the Lavanet rewards and subscription modules introduce new message types, enhance RPC methods, and refine data structures. These changes streamline reward management and subscription usage tracking while improving code organization. The overall result enriches user experience and functionality, making interactions with the system more efficient and intuitive.

Changes

Files Change Summary
proto/lavanet/lava/rewards/*.proto Replaced BasePayGenesis with BasePayWithIndex; updated RPC methods and messages for reward queries.
proto/lavanet/lava/subscription/*.proto Introduced TrackedUsage and EstimatedRewards RPC methods; added new message types for tracking subscription usage.
scripts/protocgen.sh Updated file path to the versioned directory structure github.com/lavanet/lava/v2.
testutil/common/tester.go Removed the QueryRewardsProviderReward method from the Tester struct.
x/rewards/client/cli/*.go Modified CLI commands to reflect new tracking functionalities instead of provider rewards.
x/subscription/keeper/grpc_query_estimated_rewards.go Added EstimatedRewards method to query expected rewards based on parameters.
x/subscription/keeper/grpc_query_tracked_usage.go Implemented TrackedUsage method for querying subscription usage data.
x/subscription/types/expected_keepers.go Expanded EpochstorageKeeper and RewardsKeeper interfaces with new methods for improved reward and stake management.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QueryClient
    participant Keeper

    User->>QueryClient: Request SpecTrackedInfo
    QueryClient->>Keeper: SpecTrackedInfo(req)
    Keeper->>Keeper: Validate request
    Keeper->>Keeper: Retrieve BasePayWithIndex
    Keeper->>QueryClient: Respond with tracking info

🐇 "In fields of green where bunnies leap,
Changes sprout, new paths we keep.
With data bright and queries clear,
We track our joys from far and near.
So hop along, let’s bounce and play,
For brighter code is here to stay!" 🐰✨

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 Configuration 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.
github-actions[bot] commented 1 month ago

Test Results

2 159 tests  ±0   2 159 :white_check_mark: ±0   25m 51s :stopwatch: +18s   143 suites ±0       0 :zzz: ±0      7 files   ±0       0 :x: ±0 

Results for commit 8382fe7e. ± Comparison against base commit c74cbc78.

:recycle: This comment has been updated with latest results.