aboutsummaryrefslogtreecommitdiffstats
path: root/src/contract_wrappers
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-09-26 21:29:08 +0800
committerFabio Berger <me@fabioberger.com>2017-09-26 21:29:08 +0800
commitfbac611337593b9bf03552637e709c45bdeee4ed (patch)
treeef4692318b33a051e25120646a41e9a3a17bbf6e /src/contract_wrappers
parent98863836381ad56f4c7c3357baeaa57b96712732 (diff)
downloaddexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar.gz
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar.bz2
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar.lz
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar.xz
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.tar.zst
dexon-sol-tools-fbac611337593b9bf03552637e709c45bdeee4ed.zip
improve comment
Diffstat (limited to 'src/contract_wrappers')
-rw-r--r--src/contract_wrappers/exchange_wrapper.ts3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/contract_wrappers/exchange_wrapper.ts b/src/contract_wrappers/exchange_wrapper.ts
index 809bdebc5..c81e7919f 100644
--- a/src/contract_wrappers/exchange_wrapper.ts
+++ b/src/contract_wrappers/exchange_wrapper.ts
@@ -625,7 +625,8 @@ export class ExchangeWrapper extends ContractWrapper {
return exchangeAddress;
}
/**
- * Checks if order is still fillable and throws an error otherwise.
+ * Checks if order is still fillable and throws an error otherwise. Useful for orderbook
+ * pruning where you want to remove stale orders without knowing who the taker will be.
* @param signedOrder An object that conforms to the SignedOrder interface. The
* signedOrder you wish to validate.
* @param opts An object that conforms to the ValidateOrderFillableOpts