diff --git a/.github/workflows/core.yaml b/.github/workflows/core.yaml index 7addece4a..f6113780d 100644 --- a/.github/workflows/core.yaml +++ b/.github/workflows/core.yaml @@ -58,6 +58,40 @@ jobs: core/typechain/ if-no-files-found: error + core-slither: + needs: [core-build] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Set up Node + uses: actions/setup-node@v4 + with: + node-version-file: "core/.nvmrc" + cache: "yarn" + cache-dependency-path: "core/yarn.lock" + + - name: Install Dependencies + run: yarn install --prefer-offline --frozen-lockfile + + - uses: actions/setup-python@v4 + with: + python-version: 3.11 + + - name: Install Slither + env: + SLITHER_VERSION: 0.9.6 + run: pip3 install slither-analyzer==$SLITHER_VERSION + + - name: Download Build Artifacts + uses: actions/download-artifact@v3 + with: + name: core-build + path: core/ + + - name: Run Slither + run: slither --hardhat-ignore-compile . + core-test: needs: [core-build] runs-on: ubuntu-latest diff --git a/README.md b/README.md index de2f62834..df7d13b8b 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,24 @@ pre-commit run --all-files # Execute hooks for specific files (e.g. Acre.sol): pre-commit run --files ./core/contracts/Acre.sol ``` + +### Slither + +[Slither](https://github.com/crytic/slither) is a static analysis framework used +for Solidity contracts verification. + +#### Install + +To install Slither execute: + +```sh +pip3 install slither-analyzer +``` + +#### Usage + +To run Slither execute: + +```sh +slither . +``` diff --git a/core/slither.config.json b/core/slither.config.json index 684a9b7cb..fed211ee1 100644 --- a/core/slither.config.json +++ b/core/slither.config.json @@ -1,4 +1,5 @@ { + "detectors_to_exclude": "assembly,naming-convention,timestamp,pragma,solc-version", "hardhat_artifacts_directory": "build", "filter_paths": "node_modules/.*" } diff --git a/dapp/README.md b/dapp/README.md index 1f77042dd..882e0e8fa 100644 --- a/dapp/README.md +++ b/dapp/README.md @@ -1,10 +1,26 @@ # Acre dApp -## Installation +The application is compatible with Ledger Live and allows people to earn yield on their Bitcoin via yield farming on Ethereum. -1. Install dependencies and start the app. - ```bash +This project was bootstrapped with [Create Vite](https://github.com/vitejs/vite/tree/main/packages/create-vite). + +## Quickstart + +Install dependencies and start the app. + + ```bash yarn install yarn start - ``` -2. Open [http://localhost:5173](http://localhost:5173) to view it in the browser. +``` + +Once the build is running, you can import the manifest on desktop: + +1. [Install Ledger Live Desktop](https://www.ledger.com/ledger-live) +2. Enable the Developer mode + + Go to the **Settings -> About** section, and click 10 times on the Ledger Live version. A new Developer section appears in the settings menu. Turn on **Enable platform dev** tools to use the developer tools window to inspect your app. +3. Add your manifest + + Click on Browse next to **Add a local app** and select the manifest file. The app is now visible in the menu. + +If you have any problems, take a look [here](https://developers.ledger.com/docs/non-dapp/tutorial/3-import/#desktop).