README.md

v4-by-example

Solidity snippets for all things Uniswap v4

largely inspired by solidity-by-example

---

License

MIT License

---

Contributing Guide

The project is welcoming all contributions. Please try to limit PRs to:

1. Minimally opinonated examples that showcase v4 features
2. Syncing existing snippets with the latest v4 changes

Setup

Requires node 18

git clone [email protected]:uniswapfoundation/v4-by-example.git

npm i
npm start

Creating a new page

cp -r src/template src/pages/<path>/<name>

Edit the following files

• src/pages/<path>/<name>/index.md
• src/pages/<path>/<name>/Template.sol

Please write foundry tests in forge-test/ for your .sol files!

Register the page on nav.ts

{
  path: "<name>",
  title: "TITLE"
}

Generate react, register routes, and rebuild search index

npm run generate

Update the changelog