Chore/level beyond to alpha

.github/workflows/hardhat.yml

@@ -1,44 +1,37 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Hardhat full test suite CI
+name: Hardhat
 
 on:
- push:
-  branches:
-   - "**" # matches every branch
-
+  push:
+    paths:
+      - "packages/contracts/**"
+      - "package.json"
+      - ".github/workflows/hardhat.yml"
 
 defaults:
   run:
     working-directory: ./packages/contracts
 
-
 jobs:
- test:
-  runs-on: ubuntu-latest
-  env:
-    ALCHEMY: ${{ secrets.ALCHEMY }}
-    TEST_MNEMONIC: ${{ secrets.TEST_MNEMONIC }}
-
-
-  steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: 16
-
-    - name: Node module cache
-      uses: actions/cache@v2
-      id: node-cache
-      with:
-        path: "**/node_modules"
-        key: npm-v2-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: npm-v2-
-    - name: Install dependencies
-      run: npm install
-      if: steps.node-cache.outputs.cache-hit != 'true'
-
-    - run: npm run compile
-    - run: npx hardhat test ./test/*.ts
+  test:
+    runs-on: ubuntu-latest
+    env:
+      ALCHEMY: ${{ secrets.ALCHEMY }}
+      TEST_MNEMONIC: ${{ secrets.TEST_MNEMONIC }}
+      ARBITRUM: ${{ secrets.ARBITRUM }}
+      ARBITRUM_GOERLI: ${{ secrets.ARBITRUM_GOERLI }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "yarn"
+
+      - name: Install modules
+        run: yarn
+
+      - name: Compile
+        run: yarn workspace contracts compile
+
+      - name: Test
+        run: yarn workspace contracts test ./test/*.ts

.gitignore

@@ -43,8 +43,8 @@ Thumbs.db
 # Ignore built ts files
 dist/**/*
 
-# ignore yarn.lock
-yarn.lock
+# ignore package-lock
+package-lock.json
 
 build/
 

README.md

@@ -1,4 +1,3 @@
-<!-- PROJECT LOGO -->
 <br />
 <p align="center">
   <a href="https://github.com/github_username/repo_name">
@@ -13,115 +12,88 @@
   </p>
 </p>
 
-<!-- GETTING STARTED -->
-
 ## Getting Started
 
 To get a local copy up and running follow these simple steps.
 
 ### Prerequisites
 
-- npm
+At Rysk, we use Yarn for package management with Yarn workspaces. To get started with Yarn if you haven't installed it yet, you can run:
 
 ```sh
-npm install npm@latest -g
+npm install --global yarn
 ```
 
 ### Installation
 
 1. Clone the repo
 
-```sh
-git clone
-```
+    ```sh
+    git clone
+    ```
 
-2. Install NPM packages
+2. Install packages
 
-```sh
-npm install
-```
-
-or
-
-```sh
-yarn
-```
+    ```sh
+    yarn
+    ```
 
 3. Add environment variables
 
-Create free API keys for alchemy and infura
-
-a. Create /packages/contracts/.env with:
-
-```sh
-ALCHEMY_KEY=<your-alchemy-key>
-```
-
-b. Create /packages/front-end/.env with:
-
-```sh
-REACT_APP_INFURA_KEY=<your-infura-key>
-```
-
-4. Start a hardhat node as mainnet fork
+    You will need to create free API keys for Alchemy and Infura. You can then:
 
-```sh
-cd packages/contracts
-npm run mainnet-fork
-```
+    - Create `/packages/contracts/.env`
+    - Add `ALCHEMY=<your-alchemy-key>`
+    - Create `/packages/front-end/.env`
+    - Add `REACT_APP_INFURA_KEY=<your-infura-key>`
 
-From a new terminal window
+4. Compile contracts
 
-5. Compile contracts
+    ```sh
+    yarn workspace contracts compile
+    ```
 
-```sh
-cd packages/contracts
-npm run compile
-```
+5. Deploy contracts and update ABIs + address
 
-6. Deploy contracts and update ABIs + address
+    ```sh
+    yarn workspace contracts deploy:localhost
+    ```
 
-```sh
-cd packages/contracts
-npm run deploy:localhost
-```
-
-7. Start the React app
+6. Start the front end
 
-```sh
-cd packages/front-end
-npm run start
-```
+    ```sh
+    yarn workspace front-end start
+    ```
 
-<!-- USAGE EXAMPLES -->
+## Usage examples
 
-## Testing Contracts
+### Testing Contracts
 
-Complete steps 1 to 3 from above:
+Complete steps 1 to 3 from the installation section and then:
 
-Compile all files
+1. Compile all files
 
-```sh
-npm run compile
-```
+    ```sh
+    yarn workspace contracts compile
+    ```
 
-Run all tests
+2. Run all tests
 
-```sh
-npx hardhat test
-```
+    ```sh
+    yarn workspace contracts test
+    ```
 
-To run a specific test suite, e.g. LiquidityPool.ts
+    To run a specific test suite, e.g. `LiquidityPool.ts`
 
-```sh
-npx hardhat test test/LiquidityPool.ts
-```
+    ```sh
+    yarn workspace contracts test test/LiquidityPool.ts
+    ```
 
-Run test coverage
+    Run test coverage
 
-```sh
-npm run test-coverage
-```
+    ```sh
+    yarn workspace contracts test-coverage
+    ```
 
 Run foundry fuzzing
 
@@ -130,12 +102,13 @@ Run foundry fuzzing
 
 ## Contract Architecture
 
-![Rysk Architecture](./images/RyskArchitecture.png) ![Diagram C](./images/DiagramC.png)
+![Rysk Architecture](./images/RyskArchitecture.png)
+![Diagram C](./images/DiagramC.png)
 ![Diagram F](./images/DiagramF.png)
 
 ## Contract layout
 
-```
+```bash
 contracts
 ├── hedging
 │   ├── GMXHedgingReactor.sol