Merge pull request #579 from 0xProject/breakUp0xjs

Split 0x.js into: contract-wrappers & order-watcher

1 files changed, 7 insertions, 0 deletions

diff --git a/packages/web3-wrapper/src/web3_wrapper.ts b/packages/web3-wrapper/src/web3_wrapper.ts
index 82e6ef4f9..349e1ed7e 100644
--- a/packages/web3-wrapper/src/web3_wrapper.ts
+++ b/packages/web3-wrapper/src/web3_wrapper.ts
@@ -324,6 +324,13 @@ export class Web3Wrapper {
         const txHash = await promisify<string>(this._web3.eth.sendTransaction)(txData);
         return txHash;
     }
+    /**
+     * Waits for a transaction to be mined and returns the transaction receipt.
+     * @param   txHash            Transaction hash
+     * @param   pollingIntervalMs How often (in ms) should we check if the transaction is mined.
+     * @param   timeoutMs         How long (in ms) to poll for transaction mined until aborting.
+     * @return  Transaction receipt with decoded log args.
+     */
     public async awaitTransactionMinedAsync(
         txHash: string,
         pollingIntervalMs = 1000,