R4R: Auth Module Param Store

PENDING.md

@@ -30,6 +30,8 @@ FEATURES
 * Gaia
 
 * SDK
+ * \#2996 Update the `AccountKeeper` to contain params used in the context of
+ the ante handler.
 
 * Tendermint
 

cmd/gaia/app/app.go

@@ -90,10 +90,13 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, traceStore io.Writer, baseAppOptio
  tkeyParams: sdk.NewTransientStoreKey("transient_params"),
  }
 
+ app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+
  // define the accountKeeper
  app.accountKeeper = auth.NewAccountKeeper(
  app.cdc,
- app.keyAccount, // target store
+ app.keyAccount, // target store
+ app.paramsKeeper.Subspace(auth.DefaultParamspace),
  auth.ProtoBaseAccount, // prototype
  )
 
@@ -103,10 +106,6 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, traceStore io.Writer, baseAppOptio
  app.cdc,
  app.keyFeeCollection,
  )
- app.paramsKeeper = params.NewKeeper(
- app.cdc,
- app.keyParams, app.tkeyParams,
- )
  stakeKeeper := stake.NewKeeper(
  app.cdc,
  app.keyStake, app.tkeyStake,
@@ -244,7 +243,7 @@ func (app *GaiaApp) initFromGenesisState(ctx sdk.Context, genesisState GenesisSt
  }
 
  // initialize module-specific stores
- auth.InitGenesis(ctx, app.feeCollectionKeeper, genesisState.AuthData)
+ auth.InitGenesis(ctx, app.accountKeeper, app.feeCollectionKeeper, genesisState.AuthData)
  slashing.InitGenesis(ctx, app.slashingKeeper, genesisState.SlashingData, genesisState.StakeData)
  gov.InitGenesis(ctx, app.govKeeper, genesisState.GovData)
  mint.InitGenesis(ctx, app.mintKeeper, genesisState.MintData)

cmd/gaia/app/export.go

@@ -38,7 +38,7 @@ func (app *GaiaApp) ExportAppStateAndValidators(forZeroHeight bool) (
 
  genState := NewGenesisState(
  accounts,
- auth.ExportGenesis(ctx, app.feeCollectionKeeper),
+ auth.ExportGenesis(ctx, app.accountKeeper, app.feeCollectionKeeper),
  stake.ExportGenesis(ctx, app.stakeKeeper),
  mint.ExportGenesis(ctx, app.mintKeeper),
  distr.ExportGenesis(ctx, app.distrKeeper),

cmd/gaia/app/genesis.go

@@ -142,6 +142,7 @@ func GaiaAppGenState(cdc *codec.Codec, genDoc tmtypes.GenesisDoc, appGenTxs []js
 func NewDefaultGenesisState() GenesisState {
  return GenesisState{
  Accounts: nil,
+ AuthData: auth.DefaultGenesisState(),
  StakeData: stake.DefaultGenesisState(),
  MintData: mint.DefaultGenesisState(),
  DistrData: distr.DefaultGenesisState(),

cmd/gaia/cmd/gaiadebug/hack.go

@@ -165,16 +165,18 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseAp
  tkeyParams: sdk.NewTransientStoreKey("transient_params"),
  }
 
+ app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+
  // define the accountKeeper
  app.accountKeeper = auth.NewAccountKeeper(
  app.cdc,
- app.keyAccount, // target store
+ app.keyAccount, // target store
+ app.paramsKeeper.Subspace(auth.DefaultParamspace),
  auth.ProtoBaseAccount, // prototype
  )
 
  // add handlers
  app.bankKeeper = bank.NewBaseKeeper(app.accountKeeper)
- app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
  app.stakeKeeper = stake.NewKeeper(app.cdc, app.keyStake, app.tkeyStake, app.bankKeeper, app.paramsKeeper.Subspace(stake.DefaultParamspace), stake.DefaultCodespace)
  app.slashingKeeper = slashing.NewKeeper(app.cdc, app.keySlashing, app.stakeKeeper, app.paramsKeeper.Subspace(slashing.DefaultParamspace), slashing.DefaultCodespace)
 

docs/examples/basecoin/app/app.go

@@ -11,6 +11,7 @@ import (
  "github.com/cosmos/cosmos-sdk/x/auth"
  "github.com/cosmos/cosmos-sdk/x/bank"
  "github.com/cosmos/cosmos-sdk/x/ibc"
+ "github.com/cosmos/cosmos-sdk/x/params"
  abci "github.com/tendermint/tendermint/abci/types"
  cmn "github.com/tendermint/tendermint/libs/common"
  dbm "github.com/tendermint/tendermint/libs/db"
@@ -40,12 +41,15 @@ type BasecoinApp struct {
  keyMain *sdk.KVStoreKey
  keyAccount *sdk.KVStoreKey
  keyIBC *sdk.KVStoreKey
+ keyParams *sdk.KVStoreKey
+ tkeyParams *sdk.TransientStoreKey
 
  // manage getting and setting accounts
  accountKeeper auth.AccountKeeper
  feeCollectionKeeper auth.FeeCollectionKeeper
  bankKeeper bank.Keeper
  ibcMapper ibc.Mapper
+ paramsKeeper params.Keeper
 }
 
 // NewBasecoinApp returns a reference to a new BasecoinApp given a logger and
@@ -64,12 +68,17 @@ func NewBasecoinApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.Ba
  keyMain: sdk.NewKVStoreKey("main"),
  keyAccount: sdk.NewKVStoreKey("acc"),
  keyIBC: sdk.NewKVStoreKey("ibc"),
+ keyParams: sdk.NewKVStoreKey("params"),
+ tkeyParams: sdk.NewTransientStoreKey("transient_params"),
  }
 
+ app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+
  // define and attach the mappers and keepers
  app.accountKeeper = auth.NewAccountKeeper(
  cdc,
  app.keyAccount, // target store
+ app.paramsKeeper.Subspace(auth.DefaultParamspace),
  func() auth.Account {
  return &types.AppAccount{}
  },

docs/examples/democoin/app/app.go

@@ -16,6 +16,7 @@ import (
  "github.com/cosmos/cosmos-sdk/x/auth"
  "github.com/cosmos/cosmos-sdk/x/bank"
  "github.com/cosmos/cosmos-sdk/x/ibc"
+ "github.com/cosmos/cosmos-sdk/x/params"
 
  "github.com/cosmos/cosmos-sdk/docs/examples/democoin/types"
  "github.com/cosmos/cosmos-sdk/docs/examples/democoin/x/cool"
@@ -45,8 +46,11 @@ type DemocoinApp struct {
  capKeyPowStore *sdk.KVStoreKey
  capKeyIBCStore *sdk.KVStoreKey
  capKeyStakingStore *sdk.KVStoreKey
+ keyParams *sdk.KVStoreKey
+ tkeyParams *sdk.TransientStoreKey
 
  // keepers
+ paramsKeeper params.Keeper
  feeCollectionKeeper auth.FeeCollectionKeeper
  bankKeeper bank.Keeper
  coolKeeper cool.Keeper
@@ -72,13 +76,18 @@ func NewDemocoinApp(logger log.Logger, db dbm.DB) *DemocoinApp {
  capKeyPowStore: sdk.NewKVStoreKey("pow"),
  capKeyIBCStore: sdk.NewKVStoreKey("ibc"),
  capKeyStakingStore: sdk.NewKVStoreKey("stake"),
+ keyParams: sdk.NewKVStoreKey("params"),
+ tkeyParams: sdk.NewTransientStoreKey("transient_params"),
  }
 
+ app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+
  // Define the accountKeeper.
  app.accountKeeper = auth.NewAccountKeeper(
  cdc,
  app.capKeyAccountStore, // target store
- types.ProtoAppAccount, // prototype
+ app.paramsKeeper.Subspace(auth.DefaultParamspace),
+ types.ProtoAppAccount, // prototype
  )
 
  // Add handlers.

docs/examples/democoin/x/cool/keeper_test.go

@@ -13,26 +13,44 @@ import (
  sdk "github.com/cosmos/cosmos-sdk/types"
  auth "github.com/cosmos/cosmos-sdk/x/auth"
  bank "github.com/cosmos/cosmos-sdk/x/bank"
+ "github.com/cosmos/cosmos-sdk/x/params"
 )
 
-func setupMultiStore() (sdk.MultiStore, *sdk.KVStoreKey) {
+type testInput struct {
+ cdc *codec.Codec
+ ctx sdk.Context
+ capKey *sdk.KVStoreKey
+ bk bank.BaseKeeper
+}
+
+func setupTestInput() testInput {
  db := dbm.NewMemDB()
+
+ cdc := codec.New()
+ auth.RegisterBaseAccount(cdc)
+
  capKey := sdk.NewKVStoreKey("capkey")
+ keyParams := sdk.NewKVStoreKey("params")
+ tkeyParams := sdk.NewTransientStoreKey("transient_params")
+
  ms := store.NewCommitMultiStore(db)
  ms.MountStoreWithDB(capKey, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(keyParams, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(tkeyParams, sdk.StoreTypeTransient, db)
  ms.LoadLatestVersion()
- return ms, capKey
+
+ pk := params.NewKeeper(cdc, keyParams, tkeyParams)
+ ak := auth.NewAccountKeeper(cdc, capKey, pk.Subspace(auth.DefaultParamspace), auth.ProtoBaseAccount)
+ bk := bank.NewBaseKeeper(ak)
+ ctx := sdk.NewContext(ms, abci.Header{}, false, nil)
+
+ return testInput{cdc: cdc, ctx: ctx, capKey: capKey, bk: bk}
 }
 
 func TestCoolKeeper(t *testing.T) {
- ms, capKey := setupMultiStore()
- cdc := codec.New()
- auth.RegisterBaseAccount(cdc)
-
- am := auth.NewAccountKeeper(cdc, capKey, auth.ProtoBaseAccount)
- ctx := sdk.NewContext(ms, abci.Header{}, false, nil)
- ck := bank.NewBaseKeeper(am)
- keeper := NewKeeper(capKey, ck, DefaultCodespace)
+ input := setupTestInput()
+ keeper := NewKeeper(input.capKey, input.bk, DefaultCodespace)
+ ctx := input.ctx
 
  err := InitGenesis(ctx, keeper, Genesis{"icy"})
  require.Nil(t, err)

docs/examples/democoin/x/pow/handler_test.go

@@ -5,25 +5,15 @@ import (
 
  "github.com/stretchr/testify/require"
 
- abci "github.com/tendermint/tendermint/abci/types"
- "github.com/tendermint/tendermint/libs/log"
-
- codec "github.com/cosmos/cosmos-sdk/codec"
  sdk "github.com/cosmos/cosmos-sdk/types"
- auth "github.com/cosmos/cosmos-sdk/x/auth"
- bank "github.com/cosmos/cosmos-sdk/x/bank"
 )
 
 func TestPowHandler(t *testing.T) {
- ms, capKey := setupMultiStore()
- cdc := codec.New()
- auth.RegisterBaseAccount(cdc)
+ input := setupTestInput()
+ ctx := input.ctx
 
- am := auth.NewAccountKeeper(cdc, capKey, auth.ProtoBaseAccount)
- ctx := sdk.NewContext(ms, abci.Header{}, false, log.NewNopLogger())
  config := NewConfig("pow", int64(1))
- ck := bank.NewBaseKeeper(am)
- keeper := NewKeeper(capKey, config, ck, DefaultCodespace)
+ keeper := NewKeeper(input.capKey, config, input.bk, DefaultCodespace)
 
  handler := keeper.Handler
 

docs/examples/democoin/x/pow/keeper_test.go

@@ -7,36 +7,52 @@ import (
 
  abci "github.com/tendermint/tendermint/abci/types"
  dbm "github.com/tendermint/tendermint/libs/db"
- "github.com/tendermint/tendermint/libs/log"
 
  "github.com/cosmos/cosmos-sdk/codec"
  "github.com/cosmos/cosmos-sdk/store"
  sdk "github.com/cosmos/cosmos-sdk/types"
  auth "github.com/cosmos/cosmos-sdk/x/auth"
  bank "github.com/cosmos/cosmos-sdk/x/bank"
+ "github.com/cosmos/cosmos-sdk/x/params"
 )
 
-// possibly share this kind of setup functionality between module testsuites?
-func setupMultiStore() (sdk.MultiStore, *sdk.KVStoreKey) {
+type testInput struct {
+ cdc *codec.Codec
+ ctx sdk.Context
+ capKey *sdk.KVStoreKey
+ bk bank.BaseKeeper
+}
+
+func setupTestInput() testInput {
  db := dbm.NewMemDB()
+
+ cdc := codec.New()
+ auth.RegisterBaseAccount(cdc)
+
  capKey := sdk.NewKVStoreKey("capkey")
+ keyParams := sdk.NewKVStoreKey("params")
+ tkeyParams := sdk.NewTransientStoreKey("transient_params")
+
  ms := store.NewCommitMultiStore(db)
  ms.MountStoreWithDB(capKey, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(keyParams, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(tkeyParams, sdk.StoreTypeTransient, db)
  ms.LoadLatestVersion()
 
- return ms, capKey
+ pk := params.NewKeeper(cdc, keyParams, tkeyParams)
+ ak := auth.NewAccountKeeper(cdc, capKey, pk.Subspace(auth.DefaultParamspace), auth.ProtoBaseAccount)
+ bk := bank.NewBaseKeeper(ak)
+ ctx := sdk.NewContext(ms, abci.Header{}, false, nil)
+
+ return testInput{cdc: cdc, ctx: ctx, capKey: capKey, bk: bk}
 }
 
 func TestPowKeeperGetSet(t *testing.T) {
- ms, capKey := setupMultiStore()
- cdc := codec.New()
- auth.RegisterBaseAccount(cdc)
+ input := setupTestInput()
+ ctx := input.ctx
 
- am := auth.NewAccountKeeper(cdc, capKey, auth.ProtoBaseAccount)
- ctx := sdk.NewContext(ms, abci.Header{}, false, log.NewNopLogger())
  config := NewConfig("pow", int64(1))
- ck := bank.NewBaseKeeper(am)
- keeper := NewKeeper(capKey, config, ck, DefaultCodespace)
+ keeper := NewKeeper(input.capKey, config, input.bk, DefaultCodespace)
 
  err := InitGenesis(ctx, keeper, Genesis{uint64(1), uint64(0)})
  require.Nil(t, err)

docs/examples/democoin/x/simplestake/keeper_test.go

@@ -10,34 +10,51 @@ import (
  abci "github.com/tendermint/tendermint/abci/types"
  "github.com/tendermint/tendermint/crypto/ed25519"
  dbm "github.com/tendermint/tendermint/libs/db"
- "github.com/tendermint/tendermint/libs/log"
 
  "github.com/cosmos/cosmos-sdk/codec"
  "github.com/cosmos/cosmos-sdk/store"
  sdk "github.com/cosmos/cosmos-sdk/types"
  "github.com/cosmos/cosmos-sdk/x/auth"
  "github.com/cosmos/cosmos-sdk/x/bank"
+ "github.com/cosmos/cosmos-sdk/x/params"
 )
 
-func setupMultiStore() (sdk.MultiStore, *sdk.KVStoreKey, *sdk.KVStoreKey) {
+type testInput struct {
+ cdc *codec.Codec
+ ctx sdk.Context
+ capKey *sdk.KVStoreKey
+ bk bank.BaseKeeper
+}
+
+func setupTestInput() testInput {
  db := dbm.NewMemDB()
- authKey := sdk.NewKVStoreKey("authkey")
+
+ cdc := codec.New()
+ auth.RegisterBaseAccount(cdc)
+
  capKey := sdk.NewKVStoreKey("capkey")
+ keyParams := sdk.NewKVStoreKey("params")
+ tkeyParams := sdk.NewTransientStoreKey("transient_params")
+
  ms := store.NewCommitMultiStore(db)
  ms.MountStoreWithDB(capKey, sdk.StoreTypeIAVL, db)
- ms.MountStoreWithDB(authKey, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(keyParams, sdk.StoreTypeIAVL, db)
+ ms.MountStoreWithDB(tkeyParams, sdk.StoreTypeTransient, db)
  ms.LoadLatestVersion()
- return ms, authKey, capKey
+
+ pk := params.NewKeeper(cdc, keyParams, tkeyParams)
+ ak := auth.NewAccountKeeper(cdc, capKey, pk.Subspace(auth.DefaultParamspace), auth.ProtoBaseAccount)
+ bk := bank.NewBaseKeeper(ak)
+ ctx := sdk.NewContext(ms, abci.Header{}, false, nil)
+
+ return testInput{cdc: cdc, ctx: ctx, capKey: capKey, bk: bk}
 }
 
 func TestKeeperGetSet(t *testing.T) {
- ms, authKey, capKey := setupMultiStore()
- cdc := codec.New()
- auth.RegisterBaseAccount(cdc)
+ input := setupTestInput()
+ ctx := input.ctx
 
- accountKeeper := auth.NewAccountKeeper(cdc, authKey, auth.ProtoBaseAccount)
- stakeKeeper := NewKeeper(capKey, bank.NewBaseKeeper(accountKeeper), DefaultCodespace)
- ctx := sdk.NewContext(ms, abci.Header{}, false, log.NewNopLogger())
+ stakeKeeper := NewKeeper(input.capKey, input.bk, DefaultCodespace)
  addr := sdk.AccAddress([]byte("some-address"))
 
  bi := stakeKeeper.getBondInfo(ctx, addr)
@@ -59,15 +76,10 @@ func TestKeeperGetSet(t *testing.T) {
 }
 
 func TestBonding(t *testing.T) {
- ms, authKey, capKey := setupMultiStore()
- cdc := codec.New()
- auth.RegisterBaseAccount(cdc)
-
- ctx := sdk.NewContext(ms, abci.Header{}, false, log.NewNopLogger())
+ input := setupTestInput()
+ ctx := input.ctx
 
- accountKeeper := auth.NewAccountKeeper(cdc, authKey, auth.ProtoBaseAccount)
- bankKeeper := bank.NewBaseKeeper(accountKeeper)
- stakeKeeper := NewKeeper(capKey, bankKeeper, DefaultCodespace)
+ stakeKeeper := NewKeeper(input.capKey, input.bk, DefaultCodespace)
  addr := sdk.AccAddress([]byte("some-address"))
  privKey := ed25519.GenPrivKey()
  pubKey := privKey.PubKey()