smartkeyplatform/node repository overview

⁠SmartKey Node in Docker

⁠About the image

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

GitHub repository: Will soon...

⁠Before You start

martKey technical layer is based on Waves blockchain so it is recommended to read more about Waves Node configuration⁠ before running the container.

⁠System requirements

⁠Configuration options

Custom /etc/smartkey/template.conf have to be used to override the whole configuration from /etc/waves/waves.conf. For additional information about Docker volumes mapping please refer to Managing data item.

⁠Environment variables

You can run container with predefined environment variables:

⁠Managing data

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

• /etc/smartkey/template.conf:/etc/waves/waves.conf # SmartKey configuration file
• /var/lib/smartkey:/var/lib/waves # Data directory
• /var/log/smartkey:/var/log/waves # Logs directory

⁠Blockchain state [will soon...]

If you are a SmartKey Blockchain newbie and launching SmartKey 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 SmartKey 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.

⁠Network Ports

• 6869 Port number where the REST API accepts incoming connections
• 6870 Sets the network port number to which other Waves nodes will connect. Check that the port is reachable from outside, otherwise your node will connect to P2P network using only outgoing connections. If this the port is used by other application, your node won’t start.
• 6863 Port reserved for Waves testnet
• 6881 Port reserved for SmartKey stagenet
• 6877 gRPC Server port

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

⁠Running

Below command will launch a container with REST-API port enabled and configured on the socket 0.0.0.0:6869 SmartKey node communication port enabled and configured on the socket 0.0.0.0:6870 and gRPC extension enabled on port 6877

Ports 6869, 6870 and 6877 are mapped from the host to the container.

docker run -p 6870:6870 -p 6869:6869 -p 6877:6877  -v "/var/lib/smartkey:/var/lib/waves" -v "/etc/smartkey/template.conf:/etc/waves/waves.conf" -v "/var/log/smartkey:/var/log/waves" -i smartkeyplatform/node

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

⁠Extensions

SmartKey node use following extensions:

• com.wavesplatform.events.BlockchainUpdates,
• com.wavesplatform.api.grpc.GRPCServerExtension