README

Cosmos SDK

banner

version CircleCI codecov Go Report Card license LoC API Reference riot.im

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.13+

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.

Expand ▾ Collapse ▴

Directories

Path Synopsis
lcd
lcd/statik
Package statik contains static assets.
Package statik contains static assets.
rpc
cosmovisor module
keys/hd
Package hd provides basic functionality Hierarchical Deterministic Wallets.
Package hd provides basic functionality Hierarchical Deterministic Wallets.
mock
nolint
nolint
params
Package params defines the simulation parameters in the simapp.
Package params defines the simulation parameters in the simapp.
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
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/ante ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/keeper ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/types
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/ante ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/keeper ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/types
auth/legacy/v0_34
DONTCOVER nolint
DONTCOVER nolint
auth/legacy/v0_36
DONTCOVER nolint DONTCOVER nolint
DONTCOVER nolint DONTCOVER nolint
auth/types
nolint noalias
nolint noalias
auth/vesting
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/vesting/types/
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/vesting/types/
auth/vesting/types
nolint noalias
nolint noalias
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.
nolint
distribution/legacy/v0_34
DONTCOVER nolint
DONTCOVER nolint
distribution/legacy/v0_36
DONTCOVER nolint
DONTCOVER 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/internal/types
DONTCOVER Common testing types and utility functions and methods to be used in unit and integration testing of the evidence module.
DONTCOVER Common testing types and utility functions and methods to be used in unit and integration testing of the evidence module.
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
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/genutil/types Package genutil contains a variety of genesis utility functionality for usage within a blockchain application.
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/genutil/types Package genutil contains a variety of genesis utility functionality for usage within a blockchain application.
gov
nolint DONTCOVER
nolint DONTCOVER
gov/keeper
nolint
nolint
gov/legacy/v0_34
DONTCOVER nolint
DONTCOVER nolint
gov/legacy/v0_36
DONTCOVER nolint
DONTCOVER nolint
mock
Package mock provides utility methods to ease writing tests.
Package mock provides utility methods to ease writing tests.
params
Package params provides a namespaced module parameter store.
Package params provides a namespaced module parameter store.
params/subspace
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/internal/keeper
nolint nolint:deadcode,unused DONTCOVER noalias
nolint nolint:deadcode,unused DONTCOVER noalias
slashing/internal/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
supply
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/supply/internal/keeper ALIASGEN: github.com/cosmos/cosmos-sdk/x/supply/internal/types
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/supply/internal/keeper ALIASGEN: github.com/cosmos/cosmos-sdk/x/supply/internal/types
supply/legacy/v0_36
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.