README
¶
Cosmos SDK
The Cosmos-SDK is a framework for building blockchain applications in Golang.
It is being used to build Gaia, the first implementation of the Cosmos Hub.
WARNING: The SDK has mostly stabilized, but we are still making some breaking changes.
Note: Requires Go 1.14+
Quick Start
To learn how the SDK works from a high-level perspective, go to the SDK Intro.
If you want to get started quickly and learn how to build on top of the SDK, please follow the SDK Application Tutorial. You can also fork the tutorial's repository to get started building your own Cosmos SDK application.
For more, please go to the Cosmos SDK Docs.
Cosmos Hub Mainnet
The Cosmos Hub application, gaia, has moved to its own repository. Go there to join the Cosmos Hub mainnet and more.
Scaffolding
If you are starting a new app or a new module we provide a scaffolding tool to help you get started and speed up development. If you have any questions or find a bug, feel free to open an issue in the repo.
Disambiguation
This Cosmos-SDK project is not related to the React-Cosmos project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
lcd/statik
Package statik contains static assets.
|
Package statik contains static assets. |
|
types
Package types defines a custom wrapper for google.protobuf.Any which supports cached values as well as InterfaceRegistry which keeps track of types which can be used with Any for both security and introspection
|
Package types defines a custom wrapper for google.protobuf.Any which supports cached values as well as InterfaceRegistry which keeps track of types which can be used with Any for both security and introspection |
|
container
module
|
|
|
cosmovisor
module
|
|
|
hd
Package hd provides support for hierarchical deterministic wallets generation and derivation.
|
Package hd provides support for hierarchical deterministic wallets generation and derivation. |
|
keyring
Package keys provides common key management API.
|
Package keys provides common key management API. |
|
db
module
|
|
|
depinject
module
|
|
|
errors
module
|
|
|
log
module
|
|
|
math
module
|
|
|
orm
module
|
|
|
mock
nolint
|
nolint |
|
params
Package params defines the simulation parameters in the simapp.
|
Package params defines the simulation parameters in the simapp. |
|
Package std defines all the common and standard inter-module Cosmos SDK types and definitions modules and applications can depend on.
|
Package std defines all the common and standard inter-module Cosmos SDK types and definitions modules and applications can depend on. |
|
tools/ics23
Module
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
errors
Package errors implements custom error interfaces for cosmos-sdk.
|
Package errors implements custom error interfaces for cosmos-sdk. |
|
module
Package module contains application module patterns and associated "manager" functionality.
|
Package module contains application module patterns and associated "manager" functionality. |
|
rest
Package rest provides HTTP types and primitives for REST requests validation and responses handling.
|
Package rest provides HTTP types and primitives for REST requests validation and responses handling. |
|
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time.
|
Package version is a convenience utility that provides SDK consumers with a ready-to-use version command that produces apps versioning information based on flags passed at compile time. |
|
x
|
|
|
auth/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
auth/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
bank/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
distribution
Package distribution implements a Cosmos SDK module, that provides an implementation of the F1 fee distribution algorithm.
|
Package distribution implements a Cosmos SDK module, that provides an implementation of the F1 fee distribution algorithm. |
|
distribution/client/cli
nolint
|
nolint |
|
distribution/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
distribution/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
distribution/types
nolint
|
nolint |
|
evidence
Package evidence implements a Cosmos SDK module, per ADR 009, that allows for the submission and handling of arbitrary evidence of misbehavior.
|
Package evidence implements a Cosmos SDK module, per ADR 009, that allows for the submission and handling of arbitrary evidence of misbehavior. |
|
evidence/types
DONTCOVER
|
DONTCOVER |
|
genaccounts
Package genaccounts is now deprecated.
|
Package genaccounts is now deprecated. |
|
genaccounts/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
genaccounts/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
genutil
Package genutil contains a variety of genesis utility functionality for usage within a blockchain application.
|
Package genutil contains a variety of genesis utility functionality for usage within a blockchain application. |
|
gov/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
gov/legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
ibc/02-client
Package client implements the ICS 02 - Client Semantics specification https://github.com/cosmos/ics/tree/master/spec/ics-002-client-semantics.
|
Package client implements the ICS 02 - Client Semantics specification https://github.com/cosmos/ics/tree/master/spec/ics-002-client-semantics. |
|
ibc/07-tendermint
Package tendermint implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Tendermint consensus light client.
|
Package tendermint implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Tendermint consensus light client. |
|
ibc/09-localhost
Package localhost implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the loop-back client.
|
Package localhost implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the loop-back client. |
|
params
Package params provides a namespaced module parameter store.
|
Package params provides a namespaced module parameter store. |
|
params/types
To prevent namespace collision between consumer modules, we define a type Subspace.
|
To prevent namespace collision between consumer modules, we define a type Subspace. |
|
simulation
Package simulation implements a full fledged Cosmos SDK application used for executing simulation test suites.
|
Package simulation implements a full fledged Cosmos SDK application used for executing simulation test suites. |
|
slashing/types
noalias noalias DONTCOVER
|
noalias noalias DONTCOVER |
|
staking/legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
staking/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
staking/legacy/v0_38
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
upgrade
Package upgrade provides a Cosmos SDK module that can be used for smoothly upgrading a live Cosmos chain to a new software version.
|
Package upgrade provides a Cosmos SDK module that can be used for smoothly upgrading a live Cosmos chain to a new software version. |
|
circuit
Module
|
|
|
feegrant
Module
|
|
|
group
Module
|
|
|
nft
Module
|
Click to show internal directories.
Click to hide internal directories.