From a47cf5aa2cc6fa4b6352ecb8697f08b9b8932441 Mon Sep 17 00:00:00 2001
From: zah <zahary@status.im>
Date: Sat, 15 Oct 2022 04:46:30 +0300
Subject: [PATCH] Flake-based build environment for Nix users (#3534)

---
 .envrc                     | 16 ++++++++++++++
 .gitignore                 |  1 +
 env.sh                     | 20 ++++++++++--------
 installer/nix/.gitignore   |  2 ++
 installer/nix/flake.lock   | 43 ++++++++++++++++++++++++++++++++++++++
 installer/nix/flake.nix    | 15 +++++++++++++
 installer/nix/shell.nix    | 23 ++++++++++++++++++++
 vendor/nim-nat-traversal   |  2 +-
 vendor/nimbus-build-system |  2 +-
 9 files changed, 113 insertions(+), 11 deletions(-)
 create mode 100644 .envrc
 create mode 100644 installer/nix/.gitignore
 create mode 100644 installer/nix/flake.lock
 create mode 100644 installer/nix/flake.nix
 create mode 100644 installer/nix/shell.nix

diff --git a/.envrc b/.envrc
new file mode 100644
index 000000000..c3cc25a7c
--- /dev/null
+++ b/.envrc
@@ -0,0 +1,16 @@
+NBS_ONLY_LOAD_ENV_VARS=1 source env.sh
+
+if command -v nix > /dev/null
+then
+  export NIMBUS_NIX_ENV=1
+
+  cd installer/nix
+  # watch_file tells direnv that changes to any of the watched files
+  # should trigger a re-evalution of the environment
+  watch_file flake.nix
+  watch_file flake.lock
+  watch_file shell.nix
+
+  mkdir -p .flake-profiles
+  eval "$(nix print-dev-env --profile ".flake-profiles/profile")"
+fi
diff --git a/.gitignore b/.gitignore
index b069fa3e1..16649bf83 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,6 +22,7 @@ build/
 # Each developer can create a personal .env file with
 # local settings overrides (e.g. WEB3_URL)
 .env
+.direnv/
 
 # Ignore dynamic, static libs and libtool archive files
 *.so
diff --git a/env.sh b/env.sh
index b3701ca74..c0466092a 100755
--- a/env.sh
+++ b/env.sh
@@ -7,17 +7,19 @@ ABS_PATH="$(cd ${REL_PATH}; pwd)"
 
 # Activate nvm only when this file is sourced without arguments:
 if [ -z "$*" ]; then
-  if command -v nvm > /dev/null; then
-    nvm use
-    command -v ganache-cli > /dev/null || { npm install -g ganache-cli; }
-  else
-    echo <<EOF
-  In order to use Ganache (a development ETH1 chain), please install NVM with:
-  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
+  if ! command -v ganache-cli > /dev/null; then
+    if command -v nvm > /dev/null; then
+      nvm use
+      npm install -g ganache-cli
+    else
+      echo <<EOF
+    In order to use Ganache (a development ETH1 chain), please install NVM with:
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
 
-  For more info:
-  https://github.com/nvm-sh/nvm
+    For more info:
+    https://github.com/nvm-sh/nvm
 EOF
+    fi
   fi
 fi
 
diff --git a/installer/nix/.gitignore b/installer/nix/.gitignore
new file mode 100644
index 000000000..0500e4799
--- /dev/null
+++ b/installer/nix/.gitignore
@@ -0,0 +1,2 @@
+# Local file unique for each user
+.flake-profiles/
\ No newline at end of file
diff --git a/installer/nix/flake.lock b/installer/nix/flake.lock
new file mode 100644
index 000000000..788369f5c
--- /dev/null
+++ b/installer/nix/flake.lock
@@ -0,0 +1,43 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "locked": {
+        "lastModified": 1659877975,
+        "narHash": "sha256-zllb8aq3YO3h8B/U0/J1WBgAL8EX5yWf5pMj3G0NAmc=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "c0e246b9b83f637f4681389ecabcb2681b4f3af0",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1659446231,
+        "narHash": "sha256-hekabNdTdgR/iLsgce5TGWmfIDZ86qjPhxDg/8TlzhE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "eabc38219184cc3e04a974fe31857d8e0eac098d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-21.11",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}
diff --git a/installer/nix/flake.nix b/installer/nix/flake.nix
new file mode 100644
index 000000000..d9f8a6c07
--- /dev/null
+++ b/installer/nix/flake.nix
@@ -0,0 +1,15 @@
+{
+  description = "nimbus-eth2";
+
+  inputs = {
+    nixpkgs.url = github:NixOS/nixpkgs/nixos-21.11;
+    flake-utils.url = github:numtide/flake-utils;
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.simpleFlake {
+      inherit self nixpkgs;
+      name = "nimbus-eth2";
+      shell = ./shell.nix;
+    };
+}
\ No newline at end of file
diff --git a/installer/nix/shell.nix b/installer/nix/shell.nix
new file mode 100644
index 000000000..e1ea571db
--- /dev/null
+++ b/installer/nix/shell.nix
@@ -0,0 +1,23 @@
+{ pkgs ? import <nixpkgs> { } }: with pkgs;
+mkShell {
+  buildInputs = [
+    llvmPackages_14.clang-unwrapped
+    figlet
+    git
+    gnumake
+
+    # For installing ganache for local simulations
+    nodePackages.ganache-cli
+  ] ++ lib.optionals (!stdenv.isDarwin) [
+    lsb-release
+  ];
+
+  shellHook = ''
+    # We use clang unwrapped because the compiler wrappers under Nix
+    # ignore -march=native in order to keep the build deterministic
+    export PATH=${llvmPackages_14.clang-unwrapped}/bin:$PATH
+    export CC=clang
+
+    figlet "Welcome to Nimbus-eth2"
+  '';
+}
diff --git a/vendor/nim-nat-traversal b/vendor/nim-nat-traversal
index 11df74552..27d314d65 160000
--- a/vendor/nim-nat-traversal
+++ b/vendor/nim-nat-traversal
@@ -1 +1 @@
-Subproject commit 11df74552d3a3abe2c722c536c8075ef6814d5fa
+Subproject commit 27d314d65c9078924b3239fe4e2f5af0c512b28c
diff --git a/vendor/nimbus-build-system b/vendor/nimbus-build-system
index 07e37730c..dc535cd46 160000
--- a/vendor/nimbus-build-system
+++ b/vendor/nimbus-build-system
@@ -1 +1 @@
-Subproject commit 07e37730c627c19848e8662352976afe7e15bb1f
+Subproject commit dc535cd4627e6c1ec023ee6d6d0c3e5d66d414e5