feat(slash): Add the historical voting power to the slashing record

[TimmyExogenous]

Description

This PR adds the historical voting power to the slashing record and additional logs for slashing events.

Summary by CodeRabbit

• New Features

  • Added a new field, historical_voting_power, to enhance slashing event logging.
  • Improved logging for slashing operations, providing detailed insights.

• Bug Fixes

  • Enhanced error handling for USD value calculations, ensuring robustness when asset data is unavailable.

• Refactor

  • Updated logic for calculating USD values for operators, improving clarity and maintainability.

[coderabbitai]

Walkthrough

This pull request introduces a new field historical_voting_power to the SlashExecutionInfo message in the protocol buffer definition. The changes span across multiple files in the operator module, including tx.proto, slash.go, and usd_value.go. The modifications enhance logging and tracking capabilities for slashing operations, particularly by adding the ability to capture historical voting power during slash events and improving error handling and value calculation methods.

Changes

File	Change Summary
proto/exocore/operator/v1/tx.proto	Added int64 historical_voting_power = 6; to SlashExecutionInfo message
x/operator/keeper/slash.go	- Added JSON marshaling import - Enhanced logging in Slash and SlashAssets methods - Improved variable naming and logging details
x/operator/keeper/usd_value.go	- Refactored USD value calculation method - Added logging for USD values - Improved error handling for asset retrieval

Possibly related PRs

• add implementations to support gov-tx-proposal #240: Modifies SlashExecutionInfo struct to include historical voting power field

Suggested labels

C:Proto

Suggested reviewers

• bwhour
• cloud8little
• MaxMustermann2

Poem

🐰 A rabbit's tale of code so bright,
Voting power now in clear sight!
Slashing logs with newfound grace,
Tracking metrics at lightning pace.
Protocol buffers dance with glee! 🔍

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

x/operator/keeper/slash.go (1)

164-168: Consider more robust error handling for JSON marshaling.

While ignoring the JSON marshal error is acceptable for logging, consider adding debug logging when the error occurs to help troubleshoot potential issues.

-	snapshotJSON, _ := json.Marshal(snapshot)
-	k.Logger(ctx).Info("the voting power snapshot info is:", "filter_height", slashEventEpochStartHeight, "snapshot", string(snapshotJSON))
+	snapshotJSON, err := json.Marshal(snapshot)
+	if err != nil {
+		k.Logger(ctx).Debug("failed to marshal snapshot", "error", err)
+		k.Logger(ctx).Info("the voting power snapshot info is:", "filter_height", slashEventEpochStartHeight, "snapshot", snapshot)
+	} else {
+		k.Logger(ctx).Info("the voting power snapshot info is:", "filter_height", slashEventEpochStartHeight, "snapshot", string(snapshotJSON))
+	}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6638e9 and f5934f0.

⛔ Files ignored due to path filters (3)

• x/operator/types/genesis.pb.go is excluded by !**/*.pb.go
• x/operator/types/tx.pb.go is excluded by !**/*.pb.go
• x/oracle/types/params.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (3)

• proto/exocore/operator/v1/tx.proto (1 hunks)
• x/operator/keeper/slash.go (4 hunks)
• x/operator/keeper/usd_value.go (1 hunks)

🔇 Additional comments (4)

proto/exocore/operator/v1/tx.proto (1)

224-225: LGTM! The historical voting power field is well-defined.

The new field is properly documented and uses an appropriate type (int64) for storing voting power.

x/operator/keeper/slash.go (2)

4-4: LGTM! Import added for JSON marshaling.

The import is required for the new snapshot marshaling functionality.

---

91-91: LGTM! Historical voting power field properly initialized.

The field is correctly populated with the parameter's Power value.

x/operator/keeper/usd_value.go (1)

393-395: LGTM! Enhanced logging improves debuggability.

The detailed logging of USD value calculations will be valuable for debugging slashing events, including all relevant values like asset details, amounts, and prices.