Add RewardsPerSecond param to x/community module

ci/env/kava-protonet/genesis.json

@@ -1316,7 +1316,8 @@
     },
     "community": {
       "params": {
-        "upgrade_time_disable_inflation": "2023-11-01T00:00:00Z"
+        "upgrade_time_disable_inflation": "2023-11-01T00:00:00Z",
+        "rewards_per_second": "744191"
       }
     },
     "crisis": {

docs/core/proto-docs.md

@@ -2906,6 +2906,7 @@ Params defines the parameters of the community module.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `upgrade_time_disable_inflation` | [google.protobuf.Timestamp](#google.protobuf.Timestamp) |  |  |
+| `rewards_per_second` | [string](#string) |  |  |
 
 
 

proto/kava/community/v1beta1/params.proto

@@ -1,6 +1,7 @@
 syntax = "proto3";
 package kava.community.v1beta1;
 
+import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
 
@@ -12,4 +13,10 @@ message Params {
     (gogoproto.stdtime) = true,
     (gogoproto.nullable) = false
   ];
+
+  string staking_rewards_per_second = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "cosmossdk.io/math.Int",
+    (gogoproto.nullable) = false
+  ];
 }

x/community/genesis_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
+	sdkmath "cosmossdk.io/math"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 
 	"github.com/kava-labs/kava/x/community"
@@ -30,7 +31,10 @@ func (suite *genesisTestSuite) TestInitGenesis() {
 	accountKeeper := suite.App.GetAccountKeeper()
 
 	genesisState := types.NewGenesisState(
-		types.NewParams(time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC)),
+		types.NewParams(
+			time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC),
+			sdkmath.NewInt(1000),
+		),
 	)
 
 	suite.NotPanics(func() {
@@ -49,8 +53,10 @@ func (suite *genesisTestSuite) TestInitGenesis() {
 }
 
 func (suite *genesisTestSuite) TestExportGenesis() {
-
-	params := types.NewParams(time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC))
+	params := types.NewParams(
+		time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC),
+		sdkmath.NewInt(1000),
+	)
 	suite.Keeper.SetParams(suite.Ctx, params)
 
 	genesisState := community.ExportGenesis(suite.Ctx, suite.Keeper)
@@ -60,7 +66,10 @@ func (suite *genesisTestSuite) TestExportGenesis() {
 
 func (suite *genesisTestSuite) TestInitExportIsLossless() {
 	genesisState := types.NewGenesisState(
-		types.NewParams(time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC)),
+		types.NewParams(
+			time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC),
+			sdkmath.NewInt(1000),
+		),
 	)
 
 	community.InitGenesis(suite.Ctx, suite.Keeper, suite.App.GetAccountKeeper(), genesisState)

x/community/keeper/grpc_query_test.go

@@ -34,7 +34,10 @@ func TestGrpcQueryTestSuite(t *testing.T) {
 }
 
 func (suite *grpcQueryTestSuite) TestGrpcQueryParams() {
-	p := types.NewParams(time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC))
+	p := types.NewParams(
+		time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC),
+		sdkmath.NewInt(1000),
+	)
 	suite.Keeper.SetParams(suite.Ctx, p)
 
 	res, err := suite.queryClient.Params(context.Background(), &types.QueryParamsRequest{})

x/community/keeper/params_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 	"time"
 
+	sdkmath "cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/stretchr/testify/suite"
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
@@ -59,7 +60,10 @@ func (suite *StoreTestSuite) TestGetSetParams() {
 	suite.Run("set overwrite previous value", func() {
 		suite.Keeper.SetParams(suite.Ctx, types.DefaultParams())
 
-		params := types.NewParams(time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC))
+		params := types.NewParams(
+			time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC),
+			sdkmath.NewInt(1000),
+		)
 		suite.Keeper.SetParams(suite.Ctx, params)
 
 		storedParams, found := suite.Keeper.GetParams(suite.Ctx)

x/community/types/params.go

@@ -1,26 +1,47 @@
 package types
 
-import "time"
+import (
+	"errors"
+	fmt "fmt"
+	"time"
+
+	sdkmath "cosmossdk.io/math"
+)
 
 var (
 	DefaultUpgradeTimeDisableInflation = time.Time{}
+	// DefaultStakingRewardsPerSecond is ~4.6 KAVA per block, 6.3s block time
+	DefaultStakingRewardsPerSecond = sdkmath.NewInt(744191)
 )
 
 // NewParams returns a new params object
-func NewParams(upgradeTime time.Time) Params {
+func NewParams(
+	upgradeTime time.Time,
+	stakingRewardsPerSecond sdkmath.Int,
+) Params {
 	return Params{
 		UpgradeTimeDisableInflation: upgradeTime,
+		StakingRewardsPerSecond:     stakingRewardsPerSecond,
 	}
 }
 
 // DefaultParams returns default params
 func DefaultParams() Params {
 	return NewParams(
 		DefaultUpgradeTimeDisableInflation,
+		DefaultStakingRewardsPerSecond,
 	)
 }
 
 // Validate checks the params are valid
 func (p Params) Validate() error {
+	if p.StakingRewardsPerSecond.IsNil() {
+		return errors.New("StakingRewardsPerSecond should not be nil")
+	}
+
+	if p.StakingRewardsPerSecond.IsNegative() {
+		return fmt.Errorf("StakingRewardsPerSecond should not be negative: %s", p.StakingRewardsPerSecond)
+	}
+
 	return nil
 }

x/community/types/params_test.go

@@ -0,0 +1,57 @@
+package types_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	sdkmath "cosmossdk.io/math"
+	"github.com/kava-labs/kava/x/community/types"
+)
+
+func TestParamsValidate(t *testing.T) {
+	testCases := []struct {
+		name        string
+		params      types.Params
+		expectedErr string
+	}{
+		{
+			name: "valid parms",
+			params: types.Params{
+				UpgradeTimeDisableInflation: time.Time{},
+				StakingRewardsPerSecond:     sdkmath.NewInt(1000),
+			},
+			expectedErr: "",
+		},
+		{
+			name: "nil rewards per second",
+			params: types.Params{
+				UpgradeTimeDisableInflation: time.Time{},
+				StakingRewardsPerSecond:     sdkmath.Int{},
+			},
+			expectedErr: "StakingRewardsPerSecond should not be nil",
+		},
+		{
+			name: "negative rewards per second",
+			params: types.Params{
+				UpgradeTimeDisableInflation: time.Time{},
+				StakingRewardsPerSecond:     sdkmath.NewInt(-5),
+			},
+			expectedErr: "StakingRewardsPerSecond should not be negative",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			err := tc.params.Validate()
+
+			if tc.expectedErr == "" {
+				require.NoError(t, err)
+			} else {
+				require.Error(t, err)
+				require.Contains(t, err.Error(), tc.expectedErr)
+			}
+		})
+	}
+}