Make getZRXTokenAddress non async

packages/0x.js/src/artifacts.ts

@@ -1,4 +1,5 @@
 import {Artifact} from './types';
+import * as ZRXArtifact from './artifacts/ZRX.json';
 import * as TokenArtifact from './artifacts/Token.json';
 import * as ExchangeArtifact from './artifacts/Exchange.json';
 import * as EtherTokenArtifact from './artifacts/EtherToken.json';
@@ -6,6 +7,7 @@ import * as TokenRegistryArtifact from './artifacts/TokenRegistry.json';
 import * as TokenTransferProxyArtifact from './artifacts/TokenTransferProxy.json';
 
 export const artifacts = {
+    ZRXArtifact: ZRXArtifact as any as Artifact,
     TokenArtifact: TokenArtifact as any as Artifact,
     ExchangeArtifact: ExchangeArtifact as any as Artifact,
     EtherTokenArtifact: EtherTokenArtifact as any as Artifact,

packages/0x.js/src/contract_wrappers/exchange_wrapper.ts

@@ -63,6 +63,7 @@ export class ExchangeWrapper extends ContractWrapper {
         [ExchangeContractErrCodes.ERROR_FILL_BALANCE_ALLOWANCE]: ExchangeContractErrs.FillBalanceAllowanceError,
     };
     private _contractAddressIfExists?: string;
+    private _zrxContractAddressIfExists?: string;
     private static _getOrderAddressesAndValues(order: Order): [OrderAddresses, OrderValues] {
         const orderAddresses: OrderAddresses = [
             order.maker,
@@ -177,7 +178,7 @@ export class ExchangeWrapper extends ContractWrapper {
             SHOULD_VALIDATE_BY_DEFAULT :
             orderTransactionOpts.shouldValidate;
         if (shouldValidate) {
-            const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+            const zrxTokenAddress = this.getZRXTokenAddress();
             const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
             await this._orderValidationUtils.validateFillOrderThrowIfInvalidAsync(
                 exchangeTradeEmulator, signedOrder, fillTakerTokenAmount, takerAddress, zrxTokenAddress);
@@ -249,7 +250,7 @@ export class ExchangeWrapper extends ContractWrapper {
             SHOULD_VALIDATE_BY_DEFAULT :
             orderTransactionOpts.shouldValidate;
         if (shouldValidate) {
-            const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+            const zrxTokenAddress = this.getZRXTokenAddress();
             const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
             for (const signedOrder of signedOrders) {
                 await this._orderValidationUtils.validateFillOrderThrowIfInvalidAsync(
@@ -339,7 +340,7 @@ export class ExchangeWrapper extends ContractWrapper {
             SHOULD_VALIDATE_BY_DEFAULT :
             orderTransactionOpts.shouldValidate;
         if (shouldValidate) {
-            const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+            const zrxTokenAddress = this.getZRXTokenAddress();
             const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
             for (const orderFillRequest of orderFillRequests) {
                 await this._orderValidationUtils.validateFillOrderThrowIfInvalidAsync(
@@ -419,7 +420,7 @@ export class ExchangeWrapper extends ContractWrapper {
             SHOULD_VALIDATE_BY_DEFAULT :
             orderTransactionOpts.shouldValidate;
         if (shouldValidate) {
-            const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+            const zrxTokenAddress = this.getZRXTokenAddress();
             const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
             await this._orderValidationUtils.validateFillOrKillOrderThrowIfInvalidAsync(
                 exchangeTradeEmulator, signedOrder, fillTakerTokenAmount, takerAddress, zrxTokenAddress);
@@ -483,7 +484,7 @@ export class ExchangeWrapper extends ContractWrapper {
             SHOULD_VALIDATE_BY_DEFAULT :
             orderTransactionOpts.shouldValidate;
         if (shouldValidate) {
-            const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+            const zrxTokenAddress = this.getZRXTokenAddress();
             const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
             for (const orderFillRequest of orderFillRequests) {
                 await this._orderValidationUtils.validateFillOrKillOrderThrowIfInvalidAsync(
@@ -719,7 +720,7 @@ export class ExchangeWrapper extends ContractWrapper {
         signedOrder: SignedOrder, opts?: ValidateOrderFillableOpts,
     ): Promise<void> {
         assert.doesConformToSchema('signedOrder', signedOrder, schemas.signedOrderSchema);
-        const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+        const zrxTokenAddress = this.getZRXTokenAddress();
         const expectedFillTakerTokenAmount = !_.isUndefined(opts) ? opts.expectedFillTakerTokenAmount : undefined;
         const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
         await this._orderValidationUtils.validateOrderFillableOrThrowAsync(
@@ -740,7 +741,7 @@ export class ExchangeWrapper extends ContractWrapper {
         assert.doesConformToSchema('signedOrder', signedOrder, schemas.signedOrderSchema);
         assert.isValidBaseUnitAmount('fillTakerTokenAmount', fillTakerTokenAmount);
         await assert.isSenderAddressAsync('takerAddress', takerAddress, this._web3Wrapper);
-        const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+        const zrxTokenAddress = this.getZRXTokenAddress();
         const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
         await this._orderValidationUtils.validateFillOrderThrowIfInvalidAsync(
             exchangeTradeEmulator, signedOrder, fillTakerTokenAmount, takerAddress, zrxTokenAddress);
@@ -774,7 +775,7 @@ export class ExchangeWrapper extends ContractWrapper {
         assert.doesConformToSchema('signedOrder', signedOrder, schemas.signedOrderSchema);
         assert.isValidBaseUnitAmount('fillTakerTokenAmount', fillTakerTokenAmount);
         await assert.isSenderAddressAsync('takerAddress', takerAddress, this._web3Wrapper);
-        const zrxTokenAddress = await this.getZRXTokenAddressAsync();
+        const zrxTokenAddress = this.getZRXTokenAddress();
         const exchangeTradeEmulator = new ExchangeTransferSimulator(this._tokenWrapper);
         await this._orderValidationUtils.validateFillOrKillOrderThrowIfInvalidAsync(
             exchangeTradeEmulator, signedOrder, fillTakerTokenAmount, takerAddress, zrxTokenAddress);
@@ -819,10 +820,17 @@ export class ExchangeWrapper extends ContractWrapper {
      * Returns the ZRX token address used by the exchange contract.
      * @return Address of ZRX token
      */
-    public async getZRXTokenAddressAsync(): Promise<string> {
+    public getZRXTokenAddress(): string {
-        const exchangeInstance = await this._getExchangeContractAsync();
+        const networkId = this._web3Wrapper.getNetworkId();
-        const ZRXtokenAddress = await exchangeInstance.ZRX_TOKEN_CONTRACT.callAsync();
+        if (_.isUndefined(this._zrxContractAddressIfExists)) {
-        return ZRXtokenAddress;
+            const zrxTokenAddress = artifacts.ZRXArtifact.networks[networkId].address;
+            if (_.isUndefined(zrxTokenAddress)) {
+                throw new Error(ZeroExError.ZRXContractDoesNotExist);
+            }
+            return zrxTokenAddress;
+        } else {
+            return this._zrxContractAddressIfExists;
+        }
     }
     private async _invalidateContractInstancesAsync(): Promise<void> {
         this.unsubscribeAll();

packages/0x.js/src/contract_wrappers/token_wrapper.ts

@@ -76,8 +76,8 @@ export class TokenWrapper extends ContractWrapper {
         // Hack: for some reason default estimated gas amount causes `base fee exceeds gas limit` exception
         // on testrpc. Probably related to https://github.com/ethereumjs/testrpc/issues/294
         // TODO: Debug issue in testrpc and submit a PR, then remove this hack
-        const networkIdIfExists = await this._web3Wrapper.getNetworkIdIfExistsAsync();
+        const networkId = this._web3Wrapper.getNetworkId();
-        const gas = networkIdIfExists === constants.TESTRPC_NETWORK_ID ? ALLOWANCE_TO_ZERO_GAS_AMOUNT : undefined;
+        const gas = networkId === constants.TESTRPC_NETWORK_ID ? ALLOWANCE_TO_ZERO_GAS_AMOUNT : undefined;
         const txHash = await tokenContract.approve.sendTransactionAsync(spenderAddress, amountInBaseUnits, {
             from: ownerAddress,
             gas,

packages/0x.js/src/order_watcher/order_state_watcher.ts

@@ -116,7 +116,7 @@ export class OrderStateWatcher {
         delete this._orderByOrderHash[orderHash];
         delete this._orderStateByOrderHashCache[orderHash];
         const exchange = (this._orderFilledCancelledLazyStore as any).exchange as ExchangeWrapper;
-        const zrxTokenAddress = await exchange.getZRXTokenAddressAsync();
+        const zrxTokenAddress = exchange.getZRXTokenAddress();
         this.removeFromDependentOrderHashes(signedOrder.maker, zrxTokenAddress, orderHash);
         this.removeFromDependentOrderHashes(signedOrder.maker, signedOrder.makerTokenAddress, orderHash);
         this._expirationWatcher.removeOrder(orderHash);
@@ -263,7 +263,7 @@ export class OrderStateWatcher {
         }
         this._dependentOrderHashes[signedOrder.maker][signedOrder.makerTokenAddress].add(orderHash);
         const exchange = (this._orderFilledCancelledLazyStore as any).exchange as ExchangeWrapper;
-        const zrxTokenAddress = await exchange.getZRXTokenAddressAsync();
+        const zrxTokenAddress = exchange.getZRXTokenAddress();
         if (_.isUndefined(this._dependentOrderHashes[signedOrder.maker][zrxTokenAddress])) {
             this._dependentOrderHashes[signedOrder.maker][zrxTokenAddress] = new Set();
         }

packages/0x.js/src/types.ts

@@ -4,6 +4,7 @@ import BigNumber from 'bignumber.js';
 export enum ZeroExError {
     ContractDoesNotExist = 'CONTRACT_DOES_NOT_EXIST',
     ExchangeContractDoesNotExist = 'EXCHANGE_CONTRACT_DOES_NOT_EXIST',
+    ZRXContractDoesNotExist = 'ZRX_CONTRACT_DOES_NOT_EXIST',
     UnhandledError = 'UNHANDLED_ERROR',
     UserHasNoAssociatedAddress = 'USER_HAS_NO_ASSOCIATED_ADDRESSES',
     InvalidSignature = 'INVALID_SIGNATURE',
@@ -441,7 +442,7 @@ export interface TransactionReceiptWithDecodedLogs extends TransactionReceipt {
 }
 
 export interface Artifact {
-    abi: any;
+    abi: Web3.ContractAbi;
     networks: {[networkId: number]: {
         address: string;
     }};

packages/0x.js/src/utils/order_state_utils.ts

@@ -55,7 +55,7 @@ export class OrderStateUtils {
         // because JS doesn't support async constructors.
         // Moreover - it's cached under the hood so it's equivalent to an async constructor.
         const exchange = (this.orderFilledCancelledLazyStore as any).exchange as ExchangeWrapper;
-        const zrxTokenAddress = await exchange.getZRXTokenAddressAsync();
+        const zrxTokenAddress = exchange.getZRXTokenAddress();
         const orderHash = ZeroEx.getOrderHashHex(signedOrder);
         const makerBalance = await this.balanceAndProxyAllowanceLazyStore.getBalanceAsync(
             signedOrder.makerTokenAddress, signedOrder.maker,

packages/0x.js/test/artifacts_test.ts

@@ -12,15 +12,15 @@ const expect = chai.expect;
 const TIMEOUT = 10000;
 
 describe('Artifacts', () => {
-    const config = {
-        networkId: constants.TESTRPC_NETWORK_ID,
-    };
     describe('contracts are deployed on kovan', () => {
         const kovanRpcUrl = constants.KOVAN_RPC_URL;
         const packageJSONContent = fs.readFileSync('package.json', 'utf-8');
         const packageJSON = JSON.parse(packageJSONContent);
         const mnemonic = packageJSON.config.mnemonic;
         const web3Provider = new HDWalletProvider(mnemonic, kovanRpcUrl);
+        const config = {
+            networkId: constants.KOVAN_NETWORK_ID,
+        };
         const zeroEx = new ZeroEx(web3Provider, config);
         it('token registry contract is deployed', async () => {
             await (zeroEx.tokenRegistry as any)._getTokenRegistryContractAsync();
@@ -38,6 +38,9 @@ describe('Artifacts', () => {
         const packageJSON = JSON.parse(packageJSONContent);
         const mnemonic = packageJSON.config.mnemonic;
         const web3Provider = new HDWalletProvider(mnemonic, ropstenRpcUrl);
+        const config = {
+            networkId: constants.ROPSTEN_NETWORK_ID,
+        };
         const zeroEx = new ZeroEx(web3Provider, config);
         it('token registry contract is deployed', async () => {
             await (zeroEx.tokenRegistry as any)._getTokenRegistryContractAsync();

packages/0x.js/test/event_watcher_test.ts

@@ -58,7 +58,7 @@ describe('EventWatcher', () => {
     before(async () => {
         web3 = web3Factory.create();
         const pollingIntervalMs = 10;
-        web3Wrapper = new Web3Wrapper(web3.currentProvider);
+        web3Wrapper = new Web3Wrapper(web3.currentProvider, constants.TESTRPC_NETWORK_ID);
         eventWatcher = new EventWatcher(web3Wrapper, pollingIntervalMs);
     });
     afterEach(() => {

packages/0x.js/test/exchange_wrapper_test.ts

@@ -744,8 +744,8 @@ describe('ExchangeWrapper', () => {
         });
     });
     describe('#getZRXTokenAddressAsync', () => {
-        it('gets the same token as is in token registry', async () => {
+        it('gets the same token as is in token registry', () => {
-            const zrxAddress = await zeroEx.exchange.getZRXTokenAddressAsync();
+            const zrxAddress = zeroEx.exchange.getZRXTokenAddress();
             const zrxToken = tokenUtils.getProtocolTokenOrThrow();
             expect(zrxAddress).to.equal(zrxToken.address);
         });

packages/0x.js/test/utils/constants.ts

@@ -2,6 +2,8 @@ export const constants = {
     NULL_ADDRESS: '0x0000000000000000000000000000000000000000',
     RPC_HOST: 'localhost',
     RPC_PORT: 8545,
+    ROPSTEN_NETWORK_ID: 3,
+    KOVAN_NETWORK_ID: 42,
     TESTRPC_NETWORK_ID: 50,
     KOVAN_RPC_URL: 'https://kovan.infura.io',
     ROPSTEN_RPC_URL: 'https://ropsten.infura.io',

packages/0x.js/test/web3_wrapper_test.ts

@@ -1,32 +0,0 @@
-import * as chai from 'chai';
-import {web3Factory} from './utils/web3_factory';
-import {ZeroEx} from '../src/';
-import {Web3Wrapper} from '../src/web3_wrapper';
-import {constants} from './utils/constants';
-
-chai.config.includeStack = true;
-const expect = chai.expect;
-
-describe('Web3Wrapper', () => {
-    const web3Provider = web3Factory.create().currentProvider;
-    const config = {
-        networkId: constants.TESTRPC_NETWORK_ID,
-    };
-    describe('#getNetworkIdIfExistsAsync', () => {
-        it('caches network id requests', async () => {
-            const web3Wrapper = (new ZeroEx(web3Provider, config) as any)._web3Wrapper as Web3Wrapper;
-            expect((web3Wrapper as any).networkIdIfExists).to.be.undefined();
-            const networkIdIfExists = await web3Wrapper.getNetworkIdIfExistsAsync();
-            expect((web3Wrapper as any).networkIdIfExists).to.be.equal(constants.TESTRPC_NETWORK_ID);
-        });
-        it('invalidates network id cache on setProvider call', async () => {
-            const web3Wrapper = (new ZeroEx(web3Provider, config) as any)._web3Wrapper as Web3Wrapper;
-            expect((web3Wrapper as any).networkIdIfExists).to.be.undefined();
-            const networkIdIfExists = await web3Wrapper.getNetworkIdIfExistsAsync();
-            expect((web3Wrapper as any).networkIdIfExists).to.be.equal(constants.TESTRPC_NETWORK_ID);
-            const newProvider = web3Factory.create().currentProvider;
-            web3Wrapper.setProvider(newProvider);
-            expect((web3Wrapper as any).networkIdIfExists).to.be.undefined();
-        });
-    });
-});