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.
- 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.
- Evidence - Evidence handling for double signing, misbehaviour, etc.
- 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.
Directories
¶
| Path | Synopsis |
|---|---|
|
legacy/v034
Package v034 is used for legacy migration scripts.
|
Package v034 is used for legacy migration scripts. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
legacy/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. |
|
legacy/v036
Package v036 is used for legacy migration scripts.
|
Package v036 is used for legacy migration scripts. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
legacy/v040
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/bank/types/key.go
|
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/bank/types/key.go |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
circuit
module
|
|
|
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
Package v034 is used for legacy migration scripts.
|
Package v034 is used for legacy migration scripts. |
|
legacy/v036
Package v036 is used for legacy migration scripts.
|
Package v036 is used for legacy migration scripts. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
legacy/v040
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/distribution/types/keys.go
|
Package v040 is copy-pasted from: https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/distribution/types/keys.go |
|
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. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
types
DONTCOVER Package types is a reverse proxy.
|
DONTCOVER 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). |
|
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
Package v034 is used for legacy migration scripts.
|
Package v034 is used for legacy migration scripts. |
|
legacy/v036
Package v036 is used for legacy migration scripts.
|
Package v036 is used for legacy migration scripts. |
|
legacy/v040
Package v040 is taken from: https://github.com/cosmos/cosmos-sdk/blob/v0.42.1/x/gov/types/genesis.pb.go by copy-pasted only the relevants parts for Genesis.
|
Package v040 is taken from: https://github.com/cosmos/cosmos-sdk/blob/v0.42.1/x/gov/types/genesis.pb.go by copy-pasted only the relevants parts for Genesis. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
group
module
|
|
|
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. |
|
legacy/v036
Package v036 is used for legacy migration scripts.
|
Package v036 is used for legacy migration scripts. |
|
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. |
|
legacy/v040
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 Package types is a reverse proxy.
|
noalias DONTCOVER Package types is a reverse proxy. |
|
legacy/v034
Package v034 is used for legacy migration scripts.
|
Package v034 is used for legacy migration scripts. |
|
legacy/v036
Package v036 is used for legacy migration scripts.
|
Package v036 is used for legacy migration scripts. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
legacy/v040
Package v040 is taken from: https://github.com/cosmos/cosmos-sdk/blob/v0.40.1/x/staking/types/genesis.pb.go by copy-pasted only the relevants parts for Genesis.
|
Package v040 is taken from: https://github.com/cosmos/cosmos-sdk/blob/v0.40.1/x/staking/types/genesis.pb.go by copy-pasted only the relevants parts for Genesis. |
|
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. |
|
legacy/v038
Package v038 is used for legacy migration scripts.
|
Package v038 is used for legacy migration scripts. |
|
types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.