Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs via example apps #1376

Merged
merged 40 commits into from
Jun 29, 2018
Merged
Show file tree
Hide file tree
Changes from 34 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
9233e35
example app1
ebuchman Jun 26, 2018
7e50e7d
docs: update readme structure with example apps
ebuchman Jun 26, 2018
234d749
docs/examples: templates for more examples
ebuchman Jun 26, 2018
05db92f
Added handler to app1
AdityaSripal Jun 26, 2018
b3b075c
finish docs for app1
ebuchman Jun 26, 2018
7566ac2
consolidate files into appX.md
ebuchman Jun 26, 2018
bc35c72
minor fixes
ebuchman Jun 26, 2018
cc4f254
fix comment
ebuchman Jun 26, 2018
69a4737
more minor fixes
ebuchman Jun 26, 2018
dde8abf
more structure for app2 and app3 md
ebuchman Jun 26, 2018
72c1381
some reordering in app1 and app3
ebuchman Jun 27, 2018
e6aec82
update readme
ebuchman Jun 27, 2018
d1c9b8b
Finish app1-3, app4 done minus staking
AdityaSripal Jun 27, 2018
c0445e5
Remove unnecessary fields from simple account
AdityaSripal Jun 27, 2018
e11e469
Initialize coin metadata in app4 and fmt
AdityaSripal Jun 27, 2018
41c61d2
Revert changes to app1 router
AdityaSripal Jun 27, 2018
354f976
move AnteHandler to app2 and some cleanup in app3
ebuchman Jun 27, 2018
fc81c14
update/finish app1 go and md
ebuchman Jun 27, 2018
6a5a8b4
minor cleanup
ebuchman Jun 27, 2018
0987787
more app1 cleanup
ebuchman Jun 27, 2018
d6a01ba
minor updates in App2
ebuchman Jun 27, 2018
bd581b2
working on app3
ebuchman Jun 27, 2018
b335d3b
app3 ante handler
ebuchman Jun 27, 2018
0c5e3fd
some cleanup, remove old files
ebuchman Jun 27, 2018
6bbe295
app3 coin keeper
ebuchman Jun 27, 2018
98be0e7
Improved apps with better handling/routing and simpler MsgIssue
AdityaSripal Jun 27, 2018
e3f38b6
Added some documentation
AdityaSripal Jun 27, 2018
4e2eb24
Appease linter
AdityaSripal Jun 27, 2018
3a96f8f
Merge pull request #1434 from cosmos/bucky-aditya/docs-core
ebuchman Jun 28, 2018
e8946e9
fixes from review
ebuchman Jun 28, 2018
e708104
address TODOs in app 1 and 2
ebuchman Jun 28, 2018
778b102
more app1/app2 cleanup
ebuchman Jun 29, 2018
d0efeb1
fill in app3 todos. simplify app3.go
ebuchman Jun 29, 2018
d1a42e0
satisfy linter
ebuchman Jun 29, 2018
1d4d9e9
simplify and complete app3
ebuchman Jun 29, 2018
f405bdf
template app4.md. simplify app4.go
ebuchman Jun 29, 2018
12a1807
started app5
ebuchman Jun 29, 2018
822ebdb
cleanup _attic
ebuchman Jun 29, 2018
4e87cdf
add links for modules and clients
ebuchman Jun 29, 2018
a7cdea5
minor fix
ebuchman Jun 29, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 34 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,40 @@ NOTE: This documentation is a work-in-progress!
- [Application Architecture](overview/apps.md) - Layers in the application architecture
- [Install](install.md) - Install the library and example applications
- [Core](core)
- [Messages](core/messages.md) - Messages contain the content of a transaction
- [Handlers](core/handlers.md) - Handlers are the workhorse of the app!
- [BaseApp](core/baseapp.md) - BaseApp is the base layer of the application
- [The MultiStore](core/multistore.md) - MultiStore is a rich Merkle database
- [Amino](core/amino.md) - Amino is the primary serialization library used in the SDK
- [Accounts](core/accounts.md) - Accounts are the prototypical object kept in the store
- [Transactions](core/transactions.md) - Transactions wrap messages and provide authentication
- [Keepers](core/keepers.md) - Keepers are the interfaces between handlers
- [Clients](core/clients.md) - Hook up your app to standard CLI and REST
interfaces for clients to use!
- [Advanced](core/advanced.md) - Trigger logic on a timer, use custom
serialization formats, advanced Merkle proofs, and more!
- [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
- [Stores](core/app1.md#kvstore) - KVStore is a Merkle Key-Value store.
- [Handlers](core/app1.md#handlers) - Handlers are the workhorse of the app!
- [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
- [App2 - Transactions](core/app2.md)
- [Amino](core/app2.md#amino) - Amino is the primary serialization library used in the SDK
- [Ante Handler](core/app2.md#antehandler) - The AnteHandler
authenticates transactions
- [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
- [auth.AnteHandler](core/app3.md#antehandler) - The `AnteHandler`
verifies `StdTx`, manages accounts, and deducts fees
- [bank.CoinKeeper](core/app3.md#coin-keeper) - CoinKeeper allows for coin
transfers 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
application code organized
- [Clients](core/app5.md#clients) - Hook up your app to standard CLI and REST
interfaces for clients to use!

- [Modules](modules)
- [Bank](modules/bank.md)
Expand Down
101 changes: 0 additions & 101 deletions docs/core/accounts.md

This file was deleted.

36 changes: 0 additions & 36 deletions docs/core/amino.md

This file was deleted.

Loading