README
¶
List of Modules
Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation:
- Auth - Authentication of accounts and transactions for Cosmos SDK application.
- Bank - Token transfer functionalities.
- Capability - Object capability implementation.
- Crisis - Halting the blockchain under certain circumstances (e.g. if an invariant is broken).
- Distribution - Fee distribution, and staking token provision distribution.
- Evidence - Evidence handling for double signing, misbehaviour, etc.
- Governance - On-chain proposals and voting.
- IBC - IBC protocol for transport, authentication adn ordering.
- IBC Transfer - Cross-chain fungible token transfer implementation through IBC.
- Mint - Creation of new units of staking token.
- Params - Globally available parameter store.
- Slashing - Validator punishment mechanisms.
- Staking - Proof-of-Stake layer for public blockchains.
- Upgrade - Software upgrades handling and coordination.
To learn more about the process of building modules, visit the building modules reference documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
legacy/v034
DONTCOVER
|
DONTCOVER |
|
legacy/v036
DONTCOVER
|
DONTCOVER |
|
tx
Package tx 's xauthclient.go file is copy-pasted from https://github.com/cosmos/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/cosmos/cosmos-sdk/pull/8732#discussion_r584746947
|
Package tx 's xauthclient.go file is copy-pasted from https://github.com/cosmos/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/cosmos/cosmos-sdk/pull/8732#discussion_r584746947 |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
Package authz is a reverse proxy.
|
Package authz is a reverse proxy. |
|
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. |
|
legacy/v036
DONTCOVER
|
DONTCOVER |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
legacy/v034
DONTCOVER
|
DONTCOVER |
|
types
nolint
|
nolint |
|
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. |
|
types
DONTCOVER
|
DONTCOVER |
|
Package feegrant provides functionality for authorizing the payment of transaction fees from one account (key) to another account (key).
|
Package feegrant provides functionality for authorizing the payment of transaction fees from one account (key) to another account (key). |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
Package genaccounts is now deprecated.
|
Package genaccounts is now deprecated. |
|
legacy/v034
DONTCOVER
|
DONTCOVER |
|
legacy/v036
DONTCOVER nolint
|
DONTCOVER nolint |
|
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. |
|
legacy/v034
DONTCOVER
|
DONTCOVER |
|
legacy/v036
DONTCOVER
|
DONTCOVER |
|
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. |
|
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. |
|
core/02-client/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/03-connection/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
core/04-channel/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
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. |
|
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. |
|
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. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
Package params provides a namespaced module parameter store.
|
Package params provides a namespaced module parameter store. |
|
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. |
|
types/proposal
Package proposal is a reverse proxy.
|
Package proposal is a reverse proxy. |
|
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. |
|
types
noalias
|
noalias |
|
legacy/v034
DONTCOVER
|
DONTCOVER |
|
legacy/v036
DONTCOVER
|
DONTCOVER |
|
legacy/v038
DONTCOVER
|
DONTCOVER |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.