Add template tooling

.envrc.example

@@ -0,0 +1,29 @@
+# Mnemonic phrase
+export MNEMONIC=""
+
+# Private key
+export PRIVATE_KEY=""
+
+# Mainnet RPC URLs
+export MAINNET_RPC_URL=""
+export ARBITRUM_RPC_URL=""
+export OPTIMISM_RPC_URL=""
+export POLYGON_RPC_URL=""
+
+# Testnet RPC URLs
+export GOERLI_RPC_URL=""
+export ARBITRUM_GOERLI_RPC_URL=""
+export OPTIMISM_GOERLI_RPC_URL=""
+export POLYGON_MUMBAI_RPC_URL=""
+
+# Used for verifying contracts on Etherscan
+export ETHERSCAN_API_KEY=""
+export ARBITRUM_ETHERSCAN_API_KEY=""
+export OPTIMISM_ETHERSCAN_API_KEY=""
+export POLYGONSCAN_API_KEY=""
+
+# Used to run Hardhat scripts in fork mode
+export FORK_ENABLED=true
+
+# Used to report gas usage when running Forge tests
+export FORGE_GAS_REPORT=true

.gitignore

@@ -1,5 +1,6 @@
 # Compiler files
 cache/
+coverage/
 out/
 
 # Ignores development broadcast logs
@@ -12,6 +13,7 @@ docs/
 
 # Dotenv file
 .env
+.envrc
 
 # VSCode
 .history
@@ -20,4 +22,7 @@ docs/
 lcov.info
 
 # Test Output Data
-data/
+data/
+
+.DS_Store
+node_modules

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint-staged && npm test

.lintstagedrc

@@ -0,0 +1,8 @@
+{
+  "*.{json,md,sol,yml}": [
+    "npm run format"
+  ],
+  "*.sol": [
+    "npm run hint"
+  ]
+}

.prettierignore

@@ -0,0 +1,10 @@
+artifacts
+broadcast
+cache
+cache_hardhat
+deployments
+lib
+out
+types
+
+package.json

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "bracketSpacing": true
+      }
+    }
+  ]
+}

.solhint.json

@@ -0,0 +1,11 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": ["prettier"],
+  "rules": {
+    "avoid-low-level-calls": "off",
+    "compiler-version": ["error", "0.8.17"],
+    "func-visibility": "off",
+    "no-empty-blocks": "off",
+    "no-inline-assembly": "off"
+  }
+}

foundry.toml

@@ -2,8 +2,32 @@
 src = 'src'
 out = 'out'
 libs = ['lib']
-gas_reports_ignore = ["ERC20Mintable", "TwabController"]
+solc = "0.8.17"
 gas_limit = "18446744073709551615" # u64::MAX
+gas_reports_ignore = ["ERC20Mintable", "TwabController"]
 block_gas_limit = "18446744073709551615" # u64::MAX
 fs_permissions = [{ access = "read-write", path = "./data"}]
+
+[rpc_endpoints]
+mainnet = "${MAINNET_RPC_URL}"
+arbitrum = "${ARBITRUM_RPC_URL}"
+optimism = "${OPTIMISM_RPC_URL}"
+polygon = "${POLYGON_RPC_URL}"
+
+goerli = "${GOERLI_RPC_URL}"
+arbitrum-goerli = "${ARBITRUM_GOERLI_RPC_URL}"
+optimism-goerli = "${OPTIMISM_GOERLI_RPC_URL}"
+polygon-mumbai = "${POLYGON_MUMBAI_RPC_URL}"
+
+[etherscan]
+mainnet = { key = "${ETHERSCAN_API_KEY}", url = "https://api.etherscan.io/api" }
+arbitrum = { key = "${ARBITRUM_ETHERSCAN_API_KEY}", url = "https://api.arbiscan.io/api" }
+optimism = { key = "${OPTIMISM_ETHERSCAN_API_KEY}", url = "https://api-optimistic.etherscan.io/api" }
+polygon = { key = "${POLYGONSCAN_API_KEY}", url = "https://api.polygonscan.com/api" }
+
+goerli = { key = "${ETHERSCAN_API_KEY}", url = "https://api-goerli.etherscan.io/api" }
+arbitrum-goerli = { key = "${ARBITRUM_ETHERSCAN_API_KEY}", url = "https://api-goerli.arbiscan.io/api" }
+optimism-goerli = { key = "${OPTIMISM_ETHERSCAN_API_KEY}", url = "https://api-goerli-optimistic.etherscan.io/api" }
+polygon-mumbai = { key = "${POLYGONSCAN_API_KEY}", url = "https://api-testnet.polygonscan.com/api" }
+
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config