Support EIP1193 provider interface

contracts/asset-proxy/test/utils/erc20_wrapper.ts

@@ -1,8 +1,7 @@
-import { constants, ERC20BalancesByOwner, txDefaults } from '@0x/contracts-test-utils';
+import { constants, ERC20BalancesByOwner, txDefaults, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { assetDataUtils } from '@0x/order-utils';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { artifacts, DummyERC20TokenContract, ERC20ProxyContract } from '../../src';
@@ -11,7 +10,7 @@ export class ERC20Wrapper {
     private readonly _tokenOwnerAddresses: string[];
     private readonly _contractOwnerAddress: string;
     private readonly _web3Wrapper: Web3Wrapper;
-    private readonly _provider: Provider;
+    private readonly _provider: Web3ProviderEngine;
     private readonly _dummyTokenContracts: DummyERC20TokenContract[];
     private _proxyContract?: ERC20ProxyContract;
     private _proxyIdIfExists?: string;
@@ -22,7 +21,7 @@ export class ERC20Wrapper {
      * @param contractOwnerAddress Desired owner of the contract
      * Instance of ERC20Wrapper
      */
-    constructor(provider: Provider, tokenOwnerAddresses: string[], contractOwnerAddress: string) {
+    constructor(provider: Web3ProviderEngine, tokenOwnerAddresses: string[], contractOwnerAddress: string) {
         this._dummyTokenContracts = [];
         this._web3Wrapper = new Web3Wrapper(provider);
         this._provider = provider;

contracts/asset-proxy/test/utils/erc721_wrapper.ts

@@ -1,8 +1,7 @@
-import { constants, ERC721TokenIdsByOwner, txDefaults } from '@0x/contracts-test-utils';
+import { constants, ERC721TokenIdsByOwner, txDefaults, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { generatePseudoRandomSalt } from '@0x/order-utils';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { artifacts, DummyERC721TokenContract, ERC721ProxyContract } from '../../src';
@@ -11,12 +10,12 @@ export class ERC721Wrapper {
     private readonly _tokenOwnerAddresses: string[];
     private readonly _contractOwnerAddress: string;
     private readonly _web3Wrapper: Web3Wrapper;
-    private readonly _provider: Provider;
+    private readonly _provider: Web3ProviderEngine;
     private readonly _dummyTokenContracts: DummyERC721TokenContract[];
     private _proxyContract?: ERC721ProxyContract;
     private _proxyIdIfExists?: string;
     private _initialTokenIdsByOwner: ERC721TokenIdsByOwner = {};
-    constructor(provider: Provider, tokenOwnerAddresses: string[], contractOwnerAddress: string) {
+    constructor(provider: Web3ProviderEngine, tokenOwnerAddresses: string[], contractOwnerAddress: string) {
         this._web3Wrapper = new Web3Wrapper(provider);
         this._provider = provider;
         this._dummyTokenContracts = [];

contracts/exchange-forwarder/test/utils/forwarder_wrapper.ts

@@ -1,8 +1,8 @@
-import { constants, formatters, LogDecoder, MarketSellOrders } from '@0x/contracts-test-utils';
+import { constants, formatters, LogDecoder, MarketSellOrders, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { SignedOrder } from '@0x/types';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider, TransactionReceiptWithDecodedLogs, TxDataPayable } from 'ethereum-types';
+import { TransactionReceiptWithDecodedLogs, TxDataPayable } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { ForwarderContract } from '../../generated-wrappers/forwarder';
@@ -55,7 +55,7 @@ export class ForwarderWrapper {
         const params = formatters.createMarketSellOrders(signedOrders, constants.ZERO_AMOUNT);
         return params;
     }
-    constructor(contractInstance: ForwarderContract, provider: Provider) {
+    constructor(contractInstance: ForwarderContract, provider: Web3ProviderEngine) {
         this._forwarderContract = contractInstance;
         this._web3Wrapper = new Web3Wrapper(provider);
         this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);

contracts/exchange/test/utils/exchange_wrapper.ts

@@ -1,8 +1,15 @@
-import { FillResults, formatters, LogDecoder, OrderInfo, orderUtils } from '@0x/contracts-test-utils';
+import {
+    FillResults,
+    formatters,
+    LogDecoder,
+    OrderInfo,
+    orderUtils,
+    Web3ProviderEngine,
+} from '@0x/contracts-test-utils';
 import { SignedOrder, SignedZeroExTransaction } from '@0x/types';
 import { AbiEncoder, BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { MethodAbi, Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import { MethodAbi, TransactionReceiptWithDecodedLogs, ZeroExProvider } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { artifacts, ExchangeContract } from '../../src';
@@ -13,7 +20,7 @@ export class ExchangeWrapper {
     private readonly _exchange: ExchangeContract;
     private readonly _web3Wrapper: Web3Wrapper;
     private readonly _logDecoder: LogDecoder;
-    constructor(exchangeContract: ExchangeContract, provider: Provider) {
+    constructor(exchangeContract: ExchangeContract, provider: Web3ProviderEngine | ZeroExProvider) {
         this._exchange = exchangeContract;
         this._web3Wrapper = new Web3Wrapper(provider);
         this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);

contracts/exchange/test/utils/fill_order_combinatorial_utils.ts

@@ -15,6 +15,7 @@ import {
     TakerAssetFillAmountScenario,
     TakerScenario,
     TraderStateScenario,
+    Web3ProviderEngine,
 } from '@0x/contracts-test-utils';
 import {
     assetDataUtils,
@@ -28,7 +29,7 @@ import { AssetProxyId, RevertReason, SignatureType, SignedOrder } from '@0x/type
 import { BigNumber, errorUtils, logUtils } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as chai from 'chai';
-import { LogWithDecodedArgs, Provider, TxData } from 'ethereum-types';
+import { LogWithDecodedArgs, TxData } from 'ethereum-types';
 import * as _ from 'lodash';
 import 'make-promises-safe';
 
@@ -59,7 +60,7 @@ export async function fillOrderCombinatorialUtilsFactoryAsync(
     const [ownerAddress, makerAddress, takerAddress] = userAddresses;
     const makerPrivateKey = constants.TESTRPC_PRIVATE_KEYS[userAddresses.indexOf(makerAddress)];
 
-    const provider = web3Wrapper.getProvider();
+    const provider = web3Wrapper.getZeroExProvider();
     const erc20Wrapper = new ERC20Wrapper(provider, userAddresses, ownerAddress);
     const erc721Wrapper = new ERC721Wrapper(provider, userAddresses, ownerAddress);
 
@@ -351,7 +352,7 @@ export class FillOrderCombinatorialUtils {
         this.testLibsContract = testLibsContract;
     }
     public async testFillOrderScenarioAsync(
-        provider: Provider,
+        provider: Web3ProviderEngine,
         fillScenario: FillScenario,
         isVerbose: boolean = false,
     ): Promise<void> {

contracts/extensions/test/utils/balance_threshold_wrapper.ts

@@ -5,11 +5,12 @@ import {
     OrderInfo,
     orderUtils,
     TransactionFactory,
+    Web3ProviderEngine,
 } from '@0x/contracts-test-utils';
 import { SignedOrder } from '@0x/types';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import { TransactionReceiptWithDecodedLogs } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { artifacts, BalanceThresholdFilterContract, ExchangeContract } from '../../src';
@@ -24,7 +25,7 @@ export class BalanceThresholdWrapper {
         balanceThresholdFilter: BalanceThresholdFilterContract,
         exchangeContract: ExchangeContract,
         signerTransactionFactory: TransactionFactory,
-        provider: Provider,
+        provider: Web3ProviderEngine,
     ) {
         this._balanceThresholdFilter = balanceThresholdFilter;
         this._exchange = exchangeContract;

contracts/extensions/test/utils/dutch_auction_test_wrapper.ts

@@ -1,7 +1,7 @@
-import { LogDecoder } from '@0x/contracts-test-utils';
+import { LogDecoder, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { DutchAuctionDetails, SignedOrder } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import { TransactionReceiptWithDecodedLogs } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { DutchAuctionContract } from '../../generated-wrappers/dutch_auction';
@@ -12,7 +12,7 @@ export class DutchAuctionTestWrapper {
     private readonly _web3Wrapper: Web3Wrapper;
     private readonly _logDecoder: LogDecoder;
 
-    constructor(contractInstance: DutchAuctionContract, provider: Provider) {
+    constructor(contractInstance: DutchAuctionContract, provider: Web3ProviderEngine) {
         this._dutchAuctionContract = contractInstance;
         this._web3Wrapper = new Web3Wrapper(provider);
         this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);

contracts/multisig/test/utils/asset_proxy_owner_wrapper.ts

@@ -1,7 +1,7 @@
-import { LogDecoder } from '@0x/contracts-test-utils';
+import { LogDecoder, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import { TransactionReceiptWithDecodedLogs } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { AssetProxyOwnerContract } from '../../generated-wrappers/asset_proxy_owner';
@@ -11,7 +11,7 @@ export class AssetProxyOwnerWrapper {
     private readonly _assetProxyOwner: AssetProxyOwnerContract;
     private readonly _web3Wrapper: Web3Wrapper;
     private readonly _logDecoder: LogDecoder;
-    constructor(assetproxyOwnerContract: AssetProxyOwnerContract, provider: Provider) {
+    constructor(assetproxyOwnerContract: AssetProxyOwnerContract, provider: Web3ProviderEngine) {
         this._assetProxyOwner = assetproxyOwnerContract;
         this._web3Wrapper = new Web3Wrapper(provider);
         this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);

contracts/multisig/test/utils/multi_sig_wrapper.ts

@@ -1,7 +1,7 @@
-import { LogDecoder } from '@0x/contracts-test-utils';
+import { LogDecoder, Web3ProviderEngine } from '@0x/contracts-test-utils';
 import { BigNumber } from '@0x/utils';
 import { Web3Wrapper } from '@0x/web3-wrapper';
-import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import { TransactionReceiptWithDecodedLogs } from 'ethereum-types';
 import * as _ from 'lodash';
 
 import { MultiSigWalletContract } from '../../generated-wrappers/multi_sig_wallet';
@@ -11,7 +11,7 @@ export class MultiSigWrapper {
     private readonly _multiSig: MultiSigWalletContract;
     private readonly _web3Wrapper: Web3Wrapper;
     private readonly _logDecoder: LogDecoder;
-    constructor(multiSigContract: MultiSigWalletContract, provider: Provider) {
+    constructor(multiSigContract: MultiSigWalletContract, provider: Web3ProviderEngine) {
         this._multiSig = multiSigContract;
         this._web3Wrapper = new Web3Wrapper(provider);
         this._logDecoder = new LogDecoder(this._web3Wrapper, artifacts);

contracts/test-utils/src/index.ts

@@ -22,6 +22,7 @@ export { orderUtils } from './order_utils';
 export { typeEncodingUtils } from './type_encoding_utils';
 export { profiler } from './profiler';
 export { coverage } from './coverage';
+export { Web3ProviderEngine } from '@0x/subproviders';
 export { addressUtils } from './address_utils';
 export { OrderFactory } from './order_factory';
 export { bytes32Values, testCombinatoriallyWithReferenceFuncAsync, uint256Values } from './combinatorial_utils';

packages/0x.js/CHANGELOG.json

@@ -1,4 +1,17 @@
 [
+    {
+        "version": "5.1.0",
+        "changes": [
+            {
+                "note": "Add support for EIP1193 providers & Web3.js providers >= 1.0-beta.38",
+                "pr": 1627
+            },
+            {
+                "note": "Update provider params to type SupportedProvider which outlines all supported providers",
+                "pr": 1627
+            }
+        ]
+    },
     {
         "version": "5.0.0",
         "changes": [

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

@@ -108,10 +108,9 @@ export {
     BlockParam,
     LogWithDecodedArgs,
     ContractEventArg,
-    Provider,
+    SupportedProvider,
     JSONRPCRequestPayload,
     JSONRPCResponsePayload,
-    JSONRPCErrorCallback,
     JSONRPCResponseError,
     LogEntry,
     DecodedLogArgs,
@@ -129,4 +128,13 @@ export {
     DataItem,
     ConstructorStateMutability,
     StateMutability,
+    Web3JsProvider,
+    GanacheProvider,
+    EIP1193Provider,
+    ZeroExProvider,
+    EIP1193Event,
+    JSONRPCErrorCallback,
+    Web3JsV1Provider,
+    Web3JsV2Provider,
+    Web3JsV3Provider,
 } from 'ethereum-types';

packages/abi-gen-templates/contract.handlebars

@@ -2,8 +2,8 @@
 // tslint:disable:no-unused-variable
 // tslint:disable:no-unbound-method
 import { BaseContract } from '@0x/base-contract';
-import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
-import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, TxData, TxDataPayable, SupportedProvider } from 'ethereum-types';
+import { BigNumber, classUtils, logUtils, providerUtils } from '@0x/utils';
 import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
@@ -42,24 +42,26 @@ export class {{contractName}}Contract extends BaseContract {
 {{/each}}
     public static async deployFrom0xArtifactAsync(
         artifact: ContractArtifact | SimpleContractArtifact,
-        provider: Provider,
+        supportedProvider: SupportedProvider,
         txDefaults: Partial<TxData>,
         {{> typed_params inputs=ctor.inputs}}
     ): Promise<{{contractName}}Contract> {
         if (_.isUndefined(artifact.compilerOutput)) {
             throw new Error('Compiler output not found in the artifact file');
         }
+        const provider = providerUtils.standardizeOrThrow(supportedProvider);
         const bytecode = artifact.compilerOutput.evm.bytecode.object;
         const abi = artifact.compilerOutput.abi;
         return {{contractName}}Contract.deployAsync(bytecode, abi, provider, txDefaults, {{> params inputs=ctor.inputs}});
     }
     public static async deployAsync(
         bytecode: string,
         abi: ContractAbi,
-        provider: Provider,
+        supportedProvider: SupportedProvider,
         txDefaults: Partial<TxData>,
         {{> typed_params inputs=ctor.inputs}}
     ): Promise<{{contractName}}Contract> {
+        const provider = providerUtils.standardizeOrThrow(supportedProvider);
         const constructorAbi = BaseContract._lookupConstructorAbi(abi);
         [{{> params inputs=ctor.inputs}}] = BaseContract._formatABIDataItemList(
             constructorAbi.inputs,
@@ -83,8 +85,8 @@ export class {{contractName}}Contract extends BaseContract {
         contractInstance.constructorArgs = [{{> params inputs=ctor.inputs}}];
         return contractInstance;
     }
-    constructor(abi: ContractAbi, address: string, provider: Provider, txDefaults?: Partial<TxData>) {
-        super('{{contractName}}', abi, address, provider, txDefaults);
+    constructor(abi: ContractAbi, address: string, supportedProvider: SupportedProvider, txDefaults?: Partial<TxData>) {
+        super('{{contractName}}', abi, address, supportedProvider, txDefaults);
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', 'abi', '_web3Wrapper']);
     }
 } // tslint:disable:max-file-line-count

packages/abi-gen-wrappers/CHANGELOG.json

@@ -1,4 +1,17 @@
 [
+    {
+        "version": "3.1.0",
+        "changes": [
+            {
+                "note": "Add support for EIP1193 providers & Web3.js providers >= 1.0-beta.38",
+                "pr": 1627
+            },
+            {
+                "note": "Update provider params to type SupportedProvider which outlines all supported providers",
+                "pr": 1627
+            }
+        ]
+    },
     {
         "timestamp": 1549733923,
         "version": "3.0.3",

packages/abi-gen-wrappers/src/generated-wrappers/asset_proxy_owner.ts

@@ -2,8 +2,8 @@
 // tslint:disable:no-unused-variable
 // tslint:disable:no-unbound-method
 import { BaseContract } from '@0x/base-contract';
-import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
-import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, TxData, TxDataPayable, SupportedProvider } from 'ethereum-types';
+import { BigNumber, classUtils, logUtils, providerUtils } from '@0x/utils';
 import { SimpleContractArtifact } from '@0x/types';
 import { Web3Wrapper } from '@0x/web3-wrapper';
 import * as ethers from 'ethers';
@@ -1419,7 +1419,7 @@ export class AssetProxyOwnerContract extends BaseContract {
     };
     public static async deployFrom0xArtifactAsync(
         artifact: ContractArtifact | SimpleContractArtifact,
-        provider: Provider,
+        supportedProvider: SupportedProvider,
         txDefaults: Partial<TxData>,
             _owners: string[],
             _assetProxyContracts: string[],
@@ -1429,6 +1429,7 @@ export class AssetProxyOwnerContract extends BaseContract {
         if (_.isUndefined(artifact.compilerOutput)) {
             throw new Error('Compiler output not found in the artifact file');
         }
+        const provider = providerUtils.standardizeOrThrow(supportedProvider);
         const bytecode = artifact.compilerOutput.evm.bytecode.object;
         const abi = artifact.compilerOutput.abi;
         return AssetProxyOwnerContract.deployAsync(bytecode, abi, provider, txDefaults, _owners,
@@ -1440,13 +1441,14 @@ _secondsTimeLocked
     public static async deployAsync(
         bytecode: string,
         abi: ContractAbi,
-        provider: Provider,
+        supportedProvider: SupportedProvider,
         txDefaults: Partial<TxData>,
             _owners: string[],
             _assetProxyContracts: string[],
             _required: BigNumber,
             _secondsTimeLocked: BigNumber,
     ): Promise<AssetProxyOwnerContract> {
+        const provider = providerUtils.standardizeOrThrow(supportedProvider);
         const constructorAbi = BaseContract._lookupConstructorAbi(abi);
         [_owners,
 _assetProxyContracts,
@@ -1486,8 +1488,8 @@ _secondsTimeLocked
 ];
         return contractInstance;
     }
-    constructor(abi: ContractAbi, address: string, provider: Provider, txDefaults?: Partial<TxData>) {
-        super('AssetProxyOwner', abi, address, provider, txDefaults);
+    constructor(abi: ContractAbi, address: string, supportedProvider: SupportedProvider, txDefaults?: Partial<TxData>) {
+        super('AssetProxyOwner', abi, address, providerUtils.standardizeOrThrow(supportedProvider), txDefaults);
         classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', 'abi', '_web3Wrapper']);
     }
 } // tslint:disable:max-file-line-count