From 10bdf8fa037439006189f1ea917c1f8f754197a4 Mon Sep 17 00:00:00 2001 From: Jae Kwon Date: Tue, 20 Nov 2018 16:44:49 -0800 Subject: [PATCH] Store ConsensusParams to main store --- baseapp/baseapp.go | 107 +++++++++++++------ baseapp/baseapp_test.go | 12 ++- baseapp/options.go | 5 - cmd/gaia/cmd/gaiad/main.go | 13 +-- docs/examples/basecoin/cmd/basecoind/main.go | 3 +- docs/examples/democoin/cmd/democoind/main.go | 5 +- server/constructors.go | 4 +- server/start.go | 9 +- store/rootmultistore.go | 8 +- types/store.go | 1 + 10 files changed, 98 insertions(+), 69 deletions(-) diff --git a/baseapp/baseapp.go b/baseapp/baseapp.go index 34780cfbb..19a5d6dab 100644 --- a/baseapp/baseapp.go +++ b/baseapp/baseapp.go @@ -6,6 +6,7 @@ import ( "runtime/debug" "strings" + "github.com/gogo/protobuf/proto" "github.com/pkg/errors" abci "github.com/tendermint/tendermint/abci/types" @@ -19,11 +20,8 @@ import ( "github.com/cosmos/cosmos-sdk/version" ) -// Key to store the header in the DB itself. -// Use the db directly instead of a store to avoid -// conflicts with handlers writing to the store -// and to avoid affecting the Merkle root. -var dbHeaderKey = []byte("header") +// Key to store the consensus params in the main store. +var mainConsensusParamsKey = []byte("consensus_params") // Enum mode for app.runTx type runTxMode uint8 @@ -48,9 +46,11 @@ type BaseApp struct { queryRouter QueryRouter // router for redirecting query calls txDecoder sdk.TxDecoder // unmarshal []byte into sdk.Tx - anteHandler sdk.AnteHandler // ante handler for fee and auth + // set upon LoadVersion or LoadLatestVersion. + mainKey *sdk.KVStoreKey // Main KVStore in cms // may be nil + anteHandler sdk.AnteHandler // ante handler for fee and auth initChainer sdk.InitChainer // initialize state with validators and state blob beginBlocker sdk.BeginBlocker // logic to run before any txs endBlocker sdk.EndBlocker // logic to run after all txs, and to determine valset changes @@ -66,9 +66,12 @@ type BaseApp struct { deliverState *state // for DeliverTx voteInfos []abci.VoteInfo // absent validators from begin block + // consensus params + // TODO move this in the future to baseapp param store on main store. + consensusParams *abci.ConsensusParams + // spam prevention - minimumFees sdk.Coins - maximumBlockGas uint64 + minimumFees sdk.Coins // flag for sealing sealed bool @@ -78,10 +81,6 @@ var _ abci.Application = (*BaseApp)(nil) // NewBaseApp returns a reference to an initialized BaseApp. // -// TODO: Determine how to use a flexible and robust configuration paradigm that -// allows for sensible defaults while being highly configurable -// (e.g. functional options). -// // NOTE: The db is used to store the version number for now. // Accepts a user-defined txDecoder // Accepts variable number of option functions, which act on the BaseApp to set configuration choices @@ -95,7 +94,6 @@ func NewBaseApp(name string, logger log.Logger, db dbm.DB, txDecoder sdk.TxDecod queryRouter: NewQueryRouter(), txDecoder: txDecoder, } - for _, option := range options { option(app) } @@ -138,21 +136,21 @@ func (app *BaseApp) MountStore(key sdk.StoreKey, typ sdk.StoreType) { } // load latest application version -func (app *BaseApp) LoadLatestVersion(mainKey sdk.StoreKey) error { +func (app *BaseApp) LoadLatestVersion(mainKey *sdk.KVStoreKey) error { err := app.cms.LoadLatestVersion() if err != nil { return err } - return app.initFromStore(mainKey) + return app.initFromMainStore(mainKey) } // load application version -func (app *BaseApp) LoadVersion(version int64, mainKey sdk.StoreKey) error { +func (app *BaseApp) LoadVersion(version int64, mainKey *sdk.KVStoreKey) error { err := app.cms.LoadVersion(version) if err != nil { return err } - return app.initFromStore(mainKey) + return app.initFromMainStore(mainKey) } // the last CommitID of the multistore @@ -166,13 +164,34 @@ func (app *BaseApp) LastBlockHeight() int64 { } // initializes the remaining logic from app.cms -func (app *BaseApp) initFromStore(mainKey sdk.StoreKey) error { +func (app *BaseApp) initFromMainStore(mainKey *sdk.KVStoreKey) error { + // main store should exist. - // TODO: we don't actually need the main store here - main := app.cms.GetKVStore(mainKey) - if main == nil { + mainStore := app.cms.GetKVStore(mainKey) + if mainStore == nil { return errors.New("baseapp expects MultiStore with 'main' KVStore") } + + // memoize mainKey. + if app.mainKey != nil { + panic("app.mainKey expected to be nil; duplicate init?") + } + app.mainKey = mainKey + + // load consensus param from the main store + consensusParamsBz := mainStore.Get(mainConsensusParamsKey) + if consensusParamsBz != nil { + var consensusParams = &abci.ConsensusParams{} + err := proto.Unmarshal(consensusParamsBz, consensusParams) + if err != nil { + panic(err) + } + app.setConsensusParams(consensusParams) + } else { + // It will get saved later during InitChain. + // TODO assert that InitChain hasn't yet been called. + } + // Needed for `gaiad export`, which inits from store but never calls initchain app.setCheckState(abci.Header{}) @@ -184,9 +203,6 @@ func (app *BaseApp) initFromStore(mainKey sdk.StoreKey) error { // SetMinimumFees sets the minimum fees. func (app *BaseApp) SetMinimumFees(fees sdk.Coins) { app.minimumFees = fees } -// SetMaximumBlockGas sets the maximum gas allowable per block. -func (app *BaseApp) SetMaximumBlockGas(gas uint64) { app.maximumBlockGas = gas } - // NewContext returns a new Context with the correct store, the given header, and nil txBytes. func (app *BaseApp) NewContext(isCheckTx bool, header abci.Header) sdk.Context { if isCheckTx { @@ -220,6 +236,30 @@ func (app *BaseApp) setDeliverState(header abci.Header) { } } +// setConsensusParams memoizes the consensus params. +func (app *BaseApp) setConsensusParams(consensusParams *abci.ConsensusParams) { + app.consensusParams = consensusParams +} + +// setConsensusParams stores the consensus params to the main store. +func (app *BaseApp) storeConsensusParams(consensusParams *abci.ConsensusParams) { + consensusParamsBz, err := proto.Marshal(consensusParams) + if err != nil { + panic(err) + } + mainStore := app.cms.GetKVStore(app.mainKey) + mainStore.Set(mainConsensusParamsKey, consensusParamsBz) +} + +// getMaximumBlockGas gets the maximum gas from the consensus params. +func (app *BaseApp) getMaximumBlockGas() (maxGas uint64) { + if app.consensusParams == nil || app.consensusParams.BlockSize == nil { + return 0 + } else { + return uint64(app.consensusParams.BlockSize.MaxGas) + } +} + //______________________________________________________________________________ // ABCI @@ -244,6 +284,13 @@ func (app *BaseApp) SetOption(req abci.RequestSetOption) (res abci.ResponseSetOp // Implements ABCI // InitChain runs the initialization logic directly on the CommitMultiStore. func (app *BaseApp) InitChain(req abci.RequestInitChain) (res abci.ResponseInitChain) { + + // Stash the consensus params in the cms main store and memoize. + if req.ConsensusParams != nil { + app.setConsensusParams(req.ConsensusParams) + app.storeConsensusParams(req.ConsensusParams) + } + // Initialize the deliver state and check state with ChainID and run initChain app.setDeliverState(abci.Header{ChainID: req.ChainId}) app.setCheckState(abci.Header{ChainID: req.ChainId}) @@ -435,8 +482,8 @@ func (app *BaseApp) BeginBlock(req abci.RequestBeginBlock) (res abci.ResponseBeg // add block gas meter var gasMeter sdk.GasMeter - if app.maximumBlockGas > 0 { - gasMeter = sdk.NewGasMeter(app.maximumBlockGas) + if maxGas := app.getMaximumBlockGas(); maxGas > 0 { + gasMeter = sdk.NewGasMeter(maxGas) } else { gasMeter = sdk.NewInfiniteGasMeter() } @@ -733,14 +780,6 @@ func (app *BaseApp) EndBlock(req abci.RequestEndBlock) (res abci.ResponseEndBloc // Implements ABCI func (app *BaseApp) Commit() (res abci.ResponseCommit) { header := app.deliverState.ctx.BlockHeader() - /* - // Write the latest Header to the store - headerBytes, err := proto.Marshal(&header) - if err != nil { - panic(err) - } - app.db.SetSync(dbHeaderKey, headerBytes) - */ // Write the Deliver state and commit the MultiStore app.deliverState.ms.Write() diff --git a/baseapp/baseapp_test.go b/baseapp/baseapp_test.go index 8ea5cbb89..83cecee08 100644 --- a/baseapp/baseapp_test.go +++ b/baseapp/baseapp_test.go @@ -56,7 +56,9 @@ func setupBaseApp(t *testing.T, options ...func(*BaseApp)) *BaseApp { require.Equal(t, t.Name(), app.Name()) // no stores are mounted - require.Panics(t, func() { app.LoadLatestVersion(capKey1) }) + require.Panics(t, func() { + app.LoadLatestVersion(capKey1) + }) app.MountStoresIAVL(capKey1, capKey2) @@ -898,7 +900,13 @@ func TestMaxBlockGasLimits(t *testing.T) { } app := setupBaseApp(t, anteOpt, routerOpt) - app.SetMaximumBlockGas(100) + app.InitChain(abci.RequestInitChain{ + ConsensusParams: &abci.ConsensusParams{ + BlockSize: &abci.BlockSizeParams{ + MaxGas: 100, + }, + }, + }) testCases := []struct { tx *txTest diff --git a/baseapp/options.go b/baseapp/options.go index 7fd95aec8..a6460248d 100644 --- a/baseapp/options.go +++ b/baseapp/options.go @@ -39,11 +39,6 @@ func SetMinimumFees(minFees string) func(*BaseApp) { return func(bap *BaseApp) { bap.SetMinimumFees(fees) } } -// SetMinimumFees returns an option that sets the minimum fees on the app. -func SetMaximumBlockGas(gas uint64) func(*BaseApp) { - return func(bap *BaseApp) { bap.SetMaximumBlockGas(gas) } -} - func (app *BaseApp) SetName(name string) { if app.sealed { panic("SetName() on sealed BaseApp") diff --git a/cmd/gaia/cmd/gaiad/main.go b/cmd/gaia/cmd/gaiad/main.go index ecb906bc7..f3a8309e0 100644 --- a/cmd/gaia/cmd/gaiad/main.go +++ b/cmd/gaia/cmd/gaiad/main.go @@ -13,7 +13,6 @@ import ( "github.com/tendermint/tendermint/libs/cli" dbm "github.com/tendermint/tendermint/libs/db" "github.com/tendermint/tendermint/libs/log" - "github.com/tendermint/tendermint/node" tmtypes "github.com/tendermint/tendermint/types" "github.com/cosmos/cosmos-sdk/cmd/gaia/app" @@ -55,20 +54,10 @@ func main() { } } -func newApp(logger log.Logger, db dbm.DB, - traceStore io.Writer, genDocProvider node.GenesisDocProvider) abci.Application { - - // get the maximum gas from tendermint genesis parameters - genDoc, err := genDocProvider() - if err != nil { - panic(err) - } - maxBlockGas := uint64(genDoc.ConsensusParams.BlockSize.MaxGas) - +func newApp(logger log.Logger, db dbm.DB, traceStore io.Writer) abci.Application { return app.NewGaiaApp(logger, db, traceStore, baseapp.SetPruning(viper.GetString("pruning")), baseapp.SetMinimumFees(viper.GetString("minimum_fees")), - baseapp.SetMaximumBlockGas(maxBlockGas), ) } diff --git a/docs/examples/basecoin/cmd/basecoind/main.go b/docs/examples/basecoin/cmd/basecoind/main.go index 3f257c495..318b36a8f 100644 --- a/docs/examples/basecoin/cmd/basecoind/main.go +++ b/docs/examples/basecoin/cmd/basecoind/main.go @@ -6,7 +6,6 @@ import ( "io" "os" - "github.com/tendermint/tendermint/node" "github.com/tendermint/tendermint/p2p" "github.com/cosmos/cosmos-sdk/baseapp" @@ -121,7 +120,7 @@ func InitCmd(ctx *server.Context, cdc *codec.Codec) *cobra.Command { return cmd } -func newApp(logger log.Logger, db dbm.DB, storeTracer io.Writer, _ node.GenesisDocProvider) abci.Application { +func newApp(logger log.Logger, db dbm.DB, storeTracer io.Writer) abci.Application { return app.NewBasecoinApp(logger, db, baseapp.SetPruning(viper.GetString("pruning"))) } diff --git a/docs/examples/democoin/cmd/democoind/main.go b/docs/examples/democoin/cmd/democoind/main.go index a4feef77c..730109798 100644 --- a/docs/examples/democoin/cmd/democoind/main.go +++ b/docs/examples/democoin/cmd/democoind/main.go @@ -9,7 +9,6 @@ import ( "github.com/cosmos/cosmos-sdk/client" "github.com/spf13/viper" "github.com/tendermint/tendermint/libs/common" - "github.com/tendermint/tendermint/node" "github.com/tendermint/tendermint/p2p" "github.com/spf13/cobra" @@ -125,9 +124,7 @@ func InitCmd(ctx *server.Context, cdc *codec.Codec) *cobra.Command { return cmd } -func newApp(logger log.Logger, db dbm.DB, _ io.Writer, - _ node.GenesisDocProvider) abci.Application { - +func newApp(logger log.Logger, db dbm.DB, _ io.Writer) abci.Application { return app.NewDemocoinApp(logger, db) } diff --git a/server/constructors.go b/server/constructors.go index 4e62239b6..9039d8a81 100644 --- a/server/constructors.go +++ b/server/constructors.go @@ -9,15 +9,13 @@ import ( abci "github.com/tendermint/tendermint/abci/types" dbm "github.com/tendermint/tendermint/libs/db" "github.com/tendermint/tendermint/libs/log" - "github.com/tendermint/tendermint/node" tmtypes "github.com/tendermint/tendermint/types" ) type ( // AppCreator is a function that allows us to lazily initialize an // application using various configurations. - AppCreator func(log.Logger, dbm.DB, - io.Writer, node.GenesisDocProvider) abci.Application + AppCreator func(log.Logger, dbm.DB, io.Writer) abci.Application // AppExporter is a function that dumps all app state to // JSON-serializable structure and returns the current validator set. diff --git a/server/start.go b/server/start.go index d84169ab4..cf39ff71b 100644 --- a/server/start.go +++ b/server/start.go @@ -68,9 +68,7 @@ func startStandAlone(ctx *Context, appCreator AppCreator) error { return err } - cfg := ctx.Config - genDocProvider := node.DefaultGenesisDocProviderFunc(cfg) - app := appCreator(ctx.Logger, db, traceWriter, genDocProvider) + app := appCreator(ctx.Logger, db, traceWriter) svr, err := server.NewServer(addr, "socket", app) if err != nil { @@ -109,8 +107,7 @@ func startInProcess(ctx *Context, appCreator AppCreator) (*node.Node, error) { return nil, err } - genDocProvider := node.DefaultGenesisDocProviderFunc(cfg) - app := appCreator(ctx.Logger, db, traceWriter, genDocProvider) + app := appCreator(ctx.Logger, db, traceWriter) nodeKey, err := p2p.LoadOrGenNodeKey(cfg.NodeKeyFile()) if err != nil { @@ -123,7 +120,7 @@ func startInProcess(ctx *Context, appCreator AppCreator) (*node.Node, error) { pvm.LoadOrGenFilePV(cfg.PrivValidatorFile()), nodeKey, proxy.NewLocalClientCreator(app), - genDocProvider, + node.DefaultGenesisDocProviderFunc(cfg), node.DefaultDBProvider, node.DefaultMetricsProvider(cfg.Instrumentation), ctx.Logger.With("module", "node"), diff --git a/store/rootmultistore.go b/store/rootmultistore.go index cd2d0135f..3faf67a5e 100644 --- a/store/rootmultistore.go +++ b/store/rootmultistore.go @@ -230,13 +230,19 @@ func (rs *rootMultiStore) CacheMultiStore() CacheMultiStore { } // Implements MultiStore. +// If the store does not exist, panics. func (rs *rootMultiStore) GetStore(key StoreKey) Store { - return rs.stores[key] + store := rs.stores[key] + if store == nil { + panic("Could not load store " + key.String()) + } + return store } // GetKVStore implements the MultiStore interface. If tracing is enabled on the // rootMultiStore, a wrapped TraceKVStore will be returned with the given // tracer, otherwise, the original KVStore will be returned. +// If the store does not exist, panics. func (rs *rootMultiStore) GetKVStore(key StoreKey) KVStore { store := rs.stores[key].(KVStore) diff --git a/types/store.go b/types/store.go index 8fe0321f5..c2e57a342 100644 --- a/types/store.go +++ b/types/store.go @@ -64,6 +64,7 @@ type MultiStore interface { //nolint CacheMultiStore() CacheMultiStore // Convenience for fetching substores. + // If the store does not exist, panics. GetStore(StoreKey) Store GetKVStore(StoreKey) KVStore