cosmos-sdk/docs/building-modules/README.md

76 lines
2.6 KiB
Markdown
Raw Normal View History

# Modules
2019-05-17 06:24:24 -07:00
## Auth
2019-05-17 06:24:24 -07:00
The `x/auth` modules is used for accounts
2019-05-17 06:24:24 -07:00
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/auth)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/auth)
2019-05-17 06:24:24 -07:00
## Bank
2018-06-28 22:59:52 -07:00
The `x/bank` module is for transferring coins between accounts.
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/bank)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/bank)
2019-05-17 06:24:24 -07:00
## Staking
2018-06-28 22:59:52 -07:00
2019-01-11 12:08:01 -08:00
The `x/staking` module is for Cosmos Delegated-Proof-of-Stake.
2018-06-28 22:59:52 -07:00
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/staking)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/staking)
2018-06-28 22:59:52 -07:00
## Slashing
2018-06-28 22:59:52 -07:00
The `x/slashing` module is for Cosmos Delegated-Proof-of-Stake.
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/slashing)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/slashing)
2018-06-28 22:59:52 -07:00
## Distribution
2018-06-28 22:59:52 -07:00
2019-05-17 06:24:24 -07:00
The `x/distribution` module is for distributing fees and inflation across bonded
2018-06-28 22:59:52 -07:00
stakeholders.
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/distribution)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/distribution)
2018-06-28 22:59:52 -07:00
## Governance
2018-06-28 22:59:52 -07:00
The `x/gov` module is for bonded stakeholders to make proposals and vote on them.
- [API docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/gov)
- [Specification](https://github.com/cosmos/cosmos-sdk/tree/master/docs/spec/governance)
2018-06-28 22:59:52 -07:00
2019-05-17 06:24:24 -07:00
To keep up with the current status of IBC, follow and contribute to [ICS](https://github.com/cosmos/ics)
## Crisis
2019-05-17 06:24:24 -07:00
The `x/crisis` module is for halting the blockchain under certain circumstances.
- [API Docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/crisis)
- [Specification](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/crisis)
2019-05-17 06:24:24 -07:00
## Mint
2019-05-17 06:24:24 -07:00
The `x/mint` module is for flexible inflation rates and effect a balance between market liquidity and staked supply.
- [API Docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/mint)
- [Specification](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/mint)
2019-05-17 06:24:24 -07:00
## Params
2019-05-17 06:24:24 -07:00
The `x/params` module provides a globally available parameter store.
- [API Docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/params)
- [Specification](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/params)
## Evidence
The `x/evidence` modules provides a mechanism for defining and submitting arbitrary
events of misbehavior and a means to execute custom business logic for such misbehavior.
2019-05-17 06:24:24 -07:00
- [API Docs](https://godoc.org/github.com/cosmos/cosmos-sdk/x/evidence)
- [Specification](https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/evidence)