refactor: power shaping

[mpoke]

Description

Closes: #XXXX

Review in order of commits. The last commit is just moving methods around without any changes.

---

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
• Added ! to the type prefix if the change is state-machine breaking
• Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
• Targeted the correct branch (see PR Targeting)
• Provided a link to the relevant issue or specification
• Followed the guidelines for building SDK modules
• Included the necessary unit and integration tests
• Added a changelog entry to CHANGELOG.md
• Included comments for documenting Go code
• Updated the relevant documentation or specification
• Reviewed "Files changed" and left comments if necessary
• Confirmed all CI checks have passed
• If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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 ! the type prefix if the change is state-machine breaking
• confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced new functionalities for managing power-shaping parameters for consumer chains, enhancing validator management.
  • Added comprehensive unit tests for the new power-shaping functionalities to ensure robust validation.

• Bug Fixes

  • Enhanced error handling in various test functions to ensure robustness and reliability of test outcomes.

• Documentation

  • Added new error variables to improve error reporting related to store operations.

• Chores

  • Removed outdated functions and tests related to allowlists and denylists, streamlining the codebase.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The changes primarily involve enhancing error handling across various test functions and methods related to consumer power-shaping parameters within the providerKeeper. Several functions for managing allowlists and denylists have been removed, indicating a shift in functionality. New error variables have been introduced to improve error reporting. Additionally, a new file has been created to implement power-shaping functionalities, and existing tests have been updated or removed accordingly.

Changes

Files	Change Summary
tests/integration/partial_set_security_test.go, tests/mbt/driver/setup.go, testutil/keeper/unit_test_helpers.go, x/ccv/provider/keeper/consumer_lifecycle_test.go, x/ccv/provider/keeper/grpc_query_test.go, x/ccv/provider/keeper/partial_set_security_test.go, x/ccv/provider/keeper/relay_test.go	Enhanced error handling for function calls related to setting consumer parameters.
x/ccv/provider/keeper/keeper.go, x/ccv/provider/keeper/msg_server.go, x/ccv/provider/keeper/permissionless.go	Removal of functions related to managing allowlists and denylists, indicating a change in functionality.
x/ccv/provider/keeper/keeper_test.go, x/ccv/provider/keeper/permissionless_test.go	Removal of tests for allowlist and denylist functionalities, reducing test coverage in those areas.
x/ccv/provider/keeper/power_shaping.go, x/ccv/provider/keeper/power_shaping_test.go	Introduction of a new file implementing power-shaping parameters management with corresponding tests.
x/ccv/types/errors.go	Addition of new error variables for improved error handling related to store operations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ProviderKeeper
    participant ErrorHandler

    User->>ProviderKeeper: SetConsumerPowerShapingParameters()
    ProviderKeeper-->>ErrorHandler: Check for errors
    ErrorHandler-->>ProviderKeeper: Error found
    ProviderKeeper-->>User: Return error message

Loading

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.

---

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
• Mastodon
• Reddit
• LinkedIn

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

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[insumity]

Not part of this PR but since you "touch" this already, let's rename record (because it's not a record anymore) to powerShapingParameters or something similar.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (8)

x/ccv/provider/keeper/power_shaping.go (1)

265-265: Run gofumpt with -extra flag to format the code.

The static analysis tool golangci-lint suggests that this file is not gofumpt-ed with -extra flag.

Please run gofumpt with -extra flag on this file to ensure that the code follows the Uber Golang style guide.

Tools

golangci-lint

265-265: File is not gofumpt-ed with -extra

(gofumpt)

x/ccv/provider/keeper/keeper.go (1)

Line range hint 1-1: Removal of allowlist and denylist functionality for validators.

The removal of multiple methods related to managing allowlists and denylists for validators suggests a significant change in the validator management mechanism. This could potentially simplify the codebase but may also impact how validators are processed or validated within the broader application.

Consider the following:

1. Ensure that the removal of these methods aligns with the desired validator management strategy and does not introduce any unintended consequences.
2. Update the relevant documentation and code comments to reflect the changes in the validator management approach.
3. Verify that the removal of these methods does not break any existing functionality or introduce any security vulnerabilities.

x/ccv/provider/keeper/relay_test.go (2)

745-749: Handle the error returned by SetConsumerPowerShapingParameters.

The code is not checking the error returned by SetConsumerPowerShapingParameters. It's a good practice to handle errors to avoid unexpected behavior.

Check the error and handle it appropriately:

err := providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", providertypes.PowerShapingParameters{
    Top_N:              50, 
    ValidatorsPowerCap: 40,
})
require.NoError(t, err)

---

591-594: Handle the error returned by SetConsumerPowerShapingParameters.

The code is not checking the error returned by SetConsumerPowerShapingParameters. It's a good practice to handle errors to avoid unexpected behavior.

Check the error and handle it appropriately:

err := providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", providertypes.PowerShapingParameters{
    Top_N: 100,
})
require.NoError(t, err)

x/ccv/provider/keeper/partial_set_security_test.go (4)

Line range hint 310-447: Add error checks for SetConsumerPowerShapingParameters and GetConsumerPowerShapingParameters.

The test function should check the errors returned by these functions to ensure they are handled correctly.

Apply this diff to add the error checks:

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, consumerID, types.PowerShapingParameters{Top_N: 50})
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, consumerID)
+require.NoError(t, err)

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, consumerID, types.PowerShapingParameters{Top_N: 0})
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, consumerID)
+require.NoError(t, err)

---

Line range hint 449-520: Add error checks for SetConsumerPowerShapingParameters and GetConsumerPowerShapingParameters.

The test function should check the errors returned by these functions to ensure they are handled correctly.

Apply this diff to add the error checks:

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorSetCap: 0,
 })
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorSetCap: 100,
 })
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorSetCap: 1,
 })
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorSetCap: 2,
 })
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorSetCap: 3,
 })
+require.NoError(t, err)
 powerShapingParameters, err = providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

---

Line range hint 522-583: Add an error check for SetConsumerPowerShapingParameters.

The test function should check the error returned by this function to ensure it is handled correctly.

Apply this diff to add the error check:

 err = providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  ValidatorsPowerCap: 33,
 })
+require.NoError(t, err)

---

Line range hint 821-905: Add error checks for SetConsumerPowerShapingParameters and GetConsumerPowerShapingParameters.

The test function should check the errors returned by these functions to ensure they are handled correctly.

Apply this diff to add the error checks:

 err := providerKeeper.SetConsumerPowerShapingParameters(ctx, "consumerId", types.PowerShapingParameters{
  MinStake:          minStake,
  AllowInactiveVals: false,
 })
+require.NoError(t, err)

 powerShapingParameters, err := providerKeeper.GetConsumerPowerShapingParameters(ctx, "consumerId")
+require.NoError(t, err)

[insumity]

I would recommend just doing:

store.Set(...)
k.UpdateAllowlist()
k.UpdateDenylist()

I understand that by getting oldParameters we gain by not executing the Update* methods when not needed, but it seems unnecessary. We do not expect this method to be executed that often (only part of the MsgCreateConsumer and MsgUpdateConsumer) in any case.

[mpoke]

What's the concern that you're trying to address? The reason I prefer to only update when it changes is that power shaping params will keep growing. In a permissionless world, these params could change quite often.