README
¶
Farming Module
The farming module is a Cosmos SDK module that implements farming functionality, which provides farming rewards to participants called farmers. A primary use case is to use this module to provide incentives for liquidity pool investors for their pool participation.
Dependencies
If you haven't already, install Golang by following the official docs. Make sure that your GOPATH and GOBIN environment variables are properly set up.
| Requirement | Notes |
|---|---|
| Go version | Go1.16 or higher |
| Cosmos SDK | v0.44.3 or higher |
Installation
# Use git to clone farming module source code and install `farmingd`
git clone https://github.com/tendermint/farming.git
cd farming
make install
Getting Started
To get started to the project, visit the TECHNICAL-SETUP.md docs.
Documentation
The farming module documentation is available in docs folder and technical specification is available in specs folder.
These are some of the documents that help you to quickly get you on board with the farming module.
- How to bootstrap a local network with farming module
- How to use Command Line Interfaces
- How to use gRPC-gateway REST Routes
- Demo for how to budget and farming modules
Contributing
We welcome contributions from everyone. The main branch contains the development version of the code. You can branch of from main and create a pull request, or maintain your own fork and submit a cross-repository pull request. If you're not sure where to start check out CONTRIBUTING.md for our guidelines & policies for how we develop farming module. Thank you to all those who have contributed to farming module!
Directories
¶
| Path | Synopsis |
|---|---|
|
params
Package params defines the simulation parameters in the simapp.
|
Package params defines the simulation parameters in the simapp. |
|
client
|
|
|
cmd
|
|
|
third_party
|
|
|
x
|
|
|
farming/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |