Loyal 1 entwicklungsumgebung einrichten

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: test
+name: Solidity CI
 
 on:
   push:
@@ -11,9 +11,6 @@ env:
 
 jobs:
   check:
-    strategy:
-      fail-fast: true
-
     name: Foundry project
     runs-on: ubuntu-latest
     steps:
@@ -29,10 +26,35 @@ jobs:
       - name: Run Forge build
         run: |
           forge --version
-          forge build
+          forge build --sizes
         id: build
 
       - name: Run Forge tests
         run: |
           forge test -vvv
         id: test
+
+      - name: Run Forge coverage
+        run: |
+          forge coverage --report lcov
+        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
+
+      - name: Run Slither
+        uses: crytic/[email protected]
+        id: slither
+        continue-on-error: true
+        with:
+          sarif: results.sarif
+          fail-on: none
+
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: ${{ steps.slither.outputs.sarif }}

README.md

@@ -1,16 +1,31 @@
-# Pancake v4 hooks template
+# Liquidity Pool Credit System
 
-[`Use this Template`](https://github.com/new?owner=pancakeswap&template_name=pancake-v4-hooks-template&template_owner=pancakeswap)
+## Overview
 
-## Prerequisite
+The Liquidity Pool Credit System is an innovative DeFi project that aims to incentivize long-term liquidity provision in decentralized exchanges. By leveraging the Brevis ZK-Coprocessor, we've created a secure and transparent system that rewards consistent liquidity providers with credit points, which can be used for various benefits within the ecosystem.
 
-1. Install foundry, see https://book.getfoundry.sh/getting-started/installation
+## Features
 
-## Running test
+- **Credit Point Accumulation**: Liquidity providers earn credit points based on the duration and consistency of their liquidity provision.
+- **Reward Tiers**: Different levels of rewards are unlocked as users accumulate more credit points.
+- **Reduced Transaction Fees**: Users can spend their credit points to enjoy lower transaction fees on the platform.
+- **Early Access**: High-credit users get priority access to new liquidity pools.
+- **Enhanced Governance Rights**: Credit points translate to increased voting power in platform governance decisions.
+- **Secure Tracking**: Utilizes Brevis ZK-Coprocessor for transparent and tamper-proof credit point calculation and management.
 
-1. Install dependencies with `forge install`
-2. Run test with `forge test`
+## Technical Stack
 
-## Description
+- Solidity Smart Contracts
+- Brevis ZK-Coprocessor
+- Foundry for testing and deployment
+- React.js for the frontend (optional)
 
-This repository contains example counter hook for both CL and Bin pool types. 
+## Getting Started
+
+### Prerequisites
+
+- Node.js v14+
+- Foundry
+
+
+# In dieser Branch haben wir die Basis für die Credit System aufgesetzt.