crescent

module
v1.0.0-rc3 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2022 License: Apache-2.0

README

codecov PkgGoDev

Crescent

The Crescent containing below Cosmos SDK modules

  • liquidity
  • liquidstaking
  • farming
  • mint (constant inflation)
  • claim
  • see the main branch for the latest
  • see releases for the latest release

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.

This project uses customized cosmos-sdk, Please check the difference on here.

Requirement Notes
Go version Go1.16 or higher
Cosmos SDK (custom) v1.0.2-sdk-0.44.5

Installation

# Use git to clone the source code and install `crescentd`
git clone https://github.com/crescent-network/crescent.git
cd crescent
make install

Getting Started

To get started to the project, visit the TECHNICAL-SETUP.md docs.

Documentation

The Crescent documentation is available in docs folder and technical specification is available in x/{module}/spec/ folder.

These are some of the documents that help you to quickly get you on board with the farming module.

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 crescent. Thank you to all those who have contributed to crescent!

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
crescentd command
cremath module
third_party
x
claim/types
Package types is a reverse proxy.
Package types is a reverse proxy.
farming/types
Package types is a reverse proxy.
Package types is a reverse proxy.
liquidity/types
Package types is a reverse proxy.
Package types is a reverse proxy.
liquidstaking/types
Package types is a reverse proxy.
Package types is a reverse proxy.
mint/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