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(delegation): auto associate when possible #284

Merged
merged 4 commits into from
Jan 14, 2025

Conversation

MaxMustermann2
Copy link
Contributor

@MaxMustermann2 MaxMustermann2 commented Jan 12, 2025

Whenever the asset bearing ExocoreAssetID is delegated by a staker to an operator, we should check if the staker address is the same as the operator address. If a match is found, they should be automatically associated.

Summary by CodeRabbit

Release Notes

  • New Features

    • Added automatic operator-staker association for self-delegation scenarios
    • Enhanced delegation process with improved association mechanism
  • Testing

    • Added new test case to validate automatic operator association during self-delegation
    • Updated test suite with refined asset and constant references
  • Improvements

    • Updated module dependencies to utilize Exocore network types
    • Added clarifying comments for asset information handling related to slashing and undelegation

Whenever the asset bearing `ExocoreAssetID` is delegated by a staker to
an operator, we should check if the staker address is the same as the
operator address. If a match is found, they should be automatically
associated.
Copy link
Contributor

coderabbitai bot commented Jan 12, 2025

Walkthrough

The pull request introduces changes across multiple files in the Exocore network's codebase. The modifications primarily focus on updating module names, imports, and testing functionality in the delegation and utility packages. The changes include refactoring test utilities, updating module interactions, and adding a new test case for operator-staker association during self-delegation. Additionally, comments have been added to clarify the handling of asset information in relation to slashing and undelegation processes.

Changes

File Change Summary
testutil/fund.go Replaced inflationtypes.ModuleName with exominttypes.ModuleName in coin minting and sending functions; updated imports.
x/delegation/keeper/delegation.go Added logic to associate operator with staker during self-delegation, added comments about hold count in undelegation method; new import for bytes package.
x/delegation/keeper/delegation_op_test.go Added TestAutoAssociate test function, updated asset and chain references, refined test cases.
x/assets/keeper/staker_asset.go Added comments to clarify handling of asset information related to slashing and undelegation processes.

Suggested Labels

C:Proto, Type: Tests

Suggested Reviewers

  • cloud8little
  • trestinlsd
  • bwhour
  • leonz789
  • adu-web3
  • mikebraver

Poem

🐰 In the realm of code, where bits dance and sway,
Delegation's dance gets a new ballet.
Operators and stakers, now hand in hand,
Refactored and tested across the land.
A rabbit's code leap, precise and bright! 🚀

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

- It is not possible to overwrite an association of the `stakerID`
  ending with `0x0` because such an association cannot be made using any
  other mechanism.
- Even if it exists, the overwriting will do nothing of import due to
  the equality check.
Validate that the operator share is correctly set to the expected value
when self-staking ExocoreAssetID
- for ExocoreAssetID, the `TotalDepositAmount` is post-slashing, if any
  was applied.
- for other asset IDs, all components are pre-slashing.
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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
x/delegation/keeper/delegation_op_test.go (1)

220-276: Test coverage for auto-association looks good, consider adding edge cases.

The test thoroughly validates the happy path for automatic association during self-delegation. Consider adding test cases for:

  1. Failed association scenarios
  2. Multiple self-delegations
  3. Mixed delegations (self and non-self)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4794bf3 and e7fe3c9.

📒 Files selected for processing (3)
  • x/assets/keeper/staker_asset.go (2 hunks)
  • x/delegation/keeper/delegation.go (3 hunks)
  • x/delegation/keeper/delegation_op_test.go (7 hunks)
✅ Files skipped from review due to trivial changes (1)
  • x/assets/keeper/staker_asset.go
🚧 Files skipped from review as they are similar to previous changes (1)
  • x/delegation/keeper/delegation.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: goreleaser
🔇 Additional comments (3)
x/delegation/keeper/delegation_op_test.go (3)

105-107: LGTM! Import path updates are consistent.

The changes correctly update the constants to use the types package instead of assetstypes.


179-181: Import path updates are consistent with previous changes.


193-196: Balance check updates are consistent with import path changes.

Also applies to: 347-350, 499-502

@MaxMustermann2 MaxMustermann2 merged commit 4225ead into imua-xyz:develop Jan 14, 2025
20 checks passed
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.

3 participants