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

…comments-info Update comments for asset-swapper
0xProject · Aug 2, 2019 · 78c704e · 78c704e
2 parents 50f1a8f + 0f90b7b
commit 78c704e
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/packages/asset-swapper/src/types.ts b/packages/asset-swapper/src/types.ts
@@ -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;