LUM-1078: Add Github Actions for contracts #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

shyam-patel-kira merged 35 commits into feat/stakeTokens from feat/github-actions

Jan 6, 2025

.gas-snapshot

-Original file line number
+Diff line change
@@ -0,0 +1,21 @@
+    JobsManagerTest:testCreateJob() (gas: 197562)
+    JobsManagerTest:testCreateMultipleJobs() (gas: 789598)
+    JobsManagerTest:testGetActiveJobs() (gas: 484465)
+    JobsManagerTest:testInitialization() (gas: 20413)
+    JobsManagerTest:testJobDetailsRetrieval() (gas: 195057)
+    JobsManagerTest:testNonExistentJobDetails() (gas: 14082)
+    JobsManagerTest:testUpdateJobStatus() (gas: 401370)
+    JobsManagerTest:testUpdateJobStatusInvalidTransition() (gas: 324846)
+    JobsManagerTest:testUpdateJobStatusUnauthorized() (gas: 191908)
+    JobsManagerTest:testUpdateNonExistentJob() (gas: 14142)
+    StakeManagerTest:testInitialization() (gas: 17084)
+    StakeManagerTest:testStake() (gas: 147646)
+    StakeManagerTest:testStakeInsufficientAmount() (gas: 22857)
+    StakeManagerTest:testUnstake() (gas: 191933)
+    StakeManagerTest:testWithdraw() (gas: 163469)
+    StakeManagerTest:testWithdrawBeforeUnlock() (gas: 190212)
+    StateManagerTest:testBufferState() (gas: 9526)
+    StateManagerTest:testCommitState() (gas: 9998)
+    StateManagerTest:testNonBufferState() (gas: 9894)
+    StateManagerTest:testProposeState() (gas: 10306)
+    StateManagerTest:testRevealState() (gas: 10203)

.github/codecov.yml

-Original file line number
+Diff line change
@@ -0,0 +1,32 @@
+    codecov:
+      require_ci_to_pass: yes
+      notify:
+        wait_for_ci: yes
+    coverage:
+      precision: 2
+      round: down
+      range: "70...100"
+      status:
+        project:
+          default:
+            target: 80%    # minimum coverage ratio
+            threshold: 1%  # allow coverage to drop by 1% and still succeed
+        patch:
+          default:
+            target: 80%
+            threshold: 1%
+        changes: no
+    parsers:
+      gcov:
+        branch_detection:
+          conditional: yes
+          loop: yes
+          method: no
+          macro: no
+    comment:
+      layout: "reach,diff,flags,files,footer"
+      behavior: default
+      require_changes: no

