Merge pull request #11678 from MinaProtocol/refactor-split-overlays

Nix: refactor by splitting out overlays per-language

Author: balsoft

flake.nix

@@ -39,7 +39,11 @@
     , opam-nix, opam-repository, nixpkgs-mozilla, flake-buildkite-pipeline, ...
     }:
     {
-      overlay = import ./nix/overlay.nix;
+      overlays = {
+        misc = import ./nix/misc.nix;
+        rust = import ./nix/rust.nix;
+        go = import ./nix/go.nix;
+      };
       nixosModules.mina = import ./nix/modules/mina.nix inputs;
       nixosConfigurations.container = nixpkgs.lib.nixosSystem {
         system = "x86_64-linux";
@@ -150,14 +154,13 @@
     } // utils.lib.eachDefaultSystem (system:
       let
         pkgs = nixpkgs.legacyPackages.${system}.extend
-          (nixpkgs.lib.composeManyExtensions [
+          (nixpkgs.lib.composeManyExtensions ([
             (import nixpkgs-mozilla)
-            (import ./nix/overlay.nix)
             (final: prev: {
               ocamlPackages_mina = requireSubmodules
                 (import ./nix/ocaml.nix { inherit inputs pkgs; });
             })
-          ]);
+          ] ++ builtins.attrValues self.overlays));
         inherit (pkgs) lib;
         mix-to-nix = pkgs.callPackage inputs.mix-to-nix { };
         nix-npm-buildPackage = pkgs.callPackage inputs.nix-npm-buildPackage { };

nix/overlay.nix renamed to nix/go.nix

@@ -1,49 +1,6 @@
-final: prev:
-let pkgs = final;
-in {
-  sodium-static =
-    pkgs.libsodium.overrideAttrs (o: { dontDisableStatic = true; });
-
-  rocksdb = (prev.rocksdb.override {
-    snappy = null;
-    lz4 = null;
-    zstd = null;
-    bzip2 = null;
-  }).overrideAttrs (_: {
-    cmakeFlags = [
-      "-DPORTABLE=1"
-      "-DWITH_JEMALLOC=0"
-      "-DWITH_JNI=0"
-      "-DWITH_BENCHMARK_TOOLS=0"
-      "-DWITH_TESTS=1"
-      "-DWITH_TOOLS=0"
-      "-DWITH_BZ2=0"
-      "-DWITH_LZ4=0"
-      "-DWITH_SNAPPY=0"
-      "-DWITH_ZLIB=0"
-      "-DWITH_ZSTD=0"
-      "-DWITH_GFLAGS=0"
-      "-DUSE_RTTI=1"
-    ];
-  });
-
-  # Dependencies which aren't in nixpkgs and local packages which need networking to build
-
-  marlin_plonk_bindings_stubs = pkgs.rustPlatform.buildRustPackage {
-    pname = "marlin_plonk_bindings_stubs";
-    version = "0.1.0";
-    srcs = [ ../src/lib/marlin_plonk_bindings/stubs ../src/lib/marlin ];
-    nativeBuildInputs = [ pkgs.ocamlPackages_mina.ocaml ];
-    sourceRoot = "stubs";
-    postUnpack = ''
-      mkdir -p marlin_plonk_bindings
-      mv stubs marlin_plonk_bindings
-      export sourceRoot=marlin_plonk_bindings/stubs
-    '';
-    cargoLock.lockFile = ../src/lib/marlin_plonk_bindings/stubs/Cargo.lock;
-  };
-
-  go-capnproto2 = pkgs.buildGoModule rec {
+# An overlay defining Go parts&dependencies of Mina
+final: prev: {
+  go-capnproto2 = final.buildGoModule rec {
     pname = "capnpc-go";
     version = "v3.0.0-alpha.1";
     vendorSha256 = "sha256-jbX/nnlnQoItFXFL/MZZKe4zAjM/EA3q+URJG8I3hok=";
@@ -55,21 +12,22 @@ in {
     };
   };
 
-  libp2p_ipc_go = pkgs.stdenv.mkDerivation {
+  libp2p_ipc_go = final.stdenv.mkDerivation {
     # todo: buildgomodule?
     name = "libp2p_ipc-go";
-    buildInputs = [ pkgs.capnproto pkgs.go-capnproto2 ];
+    buildInputs = [ final.capnproto final.go-capnproto2 ];
     src = ../src/libp2p_ipc;
     buildPhase = ''
-      capnp compile -ogo -I${pkgs.go-capnproto2.src}/std libp2p_ipc.capnp
+      capnp compile -ogo -I${final.go-capnproto2.src}/std libp2p_ipc.capnp
     '';
     installPhase = ''
       mkdir $out
       cp go.mod go.sum *.go $out/
     '';
   };
+
   # Jobs/Test/Libp2pUnitTest
-  libp2p_helper = pkgs.buildGoModule {
+  libp2p_helper = final.buildGoModule {
     pname = "libp2p_helper";
     version = "0.1";
     src = ../src/app/libp2p_helper/src;
@@ -84,9 +42,9 @@ in {
       == "8b90b3cee4be058eeca0bc9a5a2ee88d62cada9fb09785e0ced5e5cea7893192" then
         "sha256-MXLfE122UCNizqvGUu6WlThh1rnZueTqirCzaEWmbno="
       else
-        pkgs.lib.warn
+        final.lib.warn
         "Please update the hashes in ${__curPos.file}#${toString __curPos.line}"
-        pkgs.lib.fakeHash;
+        final.lib.fakeHash;
     NO_MDNS_TEST = 1; # no multicast support inside the nix sandbox
     overrideModAttrs = n: {
       # remove libp2p_ipc from go.mod, inject it back in postconfigure
@@ -96,8 +54,8 @@ in {
     };
     postConfigure = ''
       chmod +w vendor
-      cp -r --reflink=auto ${pkgs.libp2p_ipc_go}/ vendor/libp2p_ipc
+      cp -r --reflink=auto ${final.libp2p_ipc_go}/ vendor/libp2p_ipc
       sed -i 's/.*libp2p_ipc.*//' go.mod
     '';
   };
-}
+}

nix/misc.nix

@@ -0,0 +1,30 @@
+# Overlay containing various overrides for nixpkgs packages used by Mina
+final: prev:
+{
+  sodium-static =
+    final.libsodium.overrideAttrs (o: { dontDisableStatic = true; });
+
+  rocksdb = (prev.rocksdb.override {
+    snappy = null;
+    lz4 = null;
+    zstd = null;
+    bzip2 = null;
+  }).overrideAttrs (_: {
+    cmakeFlags = [
+      "-DPORTABLE=1"
+      "-DWITH_JEMALLOC=0"
+      "-DWITH_JNI=0"
+      "-DWITH_BENCHMARK_TOOLS=0"
+      "-DWITH_TESTS=1"
+      "-DWITH_TOOLS=0"
+      "-DWITH_BZ2=0"
+      "-DWITH_LZ4=0"
+      "-DWITH_SNAPPY=0"
+      "-DWITH_ZLIB=0"
+      "-DWITH_ZSTD=0"
+      "-DWITH_GFLAGS=0"
+      "-DUSE_RTTI=1"
+    ];
+  });
+
+}

nix/ocaml.nix

@@ -1,3 +1,4 @@
+# A set defining OCaml parts&dependencies of Mina
 { inputs, ... }@args:
 let
   opam-nix = inputs.opam-nix.lib.${pkgs.system};

nix/rust.nix

@@ -0,0 +1,16 @@
+# An overlay defining Rust parts&dependencies of Mina
+final: prev: {
+  marlin_plonk_bindings_stubs = final.rustPlatform.buildRustPackage {
+    pname = "marlin_plonk_bindings_stubs";
+    version = "0.1.0";
+    srcs = [ ../src/lib/marlin_plonk_bindings/stubs ../src/lib/marlin ];
+    nativeBuildInputs = [ final.ocamlPackages_mina.ocaml ];
+    sourceRoot = "stubs";
+    postUnpack = ''
+      mkdir -p marlin_plonk_bindings
+      mv stubs marlin_plonk_bindings
+      export sourceRoot=marlin_plonk_bindings/stubs
+    '';
+    cargoLock.lockFile = ../src/lib/marlin_plonk_bindings/stubs/Cargo.lock;
+  };
+}