From e1e886a0fc6336e8e44a13c12f8736bf2a0d2f7a Mon Sep 17 00:00:00 2001 From: zramsay Date: Mon, 19 Feb 2018 22:17:06 +0000 Subject: [PATCH] s/dummy&Dummy/kvstore&KVStore/g --- Makefile | 3 --- docs/guide.md | 2 +- docs/sdk/overview.rst | 4 ++-- examples/{dummy => kvstore}/main.go | 10 +++++----- examples/{dummy => kvstore}/tx.go | 24 ++++++++++++------------ 5 files changed, 20 insertions(+), 23 deletions(-) rename examples/{dummy => kvstore}/main.go (84%) rename examples/{dummy => kvstore}/tx.go (64%) diff --git a/Makefile b/Makefile index c5e0357ccd..ea802ef2fa 100644 --- a/Makefile +++ b/Makefile @@ -58,9 +58,6 @@ godocs: ######################################## ### Testing -TUTORIALS=$(shell find docs/guide -name "*md" -type f) - -#test: test_unit test_cli test_tutorial test: test_unit # test_cli test_unit: diff --git a/docs/guide.md b/docs/guide.md index ae2829b451..8741ada865 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -282,7 +282,7 @@ func NewHandler(am sdk.AccountMapper) sdk.Handler { ### vs encoding/json ### vs protobuf -## Dummy example +## KVStore example ## Basecoin example diff --git a/docs/sdk/overview.rst b/docs/sdk/overview.rst index d7639d4943..25ed2b132b 100644 --- a/docs/sdk/overview.rst +++ b/docs/sdk/overview.rst @@ -421,8 +421,8 @@ vs encoding/json vs protobuf ~~~~~~~~~~~ -Dummy example -------------- +KVStore example +--------------- Basecoin example ---------------- diff --git a/examples/dummy/main.go b/examples/kvstore/main.go similarity index 84% rename from examples/dummy/main.go rename to examples/kvstore/main.go index 6fd7aa5478..5ffe590f1a 100644 --- a/examples/dummy/main.go +++ b/examples/kvstore/main.go @@ -27,7 +27,7 @@ func main() { var capKeyMainStore = sdk.NewKVStoreKey("main") // Create BaseApp. - var baseApp = bam.NewBaseApp("dummy", logger, db) + var baseApp = bam.NewBaseApp("kvstore", logger, db) // Set mounts for BaseApp's MultiStore. baseApp.MountStore(capKeyMainStore, sdk.StoreTypeIAVL) @@ -36,7 +36,7 @@ func main() { baseApp.SetTxDecoder(decodeTx) // Set a handler Route. - baseApp.Router().AddRoute("dummy", DummyHandler(capKeyMainStore)) + baseApp.Router().AddRoute("kvstore", KVStoreHandler(capKeyMainStore)) // Load latest version. if err := baseApp.LoadLatestVersion(capKeyMainStore); err != nil { @@ -60,11 +60,11 @@ func main() { return } -func DummyHandler(storeKey sdk.StoreKey) sdk.Handler { +func KVStoreHandler(storeKey sdk.StoreKey) sdk.Handler { return func(ctx sdk.Context, msg sdk.Msg) sdk.Result { - dTx, ok := msg.(dummyTx) + dTx, ok := msg.(kvstoreTx) if !ok { - panic("DummyHandler should only receive dummyTx") + panic("KVStoreHandler should only receive kvstoreTx") } // tx is already unmarshalled diff --git a/examples/dummy/tx.go b/examples/kvstore/tx.go similarity index 64% rename from examples/dummy/tx.go rename to examples/kvstore/tx.go index 7bea103e7a..b324081e83 100644 --- a/examples/dummy/tx.go +++ b/examples/kvstore/tx.go @@ -8,13 +8,13 @@ import ( ) // An sdk.Tx which is its own sdk.Msg. -type dummyTx struct { +type kvstoreTx struct { key []byte value []byte bytes []byte } -func (tx dummyTx) Get(key interface{}) (value interface{}) { +func (tx kvstoreTx) Get(key interface{}) (value interface{}) { switch k := key.(type) { case string: switch k { @@ -27,32 +27,32 @@ func (tx dummyTx) Get(key interface{}) (value interface{}) { return nil } -func (tx dummyTx) Type() string { - return "dummy" +func (tx kvstoreTx) Type() string { + return "kvstore" } -func (tx dummyTx) GetMsg() sdk.Msg { +func (tx kvstoreTx) GetMsg() sdk.Msg { return tx } -func (tx dummyTx) GetSignBytes() []byte { +func (tx kvstoreTx) GetSignBytes() []byte { return tx.bytes } // Should the app be calling this? Or only handlers? -func (tx dummyTx) ValidateBasic() sdk.Error { +func (tx kvstoreTx) ValidateBasic() sdk.Error { return nil } -func (tx dummyTx) GetSigners() []crypto.Address { +func (tx kvstoreTx) GetSigners() []crypto.Address { return nil } -func (tx dummyTx) GetSignatures() []sdk.StdSignature { +func (tx kvstoreTx) GetSignatures() []sdk.StdSignature { return nil } -func (tx dummyTx) GetFeePayer() crypto.Address { +func (tx kvstoreTx) GetFeePayer() crypto.Address { return nil } @@ -64,10 +64,10 @@ func decodeTx(txBytes []byte) (sdk.Tx, sdk.Error) { split := bytes.Split(txBytes, []byte("=")) if len(split) == 1 { k := split[0] - tx = dummyTx{k, k, txBytes} + tx = kvstoreTx{k, k, txBytes} } else if len(split) == 2 { k, v := split[0], split[1] - tx = dummyTx{k, v, txBytes} + tx = kvstoreTx{k, v, txBytes} } else { return nil, sdk.ErrTxParse("too many =") }