nix-bitcoin/examples
Erik Arvstedt 44546561fc
run-tests: allow defining scenarios via cmdline args
This simplifies running self-contained scenarios for testing and debugging.
2021-01-30 11:38:47 +01:00
..
nixops move main module import to configuration.nix 2020-03-24 21:43:21 +00:00
qemu-vm add deploy-qemu-vm.sh example 2020-03-30 10:56:57 +02:00
configuration.nix joinmarket-obwatcher: add pkg & module 2021-01-17 17:40:12 +00:00
deploy-container-minimal.sh examples: add deploy-container-minimal.sh 2020-10-20 12:35:23 +02:00
deploy-container.sh examples: add deploy-container-minimal.sh 2020-10-20 12:35:23 +02:00
deploy-nixops.sh examples: add option --interactive|-i 2020-10-18 13:42:58 +02:00
deploy-qemu-vm.sh tests: add example scripts 2020-12-18 19:56:56 +01:00
minimal-configuration.nix examples: add deploy-container-minimal.sh 2020-10-20 12:35:23 +02:00
nix-bitcoin-release.nix Add fetch-release script 2020-04-08 07:01:35 +00:00
README.md run-tests: allow defining scenarios via cmdline args 2021-01-30 11:38:47 +01:00
shell.nix shell.nix: fix failing generate-secrets 2020-10-19 11:35:32 +02:00
start-bash-session.sh examples: add option --interactive|-i 2020-10-18 13:42:58 +02:00

Examples

The easiest way to try out nix-bitcoin is to use one of the provided examples.

git clone https://github.com/fort-nix/nix-bitcoin
cd nix-bitcoin/examples/
nix-shell

The following example scripts set up a nix-bitcoin node according to configuration.nix and then shut down immediately. They leave no traces (outside of /nix/store) on the host system.
By default, configuration.nix enables bitcoind and clightning.

Run the examples with option --interactive or -i to start a shell for interacting with the node:

./deploy-qemu-vm.sh -i

Tests

The internal test suite is also useful for exploring features.
The following run-tests.sh commands leave no traces (outside of /nix/store) on the host system.

git clone https://github.com/fort-nix/nix-bitcoin
cd nix-bitcoin/test

# Run a Python test shell inside a VM node
./run-tests.sh debug
print(succeed("systemctl status bitcoind"))

# Run a node in a container. Requires systemd and root privileges.
./run-tests.sh container
c systemctl status bitcoind

# Explore a single feature
./run-tests.sh --scenario electrs container

# Run a command in a container
./run-tests.sh --scenario '{
  services.clightning.enable = true;
  nix-bitcoin.nodeinfo.enable = true;
}' container --run c nodeinfo

See run-tests.sh for a complete documentation.