cosmos-sdk/docs/README.md

61 lines
3.1 KiB
Markdown
Raw Normal View History

# Cosmos SDK Documentation
2018-06-16 21:18:24 -07:00
NOTE: This documentation is a work-in-progress!
- [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
- [Core](core)
- [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.
- [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
- [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)
- [Amino](core/app2.md#amino) - Amino is the primary serialization library used in the SDK
2018-06-27 09:45:01 -07:00
- [Ante Handler](core/app2.md#antehandler) - The AnteHandler
2018-06-26 18:30:13 -07:00
authenticates transactions
2018-06-27 06:53:00 -07:00
- [App3 - Modules: Auth and Bank](core/app3.md)
- [auth.Account](core/app3.md#accounts) - Accounts are the prototypical object kept in the store
- [auth.AccountMapper](core/app3.md#account-mapper) - AccountMapper gets and sets Account on a KVStore
- [auth.StdTx](core/app3.md#stdtx) - `StdTx` is the default implementation of `Tx`
- [auth.StdSignBytes](core/app3.md#signing) - `StdTx` must be signed with certain
information
2018-06-27 09:45:01 -07:00
- [auth.AnteHandler](core/app3.md#antehandler) - The `AnteHandler`
2018-06-27 06:53:00 -07:00
verifies `StdTx`, manages accounts, and deducts fees
- [bank.CoinKeeper](core/app3.md#coin-keeper) - CoinKeeper allows for coin
transfers on an underlying AccountMapper
2018-06-26 18:30:13 -07:00
- [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
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
interfaces for clients to use!
2018-06-18 12:14:08 -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
- [Clients](clients)
2018-06-18 12:14:08 -07:00
- [Running a Node](clients/node.md) - Run a full node!
- [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