farming

module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2021 License: Apache-2.0

README

codecov PkgGoDev

Farming Module

A farming module is a Cosmos SDK module that implements farming functionality, which provides farming rewards to participants called farmers. One use case is to use this module to provide incentives for liquidity pool investors for their pool participation.

Farming module v1 is in active development - see "master" branch for the v1 mainnet version

Installation

Requirements

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.2 or higher
Get Farming Module source code
git clone https://github.com/tendermint/farming.git
cd farming
make install

Development

Test
make test-all
Setup local testnet using script
# This script bootstraps a single local testnet.
# Note that config, data, and keys are created in the ./data/localnet folder and
# RPC, GRPC, and REST ports are all open.
$ make localnet

Resources

Directories

Path Synopsis
app
params
Package params defines the simulation parameters in the simapp.
Package params defines the simulation parameters in the simapp.
client
docs/statik
Package statik contains static assets.
Package statik contains static assets.
cmd
farmingd command
third_party
x
farming/types
Package types is a reverse proxy.
Package types is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL