feat: implementation of new features

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4
+
+[*.tree]
+indent_size = 1

.env.example

@@ -1 +1,2 @@
-MNEMONIC=
+export TESTNET=true
+export HEX_PRIV_KEY="HEX_PRIV_KEY"

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+custom: "https://3cities.xyz/#/pay?c=CAESFAKY9DMuOFdjE4Wzl2YyUFipPiSfIgICATICCAJaFURvbmF0aW9uIHRvIFBhdWwgQmVyZw"
+github: "PaulRBerg"

.github/setup/action.yml

@@ -0,0 +1,20 @@
+name: Setup Node and Foundry
+description: Comprehensive setup for Node.js environment with Foundry toolchain
+
+runs:
+  using: composite
+  steps:
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
+      with:
+        version: nightly
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 20.x
+        check-latest: true
+        cache: yarn
+
+    - name: Install dependencies
+      shell: bash
+      run: yarn install --frozen-lockfile --audit

.github/workflows/ci.yml

@@ -1,177 +1,97 @@
-name: E2E (tapio-qa)
+name: "CI"
+
+env:
+  FOUNDRY_PROFILE: "ci"
 
-# Trigger this workflow on merge (push the code to the main)
 on:
+  workflow_dispatch:
+  pull_request:
   push:
     branches:
-      - main
-      - workflow-for-running-tapio-qa-tests
-  workflow_dispatch:
-
-concurrency:
-  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label ||
-    github.head_ref || github.ref }}"
-  cancel-in-progress: true
+      - "main"
 
 jobs:
-  e2e-chrome:
-    runs-on: ubuntu-latest
+  lint:
+    runs-on: "ubuntu-latest"
     steps:
-      - name: Checkout nutsfinance/tapio-qa private repo
-        uses: actions/checkout@main
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - uses: actions/setup-node@v2
         with:
-          repository: nutsfinance/tapio-qa
-          token: ${{ secrets.GH_PAT }} #Please provide your Personal Access Token
+          node-version: 18
+          cache: "yarn"
 
-      - name: Install pnpm
-        uses: pnpm/action-setup@c3b53f6a16e57305370b4ae5a540c2077a1d50dd # [email protected]
+      - name: "Install the Node.js dependencies"
+        run: "yarn install"
 
-      - name: Setup node
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # [email protected]
-        with:
-          node-version: 18.16
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: Set pnpm cache directory
-        run: pnpm config set store-dir .pnpm-store
-        continue-on-error: true
+      - name: "Lint the code"
+        run: "yarn run lint"
 
-      - name: Setup cache
-        uses: actions/cache@69d9d449aced6a2ede0bc19182fadc3a0a42d2b0 # pin@v2
-        with:
-          path: |
-            .pnpm-store
-            node_modules
-            /home/runner/.cache/Cypress
-          key: ${{ runner.os }}-pnpm-v1-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-v1-
-        continue-on-error: true
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile --prefer-offline
-
-      - name: Install linux deps
+      - name: "Add lint summary"
         run: |
-          sudo apt-get install --no-install-recommends -y \
-          fluxbox \
-          xvfb
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
-      - name: Run xvfb and fluxbox as virtual monitors
-        run: |
-          Xvfb :0 -screen 0 1024x768x24 -listen tcp -ac &
-          fluxbox &
-        env:
-          DISPLAY: :0.0
-
-      - name: Run e2e tests (cypress-action)
-        uses: cypress-io/github-action@cdbbcd60fb5d967d7a37d8eb148add76a7ded7b6 # [email protected]
-        continue-on-error: true
+  build:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - uses: actions/setup-node@v2
         with:
-          command: pnpm cypress:run:chrome
-          browser: chrome
-        env:
-          GH_PAT: ${{ secrets.GH_PAT }}
-          GH_USERNAME: ${{ secrets.GH_USERNAME }}
-          DISPLAY: :0.0
-      - name: Generate HTML report
+          node-version: 18
+          cache: "yarn"
+
+      - name: "Install the Node.js dependencies"
+        run: "yarn install"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Build the contracts and print their size"
+        run: "forge build --sizes"
+
+      - name: "Add build summary"
         run: |
