Initial commit

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{diff,md}]
+trim_trailing_whitespace = false
+
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2
+
+[foundry.toml]
+indent_style = space
+indent_size = 4

.env.example

@@ -0,0 +1,6 @@
+export FOUNDRY_ETH_FROM='string: wallet address'
+export FOUNDRY_ETH_KEYSTORE_DIR='string: keystore directory'
+export FOUNDRY_ETH_PASSWORD_FILE='string: keystore file password'
+
+export ALCHEMY_API_KEY='string: API key'
+export ETHERSCAN_API_KEY='string: API key'

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.github/workflows/tests.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+env:
+  FOUNDRY_PROFILE: ci
+  # For fork mode only
+  # FORK_URL: ${{ secrets.ALCHEMY_GOERLI_ETH_RPC_URL }}
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry Project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge Build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      # Standalone mode
+      - name: Run Forge Tests
+        run: |
+          forge test -vvv
+        id: test
+
+      # Fork mode
+      # - name: Run Forge Tests
+      #   run: |
+      #     forge test -vvv --fork-url=$FORK_URL
+      #   id: test

.gitignore

@@ -0,0 +1,6 @@
+cache/
+out/
+node_modules/
+.env*
+!.env.example
+broadcast/

.gitmodules

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

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "${1}"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1 @@
+lib/

.prettierrc.json

@@ -0,0 +1,13 @@
+{
+  "printWidth": 120,
+  "overrides": [
+    {
+      "files": [
+        "*.json"
+      ],
+      "options": {
+        "parser": "json-stringify"
+      }
+    }
+  ]
+}

.solhint.json

@@ -0,0 +1,20 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": [
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "warn",
+    "max-line-length": "off",
+    "check-send-result": "off",
+    "not-rely-on-time": "off",
+    "multiple-sends": "off",
+    "compiler-version": "off",
+    "func-visibility": [
+      "warn",
+      {
+        "ignoreConstructors": true
+      }
+    ]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+lib/