nix-bitcoin

History

a0f48c9de9d2c45e446965bdaf3ad3cf1fc1b90f examples: fix deploy-container interactive flag (nixbitcoin)
a2f265cd35dffbe44f1049482759c5b552457834 secp256k1: move to top-level packages (Erik Arvstedt)
d41a84316738271ac29ddd1dfb422063cf34a2d8 jmbitcoin: remove secp256k1 from propagatedBuildInputs (Erik Arvstedt)
c22adb03afaa5e6caf55ee4ab8021f50533a1fd7 extra-container: 0.5 -> 0.6 (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  nixbitcoin:
    ACK a0f48c9de9d2c45e446965bdaf3ad3cf1fc1b90f
  jonasnick:
    ACK a0f48c9de9d2c45e446965bdaf3ad3cf1fc1b90f

Tree-SHA512: 29fa58a960673df407831dd41594c66b26dad1de1e792f4fcc8e35641f39dd873d77b725651be5e01c875bf42284fa78903bab0ea677ec5a0e7eccf98816845d

2021-02-07 21:44:10 +00: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

lnd: add option 'restOnionService'

2021-02-05 09:17:14 +01:00

deploy-container-minimal.sh

examples: add deploy-container-minimal.sh

2020-10-20 12:35:23 +02:00

deploy-container.sh

examples: fix deploy-container interactive flag

2021-02-06 11:43:36 +01: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

README.md

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.

./deploy-container.sh creates a NixOS container.
This is the fastest way to set up a node.
Requires: Nix, a systemd-based Linux distro and root privileges
./deploy-qemu-vm.sh creates a QEMU VM.
Requires: Nix
./deploy-nixops.sh creates a VirtualBox VM via NixOps.
NixOps can be used to deploy to various other backends like cloud providers.
Requires: Nix, VirtualBox
./deploy-container-minimal.sh creates a container defined by minimal-configuration.nix that doesn't use the secure-node.nix preset. Also shows how to use nix-bitcoin in an existing NixOS config.
Requires: Nix, a systemd-based Linux distro and root privileges

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.