From 609ea0d0f0a2d8948024eef850b0d4585376adec Mon Sep 17 00:00:00 2001 From: Ethan Buchman Date: Thu, 5 Apr 2018 13:24:53 +0300 Subject: [PATCH] more daemon refactoring --- examples/basecoin/cmd/basecoind/main.go | 33 +--- examples/democoin/LICENSE | 204 ------------------------ examples/democoin/Makefile | 22 --- examples/democoin/cmd/democoind/main.go | 83 +++------- mock/app.go | 2 +- server/{pre_run.go => cmd.go} | 15 ++ server/init.go | 27 +++- server/start.go | 8 +- 8 files changed, 65 insertions(+), 329 deletions(-) delete mode 100644 examples/democoin/LICENSE delete mode 100644 examples/democoin/Makefile rename server/{pre_run.go => cmd.go} (79%) diff --git a/examples/basecoin/cmd/basecoind/main.go b/examples/basecoin/cmd/basecoind/main.go index 9b38660c46..3153330086 100644 --- a/examples/basecoin/cmd/basecoind/main.go +++ b/examples/basecoin/cmd/basecoind/main.go @@ -1,8 +1,6 @@ package main import ( - "encoding/json" - "fmt" "os" "path/filepath" @@ -15,7 +13,6 @@ import ( "github.com/cosmos/cosmos-sdk/examples/basecoin/app" "github.com/cosmos/cosmos-sdk/server" - "github.com/cosmos/cosmos-sdk/version" ) // basecoindCmd is the entry point for this binary @@ -28,27 +25,6 @@ var ( } ) -// defaultOptions sets up the app_state for the -// default genesis file. It is a server.GenAppState -// used for `basecoind init`. -func defaultOptions(args ...string) (json.RawMessage, error) { - if len(args) != 2 { - return nil, fmt.Errorf("Expected 2 args: address and coin denom") - } - opts := fmt.Sprintf(`{ - "accounts": [{ - "address": "%s", - "coins": [ - { - "denom": "mycoin", - "amount": 9007199254740992 - } - ] - }] - }`, args) - return json.RawMessage(opts), nil -} - func generateApp(rootDir string, logger log.Logger) (abci.Application, error) { dataDir := filepath.Join(rootDir, "data") dbMain, err := dbm.NewGoLevelDB("basecoin", dataDir) @@ -78,14 +54,7 @@ func generateApp(rootDir string, logger log.Logger) (abci.Application, error) { } func main() { - rootCmd.AddCommand( - server.InitCmd(defaultOptions, context), - server.StartCmd(generateApp, context), - server.UnsafeResetAllCmd(context), - server.ShowNodeIDCmd(context), - server.ShowValidatorCmd(context), - version.VersionCmd, - ) + server.AddCommands(rootCmd, server.DefaultGenAppState, generateApp, context) // prepare and add flags rootDir := os.ExpandEnv("$HOME/.basecoind") diff --git a/examples/democoin/LICENSE b/examples/democoin/LICENSE deleted file mode 100644 index 1697a74436..0000000000 --- a/examples/democoin/LICENSE +++ /dev/null @@ -1,204 +0,0 @@ -Cosmos-SDK Democoin (template) -License: Apache2.0 - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2018 All in Bits, Inc - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/examples/democoin/Makefile b/examples/democoin/Makefile deleted file mode 100644 index 067d03e9bd..0000000000 --- a/examples/democoin/Makefile +++ /dev/null @@ -1,22 +0,0 @@ -PACKAGES=$(shell go list ./... | grep -v '/vendor/') -BUILD_FLAGS = -ldflags "-X github.com/cosmos/cosmos-sdk/examples/democoin/version.GitCommit=`git rev-parse --short HEAD`" - -all: get_tools get_vendor_deps build test - -get_tools: - go get github.com/golang/dep/cmd/dep - -build: - go build $(BUILD_FLAGS) -o build/democoin ./cmd/... - -get_vendor_deps: - @rm -rf vendor/ - @dep ensure - -test: - @go test $(PACKAGES) - -benchmark: - @go test -bench=. $(PACKAGES) - -.PHONY: all build test benchmark diff --git a/examples/democoin/cmd/democoind/main.go b/examples/democoin/cmd/democoind/main.go index 114c28d0ff..04436eec2e 100644 --- a/examples/democoin/cmd/democoind/main.go +++ b/examples/democoin/cmd/democoind/main.go @@ -2,82 +2,48 @@ package main import ( "encoding/json" - "fmt" "os" "path/filepath" "github.com/spf13/cobra" - "github.com/spf13/viper" abci "github.com/tendermint/abci/types" - tcmd "github.com/tendermint/tendermint/cmd/tendermint/commands" - cfg "github.com/tendermint/tendermint/config" "github.com/tendermint/tmlibs/cli" - tmflags "github.com/tendermint/tmlibs/cli/flags" - cmn "github.com/tendermint/tmlibs/common" dbm "github.com/tendermint/tmlibs/db" "github.com/tendermint/tmlibs/log" "github.com/cosmos/cosmos-sdk/examples/democoin/app" "github.com/cosmos/cosmos-sdk/server" - "github.com/cosmos/cosmos-sdk/version" + sdk "github.com/cosmos/cosmos-sdk/types" ) // democoindCmd is the entry point for this binary var ( - context = server.NewContext(nil, nil) - democoindCmd = &cobra.Command{ - Use: "democoind", - Short: "Gaia Daemon (server)", - PersistentPreRunE: func(cmd *cobra.Command, args []string) error { - if cmd.Name() == version.VersionCmd.Name() { - return nil - } - config, err := tcmd.ParseConfig() - if err != nil { - return err - } - logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout)) - logger, err = tmflags.ParseLogLevel(config.LogLevel, logger, cfg.DefaultLogLevel()) - if err != nil { - return err - } - if viper.GetBool(cli.TraceFlag) { - logger = log.NewTracingLogger(logger) - } - logger = logger.With("module", "main") - context.Config = config - context.Logger = logger - return nil - }, + context = server.NewContext(nil, nil) + rootCmd = &cobra.Command{ + Use: "democoind", + Short: "Gaia Daemon (server)", + PersistentPreRunE: server.PersistentPreRunEFn(context), } ) -// defaultOptions sets up the app_options for the +// defaultAppState sets up the app_state for the // default genesis file -func defaultOptions(args []string) (json.RawMessage, string, cmn.HexBytes, error) { - addr, secret, err := server.GenerateCoinKey() +func defaultAppState(args []string, addr sdk.Address, coinDenom string) (json.RawMessage, error) { + baseJSON, err := server.DefaultGenAppState(args, addr, coinDenom) if err != nil { - return nil, "", nil, err + return nil, err } - fmt.Println("Secret phrase to access coins:") - fmt.Println(secret) - - opts := fmt.Sprintf(`{ - "accounts": [{ - "address": "%s", - "coins": [ - { - "denom": "mycoin", - "amount": 9007199254740992 - } - ] - }], - "cool": { + var jsonMap map[string]json.RawMessage + err = json.Unmarshal(baseJSON, jsonMap) + if err != nil { + return nil, err + } + jsonMap["cool"] = json.RawMessage(`{ "trend": "ice-cold" - } - }`, addr) - return json.RawMessage(opts), "", nil, nil + }`) + bz, err := json.Marshal(jsonMap) + return json.RawMessage(bz), err } func generateApp(rootDir string, logger log.Logger) (abci.Application, error) { @@ -108,17 +74,10 @@ func generateApp(rootDir string, logger log.Logger) (abci.Application, error) { } func main() { - democoindCmd.AddCommand( - server.InitCmd(defaultOptions, context), - server.StartCmd(generateApp, context), - server.UnsafeResetAllCmd(context), - server.ShowNodeIdCmd(context), - server.ShowValidatorCmd(context), - version.VersionCmd, - ) + server.AddCommands(rootCmd, defaultAppState, generateApp, context) // prepare and add flags rootDir := os.ExpandEnv("$HOME/.democoind") - executor := cli.PrepareBaseCmd(democoindCmd, "BC", rootDir) + executor := cli.PrepareBaseCmd(rootCmd, "BC", rootDir) executor.Execute() } diff --git a/mock/app.go b/mock/app.go index e884a3ede0..631cc3c314 100644 --- a/mock/app.go +++ b/mock/app.go @@ -106,7 +106,7 @@ func InitChainer(key sdk.StoreKey) func(sdk.Context, abci.RequestInitChain) abci // GenInitOptions can be passed into InitCmd, // returns a static string of a few key-values that can be parsed // by InitChainer -func GenInitOptions(args ...string) (json.RawMessage, error) { +func GenInitOptions(args []string, addr sdk.Address, coinDenom string) (json.RawMessage, error) { opts := []byte(`{ "values": [ { diff --git a/server/pre_run.go b/server/cmd.go similarity index 79% rename from server/pre_run.go rename to server/cmd.go index c82a8f3649..a85e761dd1 100644 --- a/server/pre_run.go +++ b/server/cmd.go @@ -40,3 +40,18 @@ func PersistentPreRunEFn(context *Context) func(*cobra.Command, []string) error return nil } } + +func AddCommands( + rootCmd *cobra.Command, + appState GenAppState, appCreator AppCreator, + context *Context) { + + rootCmd.AddCommand( + InitCmd(appState, context), + StartCmd(appCreator, context), + UnsafeResetAllCmd(context), + ShowNodeIDCmd(context), + ShowValidatorCmd(context), + version.VersionCmd, + ) +} diff --git a/server/init.go b/server/init.go index 3a48e9fe5e..e172816a51 100644 --- a/server/init.go +++ b/server/init.go @@ -5,6 +5,7 @@ import ( "fmt" "io/ioutil" + sdk "github.com/cosmos/cosmos-sdk/types" "github.com/spf13/cobra" cfg "github.com/tendermint/tendermint/config" @@ -42,11 +43,29 @@ func InitCmd(gen GenAppState, ctx *Context) *cobra.Command { return &cobraCmd } -// GenAppState takes a list of arguments and -// returns a default app_state to be included in +// GenAppState takes the command line args, as well +// as an address and coin denomination. +// It returns a default app_state to be included in // in the genesis file. // This is application-specific -type GenAppState func(args ...string) (json.RawMessage, error) +type GenAppState func(args []string, addr sdk.Address, coinDenom string) (json.RawMessage, error) + +// DefaultGenAppState expects two args: an account address +// and a coin denomination, and gives lots of coins to that address. +func DefaultGenAppState(args []string, addr sdk.Address, coinDenom string) (json.RawMessage, error) { + opts := fmt.Sprintf(`{ + "accounts": [{ + "address": "%s", + "coins": [ + { + "denom": "%s", + "amount": 9007199254740992 + } + ] + }] + }`, addr.String(), coinDenom) + return json.RawMessage(opts), nil +} type initCmd struct { genAppState GenAppState @@ -79,7 +98,7 @@ func (c initCmd) run(cmd *cobra.Command, args []string) error { var DEFAULT_DENOM = "mycoin" // Now, we want to add the custom app_state - appState, err := c.genAppState(addr.String(), DEFAULT_DENOM) + appState, err := c.genAppState(args, addr, DEFAULT_DENOM) if err != nil { return err } diff --git a/server/start.go b/server/start.go index 574e1584e5..6aee5d316c 100644 --- a/server/start.go +++ b/server/start.go @@ -21,13 +21,13 @@ const ( flagAddress = "address" ) -// appGenerator lets us lazily initialize app, using home dir +// AppCreator lets us lazily initialize app, using home dir // and other flags (?) to start -type appCreator func(string, log.Logger) (abci.Application, error) +type AppCreator func(string, log.Logger) (abci.Application, error) // StartCmd runs the service passed in, either // stand-alone, or in-process with tendermint -func StartCmd(app appCreator, ctx *Context) *cobra.Command { +func StartCmd(app AppCreator, ctx *Context) *cobra.Command { start := startCmd{ appCreator: app, context: ctx, @@ -48,7 +48,7 @@ func StartCmd(app appCreator, ctx *Context) *cobra.Command { } type startCmd struct { - appCreator appCreator + appCreator AppCreator context *Context }