Initial commit

Author: pegahcarter

.env.EXAMPLE

@@ -0,0 +1,15 @@
+PK=0x{$INSERT_KEY_HERE}
+
+MAINNET_RPC_URL=https://eth-mainnet.g.alchemy.com/v2/{$INSERT_KEY_HERE}
+ETHERSCAN_API_URL=https://api.etherscan.io/api
+ETHERSCAN_API_KEY={$INSERT_KEY_HERE}
+
+POLYGON_RPC_URL=https://polygon-mainnet.g.alchemy.com/v2/{$INSERT_KEY_HERE}
+POLYGONSCAN_API_URL=https://api.polygonscan.com/api
+POLYGONSCAN_API_KEY={$INSERT_KEY_HERE}
+
+FRAXTAL_RPC_URL=https://rpc.frax.com
+FRAXTAL_TESTNET_RPC_URL=https://rpc.testnet.frax.com
+FRAXSCAN_API_URL=https://api.fraxscan.com/api
+FRAXSCAN_TESTNET_API_URL=https://api-holesky.fraxscan.com/api
+FRAXSCAN_API_KEY={$INSERT_KEY_HERE}

.github/workflows/main.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+name: Node.js CI
+on:
+  push:
+    branches: master
+  pull_request:
+    branches: master
+jobs:
+  build:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    env:
+      MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
+      FOUNDRY_PROFILE: "test"
+    steps:
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+      - uses: actions/checkout@v2
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.11.0
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+      - run: pnpm i
+      - run: pnpm lint:check
+      - run: forge build
+      - run: forge test

.gitignore

@@ -0,0 +1,22 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+#misc
+node_modules
+.DS_Store
+.vscode
+lcov.info
+report/
+.idea/

.husky/_/.gitignore

@@ -0,0 +1 @@
+*

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged --allow-empty

.lintstagedrc

@@ -0,0 +1,8 @@
+{
+  "*.{js,json,ts,yaml,yml}": [
+    "prettier --config ./.prettierrc.json --write"
+  ],
+  "*.sol": [
+    "forge fmt", "prettier --config ./.prettierrc.json --write"
+  ]
+}

.npmrc

@@ -0,0 +1 @@
+public-hoist-pattern=*

.prettierignore

@@ -0,0 +1,9 @@
+# directories
+out
+broadcast
+cache
+artifacts
+
+# files
+*.env
+

.prettierrc.json

@@ -0,0 +1,21 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "endOfLine": "auto",
+  "printWidth": 120,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "plugins": ["prettier-plugin-svelte", "prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "bracketSpacing": true,
+        "tabWidth": 4,
+        "singleQuote": false,
+        "parser": "solidity-parse"
+      }
+    }
+  ]
+}

.solhint.json

@@ -0,0 +1,24 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": ["prettier"],
+  "rules": {
+    "code-complexity": ["warn", 8],
+    "compiler-version": ["warn", ">=0.8.0"],
+    "const-name-snakecase": "warn",
+    "constructor-syntax": "error",
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "max-line-length": ["warn", 120],
+    "not-rely-on-time": "warn",
+    "prettier/prettier": [
+      "warn",
+      {
+        "endOfLine": "auto"
+      }
+    ],
+    "reason-string": ["warn", { "maxLength": 32 }],
+    "func-param-name-mixedCase": "warn",
+    "named-parameters-mapping": "warn",
+    "private-vars-leading-underscore": "warn",
+    "no-console": "warn"
+  }
+}