aboutsummaryrefslogtreecommitdiffstats
path: root/packages/dev-utils/src/web3_factory.ts
blob: 6435f0f9a3898495244e879c5c31856b3cfe1271 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
// HACK: web3 injects XMLHttpRequest into the global scope and ProviderEngine checks XMLHttpRequest
// to know whether it is running in a browser or node environment. We need it to be undefined since
// we are not running in a browser env.
// Filed issue: https://github.com/ethereum/web3.js/issues/844
(global as any).XMLHttpRequest = undefined;
import ProviderEngine = require('web3-provider-engine');
import RpcSubprovider = require('web3-provider-engine/subproviders/rpc');

import { EmptyWalletSubprovider, FakeGasEstimateSubprovider, GanacheSubprovider } from '@0xproject/subproviders';
import * as fs from 'fs';
import * as _ from 'lodash';
import * as process from 'process';

import { constants } from './constants';
import { coverage } from './coverage';
import { env, EnvVars } from './env';

// HACK: web3 leaks XMLHttpRequest into the global scope and causes requests to hang
// because they are using the wrong XHR package.
// importing web3 after subproviders fixes this issue
// Filed issue: https://github.com/ethereum/web3.js/issues/844
// tslint:disable-next-line:ordered-imports
import * as Web3 from 'web3';

export interface Web3Config {
    hasAddresses?: boolean; // default: true
    shouldUseInProcessGanache?: boolean; // default: false
}

export const web3Factory = {
    create(config: Web3Config = {}): Web3 {
        const provider = this.getRpcProvider(config);
        const web3 = new Web3();
        web3.setProvider(provider);
        return web3;
    },
    getRpcProvider(config: Web3Config = {}): Web3.Provider {
        const provider = new ProviderEngine();
        const isCoverageEnabled = env.parseBoolean(EnvVars.SolidityCoverage);
        if (isCoverageEnabled) {
            provider.addProvider(coverage.getCoverageSubproviderSingleton());
        }
        const hasAddresses = _.isUndefined(config.hasAddresses) || config.hasAddresses;
        if (!hasAddresses) {
            provider.addProvider(new EmptyWalletSubprovider());
        }
        provider.addProvider(new FakeGasEstimateSubprovider(constants.GAS_ESTIMATE));
        const logger = {
            log: (arg: any) => {
                fs.appendFileSync('ganache.log', `${arg}\n`);
            },
        };
        const shouldUseInProcessGanache = !!config.shouldUseInProcessGanache;
        if (shouldUseInProcessGanache) {
            provider.addProvider(
                new GanacheSubprovider({
                    logger,
                    verbose: env.parseBoolean(EnvVars.SolidityCoverage),
                    port: 8545,
                    networkId: 50,
                    mnemonic: 'concert load couple harbor equip island argue ramp clarify fence smart topic',
                }),
            );
        } else {
            provider.addProvider(
                new RpcSubprovider({
                    rpcUrl: constants.RPC_URL,
                }),
            );
        }
        provider.start();
        return provider;
    },
};