Merge pull request #272 from 0xProject/fix/subscription-opts

Rename SubscriptionOpts to BlockRange

15 files changed, 53 insertions, 47 deletions

diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md
index 9874b0ca8..962d312d3 100644
--- a/packages/0x.js/CHANGELOG.md
+++ b/packages/0x.js/CHANGELOG.md
@@ -1,10 +1,11 @@
 # CHANGELOG
 
-v0.28.0 - _TBD_
+v0.x.x - _TBD, 2017_
 ------------------------
-* Add `etherTokenAddress` arg to `depositAsync` and `withdrawAsync` methods on `zeroEx.etherToken` (#267)
-* Removed accidentally included `unsubscribeAll` method from `zeroEx.proxy`, `zeroEx.etherToken` and `zeroEx.tokenRegistry` (#267)
-* Removed `etherTokenContractAddress` from `ZeroEx` constructor arg `ZeroExConfig` (#267)
+    * Add `etherTokenAddress` arg to `depositAsync` and `withdrawAsync` methods on `zeroEx.etherToken` (#267)
+    * Removed accidentally included `unsubscribeAll` method from `zeroEx.proxy`, `zeroEx.etherToken` and `zeroEx.tokenRegistry` (#267)
+    * Removed `etherTokenContractAddress` from `ZeroEx` constructor arg `ZeroExConfig` (#267)
+    * Rename `SubscriptionOpts` to `BlockRange` (#272)
 
 v0.27.1 - _November 28, 2017_
 ------------------------
diff --git a/packages/0x.js/src/contract_wrappers/contract_wrapper.ts b/packages/0x.js/src/contract_wrappers/contract_wrapper.ts
index 46916ebf4..3f07e4e47 100644
--- a/packages/0x.js/src/contract_wrappers/contract_wrapper.ts
+++ b/packages/0x.js/src/contract_wrappers/contract_wrapper.ts
@@ -7,6 +7,7 @@ import * as Web3 from 'web3';
 import {
     Artifact,
     BlockParamLiteral,
+    BlockRange,
     ContractEventArgs,
     ContractEvents,
     EventCallback,
@@ -14,7 +15,6 @@ import {
     InternalZeroExError,
     LogWithDecodedArgs,
     RawLog,
-    SubscriptionOpts,
     ZeroExError,
 } from '../types';
 import {AbiDecoder} from '../utils/abi_decoder';
@@ -83,9 +83,9 @@ export class ContractWrapper {
         return filterToken;
     }
     protected async _getLogsAsync<ArgsType extends ContractEventArgs>(
-        address: string, eventName: ContractEvents, subscriptionOpts: SubscriptionOpts,
+        address: string, eventName: ContractEvents, blockRange: BlockRange,
         indexFilterValues: IndexedFilterValues, abi: Web3.ContractAbi): Promise<Array<LogWithDecodedArgs<ArgsType>>> {
-        const filter = filterUtils.getFilter(address, eventName, indexFilterValues, abi, subscriptionOpts);
+        const filter = filterUtils.getFilter(address, eventName, indexFilterValues, abi, blockRange);
         const logs = await this._web3Wrapper.getLogsAsync(filter);
         const logsWithDecodedArguments = _.map(logs, this._tryToDecodeLogOrNoop.bind(this));
         return logsWithDecodedArguments;
diff --git a/packages/0x.js/src/contract_wrappers/exchange_wrapper.ts b/packages/0x.js/src/contract_wrappers/exchange_wrapper.ts
index 3ca5695c4..df793aa06 100644
--- a/packages/0x.js/src/contract_wrappers/exchange_wrapper.ts
+++ b/packages/0x.js/src/contract_wrappers/exchange_wrapper.ts
@@ -7,6 +7,7 @@ import * as Web3 from 'web3';
 import {artifacts} from '../artifacts';
 import {
     BlockParamLiteral,
+    BlockRange,
     DecodedLogArgs,
     ECSignature,
     EventCallback,
@@ -25,7 +26,6 @@ import {
     OrderTransactionOpts,
     OrderValues,
     SignedOrder,
-    SubscriptionOpts,
     ValidateOrderFillableOpts,
 } from '../types';
 import {AbiDecoder} from '../utils/abi_decoder';
@@ -616,20 +616,20 @@ export class ExchangeWrapper extends ContractWrapper {
     /**
      * Gets historical logs without creating a subscription
      * @param   eventName           The exchange contract event you would like to subscribe to.
-     * @param   subscriptionOpts    Subscriptions options that let you configure the subscription.
+     * @param   blockRange          Block range to get logs from.
      * @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 `{_from: aUserAddressHex}`
      * @return  Array of logs that match the parameters
      */
     public async getLogsAsync<ArgsType extends ExchangeContractEventArgs>(
-        eventName: ExchangeEvents, subscriptionOpts: SubscriptionOpts, indexFilterValues: IndexedFilterValues,
+        eventName: ExchangeEvents, blockRange: BlockRange, indexFilterValues: IndexedFilterValues,
     ): Promise<Array<LogWithDecodedArgs<ArgsType>>> {
         assert.doesBelongToStringEnum('eventName', eventName, ExchangeEvents);
-        assert.doesConformToSchema('subscriptionOpts', subscriptionOpts, schemas.subscriptionOptsSchema);
+        assert.doesConformToSchema('blockRange', blockRange, schemas.blockRangeSchema);
         assert.doesConformToSchema('indexFilterValues', indexFilterValues, schemas.indexFilterValuesSchema);
         const exchangeContractAddress = this.getContractAddress();
         const logs = await this._getLogsAsync<ArgsType>(
-            exchangeContractAddress, eventName, subscriptionOpts, indexFilterValues, artifacts.ExchangeArtifact.abi,
+            exchangeContractAddress, eventName, blockRange, indexFilterValues, artifacts.ExchangeArtifact.abi,
         );
         return logs;
     }
diff --git a/packages/0x.js/src/contract_wrappers/token_wrapper.ts b/packages/0x.js/src/contract_wrappers/token_wrapper.ts
index eccb74871..a9eac10e0 100644
--- a/packages/0x.js/src/contract_wrappers/token_wrapper.ts
+++ b/packages/0x.js/src/contract_wrappers/token_wrapper.ts
@@ -5,11 +5,11 @@ import * as _ from 'lodash';
 
 import {artifacts} from '../artifacts';
 import {
+    BlockRange,
     EventCallback,
     IndexedFilterValues,
     LogWithDecodedArgs,
     MethodOpts,
-    SubscriptionOpts,
     TokenContractEventArgs,
     TokenEvents,
     TransactionOpts,
@@ -291,20 +291,20 @@ export class TokenWrapper extends ContractWrapper {
      * Gets historical logs without creating a subscription
      * @param   tokenAddress        An address of the token that emmited the logs.
      * @param   eventName           The token contract event you would like to subscribe to.
-     * @param   subscriptionOpts    Subscriptions options that let you configure the subscription.
+     * @param   blockRange          Block range to get logs from.
      * @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 `{_from: aUserAddressHex}`
      * @return  Array of logs that match the parameters
      */
     public async getLogsAsync<ArgsType extends TokenContractEventArgs>(
-        tokenAddress: string, eventName: TokenEvents, subscriptionOpts: SubscriptionOpts,
+        tokenAddress: string, eventName: TokenEvents, blockRange: BlockRange,
         indexFilterValues: IndexedFilterValues): Promise<Array<LogWithDecodedArgs<ArgsType>>> {
         assert.isETHAddressHex('tokenAddress', tokenAddress);
         assert.doesBelongToStringEnum('eventName', eventName, TokenEvents);
-        assert.doesConformToSchema('subscriptionOpts', subscriptionOpts, schemas.subscriptionOptsSchema);
+        assert.doesConformToSchema('blockRange', blockRange, schemas.blockRangeSchema);
         assert.doesConformToSchema('indexFilterValues', indexFilterValues, schemas.indexFilterValuesSchema);
         const logs = await this._getLogsAsync<ArgsType>(
-            tokenAddress, eventName, subscriptionOpts, indexFilterValues, artifacts.TokenArtifact.abi,
+            tokenAddress, eventName, blockRange, indexFilterValues, artifacts.TokenArtifact.abi,
         );
         return logs;
     }
diff --git a/packages/0x.js/src/index.ts b/packages/0x.js/src/index.ts
index 2f5296a9f..b75ca4fa3 100644
--- a/packages/0x.js/src/index.ts
+++ b/packages/0x.js/src/index.ts
@@ -12,7 +12,7 @@ export {
     ExchangeEvents,
     TokenEvents,
     IndexedFilterValues,
-    SubscriptionOpts,
+    BlockRange,
     BlockParam,
     OrderCancellationRequest,
     OrderFillRequest,
diff --git a/packages/0x.js/src/types.ts b/packages/0x.js/src/types.ts
index fb3cfa6df..844ac9ed9 100644
--- a/packages/0x.js/src/types.ts
+++ b/packages/0x.js/src/types.ts
@@ -217,7 +217,7 @@ export enum BlockParamLiteral {
 
 export type BlockParam = BlockParamLiteral|number;
 
-export interface SubscriptionOpts {
+export interface BlockRange {
     fromBlock: BlockParam;
     toBlock: BlockParam;
 }
diff --git a/packages/0x.js/src/utils/filter_utils.ts b/packages/0x.js/src/utils/filter_utils.ts
index 57c3ee71c..65161c33e 100644
--- a/packages/0x.js/src/utils/filter_utils.ts
+++ b/packages/0x.js/src/utils/filter_utils.ts
@@ -4,7 +4,7 @@ import * as _ from 'lodash';
 import * as uuid from 'uuid/v4';
 import * as Web3 from 'web3';
 
-import {ContractEvents, IndexedFilterValues, SubscriptionOpts} from '../types';
+import {BlockRange, ContractEvents, IndexedFilterValues} from '../types';
 
 const TOPIC_LENGTH = 32;
 
@@ -14,7 +14,7 @@ export const filterUtils = {
     },
     getFilter(address: string, eventName: ContractEvents,
               indexFilterValues: IndexedFilterValues, abi: Web3.ContractAbi,
-              subscriptionOpts?: SubscriptionOpts): Web3.FilterObject {
+              blockRange?: BlockRange): Web3.FilterObject {
         const eventAbi = _.find(abi, {name: eventName}) as Web3.EventAbi;
         const eventSignature = filterUtils.getEventSignatureFromAbiByName(eventAbi, eventName);
         const topicForEventSignature = ethUtil.addHexPrefix(jsSHA3.keccak256(eventSignature));
@@ -24,9 +24,9 @@ export const filterUtils = {
             address,
             topics,
         };
-        if (!_.isUndefined(subscriptionOpts)) {
+        if (!_.isUndefined(blockRange)) {
             filter = {
-                ...subscriptionOpts,
+                ...blockRange,
                 ...filter,
             };
         }
diff --git a/packages/0x.js/test/exchange_wrapper_test.ts b/packages/0x.js/test/exchange_wrapper_test.ts
index 51b511dbf..9c55069da 100644
--- a/packages/0x.js/test/exchange_wrapper_test.ts
+++ b/packages/0x.js/test/exchange_wrapper_test.ts
@@ -5,6 +5,7 @@ import 'mocha';
 import * as Web3 from 'web3';
 
 import {
+    BlockRange,
     DecodedLogEvent,
     ExchangeContractErrs,
     ExchangeEvents,
@@ -13,7 +14,6 @@ import {
     OrderCancellationRequest,
     OrderFillRequest,
     SignedOrder,
-    SubscriptionOpts,
     Token,
     ZeroEx,
 } from '../src';
@@ -760,7 +760,7 @@ describe('ExchangeWrapper', () => {
         let takerAddress: string;
         const fillableAmount = new BigNumber(5);
         const shouldThrowOnInsufficientBalanceOrAllowance = true;
-        const subscriptionOpts: SubscriptionOpts = {
+        const blockRange: BlockRange = {
             fromBlock: 0,
             toBlock: BlockParamLiteral.Latest,
         };
@@ -781,7 +781,7 @@ describe('ExchangeWrapper', () => {
             await zeroEx.awaitTransactionMinedAsync(txHash);
             const eventName = ExchangeEvents.LogFill;
             const indexFilterValues = {};
-            const logs = await zeroEx.exchange.getLogsAsync(eventName, subscriptionOpts, indexFilterValues);
+            const logs = await zeroEx.exchange.getLogsAsync(eventName, blockRange, indexFilterValues);
             expect(logs).to.have.length(1);
             expect(logs[0].event).to.be.equal(eventName);
         });
@@ -795,7 +795,7 @@ describe('ExchangeWrapper', () => {
             await zeroEx.awaitTransactionMinedAsync(txHash);
             const differentEventName = ExchangeEvents.LogCancel;
             const indexFilterValues = {};
-            const logs = await zeroEx.exchange.getLogsAsync(differentEventName, subscriptionOpts, indexFilterValues);
+            const logs = await zeroEx.exchange.getLogsAsync(differentEventName, blockRange, indexFilterValues);
             expect(logs).to.have.length(0);
         });
         it('should only get the logs with the correct indexed fields', async () => {
@@ -821,7 +821,7 @@ describe('ExchangeWrapper', () => {
                 maker: differentMakerAddress,
             };
             const logs = await zeroEx.exchange.getLogsAsync<LogFillContractEventArgs>(
-                eventName, subscriptionOpts, indexFilterValues,
+                eventName, blockRange, indexFilterValues,
             );
             expect(logs).to.have.length(1);
             const args = logs[0].args;
diff --git a/packages/0x.js/test/token_wrapper_test.ts b/packages/0x.js/test/token_wrapper_test.ts
index 70637dbfe..48742b663 100644
--- a/packages/0x.js/test/token_wrapper_test.ts
+++ b/packages/0x.js/test/token_wrapper_test.ts
@@ -7,8 +7,8 @@ import * as Web3 from 'web3';
 
 import {
     ApprovalContractEventArgs,
+    BlockRange,
     DecodedLogEvent,
-    SubscriptionOpts,
     Token,
     TokenEvents,
     TransferContractEventArgs,
@@ -433,7 +433,7 @@ describe('TokenWrapper', () => {
     describe('#getLogsAsync', () => {
         let tokenAddress: string;
         let tokenTransferProxyAddress: string;
-        const subscriptionOpts: SubscriptionOpts = {
+        const blockRange: BlockRange = {
             fromBlock: 0,
             toBlock: BlockParamLiteral.Latest,
         };
@@ -449,7 +449,7 @@ describe('TokenWrapper', () => {
             const eventName = TokenEvents.Approval;
             const indexFilterValues = {};
             const logs = await zeroEx.token.getLogsAsync<ApprovalContractEventArgs>(
-                tokenAddress, eventName, subscriptionOpts, indexFilterValues,
+                tokenAddress, eventName, blockRange, indexFilterValues,
             );
             expect(logs).to.have.length(1);
             const args = logs[0].args;
@@ -464,7 +464,7 @@ describe('TokenWrapper', () => {
             const differentEventName = TokenEvents.Transfer;
             const indexFilterValues = {};
             const logs = await zeroEx.token.getLogsAsync(
-                tokenAddress, differentEventName, subscriptionOpts, indexFilterValues,
+                tokenAddress, differentEventName, blockRange, indexFilterValues,
             );
             expect(logs).to.have.length(0);
         });
@@ -478,7 +478,7 @@ describe('TokenWrapper', () => {
                 _owner: coinbase,
             };
             const logs = await zeroEx.token.getLogsAsync<ApprovalContractEventArgs>(
-                tokenAddress, eventName, subscriptionOpts, indexFilterValues,
+                tokenAddress, eventName, blockRange, indexFilterValues,
             );
             expect(logs).to.have.length(1);
             const args = logs[0].args;
diff --git a/packages/json-schemas/CHANGELOG.md b/packages/json-schemas/CHANGELOG.md
index 9f080adeb..81225e5de 100644
--- a/packages/json-schemas/CHANGELOG.md
+++ b/packages/json-schemas/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+v0.x.x - _TBD, 2017_
+------------------------
+    * Rename `subscriptionOptsSchema` to `blockRangeSchema` (#272)
+
 v0.6.7 - _Nov. 14, 2017_
 ------------------------
     * Re-publish JSON-schema previously published under NPM package 0x-json-schemas
diff --git a/packages/json-schemas/schemas/subscription_opts_schema.ts b/packages/json-schemas/schemas/block_range_schema.ts
index a476e6963..b264cb66e 100644
--- a/packages/json-schemas/schemas/subscription_opts_schema.ts
+++ b/packages/json-schemas/schemas/block_range_schema.ts
@@ -10,8 +10,8 @@ export const blockParamSchema = {
     ],
 };
 
-export const subscriptionOptsSchema = {
-    id: '/SubscriptionOpts',
+export const blockRangeSchema = {
+    id: '/BlockRange',
     properties: {
         fromBlock: {$ref: '/BlockParam'},
         toBlock: {$ref: '/BlockParam'},
diff --git a/packages/json-schemas/src/schemas.ts b/packages/json-schemas/src/schemas.ts
index 69164cbc7..854291a71 100644
--- a/packages/json-schemas/src/schemas.ts
+++ b/packages/json-schemas/src/schemas.ts
@@ -3,6 +3,10 @@ import {
     numberSchema,
 } from '../schemas/basic_type_schemas';
 import {
+    blockParamSchema,
+    blockRangeSchema,
+} from '../schemas/block_range_schema';
+import {
     ecSignatureParameterSchema,
     ecSignatureSchema,
 } from '../schemas/ec_signature_schema';
@@ -56,10 +60,6 @@ import {
     signedOrdersSchema,
 } from '../schemas/signed_orders_schema';
 import {
-    blockParamSchema,
-    subscriptionOptsSchema,
-} from '../schemas/subscription_opts_schema';
-import {
     tokenSchema,
 } from '../schemas/token_schema';
 import {
@@ -81,7 +81,7 @@ export const schemas = {
     signedOrderSchema,
     signedOrdersSchema,
     blockParamSchema,
-    subscriptionOptsSchema,
+    blockRangeSchema,
     tokenSchema,
     jsNumber,
     txDataSchema,
diff --git a/packages/json-schemas/test/schema_test.ts b/packages/json-schemas/test/schema_test.ts
index 067b02827..e729c1925 100644
--- a/packages/json-schemas/test/schema_test.ts
+++ b/packages/json-schemas/test/schema_test.ts
@@ -23,7 +23,7 @@ const {
     signedOrderSchema,
     signedOrdersSchema,
     blockParamSchema,
-    subscriptionOptsSchema,
+    blockRangeSchema,
     tokenSchema,
     jsNumber,
     txDataSchema,
@@ -170,21 +170,21 @@ describe('Schema', () => {
             validateAgainstSchema(testCases, blockParamSchema, shouldFail);
         });
     });
-    describe('#subscriptionOptsSchema', () => {
+    describe('#blockRangeSchema', () => {
         it('should validate valid subscription opts', () => {
             const testCases = [
                 {fromBlock: 42, toBlock: 'latest'},
                 {fromBlock: 42},
                 {},
             ];
-            validateAgainstSchema(testCases, subscriptionOptsSchema);
+            validateAgainstSchema(testCases, blockRangeSchema);
         });
         it('should fail for invalid subscription opts', () => {
             const testCases = [
                 {fromBlock: '42'},
             ];
             const shouldFail = true;
-            validateAgainstSchema(testCases, subscriptionOptsSchema, shouldFail);
+            validateAgainstSchema(testCases, blockRangeSchema, shouldFail);
         });
     });
     describe('#tokenSchema', () => {
diff --git a/packages/website/ts/blockchain.ts b/packages/website/ts/blockchain.ts
index a42b19cff..2a4aabeb2 100644
--- a/packages/website/ts/blockchain.ts
+++ b/packages/website/ts/blockchain.ts
@@ -1,5 +1,6 @@
 import {
     BlockParam,
+    BlockRange,
     DecodedLogEvent,
     ExchangeContractEventArgs,
     ExchangeEvents,
@@ -9,7 +10,6 @@ import {
     LogWithDecodedArgs,
     Order,
     SignedOrder,
-    SubscriptionOpts,
     Token as ZeroExToken,
     TransactionReceiptWithDecodedLogs,
     ZeroEx,
@@ -524,12 +524,12 @@ export class Blockchain {
     }
     private async fetchHistoricalExchangeLogFillEventsAsync(indexFilterValues: IndexedFilterValues) {
         const fromBlock = tradeHistoryStorage.getFillsLatestBlock(this.userAddress, this.networkId);
-        const subscriptionOpts: SubscriptionOpts = {
+        const blockRange: BlockRange = {
             fromBlock,
             toBlock: 'latest' as BlockParam,
         };
         const decodedLogs = await this.zeroEx.exchange.getLogsAsync<LogFillContractEventArgs>(
-            ExchangeEvents.LogFill, subscriptionOpts, indexFilterValues,
+            ExchangeEvents.LogFill, blockRange, indexFilterValues,
         );
         for (const decodedLog of decodedLogs) {
             if (!this.doesLogEventInvolveUser(decodedLog)) {
diff --git a/packages/website/ts/containers/zero_ex_js_documentation.tsx b/packages/website/ts/containers/zero_ex_js_documentation.tsx
index 1ce9ba139..ded62d2bc 100644
--- a/packages/website/ts/containers/zero_ex_js_documentation.tsx
+++ b/packages/website/ts/containers/zero_ex_js_documentation.tsx
@@ -95,6 +95,7 @@ const docsInfoConfig: DocsInfoConfig = {
         'ExchangeEvents',
         'IndexedFilterValues',
         'SubscriptionOpts',
+        'BlockRange',
         'BlockParam',
         'OrderFillOrKillRequest',
         'OrderCancellationRequest',