nix-bitcoin

Go to file

Jonas Nick 9b24a74b23 Merge fort-nix/nix-bitcoin#378 : Misc. improvements `b0c66c41e1` tests: add container-minimal example (Erik Arvstedt) `a8a8b9ce4d` backups: backup NixOS uid, gid mappings (Erik Arvstedt) `ee8b83681b` modules: document module dependencies (Erik Arvstedt) `9f7d048769` modules: move assertion to lnd.nix (Erik Arvstedt) `cce9a3f6b2` modules: move nix-bitcoin options to file 'nix-bitcoin.nix' (Erik Arvstedt) `fdc278a0b8` lib: fix comment (Erik Arvstedt) `13b4650e84` versioning: add usage comment (Erik Arvstedt) `ca3c7a281b` secrets: mark option 'secretsSetupMethod' as internal (Erik Arvstedt) `f9a0fd7a17` nodeinfo: fix indentation (Erik Arvstedt) `4ece606e8b` examples/minimal-configuration: improve comment (Erik Arvstedt) `6de9aba854` run-tests: quote scriptDir (Erik Arvstedt) `1ef8cbb384` joinmarket: fix allowRunAsUsers setting (Erik Arvstedt) `fb36f2abe5` joinmarket-ob-watcher: use consistent mode formatting (Erik Arvstedt) `f14af1fc48` treewide: use consistent echo message formatting (Erik Arvstedt) `b8043d3db5` treewide: use consistent bash script indentation (Erik Arvstedt) `c758d68ea4` lib: rename privileged -> rootScript (Erik Arvstedt) `1c3735b600` examples/README: add nixbitcoin.org server repo (Erik Arvstedt) `c041079ae1` configuration.nix: reorder sections (Erik Arvstedt) `3734ab38a6` configuration.nix: improve wording and formatting (Erik Arvstedt) Pull request description: ACKs for top commit: jonasnick: ACK `b0c66c41e1` Tree-SHA512: 11411e13de4ed8a6c8c942b2843b9ad45f3340a0682fe673a5cee18db93bb75f995c717eb9624f6a754615c508d089c03bf1790848c5112a7d5e9546d583fb24		2021-08-15 21:28:01 +00:00
ci	ci: use 'cachix watch-exec'	2021-02-07 22:45:37 +01:00
docs	docs: nixops-krops migration guide	2021-03-15 19:02:58 +01:00
examples	modules: move nix-bitcoin options to file 'nix-bitcoin.nix'	2021-08-15 22:40:35 +02:00
helper	fetch-release: minor improvements	2021-03-16 12:46:18 +01:00
modules	backups: backup NixOS uid, gid mappings	2021-08-15 22:40:35 +02:00
pkgs	lib: fix comment	2021-08-15 11:29:36 +02:00
test	tests: add container-minimal example	2021-08-15 22:42:03 +02:00
.cirrus.yml	fix build-to-cachix	2021-01-30 11:38:47 +01:00
default.nix	simplify overlay.nix	2020-01-09 10:43:29 +01:00
LICENSE	Add license	2019-01-02 14:03:52 +00:00
overlay.nix	simplify overlay.nix	2020-01-09 10:43:29 +01:00
README.md	charge-lnd: add module	2021-07-12 17:36:31 +02:00
shell.nix	Clean up development shell.nix	2020-03-30 10:49:15 +02:00

README.md

nix-bitcoin is a collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.

Overview

A Bitcoin node verifies the Bitcoin protocol and provides ways of interacting with the Bitcoin network. nix-bitcoin nodes are used for a variety of purposes and can serve as personal or merchant wallets, second layer public infrastructure and as backends for Bitcoin applications. In all cases, the aim is to provide security and privacy by default. However, while nix-bitcoin is used in production today, it is still considered experimental.

A full installation of nix-bitcoin is usually deployed either on a dedicated (virtual) machine or runs in a container and is online 24/7. Alternatively, the Nix packages, NixOS modules and configurations can be used independently and combined freely.

nix-bitcoin is built on top of Nix and NixOS which provide powerful abstractions to keep it highly customizable and maintainable. Testament to this are nix-bitcoin's robust security features and its potent test framework. However, running nix-bitcoin does not require any previous experience with the Nix ecosystem.

Examples

See here for examples.

Features

A configuration preset for setting up a secure node

All applications use Tor for outbound connections and support accepting inbound connections via onion services.

NixOS modules

Application services
- bitcoind, with a default banlist against spy nodes
- clightning with support for announcing an onion service
  Available plugins:
  - clboss: automated C-Lightning Node Manager
  - helpme: walks you through setting up a fresh c-lightning node
  - monitor: helps you analyze the health of your peers and channels
  - prometheus: lightning node exporter for the prometheus timeseries server
  - rebalance: keeps your channels balanced
  - summary: print a nice summary of the node status
  - zmq: publishes notifications via ZeroMQ to configured endpoints
- lnd with support for announcing an onion service
  - Lightning Loop
  - Lightning Pool
  - charge-lnd: policy-based channel fee manager
  - lndconnect via a REST onion service
- spark-wallet
- electrs
- btcpayserver
- liquid
- JoinMarket
  - JoinMarket Orderbook Watcher
- recurring-donations: for periodic lightning payments
- bitcoin-core-hwi
Helper
- netns-isolation: isolates applications on the network-level via network namespaces
- nodeinfo: script which prints info about the node's services
- backups: duplicity backups of all your node's important files
- operator: adds non-root user operator who has access to client tools (e.g. bitcoin-cli, lightning-cli)

Security

Simplicity: Only services you select in configuration.nix and their dependencies are installed, packages and dependencies are pinned, support for doas (sudo alternative), most packages are built from the NixOS stable channel, with a few exceptions that are built from the nixpkgs unstable channel, builds happen in a sandboxed environment, code is continuously reviewed and refined.
Integrity: Nix package manager, NixOS and packages can be built from source to reduce reliance on binary caches, nix-bitcoin merge commits are signed, all commits are approved by multiple nix-bitcoin developers, upstream packages are cryptographically verified where possible, we use this software ourselves.
Principle of Least Privilege: Services operate with least privileges; they each have their own user and are restricted further with systemd options, RPC whitelisting, and netns-isolation. There's a non-root user operator to interact with the various services.
Defense-in-depth: nix-bitcoin is built with a hardened kernel by default, services are confined through discretionary access control, Linux namespaces, dbus firewall and seccomp-bpf with continuous improvements.

Note that if the machine you're deploying from is insecure, there is nothing nix-bitcoin can do to protect itself.

Docs

Troubleshooting

If you are having problems with nix-bitcoin check the FAQ or submit an issue. There's also a #nix-bitcoin IRC channel on libera. We are always happy to help.