vilsbole/testchain

Start a local test chain with the MakerDAO contracts deployed on it, quickly and easily. (Work in progress)

MakerDAO Testchain

This tool will help you set up a local testchain and deploy the contracts you need to work with Maker apps.

This branch, dai.js, is configured with the contracts needed for the Dai.js library.

Installation and requirements

Requires Node.js and Bash.

Run npm install or yarn install to install Ganache.

Basic usage

Run scripts/launch.sh.

If run with no arguments, it will start Ganache at 127.0.0.1:2000 with the chain data it finds in var/chaindata, and run until killed with Ctrl-C.

If var/chaindata does not exist, the default snapshot will be used to create it.

If you want to start the launch script with an empty snapshot, you will need to mkdir -p testchain/var/chaindata first.

Options

• -s, --snapshot: Optional. This should match the name of a folder under the snapshots folder. This will be copied to var/chaindata, overwriting anything there.

• -d, --deploy: Optional. If set, scripts/deploy.sh will be run once Ganache is set up, to deploy contracts to the test chain.

• --fast: Skip git submodule update and skip running dapp build for dapps that are already built. This is accomplished by setting the SKIP_BUILD_IF_ALREADY_BUILT environment variable, so the dapp build scripts must be written (or modified; see the use of sed_inplace in deploy.sh) to support it.

• -u, --skip-update: Skip the git submodule updates, but still run dapp build on the contracts.

• -p, --port: Start Ganache on a different port.

• --ci: If this is set, all unrecognized arguments will be treated as a new command. This command will be run, and Ganache will exit afterward.

• -o, --output: Works only with -d. Will export deployed contracts to specified format. Available formats are: json|env|yaml|template

• --template: Output configuration template. See deployment output section.

Deploying changes to contract code

When the deploy script is run, it copies ABI files and output addresses of deployment contracts to a file in out/ directory. These can be copied into the source code of applications working with the test chain as you see fit.

This output file can be in different formats depending on -o, --output option.

• -o json - creates out/addresses.json file in JSON format
• -o env - creates out/addresses file with bash script that exports the addresses as environment variables
• -o yaml - creates out/addresses.yaml file in YAML format
• -o path/to/output/config.any --template path/to/config.template - will copy config file to path/to/output/config.any and replace all placeholders there.

Configuration file template

If you need to configure your application using a custom config file you could do this using config template.

1. Create config template file somewhere ex: your/project/path/config/local.template with this content:

[database]
name = "vulcanize_public"
hostname = "localhost"
port = 5432

[client]
ipcPath = "http://{{TESTCHAIN_HOST}}:{{TESTCHAIN_PORT}}"

[contract]
sai_gem = "{{TESTCHAIN_SAI_GEM}}"
sai_pip = "{{TESTCHAIN_SAI_PIP}}"

2. Run launch script with -d deploy flag.

$ testchain/scripts/launch -d --template your/project/path/config/local.template -o your/project/path/config/local.toml

This command will copy local.template content, replace all testchain variables and place new fullfilled config file to your/project/path/config/local.toml

If such file already exist, script will ask you to delete it first.

Testchain template variables

Name	Description	Default value
TESTCHAIN_HOST	testchain host	127.0.0.1
TESTCHAIN_PORT	testchain port	2000
TESTCHAIN_SAI_GEM	contract address
TESTCHAIN_SAI_GOV	contract address
TESTCHAIN_SAI_PIP	contract address
TESTCHAIN_SAI_PEP	contract address
TESTCHAIN_SAI_PIT	contract address
TESTCHAIN_SAI_ADM	contract address
TESTCHAIN_SAI_SAI	contract address
TESTCHAIN_SAI_SIN	contract address
TESTCHAIN_SAI_SKR	contract address
TESTCHAIN_SAI_DAD	contract address
TESTCHAIN_SAI_MOM	contract address
TESTCHAIN_SAI_VOX	contract address
TESTCHAIN_SAI_TUB	contract address
TESTCHAIN_SAI_TAP	contract address
TESTCHAIN_SAI_TOP	contract address
TESTCHAIN_OTC	contract address
TESTCHAIN_DS_PROXY_FACTORY	contract address
TESTCHAIN_PROXY_REGISTRY	contract address
TESTCHAIN_DS_PROXY	contract address
TESTCHAIN_SAI_PROXY	contract address

Creating new snapshots

Use scripts/create-snapshot NAME to copy the contents of var/chaindata into a new folder snapshots/NAME. Add --force if you want to replace an existing snapshot.