Skip to content

goatfi/contracts

Repository files navigation

Goat Protocol

Tests Foundry

The Goat Protocol is a decentralized yield optimizer. It allows users, DAOs and other protocols earn the yield on their digital assets by auto compounding the rewards into more of what they've deposited.

Documentation

This respository uses Foundry as development enviroment.

To compile the source code, run forge build. The repository already has a remappings.txt file, so it should pick up the dependencies.

forge build

To run the unit and invariant tests, run forge test.

forge test

To learn bore about the Goat Protocol visit docs.goat.fi.

Repository Structure

/src contains the source code of the core contract of the Goat Protocol.

/src/interfaces/infra contains the interfaces of the Goat Protocol.

/script contains deployment and configuration scripts.

/test contains unit and invariant tests.

Licences

The primary license for the Goat Protocol is the MIT License (MIT), see LICENSE.