Merge pull request #2032 from 0xProject/feature/asset-swapper/update-comments-info

Update comments for asset-swapper
This commit is contained in:
David Sun
2019-08-02 13:47:48 -07:00
committed by GitHub

View File

@@ -256,9 +256,10 @@ export interface MarketBuySwapQuoteWithAffiliateFee extends SwapQuoteWithAffilia
export type SwapQuoteWithAffiliateFee = MarketBuySwapQuoteWithAffiliateFee | MarketSellSwapQuoteWithAffiliateFee; export type SwapQuoteWithAffiliateFee = MarketBuySwapQuoteWithAffiliateFee | MarketSellSwapQuoteWithAffiliateFee;
/** /**
* assetEthAmount: The amount of eth required to pay for the requested asset. * feeTakerTokenAmount: The amount of takerToken required any fee concerned with completing the swap.
* feeEthAmount: The amount of eth required to pay any fee concerned with completing the swap. * takerTokenAmount: The amount of takerToken required to conduct the swap.
* totalEthAmount: The total amount of eth required to complete the buy (filling orders, feeOrders, and paying affiliate fee). * totalTakerTokenAmount: The total amount of takerToken required to complete the swap (filling orders, feeOrders, and paying affiliate fee)
* makerTokenAmount: The amount of makerToken that will be acquired through the swap.
*/ */
export interface SwapQuoteInfo { export interface SwapQuoteInfo {
feeTakerTokenAmount: BigNumber; feeTakerTokenAmount: BigNumber;