From fd5dfc5944f1eded9fc9b5fc3ba6b46da90e755f Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Wed, 7 Feb 2018 16:14:54 +0000 Subject: [PATCH] docs: remove middleware section --- docs/glossary.rst | 26 -------------------------- docs/sdk/overview.rst | 2 +- 2 files changed, 1 insertion(+), 27 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index e67f7a0959..1480e7b38c 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -135,32 +135,6 @@ that execute transactions, and this can provide a large degree of code interoperability, much like ``http.Handler`` does in golang web development. -Middleware ----------- - -Middleware is a series of processing steps that any request must travel -through before (and after) executing the registered ``Handler``. Some -examples are a logger (that records the time before executing the -transaction, then outputs info - including duration - after the -execution), of a signature checker (which unwraps the transaction by one -layer, verifies signatures, and adds the permissions to the Context -before passing the request along). - -In keeping with the standardization of ``http.Handler`` and inspired by -the super minimal -`negroni `__ -package, we just provide one more ``Middleware`` interface, which has an -extra ``next`` parameter, and a ``Stack`` that can wire all the levels -together (which also gives us a place to perform seperation of each -step). - -:: - - Name() string - CheckTx(ctx Context, store state.KVStore, tx Tx, next Checker) (Result, error) - DeliverTx(ctx Context, store state.KVStore, tx Tx, next Deliver) (Result, error) - SetOption(l log.Logger, store state.KVStore, module, key, value string, next Optioner) (string, error) - Modules ------- diff --git a/docs/sdk/overview.rst b/docs/sdk/overview.rst index 32d777dbb5..5f513bf8af 100644 --- a/docs/sdk/overview.rst +++ b/docs/sdk/overview.rst @@ -3,7 +3,7 @@ SDK Overview The SDK design optimizes flexibility and security. The framework is designed around a modular execution stack which allows -applications to mix and match modular elements as desired. In addition, +applications to mix and match elements as desired. In addition, all modules are sandboxed for greater application security. Framework Overview