move directory

packages/foundry/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: workflow_dispatch
+
+env:
+  FOUNDRY_PROFILE: ci
+
+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
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

packages/foundry/.gitignore

@@ -2,13 +2,17 @@
 cache/
 out/
 
-# Ignores development broadcast logs
+# Ignores development (and goerli) broadcast logs
+!/broadcast
 /broadcast/*/31337/
+/broadcast/*/5/
 /broadcast/**/dry-run/
 
 # Docs
 docs/
 
 # Dotenv file
 .env
-localhost.json
+
+# Node modules
+node_modules/

packages/foundry/.gitmodules

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

packages/foundry/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 saucepoint
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/foundry/README.md

@@ -0,0 +1,102 @@
+# v4-template
+### **A template for writing Uniswap v4 Hooks 🦄**
+
+[`Use this Template`](https://github.com/uniswapfoundation/v4-template/generate)
+
+1. The example hook [Counter.sol](src/Counter.sol) demonstrates the `beforeSwap()` and `afterSwap()` hooks
+2. The test template [Counter.t.sol](test/Counter.t.sol) preconfigures the v4 pool manager, test tokens, and test liquidity.
+
+<details>
+<summary>Updating to v4-template:latest</summary>
+
+This template is actively maintained -- you can update the v4 dependencies, scripts, and helpers: 
+```bash
+git remote add template https://github.com/uniswapfoundation/v4-template
+git fetch template
+git merge template/main <BRANCH> --allow-unrelated-histories
+```
+
+</details>
+
+---
+
+### Check Forge Installation
+*Ensure that you have correctly installed Foundry (Forge) and that it's up to date. You can update Foundry by running:*
+
+```
+foundryup
+```
+
+## Set up
+
+*requires [foundry](https://book.getfoundry.sh)*
+
+```
+forge install
+forge test
+```
+
+## Run script
+
+```
+forge script script/00_Counter.s.sol --tc EtfHookScript --rpc-url https://sepolia.base.org
+```
+
+### Local Development (Anvil)
+
+Other than writing unit tests (recommended!), you can only deploy & test hooks on [anvil](https://book.getfoundry.sh/anvil/)
+
+```bash
+# start anvil, a local EVM chain
+anvil
+
+# in a new terminal
+forge script script/Anvil.s.sol \
+    --rpc-url http://localhost:8545 \
+    --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
+    --broadcast
+```
+
+See [script/](script/) for hook deployment, pool creation, liquidity provision, and swapping.
+
+---
+
+<details>
+<summary><h2>Troubleshooting</h2></summary>
+
+
+
+### *Permission Denied*
+
+When installing dependencies with `forge install`, Github may throw a `Permission Denied` error
+
+Typically caused by missing Github SSH keys, and can be resolved by following the steps [here](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) 
+
+Or [adding the keys to your ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent), if you have already uploaded SSH keys
+
+### Hook deployment failures
+
+Hook deployment failures are caused by incorrect flags or incorrect salt mining
+
+1. Verify the flags are in agreement:
+    * `getHookCalls()` returns the correct flags
+    * `flags` provided to `HookMiner.find(...)`
+2. Verify salt mining is correct:
+    * In **forge test**: the *deployer* for: `new Hook{salt: salt}(...)` and `HookMiner.find(deployer, ...)` are the same. This will be `address(this)`. If using `vm.prank`, the deployer will be the pranking address
+    * In **forge script**: the deployer must be the CREATE2 Proxy: `0x4e59b44847b379578588920cA78FbF26c0B4956C`
+        * If anvil does not have the CREATE2 deployer, your foundry may be out of date. You can update it with `foundryup`
+
+</details>
+
+---
+
+Additional resources:
+
+[Uniswap v4 docs](https://docs.uniswap.org/contracts/v4/overview)
+
+[v4-periphery](https://github.com/uniswap/v4-periphery) contains advanced hook implementations that serve as a great reference
+
+[v4-core](https://github.com/uniswap/v4-core)
+
+[v4-by-example](https://v4-by-example.org)
+