Deploy Node in Docker

The easiest way to run Waves node is by means of Waves Docker container. Waves Docker image is focused on fast and convenient deployment of Waves Node and contains scripts and configs to run the node in Mainnet, Testnet, Stagenet or any other custom network.

GitHub repository: https://github.com/wavesplatform/Waves/tree/master/docker

Prerequisites

Install Docker app from Docker website.

Building Docker image

You can get the latest image at Docker Hub or download it with the following command:

docker pull wavesplatform/wavesnode

Or use the following command to build an image with the current local repository (from the repository root):

./build-with-docker.sh && docker build -t wavesplatform/wavesnode docker

You can specify the following arguments when building the image:

Argument	Default Value	Description
WAVES_NETWORK	mainnet	Waves Blockchain network. The available values are mainnet, testnet and stagenet. Can be overridden in a runtime using environment variable with the same name.
WAVES_LOG_LEVEL	DEBUG	Default Waves Node log level. The available values are OFF, ERROR, WARN, INFO, DEBUG and TRACE. Can be overridden in a runtime using environment variable with the same name. Read more about logging.
WAVES_HEAP_SIZE	2g	Default Waves Node JVM Heap Size limit in -X Command-line Options notation (-Xms=[your value]). Can be overridden in a runtime using environment variable with the same name. Read more about -X Command-line Options.

Running the Image

Node Configuration Parameters

Be careful: the security of your wallet and funds depends on the configuration. For detailed information, see the Node Configuration article.

You can set the node configuration parameters in the node configuration file or in the command to start the node image as environment variables. Environment variables override the settings specified in the configuration file.

An example of the command to start a node image with environment variables:

docker run -v /docker/waves/waves-data:/var/lib/waves -v /docker/waves/waves-config:/etc/waves -p 6870:6870 -p 6868:6868 -e JAVA_OPTS="-Dwaves.network.declared-address=0.0.0.0:6868 -Dwaves.network.node-name=-my-testnet-node -Dwaves.rest-api.api-key-hash=6nSftY1F5kurz23yLrT1r9YJpiEveBLEa9RB1SCChiqv -Dwaves.rest-api.bind-address=0.0.0.0 -Dwaves.rest-api.port=6870" -e WAVES_WALLET_SEED="TBXHUUcVx2n3Rgszpu5MCybRaR86JGmqCWp7XKh7czU57ox5dgjdX4K4" -e WAVES_WALLET_PASSWORD=myWalletSuperPassword -e WAVES_NETWORK=testnet -ti wavesplatform/wavesnode

Environment Variable	Description
WAVES_WALLET_SEED	Base58 encoded seed. Overrides -Dwaves.wallet.seed JVM configuration parameter
WAVES_WALLET_PASSWORD	Password for the wallet file. Overrides -Dwaves.wallet.password JVM configuration parameter
WAVES_LOG_LEVEL	Node logging level. Available values: OFF, ERROR, WARN, INFO, DEBUG and TRACE. Read more about logging
WAVES_HEAP_SIZE	Default Java Heap Size limit in -X Command-line Options notation (-Xms=[your value]). Read more about -X Command-line Options
WAVES_NETWORK	Waves Blockchain network. The available values are mainnet, testnet, and stagenet.
JAVA_OPTS	Additional Waves Node JVM configuration parameters. Refer to application.conf file to get the full path of the configuration parameters and examples of values

The Waves node stores default configuration file in /etc/waves/waves.conf directory. You can mount the directory with Docker volumes. See Managing Data section below for more details about Docker volumes mapping.

If the directory does not exist, the directory and default configuration file will be created. Default configuration file is used depending on type of network specified by WAVES_NETWORK environment variable. If the value of WAVES_NETWORK is not mainnet, testnet, or stagenet, the default configuration will not be used. This is the case of using CUSTOM network type that requires correct configuration file. If you use CUSTOM network and the /etc/waves/waves.conf is NOT found, the container will not run.

By default, the /etc/waves/waves.conf config includes /etc/waves/local.conf. Custom /etc/waves/local.conf can be used to override default config parameters. Custom /etc/waves/waves.conf can be used to override the whole node configuration.

Managing Data

It is recommended to store the blockchain state as well as node configuration on the host side. Consider using Docker volumes mapping to map host directories inside the container.

Example:

• Create directories to store Waves data with the following command:

  mkdir -p /docker/waves
  
  mkdir /docker/waves/waves-data
  
  mkdir /docker/waves/waves-config
  

