Setting up nix

Setting up the IOHK binary cache will significantly decrease build time. Add the below to the nix.conf file in /etc/nix/nix.conf (create it if it does not exist):

substituters = https://cache.nixos.org https://hydra.iohk.io
trusted-substituters =
trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

If you are runnning Windows 10 with WSL and Ubuntu, you will also need to add the following flags to fix two NixOS required workarounds needed for NixOS to run on WSL:

• Work around missing cgroups support microsoft/WSL#994
• Work around incorrect file locking microsoft/WSL#2395

sandbox = false
use-sqlite-wal = false

On NixOS this can be done with:

    nix.binaryCaches = [
      "https://cache.nixos.org"
      "https://hydra.iohk.io"
    ];
    nix.binaryCachePublicKeys = [
      "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ="
    ];

A docker image

docker load < $(nix-build -A docker-images.jormungandr-standalone --no-link)
docker run -t -e GELF='true' jormungandr-standalone:0.3.0

(remove -e GELF='true' if you don't want to send jormungandr's logs to iohk)

A nix-shell for Jormungandr

To drop into a shell ready to connect to the testnet, clone this repo and run:

nix-shell

After you've generated secrets in state-jormungandr using create-stake-pool run the node with nix-shell --arg customConfig '{ staking = true; }' to launch the node as a stake pool with your secret.yaml.

Important if you want to help IOHK diagnoctic issues you may encouter

Set logger output to gelf with

--arg customConfig '{ sendLogs = true; }'

Note that any number of options can be combined in customConfig. For example to send logs and run as a stake pool use:

--arg customConfig '{ sendLogs = true; staking = true; }'

that way jormungandr logs will be sent to iohk testnet log server and will be invaluable inputs to diagnoctic issues.

One other useful feature, if you run jormungandr on a separate host and can access the REST API from the host your running the nix-shell, use:

--arg customConfig '{restListen = "192.168.1.1:3101"'

to connect to the API at host 192.168.1.1 on port 3101.

Once in the shell run run-jormungandr to start jormungandr.

Nix-shell for self node and creating new genesis files

The self node generation scripts have been moved to nix-shell -A bootstrap.

Unless you're developing a feature in isolation from the network, like a custom explorer or wallet, you have no need for these instructions and should refer above to the networked testnet nix-shell.

To regenerate the config (in case of incompatible change in jormungandr after updating the commit), run generate-config

You can tweak the blockchain configuration through nix-shell parameters, eg.:

nix-shell -A bootstrap --arg customConfig '{ faucetAmounts = [ 100000 1234444 34556 ]; numberOfStakePools = 2; logger_output = gelf; }'

This will put the new bootstrap config in state-jormungandr-bootstrap.

TODO: update below params to be up to date.

Available parameters

[1]: fee(num_bytes, has_certificate) = constant + num_bytes * coefficient + has_certificate * certificate