https://github.com/bunsdev/chainlink-hooks
https://github.com/bunsdev/chainlink-hooks
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bunsdev/chainlink-hooks
- Owner: BunsDev
- License: mit
- Created: 2024-08-23T05:01:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T07:50:02.000Z (almost 2 years ago)
- Last Synced: 2026-01-12T14:37:32.969Z (5 months ago)
- Language: Solidity
- Size: 52.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# v4-template
### **A template for writing Uniswap v4 Hooks 🦄**
[`Use this Template`](https://github.com/uniswapfoundation/v4-template/generate)
1. The example hook [SwapHook.sol](src/SwapHook.sol) demonstrates the `beforeSwap()` and `afterSwap()` hooks
2. The test template [SwapHook.t.sol](test/SwapHook.t.sol) preconfigures the v4 pool manager, test tokens, and test liquidity.
Updating to v4-template:latest
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 --allow-unrelated-histories
```
---
## 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
```
## Setup
*requires [foundry](https://book.getfoundry.sh)*
```
forge install
forge test
```
### 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
```
Testnets
NOTE: 11/21/2023, the Goerli deployment is out of sync with the latest v4. **It is recommend to use local testing instead**
~~For testing on Goerli Testnet the Uniswap Foundation team has deployed a slimmed down version of the V4 contract (due to current contract size limits) on the network.~~
~~The relevant addresses for testing on Goerli are the ones below~~
```bash
POOL_MANAGER = 0x0
POOL_MODIFY_POSITION_TEST = 0x0
SWAP_ROUTER = 0x0
```
Update the following command with your own private key:
```
forge script script/00_Counter.s.sol \
--rpc-url https://rpc.ankr.com/eth_goerli \
--private-key [your_private_key_on_goerli_here] \
--broadcast
```
### *Deploying your own Tokens For Testing*
Because V4 is still in testing mode, most networks don't have liquidity pools live on V4 testnets. We recommend launching your own test tokens and expirementing with them that. We've included in the templace a Mock UNI and Mock USDC contract for easier testing. You can deploy the contracts and when you do you'll have 1 million mock tokens to test with for each contract. See deployment commands below
```
forge create script/mocks/mUNI.sol:MockUNI \
--rpc-url [your_rpc_url_here] \
--private-key [your_private_key_on_goerli_here]
```
```
forge create script/mocks/mUSDC.sol:MockUSDC \
--rpc-url [your_rpc_url_here] \
--private-key [your_private_key_on_goerli_here]
```
---
Troubleshooting
### *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 *deploye*r 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`
---
Additional resources:
[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)