From aa9aa1f58a4e63b5e5c7863f3b7afb020d7712c5 Mon Sep 17 00:00:00 2001 From: Steve Klebanoff Date: Fri, 14 Dec 2018 17:05:52 -0800 Subject: more documentation --- packages/asset-buyer/src/errors.ts | 6 ++++++ 1 file changed, 6 insertions(+) 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; -- cgit v1.2.3