Feature/sc 2663/wrap amm quote requests in api #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this is a huge refactor and rewrite of the pricing api, covering @nftx/api, @nftx/core, and @nftx/trade the individual quoting methods (fetchVaultBuyPrice etc) have been removed in favour of two methods: fetchQuote, and fetchPrice fetchPrice returns an off-chain price, fetchQuote returns an on-chain quote with executable data the different types of pricing calls can now be chosen via the `type` parameter, which can be buy/sell/swap/mint/redeem and the new type: erc20 BREAKING CHANGE: price methods have been removed in favour of fetchPrice and fetchQuote BREAKING CHANGE: tradeErc20 method now takes a quote object (obtained from fetchQuote) instead of a price object (from fetchTokenBuyPrice) BREAKING CHANGE: fetchTokenBuyPrice has been replaced with fetchAmmQuote - though fetchQuote/fetchPrice should be preferred
these methods were previously in @nftx/trade and interacted directly with the AMM router as we now have an API layer for requesting ERC20 quotes, these methods have been moved to @nftx/api BREAKING CHANGE: these methods are no longer available in @nftx/trade
this function takes any quote from fetchQuote and fulfills it, regardless of whether it's a sell/buy, a mint/redeem, or an ERC20 quote
jackmellis
force-pushed
the
feature/sc-2663/wrap-amm-quote-requests-in-api
branch
from
0c8370d to
4c11b2e
Compare
0xNumlock
reviewed
May 22, 2024
| function fetchQuote(args: QuoteArgs): Promise<MarketplaceQuote>; | ||
| function fetchQuote(args: PriceArgs | QuoteArgs) { | ||
| /** Returns an on-chain quote for a transaction. The response object can be passed into @nftx/trade's fulfill method to execute the quote */ | ||
| function fetchQuote(args: BuyArgs & PriceArgs): Promise<MarketplacePrice>; |
There was a problem hiding this comment.
Isn't it easier/more readable just to have an interface with all the props?
There was a problem hiding this comment.
I did it this way so ts can tell you which props you actually need to provide for each type of txn, otherwise it's a whole mess of optional props and it'd be difficult to know which things you need to pass and when
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
feat: ERC20 quotes can now be obtained via the nftx api
this is a huge refactor and rewrite of the pricing api, covering @nftx/api, @nftx/core, and @nftx/trade
the individual quoting methods (fetchVaultBuyPrice etc) have been removed in favour of two methods: fetchQuote, and fetchPrice
fetchPrice returns an off-chain price, fetchQuote returns an on-chain quote with executable data
the different types of pricing calls can now be chosen via the
typeparameter, which can be buy/sell/swap/mint/redeem and the new type: erc20BREAKING CHANGE: price methods have been removed in favour of fetchPrice and fetchQuote
BREAKING CHANGE: tradeErc20 method now takes a quote object (obtained from fetchQuote) instead of a price object (from fetchTokenBuyPrice)
BREAKING CHANGE: fetchTokenBuyPrice has been replaced with fetchAmmQuote - though fetchQuote/fetchPrice should be preferred
refactor: move fetchEthPrice / fetchSpread / fetchSpotPrice to @nftx/api
these methods were previously in @nftx/trade and interacted directly with the AMM router
as we now have an API layer for requesting ERC20 quotes, these methods have been moved to @nftx/api
BREAKING CHANGE: these methods are no longer available in @nftx/trade
feat(@nftx/trade): add fulfill function
this function takes any quote from fetchQuote and fulfills it, regardless of whether it's a sell/buy, a mint/redeem, or an ERC20 quote