Smart Contracts

Explore the architecture of the Kolektivo Framework's smart contracts

Monetary System

Governance System

Please note that this experimental software is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any loss incurred through any use of this codebase.

Installation

Kolektivo's smart contracts are developed using the foundry toolchain.

However, the project also uses hardhat tasks and also depends on hardhat.

1. Clone the repository

2. cd into the repository

3. Run forge install to install contract dependencies

4. Run yarn to install hardhat dependencies

5. (Optional) Run source dev.env to setup environment variables

Usage

Common tasks are executed through a Makefile.

The Makefile supports a help command, i.e. make help.

$ make help
> build                    Build project
> clean                    Remove build artifacts
> test                     Run whole testsuite
> update                   Update dependencies
> [...]

Simulation

This project includes a framework to simulate the contracts on a local node.

To start the simulation, first follow each step described in Installation.

Afterwards, start an anvil node in a second terminal session.

To start the simulation, run npx hardhat simulation.

Dependencies

• byterocket's solrocket
• Rari Capital's solmate