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

feat(synapse-interface): display small tx origin values #2922

Merged
merged 1 commit into from
Jul 29, 2024

Conversation

bigboydiamonds
Copy link
Collaborator

@bigboydiamonds bigboydiamonds commented Jul 25, 2024

Summary by CodeRabbit

  • New Features

    • Improved formatting of token amounts for greater accuracy and consistency in display.
  • Bug Fixes

    • Enhanced handling of token amounts, allowing for better representation of financial data.

4fe8ec3: synapse-interface preview link

Copy link
Contributor

coderabbitai bot commented Jul 25, 2024

Walkthrough

The recent updates to the TransactionPayloadDetail component enhance the precision and consistency of token amount displays. The numeral library has been replaced with a custom formatAmount utility, streamlining number formatting. Adjustments were made to handle both string and numeric formats of tokenAmount, increasing decimal precision from 4 to 18. These changes reflect a robust approach to managing financial data, ensuring clearer and more accurate representations.

Changes

File Path Change Summary
packages/synapse-interface/components/Activity/Transaction/.../TransactionPayloadDetail.tsx Replaced numeral library with formatAmount for number formatting, adjusted handling of tokenAmount for improved precision and consistency.

Poem

In the meadow where numbers play,
A rabbit hops and sings today.
With formats fresh and clear in sight,
Token tales now shine so bright!
Hooray for changes, swift and grand,
A better world at our command! 🐇✨


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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Enhanced the display of small transaction values by replacing the numeral library with a custom formatAmount utility function, increasing precision from 4 to 18 decimal places.

  • Modified packages/synapse-interface/components/Activity/Transaction/components/TransactionPayloadDetail.tsx to use formatAmount for better precision.
  • Integrated formatBigIntToString and trimTrailingZeroesAfterDecimal with formatAmount for consistent formatting.
  • Improved accuracy and readability of transaction details, especially for small values.

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

Deploying sanguine with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7f562af
Status:🚫  Build failed.

View logs

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.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8e30911 and 7f562af.

Files selected for processing (1)
  • packages/synapse-interface/components/Activity/Transaction/components/TransactionPayloadDetail.tsx (3 hunks)
Additional comments not posted (3)
packages/synapse-interface/components/Activity/Transaction/components/TransactionPayloadDetail.tsx (3)

13-13: Import statement looks good!

The import statement for formatAmount is correct.


95-96: JSX rendering logic for tokenAmount as a string looks good!

The changes correctly use formatAmount to format the result of formatBigIntToString with increased precision.

Verification successful

JSX rendering logic for tokenAmount as a string looks good!

The changes correctly use formatAmount to format the result of formatBigIntToString with increased precision.

  • packages/synapse-interface/components/Activity/Transaction/components/TransactionPayloadDetail.tsx
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `formatAmount` and `formatBigIntToString` in the codebase.

# Test: Search for the function usage. Expect: Consistent usage of `formatAmount` and `formatBigIntToString`.
rg --type tsx -A 5 $'formatAmount'
rg --type tsx -A 5 $'formatBigIntToString'

Length of output: 131


Script:

#!/bin/bash
# Description: Verify the usage of `formatAmount` and `formatBigIntToString` in the codebase.

# Test: Search for the function usage. Expect: Consistent usage of `formatAmount` and `formatBigIntToString`.
rg --type-add 'tsx:*.{ts,tsx}' -t tsx -A 5 'formatAmount'
rg --type-add 'tsx:*.{ts,tsx}' -t tsx -A 5 'formatBigIntToString'

Length of output: 56358


102-102: JSX rendering logic for tokenAmount as a number looks good!

The changes correctly use formatAmount to format the tokenAmount after converting it to a string.

Verification successful

JSX rendering logic for tokenAmount as a number looks good!

The changes correctly use formatAmount to format the tokenAmount after converting it to a string. The usage of formatAmount is consistent across the codebase.

  • packages/synapse-interface/components/Activity/Transaction/components/TransactionPayloadDetail.tsx
  • packages/synapse-interface/components/Portfolio/components/PortfolioTokenAsset.tsx
  • packages/synapse-interface/components/ui/SelectSpecificTokenButton.tsx
  • packages/synapse-interface/components/WipWrapperComponents/Ticker.tsx
  • packages/synapse-interface/components/Portfolio/components/PortfolioTokenVisualizer.tsx
  • packages/synapse-interface/components/Portfolio/components/GasTokenAsset.tsx
  • packages/synapse-interface/components/StateManagedBridge/InputContainer.tsx
  • packages/synapse-interface/components/StateManagedSwap/SwapInputContainer.tsx
  • packages/synapse-interface/components/StateManagedBridge/AvailableBalance.tsx
  • packages/explorer-ui/components/misc/IconAndAmount.tsx
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of `formatAmount` in the codebase.

# Test: Search for the function usage. Expect: Consistent usage of `formatAmount`.
rg --type tsx -A 5 $'formatAmount'

Length of output: 61


Script:

#!/bin/bash
# Description: Verify the usage of `formatAmount` in the codebase.

# Test: Search for the function usage. Expect: Consistent usage of `formatAmount`.
rg --type-add 'tsx:*.tsx' --type tsx -A 5 'formatAmount'

Length of output: 17445

Copy link

codecov bot commented Jul 25, 2024

Bundle Report

Changes will increase total bundle size by 4.21MB ⬆️

Bundle name Size Change
sdk-router-@synapsecns/sdk-router-cjs 117.01kB 0 bytes
sdk-router-@synapsecns/sdk-router-esm 252.32kB 0 bytes
synapse-interface-server-cjs 1.38MB 51 bytes ⬇️
synapse-interface-edge-server-array-push 83 bytes 0 bytes
synapse-interface-client-array-push 7.45MB 7.45MB ⬆️
widget-cjs-esm 273.3kB 273.3kB ⬆️
explorer-ui-server-cjs (removed) 895.87kB ⬇️
explorer-ui-edge-server-array-push (removed) 83 bytes ⬇️
explorer-ui-client-array-push (removed) 2.34MB ⬇️
widget-esm-cjs (removed) 275.25kB ⬇️

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7f562af
Status: ✅  Deploy successful!
Preview URL: https://a024b200.sanguine-fe.pages.dev
Branch Preview URL: https://fe-display-small-tx-values.sanguine-fe.pages.dev

View logs

Copy link

codecov bot commented Jul 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.71321%. Comparing base (8e30911) to head (7f562af).

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #2922         +/-   ##
===================================================
+ Coverage   25.39826%   25.71321%   +0.31494%     
===================================================
  Files            785         770         -15     
  Lines          56559       55524       -1035     
  Branches          80          80                 
===================================================
- Hits           14365       14277         -88     
+ Misses         40713       39769        -944     
+ Partials        1481        1478          -3     
Flag Coverage Δ
packages 90.48563% <ø> (ø)
promexporter ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@abtestingalpha abtestingalpha merged commit 390bf29 into master Jul 29, 2024
38 checks passed
@abtestingalpha abtestingalpha deleted the fe/display-small-tx-values branch July 29, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants