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.15+
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.
Starport
If you are starting a new app or a new module you can use Starport 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 |
|---|---|
|
grpc/reflection
Package reflection is a reverse proxy.
|
Package reflection is a reverse proxy. |
|
grpc/tmservice
Package tmservice is a reverse proxy.
|
Package tmservice 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: a) Unknown fields in the stream -- this is indicative of mismatched services, perhaps a malicious actor b) Mismatched wire types for a field -- this is indicative of mismatched services Its API signature is similar to proto.Unmarshal([]byte, proto.Message) in the strict case if err := RejectUnknownFieldsStrict(protoBlob, protoMessage, false); err != nil { // Handle the error.
|
unknownproto implements functionality to "type check" protobuf serialized byte sequences against an expected proto.Message to report: a) Unknown fields in the stream -- this is indicative of mismatched services, perhaps a malicious actor b) Mismatched wire types for a field -- this is indicative of mismatched services Its API signature is similar to proto.Unmarshal([]byte, proto.Message) in the strict case if err := RejectUnknownFieldsStrict(protoBlob, protoMessage, false); err != nil { // Handle the error. |
|
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. |
|
keys/secp256k1/internal/secp256k1
nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library.
|
nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library. |
|
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. |
|
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. |
|
tests
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
network
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators.
|
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators. |
|
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. |
|
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/legacy/v034
DONTCOVER nolint
|
DONTCOVER nolint |
|
auth/legacy/v036
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
auth/tx
Package tx 's xauthclient.go file is copy-pasted from https://github.com/ivansukach/modified-cosmos-sdk/blob/v0.41.3/x/auth/client/query.go It is duplicated as to not introduce any breaking change in 0.41.4, see PR: https://github.com/ivansukach/modified-cosmos-sdk/pull/8732#discussion_r584746947
|
Package tx 's xauthclient.go file is copy-pasted from https://github.com/ivansukach/modified-cosmos-sdk/blob/v0.41.3/x/auth/client/query.go It is duplicated as to not introduce any breaking change in 0.41.4, see PR: https://github.com/ivansukach/modified-cosmos-sdk/pull/8732#discussion_r584746947 |
|
auth/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
bank/legacy/v036
DONTCOVER nolint
|
DONTCOVER nolint |
|
bank/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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/legacy/v034
DONTCOVER nolint
|
DONTCOVER nolint |
|
distribution/legacy/v036
DONTCOVER nolint
|
DONTCOVER nolint |
|
distribution/types
nolint Package types is a reverse proxy.
|
nolint Package types is a reverse proxy. |
|
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 Package types is a reverse proxy.
|
DONTCOVER Package types is a reverse proxy. |
|
genaccounts
Package genaccounts is now deprecated.
|
Package genaccounts is now deprecated. |
|
genaccounts/legacy/v034
DONTCOVER nolint
|
DONTCOVER nolint |
|
genaccounts/legacy/v036
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/v034
DONTCOVER nolint
|
DONTCOVER nolint |
|
gov/legacy/v036
DONTCOVER nolint
|
DONTCOVER nolint |
|
gov/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
ibc/applications/transfer/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
ibc/core/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/core/02-client/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
ibc/core/03-connection/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
ibc/core/04-channel/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
ibc/light-clients/06-solomachine
Package solomachine implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Solo Machine light client.
|
Package solomachine implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Solo Machine light client. |
|
ibc/light-clients/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/light-clients/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. |
|
ibc/testing/mock
This package is only intended to be used for testing core IBC.
|
This package is only intended to be used for testing core IBC. |
|
mint/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
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/types
noalias noalias DONTCOVER Package types is a reverse proxy.
|
noalias noalias DONTCOVER Package types is a reverse proxy. |
|
staking/legacy/v034
DONTCOVER nolint
|
DONTCOVER nolint |
|
staking/legacy/v036
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
staking/legacy/v038
DONTCOVER nolint DONTCOVER nolint
|
DONTCOVER nolint DONTCOVER nolint |
|
staking/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
upgrade/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.