feat(wallet): migrate 0x Swap API to v2 #26231

onyb · 2024-10-25T15:55:57Z

Resolves brave/brave-browser#41891

Submitter Checklist:

I confirm that no security/privacy review is needed and no other type of reviews are needed, or that I have requested them
There is a ticket for my issue
Used Github auto-closing keywords in the PR description above
Wrote a good PR/commit description
Squashed any review feedback or "fixup" commits before merge, so that history is a record of what happened in the repo, not your PR
Added appropriate labels (QA/Yes or QA/No; release-notes/include or release-notes/exclude; OS/...) to the associated issue
Checked the PR locally:
- npm run test -- brave_browser_tests, npm run test -- brave_unit_tests wiki
- npm run presubmit wiki, npm run gn_check, npm run tslint
Ran git rebase master (if needed)

Reviewer Checklist:

A security review is not needed, or a link to one is included in the PR description
New files have MPL-2.0 license header
Adequate test coverage exists to prevent regressions
Major classes, functions and non-trivial code blocks are well-commented
Changes in component dependencies are properly reflected in gn
Code follows the style guide
Test plan is specified in PR before merging

After-merge Checklist:

The associated issue milestone is set to the smallest version that the
changes has landed on
All relevant documentation has been updated, for instance:

Test Plan:

See STR in linked issue

Douglashdaniel

++

components/brave_wallet/browser/brave_wallet_constants.cc

components/brave_wallet/browser/swap_service.cc

components/brave_wallet/browser/swap_response_parser.cc

nuo-xu · 2024-10-28T17:14:54Z

components/brave_wallet/common/brave_wallet.mojom

