e31e5788b2
f234e59ca5e62a24d8eef0c7490d6f6de3e43c18 nbPython3Packages: fix clightning pkgs (Erik Arvstedt)
6bdf0ac3fb485438098b668341dcf205066dcdaf update nixpkgs{,-unstable} (Jonas Nick)
900836fe0d5983192db78c7da5a15a66925cf84d joinmarket: add private python package set (Erik Arvstedt)
ca834cce8416c3a031c27f2bb5064d45cc4ee774 joinmarket: simplify pkgs (Erik Arvstedt)
43ee7668abb79a1b0200b87f29f924add852156e joinmarket: explicitly create no descriptor wallet (Jonas Nick)
408486ac9c159395d603a577ffe251da307eb463 tests: update nbxplorer (Erik Arvstedt)
aa21fb454e44afa414a2aefebdce5b38146314e8 tests: disable `btcpayserver.lbtc` for regtest (Erik Arvstedt)
7de56b019fe34872dbfb77a46ba5fadd15e1dc2d nbxplorer: use postgresql (Erik Arvstedt)
29d2ffc111ccf553314101dec44a1d9e6fd650dd defaultHardening: allow `clone3` system call (Erik Arvstedt)
Pull request description:
ACKs for top commit:
erikarvstedt:
ACK f234e59ca5e62a24d8eef0c7490d6f6de3e43c18
Tree-SHA512: 1d3e76f096746eadb4596fb87dfd654cd3c85c88bb437eb5ed601ff8513e5272b6f1266bba64e5bfe9147ff2530ab3bc421c7c2659e793e6dbe12fdf4451310a
nix-bitcoin is a collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.
Overview
nix-bitcoin can be used for personal or merchant wallets, public infrastructure or for Bitcoin application backends. 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.
nix-bitcoin nodes can be deployed on dedicated hardware, virtual machines or containers. The Nix packages and NixOS modules 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.
Get started
- See the examples for an overview of all features.
- To setup a new node from scratch, see the installation instructions.
- To add nix-bitcoin to an existing NixOS configuration, see importable-configuration.nix and the Flake example.
Docs
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 (src)
- 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
- commando: control your node over lightning
- 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 and static channel backups
- Lightning Loop
- Lightning Pool
- charge-lnd: policy-based channel fee manager
- lndconnect via a REST onion service
- Ride The Lightning: web interface for
lndandclightning - spark-wallet
- electrs
- btcpayserver
- liquid
- JoinMarket
- 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
operatorwho has access to client tools (e.g.bitcoin-cli,lightning-cli)
Security
See SECURITY.md for the security policy and how to report a vulnerability.
nix-bitcoin aims to achieve a high degree of security by building on the following principles:
- Simplicity: Only services enabled in
configuration.nixand their dependencies are installed, support for doas (sudo alternative), code is continuously reviewed and refined. - Integrity: The Nix package manager guarantees that all dependencies are exactly specified, 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 features, RPC whitelisting and netns-isolation. There's a non-root user operator to interact with the various services.
- Defense-in-depth: nix-bitcoin supports a hardened kernel, 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.
Troubleshooting
If you are having problems with nix-bitcoin check the FAQ or submit an issue.
There's also a Matrix room at #general:nixbitcoin.org
and a #nix-bitcoin IRC channel on libera.
We are always happy to help.