History

Adrian Brink 42c2712543 Address comments * Move from specs to docs folder * Attempt to fix markdown links * Address general comments from the PR * Remove overview.md due to duplication with readme.md		2018-07-11 13:50:09 +02:00
..
_attic/staking	cli: deprecate --name in favor of --from	2018-07-05 17:24:02 -07:00
clients	cli: deprecate --name in favor of --from	2018-07-05 17:24:02 -07:00
core	changelong	2018-07-09 02:15:36 -07:00
graphics	docs: .rst formatting & image	2018-02-13 09:12:23 -05:00
light	Address comments	2018-07-11 13:50:09 +02:00
modules	add links for modules and clients	2018-06-29 01:59:52 -04:00
overview	/docs/sdk -> /docs	2018-06-21 15:46:33 -07:00
spec	Address comments	2018-07-11 13:50:09 +02:00
install.md	/docs/sdk -> /docs	2018-06-21 15:46:33 -07:00
README.md	minor fix	2018-06-29 02:03:59 -04:00

README.md

Cosmos SDK Documentation

NOTE: This documentation is a work-in-progress!

Overview
- Overview - An overview of the Cosmos-SDK
- The Object-Capability Model - Security by least-privilege
- Application Architecture - Layers in the application architecture
Install - Install the library and example applications
Core
- Introduction - Intro to the tutorial
- App1 - The Basics
  - Messages - Messages contain the content of a transaction
  - Stores - KVStore is a Merkle Key-Value store.
  - Handlers - Handlers are the workhorse of the app!
  - Tx - Transactions are the ultimate input to the application
  - BaseApp - BaseApp is the base layer of the application
- App2 - Transactions
  - Amino - Amino is the primary serialization library used in the SDK
  - Ante Handler - The AnteHandler authenticates transactions
- App3 - Modules: Auth and Bank
  - auth.Account - Accounts are the prototypical object kept in the store
  - auth.AccountMapper - AccountMapper gets and sets Account on a KVStore
  - auth.StdTx - StdTx is the default implementation of Tx
  - auth.StdSignBytes - StdTx must be signed with certain information
  - auth.AnteHandler - The AnteHandler verifies StdTx, manages accounts, and deducts fees
  - bank.CoinKeeper - CoinKeeper allows for coin transfers on an underlying AccountMapper
- App4 - ABCI
  - ABCI - ABCI is the interface between Tendermint and the Cosmos-SDK
  - InitChain - Initialize the application store
  - BeginBlock - BeginBlock runs at the beginning of every block and updates the app about validator behaviour
  - EndBlock - EndBlock runs at the end of every block and lets the app change the validator set.
  - Query - Query the application store
  - CheckTx - CheckTx only runs the AnteHandler
- App5 - Basecoin -
  - Directory Structure - Keep your application code organized
  - Tendermint Node - Run a full blockchain node with your app
  - Clients - Hook up your app to CLI and REST interfaces for clients to use!
Modules
- Bank
- Staking
- Slashing
- Provisions
- Governance
- IBC
Clients
- Running a Node - Run a full node!
- Key Management - Managing user keys
- CLI - Queries and transactions via command line
- REST Light Client Daemon - Queries and transactions via REST API