Skip to content

Develop

Development is supported on linux systems. Virtual machines are run with qemu so kvm is recommended. Follow the installation guide to set up nix.

Development Shell

spo-anywhere provides a devshell that includes various tools to build, test, run and update the project:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
$ nix develop
...
❄️ Welcome to the SPO-anywhere devshell ❄️

[Tools]

  build-all  - Build all the checks
  check      - Alias of `nix flake check`
  fmt        - Format the source tree

[[general commands]]

  menu       - prints this menu

[documentation]

  docs-build - build documentation
  docs-serve - serve documentation web page

[testing]

  run-test   - Run tests

A .envrc file is also provided, using direnv and nix-direnv is suggested.

Running Integration Tests

From the devshell you can run integration tests with run-test, for example the following will start two cardano-node's and on a testnet, spend some transaction and wait for its inclusion in a minted block.

1
run-test relay-node