@@ -448,74 +448,71 @@ union SwapTransactionParamsUnion {

 union SwapQuoteUnion {
  JupiterQuote jupiter_quote;
-  ZeroExQuote zero_ex_quote;
+  ZeroExQuoteInfo zero_ex_quote;


should we change this to zero_ex_quote_info to distinguish from ZeroExQuote? it seems ZeroExQuoteInfo now contains an optional of ZeroExQuote

The refactoring here should fix this.

nuo-xu · 2024-10-28T17:21:17Z

components/brave_wallet_ui/page/screens/swap/hooks/useSwap.ts

+      // 0x specific validations
+      if (quoteUnion?.zeroExQuote?.liquidityAvailable === false) {
+        return 'insufficientLiquidity'
+      }

+      if (quoteErrorUnion?.zeroExError) {


In this case, shouldn't quoteErrorUnion.zeroExError. isInsufficientLiquidity == true?
checking both QuoteUnion and QuoteErrorUnion for errors seems odd to me. Also the quoteErrorUnion.zeroExError.isInsufficientAllowance case seems to be ignored.

This was actually done because 0x API v2 now returns isInsufficientLiquidity as part of the quote instead of an error response. But now that I think about it, retaining the old interface is cleaner. You can find this change here: review(nuo-xu): reuse ZeroExQuote and drop ZeroExQuoteInfo struct

Also the quoteErrorUnion.zeroExError.isInsufficientAllowance case seems to be ignored

Allowance checks are no longer returned as part of the error response from the API. If this changes in future, will add this back. Meanwhile, the desktop code already handles allowance checks just like LiFi and Squid.

brave-builds · 2024-10-30T12:26:08Z

A Storybook has been deployed to preview UI for the latest push

supermassive

wallet core lgtm

nuo-xu · 2024-11-05T04:44:37Z

components/brave_wallet/common/brave_wallet.mojom

 };

 struct ZeroExFees {
  ZeroExFee? zero_ex_fee;
 };

-struct ZeroExQuote {
-  string price;


is it possible to keep the price in ZeroExQuote? we are using it to calculate sell_token's market price value. I don't think desktop UI has market value displayed in swap. iOS has an outdated UI still has this Market Price value

Is it possible to infer this on this client-side like we do on desktop?

brave-core/components/brave_wallet_ui/page/screens/swap/swap.utils.ts

Lines 83 to 85 in 369f9d6

rate: new Amount(quote.buyAmount)

.divideByDecimals(toToken.decimals)

.div(new Amount(quote.sellAmount).divideByDecimals(fromToken.decimals)),

In the backend, we no longer have this field and we don't know about the buy/sell token decimals to be able to correctly compute the rate.

~~we have no problem with sell amount and buy amount. just the market price for the sell token.~~
~~i think iOS can do one of the following:~~
~~1. fetch market price for sell token using assetRatioService api instead of from quote response.~~
~~2. remove this market price label but need to move that refresh button else where for users to refetch quote.~~
~~cc @jamesmudgett and design @kleantzogu~~

My understanding is that "Market Price in ETH" is the exchange rate between buyToken and sellToken. I don't think using the assetRatioService will be correct here, since it's the CEX/global exchange rate and not the one as per the AMM swap quote.

you are right. i think this leave us removing that label. i just need to figure out where to put that refetch button.

Highlighting again (see #26231 (comment)) that the "Market price in <sellToken>" can be determined using buyAmount and sellAmount formatted with their respective decimals.

Note that it's "Market price in ETH" and not "Market price of ETH".

ah! i mistakenly thought the sell amount and buy amount are from the ZeroExTransaction. ok yeah i think we can using those two values to determine the market price. Thanks!

github-actions · 2024-11-05T20:37:06Z

[puLL-Merge] - brave/brave-core@26231

Description

This PR updates the 0x API integration in the Brave Wallet to use the newer allowance-holder API. It modifies the request and response handling for quotes and transactions, updates the data models, and adjusts the UI components to work with the new data structure.

Possible Issues

The removal of the estimatedPriceImpact field from the 0x response might affect the accuracy of displayed price impact information. The new calculation method using fiat values could potentially be less accurate or behave differently in edge cases.
The change in the way routing information is handled (from sources to route.fills) might lead to inconsistencies in how multi-hop or split trades are displayed or processed.

Security Hotspots

The new allowance target address is now being fetched from a predefined list based on the chain ID. Ensure that this list is kept up-to-date and secure, as using an incorrect allowance target could potentially lead to loss of funds.
The removal of the skipValidation parameter in the API requests means that allowance checks are now likely performed on the server-side. Ensure that this doesn't introduce any new attack vectors or ways to bypass important checks.

Changes

Changes

components/brave_wallet/browser/brave_wallet_constants.cc:

Added a new function GetZeroExAllowanceHolderAddress to retrieve the allowance holder address for a given chain ID.
Removed several chain-specific API URL constants.

components/brave_wallet/browser/brave_wallet_constants.h:

Updated constants related to 0x API, including removing chain-specific URLs and adding new allowance holder addresses.
Added declaration for GetZeroExAllowanceHolderAddress function.

components/brave_wallet/browser/swap_response_parser.cc:

Significantly refactored the parsing logic for 0x API responses to match the new allowance-holder API structure.
Updated error handling to match new error response format.

components/brave_wallet/browser/swap_response_parser.h:

Updated function signatures to reflect changes in parsing logic.

components/brave_wallet/browser/swap_response_parser_unittest.cc:

Updated unit tests to match new response structures and parsing logic.

components/brave_wallet/browser/swap_service.cc:

Updated URL construction for 0x API requests to use the new allowance-holder endpoints.
Modified request parameter handling to match the new API requirements.
Updated error handling and response processing.

components/brave_wallet/browser/swap_service.h:

Updated function signatures to reflect changes in service logic.

components/brave_wallet/browser/swap_service_unittest.cc:

Updated unit tests to match new service behavior and API structures.

components/brave_wallet/common/brave_wallet.mojom:

Updated data structures to match new 0x API response format.

components/brave_wallet_ui/common/async/mocks/bridge.ts:

Updated mock data structures to match new 0x API response format.

components/brave_wallet_ui/page/screens/swap/hooks/useSwap.ts:

Removed check for isInsufficientAllowance in 0x error handling.

components/brave_wallet_ui/page/screens/swap/hooks/useZeroEx.ts:

Updated transaction processing to use gas instead of estimatedGas.

components/brave_wallet_ui/page/screens/swap/swap.utils.ts:

Updated quote option generation to use new data structure from 0x API.
Modified price impact calculation to use fiat values instead of the removed estimatedPriceImpact field.

ios/brave-ios/Sources/BraveWallet/Crypto/Stores/SwapTokenStore.swift:

Updated handling of 0x quote data to match new response structure.
Modified price and amount calculations to use new fields.

ios/brave-ios/Sources/BraveWallet/Preview MockContent.swift:

Updated mock 0x quote data to match new structure.

ios/brave-ios/Sources/BraveWallet/Preview MockSwapService.swift:

Updated mock swap service to use new 0x transaction structure.

ios/brave-ios/Tests/BraveWalletTests/SwapTokenStoreTests.swift:

Updated test data to match new 0x quote structure.

StephenHeaps

@onyb @nuo-xu Safer sign isn't showing with Zero Ex anymore (iOS & desktop), is that known / expected with this change?

StephenHeaps · 2024-11-05T21:54:29Z

ios/brave-ios/Sources/BraveWallet/Preview Content/MockContent.swift

+        proportionBps: "10000"
+      )]
+    ),
+    sellAmount: "1000000000000000000",


nite: restore the 1 ETH comment

onyb · 2024-11-06T10:48:49Z

Safer sign isn't showing with Zero Ex anymore (iOS & desktop)

@StephenHeaps Yes this is expected. The contracts are not public yet, so I'm unable to add the parsers right now. Will follow it up in a future PR.

brave-builds · 2024-11-07T00:17:18Z

Released in v1.75.1

onyb requested review from a team as code owners October 25, 2024 15:55

github-actions bot assigned onyb Oct 25, 2024

github-actions bot added CI/storybook-url Deploy storybook and provide a unique URL for each build feature/web3/wallet feature/web3/wallet/core chromium-version-mismatch The Chromium version on the PR branch does not match the version on the target branch puLL-Merge labels Oct 25, 2024

Douglashdaniel approved these changes Oct 25, 2024

View reviewed changes

supermassive reviewed Oct 28, 2024

View reviewed changes

components/brave_wallet/browser/brave_wallet_constants.cc Outdated Show resolved Hide resolved

supermassive reviewed Oct 28, 2024

View reviewed changes

components/brave_wallet/browser/brave_wallet_constants.cc Outdated Show resolved Hide resolved

supermassive reviewed Oct 28, 2024

View reviewed changes

components/brave_wallet/browser/swap_service.cc Outdated Show resolved Hide resolved

supermassive reviewed Oct 28, 2024

View reviewed changes

components/brave_wallet/browser/swap_response_parser.cc Outdated Show resolved Hide resolved

nuo-xu reviewed Oct 28, 2024

View reviewed changes

onyb added 7 commits October 30, 2024 12:01

feat(wallet): migrate 0x Swap API to v2

44a7c85

Fix presubmit errors

22110ee

review(supermassive): return std::nullopt instead of empty string

a6df80c

review(supermassive): separate function for 0x headers

21ac0e1

review(supermassive): concise if-condition

dcf4616

review(supermassive): use base::NoDestructor

8b20e11

review(nuo-xu): reuse ZeroExQuote and drop ZeroExQuoteInfo struct

1bbee57

onyb force-pushed the f/wallet/0x-api-v2 branch from 1471c24 to 1bbee57 Compare October 30, 2024 08:14

github-actions bot removed the chromium-version-mismatch The Chromium version on the PR branch does not match the version on the target branch label Oct 30, 2024

onyb requested a review from nuo-xu October 30, 2024 08:27

Fix storybook build

bbcccca

supermassive approved these changes Oct 31, 2024

View reviewed changes

nuo-xu reviewed Nov 5, 2024

View reviewed changes

some updates after 0x api migration in core.

51c3eca

nuo-xu requested a review from a team as a code owner November 5, 2024 20:36

nuo-xu requested a review from StephenHeaps November 5, 2024 21:07

StephenHeaps reviewed Nov 5, 2024

View reviewed changes

review(stephen) adding comment

60e3ddb

StephenHeaps approved these changes Nov 6, 2024

View reviewed changes

nuo-xu approved these changes Nov 6, 2024

View reviewed changes

onyb merged commit 606c380 into master Nov 6, 2024
17 checks passed

onyb deleted the f/wallet/0x-api-v2 branch November 6, 2024 16:21

github-actions bot added this to the 1.73.x - Nightly milestone Nov 6, 2024

bsclifton modified the milestones: 1.73.x - Nightly, 1.74.x - Nightly Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(wallet): migrate 0x Swap API to v2 #26231

feat(wallet): migrate 0x Swap API to v2 #26231

onyb commented Oct 25, 2024

Douglashdaniel left a comment

nuo-xu Oct 28, 2024

onyb Oct 30, 2024

nuo-xu Oct 28, 2024

onyb Oct 30, 2024

brave-builds commented Oct 30, 2024

supermassive left a comment

nuo-xu Nov 5, 2024 •

edited

Loading

onyb Nov 5, 2024 •

edited

Loading

nuo-xu Nov 5, 2024 •

edited

Loading

onyb Nov 5, 2024

nuo-xu Nov 5, 2024

onyb Nov 5, 2024

onyb Nov 5, 2024

nuo-xu Nov 5, 2024

github-actions bot commented Nov 5, 2024

Changes

StephenHeaps left a comment

StephenHeaps Nov 5, 2024

onyb commented Nov 6, 2024

brave-builds commented Nov 7, 2024

	rate: new Amount(quote.buyAmount)
	.divideByDecimals(toToken.decimals)
	.div(new Amount(quote.sellAmount).divideByDecimals(fromToken.decimals)),

feat(wallet): migrate 0x Swap API to v2 #26231

feat(wallet): migrate 0x Swap API to v2 #26231

Conversation

onyb commented Oct 25, 2024

Submitter Checklist:

Reviewer Checklist:

After-merge Checklist:

Test Plan:

Douglashdaniel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brave-builds commented Oct 30, 2024

supermassive left a comment

Choose a reason for hiding this comment

nuo-xu Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

onyb Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

nuo-xu Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 5, 2024

Description

Possible Issues

Security Hotspots

Changes

StephenHeaps left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onyb commented Nov 6, 2024

brave-builds commented Nov 7, 2024

nuo-xu Nov 5, 2024 •

edited

Loading

onyb Nov 5, 2024 •

edited

Loading

nuo-xu Nov 5, 2024 •

edited

Loading