feat: Setup repo to compile contracts

Author: DrakeEvans

.env.example

@@ -0,0 +1,9 @@
+## NODE URLS
+MAINNET_URL=https://eth-mainnet.alchemyapi.io/v2/API_KEY
+POLYGON_MAINNET_URL=https://polygon-mainnet.g.alchemy.com/v2/API_KEY
+RINKEBY_URL=
+DEFAULT_FORK_BLOCK=15001901
+
+## Always consider these compromised
+MNEMONIC=
+PRIVATE_KEY=

.gitignore

@@ -0,0 +1,16 @@
+# files
+.DS_Store
+node_modules
+
+# env
+.env
+
+# foundry
+out
+cache
+
+# hardhat
+artifacts
+
+# typechain
+typechain

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/ds-test"]
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test

foundry.toml

@@ -0,0 +1,21 @@
+[profile.default]
+src = 'src/contracts'
+test = 'src/test'
+out = 'out'
+libs = ['node_modules', 'lib']
+#block number
+block_number = 100
+# The block timestamp in tests
+block_timestamp = 1500
+# allow ffi
+ffi = true
+# gas limit in tests
+gas_limit = 30000000
+# optimizer
+optimizer = true
+# optimizer runs
+optimizer_runs = 200
+# use via-ir optimizer
+# via_ir = true
+
+# See more config options https://github.com/gakonst/foundry/tree/master/config

hardhat.config.ts

@@ -0,0 +1,118 @@
+import * as fs from "fs";
+import { config as dotenvConfig } from "dotenv";
+import "@nomiclabs/hardhat-ethers";
+import '@typechain/hardhat'
+import '@nomiclabs/hardhat-ethers'
+import '@nomiclabs/hardhat-waffle'
+import { HardhatUserConfig } from "hardhat/config";
+import "hardhat-gas-reporter";
+import "hardhat-preprocessor";
+import "solidity-coverage";
+
+dotenvConfig();
+
+// Ensure that we have all the environment variables we need.
+const mnemonic = process.env.MNEMONIC as string;
+const mainnetUrl = process.env.MAINNET_URL as string;
+
+const chainIds = {
+  hardhat: 1337,
+  mainnet: 1,
+  "polygon-mainnet": 137,
+  rinkeby: 4,
+};
+
+function getRemappings() {
+  return fs
+    .readFileSync("remappings.txt", "utf8")
+    .split("\n")
+    .map((line) => line.trim().split("="));
+}
+
+const config: HardhatUserConfig = {
+  defaultNetwork: "hardhat",
+  gasReporter: {
+    currency: "USD",
+    enabled: true,
+    excludeContracts: [],
+    src: "./contracts",
+  },
+  networks: {
+    hardhat: {
+      gas: "auto",
+      accounts: {
+        mnemonic,
+      },
+      chainId: chainIds.hardhat,
+      // forking: {
+      //   url: mainnetUrl,
+      //   blockNumber: Number.parseInt(process.env.DEFAULT_FORK_BLOCK as string),
+      // },
+    },
+    // mainnet: {
+    //   accounts: [process.env.PRIVATE_KEY as string],
+    //   chainId: chainIds.mainnet,
+    //   url: mainnetUrl,
+    // },
+    // "polygon-mainnet": {
+    //   accounts: [process.env.PRIVATE_KEY as string],
+    //   chainId: chainIds["polygon-mainnet"],
+    //   url: process.env.POLYGON_MAINNET_URL,
+    //   timeout: 100000,
+    // },
+    // rinkeby: {
+    //   accounts: {
+    //     mnemonic
+    //   },
+    //   chainId: chainIds.rinkeby,
+    //   url: process.env.RINKEBY_URL,
+    // },
+  },
+  paths: {
+    artifacts: "./artifacts",
+    cache: "./cache",
+    sources: "./src",
+    tests: "./src/test",
+  },
+  solidity: {
+    compilers: [
+      {
+        version: "0.8.15",
+        settings: {
+          // viaIR: true,
+          metadata: {
+            // Not including the metadata hash
+            // https://github.com/paulrberg/solidity-template/issues/31
+            bytecodeHash: "none",
+          },
+          // Disable the optimizer when debugging
+          // https://hardhat.org/hardhat-network/#solidity-optimizer-support
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+    ],
+  },
+  typechain: {
+    outDir: "./typechain/types",
+    target: "ethers-v5",
+  },
+  preprocess: {
+    eachLine: (hre) => ({
+      transform: (line: string) => {
+        if (line.match(/^\s*import /i)) {
+          getRemappings().forEach(([find, replace]) => {
+            if (line.match('"' + find)) {
+              line = line.replace('"' + find, '"' + replace);
+            }
+          });
+        }
+        return line;
+      },
+    }),
+  },
+};
+
+export default config;