2018-06-16 20:16:04 -07:00
|
|
|
# Cosmos SDK Documentation
|
|
|
|
|
2018-06-16 21:18:24 -07:00
|
|
|
NOTE: This documentation is a work-in-progress!
|
|
|
|
|
2018-06-16 20:16:04 -07:00
|
|
|
- [Overview](overview)
|
|
|
|
- [Overview](overview/overview.md) - An overview of the Cosmos-SDK
|
2018-06-16 22:14:38 -07:00
|
|
|
- [The Object-Capability Model](overview/capabilities.md) - Security by
|
|
|
|
least-privilege
|
|
|
|
- [Application Architecture](overview/apps.md) - Layers in the application architecture
|
|
|
|
- [Install](install.md) - Install the library and example applications
|
2018-06-16 20:16:04 -07:00
|
|
|
- [Core](core)
|
2018-06-25 19:30:20 -07:00
|
|
|
- [Introduction](core/intro.md) - Intro to the tutorial
|
|
|
|
- [App1 - The Basics](core/app1.md)
|
|
|
|
- [Messages](core/app1.md#messages) - Messages contain the content of a transaction
|
2018-06-26 14:20:59 -07:00
|
|
|
- [Stores](core/app1.md#kvstore) - KVStore is a Merkle Key-Value store.
|
2018-06-25 19:30:20 -07:00
|
|
|
- [Handlers](core/app1.md#handlers) - Handlers are the workhorse of the app!
|
2018-06-26 18:30:13 -07:00
|
|
|
- [Tx](core/app1.md#tx) - Transactions are the ultimate input to the
|
|
|
|
application
|
2018-06-25 19:30:20 -07:00
|
|
|
- [BaseApp](core/app1.md#baseapp) - BaseApp is the base layer of the application
|
2018-06-26 18:30:13 -07:00
|
|
|
- [App2 - Transactions](core/app2.md)
|
2018-06-25 19:30:20 -07:00
|
|
|
- [Amino](core/app2.md#amino) - Amino is the primary serialization library used in the SDK
|
2018-06-26 18:30:13 -07:00
|
|
|
- [Ante Handler](core/app2.md#ante-handler) - The AnteHandler
|
|
|
|
authenticates transactions
|
|
|
|
- [App3 - Modules](core/app3.md)
|
2018-06-26 19:49:13 -07:00
|
|
|
- [Accounts](core/app3.md#accounts) - Accounts are the prototypical object kept in the store
|
2018-06-26 18:30:13 -07:00
|
|
|
provides Account lookup on a KVStore
|
2018-06-26 19:49:13 -07:00
|
|
|
- [Transactions](core/app3.md#transactions) - `StdTx` is the default
|
|
|
|
implementation of `Tx`
|
2018-06-26 18:30:13 -07:00
|
|
|
- [CoinKeeper](core/app3.md#coin-keeper) - CoinKeeper allows for coin
|
|
|
|
transfer on an underlying AccountMapper
|
|
|
|
- [App4 - Validator Set Changes](core/app4.md)
|
|
|
|
- [InitChain](core/app4.md#init-chain) - Initialize the application
|
|
|
|
state
|
|
|
|
- [BeginBlock](core/app4.md#begin-block) - BeginBlock logic runs at the
|
|
|
|
beginning of every block
|
|
|
|
- [EndBlock](core/app4.md#end-block) - EndBlock logic runs at the
|
|
|
|
end of every block
|
|
|
|
- [App5 - Basecoin](core/app5.md) -
|
|
|
|
- [Directory Structure](core/app5.md#directory-structure) - Keep your
|
2018-06-25 19:30:20 -07:00
|
|
|
application code organized
|
2018-06-26 18:30:13 -07:00
|
|
|
- [Clients](core/app5.md#clients) - Hook up your app to standard CLI and REST
|
2018-06-25 19:30:20 -07:00
|
|
|
interfaces for clients to use!
|
2018-06-18 12:14:08 -07:00
|
|
|
|
2018-06-16 20:16:04 -07:00
|
|
|
- [Modules](modules)
|
|
|
|
- [Bank](modules/bank.md)
|
|
|
|
- [Staking](modules/staking.md)
|
|
|
|
- [Slashing](modules/slashing.md)
|
|
|
|
- [Provisions](modules/provisions.md)
|
|
|
|
- [Governance](modules/governance.md)
|
|
|
|
- [IBC](modules/ibc.md)
|
2018-06-18 12:14:08 -07:00
|
|
|
|
2018-06-16 20:16:04 -07:00
|
|
|
- [Clients](clients)
|
2018-06-18 12:14:08 -07:00
|
|
|
- [Running a Node](clients/node.md) - Run a full node!
|
2018-06-16 20:16:04 -07:00
|
|
|
- [Key Management](clients/keys.md) - Managing user keys
|
|
|
|
- [CLI](clients/cli.md) - Queries and transactions via command line
|
|
|
|
- [Light Client Daemon](clients/lcd.md) - Queries and transactions via REST
|
|
|
|
API
|