path: root/packages/deployer/src/cli.ts

import { BigNumber } from '@0xproject/utils';
import { Web3Wrapper } from '@0xproject/web3-wrapper';
import * as _ from 'lodash';
import * as path from 'path';
import * as Web3 from 'web3';
import * as yargs from 'yargs';

import { commands } from './commands';
import { CliOptions, CompilerOptions, DeployerOptions } from './utils/types';

const DEFAULT_OPTIMIZER_ENABLED = false;
const DEFAULT_CONTRACTS_DIR = path.resolve('src');
const DEFAULT_ARTIFACTS_DIR = path.resolve('artifacts');
const DEFAULT_NETWORK_ID = 50;
const DEFAULT_JSONRPC_PORT = 8545;
const DEFAULT_GAS_PRICE = (10 ** 9 * 2).toString();
const DEFAULT_COMPILE_CONTRACTS = '*';

/**
 * Compiles all contracts with options passed in through CLI.
 * @param argv Instance of process.argv provided by yargs.
 */
async function onCompileCommand(argv: CliOptions): Promise<void> {
    const opts: CompilerOptions = {
        contractsDir: argv.contractsDir,
        networkId: argv.networkId,
        optimizerEnabled: argv.shouldOptimize ? 1 : 0,
        artifactsDir: argv.artifactsDir,
        contractsToCompile: generateContractsToCompileSet(argv.contracts),
    };
    await commands.compileAsync(opts);
}
/**
 * Compiles all contracts and runs migration script with options passed in through CLI.
 * Uses network ID of running node.
 * @param argv Instance of process.argv provided by yargs.
 */
async function onMigrateCommand(argv: CliOptions): Promise<void> {
    const url = `http://localhost:${argv.jsonrpcPort}`;
    const web3Provider = new Web3.providers.HttpProvider(url);
    const web3Wrapper = new Web3Wrapper(web3Provider);
    const networkId = await web3Wrapper.getNetworkIdAsync();
    const compilerOpts: CompilerOptions = {
        contractsDir: argv.contractsDir,
        networkId,
        optimizerEnabled: argv.shouldOptimize ? 1 : 0,
        artifactsDir: argv.artifactsDir,
        contractsToCompile: generateContractsToCompileSet(argv.contracts),
    };
    await commands.compileAsync(compilerOpts);

    const defaults = {
        gasPrice: new BigNumber(argv.gasPrice),
        from: argv.account,
    };
    const deployerOpts = {
        artifactsDir: argv.artifactsDir,
        jsonrpcPort: argv.jsonrpcPort,
        networkId,
        defaults,
    };
    await commands.migrateAsync(deployerOpts);
}
/**
 * Deploys a single contract with provided name and args.
 * @param argv Instance of process.argv provided by yargs.
 */
async function onDeployCommand(argv: CliOptions): Promise<void> {
    const url = `http://localhost:${argv.jsonrpcPort}`;
    const web3Provider = new Web3.providers.HttpProvider(url);
    const web3Wrapper = new Web3Wrapper(web3Provider);
    const networkId = await web3Wrapper.getNetworkIdAsync();
    const compilerOpts: CompilerOptions = {
        contractsDir: argv.contractsDir,
        networkId,
        optimizerEnabled: argv.shouldOptimize ? 1 : 0,
        artifactsDir: argv.artifactsDir,
        contractsToCompile: generateContractsToCompileSet(argv.contracts),
    };
    await commands.compileAsync(compilerOpts);

    const defaults = {
        gasPrice: new BigNumber(argv.gasPrice),
        from: argv.account,
    };
    const deployerOpts: DeployerOptions = {
        artifactsDir: argv.artifactsDir,
        jsonrpcPort: argv.jsonrpcPort,
        networkId,
        defaults,
    };
    const deployerArgsString = argv.args;
    const deployerArgs = deployerArgsString.split(',');
    await commands.deployAsync(argv.contract, deployerArgs, deployerOpts);
}
/**
 * Creates a set of contracts to compile.
 * @param contracts Comma separated list of contracts to compile
 */
function generateContractsToCompileSet(contracts: string): Set<string> {
    const contractsToCompile = new Set();
    const contractsArray = contracts.split(',');
    _.forEach(contractsArray, contractName => {
        contractsToCompile.add(contractName);
    });
    return contractsToCompile;
}
/**
 * Provides extra required options for deploy command.
 * @param yargsInstance yargs instance provided in builder function callback.
 */
function deployCommandBuilder(yargsInstance: any) {
    return yargsInstance
        .option('contract', {
            type: 'string',
            description: 'name of contract to deploy, exluding .sol extension',
        })
        .option('args', {
            type: 'string',
            description: 'comma separated list of constructor args to deploy contract with',
        })
        .demandOption(['contract', 'args'])
        .help().argv;
}

(() => {
    const identityCommandBuilder = _.identity;
    return yargs
        .option('contracts-dir', {
            type: 'string',
            default: DEFAULT_CONTRACTS_DIR,
            description: 'path of contracts directory to compile',
        })
        .option('network-id', {
            type: 'number',
            default: DEFAULT_NETWORK_ID,
            description: 'mainnet=1, kovan=42, testrpc=50',
        })
        .option('should-optimize', {
            type: 'boolean',
            default: DEFAULT_OPTIMIZER_ENABLED,
            description: 'enable optimizer',
        })
        .option('artifacts-dir', {
            type: 'string',
            default: DEFAULT_ARTIFACTS_DIR,
            description: 'path to write contracts artifacts to',
        })
        .option('jsonrpc-port', {
            type: 'number',
            default: DEFAULT_JSONRPC_PORT,
            description: 'port connected to JSON RPC',
        })
        .option('gas-price', {
            type: 'string',
            default: DEFAULT_GAS_PRICE,
            description: 'gasPrice to be used for transactions',
        })
        .option('account', {
            type: 'string',
            description: 'account to use for deploying contracts',
        })
        .option('contracts', {
            type: 'string',
            default: DEFAULT_COMPILE_CONTRACTS,
            description: 'comma separated list of contracts to compile',
        })
        .command('compile', 'compile contracts', identityCommandBuilder, onCompileCommand)
        .command(
            'migrate',
            'compile and deploy contracts using migration scripts',
            identityCommandBuilder,
            onMigrateCommand,
        )
        .command('deploy', 'deploy a single contract with provided arguments', deployCommandBuilder, onDeployCommand)
        .help().argv;
})();