wavesplatform/wavesnode repository overview

⁠Waves Node in Docker

⁠About Waves

Waves is a decentralized platform that allows any user to issue, transfer, swap and trade custom blockchain tokens on an integrated peer-to-peer exchange. You can find more information about Waves at waves.tech⁠ and in the official documentation⁠.

⁠About the image

This Docker image contains scripts and configs to run Waves Node for mainnet, 'testnet' or 'stagenet' networks. The image is focused on fast and convenient deployment of Waves Node.

GitHub repository: https://github.com/wavesplatform/Waves⁠

⁠Prerequisites

It is highly recommended to read more about Waves Node configuration⁠ before running the container.

⁠Building Docker image

./build-with-docker.sh && docker build -t wavesplatform/wavesnode docker (from the repository root) - builds an image with the current local repository

You can specify following arguments when building the image:

Note: All build arguments are optional.

⁠Running Docker image

⁠Configuration options

1. The image supports Waves Node config customization. To change a config field use corrresponding JVM options. JVM options can be sent to JVM using JAVA_OPTS environment variable. Please refer to (complete configuration file⁠) to get the full path of the configuration item you want to change.

docker run -v /docker/waves/waves-data:/var/lib/waves -v /docker/waves/waves-config:/etc/waves -p 6869:6869 -p 6862:6862 -e JAVA_OPTS="-Dwaves.rest-api.enable=yes -Dwaves.rest-api.bind-address=0.0.0.0 -Dwaves.wallet.password=myWalletSuperPassword" -e WAVES_NETWORK=stagenet -ti wavesplatform/wavesnode

1. Waves Node is looking for a config in the directory /etc/waves/waves.conf which can be mounted using Docker volumes. If this directory does not exist, a default configuration will be copied to this directory. Default configuration is chosen depending on WAVES_NETWORK environment variable. If the value of WAVES_NETWORK is not mainnet, testnet or stagenet, default configuration won't be applied. This is a scenario of using CUSTOM network - correct configuration must be provided. If you use CUSTOM network and /etc/waves/waves.conf is NOT found Waves Node container will exit.

2. By default, /etc/waves/waves.conf config includes /etc/waves/local.conf. Custom /etc/waves/local.conf can be used to override default config entries. Custom /etc/waves/waves.conf can be used to override or the whole configuration. For additional information about Docker volumes mapping please refer to Managing data item.

⁠Environment variables

You can run container with predefined environment variables:

Note: All variables are optional.

Note: Environment variables override values in the configuration file.

⁠Managing data

We recommend to store the blockchain state as well as Waves configuration on the host side. As such, consider using Docker volumes mapping to map host directories inside the container:

Example:

1. Create a directory to store Waves data:

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

Once container is launched it will create:

• three subdirectories in /docker/waves/waves-data:

/docker/waves/waves-data/log    - Waves Node logs
/docker/waves/waves-data/data   - Waves Blockchain state
/docker/waves/waves-data/wallet - Waves Wallet data

• /docker/waves/waves-config/waves.conf - default Waves config

1. If you already have Waves Node configuration/data - place it in the corresponsing directories

2. Add the appropriate arguments to docker run command:

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 a Waves Blockchain newbie and launching Waves Node for the first time be aware that after launch it will start downloading the whole blockchain state from the other nodes. During this download it will be verifying all blocks one after another. This procesure can take some time.

You can speed this process up by downloading a compressed blockchain state from our official resources, extract it and mount inside the container (as discussed in the previous section). In this scenario Waves Node skips block verifying. This is a reason why it takes less time. This is also a reason why you must download blockchain state only from our official resources.

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

Example:

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

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

⁠Network Ports

1. REST-API interaction with Node. Details are available here⁠.

2. Waves Node communication port for incoming connections. Details are available here⁠.

Example: Below command will launch a container:

• 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 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 -e WAVES_NETWORK=stagenet -ti wavesplatform/wavesnode

Check that REST API is up by navigating to the following URL from the host side: http://localhost:6870/api-docs/index.html⁠

⁠Extensions

You can run custom extensions in this way:

1. Copy all lib/*.jar files from extension to any directory, lets say plugins
2. Add extension class to configuration file, lets say local.conf:

waves.extensions += com.johndoe.WavesExtension

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