1 files changed, 43 insertions, 0 deletions
diff --git a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts
index 5a2c1d7ff..8a65178b0 100644
--- a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts
+++ b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts
@@ -21,11 +21,21 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
             [userAddress: string]: BigNumber;
         };
     };
+    /**
+     * Instantiates a BalanceAndProxyAllowanceLazyStore
+     * @param balanceAndProxyAllowanceFetcher  Class the implements the AbstractBalanceAndProxyAllowanceFetcher
+     * @return Instance of BalanceAndProxyAllowanceLazyStore
+     */
     constructor(balanceAndProxyAllowanceFetcher: AbstractBalanceAndProxyAllowanceFetcher) {
         this._balanceAndProxyAllowanceFetcher = balanceAndProxyAllowanceFetcher;
         this._balance = {};
         this._proxyAllowance = {};
     }
+    /**
+     * Get a users balance of an asset
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public async getBalanceAsync(assetData: string, userAddress: string): Promise<BigNumber> {
         if (_.isUndefined(this._balance[assetData]) || _.isUndefined(this._balance[assetData][userAddress])) {
             const balance = await this._balanceAndProxyAllowanceFetcher.getBalanceAsync(assetData, userAddress);
@@ -34,12 +44,22 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
         const cachedBalance = this._balance[assetData][userAddress];
         return cachedBalance;
     }
+    /**
+     * Set the balance of an asset for a user
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public setBalance(assetData: string, userAddress: string, balance: BigNumber): void {
         if (_.isUndefined(this._balance[assetData])) {
             this._balance[assetData] = {};
         }
         this._balance[assetData][userAddress] = balance;
     }
+    /**
+     * Clear the balance of an asset for a user
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public deleteBalance(assetData: string, userAddress: string): void {
         if (!_.isUndefined(this._balance[assetData])) {
             delete this._balance[assetData][userAddress];
@@ -48,6 +68,11 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
             }
         }
     }
+    /**
+     * Get the 0x asset proxy allowance
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public async getProxyAllowanceAsync(assetData: string, userAddress: string): Promise<BigNumber> {
         if (
             _.isUndefined(this._proxyAllowance[assetData]) ||
@@ -62,12 +87,22 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
         const cachedProxyAllowance = this._proxyAllowance[assetData][userAddress];
         return cachedProxyAllowance;
     }
+    /**
+     * Set the 0x asset proxy allowance
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public setProxyAllowance(assetData: string, userAddress: string, proxyAllowance: BigNumber): void {
         if (_.isUndefined(this._proxyAllowance[assetData])) {
             this._proxyAllowance[assetData] = {};
         }
         this._proxyAllowance[assetData][userAddress] = proxyAllowance;
     }
+    /**
+     * Clear the 0x asset proxy allowance
+     * @param assetData AssetData of interest
+     * @param userAddress Ethereum address of interest
+     */
     public deleteProxyAllowance(assetData: string, userAddress: string): void {
         if (!_.isUndefined(this._proxyAllowance[assetData])) {
             delete this._proxyAllowance[assetData][userAddress];
@@ -76,6 +111,11 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
             }
         }
     }
+    /**
+     * Clear all ERC721 0x proxy allowances a user has on all items of a specific ERC721 contract
+     * @param tokenAddress ERc721 token address
+     * @param userAddress Owner Ethereum address
+     */
     public deleteAllERC721ProxyAllowance(tokenAddress: string, userAddress: string): void {
         for (const assetData in this._proxyAllowance) {
             if (this._proxyAllowance.hasOwnProperty(assetData)) {
@@ -90,6 +130,9 @@ export class BalanceAndProxyAllowanceLazyStore implements AbstractBalanceAndProx
             }
         }
     }
+    /**
+     * Delete all balances & allowances
+     */
     public deleteAll(): void {
         this._balance = {};
         this._proxyAllowance = {};