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

[wip] feat(synapse-interface): track bridge quoted tokens #3018

Merged
merged 1 commit into from
Aug 13, 2024

Conversation

bigboydiamonds
Copy link
Collaborator

No description provided.

Copy link
Contributor

coderabbitai bot commented Aug 13, 2024

Important

Review skipped

Ignore keyword(s) in the title.

Ignored keywords (2)
  • WIP
  • DO NOT MERGE

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@bigboydiamonds bigboydiamonds changed the base branch from master to fe/track-quoted-input August 13, 2024 22:49
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

This PR introduces changes to track quoted tokens in bridge transactions, focusing on improving the accuracy and reliability of the bridging process. Key modifications include:

  • Added new properties to the BridgeQuote type: inputAmountForQuote, originTokenForQuote, and destTokenForQuote
  • Implemented a check in the executeBridge function to ensure the input amount hasn't changed since the quote was generated
  • Replaced chainSelectionsMatchBridgeQuote with a more comprehensive bridgeStateMatchesQuote comparison in BridgeTransactionButton
  • Introduced constructStringifiedBridgeSelections function for consistent string representations of bridge selections
  • Updated EMPTY_BRIDGE_QUOTE and EMPTY_BRIDGE_QUOTE_ZERO objects with new properties to align with the BridgeQuote type changes

These changes aim to enhance the accuracy of comparing the current bridge state with the obtained quote, potentially reducing errors and improving user experience.

4 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings

Comment on lines 80 to 93
const stringifiedBridgeQuote = constructStringifiedBridgeSelections(
bridgeQuote.inputAmountForQuote,
bridgeQuote.originChainId,
bridgeQuote.destChainId
bridgeQuote.originTokenForQuote,
bridgeQuote.destChainId,
bridgeQuote.destTokenForQuote
)
const stringifiedBridgeState = constructStringifiedBridgeSelections(
debouncedFromValue,
fromChainId,
toChainId
fromToken,
toChainId,
toToken
)
Copy link

Choose a reason for hiding this comment

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

style: Consider memoizing these stringified selections to avoid unnecessary recalculations on each render.

@@ -207,12 +211,16 @@ export const BridgeTransactionButton = ({
const constructStringifiedBridgeSelections = (
Copy link

Choose a reason for hiding this comment

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

logic: This function might produce inconsistent results if the objects have different property orders. Consider using a more robust comparison method.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd16484
Status: ✅  Deploy successful!
Preview URL: https://69095b0a.sanguine-fe.pages.dev
Branch Preview URL: https://fe-track-quoted-tokens.sanguine-fe.pages.dev

View logs

Copy link

Deploying sanguine with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd16484
Status: ✅  Deploy successful!
Preview URL: https://1d1ca79d.sanguine.pages.dev
Branch Preview URL: https://fe-track-quoted-tokens.sanguine.pages.dev

View logs

Copy link

codecov bot commented Aug 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.29168%. Comparing base (7029f33) to head (dd16484).

Additional details and impacted files
@@                    Coverage Diff                    @@
##           fe/track-quoted-input       #3018   +/-   ##
=========================================================
  Coverage               25.29168%   25.29168%           
=========================================================
  Files                        781         781           
  Lines                      56912       56912           
  Branches                      82          82           
=========================================================
  Hits                       14394       14394           
  Misses                     41031       41031           
  Partials                    1487        1487           
Flag Coverage Δ
packages 90.55118% <ø> (ø)

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.

@bigboydiamonds bigboydiamonds merged commit 897cd52 into fe/track-quoted-input Aug 13, 2024
19 checks passed
@bigboydiamonds bigboydiamonds deleted the fe/track-quoted-tokens branch August 13, 2024 23:39
bigboydiamonds added a commit that referenced this pull request Aug 15, 2024
* feat: compare input amount vs tracked quoted input

* Compare stringified bridge quote v bridge state for validation

* Remove log

* feat: track quoted tokens <> bridge quote (#3018)

* replace validation in callback with button check

* memoize bridge selection comparisons

* segment tracking state <> quote mismatch error

* simplify segment

* switch order

* Add back doesBridgeStateMatchQuote

* add back additional bridge quote fields
abtestingalpha pushed a commit that referenced this pull request Aug 16, 2024
* useBridgeSelections

* useBridgeValidations

* fix: stale output, infinite loader

* fix: track when input less than fees

* Remove finally

* apply validation + selection hook to input/output containes

* use bridge state for bridge write actions

* Fix chain comparison

* [wip] feat(synapse-interface): track quoted input (#3011)

* feat: compare input amount vs tracked quoted input

* Compare stringified bridge quote v bridge state for validation

* feat: track quoted tokens <> bridge quote (#3018)

* replace validation in callback with button check

* memoize bridge selection comparisons

* segment tracking state <> quote mismatch error

* simplify segment

* switch order

* Add back doesBridgeStateMatchQuote

* add back additional bridge quote fields

* remove unused bridge selection vars

* fix: conditions for active button for connect wallet

* fix: condition for showing amount must be greater than fee

* hasValidFromSelections
abtestingalpha added a commit that referenced this pull request Aug 26, 2024
* Extracts bridgeQuote into own state

* Moves quote fetching to async thunk

* Bridge approved check hook

* Deprecates redux fromValue in favor of local input component behavior

* useBridgeSelections

* useBridgeValidations

* fix: stale output, infinite loader

* fix: track when input less than fees

* apply validation + selection hook to input/output containes

* use bridge state for bridge write actions

* Fix chain comparison

* feat: compare input amount vs tracked quoted input

* Compare stringified bridge quote v bridge state for validation

* feat: track quoted tokens <> bridge quote (#3018)

* replace validation in callback with button check

* memoize bridge selection comparisons

* segment tracking state <> quote mismatch error

* simplify segment

* switch order

* Add back doesBridgeStateMatchQuote

* add back additional bridge quote fields

* remove unused bridge selection vars

* fix: conditions for active button for connect wallet

* fix: condition for showing amount must be greater than fee

* Checks if user is typing

* Adds swap behavior

---------

Co-authored-by: abtestingalpha <[email protected]>

* Post submit

* Clears input value post submit

---------

Co-authored-by: bigboydiamonds <[email protected]>
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.

1 participant