A collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.
Go to file
Jonas Nick aa169f4653
Merge fort-nix/nix-bitcoin#651: treewide: ensure services are started after secrets setup
90ce68cb16 treewide: ensure services are started after secrets setup (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK 90ce68cb16

Tree-SHA512: b0872c757235b0c66b714bbb82a2b960af040f8a8171d08ace2b4e7515613e67aa9ab56db9a8acf3f9c45ab774cb0a4583e87d4e00279a6c813102f91908c165
2023-10-09 07:45:10 +00:00
dev dev-scenarios: fix comment 2023-08-20 10:54:46 +02:00
docs Update install.md 2023-09-24 11:00:03 +02:00
examples minimal-vm.nix: improve login text 2023-08-20 10:54:45 +02:00
helper release: add nixos-* version branch 2023-07-09 13:13:05 +02:00
modules treewide: ensure services are started after secrets setup 2023-10-08 13:56:56 +02:00
pkgs bitcoin: add shell completions 2023-09-19 14:19:38 +02:00
test update nixpkgs 2023-09-16 13:40:27 +00:00
.cirrus.yml update to nixos 23.05 2023-07-19 17:22:01 +02:00
default.nix delete modules/default.nix 2022-08-28 23:49:12 +02:00
flake.lock update nixpkgs 2023-09-16 13:40:27 +00:00
flake.nix update to nixos 23.05 2023-07-19 17:22:01 +02: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 clightning-plugins/trustedcoin: improve docs 2023-08-03 17:14:40 +02:00
SECURITY.md spark-wallet: remove package and module 2023-06-02 10:50:11 +00:00
shell.nix Clean up development shell.nix 2020-03-30 10:49:15 +02:00

nix-bitcoin logo


CirrusCI status GitHub tag (latest SemVer) GitHub commit activity GitHub contributors GitHub downloads


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

Docs

Hint: To show a table of contents, click the button (Github TOC button) in the top left corner of the documents.

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)

Extension modules

Extension modules are maintained in separate repositories and have their own review and release process.

  • Mempool: Bitcoin visualizer, explorer and API service

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.nix and 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.

Security fund

The nix-bitcoin security fund is a 2 of 3 bitcoin multisig address open for donations, used to reward security researchers who discover vulnerabilities in nix-bitcoin or its upstream dependencies.
See Security Fund for details.

Developing

See dev/README.

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.