fix: unify the response data from /swap/v0/price and /meta_transaction/v0/price #228
Conversation
| price: BigNumber; | ||
| buyAmount: BigNumber; | ||
| sellAmount: BigNumber; | ||
| sellTokenAddress: string; |
There was a problem hiding this comment.
This uses the token address to be in line with the quote endpoint. However, the prices endpoint returns symbols.
Either symbol or token address would work as long as it's consistent.
There was a problem hiding this comment.
@kimpers are you referring to https://api.0x.org/swap/v0/prices ?
There was a problem hiding this comment.
Yeah exactly.
It would be nice to have consistency across the board, if we go with token address here maybe we should add it there as well or vice versa.
There was a problem hiding this comment.
I agree it should be consistently address since we cannot guarantee symbol.
kimpers
changed the title
kimpers
changed the title
|
@kimpers can you create a PR in the documentation as mentioned in https://github.com/0xProject/0x-api/blob/master/PULL_REQUEST_TEMPLATE.md |
| price: BigNumber; | ||
| buyAmount: BigNumber; | ||
| sellAmount: BigNumber; | ||
| sellTokenAddress: string; |
There was a problem hiding this comment.
@kimpers are you referring to https://api.0x.org/swap/v0/prices ?
| sellAmount, | ||
| buyAmount, | ||
| buyAmount: makerAssetAmount, | ||
| sellAmount: totalTakerAssetAmount, |
There was a problem hiding this comment.
Noticed that the metatx endpoint would only return the argument you pass to it, whereas the swap endpoint always returns buyAmount and sellAmount.
kimpers
force-pushed
the
kim/unify-interface-of-price-endpoints
branch
from
058b128
to
9581199
Compare
kimpers
force-pushed
the
kim/unify-interface-of-price-endpoints
branch
from
9581199
to
68699f8
Compare
|
deploy staging |
Implemented in 0xProject/website#298. Additionally, the linting is now failing due to CHANGELOG. Should I manually add an entry to the file or what is the process for this? |
kimpers
changed the title
|
@kimpers yes sorry about the changelog. Can you modify the prettier glob pattern in package.json to just ignore the changelog? Humans don't touch it anyway. |
Fixed 👍 |
kimpers
force-pushed
the
kim/unify-interface-of-price-endpoints
branch
from
dea962c
to
68699f8
Compare
kimpers
force-pushed
the
kim/unify-interface-of-price-endpoints
branch
from
68699f8
to
d06c39c
Compare
There was a problem hiding this comment.
Ok so I honestly didn't realize this was modifying the swap/v0/price endpoint. I think this is for RFQT only, and maybe that is why it is not documented. Seems confusing to have both /quote and /price if you don't know about RFQT.
So maybe I was wrong about documenting this, my apologies.
| price: BigNumber; | ||
| buyAmount: BigNumber; | ||
| sellAmount: BigNumber; | ||
| sellTokenAddress: string; |
There was a problem hiding this comment.
I agree it should be consistently address since we cannot guarantee symbol.
# [1.5.0](v1.4.0...v1.5.0) (2020-05-25) ### Bug Fixes * unify the response data from /swap/v0/price and /meta_transaction/v0/price ([#228](#228)) ([62f3fae](62f3fae)) ### Features * Add Prometheus Monitoring ([#222](#222)) ([5a51add](5a51add)) * added an epochs/n endpoint to get info on an arbitrary epoch ([#230](#230)) ([68ec159](68ec159)) * lower default slippage percentage to 1% ([#238](#238)) ([c7ec0ff](c7ec0ff)) * MetaTxn add signer heartbeat and status ([#236](#236)) ([3a11867](3a11867)) * set default skip RFQt buy requests to false ([#232](#232)) ([a5d7a1c](a5d7a1c))
|
🎉 This PR is included in version 1.5.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Description
This fixes #227.
When integrating with the
/priceendpoints I noticed that the data returned back is very sparse compared to the quote endpoint. I also noticed that two endpoints return different data, so I tried to unify to the point it makes sense.For us, it would be very helpful to be able to derive the pair from the response data so we don't have to keep track of that locally in the global state.
Testing Instructions
TODO:
Checklist
[WIP]if necessary.