R4R Client Generalization (+ associated module refactor)

types/config.go

@@ -85,11 +85,13 @@ func (config *Config) SetAddressVerifier(addressVerifier func([]byte) error) {
 	config.addressVerifier = addressVerifier
 }
 
+// TODO
 func (config *Config) SetCoinType(coinType uint32) {
 	config.assertNotSealed()
 	config.coinType = coinType
 }
 
+// TODO
 func (config *Config) SetFullFundraiserPath(fullFundraiserPath string) {
 	config.assertNotSealed()
 	config.fullFundraiserPath = fullFundraiserPath
@@ -144,10 +146,12 @@ func (config *Config) GetAddressVerifier() func([]byte) error {
 	return config.addressVerifier
 }
 
+// TODO
 func (config *Config) GetCoinType() uint32 {
 	return config.coinType
 }
 
+// TODO
 func (config *Config) GetFullFundraiserPath() string {
 	return config.fullFundraiserPath
 }

types/module.go

@@ -22,26 +22,28 @@ ModuleBasicManager.
 package types
 
 import (
+	"context"
 	"encoding/json"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/spf13/cobra"
 	abci "github.com/tendermint/tendermint/abci/types"
 )
 
-// ModuleClient helps modules provide a standard interface for exporting client functionality
-type ModuleClient interface {
-	GetQueryCmd() *cobra.Command
-	GetTxCmd() *cobra.Command
-}
-
 //__________________________________________________________________________________________
 // AppModuleBasic is the standard form for basic non-dependant elements of an application module.
 type AppModuleBasic interface {
 	Name() string
 	RegisterCodec(*codec.Codec)
+
+	// genesis
 	DefaultGenesis() json.RawMessage
 	ValidateGenesis(json.RawMessage) error
+
+	// client functionality
+	RegisterRESTRoutes(context.CLIContext, *mux.Router, *codec.Codec)
+	GetTxCmd() *cobra.Command
+	GetQueryCmd() *cobra.Command
 }
 
 // collections of AppModuleBasic
@@ -77,6 +79,33 @@ func (mbm ModuleBasicManager) ValidateGenesis(genesis map[string]json.RawMessage
 	return nil
 }
 
+// RegisterRestRoutes registers all module rest routes
+func (mbm ModuleBasicManager) RegisterRESTRoutes(
+	ctx context.CLIContext, rtr *mux.Router, cdc *codec.Codec) {
+
+	for _, mb := range mbm {
+		mb.RegisterRESTRoutes(ctx, rtr, cdc)
+	}
+}
+
+// add all tx commands to the rootTxCmd
+func (mbm ModuleBasicManager) AddTxCommands(rootTxCmd *cobra.Command) {
+	for _, mb := range mbm {
+		if cmd := mb.GetTxCmd(); cmd != nil {
+			rootTxCmd.AddCommand(cmd)
+		}
+	}
+}
+
+// add all query commands to the rootQueryCmd
+func (mbm ModuleBasicManager) AddQueryCommands(rootQueryCmd *cobra.Command) {
+	for _, mb := range mbm {
+		if cmd := mb.GetQueryCmd(); cmd != nil {
+			rootQueryCmd.AddCommand(cmd)
+		}
+	}
+}
+
 //_________________________________________________________
 // AppModuleGenesis is the standard form for an application module genesis functions
 type AppModuleGenesis interface {

x/auth/genaccounts/module.go

@@ -3,10 +3,13 @@ package genaccounts
 import (
 	"encoding/json"
 
+	"github.com/spf13/cobra"
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
-	abci "github.com/tendermint/tendermint/abci/types"
 )
 
 var (
@@ -43,6 +46,16 @@ func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
 	return ValidateGenesis(data)
 }
 
+// register rest routes
+func (AppModuleBasic) RegisterRESTRoutes(_ context.CLIContext, _ *mux.Router, _ *codec.Codec) {
+}
+
+// get the root tx command of this module
+func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
+
+// get the root query command of this module
+func (AppModuleBasic) GetQueryCmd() *cobra.Command { return nil }
+
 // extra function from sdk.AppModuleBasic
 // iterate the genesis accounts and perform an operation at each of them
 // - to used by other modules

x/auth/module.go

@@ -3,9 +3,13 @@ package auth
 import (
 	"encoding/json"
 
+	"github.com/spf13/cobra"
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	abci "github.com/tendermint/tendermint/abci/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/client/rest"
 )
 
 var (
@@ -44,6 +48,20 @@ func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
 	return ValidateGenesis(data)
 }
 
+// XXX
+// register rest routes
+func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router, cdc *codec.Codec) {
+	rest.RegisterRoutes(ctx, rtr, cdc, StoreKey)
+}
+
+// TODO
+// get the root tx command of this module
+func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
+
+// TODO
+// get the root query command of this module
+func (AppModuleBasic) GetQueryCmd() *cobra.Command { return nil }
+
 //___________________________
 // app module object
 type AppModule struct {

x/bank/module.go

@@ -3,10 +3,14 @@ package bank
 import (
 	"encoding/json"
 
+	"github.com/spf13/cobra"
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
-	abci "github.com/tendermint/tendermint/abci/types"
+	"github.com/cosmos/cosmos-sdk/x/bank/client/rest"
 )
 
 var (
@@ -47,6 +51,19 @@ func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
 	return ValidateGenesis(data)
 }
 
+// register rest routes
+func RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router, cdc *codec.Codec) {
+	rest.RegisterRoutes(ctx, rtr, cdc, StoreKey)
+}
+
+// TODO
+// get the root tx command of this module
+func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
+
+// TODO
+// get the root query command of this module
+func (AppModuleBasic) GetQueryCmd() *cobra.Command { return nil }
+
 //___________________________
 // app module
 type AppModule struct {

x/crisis/client/cli/tx.go

@@ -4,6 +4,7 @@ package cli
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/client/utils"
 	"github.com/cosmos/cosmos-sdk/codec"
@@ -31,3 +32,16 @@ func GetCmdInvariantBroken(cdc *codec.Codec) *cobra.Command {
 	}
 	return cmd
 }
+
+// GetTxCmd returns the transaction commands for this module
+func GetTxCmd(cdc *amino.Codec) *cobra.Command {
+	txCmd := &cobra.Command{
+		Use:   crisis.ModuleName,
+		Short: "crisis transactions subcommands",
+	}
+
+	txCmd.AddCommand(client.PostCommands(
+		GetCmdInvariantBroken(cdc),
+	)...)
+	return txCmd
+}

x/crisis/module.go

@@ -3,11 +3,14 @@ package crisis
 import (
 	"encoding/json"
 
+	"github.com/spf13/cobra"
+	abci "github.com/tendermint/tendermint/abci/types"
 	"github.com/tendermint/tendermint/libs/log"
 
+	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	abci "github.com/tendermint/tendermint/abci/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/client/cli"
 )
 
 var (
@@ -48,6 +51,20 @@ func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
 	return ValidateGenesis(data)
 }
 
+// register rest routes
+func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router, cdc *codec.Codec) {
+}
+
+// get the root tx command of this module
+func (AppModuleBasic) GetTxCmd() *cobra.Command {
+	return cli.GetTxCmd(moduleCdc)
+}
+
+// get the root query command of this module
+func (AppModuleBasic) GetQueryCmd() *cobra.Command {
+	return nil
+}
+
 //___________________________
 // app module for bank
 type AppModule struct {

x/distribution/client/cli/query.go

@@ -6,7 +6,9 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
+	amino "github.com/tendermint/go-amino"
 
+	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -16,6 +18,25 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/distribution/types"
 )
 
+// GetQueryCmd returns the cli query commands for this module
+func GetQueryCmd(storeKey string, cdc *amino.Codec) *cobra.Command {
+	distQueryCmd := &cobra.Command{
+		Use:   "distr",
+		Short: "Querying commands for the distribution module",
+	}
+
+	distQueryCmd.AddCommand(client.GetCommands(
+		GetCmdQueryParams(storeKey, cdc),
+		GetCmdQueryValidatorOutstandingRewards(storeKey, cdc),
+		GetCmdQueryValidatorCommission(storeKey, cdc),
+		GetCmdQueryValidatorSlashes(storeKey, cdc),
+		GetCmdQueryDelegatorRewards(storeKey, cdc),
+		GetCmdQueryCommunityPool(storeKey, cdc),
+	)...)
+
+	return distQueryCmd
+}
+
 // GetCmdQueryParams implements the query params command.
 func GetCmdQueryParams(queryRoute string, cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{

x/distribution/client/cli/tx.go

@@ -36,13 +36,14 @@ const (
 // GetTxCmd returns the transaction commands for this module
 func GetTxCmd(storeKey string, cdc *amino.Codec) *cobra.Command {
 	distTxCmd := &cobra.Command{
-		Use:   "dist",
+		Use:   "distr",
 		Short: "Distribution transactions subcommands",
 	}
 
 	distTxCmd.AddCommand(client.PostCommands(
 		GetCmdWithdrawRewards(cdc),
 		GetCmdSetWithdrawAddr(cdc),
+		distCmds.GetCmdWithdrawAllRewards(cdc, storeKey),
 	)...)
 
 	return distTxCmd

x/distribution/client/cli/tx_test.go

@@ -1,14 +1,15 @@
 package cli
 
 import (
+	"testing"
+
 	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/cosmos/cosmos-sdk/client/utils"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authtxb "github.com/cosmos/cosmos-sdk/x/auth/client/txbuilder"
 	"github.com/stretchr/testify/assert"
 	"github.com/tendermint/tendermint/crypto/secp256k1"
-	"testing"
 )
 
 func createFakeTxBuilder() authtxb.TxBuilder {
@@ -56,7 +57,7 @@ func Test_splitAndCall_Splitting(t *testing.T) {
 	callCount := 0
 	err := splitAndApply(
 		func(ctx context.CLIContext, txBldr authtxb.TxBuilder, msgs []sdk.Msg) error {
-			callCount += 1
+			callCount++
 
 			assert.NotNil(t, ctx)
 			assert.NotNil(t, txBldr)