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 applications.
- Authz - Authorization for accounts to perform actions on behalf of other accounts.
- 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.
- Epoching - Allows modules to queue messages for execution at a certain block height.
- Evidence - Evidence handling for double signing, misbehaviour, etc.
- Feegrant - Grant fee allowances for executing transactions.
- Governance - On-chain proposals and voting.
- 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.
IBC
The IBC module for the SDK has moved to its own repository.
CosmWasm
The CosmWasm module enables smart contracts, and has its own repository and documentation site.
Directories
¶
| Path | Synopsis |
|---|---|
|
migrations/v043
Package v043 creates in-place store migrations for fixing tracking delegations with vesting accounts.
|
Package v043 creates in-place store migrations for fixing tracking delegations with vesting accounts. |
|
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. |
|
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. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
epoching
|
|
|
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). |
|
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. |
|
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. |
|
Package group is a reverse proxy.
|
Package group is a reverse proxy. |
|
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. |
|
internal/orm
Package orm is a convenient object to data store mapper.
|
Package orm is a convenient object to data store mapper. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
Package nft is a reverse proxy.
|
Package nft 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. |
|
migrations/v042
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 |
|
types
noalias DONTCOVER
|
noalias 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.