deploy-monster v1.1.2

SYNOPSIS

A module for deploying Ethereum smart contracts.

INSTALL

npm install deploy-monster

API

Functions

• compileAndDeploy
• compileAndDeployFromConfig

compileAndDeploy(opts: DeployOpts)

Compile and deploy a contract from the values specified in opts.

• opts - A DeployOpts object.

#####Returns:

An Output object.

compileAndDeployFromConfig(configPath: string)

Compile and deploy a contract from the values specified in a JSON config file.

• configPath - An absolute or relative path from the process current working directory to a JSON config file which can be parsed as a DeployOpts object.

#####Returns:

An Output object.

Types

• DeployOpts
• Output
• TxParams

DeployOpts

A nested object keyed by the names (as in the Solidity contract <Name> { shared by the contracts' constructor functions) where the inner objects have the following properties:

• file string - An absolute or relative path from the process current working directory to the contract to be compiled.
• signingKey string
• txParams [TxParams]
• args Array - (optional, default [])
• web3Provider string - (optional, default http://localhost:8545)
• web3 object - (optional, default derived from web3Provider)

See the exampleConf, for instance.

Output

An object with the following properties:

• name string - The name of the contract.
• abi string - The contract's ABI.
• address string - The address at which the contract was deployed.
• txHash string - The transaction hash of the contract deployment.
• bytecode string - The contract's bytecode.

TxParams

A nested object keyed by the names (as in the Solidity contract <Name> { shared by the contracts' constructor functions) where the inner objects have the following properties:

• nonce number - (optional, default derived using web3.eth.getTransactionCount on the address of the signingKey specified in the DeployOpts) The nonce with which to send the deployment transaction.
• gas number - (optional, default 1000000)
• gasPrice number - (optional, default 1)
• value number - (optional, default 0)