feat(spaceward): fix max value in staking

[alex-nax]

Summary by CodeRabbit

• New Features

  • Enhanced calculation of the maximum stake amount to ensure it is always non-negative, accounting for potential fees.

• Bug Fixes

  • Improved formatting for the display of commission rates and APR values to enhance clarity and accuracy.

[coderabbitai]

Walkthrough

Walkthrough

The changes in the pull request focus on the StakeModal.tsx file, specifically refining the calculation of the maxAmount variable to ensure it remains non-negative. This is achieved through the use of Math.max, which includes a small buffer to accommodate potential fees. Additionally, there are minor formatting updates related to the display of commission rates and APR values, improving the handling of default values and addressing decimal inaccuracies.

Changes

File	Change Summary
spaceward/src/features/staking/StakeModal.tsx	Adjusted the calculation of maxAmount to ensure it does not fall below zero, including a buffer for fees; made minor formatting updates for commission rates and APR values.

Possibly related PRs

• fix(spaceward): fix some issues #625: The changes in Staking.tsx involve rendering logic related to staking, which may connect to the adjustments made in StakeModal.tsx regarding the calculation of stake amounts.

Suggested reviewers

• jjheywood

---

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.

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.

[github-actions]

Hey @alex-nax and thank you for opening this pull request! 👋🏼

It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

spaceward/src/features/staking/StakeModal.tsx (1)

26-26: Approved: Good fix for maxAmount calculation

The change effectively addresses the PR objective by ensuring maxAmount is non-negative and accounts for potential fees. This is a good improvement.

Consider updating the comment to be more specific:

- const maxAmount = Math.max(ward - 1e-14 /* should be enough to pay fee */, 0);
+ const maxAmount = Math.max(ward - 1e-14 /* Buffer for transaction fees */, 0);

This makes the purpose of the buffer clearer to other developers.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 72bc180 and 6f5be7d.

Files selected for processing (1)

• spaceward/src/features/staking/StakeModal.tsx (3 hunks)

Additional comments not posted (2)

spaceward/src/features/staking/StakeModal.tsx (2)

165-165: Approved: Good addition of default value

Adding a default value of 0 for the commission rate calculation is a good practice. It prevents potential NaN results if the rate is undefined, improving the robustness of the code.

---

190-191: Verify APR calculation decimals

The use of BigInt for the APR calculation improves precision, which is good. However, the comment suggests there might be an issue with the decimals.

Please verify the correct number of decimals for the APR calculation. If the issue persists, consider using a decimal library like decimal.js for more accurate financial calculations.

To help investigate this, you can run the following script to find all occurrences of APR calculations in the codebase:

This will help identify if there are consistent patterns or discrepancies in APR calculations across the project.