Contributing to OptriSpace Smart Contracts

The development branch is master.
This is the default branch that all Pull Requests (PR) should be made against.

Requirements:

Node.js version 16 or 17
Foundry
Slither

Developing locally

Please follow instructions below to install Smart Contracts locally.

Fork this repository to your own GitHub account
Clone it to your local device
Update submodules:
```
git submodule update --init --recursive
```
Create a new branch:
```
git checkout -b YOUR_BRANCH_NAME
```
Install the dependencies with:
```
make setup
```
Copy the environment variables:
```
cp .env.example .env
```
In a new terminal session start local blockchain node:
```
make run_node
```
Deploy contracts to local blockchain node:
```
make deploy_hardhat
```
Take a look into previous command output to configure your frontend repo.

Running tests

make test

Linting

To check the formatting of your code:

make lint

If you get errors, you can fix them with:

make fix