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

Add estimated timer #4950

Merged
merged 3 commits into from
Jan 20, 2025
Merged

Add estimated timer #4950

merged 3 commits into from
Jan 20, 2025

Conversation

kkatusic
Copy link
Collaborator

@kkatusic kkatusic commented Jan 20, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Added support for Coinbase Wrapped BTC token in the platform's token configuration
  • Improvements

    • Enhanced token amount handling for tokens with 6 and 8 decimal places
    • Improved input validation for token decimal precision
  • Configuration

    • Updated sitemap generation configuration to support dynamic rendering

Copy link

vercel bot commented Jan 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
giveth-dapps-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 20, 2025 7:19pm

Copy link
Contributor

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request introduces configuration and handling changes for tokens with varying decimal precisions, specifically focusing on tokens like Coinbase Wrapped BTC with 8 decimal places. The modifications span multiple files, including sitemap generation configuration, amount input handling, recurring donation components, and production token configuration. The changes aim to enhance the system's flexibility in processing different token types with more precise decimal handling.

Changes

File Change Summary
pages/api/generate-sitemap.ts Added maxDuration and dynamic configuration constants
src/components/AmountInput/AmountInput.tsx Updated decimal handling logic to support up to 8 decimal places
src/components/views/donate/Recurring/RecurringDonationCard.tsx Enhanced token decimal precision handling for donation amounts
src/components/views/donate/Recurring/RecurringDonationModal/RecurringDonationModal.tsx Improved amount parsing and conversion for tokens with 6 and 8 decimals
src/config/production.tsx Activated Coinbase Wrapped BTC token configuration in SUPER_FLUID_TOKENS

Possibly related issues

  • Update BE config for cbBTC #4945: Directly related to updating configuration for cbBTC, which aligns perfectly with the changes in the production configuration file.

Poem

🐰 A Rabbit's Decimal Dance 🧮

Eight decimals hop, six decimals leap,
Through tokens we parse, no precision to keep
Coinbase BTC joins our financial song
With configs aligned, nothing can go wrong!

Nibble by nibble, we crunch the math 🥕


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.

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 (5)
src/components/AmountInput/AmountInput.tsx (2)

54-60: Consider using an object map for decimal precision.

The current implementation uses a ternary operator to determine maxDecimals. As more token types with different decimal precisions are added, this approach might become harder to maintain.

Consider using an object map for better maintainability:

-const maxDecimals = decimals === 8 ? 8 : decimals / 3;
+const DECIMAL_PRECISION: { [key: number]: number } = {
+  8: 8,
+  18: 6,
+  6: 2,
+};
+const maxDecimals = DECIMAL_PRECISION[decimals] || decimals / 3;

80-86: Improve decimal validation logic.

The current implementation has separate conditions for 8 decimals and other cases. This could be simplified using the same maxDecimals variable that was calculated earlier.

Consider using the maxDecimals variable for validation:

-// Allow more decimals if token has 8 decimals
-if (decimals === 8) {
-  if (_decimals?.length > 8) return; // Limit to 8 decimals
-} else {
-  if (_decimals?.length > decimals / 3) return; // Limit to 6 or 2 decimals for other tokens
-}
+const maxDecimals = decimals === 8 ? 8 : decimals / 3;
+if (_decimals?.length > maxDecimals) return;
src/components/views/donate/Recurring/RecurringDonationModal/RecurringDonationModal.tsx (1)

245-261: Consider extracting token conversion logic.

The token conversion logic is complex and could benefit from being extracted into a separate helper function. This would improve readability and make it easier to test.

Consider creating a helper function:

const convertTokenAmount = (
  amount: bigint,
  decimals: number,
  targetDecimals: number = 18
): bigint => {
  if (decimals === 6 || decimals === 8) {
    const divisor = BigInt(10 ** decimals);
    const currentAmount = Number(amount) / Number(divisor);
    return ethers.utils.parseUnits(currentAmount.toFixed(8), targetDecimals).toBigInt();
  }
  return amount;
};

Then use it in the code:

-if (selectedRecurringToken.token.decimals === 6 || selectedRecurringToken.token.decimals === 8) {
-  const divisor = BigInt(10 ** selectedRecurringToken.token.decimals);
-  const currentAmount = Number(amount) / Number(divisor);
-  newAmount = ethers.utils.parseUnits(currentAmount.toFixed(8), 18).toBigInt();
-
-  const currentPerMonth = Number(perMonthAmount) / Number(divisor);
-  newPerMonthAmount = ethers.utils.parseUnits(currentPerMonth.toFixed(8), 18).toBigInt();
-}
+newAmount = convertTokenAmount(amount, selectedRecurringToken.token.decimals);
+newPerMonthAmount = convertTokenAmount(perMonthAmount, selectedRecurringToken.token.decimals);
src/components/views/donate/Recurring/RecurringDonationCard.tsx (2)

144-150: Consider using a constant for supported decimals.

The condition for resetting amounts could be more maintainable by using a constant for supported decimal places.

Consider using a constant:

+const SUPPORTED_DECIMALS = [6, 8];
+
-if (selectedRecurringToken.token.decimals === 6 || selectedRecurringToken.token.decimals === 8) {
+if (SUPPORTED_DECIMALS.includes(selectedRecurringToken.token.decimals)) {
  setAmount(0n);
  setPerMonthAmount(0n);
}

157-161: Consider using an object map for scale factors.

The scale factor calculation uses nested ternary operators which can be hard to read and maintain.

Consider using an object map:

+const SCALE_FACTORS: { [key: number]: bigint } = {
+  6: 10000n,
+  8: 100n,
+};
+
-const scaleFactor = selectedRecurringToken?.token.decimals === 6
-  ? 10000n
-  : selectedRecurringToken?.token.decimals === 8
-    ? 100n
-    : 1n;
+const scaleFactor = SCALE_FACTORS[selectedRecurringToken?.token.decimals || 0] || 1n;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a10b813 and 06acda5.

📒 Files selected for processing (5)
  • pages/api/generate-sitemap.ts (1 hunks)
  • src/components/AmountInput/AmountInput.tsx (2 hunks)
  • src/components/views/donate/Recurring/RecurringDonationCard.tsx (2 hunks)
  • src/components/views/donate/Recurring/RecurringDonationModal/RecurringDonationModal.tsx (1 hunks)
  • src/config/production.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • pages/api/generate-sitemap.ts
🔇 Additional comments (1)
src/config/production.tsx (1)

641-655: LGTM! Token configuration is well-structured.

The configuration for "Coinbase Wrapped BTC" is complete with all necessary properties:

  • Correct decimal places (8 for underlying token, 18 for super token)
  • Proper token addresses
  • Appropriate coingeckoId for price tracking

@kkatusic kkatusic merged commit 5713da6 into develop Jan 20, 2025
3 checks passed
@kkatusic kkatusic deleted the add_estimated_timer branch January 20, 2025 19:23
@coderabbitai coderabbitai bot mentioned this pull request Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants