R4R: Add a flag to export for zero-height start

.circleci/config.yml

@@ -162,6 +162,24 @@ jobs:
  export PATH="$GOBIN:$PATH"
  make test_sim_gaia_import_export
 
+ test_sim_gaia_simulation_after_import:
+ <<: *defaults
+ parallelism: 1
+ steps:
+ - attach_workspace:
+ at: /tmp/workspace
+ - checkout
+ - run:
+ name: dependencies
+ command: |
+ export PATH="$GOBIN:$PATH"
+ make get_vendor_deps
+ - run:
+ name: Test Gaia import/export simulation
+ command: |
+ export PATH="$GOBIN:$PATH"
+ make test_sim_gaia_simulation_after_import
+
  test_sim_gaia_multi_seed:
  <<: *defaults
  parallelism: 1
@@ -301,6 +319,9 @@ workflows:
  - test_sim_gaia_import_export:
  requires:
  - setup_dependencies
+ - test_sim_gaia_simulation_after_import:
+ requires:
+ - setup_dependencies
  - test_sim_gaia_multi_seed:
  requires:
  - setup_dependencies

Makefile

@@ -184,6 +184,10 @@ test_sim_gaia_import_export:
  @echo "Running Gaia import/export simulation. This may take several minutes..."
  @bash scripts/import-export-sim.sh 50
 
+test_sim_gaia_simulation_after_import:
+ @echo "Running Gaia simulation-after-import. This may take several minutes..."
+ @bash scripts/simulation-after-import.sh 50
+
 test_sim_gaia_multi_seed:
  @echo "Running multi-seed Gaia simulation. This may take awhile!"
  @bash scripts/multisim.sh 25

PENDING.md

@@ -44,6 +44,7 @@ FEATURES
  for getting governance parameters.
  * [app] \#2663 - Runtime-assertable invariants
  * [app] \#2791 Support export at a specific height, with `gaiad export --height=HEIGHT`.
+ * [app] \#2812 Support export alterations to prepare for restarting at zero-height
 
 * SDK
  * [simulator] \#2682 MsgEditValidator now looks at the validator's max rate, thus it now succeeds a significant portion of the time

cmd/gaia/app/app.go

@@ -1,7 +1,6 @@
 package app
 
 import (
- "encoding/json"
  "fmt"
  "io"
  "os"
@@ -22,7 +21,6 @@ import (
  cmn "github.com/tendermint/tendermint/libs/common"
  dbm "github.com/tendermint/tendermint/libs/db"
  "github.com/tendermint/tendermint/libs/log"
- tmtypes "github.com/tendermint/tendermint/types"
 )
 
 const (
@@ -218,18 +216,8 @@ func (app *GaiaApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.R
  }
 }
 
-// custom logic for gaia initialization
-func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain {
- stateJSON := req.AppStateBytes
- // TODO is this now the whole genesis file?
-
- var genesisState 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, "")
- }
-
+// initialize store from a genesis state
+func (app *GaiaApp) initFromGenesisState(ctx sdk.Context, genesisState GenesisState) []abci.ValidatorUpdate {
  // sort by account number to maintain consistency
  sort.Slice(genesisState.Accounts, func(i, j int) bool {
  return genesisState.Accounts[i].AccountNumber < genesisState.Accounts[j].AccountNumber
@@ -276,6 +264,22 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci
 
  validators = app.stakeKeeper.ApplyAndReturnValidatorSetUpdates(ctx)
  }
+ return validators
+}
+
+// custom logic for gaia initialization
+func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain {
+ stateJSON := req.AppStateBytes
+ // TODO is this now the whole genesis file?
+
+ var genesisState 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, "")
+ }
+
+ validators := app.initFromGenesisState(ctx, genesisState)
 
  // sanity check
  if len(req.Validators) > 0 {
@@ -292,40 +296,14 @@ func (app *GaiaApp) initChainer(ctx sdk.Context, req abci.RequestInitChain) abci
  }
  }
 
+ // assert runtime invariants
+ app.assertRuntimeInvariants()
+
  return abci.ResponseInitChain{
  Validators: validators,
  }
 }
 
