aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteve Klebanoff <steve.klebanoff@gmail.com>2018-12-15 09:05:52 +0800
committerSteve Klebanoff <steve.klebanoff@gmail.com>2018-12-15 09:05:52 +0800
commitaa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5 (patch)
tree41d4675645086cf24a7abf6d1d964bfd2fda6381
parent2e2e157fc8bb9da26e01ebf0b62e1cb74515d187 (diff)
downloaddexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar.gz
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar.bz2
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar.lz
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar.xz
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.tar.zst
dexon-sol-tools-aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5.zip
more documentation
-rw-r--r--packages/asset-buyer/src/errors.ts6
1 files changed, 6 insertions, 0 deletions
diff --git a/packages/asset-buyer/src/errors.ts b/packages/asset-buyer/src/errors.ts
index ef05a5d0a..68e9a684b 100644
--- a/packages/asset-buyer/src/errors.ts
+++ b/packages/asset-buyer/src/errors.ts
@@ -6,7 +6,13 @@ import { AssetBuyerError } from './types';
* Error class representing insufficient asset liquidity
*/
export class InsufficientAssetLiquidityError extends Error {
+ /**
+ * The amount availabe to fill (in base units) factoring in slippage.
+ */
public amountAvailableToFill?: BigNumber;
+ /**
+ * @param amountAvailableToFill The amount availabe to fill (in base units) factoring in slippage
+ */
constructor(amountAvailableToFill?: BigNumber) {
super(AssetBuyerError.InsufficientAssetLiquidity);
this.amountAvailableToFill = amountAvailableToFill;