From f942cb43407f645e39a31a38cf067b9d8b54fd36 Mon Sep 17 00:00:00 2001 From: Jae Kwon Date: Sat, 20 Jan 2018 20:58:34 -0800 Subject: [PATCH] WIP: Add docs --- docs/design.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/design.md b/docs/design.md index 8aa05c215..23a6523c8 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,4 +1,32 @@ -## Design Goals +## Design philosphy + +The design of the Cosmos SDK is based on the principles of "cababilities systems". + +TODO If you see this on the sdk2 branch, it's because I'm still expanding this high-level section. + +Sections: + +* Introduction + - Note to skip to Basecoin example to dive into code. +* Capabilities systems + - http://www.erights.org/elib/capability/ode/ode.pdf +* Tx & Msg +* MultiStore +* Context & Handler +* AnteHandler + - Fees + - Authentication +* Accounts and x/auth +* AccountStore +* Wire codec + - vs encoding/json + - vs protobuf +* Dummy example +* Basecoin example +* Conclusion + +## ###################################### +## TODO bring the below up. More details about the design goals of particular components follows.