-          pnpm run posttest
-      - name: Archive e2e artifacts
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # pin@v2
-        if: always()
-        with:
-          name: e2e-artifacts
-          path: |
-            /home/runner/work/tapio-eth/tapio-eth/output.html
-            /home/runner/work/tapio-eth/tapio-eth/cypress/mochawesome-report
-            /home/runner/work/tapio-eth/tapio-eth/cypress/e2e/videos
-            /home/runner/work/tapio-eth/tapio-eth/cypress/e2e/screenshots
-        continue-on-error: true
-      - name: Send Slack notification
-        uses: ravsamhq/notify-slack-action@v2
-        if: always()
-        with:
-          status: ${{ job.status }}
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }}
-  e2e-edge:
-    runs-on: ubuntu-latest
+          echo "## Build result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
+  test:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
     steps:
-      - name: Checkout nutsfinance/tapio-qa private repo
-        uses: actions/checkout@main
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - uses: actions/setup-node@v2
         with:
-          repository: nutsfinance/tapio-qa
-          token: ${{ secrets.GH_PAT }} #Please provide your Personal Access Token
+          node-version: 18
+          cache: "yarn"
 
-      - name: Install pnpm
-        uses: pnpm/action-setup@c3b53f6a16e57305370b4ae5a540c2077a1d50dd # [email protected]
+      - name: "Install the Node.js dependencies"
+        run: "yarn install"
 
-      - name: Setup node
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # [email protected]
-        with:
-          node-version: 18.16
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: Set pnpm cache directory
-        run: pnpm config set store-dir .pnpm-store
-        continue-on-error: true
+      - name: "Show the Foundry config"
+        run: "forge config"
 
-      - name: Setup cache
-        uses: actions/cache@69d9d449aced6a2ede0bc19182fadc3a0a42d2b0 # pin@v2
-        with:
-          path: |
-            .pnpm-store
-            node_modules
-            /home/runner/.cache/Cypress
-          key: ${{ runner.os }}-pnpm-v1-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-v1-
-        continue-on-error: true
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile --prefer-offline
-
-      - name: Install linux deps
-        run: |
-          sudo apt-get install --no-install-recommends -y \
-          fluxbox \
-          xvfb
+      - name: "Generate a fuzz seed that changes weekly to avoid burning through RPC allowance"
+        run: >
+          echo "FOUNDRY_FUZZ_SEED=$(
+            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))
+          )" >> $GITHUB_ENV
 
-      - name: Run xvfb and fluxbox as virtual monitors
-        run: |
-          Xvfb :0 -screen 0 1024x768x24 -listen tcp -ac &
-          fluxbox &
-        env:
-          DISPLAY: :0.0
-
-      - name: Run e2e tests (cypress-action)
-        uses: cypress-io/github-action@cdbbcd60fb5d967d7a37d8eb148add76a7ded7b6 # [email protected]
-        continue-on-error: true
-        with:
-          command: pnpm cypress:run:edge
-          browser: edge
-        env:
-          GH_PAT: ${{ secrets.GH_PAT }}
-          GH_USERNAME: ${{ secrets.GH_USERNAME }}
-          DISPLAY: :0.0
-      - name: Generate HTML report
+      - name: "Run the tests"
+        run: "forge test"
+
+      - name: "Add test summary"
         run: |
-          pnpm run posttest
-      - name: Archive e2e artifacts
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # pin@v2
-        if: always()
-        with:
-          name: e2e-artifacts
-          path: |
-            /home/runner/work/tapio-eth/tapio-eth/output.html
-            /home/runner/work/tapio-eth/tapio-eth/cypress/mochawesome-report
-            /home/runner/work/tapio-eth/tapio-eth/cypress/e2e/videos
-            /home/runner/work/tapio-eth/tapio-eth/cypress/e2e/screenshots
-        continue-on-error: true
-      - name: Send Slack notification
-        uses: ravsamhq/notify-slack-action@v2
-        if: always()
-        with:
-          status: ${{ job.status }}
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }}
+          echo "## Tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.github/workflows/mdbook.yml

@@ -0,0 +1,52 @@
+name: Deploy mdBook to Pages
+
+on:
+  push:
+    branches: ["develop"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up environment
+        uses: ./.github/setup
+
+      - name: Generate Documentation
+        run: forge doc
+
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh -s -- -y
+          rustup update
+          cargo install mdbook
+
+      - name: Build with mdBook
+        run: mdbook build docs/
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/book
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,11 +1,15 @@
-node_modules
-.env
-coverage
-coverage.json
-typechain
-typechain-types
-
-# Hardhat files
+# directories
 cache
-artifacts
+coverage
+node_modules
+out
+broadcast/**/dry-run/
 
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+package-lock.json
+pnpm-lock.yaml