Add isVerbose flag to contract-wrappers subscribe methods

packages/contract-wrappers/src/contract_wrappers/contract_wrapper.ts

@@ -7,7 +7,7 @@ import {
     LogWithDecodedArgs,
     RawLog,
 } from '@0xproject/types';
-import { AbiDecoder, intervalUtils } from '@0xproject/utils';
+import { intervalUtils, logUtils } from '@0xproject/utils';
 import { Web3Wrapper } from '@0xproject/web3-wrapper';
 import { Block, BlockAndLogStreamer, Log } from 'ethereumjs-blockstream';
 import * as _ from 'lodash';
@@ -46,9 +46,12 @@ export class ContractWrapper {
     };
     private _onLogAddedSubscriptionToken: string | undefined;
     private _onLogRemovedSubscriptionToken: string | undefined;
-    private static _onBlockstreamError(err: Error): void {
+    private static _onBlockstreamError(isVerbose: boolean, err: Error): void {
         // Noop on blockstream errors since they are automatically
         // recovered from and don't cause Blockstream to exit.
+        if (isVerbose) {
+            logUtils.warn(err.message);
+        }
     }
     constructor(web3Wrapper: Web3Wrapper, networkId: number) {
         this._web3Wrapper = web3Wrapper;
@@ -85,10 +88,11 @@ export class ContractWrapper {
         indexFilterValues: IndexedFilterValues,
         abi: ContractAbi,
         callback: EventCallback<ArgsType>,
+        isVerbose: boolean = false,
     ): string {
         const filter = filterUtils.getFilter(address, eventName, indexFilterValues, abi);
         if (_.isUndefined(this._blockAndLogStreamerIfExists)) {
-            this._startBlockAndLogStream();
+            this._startBlockAndLogStream(isVerbose);
         }
         const filterToken = filterUtils.generateUUID();
         this._filters[filterToken] = filter;
@@ -159,21 +163,21 @@ export class ContractWrapper {
             }
         });
     }
-    private _startBlockAndLogStream(): void {
+    private _startBlockAndLogStream(isVerbose: boolean): void {
         if (!_.isUndefined(this._blockAndLogStreamerIfExists)) {
             throw new Error(ContractWrappersError.SubscriptionAlreadyPresent);
         }
         this._blockAndLogStreamerIfExists = new BlockAndLogStreamer(
             this._web3Wrapper.getBlockAsync.bind(this._web3Wrapper),
             this._web3Wrapper.getLogsAsync.bind(this._web3Wrapper),
-            ContractWrapper._onBlockstreamError.bind(this),
+            ContractWrapper._onBlockstreamError.bind(this, isVerbose),
         );
         const catchAllLogFilter = {};
         this._blockAndLogStreamerIfExists.addLogFilter(catchAllLogFilter);
         this._blockAndLogStreamIntervalIfExists = intervalUtils.setAsyncExcludingInterval(
             this._reconcileBlockAsync.bind(this),
             constants.DEFAULT_BLOCK_POLLING_INTERVAL,
-            ContractWrapper._onBlockstreamError.bind(this),
+            ContractWrapper._onBlockstreamError.bind(this, isVerbose),
         );
         let isRemoved = false;
         this._onLogAddedSubscriptionToken = this._blockAndLogStreamerIfExists.subscribeToOnLogAdded(

packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts

@@ -133,6 +133,7 @@ export class EtherTokenWrapper extends ContractWrapper {
      * @param   indexFilterValues   An object where the keys are indexed args returned by the event and
      *                              the value is the value you are interested in. E.g `{_owner: aUserAddressHex}`
      * @param   callback            Callback that gets called when a log is added/removed
+     * @param   isVerbose           Enable verbose subscription warnings (e.g recoverable network issues encountered)
      * @return Subscription token used later to unsubscribe
      */
     public subscribe<ArgsType extends EtherTokenContractEventArgs>(
@@ -140,6 +141,7 @@ export class EtherTokenWrapper extends ContractWrapper {
         eventName: EtherTokenEvents,
         indexFilterValues: IndexedFilterValues,
         callback: EventCallback<ArgsType>,
+        isVerbose: boolean = false,
     ): string {
         assert.isETHAddressHex('etherTokenAddress', etherTokenAddress);
         const normalizedEtherTokenAddress = etherTokenAddress.toLowerCase();
@@ -152,6 +154,7 @@ export class EtherTokenWrapper extends ContractWrapper {
             indexFilterValues,
             artifacts.EtherToken.abi,
             callback,
+            isVerbose,
         );
         return subscriptionToken;
     }

packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts

@@ -652,12 +652,14 @@ export class ExchangeWrapper extends ContractWrapper {
      * @param   indexFilterValues   An object where the keys are indexed args returned by the event and
      *                              the value is the value you are interested in. E.g `{maker: aUserAddressHex}`
      * @param   callback            Callback that gets called when a log is added/removed
+     * @param   isVerbose           Enable verbose subscription warnings (e.g recoverable network issues encountered)
      * @return Subscription token used later to unsubscribe
      */
     public subscribe<ArgsType extends ExchangeContractEventArgs>(
         eventName: ExchangeEvents,
         indexFilterValues: IndexedFilterValues,
         callback: EventCallback<ArgsType>,
+        isVerbose: boolean = false,
     ): string {
         assert.doesBelongToStringEnum('eventName', eventName, ExchangeEvents);
         assert.doesConformToSchema('indexFilterValues', indexFilterValues, schemas.indexFilterValuesSchema);
@@ -669,6 +671,7 @@ export class ExchangeWrapper extends ContractWrapper {
             indexFilterValues,
             artifacts.Exchange.abi,
             callback,
+            isVerbose,
         );
         return subscriptionToken;
     }

packages/contract-wrappers/src/contract_wrappers/token_wrapper.ts

@@ -350,6 +350,7 @@ export class TokenWrapper extends ContractWrapper {
      * @param   indexFilterValues   An object where the keys are indexed args returned by the event and
      *                              the value is the value you are interested in. E.g `{maker: aUserAddressHex}`
      * @param   callback            Callback that gets called when a log is added/removed
+     * @param   isVerbose           Enable verbose subscription warnings (e.g recoverable network issues encountered)
      * @return Subscription token used later to unsubscribe
      */
     public subscribe<ArgsType extends TokenContractEventArgs>(
@@ -357,6 +358,7 @@ export class TokenWrapper extends ContractWrapper {
         eventName: TokenEvents,
         indexFilterValues: IndexedFilterValues,
         callback: EventCallback<ArgsType>,
+        isVerbose: boolean = false,
     ): string {
         assert.isETHAddressHex('tokenAddress', tokenAddress);
         const normalizedTokenAddress = tokenAddress.toLowerCase();
@@ -369,6 +371,7 @@ export class TokenWrapper extends ContractWrapper {
             indexFilterValues,
             artifacts.Token.abi,
             callback,
+            isVerbose,
         );
         return subscriptionToken;
     }