feat: staking config (#10988)

## Description

staking config to remove DefaultPowerReduction global. 

I want to see if this would be accepted as its easier to document and show users how to do this. 



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)

CHANGELOG.md

@@ -140,9 +140,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [\#11124](https://github.com/cosmos/cosmos-sdk/pull/11124) Add `GetAllVersions` to application store
 * (x/authz) [\#10447](https://github.com/cosmos/cosmos-sdk/pull/10447) authz `NewGrant` takes a new argument: block time, to correctly validate expire time.
 * [\#10961](https://github.com/cosmos/cosmos-sdk/pull/10961) Support third-party modules to add extension snapshots to state-sync.
+* [\#10988](https://github.com/cosmos/cosmos-sdk/pull/10988) Removes sdk.PowerReduction as a global and pass it directly to the staking keeper on creation. 
+ - Deletes `types/staking.go` and moves the functions to `x/staking/types/power_reduction.go`
 * [\#11274](https://github.com/cosmos/cosmos-sdk/pull/11274) `types/errors.New` now is an alias for `types/errors.Register` and should only be used in initialization code.
 
-
 ### Client Breaking Changes
 
 * [\#11089](https://github.com/cosmos/cosmos-sdk/pull/11089]) interacting with the node through `grpc.Dial` requires clients to pass a codec refer to [doc](docs/run-node/interact-node.md).

simapp/app.go

@@ -267,8 +267,14 @@ func NewSimApp(
  app.BankKeeper = bankkeeper.NewBaseKeeper(
  appCodec, keys[banktypes.StoreKey], app.AccountKeeper, app.GetSubspace(banktypes.ModuleName), app.ModuleAccountAddrs(),
  )
+
+ stakingConfig := stakingtypes.DefaultConfig()
+ /*
+ Example of setting staking params:
+ stakingConfig.PowerReduction = sdk.NewIntFromUint64(10)
+ */
  stakingKeeper := stakingkeeper.NewKeeper(
- appCodec, keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, app.GetSubspace(stakingtypes.ModuleName),
+ appCodec, keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, app.GetSubspace(stakingtypes.ModuleName), stakingConfig,
  )
  app.MintKeeper = mintkeeper.NewKeeper(
  appCodec, keys[minttypes.StoreKey], app.GetSubspace(minttypes.ModuleName), &stakingKeeper,

simapp/simd/cmd/testnet.go

@@ -282,8 +282,8 @@ func initTestnetFiles(
  return err
  }
 
- accTokens := sdk.TokensFromConsensusPower(1000, sdk.DefaultPowerReduction)
- accStakingTokens := sdk.TokensFromConsensusPower(500, sdk.DefaultPowerReduction)
+ accTokens := sdk.NewIntFromUint64(1000_000_000)
+ accStakingTokens := sdk.NewIntFromUint64(500_000_000)
  coins := sdk.Coins{
  sdk.NewCoin("testtoken", accTokens),
  sdk.NewCoin(sdk.DefaultBondDenom, accStakingTokens),
@@ -292,7 +292,7 @@ func initTestnetFiles(
  genBalances = append(genBalances, banktypes.Balance{Address: addr.String(), Coins: coins.Sort()})
  genAccounts = append(genAccounts, authtypes.NewBaseAccount(addr, nil, 0, 0))
 
- valTokens := sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction)
+ valTokens := sdk.NewIntFromUint64(100_000_000)
  createValMsg, err := stakingtypes.NewMsgCreateValidator(
  sdk.ValAddress(addr),
  valPubKeys[i],

simapp/test_helpers.go

@@ -154,7 +154,7 @@ func genesisStateWithValSet(t *testing.T,
  validators := make([]stakingtypes.Validator, 0, len(valSet.Validators))
  delegations := make([]stakingtypes.Delegation, 0, len(valSet.Validators))
 
- bondAmt := sdk.DefaultPowerReduction
+ bondAmt := stakingtypes.DefaultConfig().PowerReduction
 
  for _, val := range valSet.Validators {
  pk, err := cryptocodec.FromTmPubKeyInterface(val.PubKey)

testutil/network/network.go

@@ -116,9 +116,9 @@ func DefaultConfig() Config {
  NumValidators: 4,
  BondDenom: sdk.DefaultBondDenom,
  MinGasPrices: fmt.Sprintf("0.000006%s", sdk.DefaultBondDenom),
- AccountTokens: sdk.TokensFromConsensusPower(1000, sdk.DefaultPowerReduction),
- StakingTokens: sdk.TokensFromConsensusPower(500, sdk.DefaultPowerReduction),
- BondedTokens: sdk.TokensFromConsensusPower(100, sdk.DefaultPowerReduction),
+ AccountTokens: sdk.NewIntFromUint64(1000_000_000),
+ StakingTokens: sdk.NewIntFromUint64(500_000_000),
+ BondedTokens: sdk.NewIntFromUint64(100_000_000),
  PruningStrategy: storetypes.PruningOptionNothing,
  CleanupDir: true,
  SigningAlgo: string(hd.Secp256k1Type),

testutil/token.go

@@ -0,0 +1,28 @@
+package testutil
+
+import (
+ "math"
+
+ sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+var DefaultpowerReduction = sdk.NewInt(1_000_000)
+
+// TokensToConsensusPower - convert input tokens to Power
+func TokensToConsensusPower(tokens sdk.Int, powerReduction sdk.Int) int64 {
+ if tokens.IsNil() || powerReduction.IsNil() || powerReduction.IsZero() {
+ return 0
+ }
+
+ power := tokens.Quo(powerReduction)
+
+ if power.GT(sdk.NewIntFromUint64(math.MaxInt64)) {
+ return 0
+ }
+ return power.Int64()
+}
+
+// TokensFromConsensusPower - convert input power to tokens
+func TokensFromConsensusPower(power int64, powerReduction sdk.Int) sdk.Int {
+ return sdk.NewInt(power).Mul(powerReduction)
+}

types/staking.go → types/globals.go

@@ -17,16 +17,3 @@ const (
  // https://tendermint.com/docs/spec/abci/apps.html#endblock
  ValidatorUpdateDelay int64 = 1
 )
-
-// DefaultPowerReduction is the default amount of staking tokens required for 1 unit of consensus-engine power
-var DefaultPowerReduction = NewIntFromUint64(1000000)
-
-// TokensToConsensusPower - convert input tokens to potential consensus-engine power
-func TokensToConsensusPower(tokens Int, powerReduction Int) int64 {
- return (tokens.Quo(powerReduction)).Int64()
-}
-
-// TokensFromConsensusPower - convert input power to tokens
-func TokensFromConsensusPower(power int64, powerReduction Int) Int {
- return NewInt(power).Mul(powerReduction)
-}

types/module/module.go

@@ -335,7 +335,7 @@ func (m *Manager) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, genesisData
 
  // a chain must initialize with a non-empty validator set
  if len(validatorUpdates) == 0 {
- panic(fmt.Sprintf("validator set is empty after InitGenesis, please ensure at least one validator is initialized with a delegation greater than or equal to the DefaultPowerReduction (%d)", sdk.DefaultPowerReduction))
+ panic(fmt.Sprintf("validator set is empty after InitGenesis, please ensure at least one validator is initialized with a delegation greater than or equal to the DefaultPowerReduction, found in x/staking/types/config.go"))
  }
 
  return abci.ResponseInitChain{

x/auth/client/testutil/suite.go

@@ -648,7 +648,7 @@ func (s *IntegrationTestSuite) TestCLISendGenerateSignAndBroadcast() {
  account, err := val1.ClientCtx.Keyring.Key("newAccount")
  s.Require().NoError(err)
 
- sendTokens := sdk.NewCoin(s.cfg.BondDenom, sdk.TokensFromConsensusPower(10, sdk.DefaultPowerReduction))
+ sendTokens := sdk.NewCoin(s.cfg.BondDenom, testutil.TokensFromConsensusPower(10, testutil.DefaultpowerReduction))
 
  addr, err := account.GetAddress()
  s.Require().NoError(err)
@@ -849,7 +849,7 @@ func (s *IntegrationTestSuite) TestCLIMultisignInsufficientCosigners() {
 func (s *IntegrationTestSuite) TestCLIEncode() {
  val1 := s.network.Validators[0]
 
- sendTokens := sdk.NewCoin(s.cfg.BondDenom, sdk.TokensFromConsensusPower(10, sdk.DefaultPowerReduction))
+ sendTokens := sdk.NewCoin(s.cfg.BondDenom, testutil.TokensFromConsensusPower(10, testutil.DefaultpowerReduction))
 
  normalGeneratedTx, err := s.createBankMsg(
  val1, val1.Address,

x/auth/migrations/v043/store_test.go

@@ -9,6 +9,7 @@ import (
  tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 
  "github.com/cosmos/cosmos-sdk/simapp"
+ "github.com/cosmos/cosmos-sdk/testutil"
  sdk "github.com/cosmos/cosmos-sdk/types"
  authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
  authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
@@ -657,7 +658,7 @@ func dirtyTrackingFields(ctx sdk.Context, vesting exported.VestingAccount, app *
 }
 
 func createValidator(t *testing.T, ctx sdk.Context, app *simapp.SimApp, powers int64) (sdk.AccAddress, sdk.ValAddress) {
- valTokens := sdk.TokensFromConsensusPower(powers, sdk.DefaultPowerReduction)
+ valTokens := testutil.TokensFromConsensusPower(powers, testutil.DefaultpowerReduction)
  addrs := simapp.AddTestAddrsIncremental(app, ctx, 1, valTokens)
  valAddrs := simapp.ConvertAddrsToValAddrs(addrs)
  pks := simapp.CreateTestPubKeys(1)
@@ -669,6 +670,7 @@ func createValidator(t *testing.T, ctx sdk.Context, app *simapp.SimApp, powers i
  app.AccountKeeper,
  app.BankKeeper,
  app.GetSubspace(stakingtypes.ModuleName),
+ stakingtypes.DefaultConfig(),
  )
 
  val1, err := stakingtypes.NewValidator(valAddrs[0], pks[0], stakingtypes.Description{})

x/bank/keeper/grpc_query_test.go

@@ -4,6 +4,7 @@ import (
  gocontext "context"
  "fmt"
 
+ sdktestutil "github.com/cosmos/cosmos-sdk/testutil"
  "github.com/cosmos/cosmos-sdk/testutil/testdata"
  sdk "github.com/cosmos/cosmos-sdk/types"
  "github.com/cosmos/cosmos-sdk/types/query"
@@ -324,7 +325,7 @@ func (suite *IntegrationTestSuite) TestGRPCDenomOwners() {
 
  bal := sdk.NewCoins(sdk.NewCoin(
  sdk.DefaultBondDenom,
- sdk.TokensFromConsensusPower(initialPower/10, sdk.DefaultPowerReduction),
+ sdktestutil.TokensFromConsensusPower(initialPower/10, sdktestutil.DefaultpowerReduction),
  ))
  suite.Require().NoError(keeper.SendCoinsFromModuleToAccount(ctx, minttypes.ModuleName, acc.GetAddress(), bal))
  }

x/bank/keeper/keeper_test.go

@@ -12,6 +12,7 @@ import (
 
  "github.com/cosmos/cosmos-sdk/baseapp"
  "github.com/cosmos/cosmos-sdk/simapp"
+ sdktestutil "github.com/cosmos/cosmos-sdk/testutil"
  sdk "github.com/cosmos/cosmos-sdk/types"
  "github.com/cosmos/cosmos-sdk/types/query"
  authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
@@ -40,8 +41,7 @@ var (
  randomPermAcc = authtypes.NewEmptyModuleAccount(randomPerm, "random")
 
  // The default power validators are initialized to have within tests
- initTokens = sdk.TokensFromConsensusPower(initialPower, sdk.DefaultPowerReduction)
- initCoins = sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, initTokens))
+ initCoins = sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdktestutil.TokensFromConsensusPower(initialPower, sdktestutil.DefaultpowerReduction)))
 )
 
 func newFooCoin(amt int64) sdk.Coin {

x/bank/types/balance_test.go

@@ -7,6 +7,7 @@ import (
  "github.com/stretchr/testify/require"
 
  "github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
+ "github.com/cosmos/cosmos-sdk/testutil"
  sdk "github.com/cosmos/cosmos-sdk/types"
  bank "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
@@ -141,8 +142,7 @@ func TestBalance_GetAddress(t *testing.T) {
 
 func TestSanitizeBalances(t *testing.T) {
  // 1. Generate balances
- tokens := sdk.TokensFromConsensusPower(81, sdk.DefaultPowerReduction)
- coin := sdk.NewCoin("benchcoin", tokens)
+ coin := sdk.NewCoin("benchcoin", testutil.TokensFromConsensusPower(81, testutil.DefaultpowerReduction))
  coins := sdk.Coins{coin}
  addrs, _ := makeRandomAddressesAndPublicKeys(20)
 
@@ -193,9 +193,7 @@ func BenchmarkSanitizeBalances1000(b *testing.B) {
 
 func benchmarkSanitizeBalances(b *testing.B, nAddresses int) {
  b.ReportAllocs()
- tokens := sdk.TokensFromConsensusPower(81, sdk.DefaultPowerReduction)
- coin := sdk.NewCoin("benchcoin", tokens)
- coins := sdk.Coins{coin}
+ coins := sdk.NewCoins(sdk.NewCoin("benchcoin", testutil.TokensFromConsensusPower(81, testutil.DefaultpowerReduction)))
  addrs, _ := makeRandomAddressesAndPublicKeys(nAddresses)
 
  b.ResetTimer()

x/evidence/keeper/keeper_test.go

@@ -5,20 +5,20 @@ import (
  "fmt"
  "time"
 
- minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
-
  "github.com/stretchr/testify/suite"
  tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 
  "github.com/cosmos/cosmos-sdk/baseapp"
  "github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
  cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
  "github.com/cosmos/cosmos-sdk/simapp"
+ "github.com/cosmos/cosmos-sdk/testutil"
  sdk "github.com/cosmos/cosmos-sdk/types"
  authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
  "github.com/cosmos/cosmos-sdk/x/evidence/exported"
  "github.com/cosmos/cosmos-sdk/x/evidence/keeper"
  "github.com/cosmos/cosmos-sdk/x/evidence/types"
+ minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
 )
 
 var (
@@ -35,7 +35,7 @@ var (
  }
 
  // The default power validators are initialized to have within tests
- initAmt = sdk.TokensFromConsensusPower(200, sdk.DefaultPowerReduction)
+ initAmt = testutil.TokensFromConsensusPower(200, testutil.DefaultpowerReduction)
  initCoins = sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, initAmt))
 )