From 44f11442424c88d1130ee398d0714636c5ade045 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Thu, 1 Jun 2017 16:21:01 +0200
Subject: Add comment for fillOrderAsync method, rename fillAmount to
 fillTakerAmountInBaseUnits and remove default value for shouldCheckTransfer

---
 src/contract_wrappers/exchange_wrapper.ts | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

(limited to 'src/contract_wrappers/exchange_wrapper.ts')

diff --git a/src/contract_wrappers/exchange_wrapper.ts b/src/contract_wrappers/exchange_wrapper.ts
index dbb427d2c..40f22bd28 100644
--- a/src/contract_wrappers/exchange_wrapper.ts
+++ b/src/contract_wrappers/exchange_wrapper.ts
@@ -57,18 +57,23 @@ export class ExchangeWrapper extends ContractWrapper {
         );
         return isValidSignature;
     }
-    public async fillOrderAsync(signedOrder: SignedOrder, fillAmount: BigNumber.BigNumber,
-                                shouldCheckTransfer: boolean = true): Promise<void> {
+    /**
+     * Fills a signed order with a specified amount in baseUnits of the taker token. The caller can
+     * decide whether they want the call to throw if the balance/allowance checks fail by setting
+     * shouldCheckTransfer to false. If true, the call will fail without throwing, preserving gas costs.
+     */
+    public async fillOrderAsync(signedOrder: SignedOrder, fillTakerAmountInBaseUnits: BigNumber.BigNumber,
+                                shouldCheckTransfer: boolean): Promise<void> {
         assert.doesConformToSchema('signedOrder',
                                    SchemaValidator.convertToJSONSchemaCompatibleObject(signedOrder as object),
                                    signedOrderSchema);
-        assert.isBigNumber('fillAmount', fillAmount);
+        assert.isBigNumber('fillTakerAmountInBaseUnits', fillTakerAmountInBaseUnits);
         assert.isBoolean('shouldCheckTransfer', shouldCheckTransfer);
 
         const senderAddress = await this.web3Wrapper.getSenderAddressOrThrowAsync();
         const exchangeInstance = await this.getExchangeInstanceOrThrowAsync();
 
-        this.validateFillOrder(signedOrder, fillAmount, senderAddress, shouldCheckTransfer);
+        this.validateFillOrder(signedOrder, fillTakerAmountInBaseUnits, senderAddress, shouldCheckTransfer);
 
         const orderAddresses: OrderAddresses = [
             signedOrder.maker,
@@ -88,7 +93,7 @@ export class ExchangeWrapper extends ContractWrapper {
         const gas = await exchangeInstance.fill.estimateGas(
             orderAddresses,
             orderValues,
-            fillAmount,
+            fillTakerAmountInBaseUnits,
             shouldCheckTransfer,
             signedOrder.ecSignature.v,
             signedOrder.ecSignature.r,
@@ -100,7 +105,7 @@ export class ExchangeWrapper extends ContractWrapper {
         const response: ContractResponse = await exchangeInstance.fill(
             orderAddresses,
             orderValues,
-            fillAmount,
+            fillTakerAmountInBaseUnits,
             shouldCheckTransfer,
             signedOrder.ecSignature.v,
             signedOrder.ecSignature.r,
-- 
cgit