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: precompile staking validator info #657

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

zakir-code
Copy link
Contributor

@zakir-code zakir-code commented Aug 28, 2024

Summary by CodeRabbit

  • New Features

    • Introduced slashing information retrieval for validators.
    • Added functionality to retrieve and sort a list of validators based on specified criteria.
    • Enhanced staking interface with new methods and parameters for improved validator management.
  • Bug Fixes

    • Improved error handling for slashing and validator list operations.
  • Documentation

    • Updated documentation to reflect new methods and functionalities related to slashing and validator management.
  • Tests

    • Added comprehensive test suites for slashing information and validator list functionalities to ensure robustness and correctness.

Copy link

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes across various files introduce enhancements to the staking module by integrating new functionalities related to slashing and validator management. Key additions include methods for retrieving slashing information and lists of validators, along with new types and interfaces to facilitate sorting and validation. These modifications expand the operational scope of the staking system, improving interactions with validators and slashing logic.

Changes

File(s) Change Summary
app/keepers/keepers.go Modified NewAppKeeper to include appKeepers.SlashingKeeper in the staking precompiled contract instantiation.
contract/IStaking.go, solidity/contracts/staking/IStaking.sol Added SlashingInfo and ValidatorList functions to the ABI, updated event definitions, and introduced a new enum ValidatorSortBy for sorting options.
solidity/contracts/test/StakingTest.sol Added external functions slashingInfo and validatorList to interact with the IStaking interface.
tests/contract/StakingTest.go Updated the ABI with new function bindings for slashingInfo and validatorList, providing additional data retrieval capabilities.
x/staking/precompile/contract.go, x/staking/precompile/keeper.go Enhanced NewPrecompiledContract with a slashingKeeper parameter and methods for slashing information and validator lists.
x/staking/precompile/slashing_info.go, x/staking/precompile/validator_list.go Implemented SlashingInfoMethod and ValidatorListMethod for managing slashing info and validator lists, respectively.
x/staking/precompile/slashing_info_test.go, x/staking/precompile/validator_list_test.go Added test suites for slashing info and validator list methods to ensure functionality and correctness.
x/staking/precompile/interfaces.go Introduced the SlashingKeeper interface and updated StakingKeeper to include GetLastValidators.
x/staking/types/contract.go Added new types and methods for sorting validators and validating slashing info arguments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StakingContract
    participant SlashingKeeper

    User->>StakingContract: Request Slashing Info
    StakingContract->>SlashingKeeper: Get Validator Signing Info
    SlashingKeeper-->>StakingContract: Return Signing Info
    StakingContract-->>User: Return Slashing Info
Loading
sequenceDiagram
    participant User
    participant StakingContract
    participant ValidatorListMethod

    User->>StakingContract: Request Validator List
    StakingContract->>ValidatorListMethod: Get Validator List
    ValidatorListMethod-->>StakingContract: Return Sorted Validator List
    StakingContract-->>User: Return Validator List
Loading

🐇 In the meadow where rabbits play,
New features hop in, hip-hip-hooray!
With slashing info and lists so bright,
Our staking world shines with delight.
Let's dance and cheer, for change is here,
In every burrow, let out a cheer! 🌼✨


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

Co-authored-by: nulnut <151493716+nulnut@users.noreply.github.com>
Copy link

@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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 80a2e34 and e6065e3.

Files selected for processing (1)
  • x/staking/types/contract.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/staking/types/contract.go

@zakir-code zakir-code merged commit 48fcc94 into main Aug 28, 2024
13 checks passed
@zakir-code zakir-code deleted the nulnut/staking-slashing-info branch August 28, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants