Single Binary & Command Refactor

.github/workflows/test.yml

@@ -205,9 +205,9 @@ jobs:
             .go
             .mod
             .sum
-      - name: build-sim
+      - name: build-simd
         run: |
-          make build-sim
+          make build-simd
         if: "env.GIT_DIFF != ''"
       - name: cli-test
         run: |

Dockerfile

@@ -7,8 +7,8 @@
 # > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simapp:/root/.simapp simapp simd start
 #
 # Client: (Note the simapp binary always looks at ~/.simapp we can bind to different local storage)
-# > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simcli keys add foo
-# > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simcli keys list
+# > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simd keys add foo
+# > docker run -it -p 26657:26657 -p 26656:26656 -v ~/.simappcli:/root/.simapp simapp simd keys list
 # TODO: demo connecting rest-server (or is this in server now?)
 FROM golang:alpine AS build-env
 
@@ -24,7 +24,7 @@ COPY . .
 
 # build Cosmos SDK, remove packages
 RUN make tools && \
-    make build-sim && \
+    make build-simd && \
     cp ./build/sim* /go/bin
 # make build-sim-linux ??
 
@@ -38,7 +38,6 @@ WORKDIR /root
 
 # Copy over binaries from the build-env
 COPY --from=build-env /go/bin/simd /usr/bin/simd
-COPY --from=build-env /go/bin/simcli /usr/bin/simcli
 
 EXPOSE 26656 26657 1317
 

Makefile

@@ -26,15 +26,14 @@ include contrib/devtools/Makefile
 build: go.sum
 	go build -mod=readonly ./...
 
-build-sim: go.sum
+build-simd: go.sum
 	mkdir -p $(BUILDDIR)
-	go build -mod=readonly $(BUILD_FLAGS) -o $(BUILDDIR) ./simapp/cmd/simd
-	go build -mod=readonly $(BUILD_FLAGS) -o $(BUILDDIR) ./simapp/cmd/simcli
+	go build -mod=readonly $(BUILD_FLAGS) -o $(BUILDDIR) ./simapp/simd
 
-build-sim-linux: go.sum
-	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build-sim
+build-simd-linux: go.sum
+	LEDGER_ENABLED=false GOOS=linux GOARCH=amd64 $(MAKE) build-simd
 
-.PHONY: build build-sim build-sim-linux
+.PHONY: build build-simd build-simd-linux
 
 mocks: $(MOCKS_DIR)
 	mockgen -source=client/account_retriever.go -package mocks -destination tests/mocks/account_retriever.go
@@ -129,7 +128,7 @@ test-unit:
 test-race:
 	@VERSION=$(VERSION) go test -mod=readonly -race $(PACKAGES_NOSIMULATION)
 
-test-integration: build-sim
+test-integration: build-simd
 	BUILDDIR=$(BUILDDIR) go test -mod=readonly -p 4 -tags='ledger test_ledger_mock cli_test' -run ^TestCLI `go list ./.../cli/...`
 
 .PHONY: test test-all test-ledger-mock test-ledger test-unit test-race
@@ -321,7 +320,7 @@ build-docker-local-simapp:
 	@$(MAKE) -C networks/local
 
 # Run a 4-node testnet locally
-localnet-start: build-sim-linux localnet-stop
+localnet-start: build-simd-linux localnet-stop
 	@if ! [ -f build/node0/simd/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/simd:Z cosmos-sdk/simappnode testnet --v 4 -o . --starting-ip-address 192.168.10.2 --keyring-backend=test ; fi
 	docker-compose up -d
 

client/cmd.go

@@ -9,13 +9,12 @@ import (
 	"github.com/spf13/pflag"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
+	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-type contextKey string
-
 // ClientContextKey defines the context key used to retrieve a client.Context from
 // a command's Context.
-const ClientContextKey = contextKey("client.context")
+const ClientContextKey = sdk.ContextKey("client.context")
 
 // SetCmdClientContextHandler is to be used in a command pre-hook execution to
 // read flags that populate a Context and sets that to the command's Context.

client/debug/main.go

@@ -8,24 +8,22 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
-
 	"github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/crypto/ed25519"
 
 	"github.com/cosmos/cosmos-sdk/client"
-	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/version"
 )
 
-func Cmd(cdc *codec.Codec) *cobra.Command {
+func Cmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "debug",
 		Short: "Tool for helping with debugging your application",
 		RunE:  client.ValidateCmd,
 	}
 
-	cmd.AddCommand(PubkeyCmd(cdc))
+	cmd.AddCommand(PubkeyCmd())
 	cmd.AddCommand(AddrCmd())
 	cmd.AddCommand(RawBytesCmd())
 
@@ -68,7 +66,7 @@ func getPubKeyFromString(pkstr string) (crypto.PubKey, error) {
 	return nil, fmt.Errorf("pubkey '%s' invalid; expected hex, base64, or bech32", pubKey)
 }
 
-func PubkeyCmd(cdc *codec.Codec) *cobra.Command {
+func PubkeyCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:   "pubkey [pubkey]",
 		Short: "Decode a ED25519 pubkey from hex, base64, or bech32",
@@ -77,9 +75,11 @@ func PubkeyCmd(cdc *codec.Codec) *cobra.Command {
 Example:
 $ %s debug pubkey TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
 $ %s debug pubkey cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
-			`, version.ClientName, version.ClientName),
+			`, version.AppName, version.AppName),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+
 			pk, err := getPubKeyFromString(args[0])
 			if err != nil {
 				return err
@@ -90,7 +90,7 @@ $ %s debug pubkey cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
 				return fmt.Errorf("invalid pubkey type; expected ED25519")
 			}
 
-			pubKeyJSONBytes, err := cdc.MarshalJSON(edPK)
+			pubKeyJSONBytes, err := clientCtx.JSONMarshaler.MarshalJSON(edPK)
 			if err != nil {
 				return err
 			}
@@ -127,7 +127,7 @@ func AddrCmd() *cobra.Command {
 
 Example:
 $ %s debug addr cosmos1e0jnq2sun3dzjh8p2xq95kk0expwmd7shwjpfg
-			`, version.ClientName),
+			`, version.AppName),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 
@@ -171,7 +171,7 @@ func RawBytesCmd() *cobra.Command {
 
 Example:
 $ %s debug raw-bytes [72 101 108 108 111 44 32 112 108 97 121 103 114 111 117 110 100]
-			`, version.ClientName),
+			`, version.AppName),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			stringBytes := args[0]

server/export.go

@@ -10,6 +10,7 @@ import (
 	"github.com/spf13/cobra"
 	tmtypes "github.com/tendermint/tendermint/types"
 
+	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -22,12 +23,16 @@ const (
 )
 
 // ExportCmd dumps app state to JSON.
-func ExportCmd(ctx *Context, cdc codec.JSONMarshaler, appExporter AppExporter) *cobra.Command {
+func ExportCmd(appExporter AppExporter) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "export",
 		Short: "Export state to JSON",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			config := ctx.Config
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			cdc := clientCtx.JSONMarshaler
+
+			serverCtx := GetServerContextFromCmd(cmd)
+			config := serverCtx.Config
 
 			homeDir, _ := cmd.Flags().GetString(flags.FlagHome)
 			config.SetRoot(homeDir)
@@ -61,12 +66,12 @@ func ExportCmd(ctx *Context, cdc codec.JSONMarshaler, appExporter AppExporter) *
 			forZeroHeight, _ := cmd.Flags().GetBool(flagForZeroHeight)
 			jailWhiteList, _ := cmd.Flags().GetStringSlice(flagJailWhitelist)
 
-			appState, validators, cp, err := appExporter(ctx.Logger, db, traceWriter, height, forZeroHeight, jailWhiteList)
+			appState, validators, cp, err := appExporter(serverCtx.Logger, db, traceWriter, height, forZeroHeight, jailWhiteList)
 			if err != nil {
 				return fmt.Errorf("error exporting state: %v", err)
 			}
 
-			doc, err := tmtypes.GenesisDocFromFile(ctx.Config.GenesisFile())
+			doc, err := tmtypes.GenesisDocFromFile(serverCtx.Config.GenesisFile())
 			if err != nil {
 				return err
 			}

server/export_test.go

@@ -2,6 +2,7 @@ package server
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -16,6 +17,7 @@ import (
 	tmtypes "github.com/tendermint/tendermint/types"
 	dbm "github.com/tendermint/tm-db"
 
+	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/simapp"
@@ -36,11 +38,13 @@ func TestExportCmd_ConsensusParams(t *testing.T) {
 	db := dbm.NewMemDB()
 	app := simapp.NewSimApp(log.NewTMLogger(log.NewSyncWriter(os.Stdout)), db, nil, true, map[int64]bool{}, tempDir, 0)
 
-	ctx := NewDefaultContext()
-	ctx.Config.RootDir = tempDir
+	serverCtx := NewDefaultContext()
+	serverCtx.Config.RootDir = tempDir
+
+	clientCtx := client.Context{}.WithJSONMarshaler(app.Codec())
 
 	genDoc := newDefaultGenesisDoc(app.Codec())
-	err = saveGenesisFile(genDoc, ctx.Config.GenesisFile())
+	err = saveGenesisFile(genDoc, serverCtx.Config.GenesisFile())
 
 	app.InitChain(
 		abci.RequestInitChain{
@@ -53,16 +57,18 @@ func TestExportCmd_ConsensusParams(t *testing.T) {
 	app.Commit()
 
 	cmd := ExportCmd(
-		ctx,
-		app.Codec(),
 		func(logger log.Logger, db dbm.DB, writer io.Writer, i int64, b bool, strings []string) (json.RawMessage, []tmtypes.GenesisValidator, *abci.ConsensusParams, error) {
 			return app.ExportAppStateAndValidators(true, []string{})
 		})
 
+	ctx := context.Background()
+	ctx = context.WithValue(ctx, client.ClientContextKey, &clientCtx)
+	ctx = context.WithValue(ctx, ServerContextKey, serverCtx)
+
 	output := &bytes.Buffer{}
 	cmd.SetOut(output)
 	cmd.SetArgs([]string{fmt.Sprintf("--%s=%s", flags.FlagHome, tempDir)})
-	require.NoError(t, cmd.Execute())
+	require.NoError(t, cmd.ExecuteContext(ctx))
 
 	var exportedGenDoc tmtypes.GenesisDoc
 	err = app.Codec().UnmarshalJSON(output.Bytes(), &exportedGenDoc)

server/start.go

@@ -48,7 +48,7 @@ const (
 
 // StartCmd runs the service passed in, either stand-alone or in-process with
 // Tendermint.
-func StartCmd(ctx *Context, cdc codec.JSONMarshaler, appCreator AppCreator) *cobra.Command {
+func StartCmd(appCreator AppCreator) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "start",
 		Short: "Run the full node",
@@ -74,20 +74,29 @@ will not be able to commit subsequent blocks.
 For profiling and benchmarking purposes, CPU profiling can be enabled via the '--cpu-profile' flag
 which accepts a path for the resulting pprof file.
 `,
-		PreRunE: func(cmd *cobra.Command, args []string) error {
-			_, err := GetPruningOptionsFromFlags(ctx.Viper)
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
+			serverCtx := GetServerContextFromCmd(cmd)
+
+			// Bind flags to the Context's Viper so the app construction can set
+			// options accordingly.
+			serverCtx.Viper.BindPFlags(cmd.Flags())
+
+			_, err := GetPruningOptionsFromFlags(serverCtx.Viper)
 			return err
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			serverCtx := GetServerContextFromCmd(cmd)
+			clientCtx := client.GetClientContextFromCmd(cmd)
+
 			withTM, _ := cmd.Flags().GetBool(flagWithTendermint)
 			if !withTM {
-				ctx.Logger.Info("starting ABCI without Tendermint")
-				return startStandAlone(ctx, appCreator)
+				serverCtx.Logger.Info("starting ABCI without Tendermint")
+				return startStandAlone(serverCtx, appCreator)
 			}
 
-			ctx.Logger.Info("starting ABCI with Tendermint")
+			serverCtx.Logger.Info("starting ABCI with Tendermint")
 
-			err := startInProcess(ctx, cdc, appCreator)
+			err := startInProcess(serverCtx, clientCtx.JSONMarshaler, appCreator)
 			return err
 		},
 	}
@@ -109,10 +118,6 @@ which accepts a path for the resulting pprof file.
 	cmd.Flags().Uint64(FlagPruningInterval, 0, "Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom')")
 	cmd.Flags().Uint(FlagInvCheckPeriod, 0, "Assert registered invariants every N blocks")
 
-	// Bind flags to the Context's Viper so the app construction can set options
-	// accordingly.
-	ctx.Viper.BindPFlags(cmd.Flags())
-
 	// add support for all Tendermint-specific command line options
 	tcmd.AddNodeFlags(cmd)
 	return cmd
@@ -147,9 +152,8 @@ func startStandAlone(ctx *Context, appCreator AppCreator) error {
 		tmos.Exit(err.Error())
 	}
 
-	tmos.TrapSignal(ctx.Logger, func() {
-		err = svr.Stop()
-		if err != nil {
+	TrapSignal(func() {
+		if err = svr.Stop(); err != nil {
 			tmos.Exit(err.Error())
 		}
 	})