README.md

parachain-launch

• Introduction
• Options
• Global Usage
• Local Usage
• Start relaychain and parachain
• Additional Docker Commands
• Resetting all data

Introduction

parachain-launch is a script that generates a docker compose file allowing you to launch a testnet of multiple blockchain nodes.

Options

The following options are supported by the generate script.

Option	Description	Required	Default
--config	Path to config file.	No	./config.yml
--output	Path to output dir.	No	./output
--yes	Overwrite generated files?	No	false

Global Usage

1. Install the package globally:

yarn global add @open-web3/parachain-launch

2. Download the example config file and edit as necessary.

3. Run the generate script:

parachain-launch generate --config=/path/to/config.yml [--yes] [--output=/path/to/output]

This will generate the docker files a folder called output in your current working directory or in the directory provided to the --output option.

Local Usage

1. Install the package locally:

yarn add @open-web3/parachain-launch

2. Download the example config file and edit as necessary.

3. Run the service from within the local directory:

node_modules/.bin/parachain-launch generate --config=/path/to/config.yml [--yes] [--output=/path/to/output]

This will generate the docker files a folder called output in your current working directory or in the directory provided to the --output option.

Start relaychain and parachain

To start the nodes, navigate to the output folder that you generated the scripts in and build the docker container:

cd ./output # OR custom output directory

docker-compose up -d --build

NOTE: If you regenerate the output directory then you will need to rebuild the docker images.

Additional Docker Commands

List all of the containers:

docker ps -a

Track container logs:

docker logs -f [container_id/container_name]

Stop all of the containers:

docker-compose stop

Remove all of the containers:

docker-compose rm

Remove all of the containers and volumes (This will wipe any existing chain data):

docker-compose down -v