import { AbiType, ConstructorAbi, ContractAbi, TxData } from '@0xproject/types'; import { logUtils } from '@0xproject/utils'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as _ from 'lodash'; import * as Web3 from 'web3'; import { Contract } from './utils/contract'; import { encoder } from './utils/encoder'; import { fsWrapper } from './utils/fs_wrapper'; import { ContractArtifact, ContractNetworkData, DeployerOptions, ProviderDeployerOptions, UrlDeployerOptions, } from './utils/types'; import { utils } from './utils/utils'; // Gas added to gas estimate to make sure there is sufficient gas for deployment. const EXTRA_GAS = 200000; /** * The Deployer facilitates deploying Solidity smart contracts to the blockchain. * It can be used to build custom migration scripts. */ export class Deployer { public web3Wrapper: Web3Wrapper; private _artifactsDir: string; private _networkId: number; private _defaults: Partial; /** * Instantiate a new instance of the Deployer class. * @param opts Deployer options, including either an RPC url or Provider instance. * @returns A Deployer instance */ constructor(opts: DeployerOptions) { this._artifactsDir = opts.artifactsDir; this._networkId = opts.networkId; this._defaults = opts.defaults; let web3Provider: Web3.Provider; if (_.isUndefined((opts as ProviderDeployerOptions).web3Provider)) { const jsonrpcUrl = (opts as UrlDeployerOptions).jsonrpcUrl; if (_.isUndefined(jsonrpcUrl)) { throw new Error(`Deployer options don't contain web3Provider nor jsonrpcUrl. Please pass one of them`); } web3Provider = new Web3.providers.HttpProvider(jsonrpcUrl); } else { web3Provider = (opts as ProviderDeployerOptions).web3Provider; } this.web3Wrapper = new Web3Wrapper(web3Provider, this._defaults); } /** * Loads a contract's corresponding artifacts and deploys it with the supplied constructor arguments. * @param contractName Name of the contract to deploy. Must match name of an artifact in supplied artifacts directory. * @param args Array of contract constructor arguments. * @return Deployed contract instance. */ public async deployAsync(contractName: string, args: any[] = []): Promise { const contractArtifactIfExists: ContractArtifact = this._loadContractArtifactIfExists(contractName); const contractNetworkDataIfExists: ContractNetworkData = this._getContractNetworkDataFromArtifactIfExists( contractArtifactIfExists, ); const data = contractNetworkDataIfExists.bytecode; const from = await this._getFromAddressAsync(); const gas = await this._getAllowableGasEstimateAsync(data); const txData = { gasPrice: this._defaults.gasPrice, from, data, gas, }; const abi = contractNetworkDataIfExists.abi; const constructorAbi = _.find(abi, { type: AbiType.Constructor }) as ConstructorAbi; const constructorArgs = _.isUndefined(constructorAbi) ? [] : constructorAbi.inputs; if (constructorArgs.length !== args.length) { const constructorSignature = `constructor(${_.map(constructorArgs, arg => `${arg.type} ${arg.name}`).join( ', ', )})`; throw new Error( `${contractName} expects ${constructorArgs.length} constructor params: ${constructorSignature}. Got ${ args.length }`, ); } const web3ContractInstance = await this._deployFromAbiAsync(abi, args, txData); logUtils.log(`${contractName}.sol successfully deployed at ${web3ContractInstance.address}`); const contractInstance = new Contract(web3ContractInstance, this._defaults); return contractInstance; } /** * Loads a contract's artifact, deploys it with supplied constructor arguments, and saves the updated data * back to the artifact file. * @param contractName Name of the contract to deploy. Must match name of an artifact in artifacts directory. * @param args Array of contract constructor arguments. * @return Deployed contract instance. */ public async deployAndSaveAsync(contractName: string, args: any[] = []): Promise { const contractInstance = await this.deployAsync(contractName, args); await this._saveContractDataToArtifactAsync(contractName, contractInstance.address, args); return contractInstance; } /** * Deploys a contract given its ABI, arguments, and transaction data. * @param abi ABI of contract to deploy. * @param args Constructor arguments to use in deployment. * @param txData Tx options used for deployment. * @return Promise that resolves to a web3 contract instance. */ private async _deployFromAbiAsync(abi: ContractAbi, args: any[], txData: TxData): Promise { const contract: Web3.Contract = this.web3Wrapper.getContractFromAbi(abi); const deployPromise = new Promise((resolve, reject) => { /** * Contract is inferred as 'any' because TypeScript * is not able to read 'new' from the Contract interface */ (contract as any).new(...args, txData, (err: Error, res: any): any => { if (err) { reject(err); } else if (_.isUndefined(res.address) && !_.isUndefined(res.transactionHash)) { logUtils.log(`transactionHash: ${res.transactionHash}`); } else { resolve(res); } }); }); return deployPromise; } /** * Updates a contract artifact's address and encoded constructor arguments. * @param contractName Name of contract. Must match an existing artifact. * @param contractAddress Contract address to save to artifact. * @param args Contract constructor arguments that will be encoded and saved to artifact. */ private async _saveContractDataToArtifactAsync( contractName: string, contractAddress: string, args: any[], ): Promise { const contractArtifactIfExists: ContractArtifact = this._loadContractArtifactIfExists(contractName); const contractNetworkDataIfExists: ContractNetworkData = this._getContractNetworkDataFromArtifactIfExists( contractArtifactIfExists, ); const abi = contractNetworkDataIfExists.abi; const encodedConstructorArgs = encoder.encodeConstructorArgsFromAbi(args, abi); const newContractData = { ...contractNetworkDataIfExists, address: contractAddress, constructor_args: encodedConstructorArgs, }; const newArtifact = { ...contractArtifactIfExists, networks: { ...contractArtifactIfExists.networks, [this._networkId]: newContractData, }, }; const artifactString = utils.stringifyWithFormatting(newArtifact); const artifactPath = `${this._artifactsDir}/${contractName}.json`; await fsWrapper.writeFileAsync(artifactPath, artifactString); } /** * Loads a contract artifact, if it exists. * @param contractName Name of the contract, without the extension. * @return The contract artifact. */ private _loadContractArtifactIfExists(contractName: string): ContractArtifact { const artifactPath = `${this._artifactsDir}/${contractName}.json`; try { const contractArtifact: ContractArtifact = require(artifactPath); return contractArtifact; } catch (err) { throw new Error(`Artifact not found for contract: ${contractName}`); } } /** * Gets data for current networkId stored in artifact. * @param contractArtifact The contract artifact. * @return Network specific contract data. */ private _getContractNetworkDataFromArtifactIfExists(contractArtifact: ContractArtifact): ContractNetworkData { const contractNetworkDataIfExists = contractArtifact.networks[this._networkId]; if (_.isUndefined(contractNetworkDataIfExists)) { throw new Error(`Data not found in artifact for contract: ${contractArtifact.contract_name}`); } return contractNetworkDataIfExists; } /** * Gets the address to use for sending a transaction. * @return The default from address. If not specified, returns the first address accessible by web3. */ private async _getFromAddressAsync(): Promise { let from: string; if (_.isUndefined(this._defaults.from)) { const accounts = await this.web3Wrapper.getAvailableAddressesAsync(); from = accounts[0]; } else { from = this._defaults.from; } return from; } /** * Estimates the gas required for a transaction. * If gas would be over the block gas limit, the max allowable gas is returned instead. * @param data Bytecode to estimate gas for. * @return Gas estimate for transaction data. */ private async _getAllowableGasEstimateAsync(data: string): Promise { const block = await this.web3Wrapper.getBlockAsync('latest'); let gas: number; try { const gasEstimate: number = await this.web3Wrapper.estimateGasAsync({ data }); gas = Math.min(gasEstimate + EXTRA_GAS, block.gasLimit); } catch (err) { gas = block.gasLimit; } return gas; } }