• Once the container is launched it will automatically create the following subdirectories in /docker/waves/waves-data directory:

  /docker/waves/waves-data/log - for Node logs

  /docker/waves/waves-data/data - for Blockchain state

  /docker/waves/waves-data/wallet - for Wallet data

  It will also create default configuration file /docker/waves/waves-config/waves.conf

  If you already have node configuration file or other data you can place it in the corresponding directory.

• Add appropriate arguments to docker run command similar to the following example:

     docker run -v /docker/waves/waves-data:/var/lib/waves -v /docker/waves/waves-config:/etc/waves -e WAVES_NETWORK=stagenet -e WAVES_WALLET_PASSWORD=myWalletSuperPassword -ti wavesplatform/wavesnode
   

Blockchain State

If you are new to Waves Blockchain and running node for the first time be aware that after the launch the node will start downloading blockchain state from other nodes. This takes much time. During downloading the node will be verifying all the blocks one after another.

You can speed this process up by downloading a compressed blockchain state from our official resources, extracting and mounting it inside the container (as described in Managing Data section). In this scenario the node skips block verifying so the process takes less time. This is also the reason why you must download blockchain state only from our official resources:

Network	Link
mainnet	http://blockchain.wavesnodes.com/blockchain_last.tar
testnet	http://blockchain-testnet.wavesnodes.com/blockchain_last.tar
stagenet	http://blockchain-stagenet.wavesnodes.com/blockchain_last.tar

Note: We do not guarantee the state consistency if it is downloaded from third parties.

Example of commands to download blockchain state and run Docker image:

mkdir -p /docker/waves/waves-data

wget -qO- http://blockchain-stagenet.wavesnodes.com/blockchain_last.tar --show-progress | tar -xvf - -C /docker/waves/waves-data/data

docker run -v /docker/waves/waves-data:/var/lib/waves -e WAVES_NETWORK=stagenet -e WAVES_WALLET_PASSWORD=myWalletSuperPassword -ti wavesplatform/wavesnode

Network Ports

Node REST API parameters can be specified in REST API section of the node configuration file. Node communication port for incoming connections can be specified in the Network Settings section of the node configuration file.

The following example command runs image with:

• REST-API port enabled and configured on the socket 0.0.0.0:6870
• Waves node communication port enabled and configured on the socket 0.0.0.0:6868
• Ports 6868 and 6870 are mapped from the host to the container

docker run -v /docker/waves/waves-data:/var/lib/waves -v /docker/waves/waves-config:/etc/waves -p 6870:6870 -p 6868:6868 -e JAVA_OPTS="-Dwaves.network.declared-address=0.0.0.0:6868 -Dwaves.rest-api.port=6870 -Dwaves.rest-api.bind-address=0.0.0.0 -Dwaves.rest-api.enable=yes" -e WAVES_WALLET_PASSWORD=myWalletSuperPassword -ti  wavesplatform/wavesnode

Note: The default network port for connecting peers depends on the network type: 6868 for Mainnet, 6863 for Testnet or custom, 6862 for Stagenet. The default port for the REST API is 6869.

To check that the REST API is up, navigate to the following URL from the host side: http://localhost:6870/api-docs/index.html

Extensions

You can run custom extensions as follows:

1. Copy all lib/*.jar files from extension to any directory, for example plugins.

2. Add extension class in the node configuration file (for example in local.conf):

   waves.extensions += com.johndoe.WavesExtension
   

3. Run the image with the following command:

   
   docker run -v "$(pwd)/plugins:/usr/share/waves/lib/plugins" -v "$(pwd)/local.conf:/etc/waves/local.conf" -i wavesplatform/wavesnode
   

Running Node with Blockchain Updates Extension

You can run the node with the blockchain updates extension enabled. The extension itself is already included in the node image that we post, so you can just enable it by means of console commands. However, you will still need to download the blockchain state and also the blockchain updates data from blockchain.wavesnodes.com and unzip it to /docker/waves/waves-data folder.

Example of commands to run the node Docker image with blockchain updates enabled:

docker run \
-v /docker/waves/waves-data:/var/lib/waves \
-e JAVA_OPTS="-Dwaves.rest-api.bind-address=0.0.0.0 -Dwaves.extensions.0=com.wavesplatform.events.BlockchainUpdates" \
-e WAVES_WALLET_PASSWORD=myWalletSuperPassword \
-p 6869:6869 \
-p 6881:6881 \
-i wavesplatform/wavesnode:1.3.15