fix: incorporate era length which may be less than a day for some chains while calc a validators APY

[Nick-1979]

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced reward calculations with improved arithmetic operations for better performance and clarity.
  • Added localization support with new entries for "PolkaGate logo" and "Total balance."

• Bug Fixes

  • Improved error handling in the block interval calculations to ensure robustness when the API is unavailable.

• Documentation

  • Updated function signatures for better compatibility with TypeScript and clearer usage.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the useValidatorApy hook to simplify calculations by transitioning from BN types to native JavaScript number types for properties such as netReward and totalRewards. New constants for dynamic calculations of block intervals and rewards are introduced. Additionally, the useBlockInterval function is updated to enhance error handling for the api parameter. Two new localization entries are added to the translation file for improved UI labeling.

Changes

File Path	Change Summary
packages/extension-polkagate/src/hooks/useValidatorApy.ts	Updated ValidatorEraInfo interface to change netReward and totalRewards from BN to number. Introduced new constants for dynamic calculations and updated function signatures for clarity.
packages/extension/public/locales/en/translation.json	Added new localization entries: "PolkaGate logo": "" and "Total balance": "".
packages/extension-polkagate/src/hooks/useBlockInterval.ts	Updated calcInterval function to accept an optional ApiPromise parameter and added error handling for undefined api. Adjusted formatting for consistency.

Possibly related PRs

• fix: incorporate era length which may be less than a day for some chains while calc a validators APY #1659: This PR directly relates to the main PR as it also modifies the useValidatorApy hook, focusing on the calculation of a validator's APY by incorporating era lengths that may be less than a day, which aligns with the changes made in the main PR regarding reward calculations and data types.

Suggested reviewers

• AMIRKHANEF

🐰 In a world of numbers, we hop and play,
Simplifying rewards in a clearer way.
With logos and balances, we localize,
Enhancing our hooks, oh what a surprise!
Through blocks and intervals, we swiftly glide,
In the garden of code, our changes abide! 🌼

---

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: 1

🧹 Outside diff range and nitpick comments (1)

packages/extension-polkagate/src/hooks/useValidatorApy.ts (1)

40-42: LGTM! Consider extracting magic numbers as named constants.

The era length calculations correctly incorporate the block time for dynamic era depth calculation. However, consider extracting magic numbers:

+const SECONDS_PER_HOUR = 3600;
+const HOURS_PER_DAY = 24;
-const eraLengthInHrs = eraLength.toNumber() * AVG_SECONDS_PER_BLOCK / 3600;
-const eraPerDay = 24 / eraLengthInHrs;
+const eraLengthInHrs = eraLength.toNumber() * AVG_SECONDS_PER_BLOCK / SECONDS_PER_HOUR;
+const eraPerDay = HOURS_PER_DAY / eraLengthInHrs;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7af7fed and cc8fc25.

📒 Files selected for processing (1)

• packages/extension-polkagate/src/hooks/useValidatorApy.ts (4 hunks)

🔇 Additional comments (4)

packages/extension-polkagate/src/hooks/useValidatorApy.ts (4)

14-14: Type change from BN to number looks good.

The change from BN to number for netReward aligns with the goal of using native JavaScript number operations for better performance and readability.

---

101-102: LGTM! Consistent type handling.

The accumulation of rewards and stakes maintains consistency in type conversions while simplifying the calculations.

---

109-111: LGTM! Correct APY calculation with proper validation.

The APY calculation:

1. Correctly incorporates era length variations
2. Properly handles daily reward calculations
3. Includes validation for infinite/NaN results

---

70-70: Verify precision requirements for reward calculations.

Converting BN to number using toNumber() could potentially lose precision for very large values. Ensure that your chain's reward values will not exceed JavaScript's Number.MAX_SAFE_INTEGER (2^53 - 1).

#!/bin/bash
# Check for potentially large reward values
rg -A 2 "erasValidatorReward|validatorReward|reward" --type typescript