add flake support

This change is fully backwards compatible. We continue to use the standard non-flake evaluation mode in our examples and internal tooling until the flakes design has stabilized. 'clightning-plugins = pkgs.recurseIntoAttrs' in pkgs/default.nix is needed by flake-utils.lib.flattenTree in flake.nix. It transforms the packages in `clightning-plugins` to top-level packages named like `clightning-plugins/summary`. (The flake attr `packages` must be a non-nested attrset of derivations.)
2021-08-16 10:42:07 +02:00
parent de77281cba
commit f7c2133250
7 changed files with 246 additions and 13 deletions
--- a/flake.nix
+++ b/flake.nix
@@ -0,0 +1,106 @@
+{
+  description = ''
+    A collection of Nix packages and NixOS modules for easily
+    installing full-featured Bitcoin nodes with an emphasis on security.
+  '';
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-21.05";
+    nixpkgsUnstable.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, nixpkgsUnstable, flake-utils }:
+    let
+      supportedSystems = [ "x86_64-linux" "i686-linux" "aarch64-linux" ];
+    in
+    rec {
+      mkNbPkgs = {
+        system
+        , pkgs ? import nixpkgs { inherit system; }
+        , pkgsUnstable ? import nixpkgsUnstable { inherit system; }
+      }:
+        import ./pkgs { inherit pkgs pkgsUnstable; };
+
+      overlay = final: prev: let
+        nbPkgs = mkNbPkgs { inherit (final) system; pkgs = final; };
+      in removeAttrs nbPkgs [ "pinned" "nixops19_09" "krops" ];
+
+      nixosModules = {
+        # Uses the default system pkgs for nix-bitcoin.pkgs
+        withSystemPkgs =  { pkgs, ... }: {
+          imports = [ ./modules/modules.nix ];
+          nix-bitcoin.pkgs = (mkNbPkgs { inherit (pkgs) system; inherit pkgs; }).modulesPkgs;
+        };
+
+        # Uses the nixpkgs version locked by this flake for nix-bitcoin.pkgs.
+        # More stable, but slightly slower to evaluate and needs more space if the
+        # locked and the system nixpkgs versions differ.
+        withLockedPkgs =  { config, ... }: {
+          imports = [ ./modules/modules.nix ];
+          nix-bitcoin.pkgs = (mkNbPkgs { inherit (config.nixpkgs) system; }).modulesPkgs;
+        };
+      };
+
+      defaultTemplate = {
+        description = "Basic node template";
+        path = ./examples/flakes;
+      };
+
+    } // (flake-utils.lib.eachSystem supportedSystems (system:
+      let
+        pkgs = import nixpkgs { inherit system; };
+
+        mkVMScript = vm: pkgs.writers.writeBash "run-vm" ''
+          set -euo pipefail
+          export TMPDIR=$(mktemp -d /tmp/nix-bitcoin-vm.XXX)
+          trap "rm -rf $TMPDIR" EXIT
+          export NIX_DISK_IMAGE=$TMPDIR/nixos.qcow2
+          QEMU_OPTS="-smp $(nproc) -m 1500" ${vm}/bin/run-*-vm
+        '';
+      in rec {
+        nbPkgs = self.mkNbPkgs { inherit system pkgs; };
+
+        packages = flake-utils.lib.flattenTree (removeAttrs nbPkgs [
+          "pinned" "modulesPkgs" "nixops19_09" "krops"
+        ]) // {
+          runVM = mkVMScript packages.vm;
+
+          # This is a simple demo VM.
+          # See ./examples/flakes/flake.nix on how to use nix-bitcoin with flakes.
+          vm = let
+            nix-bitcoin = self;
+          in
+            (import "${nixpkgs}/nixos" {
+              inherit system;
+              configuration = {
+                imports = [
+                  nix-bitcoin.nixosModules.withSystemPkgs
+                  "${nix-bitcoin}/modules/presets/secure-node.nix"
+                ];
+
+                nix-bitcoin.generateSecrets = true;
+                services.clightning.enable = true;
+                # For faster startup in offline VMs
+                services.clightning.extraConfig = "disable-dns";
+
+                nixpkgs.pkgs = pkgs;
+                virtualisation.graphics = false;
+                services.getty.autologinUser = "root";
+                nix.nixPath = [ "nixpkgs=${nixpkgs}" ];
+              };
+            }).vm;
+        };
+
+        defaultApp = apps.vm;
+
+        apps = {
+          # Run a basic nix-bitcoin node in a VM
+          vm = {
+            type = "app";
+            program = toString packages.runVM;
+          };
+        };
+      }
+    ));
+}