README
¶
sidebar_position: 0
List of Modules
Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation:
Essential Modules
Essential modules include functionality that must be included in your Cosmos SDK blockchain. These modules provide the core behaviors that are needed for users and operators such as balance tracking, proof-of-stake capabilities and governance.
- Auth - Authentication of accounts and transactions for Cosmos SDK applications.
- Bank - Token transfer functionalities.
- Consensus - Consensus module for modifying CometBFT's ABCI consensus params.
- Distribution - Fee distribution, and staking token provision distribution.
- Governance - On-chain proposals and voting.
- Genutil - Genesis utilities for the Cosmos SDK.
- Mint - Creation of new units of staking token.
- Slashing - Validator punishment mechanisms.
- Staking - Proof-of-Stake layer for public blockchains.
- Upgrade - Software upgrades handling and coordination.
- Evidence - Evidence handling for double signing, misbehaviour, etc.
Supplementary Modules
Supplementary modules are modules that are maintained in the Cosmos SDK but are not necessary for the core functionality of your blockchain. They can be thought of as ways to extend the capabilities of your blockchain or further specialize it.
- Authz - Authorization for accounts to perform actions on behalf of other accounts.
- Epochs - Registration so SDK modules can have logic to be executed on timed tickers.
- Feegrant - Grant fee allowances for executing transactions.
- ProtocolPool - Extended management of community pool functionality.
Deprecated Modules
The following modules are deprecated. They will no longer be maintained actively.
- Crisis - Deprecated halting the blockchain under certain circumstances (e.g. if an invariant is broken).
- Params - Deprecated Globally available parameter store.
- NFT - Deprecated NFT module implemented based on ADR43.
- Group - Allows for the creation and management of on-chain multisig accounts (enterprise module).
- Circuit Deprecated - Circuit breaker module for pausing messages.
To learn more about the process of building modules, visit the building modules reference documentation.
IBC
The IBC module for the SDK is maintained by the IBC Go team in its own repository.
Additionally, the capability module is from v0.50+ maintained by the IBC Go team in its own repository.
CosmWasm
The CosmWasm module enables smart contracts, learn more by going to their documentation site, or visit the repository.
EVM
Read more about writing smart contracts with solidity at the official evm documentation page.
Enterprise Modules
In addition to these core and supplementary modules, the Cosmos SDK maintains enterprise-grade modules in the enterprise/ directory.
Enterprise modules use different licenses than the Apache 2.0 core SDK modules. Please review the LICENSE file in each enterprise module directory before use.
Available Enterprise Modules
- PoA (Proof of Authority) - Admin-controlled validator set for permissioned networks with governance integration.
For complete information about enterprise modules, licensing, and documentation, see the Enterprise Modules documentation.
Directories
¶
| Path | Synopsis |
|---|---|
|
ante/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
tx/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
vesting/testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
circuit
module
|
|
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
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 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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
types/v1beta1
Package v1beta1 is a reverse proxy.
|
Package v1beta1 is a reverse proxy. |
|
group
module
|
|
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
nft
module
|
|
|
Package params provides a namespaced module parameter store.
|
Package params provides a namespaced module parameter store. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types 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. |
|
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 |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
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. |
|
testutil
Package testutil is a generated GoMock package.
|
Package testutil is a generated GoMock package. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
tx
|
|
|
internal/testpb
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
signing/aminojson/internal/aminojsonpb
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
signing/aminojson/internal/testpb
Code generated by protoc-gen-go-pulsar.
|
Code generated by protoc-gen-go-pulsar. |
|
signing/textual/internal/cbor
Package cbor implements just enough of the CBOR (Concise Binary Object Representation, RFC 8948) to deterministically encode simple data.
|
Package cbor implements just enough of the CBOR (Concise Binary Object Representation, RFC 8948) to deterministically encode simple data. |
|
signing/textual/internal/textualpb
Package textualpb contains all protobuf definitions and generated codes used internally by Textual.
|
Package textualpb contains all protobuf definitions and generated codes used internally by Textual. |
|
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. |
|
internal/conv
Package conv provides internal functions for conversions and data manipulation
|
Package conv provides internal functions for conversions and data manipulation |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.