How to get Dune¶
In this How To we explain how to get up-to-date binaries to run Dune for each network.
You can either use the docker images, which is easier, or build from sources.
The recommended way for running an up-to-date Dune node is to use the
docker images that are automatically generated from the GitLab
repository and published on Gitlab’s registry.
testnet.sh is provided to help download the right
image for each network and run a simple node.
Its only requirement is a working installation of Docker and docker compose on a machine with
Although we only officially support Linux, the script has been tested
with success in the past on windows/mac/linux.
The same script can be used to run Mainnet or Testnet, it suffices to rename it as it downloads a different image based on its name. For example, to run Testnet:
wget https://gitlab.com/dune-network/dune-network/raw/next/scripts/testnet.sh chmod +x testnet.sh
Alternatively, to run Mainnet:
wget -O mainnet.sh https://gitlab.com/dune-network/dune-network/raw/next/scripts/testnet.sh chmod +x mainnet.sh
In the following we assume you are running Testnet. You are now one step away from a working node:
This will download the right docker image for your chosen network, launch 3 docker containers running the node, the baker and the endorser. Keep in mind that when a dune node is launched, it needs to connect to new peers and synchronize the chain. This can be lengthy on the first launch considering the chain takes up several gigabytes of data. See how to use Dune for more details.
Every call to
testnet.sh will check for updates of the node and
will fail if your node is not up-to-date. For updating the node, simply
If you prefer to temporarily disable automatic updates, you just have to set an environment variable:
./testnet.sh --help for more informations about the
script. In particular see
./testnet.sh client --help or the
online manual for more information about
the client. Every command to the
dune-client can be equivalently
./testnet.sh client. Similary,
can be executed using
Build from sources¶
TL;DR: Typically you want to do:
sudo apt install -y rsync git m4 build-essential patch unzip bubblewrap wget pkg-config libgmp-dev libev-dev libhidapi-dev which wget https://github.com/ocaml/opam/releases/download/2.0.3/opam-2.0.3-x86_64-linux sudo cp opam-2.0.3-x86_64-linux /usr/local/bin/opam sudo chmod a+x /usr/local/bin/opam git clone https://gitlab.com/dune-network/dune-network.git cd dune-network git checkout testnet opam init --bare make build-deps eval $(opam env) make export PATH=~/dune-network:$PATH source ./src/bin_client/bash-completion.sh export DUNE_CLIENT_UNSAFE_DISABLE_DISCLAIMER=Y
For development, numerous shell scripts also rely on jq:
sudo apt install -y jq
Currently Dune is being developed for Linux x86_64, mostly for Debian/Ubuntu and Archlinux.
The following OSes are reported to work:
- Linux/armv7h (32 bits) (Raspberry Pi3, etc.)
- Linux/aarch64 (64 bits) (Raspberry Pi3, etc.)
A Windows port is feasible and might be developed in the future.
bubblewrap is not available in your distribution you can also
skip it and init opam with
Get the sources¶
Dune git repository is hosted at GitLab. All development happens here.
You also need to choose the branch of the network you want to connect to: testnet or mainnet.
The next branch is where code is merged, but there is no test network using the next branch directly.
To compile Dune, you need the OPAM package manager, version 2.0. For other versions check the release page. The build script will take care of setting-up OPAM, download the right version of the OCaml compiler, and so on.
opam init --bare to avoid compiling the OCaml compiler now: it
will be done in the next step.
Install Dune dependencies with OPAM¶
Install the OCaml compiler and the libraries which Dune depends on:
Alternatively, if you want to be able to install extra packages (development packages such as merlin), you may use the following command instead:
This command creates a local opam switch
_opam where the right
version of OCaml is compiled and installed (this takes a while but
it’s only done once).
After OCaml it will start with Dune dependencies, OPAM is able to handle correctly the OCaml libraries but it is not always able to handle all external C libraries we depend on. On most system, it is able to suggest a call to the system package manager but it currently does not handle version check.
Once the dependencies are done we can update opam’s environment to refer to the new switch and compile the project:
eval $(opam env) make
Lastly you can also add Dune binaries to your
activate bash autocompletion and after reading the Disclaimer a few
hundred times you are allowed to disable it with