Add modifyLiquidity script and call with ffi to check to test for acc…

…uracy (#702) * import v3-sdk to ffi * run with isolate * checkpoint ffi addLiq * modifyLiquidity delta check * add weird pool setups * failing fuzz * add fuzz ffi for addLiquidity * remove console * Use MIT license for test scripts * bundle typescript into javascript files (#713) * bundle typescript into javascript files * remove unused imports * adjust just file * fix ci * remove console logs * add prettier config and format code * add prettier to linter --------- Co-authored-by: Diana Kocsis <[email protected]> Co-authored-by: gretzke <[email protected]>
Uniswap · May 26, 2024 · 6e6ce35 · 6e6ce35
1 parent c0adc1c
commit 6e6ce35
Show file tree

Hide file tree

Showing 29 changed files with 118,459 additions and 1,222 deletions.
diff --git a/.env b/.env
@@ -1,7 +1 @@
-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
+FOUNDRY_FUZZ_SEED=0x4444
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -4,31 +4,28 @@ title: "[Bug]: "
 labels: ["bug"]
 
 body:
-    - type: markdown
-      attributes:
-          value: |
-              Please check that the bug is not already being tracked.
-    - type: textarea
-      attributes:
-          label: Describe the bug
-          description: Provide a clear and concise description of what the bug is and which contracts it affects.
-      validations:
-          required: true
-    - type: textarea
-      attributes:
-          label: Expected Behavior
-          description: Provide a clear and concise description of the desired fix.
-      validations:
-          required: true
-    - type: textarea
-      attributes:
-          label: To Reproduce
-          description: If you have written tests to showcase the bug, what can we run to reproduce the issue?
-          placeholder: "git checkout <branchname> / forge test --isolate --mt <testName>"
-    - type: textarea
-      attributes:
-          label: Additional context
-          description: If there is any additional context needed like a dependency or integrating contract that is affected please describe it below.
-
-
-
+  - type: markdown
+    attributes:
+      value: |
+        Please check that the bug is not already being tracked.
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of what the bug is and which contracts it affects.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Provide a clear and concise description of the desired fix.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: If you have written tests to showcase the bug, what can we run to reproduce the issue?
+      placeholder: "git checkout <branchname> / forge test --isolate --mt <testName>"
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: If there is any additional context needed like a dependency or integrating contract that is affected please describe it below.
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yml b/.github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yml
@@ -3,40 +3,40 @@ description: Suggest an improvement to v4-core.
 labels: ["triage"]
 
 body:
-    - type: markdown
-      attributes:
-          value: |
-              Please ensure that the feature has not already been requested.
-    - type: dropdown
-      attributes:
-          label: Component
-          description: Which area of code does your idea improve?
-          multiple: true
-          options:
-            - Hooks
-            - Singleton
-            - Lock and Call
-            - Delta accounting
-            - 1155 Balances
-            - Pool Actions (swap, modifyLiquidity, donate, take, settle, mint)
-            - Gas Optimization
-            - General design optimization (improving efficiency, cleanliness, or developer experience)
-            - Documentation
-    - type: textarea
-      attributes:
-          label: Describe the suggested feature and problem it solves.
-          description: Provide a clear and concise description of what feature you would like to see, and what problems it solves.
-      validations:
-          required: true
-    - type: textarea
-      attributes:
-          label: Describe the desired implementation.
-          description: If possible, provide a suggested architecture change or implementation.
-    - type: textarea
-      attributes:
-          label: Describe alternatives.
-          description: If possible, describe the alternatives you've considered, or describe the current functionality and how it may be sub-optimal.
-    - type: textarea
-      attributes:
-          label: Additional context.
-          description: Please list any additional dependencies or integrating contacts that are affected.
+  - type: markdown
+    attributes:
+      value: |
+        Please ensure that the feature has not already been requested.
+  - type: dropdown
+    attributes:
+      label: Component
+      description: Which area of code does your idea improve?
+      multiple: true
+      options:
+        - Hooks
+        - Singleton
+        - Lock and Call
+        - Delta accounting
+        - 1155 Balances
+        - Pool Actions (swap, modifyLiquidity, donate, take, settle, mint)
+        - Gas Optimization
+        - General design optimization (improving efficiency, cleanliness, or developer experience)
+        - Documentation
+  - type: textarea
+    attributes:
+      label: Describe the suggested feature and problem it solves.
+      description: Provide a clear and concise description of what feature you would like to see, and what problems it solves.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the desired implementation.
+      description: If possible, provide a suggested architecture change or implementation.
+  - type: textarea
+    attributes:
+      label: Describe alternatives.
+      description: If possible, describe the alternatives you've considered, or describe the current functionality and how it may be sub-optimal.
+  - type: textarea
+    attributes:
+      label: Additional context.
+      description: Please list any additional dependencies or integrating contacts that are affected.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,4 +1,5 @@
 ## Related Issue
+
 Which issue does this pull request resolve?
 
-## Description of changes
+## Description of changes
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -1,9 +1,9 @@
 name: code coverage
 
-on: 
+on:
   pull_request:
     branches:
-    - main
+      - main
 
 jobs:
   comment-forge-coverage:
@@ -13,77 +13,77 @@ jobs:
       pull-requests: write
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Install foundry
-      uses: foundry-rs/foundry-toolchain@v1
-      with:
+      - name: Install foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
           version: nightly
-    - name: Run Forge build
-      run: |
+      - name: Run Forge build
+        run: |
           forge --version
           forge build --sizes
-      id: build
-    - name: Run forge coverage
-      id: coverage
-      run: |
-        {
-        echo 'COVERAGE<<EOF'
-        forge coverage | grep '^|' | grep -v 'test/'
-        echo EOF
-        } >> "$GITHUB_OUTPUT"
-      env:
-        FOUNDRY_RPC_URL: '${{ secrets.RPC_URL }}'
-
-    - name: Check coverage is updated
-      uses: actions/github-script@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          const fs = require('fs');
-          const file = "coverage.txt"
-          if(!fs.existsSync(file)) {
-            console.log("Nothing to check");
-            return
-          }
-          const currentCoverage = fs.readFileSync(file, "utf8").trim();
-          const newCoverage = (`${{ steps.coverage.outputs.COVERAGE }}`).trim();
-          if (newCoverage != currentCoverage) {
-            core.setFailed(`Code coverage not updated. Run : forge coverage | grep '^|' | grep -v 'test/'  > coverage.txt`);
-          }
+        id: build
+      - name: Run forge coverage
+        id: coverage
+        run: |
+          {
+          echo 'COVERAGE<<EOF'
+          forge coverage | grep '^|' | grep -v 'test/'
+          echo EOF
+          } >> "$GITHUB_OUTPUT"
+        env:
+          FOUNDRY_RPC_URL: "${{ secrets.RPC_URL }}"
 
-    - name: Comment on PR
-      id: comment
-      uses: actions/github-script@v5
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        script: |
-          const {data: comments} = await github.rest.issues.listComments({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.issue.number, 
-            })
+      - name: Check coverage is updated
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs');
+            const file = "coverage.txt"
+            if(!fs.existsSync(file)) {
+              console.log("Nothing to check");
+              return
+            }
+            const currentCoverage = fs.readFileSync(file, "utf8").trim();
+            const newCoverage = (`${{ steps.coverage.outputs.COVERAGE }}`).trim();
+            if (newCoverage != currentCoverage) {
+              core.setFailed(`Code coverage not updated. Run : forge coverage | grep '^|' | grep -v 'test/'  > coverage.txt`);
+            }
 
-          const botComment = comments.find(comment => comment.user.id === 41898282)
+      - name: Comment on PR
+        id: comment
+        uses: actions/github-script@v5
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const {data: comments} = await github.rest.issues.listComments({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number, 
+              })
 
-          const output = `${{ steps.coverage.outputs.COVERAGE }}`;
-          const commentBody = `Forge code coverage:\n${output}\n`;
+            const botComment = comments.find(comment => comment.user.id === 41898282)
 
-          if (botComment) {
-            github.rest.issues.updateComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              comment_id: botComment.id,
-              body: commentBody
-            })
-          } else {
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: commentBody
-            });
-          }
+            const output = `${{ steps.coverage.outputs.COVERAGE }}`;
+            const commentBody = `Forge code coverage:\n${output}\n`;
+
+            if (botComment) {
+              github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: commentBody
+              })
+            } else {
+              github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: commentBody
+              });
+            }
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -22,3 +22,15 @@ jobs:
 
       - name: Lint
         run: forge fmt --check