-// export the state of gaia for a genesis file
-func (app *GaiaApp) ExportAppStateAndValidators() (appState json.RawMessage, validators []tmtypes.GenesisValidator, err error) {
- ctx := app.NewContext(true, abci.Header{})
-
- // iterate to get the accounts
- accounts := []GenesisAccount{}
- appendAccount := func(acc auth.Account) (stop bool) {
- account := NewGenesisAccountI(acc)
- accounts = append(accounts, account)
- return false
- }
- app.accountKeeper.IterateAccounts(ctx, appendAccount)
- genState := NewGenesisState(
- accounts,
- auth.ExportGenesis(ctx, app.feeCollectionKeeper),
- stake.ExportGenesis(ctx, app.stakeKeeper),
- mint.ExportGenesis(ctx, app.mintKeeper),
- distr.ExportGenesis(ctx, app.distrKeeper),
- gov.ExportGenesis(ctx, app.govKeeper),
- slashing.ExportGenesis(ctx, app.slashingKeeper),
- )
- appState, err = codec.MarshalJSONIndent(app.cdc, genState)
- if err != nil {
- return nil, nil, err
- }
- validators = stake.WriteValidators(ctx, app.stakeKeeper)
- return appState, validators, nil
-}
-
 // load a particular height
 func (app *GaiaApp) LoadHeight(height int64) error {
  return app.LoadVersion(height, app.keyMain)

cmd/gaia/app/app_test.go

@@ -49,6 +49,6 @@ func TestGaiadExport(t *testing.T) {
 
  // Making a new app object with the db, so that initchain hasn't been called
  newGapp := NewGaiaApp(log.NewTMLogger(log.NewSyncWriter(os.Stdout)), db, nil)
- _, _, err := newGapp.ExportAppStateAndValidators()
+ _, _, err := newGapp.ExportAppStateAndValidators(false)
  require.NoError(t, err, "ExportAppStateAndValidators should not have an error")
 }

cmd/gaia/app/export.go

@@ -0,0 +1,156 @@
+package app
+
+import (
+ "encoding/json"
+ "fmt"
+
+ "github.com/cosmos/cosmos-sdk/codec"
+ sdk "github.com/cosmos/cosmos-sdk/types"
+ "github.com/cosmos/cosmos-sdk/x/auth"
+ distr "github.com/cosmos/cosmos-sdk/x/distribution"
+ "github.com/cosmos/cosmos-sdk/x/gov"
+ "github.com/cosmos/cosmos-sdk/x/mint"
+ "github.com/cosmos/cosmos-sdk/x/slashing"
+ stake "github.com/cosmos/cosmos-sdk/x/stake"
+ abci "github.com/tendermint/tendermint/abci/types"
+ tmtypes "github.com/tendermint/tendermint/types"
+)
+
+// export the state of gaia for a genesis file
+func (app *GaiaApp) ExportAppStateAndValidators(forZeroHeight bool) (
+ appState json.RawMessage, validators []tmtypes.GenesisValidator, err error) {
+
+ // as if they could withdraw from the start of the next block
+ ctx := app.NewContext(true, abci.Header{Height: app.LastBlockHeight()})
+
+ if forZeroHeight {
+ app.prepForZeroHeightGenesis(ctx)
+ }
+
+ // iterate to get the accounts
+ accounts := []GenesisAccount{}
+ appendAccount := func(acc auth.Account) (stop bool) {
+ account := NewGenesisAccountI(acc)
+ accounts = append(accounts, account)
+ return false
+ }
+ app.accountKeeper.IterateAccounts(ctx, appendAccount)
+
+ genState := NewGenesisState(
+ accounts,
+ auth.ExportGenesis(ctx, app.feeCollectionKeeper),
+ stake.ExportGenesis(ctx, app.stakeKeeper),
+ mint.ExportGenesis(ctx, app.mintKeeper),
+ distr.ExportGenesis(ctx, app.distrKeeper),
+ gov.ExportGenesis(ctx, app.govKeeper),
+ slashing.ExportGenesis(ctx, app.slashingKeeper),
+ )
+ appState, err = codec.MarshalJSONIndent(app.cdc, genState)
+ if err != nil {
+ return nil, nil, err
+ }
+ validators = stake.WriteValidators(ctx, app.stakeKeeper)
+ return appState, validators, nil
+}
+
+// prepare for fresh start at zero height
+func (app *GaiaApp) prepForZeroHeightGenesis(ctx sdk.Context) {
+
+ /* TODO XXX check some invariants */
+
+ height := ctx.BlockHeight()
+
+ valAccum := sdk.ZeroDec()
+ vdiIter := func(_ int64, vdi distr.ValidatorDistInfo) bool {
+ lastValPower := app.stakeKeeper.GetLastValidatorPower(ctx, vdi.OperatorAddr)
+ valAccum = valAccum.Add(vdi.GetValAccum(height, sdk.NewDecFromInt(lastValPower)))
+ return false
+ }
+ app.distrKeeper.IterateValidatorDistInfos(ctx, vdiIter)
+
+ lastTotalPower := sdk.NewDecFromInt(app.stakeKeeper.GetLastTotalPower(ctx))
+ totalAccum := app.distrKeeper.GetFeePool(ctx).GetTotalValAccum(height, lastTotalPower)
+
+ if !totalAccum.Equal(valAccum) {
+ panic(fmt.Errorf("validator accum invariance: \n\tfee pool totalAccum: %v"+
+ "\n\tvalidator accum \t%v\n", totalAccum.String(), valAccum.String()))
+ }
+
+ fmt.Printf("accum invariant ok!\n")
+
+ /* END TODO XXX */
+
+ /* Handle fee distribution state. */
+
+ // withdraw all delegator & validator rewards
+ vdiIter = func(_ int64, valInfo distr.ValidatorDistInfo) (stop bool) {
+ err := app.distrKeeper.WithdrawValidatorRewardsAll(ctx, valInfo.OperatorAddr)
+ if err != nil {
+ panic(err)
+ }
+ return false
+ }
+ app.distrKeeper.IterateValidatorDistInfos(ctx, vdiIter)
+
+ ddiIter := func(_ int64, distInfo distr.DelegationDistInfo) (stop bool) {
+ err := app.distrKeeper.WithdrawDelegationReward(
+ ctx, distInfo.DelegatorAddr, distInfo.ValOperatorAddr)
+ if err != nil {
+ panic(err)
+ }
+ return false
+ }
+ app.distrKeeper.IterateDelegationDistInfos(ctx, ddiIter)
+
+ // delete all distribution infos
+ // these will be recreated in InitGenesis
+ app.distrKeeper.RemoveValidatorDistInfos(ctx)
+ app.distrKeeper.RemoveDelegationDistInfos(ctx)
+
+ // assert that the fee pool is empty
+ feePool := app.distrKeeper.GetFeePool(ctx)
+ if !feePool.TotalValAccum.Accum.IsZero() {
+ panic("unexpected leftover validator accum")
+ }
+ bondDenom := app.stakeKeeper.GetParams(ctx).BondDenom
+ if !feePool.ValPool.AmountOf(bondDenom).IsZero() {
+ panic(fmt.Sprintf("unexpected leftover validator pool coins: %v",
+ feePool.ValPool.AmountOf(bondDenom).String()))
+ }
+
+ // reset fee pool height, save fee pool
+ feePool.TotalValAccum.UpdateHeight = 0
+ app.distrKeeper.SetFeePool(ctx, feePool)
+
+ /* Handle stake state. */
+
+ // iterate through validators by power descending, reset bond height, update bond intra-tx counter
+ store := ctx.KVStore(app.keyStake)
+ iter := sdk.KVStoreReversePrefixIterator(store, stake.ValidatorsByPowerIndexKey)
+ counter := int16(0)
+ for ; iter.Valid(); iter.Next() {
+ addr := sdk.ValAddress(iter.Value())
+ validator, found := app.stakeKeeper.GetValidator(ctx, addr)
+ if !found {
+ panic("expected validator, not found")
+ }
+ validator.BondHeight = 0
+ validator.BondIntraTxCounter = counter
+ validator.UnbondingHeight = 0
+ app.stakeKeeper.SetValidator(ctx, validator)
+ counter++
+ }
+ iter.Close()
+
+ /* Handle slashing state. */
+
+ // we have to clear the slashing periods, since they reference heights
+ app.slashingKeeper.DeleteValidatorSlashingPeriods(ctx)
+
+ // reset start height on signing infos
+ app.slashingKeeper.IterateValidatorSigningInfos(ctx, func(addr sdk.ConsAddress, info slashing.ValidatorSigningInfo) (stop bool) {
+ info.StartHeight = 0
+ app.slashingKeeper.SetValidatorSigningInfo(ctx, addr, info)
+ return false
+ })
+}