Merge remote-tracking branch 'upstream/main' into use-proper-tick-spa…

…cing-range

.env

@@ -0,0 +1,7 @@
+FOUNDRY_FUZZ_SEED=0x4444
+
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+        export FOUNDRY_SOLC="./bin/solc-static-linux"
+elif [[ "$OSTYPE" == "darwin"* ]]; then
+        export FOUNDRY_SOLC="./bin/solc-mac"
+fi

.forge-snapshots/before swap hook, already cached dynamic fee.snap

@@ -1 +1 @@
-85384
+172021

.forge-snapshots/cached dynamic fee, no hooks.snap

@@ -1 +1 @@
-82539
+158656

.forge-snapshots/donate gas with 1 token.snap

@@ -1 +1 @@
-95961
+76947

.forge-snapshots/donate gas with 2 tokens.snap

@@ -1 +1 @@
-153292
+134745

.forge-snapshots/erc20 collect protocol fees.snap

@@ -0,0 +1 @@
+25033

.forge-snapshots/gas overhead of no-op lock.snap

@@ -1 +1 @@
-58562
+14918

.forge-snapshots/initialize.snap

@@ -1 +1 @@
-38123
+38101

.forge-snapshots/mint with empty hook.snap

@@ -1 +1 @@
-307130
+264055

.forge-snapshots/mint with native token.snap

@@ -1 +1 @@
-275102
+232085

.forge-snapshots/mint.snap

@@ -1 +1 @@
-293738
+250721

.forge-snapshots/native collect protocol fees.snap

@@ -0,0 +1 @@
+36699

.forge-snapshots/poolManager bytecode size.snap

@@ -0,0 +1 @@
+24630

.forge-snapshots/simple swap native.snap

@@ -0,0 +1 @@
+132772

.forge-snapshots/simple swap.snap

@@ -1 +1 @@
-49771
+129248

.forge-snapshots/swap against liquidity with native token.snap

@@ -1 +1 @@
-125033
+106413

.forge-snapshots/swap against liquidity.snap

@@ -1 +1 @@
-109721
+91101

.forge-snapshots/swap burn claim for input.snap

@@ -0,0 +1 @@
+107809

.forge-snapshots/swap mint output as claim.snap

@@ -0,0 +1 @@
+147831

.forge-snapshots/swap with dynamic fee.snap

@@ -1 +1 @@
-84493
+171256

.forge-snapshots/swap with hooks.snap

@@ -1 +1 @@
-49742
+91079

.forge-snapshots/update dynamic fee in before swap.snap

@@ -1 +1 @@
-91231
+177851

.github/workflows/lint.yml

@@ -15,19 +15,10 @@ jobs:
       - name: Check out Git repository
         uses: actions/checkout@v3
 
-      - name: Set up node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'yarn'
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
 
-      - name: Compile
-        run: yarn prettier-check
+      - name: Lint
+        run: forge fmt --check

.github/workflows/tests.yml

@@ -7,30 +7,6 @@ on:
   pull_request:
 
 jobs:
-  unit-tests:
-    name: Hardhat Unit Tests
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: 'yarn'
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
-      # This is required separately from yarn test because it generates the typechain definitions
-      - name: Compile
-        run: yarn compile
-
-      - name: Run unit tests
-        run: yarn test
-
   forge-tests:
     name: Forge Tests
     runs-on: ubuntu-latest
@@ -52,7 +28,18 @@ jobs:
         with:
           version: nightly
 
+      - name: Build
+        run: forge build
+        env:
+          FOUNDRY_PROFILE: ci
+
       - name: Run tests
         run: forge test -vvv
         env:
           FOUNDRY_PROFILE: ci
+
+      - name: Run forge snapshots
+        run: forge snapshot --check --tolerance 25
+        env:
+          FOUNDRY_PROFILE: ci
+          FOUNDRY_FUZZ_SEED: "0x4444"

.gitignore

@@ -4,4 +4,5 @@ crytic-export/
 node_modules/
 typechain/
 foundry-out/
-.vscode/
+.vscode/
+out/

CONTRIBUTING.md

@@ -32,7 +32,7 @@ Finally, before opening a pull request please do the following:
 - Run the tests and snapshots. Commands are outlined in the [tests](#tests) section.
 - Document any new functions, structs, or interfaces following the natspec standard.
 - Add tests! For smaller contributions, they should be tested with unit tests, and fuzz tests where possible. For bigger contributions, they should be tested with integration tests and invariant tests where possible.
-- Make sure all commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) 
+- Make sure all commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
 
 ## Standards
 
@@ -46,28 +46,24 @@ All contributions must follow the below standards. Maintainers will close out PR
 
 ## Setup
 
-`yarn install` to install dependencies for hardhat
-
-`yarn compile` to compile contracts for hardhat
+Run `source .env` to set FOUNDRY_SOLC to the correct solc binary.
 
 `forge build` to get contract artifacts and dependencies for forge
 
-## Tests
-
-This repo currently uses hardhat and forge tests. Please run both test suites before opening a PR.
+If after running `source .env`, you continue to get the error `Function "tload" not found.` try running
 
-`yarn snapshots` to update the hardhat gas snapshots
+On MacOS:
+`forge build --use ./bin/solc-mac`
 
-`yarn test` to run hardhat tests
+On Linux:
+`forge build --use ./bin/solc-static-linux`
 
-`yarn prettier` to run the formatter (runs both typescript and solidity formatting)
+## Tests
 
-`forge snapshot`to update the forge gas snapshots
+`forge snapshot` to update the forge gas snapshots. Note these must use a static fuzz seed, so please run `source .env`, use `FOUNDRY_FUZZ_SEED=0x4444`, or use `just snapshots` when running forge snapshots.
 
 `forge test` to run forge tests
 
-Any new tests that you add should be written with forge, as the repo is undergoing a full migration to the forge test suite.
-
 ## Code of Conduct
 
 Above all else, please be respectful of the people behind the code. Any kind of aggressive or disrespectful comments, issues, and language will be removed.

README.md

@@ -13,7 +13,7 @@ If you’re interested in contributing please see our [contribution guidelines](
 
 ## Whitepaper
 
-A more detailed description of Uniswap v4 Core can be found in the draft of the [Uniswap v4 Core Whitepaper](./whitepaper-v4-draft.pdf).
+A more detailed description of Uniswap v4 Core can be found in the draft of the [Uniswap v4 Core Whitepaper](./docs/whitepaper-v4.pdf).
 
 ## Architecture
 
@@ -26,7 +26,7 @@ A more detailed description of Uniswap v4 Core can be found in the draft of the
 - `settle`
 - `mint`
 
-Only the net balances owed to the pool (negative) or to the user (positive) are tracked throughout the duration of a lock. This is the `delta` field held in the lock state. Any number of actions can be run on the pools, as long as the deltas accumulated during the lock reach 0 by the lock’s release. This lock and call style architecture gives callers maximum flexibility in integrating with the core code.
+Only the net balances owed to the pool (positive) or to the user (negative) are tracked throughout the duration of a lock. This is the `delta` field held in the lock state. Any number of actions can be run on the pools, as long as the deltas accumulated during the lock reach 0 by the lock’s release. This lock and call style architecture gives callers maximum flexibility in integrating with the core code.
 
 Additionally, a pool may be initialized with a hook contract, that can implement any of the following callbacks in the lifecycle of pool actions: