Skip to content
Docker-compose based configuration to easily run locally deployed dev/test network
Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
nginx
node
test
README.md
docker-compose.yml
singlenode.yml

README.md

Aeternity Localnet

Docker-compose based configuration to easily run locally deployed dev/test network. Latest config files support node v5.. For older node versions use the 1. tags of this repository.

This repository provide two setups described below:

  • 3 Node configuration (default).
  • Single node configuration -- good if you only want to write and test your smart contracts.

The nodes use the mean15-generic miner (fastest generic miner). As the beneficiary key-pair is publicly available, this setup should not be connected to public networks.

All local network nodes are configured with the same beneficiary account (for more details on beneficiary see configuration documentation):

  • public key: ak_twR4h7dEcUtc2iSEDv8kB7UFJJDGiEDQCXr85C3fYF8FdVdyo
  • private key secret: secret
  • key-pair binaries can be found in /node/keys/beneficiary directory of this repository

All APIs (external, internal and state channels websocket) are exposed to the docker host, the URL pattern is as follows:

  • external/internal API - http://$DOCKER_HOST_ADDRESS:$NODE_PORT/
  • channels API - ws://$DOCKER_HOST_ADDRESS:$NODE_PORT/channel

3 Node configuration (default)

The multinode configuration (default) uses a proxy server to allow CORS and URL routing.

Node ports:

  • node1 - port 3001
  • node2 - port 3002
  • node3 - port 3003

For example to access node2 peer public key, assuming docker host address is localhost:

curl http://localhost:3002/v2/peers/pubkey

To start the network:

docker-compose up -d

To destroy the network:

docker-compose down

To cleanup the associated docker volumes, -v option could be used:

docker-compose down -v

More details can be found in docker-compose documentation.

Single Node Configuraiton

To use a Single Node Configuration just append -f singlenode.yml to the docker-compose command. Example:

docker-compose -f singlenode.yml up

Image Version

Docker compose uses the aeternity/aeternity:latest image by default, it will be pulled from docker hub if it's not found locally.

To change what node version is used set IMAGE_TAG environment variable, e.g.:

IMAGE_TAG=v4.0.0 docker-compose up -d

This configuration is known to work with node versions >= 2.0.0

Mining Rate

By default the localnet has set default mine rate of 1 block per 15 seconds. It can be changed by setting AETERNITY_MINE_RATE environment variable. The variable is in milliseconds, so to set 1 block per 10 seconds use:

AETERNITY_MINE_RATE=10000 docker-compose up
You can’t perform that action at this time.