fix: 🐛 make getLogsAsync have sensible defaults

Author: shuffledex

src/contract_wrappers/contract_wrapper.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-underscore-dangle */
 import { Block, BlockAndLogStreamer, Log } from 'ethereumjs-blockstream';
 import _ from 'lodash';
+import { schemas } from '@0x/json-schemas';
 import {
   BaseContract,
   Web3Wrapper,
@@ -64,12 +65,9 @@ export default abstract class ContractWrapper {
    */
   public unsubscribeAll = (): void => {
     const filterTokens = _.keys(this._filterCallbacks);
-    _.each(
-      filterTokens,
-      (filterToken): void => {
-        this.unsubscribeInternal(filterToken);
-      },
-    );
+    _.each(filterTokens, (filterToken): void => {
+      this.unsubscribeInternal(filterToken);
+    });
   };
 
   private _blockAndLogStreamerIfExists: BlockAndLogStreamer<Block, Log> | undefined;
@@ -138,11 +136,18 @@ export default abstract class ContractWrapper {
   protected async getLogsAsyncInternal<ArgsType extends ContractEventArgs>(
     address: string,
     eventName: ContractEvents,
-    blockRange: BlockRange,
-    indexFilterValues: IndexedFilterValues,
     abi: ContractAbi,
+    blockRange?: BlockRange,
+    indexFilterValues?: IndexedFilterValues,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> {
-    const filter = filterUtils.getFilter(address, eventName, indexFilterValues, abi, blockRange);
+    const _blockRange = blockRange || {
+      fromBlock: BlockParamLiteral.Earliest,
+      toBlock: BlockParamLiteral.Latest,
+    };
+    const _indexFilterValues = indexFilterValues || {};
+    assert.doesConformToSchema('blockRange', _blockRange, schemas.blockRangeSchema);
+    assert.doesConformToSchema('indexFilterValues', _indexFilterValues, schemas.indexFilterValuesSchema);
+    const filter = filterUtils.getFilter(address, eventName, _indexFilterValues, abi, _blockRange);
     const logs = await this.web3Wrapper.getLogsAsync(filter);
     const logsWithDecodedArguments = _.map(logs, this.tryToDecodeLogOrNoopInternal.bind(this));
     return logsWithDecodedArguments as LogWithDecodedArgs<ArgsType>[];
@@ -158,19 +163,16 @@ export default abstract class ContractWrapper {
 
   private _onLogStateChanged<ArgsType extends ContractEventArgs>(isRemoved: boolean, rawLog: Log): void {
     const log: LogEntry = marshaller.unmarshalLog(rawLog as RawLogEntry);
-    _.forEach(
-      this._filters,
-      (filter: FilterObject, filterToken: string): void => {
-        if (filterUtils.matchesFilter(log, filter)) {
-          const decodedLog = this.tryToDecodeLogOrNoopInternal(log) as LogWithDecodedArgs<ArgsType>;
-          const logEvent = {
-            log: decodedLog,
-            isRemoved,
-          };
-          this._filterCallbacks[filterToken](null, logEvent);
-        }
-      },
-    );
+    _.forEach(this._filters, (filter: FilterObject, filterToken: string): void => {
+      if (filterUtils.matchesFilter(log, filter)) {
+        const decodedLog = this.tryToDecodeLogOrNoopInternal(log) as LogWithDecodedArgs<ArgsType>;
+        const logEvent = {
+          log: decodedLog,
+          isRemoved,
+        };
+        this._filterCallbacks[filterToken](null, logEvent);
+      }
+    });
   }
 
   private _startBlockAndLogStream(isVerbose: boolean): void {

src/contract_wrappers/modules/checkpoint/erc20_dividend_checkpoint_wrapper.ts

@@ -328,14 +328,10 @@ export default class ERC20DividendCheckpointWrapper extends DividendCheckpointWr
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, ERC20DividendCheckpointEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       ERC20DividendCheckpoint.abi,
     );
     return logs;

src/contract_wrappers/modules/checkpoint/ether_dividend_checkpoint_wrapper.ts

@@ -388,14 +388,10 @@ export default class EtherDividendCheckpointWrapper extends DividendCheckpointWr
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, EtherDividendCheckpointEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       EtherDividendCheckpoint.abi,
     );
     return logs;

src/contract_wrappers/modules/module_factory_wrapper.ts

@@ -353,14 +353,10 @@ export default class ModuleFactoryWrapper extends ContractWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, ModuleFactoryEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       ModuleFactory.abi,
     );
     return logs;

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -237,16 +237,13 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
       return value[0];
     }); // [module1: [[module1, perm1], [module1, perm2]], ...]
     const typedResult: PermissionsPerModule[] = [];
-    _.forEach(
-      groupedResult,
-      (value, key): void => {
-        const permissionsPerModule: PermissionsPerModule = {
-          module: key,
-          permissions: value.map(pair => parsePermBytes32Value(pair[1] as string)),
-        };
-        typedResult.push(permissionsPerModule);
-      },
-    );
+    _.forEach(groupedResult, (value, key): void => {
+      const permissionsPerModule: PermissionsPerModule = {
+        module: key,
+        permissions: value.map(pair => parsePermBytes32Value(pair[1] as string)),
+      };
+      typedResult.push(permissionsPerModule);
+    });
     return typedResult;
   };
 
@@ -288,14 +285,10 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, GeneralPermissionManagerEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       GeneralPermissionManager.abi,
     );
     return logs;

