README
¶
Cosmos SDK
The Cosmos SDK is a framework for building blockchain applications. CometBFT (BFT Consensus) and the Cosmos SDK are written in the Go programming language. Cosmos SDK is used to build Gaia, the implementation of the Cosmos Hub.
WARNING: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.
Note: We advise to always use the latest maintained Go version for building Cosmos SDK applications.
Quick Start
To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK High-Level Intro.
If you want to get started quickly and learn how to build on top of Cosmos SDK, visit Cosmos SDK Tutorials. You can also fork the tutorial's repository to get started building your own Cosmos SDK application.
For more information, see the Cosmos SDK Documentation.
Contributing
See CONTRIBUTING.md for details on how to contribute and participate in our dev calls. If you want to follow the updates or learn more about the latest design then join our Discord.
Tools and Frameworks
The Cosmos ecosystem is vast. Awesome Cosmos is a community-curated list of notable frameworks, modules and tools.
Cosmos Hub Mainnet
The Cosmos Hub application, gaia, has its own cosmos/gaia repository. Go there to join the Cosmos Hub mainnet and more.
Inter-Blockchain Communication (IBC)
The IBC module for the Cosmos SDK has its own cosmos/ibc-go repository. Go there to build and integrate with the IBC module.
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
|
|
|
Deprecated.
|
Deprecated. |
|
testutil/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
grpc/cmtservice
Package cmtservice is a reverse proxy.
|
Package cmtservice is a reverse proxy. |
|
grpc/node
Package node is a reverse proxy.
|
Package node is a reverse proxy. |
|
grpc/reflection
Package reflection is a reverse proxy.
|
Package reflection is a reverse proxy. |
|
legacy
Package legacy contains a global amino Cdc which is deprecated but still used in several places within the SDK.
|
Package legacy contains a global amino Cdc which is deprecated but still used in several places within the SDK. |
|
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 |
|
unknownproto
unknownproto implements functionality to "type check" protobuf serialized byte sequences against an expected proto.Message to report:
|
unknownproto implements functionality to "type check" protobuf serialized byte sequences against an expected proto.Message to report: |
|
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 keyring provides common key management API.
|
Package keyring provides common key management API. |
|
keys/bcrypt
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.
|
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm. |
|
keys/internal/ecdsa
Package ECDSA implements Cosmos-SDK compatible ECDSA public and private key.
|
Package ECDSA implements Cosmos-SDK compatible ECDSA public and private key. |
|
keys/secp256r1
Package secp256r1 implements Cosmos-SDK compatible ECDSA public and private key.
|
Package secp256r1 implements Cosmos-SDK compatible ECDSA public and private key. |
|
db
module
|
|
|
depinject
module
|
|
|
errors
module
|
|
|
conv
Package conv provides internal functions for convertions and data manipulation
|
Package conv provides internal functions for convertions and data manipulation |
|
log
module
|
|
|
math
module
|
|
|
orm
module
|
|
|
The commands from the SDK are defined with `cobra` and configured with the `viper` package.
|
The commands from the SDK are defined with `cobra` and configured with the `viper` package. |
|
grpc/gogoreflection
Package gogoreflection implements gRPC reflection for gogoproto consumers the normal reflection library does not work as it points to a different singleton registry.
|
Package gogoreflection implements gRPC reflection for gogoproto consumers the normal reflection library does not work as it points to a different singleton registry. |
|
grpc/reflection/v2alpha1
Package v2alpha1 is a reverse proxy.
|
Package v2alpha1 is a reverse proxy. |
|
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. |
|
store
module
|
|
|
tools/ics23
Module
|
|
|
tests
module
|
|
|
cmdtest
Package cmdtest contains a framework for testing cobra Commands within Go unit tests.
|
Package cmdtest contains a framework for testing cobra Commands within Go unit tests. |
|
integration
Integration contains the integration test setup used for SDK modules.
|
Integration contains the integration test setup used for SDK modules. |
|
mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
network
Package network implements and exposes a fully operational in-process CometBFT test network that consists of at least one or potentially many validators.
|
Package network implements and exposes a fully operational in-process CometBFT test network that consists of at least one or potentially many validators. |
|
bech32/legacybech32
Deprecated: The module provides legacy bech32 functions which will be removed in a future release.
|
Deprecated: The module provides legacy bech32 functions which will be removed in a future release. |
|
errors
Package errors provides a shared set of errors for use in the SDK, aliases functionality in the cosmossdk.io/errors module that used to be in this package, and provides some helpers for converting errors to ABCI response code.
|
Package errors provides a shared set of errors for use in the SDK, aliases functionality in the cosmossdk.io/errors module that used to be in this package, and provides some helpers for converting errors to ABCI response code. |
|
module
Package module contains application module patterns and associated "manager" functionality.
|
Package module contains application module patterns and associated "manager" functionality. |
|
tx
Package tx is a reverse proxy.
|
Package tx is a reverse proxy. |
|
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/ante/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
auth/migrations/v2
Package v2 creates in-place store migrations for fixing tracking delegations with vesting accounts.
|
Package v2 creates in-place store migrations for fixing tracking delegations with vesting accounts. |
|
auth/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
auth/tx/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
auth/types
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages.
|
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages. |
|
auth/vesting/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
authz
Package authz is a reverse proxy.
|
Package authz is a reverse proxy. |
|
authz/codec
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgGrant or MsgExec instance so that they can be (de)serialized properly.
|
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgGrant or MsgExec instance so that they can be (de)serialized properly. |
|
authz/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
bank/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
bank/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
consensus/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
consensus/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
crisis/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
distribution/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
genutil/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
gov/codec
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgSubmitProposal instance so that they can be (de)serialized properly.
|
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgSubmitProposal instance so that they can be (de)serialized properly. |
|
gov/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
gov/types/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
gov/types/v1beta1
Package v1beta1 is a reverse proxy.
|
Package v1beta1 is a reverse proxy. |
|
group
Package group is a reverse proxy.
|
Package group is a reverse proxy. |
|
group/codec
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgSubmitProposal instance so that they can be (de)serialized properly.
|
Package codec provides a singleton instance of Amino codec that should be used to register any concrete type that can later be referenced inside a MsgSubmitProposal instance so that they can be (de)serialized properly. |
|
group/internal/math
Package math provides helper functions for doing mathematical calculations and parsing for the group module.
|
Package math provides helper functions for doing mathematical calculations and parsing for the group module. |
|
group/internal/orm
Package orm is a convenient object to data store mapper.
|
Package orm is a convenient object to data store mapper. |
|
group/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
mint/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
mint/types
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages.
|
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages. |
|
params
Package params provides a namespaced module parameter store.
|
Package params provides a namespaced module parameter store. |
|
params/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
params/types/proposal
Package proposal is a reverse proxy.
|
Package proposal is a reverse proxy. |
|
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/migrations/v1
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/slashing/types/keys.go
|
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/slashing/types/keys.go |
|
slashing/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
slashing/types
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages.
|
NOTE: Usage of x/params to manage parameters is deprecated in favor of x/gov controlled execution of MsgUpdateParams messages. |
|
staking/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
staking/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
circuit
Module
|
|
|
feegrant
Module
|
|
|
nft
Module
|
Click to show internal directories.
Click to hide internal directories.