Skip to content

README.md

Latest commit

 

History

History
65 lines (45 loc) · 2.9 KB

README.md

File metadata and controls

65 lines (45 loc) · 2.9 KB

Docker Based Development

  1. Introduction
  2. Running the image
    1. Build
    2. Run
    3. Example
  3. Test
    1. Build
    2. Run

Introduction

Optionally, You can build and run the stability node within Docker directly. it is also possible to run tests in a docker.

Running the image

Build

To build the Docker container, run the following command at the root of the project.

$ docker build -f ./docker/client/Dockerfile -t stability .

Run

docker run -d -p 30333:30333 -p 9933:9933 -p 9615:9615 -e CHAIN="/stability/chain-specs/testnet.json" stability

Optional environment variables:

  • SEED: This environment variable allows the node to authenticate with a specific account.
  • CHAIN and CHAIN_NAME: If you want to use a pre-defined chain spec, you can use the CHAIN_NAME environment variable to specify the name of the chain spec to use. If you want to use a custom chain spec, you can use the CHAIN environment variable to specify the path to the chain spec file to use. If both are specified, CHAIN will be used. By default, the node will use the dev chain spec.
  • NODE_KEY: This environment variable allows specifying the node key to use. If not specified, the node will generate a random node key. This applies to the P2P key, not the account key.
  • BOOTNODES: This environment variable allows specifying the bootnodes to use, separated by commas. If not specified, the node will use the default bootnodes for the chain spec.
  • MODE: This environment variable allows the node to run in different pruning modes. Possible values are "full_node" or "archive". The default value is "full_node".
  • BACKEND_TYPE: The only available option is sql for now. This option allows the node to use a SQL backend instead of the default key-value backend for faster Ethereum log queries.
  • ZERO_GAS_TX_POOL: This environment variable allows the node to run with a zero gas price transaction pool. By default the feature is disabled. The expected value is a string containing an URL. Check the Zero Gas Transaction Pool document for more information.
  • ZERO_GAS_TX_POOL_TIMEOUT: This environment variable allows specifying the timeout for the zero gas transaction in millisecond. If not specified, the node will use the default timeout (1000ms).

To set an environment variable in the docker run, use the flag -e NAME=VALUE

Example

docker run -d -p 30333:30333 -p 9933:9933  -p 9615:9615 -e SEED=account -e CHAIN="/stability/chain-specs/testnet.json" -e MODE=archive -e BOOTNODES=/ip4/... stability

Test

Build Testing Image

To build the Docker container for testing, run the following command in the root of the project

$ docker build -f ./docker/test/Dockerfile -t stability-test .

Run Testing Image

$ docker run stability-test