.github/workflows/test.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,15 +1,28 @@
  
    name: test

    name: Lumino Protocol CI/CD

    on: workflow_dispatch

    on:

      pull_request:

        branches:

          - "**"

          - '!main'

      workflow_dispatch:

        inputs:

          environment:

            description: 'Environment to deploy to'

            required: true

            default: 'testnet'

            type: choice

            options:

              - testnet

    env:

      FOUNDRY_PROFILE: ci

      PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}

      ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}

      TESTNET_RPC_URL: ${{ secrets.TESTNET_RPC_URL }}

    jobs:

      check:

        strategy:

          fail-fast: true

      unit-tests:

        name: Foundry project

        runs-on: ubuntu-latest

        steps:

    @@ -22,13 +35,134 @@ jobs:
  
            with:

              version: nightly

          - name: Run Forge build

          - name: Install Dependencies

            run: |

              forge --version

              forge build --sizes

              forge install OpenZeppelin/openzeppelin-contracts --no-commit

              forge install OpenZeppelin/openzeppelin-contracts-upgradeable --no-commit

          - name: Check contract sizes

            run: forge build --sizes

            id: build

          - name: Run Forge tests

          - name: Check gas snapshots

            run: |

              forge test -vvv

              forge snapshot --check || (

                echo "Gas snapshot check failed. Generating new snapshot for reference..."

                forge snapshot

                echo "Please commit the updated .gas-snapshot file"

              )

            id: snapshot

          - name: Run tests

            run: forge test -vvv

            id: test

          - name: Run coverage

            run: forge coverage --report lcov --report summary

              --report debug

              --optimize

              --optimizer-runs 200

              --no-auto-detect  

            id: coverage

          # - name: Upload coverage to Codecov

          #   uses: codecov/codecov-action@v3

          #   with:

          #     token: ${{ secrets.CODECOV_TOKEN }}

          #     files: ./lcov.info

          #     fail_ci_if_error: true

          #     verbose: true

      slither:

        name: Slither Analysis

        runs-on: ubuntu-latest

        steps:

          - uses: actions/checkout@v4

            with:

              submodules: recursive

          - name: Install Foundry

            uses: foundry-rs/foundry-toolchain@v1

            with:

              version: nightly

          - name: Install Python

            uses: actions/setup-python@v4

            with:

              python-version: '3.10'

          - name: Install Slither

            run: |

              python -m pip install --upgrade pip

              pip3 install slither-analyzer

          - name: Run Slither

            run: |

              forge build

              slither . --sarif slither-results.sarif || true

          # - name: Upload SARIF file

          #   uses: github/codeql-action/upload-sarif@v2

          #   with:

          #     sarif_file: slither-results.sarif

          #     token: ${{ secrets.GITHUB_TOKEN }}

      lint:

        name: Format Check

        runs-on: ubuntu-latest

        steps:

          - uses: actions/checkout@v4

            with:

              submodules: recursive

          - name: Install Foundry

            uses: foundry-rs/foundry-toolchain@v1

            with:

              version: nightly

          - name: Install Node.js

            uses: actions/setup-node@v3

            with:

              node-version: 18.x

          - name: Install Prettier and Solidity Plugin

            run: |

              npm install --save-dev prettier prettier-plugin-solidity

          - name: Check formatting

            run: npx prettier --check "src/**/*.sol" "test/**/*.sol"

      deploy-testnet:

        name: Deploy to Testnet

        needs: [unit-tests, slither, lint]

        if: |

          (github.ref == 'refs/heads/develop' && github.event_name == 'push') ||

          (github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'testnet')

        runs-on: ubuntu-latest

        environment: testnet

        steps:

          - uses: actions/checkout@v4

            with:

              submodules: recursive

          - name: Install Foundry

            uses: foundry-rs/foundry-toolchain@v1

            with:

              version: nightly

          - name: Deploy to Testnet

            env:

              RPC_URL: ${{ env.TESTNET_RPC_URL }}

            run: |

              forge script script/DeployUpgradeableLuminoProtocol.s.sol:DeployUpgradeableLuminoProtocol \

                --rpc-url $RPC_URL \

                --broadcast \

                --verify \

                -vvvv

          - name: Save deployment artifacts

            uses: actions/upload-artifact@v3

            with:

              name: testnet-deployment

              path: broadcast/

              if-no-files-found: error

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,11 @@ docs/ @@
     .env
     .vscode
-    /lib/*
     .idea
+    slither-results.sarif
+    node_modules
+    lcov.info
     repomix-output.txt

.gitmodules

-Original file line number
+Diff line change
@@ -1,9 +1,9 @@
-    [submodule "contracts/lib/forge-std"]
-    	path = contracts/lib/forge-std
+    [submodule "lib/forge-std"]
+    	path = lib/forge-std
     	url = https://github.com/foundry-rs/forge-std
-    [submodule "lib/openzeppelin-contracts"]
-    	path = lib/openzeppelin-contracts
-    	url = https://github.com/OpenZeppelin/openzeppelin-contracts
     [submodule "lib/openzeppelin-contracts-upgradeable"]
     	path = lib/openzeppelin-contracts-upgradeable
     	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
+    [submodule "lib/openzeppelin-contracts"]
+    	path = lib/openzeppelin-contracts
+    	url = https://github.com/OpenZeppelin/openzeppelin-contracts

.prettierrc

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    {
+        "overrides": [
+          {
+            "files": "*.sol",
+            "options": {
+              "printWidth": 100,
+              "tabWidth": 4,
+              "useTabs": false,
+              "singleQuote": false,
+              "bracketSpacing": false
+            }
+          }
+        ],
+        "printWidth": 100,
+        "tabWidth": 2,
+        "useTabs": false,
+        "semi": true,
+        "singleQuote": false,
+        "trailingComma": "es5"
+    }

foundry.toml

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,17 @@ src = "src" @@
     out = "out"
     libs = ["lib"]
+    [profile.default.fuzz]
+    runs = 1000
+    [profile.ci]
+    fuzz_runs = 10000
+    verbosity = 4
+    [profile.gas]
+    gas_reports = ["*"]
     [etherscan]
     holesky = { key = "<your-etherscan-api-key>", url = "https://api-holesky.etherscan.io/api" }
@@ Expand Down @@

lib/forge-std

Submodule forge-std added at b93cf4

lib/forge-std/.gitattributes

This file was deleted.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LUM-1078: Add Github Actions for contracts #21

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!