Add missing comments

2 files changed, 32 insertions, 0 deletions

diff --git a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts
index b2760d98e..7cb859ca7 100644
--- a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts
+++ b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts
@@ -1,6 +1,23 @@
 import { BigNumber } from '@0xproject/utils';
 
+/**l
+ * An abstract class to be implemented in order to use OrderStateUtils. The class that
+ * implements this interface must be capable of fetching the balance and proxyAllowance
+ * for an Ethereum address and assetData
+ */
 export abstract class AbstractBalanceAndProxyAllowanceFetcher {
+    /**
+     * Get balance of assetData for userAddress
+     * @param assetData AssetData for which to fetch the balance
+     * @param userAddress Ethereum address for which to fetch the balance
+     * @return Balance amount in base units
+     */
     public abstract async getBalanceAsync(assetData: string, userAddress: string): Promise<BigNumber>;
+    /**
+     * Get the 0x asset proxy allowance of assetData for userAddress
+     * @param assetData AssetData for which to fetch the allowance
+     * @param userAddress Ethereum address for which to fetch the allowance
+     * @return Allowance amount in base units
+     */
     public abstract async getProxyAllowanceAsync(assetData: string, userAddress: string): Promise<BigNumber>;
 }
diff --git a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
index 865ea4e43..d2b01c359 100644
--- a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
+++ b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
@@ -1,7 +1,22 @@
 import { BigNumber } from '@0xproject/utils';
 
+/**l
+ * An abstract class to be implemented in order to use OrderStateUtils. The class that
+ * implements this interface must be capable of fetching the amount filled of an order
+ * and whether it's been cancelled.
+ */
 export abstract class AbstractOrderFilledCancelledFetcher {
+    /**
+     * Get the amount of the order's takerToken amount already filled
+     * @param orderHash OrderHash of order we are interested in
+     * @return FilledTakerAmount
+     */
     public abstract async getFilledTakerAmountAsync(orderHash: string): Promise<BigNumber>;
+    /**
+     * Whether an order is cancelled
+     * @param orderHash OrderHash of order we are interested in
+     * @return Whether or not the order is cancelled
+     */
     public abstract async isOrderCancelledAsync(orderHash: string): Promise<boolean>;
     public abstract getZRXAssetData(): string;
 }