From 201908949affa1ed4a104a3108101a47fb29e2fc Mon Sep 17 00:00:00 2001 From: rigelrozanski Date: Mon, 23 Apr 2018 20:05:58 -0400 Subject: [PATCH] stake init overhaul --- cmd/gaia/app/app.go | 146 +++++++++++++++++++----- cmd/gaia/cli_test/cli_test.go | 21 ++-- cmd/gaia/cmd/gaiad/main.go | 2 +- examples/basecoin/app/app.go | 4 +- examples/basecoin/cmd/basecoind/main.go | 2 +- examples/democoin/app/app.go | 4 +- examples/democoin/cmd/democoind/main.go | 7 +- server/init.go | 41 ++++--- server/init_test.go | 5 +- server/start_test.go | 10 +- server/util.go | 6 +- x/stake/handler.go | 3 + x/stake/types.go | 5 +- 13 files changed, 189 insertions(+), 67 deletions(-) diff --git a/cmd/gaia/app/app.go b/cmd/gaia/app/app.go index 61242b039..3eda293d3 100644 --- a/cmd/gaia/app/app.go +++ b/cmd/gaia/app/app.go @@ -2,7 +2,11 @@ package app import ( "encoding/json" + "errors" + "strings" + "github.com/spf13/pflag" + "github.com/spf13/viper" abci "github.com/tendermint/abci/types" crypto "github.com/tendermint/go-crypto" tmtypes "github.com/tendermint/tendermint/types" @@ -133,7 +137,7 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci stateJSON := req.AppStateBytes genesisState := new(GenesisState) - err := json.Unmarshal(stateJSON, genesisState) + err := app.cdc.UnmarshalJSON(stateJSON, genesisState) if err != nil { panic(err) // TODO https://github.com/cosmos/cosmos-sdk/issues/468 // return sdk.ErrGenesisParse("").TraceCause(err, "") @@ -151,7 +155,7 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci return abci.ResponseInitChain{} } -//__________________________________________________________ +//________________________________________________________________________________________ // State to Unmarshal type GenesisState struct { @@ -172,7 +176,7 @@ func NewGenesisAccount(acc *auth.BaseAccount) GenesisAccount { } } -// convert GenesisAccount to GaiaAccount +// convert GenesisAccount to auth.BaseAccount func (ga *GenesisAccount) ToAccount() (acc *auth.BaseAccount) { return &auth.BaseAccount{ Address: ga.Address, @@ -180,44 +184,126 @@ func (ga *GenesisAccount) ToAccount() (acc *auth.BaseAccount) { } } -// XXX func AddPiece +var ( + flagAccounts = "accounts" + flagOWK = "overwrite-keys" +) + +// get app init parameters for server init command +func GaiaAppInit() server.AppInit { + fs := pflag.NewFlagSet("", pflag.ContinueOnError) + fs.String(flagAccounts, "foobar-10fermion,10baz-true", "genesis accounts in form: name1-coins-isval;name2-coins-isval;...") + fs.BoolP(flagOWK, "k", false, "overwrite the for the accounts created, if false and key exists init will fail") + return server.AppInit{ + Flags: fs, + GenAppParams: GaiaGenAppParams, + AppendAppState: GaiaAppendAppState, + } +} // Create the core parameters for genesis initialization for gaia +// note that the pubkey input is this machines pubkey func GaiaGenAppParams(cdc *wire.Codec, pubKey crypto.PubKey) (chainID string, validators []tmtypes.GenesisValidator, appState, cliPrint json.RawMessage, err error) { - // XXX what's the best way to pass around this information? have special flagset defined here? - // add keys to accounts (flag) - // generate X accounts each with X money - // generate X number of validators each bonded with X amount of token - - var addr sdk.Address - var secret string - addr, secret, err = server.GenerateCoinKey() - if err != nil { - return - } - - mm := map[string]string{"secret": secret} - bz, err := cdc.MarshalJSON(mm) - cliPrint = json.RawMessage(bz) - + printMap := make(map[string]string) + var candidates []stake.Candidate + poolAssets := int64(0) chainID = cmn.Fmt("test-chain-%v", cmn.RandStr(6)) - validators = []tmtypes.GenesisValidator{{ - PubKey: pubKey, - Power: 10, - }} + // get genesis flag account information + accountsStr := viper.GetString(flagAccounts) + accounts := strings.Split(accountsStr, ";") + genaccs := make([]GenesisAccount, len(accounts)) + for i, account := range accounts { + p := strings.Split(account, "-") + if len(p) != 3 { + err = errors.New("input account has bad form, each account must be in form name-coins-isval, for example: foobar-10fermion,10baz-true") + return + } + name := p[0] + var coins sdk.Coins + coins, err = sdk.ParseCoins(p[1]) + if err != nil { + return + } + isValidator := false + if p[2] == "true" { + isValidator = true + } - accAuth := auth.NewBaseAccountWithAddress(addr) - accAuth.Coins = sdk.Coins{{"fermion", 100000}} - acc := NewGenesisAccount(&accAuth) - genaccs := []GenesisAccount{acc} + var addr sdk.Address + var secret string + addr, secret, err = server.GenerateCoinKey() + if err != nil { + return + } + + printMap["secret-"+name] = secret + + // create the genesis account + accAuth := auth.NewBaseAccountWithAddress(addr) + accAuth.Coins = coins + acc := NewGenesisAccount(&accAuth) + genaccs[i] = acc + + // add the validator + if isValidator { + + // only use this machines pubkey the first time, all others are dummies + var pk crypto.PubKey + if i == 0 { + pk = pubKey + } else { + pk = crypto.GenPrivKeyEd25519().PubKey() + } + + freePower := int64(100) + validator := tmtypes.GenesisValidator{ + PubKey: pk, + Power: freePower, + } + desc := stake.NewDescription(name, "", "", "") + candidate := stake.NewCandidate(addr, pk, desc) + candidate.Assets = sdk.NewRat(freePower) + poolAssets += freePower + validators = append(validators, validator) + candidates = append(candidates, candidate) + } + } + + // create the print message + bz, err := cdc.MarshalJSON(printMap) + cliPrint = json.RawMessage(bz) + + stakeData := stake.GetDefaultGenesisState() + stakeData.Candidates = candidates + + // assume everything is bonded from the get-go + stakeData.Pool.TotalSupply = poolAssets + stakeData.Pool.BondedShares = sdk.NewRat(poolAssets) genesisState := GenesisState{ Accounts: genaccs, - StakeData: stake.GetDefaultGenesisState(), + StakeData: stakeData, } - appState, err = json.MarshalIndent(genesisState, "", "\t") + appState, err = wire.MarshalJSONIndent(cdc, genesisState) return } + +// append gaia app_state together, stitch the accounts together take the +// staking parameters from the first appState +func GaiaAppendAppState(cdc *wire.Codec, appState1, appState2 json.RawMessage) (appState json.RawMessage, err error) { + var genState1, genState2 GenesisState + err = cdc.UnmarshalJSON(appState1, &genState1) + if err != nil { + panic(err) + } + err = cdc.UnmarshalJSON(appState2, &genState2) + if err != nil { + panic(err) + } + genState1.Accounts = append(genState1.Accounts, genState2.Accounts...) + + return cdc.MarshalJSON(genState1) +} diff --git a/cmd/gaia/cli_test/cli_test.go b/cmd/gaia/cli_test/cli_test.go index 07028ba16..0d4443879 100644 --- a/cmd/gaia/cli_test/cli_test.go +++ b/cmd/gaia/cli_test/cli_test.go @@ -23,7 +23,8 @@ func TestGaiaCLISend(t *testing.T) { pass := "1234567890" executeWrite(t, "gaiacli keys delete foo", pass) executeWrite(t, "gaiacli keys delete bar", pass) - masterKey, chainID := executeInit(t, "gaiad init -o") + keys, chainID := executeInit(t, "gaiad init -o --accounts=foo-100000fermion-true", "foo") + require.Equal(t, 1, len(keys)) // get a free port, also setup some common flags servAddr := server.FreeTCPAddr(t) @@ -33,7 +34,7 @@ func TestGaiaCLISend(t *testing.T) { cmd, _, _ := tests.GoExecuteT(t, fmt.Sprintf("gaiad start --rpc.laddr=%v", servAddr)) defer cmd.Process.Kill() - executeWrite(t, "gaiacli keys add foo --recover", pass, masterKey) + executeWrite(t, "gaiacli keys add foo --recover", pass, keys[0]) executeWrite(t, "gaiacli keys add bar", pass) fooAddr, _ := executeGetAddrPK(t, "gaiacli keys show foo --output=json") @@ -56,7 +57,8 @@ func TestGaiaCLIDeclareCandidacy(t *testing.T) { tests.ExecuteT(t, "gaiad unsafe_reset_all", 1) pass := "1234567890" executeWrite(t, "gaiacli keys delete foo", pass) - masterKey, chainID := executeInit(t, "gaiad init -o") + keys, chainID := executeInit(t, "gaiad init -o --accounts=bar-100000fermion-true;foo-100000fermion-true", "bar", "foo") + require.Equal(t, 2, len(keys)) // get a free port, also setup some common flags servAddr := server.FreeTCPAddr(t) @@ -66,7 +68,7 @@ func TestGaiaCLIDeclareCandidacy(t *testing.T) { cmd, _, _ := tests.GoExecuteT(t, fmt.Sprintf("gaiad start --rpc.laddr=%v", servAddr)) defer cmd.Process.Kill() - executeWrite(t, "gaiacli keys add foo --recover", pass, masterKey) + executeWrite(t, "gaiacli keys add foo --recover", pass, keys[1]) fooAddr, fooPubKey := executeGetAddrPK(t, "gaiacli keys show foo --output=json") fooAcc := executeGetAccount(t, fmt.Sprintf("gaiacli account %v %v", fooAddr, flags)) assert.Equal(t, int64(100000), fooAcc.GetCoins().AmountOf("fermion")) @@ -128,7 +130,7 @@ func executeWritePrint(t *testing.T, cmdStr string, writes ...string) { fmt.Printf("debug read: %v\n", string(bz)) } -func executeInit(t *testing.T, cmdStr string) (masterKey, chainID string) { +func executeInit(t *testing.T, cmdStr string, names ...string) (keys []string, chainID string) { out := tests.ExecuteT(t, cmdStr, 1) var initRes map[string]json.RawMessage @@ -142,8 +144,13 @@ func executeInit(t *testing.T, cmdStr string) (masterKey, chainID string) { err = json.Unmarshal(initRes["app_message"], &appMessageRes) require.NoError(t, err) - err = json.Unmarshal(appMessageRes["secret"], &masterKey) - require.NoError(t, err) + for _, name := range names { + var key string + err = json.Unmarshal(appMessageRes["secret-"+name], &key) + require.NoError(t, err) + keys = append(keys, key) + } + return } diff --git a/cmd/gaia/cmd/gaiad/main.go b/cmd/gaia/cmd/gaiad/main.go index 1637a8085..565cf5ac2 100644 --- a/cmd/gaia/cmd/gaiad/main.go +++ b/cmd/gaia/cmd/gaiad/main.go @@ -24,7 +24,7 @@ func main() { PersistentPreRunE: server.PersistentPreRunEFn(ctx), } - server.AddCommands(ctx, cdc, rootCmd, app.GaiaGenAppParams, generateApp) + server.AddCommands(ctx, cdc, rootCmd, app.GaiaAppInit(), generateApp) // prepare and add flags rootDir := os.ExpandEnv("$HOME/.gaiad") diff --git a/examples/basecoin/app/app.go b/examples/basecoin/app/app.go index b02f21669..ead9c78e3 100644 --- a/examples/basecoin/app/app.go +++ b/examples/basecoin/app/app.go @@ -1,8 +1,6 @@ package app import ( - "encoding/json" - abci "github.com/tendermint/abci/types" cmn "github.com/tendermint/tmlibs/common" dbm "github.com/tendermint/tmlibs/db" @@ -133,7 +131,7 @@ func (app *BasecoinApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) stateJSON := req.AppStateBytes genesisState := new(types.GenesisState) - err := json.Unmarshal(stateJSON, genesisState) + err := app.cdc.UnmarshalJSON(stateJSON, genesisState) if err != nil { panic(err) // TODO https://github.com/cosmos/cosmos-sdk/issues/468 // return sdk.ErrGenesisParse("").TraceCause(err, "") diff --git a/examples/basecoin/cmd/basecoind/main.go b/examples/basecoin/cmd/basecoind/main.go index 02f2c8065..8d14821c6 100644 --- a/examples/basecoin/cmd/basecoind/main.go +++ b/examples/basecoin/cmd/basecoind/main.go @@ -25,7 +25,7 @@ func main() { PersistentPreRunE: server.PersistentPreRunEFn(ctx), } - server.AddCommands(ctx, cdc, rootCmd, server.SimpleGenAppParams, generateApp) + server.AddCommands(ctx, cdc, rootCmd, server.DefaultAppInit, generateApp) // prepare and add flags rootDir := os.ExpandEnv("$HOME/.basecoind") diff --git a/examples/democoin/app/app.go b/examples/democoin/app/app.go index b70f51b5c..8266b2b9b 100644 --- a/examples/democoin/app/app.go +++ b/examples/democoin/app/app.go @@ -1,8 +1,6 @@ package app import ( - "encoding/json" - abci "github.com/tendermint/abci/types" cmn "github.com/tendermint/tmlibs/common" dbm "github.com/tendermint/tmlibs/db" @@ -147,7 +145,7 @@ func (app *DemocoinApp) initChainerFn(coolKeeper cool.Keeper, powKeeper pow.Keep stateJSON := req.AppStateBytes genesisState := new(types.GenesisState) - err := json.Unmarshal(stateJSON, genesisState) + err := app.cdc.UnmarshalJSON(stateJSON, genesisState) if err != nil { panic(err) // TODO https://github.com/cosmos/cosmos-sdk/issues/468 // return sdk.ErrGenesisParse("").TraceCause(err, "") diff --git a/examples/democoin/cmd/democoind/main.go b/examples/democoin/cmd/democoind/main.go index 7cfd55e91..0eb378005 100644 --- a/examples/democoin/cmd/democoind/main.go +++ b/examples/democoin/cmd/democoind/main.go @@ -19,6 +19,11 @@ import ( "github.com/cosmos/cosmos-sdk/wire" ) +// init parameters +var CoolAppInit = server.AppInit{ + GenAppParams: CoolGenAppParams, +} + // coolGenAppParams sets up the app_state and appends the cool app state func CoolGenAppParams(cdc *wire.Codec, pubKey crypto.PubKey) (chainID string, validators []tmtypes.GenesisValidator, appState, cliPrint json.RawMessage, err error) { chainID, validators, appState, cliPrint, err = server.SimpleGenAppParams(cdc, pubKey) @@ -52,7 +57,7 @@ func main() { PersistentPreRunE: server.PersistentPreRunEFn(ctx), } - server.AddCommands(ctx, cdc, rootCmd, CoolGenAppParams, generateApp) + server.AddCommands(ctx, cdc, rootCmd, CoolAppInit, generateApp) // prepare and add flags rootDir := os.ExpandEnv("$HOME/.democoind") diff --git a/server/init.go b/server/init.go index 3e8e0da4a..7e7d895a1 100644 --- a/server/init.go +++ b/server/init.go @@ -11,6 +11,7 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" "github.com/cosmos/cosmos-sdk/wire" "github.com/spf13/cobra" + "github.com/spf13/pflag" "github.com/spf13/viper" crypto "github.com/tendermint/go-crypto" @@ -26,7 +27,7 @@ import ( // TODO flag to retrieve genesis file / config file from a URL? // get cmd to initialize all files for tendermint and application -func InitCmd(ctx *Context, cdc *wire.Codec, gen GenAppParams, appendState AppendAppState) *cobra.Command { +func InitCmd(ctx *Context, cdc *wire.Codec, appInit AppInit) *cobra.Command { flagOverwrite, flagPieceFile := "overwrite", "piece-file" cmd := &cobra.Command{ Use: "init", @@ -37,7 +38,7 @@ func InitCmd(ctx *Context, cdc *wire.Codec, gen GenAppParams, appendState Append config := ctx.Config pubkey := ReadOrCreatePrivValidator(config) - chainID, validators, appState, cliPrint, err := gen(cdc, pubkey) + chainID, validators, appState, cliPrint, err := appInit.GenAppParams(cdc, pubkey) if err != nil { return err } @@ -100,11 +101,12 @@ func InitCmd(ctx *Context, cdc *wire.Codec, gen GenAppParams, appendState Append return nil }, } - if appendState != nil { - cmd.AddCommand(FromPiecesCmd(ctx, cdc, appendState)) + if appInit.AppendAppState != nil { + cmd.AddCommand(FromPiecesCmd(ctx, cdc, appInit)) cmd.Flags().StringP(flagPieceFile, "a", "", "create an append file for others to import") } cmd.Flags().BoolP(flagOverwrite, "o", false, "overwrite the config file") + cmd.Flags().AddFlagSet(appInit.Flags) return cmd } @@ -118,7 +120,7 @@ type GenesisPiece struct { } // get cmd to initialize all files for tendermint and application -func FromPiecesCmd(ctx *Context, cdc *wire.Codec, appendState AppendAppState) *cobra.Command { +func FromPiecesCmd(ctx *Context, cdc *wire.Codec, appInit AppInit) *cobra.Command { return &cobra.Command{ Use: "from-pieces [directory]", Short: "Create genesis from directory of genesis pieces", @@ -142,7 +144,7 @@ func FromPiecesCmd(ctx *Context, cdc *wire.Codec, appendState AppendAppState) *c os.Remove(genFile) // deterministically walk the directory for genesis-piece files to import - filepath.Walk(pieceDir, appendPiece(ctx, cdc, appendState, nodeKeyFile, genFile)) + filepath.Walk(pieceDir, appendPiece(ctx, cdc, appInit, nodeKeyFile, genFile)) return nil }, @@ -150,7 +152,7 @@ func FromPiecesCmd(ctx *Context, cdc *wire.Codec, appendState AppendAppState) *c } // append a genesis-piece -func appendPiece(ctx *Context, cdc *wire.Codec, appendState AppendAppState, nodeKeyFile, genFile string) filepath.WalkFunc { +func appendPiece(ctx *Context, cdc *wire.Codec, appInit AppInit, nodeKeyFile, genFile string) filepath.WalkFunc { return func(pieceFile string, _ os.FileInfo, err error) error { if err != nil { return err @@ -203,7 +205,7 @@ func appendPiece(ctx *Context, cdc *wire.Codec, appendState AppendAppState, node validators = append(validators, piece.Validators...) // combine the app state - appState, err = appendState(cdc, appState, piece.AppState) + appState, err = appInit.AppendAppState(cdc, appState, piece.AppState) if err != nil { return err } @@ -273,17 +275,30 @@ func addAppStateToGenesis(cdc *wire.Codec, genesisConfigPath string, appState js //_____________________________________________________________________ -// GenAppParams creates the core parameters initialization. It takes in a -// pubkey meant to represent the pubkey of the validator of this machine. -type GenAppParams func(*wire.Codec, crypto.PubKey) (chainID string, validators []tmtypes.GenesisValidator, appState, cliPrint json.RawMessage, err error) +// Core functionality passed from the application to the server init command +type AppInit struct { -// append appState1 with appState2 -type AppendAppState func(cdc *wire.Codec, appState1, appState2 json.RawMessage) (appState json.RawMessage, err error) + // flags required for GenAppParams + Flags *pflag.FlagSet + + // GenAppParams creates the core parameters initialization. It takes in a + // pubkey meant to represent the pubkey of the validator of this machine. + GenAppParams func(*wire.Codec, crypto.PubKey) (chainID string, validators []tmtypes.GenesisValidator, appState, cliPrint json.RawMessage, err error) + + // append appState1 with appState2 + AppendAppState func(cdc *wire.Codec, appState1, appState2 json.RawMessage) (appState json.RawMessage, err error) +} + +// simple default application init +var DefaultAppInit = AppInit{ + GenAppParams: SimpleGenAppParams, +} // Create one account with a whole bunch of mycoin in it func SimpleGenAppParams(cdc *wire.Codec, pubKey crypto.PubKey) (chainID string, validators []tmtypes.GenesisValidator, appState, cliPrint json.RawMessage, err error) { var addr sdk.Address + var secret string addr, secret, err = GenerateCoinKey() if err != nil { diff --git a/server/init_test.go b/server/init_test.go index b13fb4789..5db483516 100644 --- a/server/init_test.go +++ b/server/init_test.go @@ -20,7 +20,10 @@ func TestInit(t *testing.T) { require.Nil(t, err) ctx := NewContext(cfg, logger) cdc := wire.NewCodec() - cmd := InitCmd(ctx, cdc, mock.GenAppParams, nil) + appInit := AppInit{ + GenAppParams: mock.GenAppParams, + } + cmd := InitCmd(ctx, cdc, appInit) err = cmd.RunE(nil, nil) require.NoError(t, err) } diff --git a/server/start_test.go b/server/start_test.go index d933d19f1..85f1a7135 100644 --- a/server/start_test.go +++ b/server/start_test.go @@ -27,7 +27,10 @@ func TestStartStandAlone(t *testing.T) { require.Nil(t, err) ctx := NewContext(cfg, logger) cdc := wire.NewCodec() - initCmd := InitCmd(ctx, cdc, mock.GenAppParams, nil) + appInit := AppInit{ + GenAppParams: mock.GenAppParams, + } + initCmd := InitCmd(ctx, cdc, appInit) err = initCmd.RunE(nil, nil) require.NoError(t, err) @@ -54,7 +57,10 @@ func TestStartWithTendermint(t *testing.T) { require.Nil(t, err) ctx := NewContext(cfg, logger) cdc := wire.NewCodec() - initCmd := InitCmd(ctx, cdc, mock.GenAppParams, nil) + appInit := AppInit{ + GenAppParams: mock.GenAppParams, + } + initCmd := InitCmd(ctx, cdc, appInit) err = initCmd.RunE(nil, nil) require.NoError(t, err) diff --git a/server/util.go b/server/util.go index 3f24d5987..ed91f3048 100644 --- a/server/util.go +++ b/server/util.go @@ -67,13 +67,13 @@ func PersistentPreRunEFn(context *Context) func(*cobra.Command, []string) error // add server commands func AddCommands( ctx *Context, cdc *wire.Codec, - rootCmd *cobra.Command, - appState GenAppParams, appCreator AppCreator) { + rootCmd *cobra.Command, appInit AppInit, + appCreator AppCreator) { rootCmd.PersistentFlags().String("log_level", ctx.Config.LogLevel, "Log level") rootCmd.AddCommand( - InitCmd(ctx, cdc, appState, nil), + InitCmd(ctx, cdc, appInit), StartCmd(ctx, appCreator), UnsafeResetAllCmd(ctx), ShowNodeIDCmd(ctx), diff --git a/x/stake/handler.go b/x/stake/handler.go index d9f718fe5..e39720385 100644 --- a/x/stake/handler.go +++ b/x/stake/handler.go @@ -52,6 +52,9 @@ func NewEndBlocker(k Keeper) sdk.EndBlocker { func InitGenesis(ctx sdk.Context, k Keeper, data GenesisState) { k.setPool(ctx, data.Pool) k.setParams(ctx, data.Params) + for _, candidate := range data.Candidates { + k.setCandidate(ctx, candidate) + } } //_____________________________________________________________________ diff --git a/x/stake/types.go b/x/stake/types.go index 8f9e87cbb..634b51186 100644 --- a/x/stake/types.go +++ b/x/stake/types.go @@ -9,8 +9,9 @@ import ( // GenesisState - all staking state that must be provided at genesis type GenesisState struct { - Pool Pool `json:"pool"` - Params Params `json:"params"` + Pool Pool `json:"pool"` + Params Params `json:"params"` + Candidates []Candidate `json:"candidates"` } //_________________________________________________________________________