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

Replace formatAmountWithDecimals with formatUnits of viem #371

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

neverm25
Copy link

@neverm25 neverm25 commented Sep 3, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced token amount formatting using the new formatUnits function for improved precision.
    • Streamlined address handling in the InitialClaimLinkView and Confirm.view components.
  • Bug Fixes

    • Improved clarity and readability of address handling logic, ensuring consistent functionality.
  • Chores

    • Removed the outdated formatAmountWithDecimals utility function to simplify the codebase.

Copy link

vercel bot commented Sep 3, 2024

@neverm25 is attempting to deploy a commit to the squirrellabs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

Walkthrough

The changes involve updates to the InitialClaimLinkView and Confirm.view components, focusing on the import of formatUnits from the viem library for token amount formatting. The logic for handling addresses has been streamlined, and the formatAmountWithDecimals function has been removed from the utility module, indicating a shift in how amounts are processed within the application.

Changes

Files Change Summary
src/components/Claim/Link/Initial.view.tsx Removed PopupButton import; replaced utils.formatAmountWithDecimals with formatUnits for token formatting; streamlined address handling and AddressInput value prop.
src/components/Claim/Link/Onchain/Confirm.view.tsx Updated amount formatting to use formatUnits; simplified address handling; retained local storage logic.
src/utils/general.utils.ts Removed formatAmountWithDecimals function, simplifying the utility module.

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7d804fe and eabb421.

Files selected for processing (3)
  • src/components/Claim/Link/Initial.view.tsx (5 hunks)
  • src/components/Claim/Link/Onchain/Confirm.view.tsx (4 hunks)
  • src/utils/general.utils.ts (1 hunks)
Additional comments not posted (9)
src/components/Claim/Link/Onchain/Confirm.view.tsx (4)

16-16: LGTM!

The code changes are approved.


61-61: LGTM!

The code changes are approved.


69-69: LGTM!

The code changes are approved.


76-76: LGTM!

The code changes are approved.

Also applies to: 152-157, 173-178

src/utils/general.utils.ts (1)

Line range hint 1-1: Verify the removal of formatAmountWithDecimals function.

The formatAmountWithDecimals function has been removed from this file. This indicates a shift in functionality and potentially simplifies the module by eliminating a utility that may no longer be necessary or used.

Please confirm that the removal is intentional and the function is no longer used in the codebase. You can use the following script to search for any remaining usages of the function:

Verification successful

Removal of formatAmountWithDecimals function verified.

The formatAmountWithDecimals function is not used anywhere in the codebase, confirming that its removal does not impact other parts of the application. This change likely simplifies the module by eliminating an unused utility.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for any usages of the `formatAmountWithDecimals` function in the codebase.

# Test: Search for the function usage. Expect: No results found.
rg --type typescript --type javascript 'formatAmountWithDecimals'

Length of output: 100


Script:

#!/bin/bash
# Description: Search for any usages of the `formatAmountWithDecimals` function in the codebase.

# Test: Search for the function usage in .ts files. Expect: No results found.
rg 'formatAmountWithDecimals' --glob '*.ts'

Length of output: 43

src/components/Claim/Link/Initial.view.tsx (4)

20-20: LGTM!

The code changes are approved.


304-304: LGTM!

The code changes are approved.


423-428: LGTM!

The code changes are approved.


452-452: LGTM!

The code changes are approved.

@borcherd
Copy link
Contributor

borcherd commented Sep 6, 2024

Hey @neverm25, thanks! Good idea! Would love to know how the formatUnits works exactly, and if it makes sense replace the amount formatting throughout the entire webapp!

@neverm25
Copy link
Author

neverm25 commented Sep 6, 2024

Hey @neverm25, thanks! Good idea! Would love to know how the formatUnits works exactly, and if it makes sense replace the amount formatting throughout the entire webapp!

Sure, will do.

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