chore: set up nix environment

.envrc

@@ -0,0 +1 @@
+use flake;

.github/workflows/ci.yaml

@@ -24,8 +24,10 @@ jobs:
         with:
           submodules: recursive
 
-      - name: Set up node
-        uses: actions/setup-node@v3
+      - name: Set up bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
 
       - name: Install foundry
         uses: foundry-rs/foundry-toolchain@v1

.gitignore

@@ -4,6 +4,7 @@
 # Ignore all dotfiles except the whitelisted ones.
 .*
 !.env.example
+!.envrc
 !.github
 !.gitignore
 !.gitattributes

Makefile

@@ -18,7 +18,7 @@ endif
 .RECIPEPREFIX = >
 
 GIT := git
-NPX := npx
+BUNX := bunx
 CAST := cast
 FORGE := forge
 
@@ -56,7 +56,7 @@ test: ## Run the entire test suite
 
 .PHONY: lint
 lint: ## Check linting on all contract source files
-> $(NPX) solhint $(CONTRACTS_DIR)/**/*.sol $(TESTS_DIR)/**/*.sol
+> $(BUNX) solhint $(CONTRACTS_DIR)/**/*.sol $(TESTS_DIR)/**/*.sol
 > $(FORGE) fmt --check $(CONTRACTS_DIR) $(TESTS_DIR)
 
 .PHONY: format

README.md

@@ -9,28 +9,38 @@ Enzyme is an Ethereum-based protocol for decentralized on-chain asset management
 
 If you find a vulnerability that may affect live deployments, you can submit a report via:
 
-A. Immunefi(https://immunefi.com/bounty/enzymefinance/), or
+A. Immunefi (https://immunefi.com/bounty/enzymefinance/), or
 
 B. Direct email to [[email protected]](mailto:[email protected])
 
 Please **DO NOT** open a public issue.
 
 ## Using this Repository
 
-### A Tale of Two Frameworks
-
-:construction:
-
-This repo is currently in-flux for a gradual move from Hardhat to Foundry. All production contracts continue to live in `contracts/persistent/` and `contracts/release/` (deployed contracts [here](https://docs.enzyme.finance/developers/contracts)).
+This repository has been migrated from Hardhat to Foundry. All production contracts continue to live in `contracts/persistent/` and `contracts/release/` (deployed contracts [here](https://docs.enzyme.finance/developers/contracts)).
 
 If you are looking for the legacy test suite & test coverage please refer to the [hardhat branch](https://github.com/enzymefinance/protocol/tree/hardhat).
 
 ### Prerequisites
 
-Make sure to have the following installed:
+#### Automatic
+
+This repository comes with a reproducible development environment based on `nix` and `direnv`.
+
+For the best possible developer experience, make sure you have the following installed:
+
+- [nix](https://nix.dev)
+- [direnv](https://direnv.net)
+
+Once you have these installed, your isolated local development environment will be set up automatically whenever you navigate to this directory.
+
+#### Manual
+
+If you don't want to use `nix`, make sure to have the following installed:
 
 - [foundry](https://github.com/foundry-rs/foundry)
-- [make](https://www.gnu.org/software/make/)
+- [make](https://www.gnu.org/software/make)
+- [bun](https://bun.sh)
 
 Then, clone this repository:
 

flake.nix

@@ -0,0 +1,27 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+    utils.url = "github:numtide/flake-utils";
+    foundry.url = "github:shazow/foundry.nix";
+  };
+
+  outputs = { self, nixpkgs, utils, foundry, ... }:
+    utils.lib.eachDefaultSystem (system: let
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [ foundry.overlay ];
+      };
+    in {
+      formatter = pkgs.alejandra;
+
+      devShells = {
+        default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            bun
+            foundry-bin
+            gnumake
+          ];
+        };
+      };
+    });
+}