src/contract_wrappers/modules/sto/capped_sto_wrapper.ts

@@ -300,16 +300,8 @@ export default class CappedSTOWrapper extends STOWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, CappedSTOEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
-    const logs = await this.getLogsAsyncInternal<ArgsType>(
-      normalizedContractAddress,
-      params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
-      CappedSTO.abi,
-    );
+    const logs = await this.getLogsAsyncInternal<ArgsType>(normalizedContractAddress, params.eventName, CappedSTO.abi);
     return logs;
   };
 }

src/contract_wrappers/modules/sto/usd_tiered_sto_wrapper.ts

@@ -943,14 +943,10 @@ export default class USDTieredSTOWrapper extends STOWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, USDTieredSTOEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       USDTieredSTO.abi,
     );
     return logs;

src/contract_wrappers/modules/transfer_manager/count_transfer_manager_wrapper.ts

@@ -201,14 +201,10 @@ export default class CountTransferManagerWrapper extends ModuleWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, CountTransferManagerEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       CountTransferManager.abi,
     );
     return logs;

src/contract_wrappers/modules/transfer_manager/general_transfer_manager_wrapper.ts

@@ -784,14 +784,10 @@ export default class GeneralTransferManagerWrapper extends ModuleWrapper {
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, GeneralTransferManagerEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       GeneralTransferManager.abi,
     );
     return logs;

src/contract_wrappers/modules/transfer_manager/manual_approval_transfer_manager_wrapper.ts

@@ -498,14 +498,10 @@ export default class ManualApprovalTransferManagerWrapper extends ModuleWrapper
     params: GetLogsAsyncParams,
   ): Promise<LogWithDecodedArgs<ArgsType>[]> => {
     assert.doesBelongToStringEnum('eventName', params.eventName, ManualApprovalTransferManagerEvents);
-    assert.doesConformToSchema('blockRange', params.blockRange, schemas.blockRangeSchema);
-    assert.doesConformToSchema('indexFilterValues', params.indexFilterValues, schemas.indexFilterValuesSchema);
     const normalizedContractAddress = (await this.contract).address.toLowerCase();
     const logs = await this.getLogsAsyncInternal<ArgsType>(
       normalizedContractAddress,
       params.eventName,
-      params.blockRange,
-      params.indexFilterValues,
       ManualApprovalTransferManager.abi,
     );
     return logs;