Update comments for asset-swapper

This commit is contained in:
David Sun 2019-08-02 13:32:45 -07:00
parent bec4384a5d
commit 0f90b7b5da

View File

@ -256,9 +256,10 @@ export interface MarketBuySwapQuoteWithAffiliateFee extends SwapQuoteWithAffilia
export type SwapQuoteWithAffiliateFee = MarketBuySwapQuoteWithAffiliateFee | MarketSellSwapQuoteWithAffiliateFee;
/**
* assetEthAmount: The amount of eth required to pay for the requested asset.
* feeEthAmount: The amount of eth required to pay any fee concerned with completing the swap.
* totalEthAmount: The total amount of eth required to complete the buy (filling orders, feeOrders, and paying affiliate fee).
* feeTakerTokenAmount: The amount of takerToken required any fee concerned with completing the swap.
* takerTokenAmount: The amount of takerToken required to conduct the swap.
* 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 {
feeTakerTokenAmount: BigNumber;