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.
- Governance - On-chain proposals and voting.
- Staking - Proof-of-stake layer for public blockchains.
- Slashing - Validator punishment mechanisms.
- Distribution - Fee distribution, and staking token provision distribution.
- Crisis - Halting the blockchain under certain circumstances (e.g. if an invariant is broken).
- Mint - Creation of new units of staking token.
- Params - Globally available parameter store.
- Supply - Total token supply of the chain.
To learn more about the process of building modules, visit the building modules reference documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
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 |
|
legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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/ |
|
vesting/types
nolint noalias
|
nolint noalias |
|
internal/typesadapter
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
client/cli
nolint
|
nolint |
|
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. |
|
client/cli
nolint
|
nolint |
|
legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
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. |
|
internal/types
DONTCOVER
|
DONTCOVER |
|
Package genaccounts is now deprecated.
|
Package genaccounts is now deprecated. |
|
legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/genutil/types
|
nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/genutil/types |
|
nolint DONTCOVER
|
nolint DONTCOVER |
|
keeper
nolint
|
nolint |
|
legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
Package mock provides utility methods to ease writing tests.
|
Package mock provides utility methods to ease writing tests. |
|
Package params provides a namespaced module parameter store.
|
Package params provides a namespaced module parameter store. |
|
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. |
|
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. |
|
internal/keeper
nolint
|
nolint |
|
internal/types
noalias
|
noalias |
|
legacy/v0_34
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
legacy/v0_38
DONTCOVER nolint
|
DONTCOVER nolint |
|
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 |
|
legacy/v0_36
DONTCOVER nolint
|
DONTCOVER nolint |
|
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. |
Click to show internal directories.
Click to hide internal directories.