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

fixed apy bug #779

Merged
merged 1 commit into from
Nov 26, 2024
Merged

fixed apy bug #779

merged 1 commit into from
Nov 26, 2024

Conversation

fonstack
Copy link
Member

@fonstack fonstack commented Nov 25, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced the APY calculation logic to ensure only valid values are processed and returned, improving overall robustness.
  • Bug Fixes

    • Implemented error handling to prevent division by zero in APY calculations.
  • Chores

    • Added console log for vaultApy in the VaultAsset component for debugging purposes.

Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

The pull request introduces changes to the useVaultApy hook and the VaultAsset component. The useVaultApy hook has been updated to improve the calculation of annual percentage yield (APY) by adding checks to prevent NaN values and division by zero. The VaultAsset component now includes a console log statement to output the vaultApy variable after it is retrieved, but no other logic or functionality has been altered.

Changes

File Change Summary
packages/web/src/hooks/vaults/useVaultApy.ts Enhanced APY calculation logic to prevent NaN and division by zero errors.
packages/web/src/pages/Honeypots/VaultDetailsPage/Sections/VaultDepositsSection/VaultAssetsSection/components/VaultAsset.tsx Added a console log for the vaultApy variable after using the useVaultApy hook.

Possibly related PRs

  • Fixes shared #774: The changes in this PR do not relate to the logic or functionality of the useVaultApy hook or its usage in the VaultAsset component, as it only updates the version in a package.json file without any code-level modifications.

Suggested reviewers

  • shayzluf

Poem

In the vaults where numbers play,
APYs dance in a bright array.
No more NaN to lead astray,
With checks in place, they’re here to stay!
A log to see the yield's display,
Hooray for changes, hip-hip-hooray! 🐇✨


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

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

🧹 Outside diff range and nitpick comments (1)
packages/web/src/hooks/vaults/useVaultApy.ts (1)

90-92: Consider making edge case handling more explicit

While the division by zero protection is correct, the logic could be more explicit about handling edge cases.

Consider this more explicit approach:

-  const apy = vaultTokenStaked > 0 ? (annualRewardValue / vaultTokenStaked) * 100 : 0;
+  if (vaultTokenStaked <= 0) return 0;
+  if (annualRewardValue <= 0) return 0;
+  
+  const apy = (annualRewardValue / vaultTokenStaked) * 100;

This makes the edge cases more obvious and maintainable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ccd6d14 and 7ac6e6a.

📒 Files selected for processing (2)
  • packages/web/src/hooks/vaults/useVaultApy.ts (2 hunks)
  • packages/web/src/pages/Honeypots/VaultDetailsPage/Sections/VaultDepositsSection/VaultAssetsSection/components/VaultAsset.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/web/src/pages/Honeypots/VaultDetailsPage/Sections/VaultDepositsSection/VaultAssetsSection/components/VaultAsset.tsx
🧰 Additional context used
🪛 Biome (1.9.4)
packages/web/src/hooks/vaults/useVaultApy.ts

[error] 59-59: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.

See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.

(lint/suspicious/noGlobalIsNan)

🔇 Additional comments (1)
packages/web/src/hooks/vaults/useVaultApy.ts (1)

90-92: Add validation for unrealistic APY values

While the code handles basic edge cases, it might be worth adding validation for unrealistically high APY values that could indicate calculation errors.

Let's verify if there have been any instances of extreme APY values in the codebase:

Consider adding a maximum threshold check:

   const apy = vaultTokenStaked > 0 ? (annualRewardValue / vaultTokenStaked) * 100 : 0;
+  // Add a maximum threshold (e.g., 1000000%) to catch potential calculation errors
+  const MAX_REASONABLE_APY = 1000000;
+  if (apy > MAX_REASONABLE_APY) {
+    console.warn(`Unusually high APY detected: ${apy}%. This might indicate a calculation error.`);
+  }

@@ -56,7 +56,7 @@ export const useVaultApy = (vault?: IVault): IVaultApy[] => {
vault.amountsInfo?.depositedAmount ? +vault.amountsInfo.depositedAmount.tokens : 0
);

apys.push({ rewardController: controller, apy });
if (!isNaN(apy)) apys.push({ rewardController: controller, apy });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Replace unsafe isNaN with Number.isNaN

The global isNaN() function attempts type coercion which can lead to unexpected results. Use Number.isNaN() instead for strict NaN checking.

Apply this change:

-        if (!isNaN(apy)) apys.push({ rewardController: controller, apy });
+        if (!Number.isNaN(apy)) apys.push({ rewardController: controller, apy });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (!isNaN(apy)) apys.push({ rewardController: controller, apy });
if (!Number.isNaN(apy)) apys.push({ rewardController: controller, apy });
🧰 Tools
🪛 Biome (1.9.4)

[error] 59-59: isNaN is unsafe. It attempts a type coercion. Use Number.isNaN instead.

See the MDN documentation for more details.
Unsafe fix: Use Number.isNaN instead.

(lint/suspicious/noGlobalIsNan)

Copy link

Deploying dapp with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ac6e6a
Status: ✅  Deploy successful!
Preview URL: https://57a56a06.dapp-a9y.pages.dev
Branch Preview URL: https://fix-apy.dapp-a9y.pages.dev

View logs

@fonstack fonstack merged commit 5da7ff6 into develop Nov 26, 2024
4 checks passed
@fonstack fonstack deleted the fix/apy branch November 26, 2024 08:20
@coderabbitai coderabbitai bot mentioned this pull request Nov 29, 2024
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