+
+      - uses: actions/cache@v2
+        name: Configure npm caching
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/workflows/prettier.yml') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      - name: Check code formatting
+        run: |-
+          npx prettier --check .
diff --git a/.github/workflows/semgrep.yml b/.github/workflows/semgrep.yml
@@ -7,7 +7,7 @@ on:
       - main
   schedule:
     # random HH:MM to avoid a load spike on GitHub Actions at 00:00
-    - cron: '35 11 * * *'
+    - cron: "35 11 * * *"
 jobs:
   semgrep:
     name: semgrep/ci

diff --git a/.github/workflows/tests-merge.yml b/.github/workflows/tests-merge.yml
@@ -15,15 +15,6 @@ jobs:
         with:
           submodules: recursive
 
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache-dependency-path: './test/js-scripts'
-          cache: 'yarn'
-
-      - run: yarn
-        working-directory: ./test/js-scripts
-
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
@@ -39,4 +30,3 @@ jobs:
         env:
           FOUNDRY_PROFILE: ci
           FORGE_SNAPSHOT_CHECK: true
-
diff --git a/.github/workflows/tests-pr.yml b/.github/workflows/tests-pr.yml
@@ -16,15 +16,6 @@ jobs:
         with:
           submodules: recursive
 
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache-dependency-path: './test/js-scripts'
-          cache: 'yarn'
-
-      - run: yarn
-        working-directory: ./test/js-scripts
-
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
@@ -40,4 +31,3 @@ jobs:
         env:
           FOUNDRY_PROFILE: pr
           FORGE_SNAPSHOT_CHECK: true
-
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+.prettierrc
+foundry.toml
+out
+lib/
+cache/
+*.sol
+dist/