Merge branch 'development' of https://github.com/0xProject/0x-monorepo into feature/instant/move-features-over-from-zrx-buyer

1 files changed, 37 insertions, 58 deletions

diff --git a/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts
index c19edf188..b6fc071ea 100644
--- a/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts
@@ -1,3 +1,5 @@
+import { ForwarderContract } from '@0xproject/abi-gen-wrappers';
+import { Forwarder } from '@0xproject/contract-artifacts';
 import { schemas } from '@0xproject/json-schemas';
 import { AssetProxyId, SignedOrder } from '@0xproject/types';
 import { BigNumber } from '@0xproject/utils';
@@ -5,36 +7,56 @@ import { Web3Wrapper } from '@0xproject/web3-wrapper';
 import { ContractAbi } from 'ethereum-types';
 import * as _ from 'lodash';
 
-import { artifacts } from '../artifacts';
 import { orderTxOptsSchema } from '../schemas/order_tx_opts_schema';
 import { txOptsSchema } from '../schemas/tx_opts_schema';
 import { OrderTransactionOpts } from '../types';
 import { assert } from '../utils/assert';
 import { calldataOptimizationUtils } from '../utils/calldata_optimization_utils';
 import { constants } from '../utils/constants';
+import { _getDefaultContractAddresses } from '../utils/contract_addresses';
 import { decorators } from '../utils/decorators';
 import { utils } from '../utils/utils';
 
 import { ContractWrapper } from './contract_wrapper';
-import { ForwarderContract } from './generated/forwarder';
 
 /**
  * This class includes the functionality related to interacting with the Forwarder contract.
  */
 export class ForwarderWrapper extends ContractWrapper {
-    public abi: ContractAbi = artifacts.Forwarder.compilerOutput.abi;
+    public abi: ContractAbi = Forwarder.compilerOutput.abi;
+    public address: string;
+    public zrxTokenAddress: string;
+    public etherTokenAddress: string;
     private _forwarderContractIfExists?: ForwarderContract;
-    private _contractAddressIfExists?: string;
-    private _zrxContractAddressIfExists?: string;
+
+    /**
+     * Instantiate ForwarderWrapper
+     * @param web3Wrapper Web3Wrapper instance to use.
+     * @param networkId Desired networkId.
+     * @param address The address of the Exchange contract. If undefined, will
+     * default to the known address corresponding to the networkId.
+     * @param zrxTokenAddress The address of the ZRXToken contract. If
+     * undefined, will default to the known address corresponding to the
+     * networkId.
+     * @param etherTokenAddress The address of a WETH (Ether token) contract. If
+     * undefined, will default to the known address corresponding to the
+     * networkId.
+     */
     constructor(
         web3Wrapper: Web3Wrapper,
         networkId: number,
-        contractAddressIfExists?: string,
-        zrxContractAddressIfExists?: string,
+        address?: string,
+        zrxTokenAddress?: string,
+        etherTokenAddress?: string,
     ) {
         super(web3Wrapper, networkId);
-        this._contractAddressIfExists = contractAddressIfExists;
-        this._zrxContractAddressIfExists = zrxContractAddressIfExists;
+        this.address = _.isUndefined(address) ? _getDefaultContractAddresses(networkId).exchange : address;
+        this.zrxTokenAddress = _.isUndefined(zrxTokenAddress)
+            ? _getDefaultContractAddresses(networkId).zrxToken
+            : zrxTokenAddress;
+        this.etherTokenAddress = _.isUndefined(etherTokenAddress)
+            ? _getDefaultContractAddresses(networkId).etherToken
+            : etherTokenAddress;
     }
     /**
      * Purchases as much of orders' makerAssets as possible by selling up to 95% of transaction's ETH value.
@@ -73,12 +95,8 @@ export class ForwarderWrapper extends ContractWrapper {
         assert.isETHAddressHex('feeRecipientAddress', feeRecipientAddress);
         assert.doesConformToSchema('orderTransactionOpts', orderTransactionOpts, orderTxOptsSchema, [txOptsSchema]);
         // other assertions
-        assert.ordersCanBeUsedForForwarderContract(signedOrders, this.getEtherTokenAddress());
-        assert.feeOrdersCanBeUsedForForwarderContract(
-            signedFeeOrders,
-            this.getZRXTokenAddress(),
-            this.getEtherTokenAddress(),
-        );
+        assert.ordersCanBeUsedForForwarderContract(signedOrders, this.etherTokenAddress);
+        assert.feeOrdersCanBeUsedForForwarderContract(signedFeeOrders, this.zrxTokenAddress, this.etherTokenAddress);
         // format feePercentage
         const formattedFeePercentage = utils.numberPercentageToEtherTokenAmountPercentage(feePercentage);
         // lowercase input addresses
@@ -165,12 +183,8 @@ export class ForwarderWrapper extends ContractWrapper {
         assert.isETHAddressHex('feeRecipientAddress', feeRecipientAddress);
         assert.doesConformToSchema('orderTransactionOpts', orderTransactionOpts, orderTxOptsSchema, [txOptsSchema]);
         // other assertions
-        assert.ordersCanBeUsedForForwarderContract(signedOrders, this.getEtherTokenAddress());
-        assert.feeOrdersCanBeUsedForForwarderContract(
-            signedFeeOrders,
-            this.getZRXTokenAddress(),
-            this.getEtherTokenAddress(),
-        );
+        assert.ordersCanBeUsedForForwarderContract(signedOrders, this.etherTokenAddress);
+        assert.feeOrdersCanBeUsedForForwarderContract(signedFeeOrders, this.zrxTokenAddress, this.etherTokenAddress);
         // format feePercentage
         const formattedFeePercentage = utils.numberPercentageToEtherTokenAmountPercentage(feePercentage);
         // lowercase input addresses
@@ -220,48 +234,13 @@ export class ForwarderWrapper extends ContractWrapper {
         );
         return txHash;
     }
-    /**
-     * Retrieves the Ethereum address of the Forwarder contract deployed on the network
-     * that the user-passed web3 provider is connected to.
-     * @returns The Ethereum address of the Forwarder contract being used.
-     */
-    public getContractAddress(): string {
-        const contractAddress = this._getContractAddress(artifacts.Forwarder, this._contractAddressIfExists);
-        return contractAddress;
-    }
-    /**
-     * Returns the ZRX token address used by the forwarder contract.
-     * @return Address of ZRX token
-     */
-    public getZRXTokenAddress(): string {
-        const contractAddress = this._getContractAddress(artifacts.ZRXToken, this._zrxContractAddressIfExists);
-        return contractAddress;
-    }
-    /**
-     * Returns the Ether token address used by the forwarder contract.
-     * @return Address of Ether token
-     */
-    public getEtherTokenAddress(): string {
-        const contractAddress = this._getContractAddress(artifacts.EtherToken);
-        return contractAddress;
-    }
-    // HACK: We don't want this method to be visible to the other units within that package but not to the end user.
-    // TS doesn't give that possibility and therefore we make it private and access it over an any cast. Because of that tslint sees it as unused.
-    // tslint:disable-next-line:no-unused-variable
-    private _invalidateContractInstance(): void {
-        delete this._forwarderContractIfExists;
-    }
     private async _getForwarderContractAsync(): Promise<ForwarderContract> {
         if (!_.isUndefined(this._forwarderContractIfExists)) {
             return this._forwarderContractIfExists;
         }
-        const [abi, address] = await this._getContractAbiAndAddressFromArtifactsAsync(
-            artifacts.Forwarder,
-            this._contractAddressIfExists,
-        );
         const contractInstance = new ForwarderContract(
-            abi,
-            address,
+            this.abi,
+            this.address,
             this._web3Wrapper.getProvider(),
             this._web3Wrapper.getContractDefaults(),
         );