aboutsummaryrefslogtreecommitdiffstats
path: root/src/contract_wrappers
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-06-01 22:21:01 +0800
committerFabio Berger <me@fabioberger.com>2017-06-01 22:21:01 +0800
commit44f11442424c88d1130ee398d0714636c5ade045 (patch)
treeec20da1effc99603a8f1bdeb85c5194062c2cfd1 /src/contract_wrappers
parent771c88ec791cb6bedf2ddd3418e89dec1581e326 (diff)
downloaddexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar.gz
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar.bz2
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar.lz
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar.xz
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.tar.zst
dexon-sol-tools-44f11442424c88d1130ee398d0714636c5ade045.zip
Add comment for fillOrderAsync method, rename fillAmount to fillTakerAmountInBaseUnits and remove default value for shouldCheckTransfer
Diffstat (limited to 'src/contract_wrappers')
-rw-r--r--src/contract_wrappers/exchange_wrapper.ts17
1 files changed, 11 insertions, 6 deletions
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,