0.22.6

Allow timeout for await transaction mined

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+v0.22.6 - _November 10, 2017_
+------------------------
+    * Add a timeout parameter to transaction awaiting (#206)
+
+v0.22.5 - _November 7, 2017_
+------------------------
+    * Re-publish v0.22.4 to fix publishing issue
+
 v0.22.4 - _October 25, 2017_
 ------------------------
     * Upgraded bignumber.js to a new version that ships with native typings

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "0x.js",
-  "version": "0.22.4",
+  "version": "0.22.6",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "0x.js",
-  "version": "0.22.4",
+  "version": "0.22.6",
   "description": "A javascript library for interacting with the 0x protocol",
   "keywords": [
     "0x.js",
@@ -58,7 +58,6 @@
     "@types/sinon": "^2.2.2",
     "@types/uuid": "^3.4.2",
     "awesome-typescript-loader": "^3.1.3",
-    "bignumber.js": "^4.0.2",
     "chai": "^4.0.1",
     "chai-as-promised": "^7.1.0",
     "chai-as-promised-typescript-typings": "0.0.3",

src/0x.ts

@@ -289,13 +289,24 @@ export class ZeroEx {
      * 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: number = 1000): Promise<TransactionReceiptWithDecodedLogs> {
+        txHash: string, pollingIntervalMs = 1000, timeoutMs?: number): Promise<TransactionReceiptWithDecodedLogs> {
+        let timeoutExceeded = false;
+        if (timeoutMs) {
+            setTimeout(() => timeoutExceeded = true, timeoutMs);
+        }
+
         const txReceiptPromise = new Promise(
             (resolve: (receipt: TransactionReceiptWithDecodedLogs) => void, reject) => {
             const intervalId = intervalUtils.setAsyncExcludingInterval(async () => {
+                if (timeoutExceeded) {
+                    intervalUtils.clearAsyncExcludingInterval(intervalId);
+                    return reject(ZeroExError.TransactionMiningTimeout);
+                }
+
                 const transactionReceipt = await this._web3Wrapper.getTransactionReceiptAsync(txHash);
                 if (!_.isNull(transactionReceipt)) {
                     intervalUtils.clearAsyncExcludingInterval(intervalId);
@@ -311,6 +322,7 @@ export class ZeroEx {
                 }
             }, pollingIntervalMs);
         });
+
         return txReceiptPromise;
     }
     /*

src/contract_wrappers/exchange_wrapper.ts

@@ -304,9 +304,9 @@ export class ExchangeWrapper extends ContractWrapper {
     /**
      * Batch version of fillOrderAsync.
      * Executes multiple fills atomically in a single transaction.
-     * If shouldThrowOnInsufficientBalanceOrAllowance is set to true, it will continue filling subsequent orders even
+     * If shouldThrowOnInsufficientBalanceOrAllowance is set to false, it will continue filling subsequent orders even
      * when earlier ones fail.
-     * When shouldThrowOnInsufficientBalanceOrAllowance is set to false, if any fill fails, the entire batch fails.
+     * When shouldThrowOnInsufficientBalanceOrAllowance is set to true, if any fill fails, the entire batch fails.
      * @param   orderFillRequests                               An array of objects that conform to the
      *                                                          OrderFillRequest interface.
      * @param   shouldThrowOnInsufficientBalanceOrAllowance     Whether or not you wish for the contract call to throw

src/types.ts

@@ -16,6 +16,7 @@ export enum ZeroExError {
     OutOfGas = 'OUT_OF_GAS',
     NoNetworkId = 'NO_NETWORK_ID',
     SubscriptionNotFound = 'SUBSCRIPTION_NOT_FOUND',
+    TransactionMiningTimeout = 'TRANSACTION_MINING_TIMEOUT',
 }
 
 export enum InternalZeroExError {