Private Testnet (#239)

* Improved the Ethereum migrations

* Fixes the docker services so that migrations runs consistently

* Increased the reliability of the docker images

* Miscallaneous improvements to the infrastructure

* Setup a github action to deploy the migrations image to the registry

* Renamed the python scripts

* Bump node version in CI

* Cleaned up `HyperdriveMath`

* Experimenting with pushing to the registry

* Added submodules to the docker workflow

* Changed the tagging logic in the docker github action

* Revert "Changed the tagging logic in the docker github action"

This reverts commit 64e00d2.

* Updated tagging logic

* Build the foundry code in the image

* Cleanup

* Added semver tagging to the github workflows

* Updated docker workflow to run when tags are pushed

* Use the production profile

* secret sauce

* Reverted to an earlier foundry version

* Updated the CI

* Pinned ape to a working version

* Fixed the tests after foundry update

* Reverted the changes to the python requirements

* Log the files

* Removed python cache

* Updated python version

* Updated the eth-ape dependency

* Fixed a numerical bug in `calculateCloseShort`

* Removed the deprecated ape setting

* run anvil on 8549 by default

* more detailed pytest

* try forge install

* remove unnecessary dependency line

* add compile step

* additional update step to ape dependencies

* Pinned to the previous ape-solidity version:

* install fix to eth-solidity

* fix the fix

* fix ape-config

* remove version pin, use upstream fix

* more descriptive pytest settings

* try to unbreak the benchmark

Revert "more descriptive pytest settings"

This reverts commit 89a228f.

* actually test upstream, add github tokens to avoid rate limit

* more verbose pytest, for specific workflow step only

* remove pytest.ini after we use it

* add newline

* fix pytest.ini

---------

Co-authored-by: Mihai <[email protected]>

Author: jalextowle

.github/workflows/benchmark.yml

@@ -21,22 +21,27 @@ jobs:
       - name: install node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
+
       - name: install packages
         uses: borales/actions-yarn@v4
         with:
           cmd: install # will run `yarn install` command
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # if needed
+
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
       # Run the gas benchmark and stores the output to a json file.
       - name: Run benchmark
-        run: python scripts/gas_benchmarks.py benchmarks.json
+        run: python python/gas_benchmarks.py benchmarks.json
 
       # Load the benchmarks cache. We use a different cache key for every run
       # because Github Actions caches are currently immutable. By specifying the

.github/workflows/coverage.yml

@@ -23,7 +23,7 @@ jobs:
       - name: install node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: install packages
         uses: borales/actions-yarn@v4
@@ -34,6 +34,8 @@ jobs:
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
 
       - name: Run coverage
         run: |

.github/workflows/docker.yml

@@ -0,0 +1,49 @@
+name: Publish the artifacts image
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "main"
+    tags:
+      - "v*"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}/migrations
+
+jobs:
+  push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=sha,enable=true,prefix=nightly-,suffix=,format=long
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/lint.yml

@@ -23,7 +23,7 @@ jobs:
       - name: install node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: install packages
         uses: borales/actions-yarn@v4

.github/workflows/test.yml

@@ -19,16 +19,19 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: install node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: install packages
         uses: borales/actions-yarn@v4
         with:
           cmd: install # will run `yarn install` command
+          token: ${{ secrets.GITHUB_TOKEN }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # if needed
 
@@ -44,14 +47,20 @@ jobs:
         uses: actions/setup-python@v3
         with:
           python-version: "3.10.10"
-          cache: "pip"
+          cache: pip
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: install python dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install -r requirements.txt
-          python -m pip install eth-ape pytest
           ape plugins install .
+          ape compile --force
 
       - name: test python
-        run: python -m pytest .
+        run: |
+          echo "[pytest]
+          log_cli: true
+          log_level: DEBUG" > pytest.ini
+          python -m pytest . -r A --verbosity=2
+          rm pytest.ini

Dockerfile

@@ -0,0 +1,42 @@
+### Yarn Image ###
+
+FROM node:lts AS yarn-builder
+
+WORKDIR /src
+
+COPY ./package.json ./package.json
+COPY ./yarn.lock ./yarn.lock
+
+RUN yarn install
+
+### Foundry Image ###
+
+FROM ghcr.io/foundry-rs/foundry:master
+
+WORKDIR /src
+
+# Load the ethereum environment variables.
+ENV ETH_FROM=${ETH_FROM}
+ENV PRIVATE_KEY=${PRIVATE_KEY}
+ENV RPC_URL=${RPC_URL}
+
+# Copy the contract dependencies required to run the migration script.
+COPY --from=yarn-builder /src/node_modules/@openzeppelin/ ./node_modules/@openzeppelin/
+COPY ./.git/ ./.git/
+COPY ./contracts/ ./contracts/
+COPY ./lib/ ./lib/
+COPY ./script/ ./script/
+COPY ./test/ ./test/
+COPY ./foundry.toml ./foundry.toml
+
+# Build the contracts using the "production" profile.
+RUN FOUNDRY_PROFILE="production" forge build
+
+# Copy the script used to run the migrations and set its permissions.
+COPY ./run_migrations.sh ./run_migrations.sh
+RUN chmod a+x ./run_migrations.sh
+
+# Create the artifacts directory. 
+RUN mkdir -p ./artifacts
+
+ENTRYPOINT ./run_migrations.sh

ape-config.yaml

@@ -4,16 +4,16 @@ plugins:
   - name: foundry
 
 dependencies:
-  - name: OpenZeppelin
-    github: OpenZeppelin/openzeppelin-contracts
-    version: 4.8.1
   - name: Aave
     github: aave/aave-v3-core
     version: 1.17.2
+  - name: OpenZeppelin
+    github: OpenZeppelin/openzeppelin-contracts
+    version: 4.8.3
 
 solidity:
   import_remapping:
-    - "@openzeppelin/contracts=OpenZeppelin/4.8.1"
+    - "@openzeppelin/contracts=OpenZeppelin/4.8.3"
     - "@aave=Aave/1.17.2"
 
 ethereum:
@@ -22,4 +22,4 @@ ethereum:
     default_provider: foundry
 
 foundry:
-  port: 8555
+  host: http://localhost:8555

contracts/src/libraries/HyperdriveMath.sol

@@ -316,8 +316,8 @@ library HyperdriveMath {
             _sharePrice
         );
 
-        if (_normalizedTimeRemaining > 0) {
-            bondReservesDelta = _amountOut.mulDown(_normalizedTimeRemaining);
+        bondReservesDelta = _amountOut.mulDown(_normalizedTimeRemaining);
+        if (bondReservesDelta > 0) {
             shareReservesDelta = YieldSpaceMath.calculateSharesInGivenBondsOut(
                 _shareReserves,
                 _bondReserves,

foundry.toml

@@ -16,6 +16,8 @@ cache_path  = 'forge-cache'
 remappings = ['forge-std=lib/forge-std/src', '@openzeppelin/=node_modules/@openzeppelin', '@aave/=lib/aave-v3-core/contracts']
 # gas limit - max u64
 gas_limit = "18446744073709551615"
+# Allows the scripts to write the addresses to a file.
+fs_permissions = [{ access = "write", path = "./artifacts/script_addresses.json" }]
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config
 
 [profile.production]