Eonian Farm

Decentralized savings account protocol and subgraph. More info in docs.

Development

This mono-repository contains protocol contracts and dApp code, as well as all related packages.

For a list of known development issues related to Lerna monorepo, see development.md.

Structure

• packages/contracts - Protocol contracts.
• packages/subgraph - GraphQl API for protocol.
• packages/eslint-config - Shared JS code linting config.

Requirements

Install required tools for development

• Foundry - The testing framework for solidity
• NodeJS - Execution environment for JS

First Start Guide

1. Install packages from npm and forge

yarn

2. Open the package which you want to start

   • cd packages/contract - Open contracts package

3. Follow the guide of the package which you want to start

   • contracts/readme.md

Commands

• yarn start - start pre-prod environment
• yarn dev - start dev environment
• yarn test - run tests in packages
• yarn build:contracts - Build only contracts
• yarn test:contracts - Test only contracts
• dev:contracts - Set up a development environment for contracts. Watch file changes and rerun tests.

Deployment

The deployment process focused on implementing GitOps practices. Basically, it means all master (main) builds go to production directly.