refactor: moving avg period and shift to oracle genesis (#2117)

* WIP: moving avg period and shift to oracle genesis params

* fix the simulation tests

* fix the tests

* add AvgCounterParams to oracle genesis params

* move historic avg counter params into oracle genesis

* chore: set and get the avg counter params by store util

proto/umee/oracle/v1/genesis.proto

@@ -25,6 +25,11 @@ message GenesisState {
   repeated Price medians          = 7 [(gogoproto.nullable) = false];
   repeated Price historic_prices  = 8 [(gogoproto.nullable) = false];
   repeated Price medianDeviations = 9 [(gogoproto.nullable) = false];
+  // Historic Avg Counter params
+  AvgCounterParams avg_counter_params = 10 [
+    (gogoproto.moretags) = "yaml:\"avg_counter_params\"",
+    (gogoproto.nullable) = false
+  ];
 }
 
 // FeederDelegation is the address for where oracle feeder authority are

proto/umee/oracle/v1/oracle.proto

@@ -3,6 +3,7 @@ package umee.oracle.v1;
 
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
+import "google/protobuf/duration.proto";
 
 option go_package = "github.com/umee-network/umee/v5/x/oracle/types";
 
@@ -57,6 +58,24 @@ message Params {
   uint64 maximum_median_stamps = 12;
 }
 
+// AvgCounterParams - Historic avg counter params
+message AvgCounterParams {
+  // avg_period
+  google.protobuf.Duration avg_period = 1 [
+    (gogoproto.nullable)    = false,
+    (gogoproto.stdduration) = true,
+    (gogoproto.jsontag)     = "avg_period,omitempty",
+    (gogoproto.moretags)    = "yaml:\"avg_period\""
+  ];
+  // avg shift
+  google.protobuf.Duration avg_shift = 2 [
+    (gogoproto.nullable)    = false,
+    (gogoproto.stdduration) = true,
+    (gogoproto.jsontag)     = "avg_shift,omitempty",
+    (gogoproto.moretags)    = "yaml:\"avg_shift\""
+  ];
+}
+
 // Denom - the object to hold configurations of each denom
 message Denom {
   option (gogoproto.equal)            = false;

x/oracle/genesis.go

@@ -71,6 +71,10 @@ func InitGenesis(ctx sdk.Context, keeper keeper.Keeper, genState types.GenesisSt
 	if moduleAcc == nil {
 		panic(fmt.Sprintf("%s module account has not been set", types.ModuleName))
 	}
+
+	// set historic avg counter params (avgPeriod and avgShift)
+	err := keeper.SetHistoricAvgCounterParams(ctx, genState.AvgCounterParams)
+	util.Panic(err)
 }
 
 // ExportGenesis returns the x/oracle module's exported genesis.
@@ -128,6 +132,7 @@ func ExportGenesis(ctx sdk.Context, keeper keeper.Keeper) *types.GenesisState {
 	historicPrices := keeper.AllHistoricPrices(ctx)
 	medianPrices := keeper.AllMedianPrices(ctx)
 	medianDeviationPrices := keeper.AllMedianDeviationPrices(ctx)
+	hacp := keeper.GetHistoricAvgCounterParams(ctx)
 
 	return types.NewGenesisState(
 		params,
@@ -139,5 +144,6 @@ func ExportGenesis(ctx sdk.Context, keeper keeper.Keeper) *types.GenesisState {
 		historicPrices,
 		medianPrices,
 		medianDeviationPrices,
+		hacp,
 	)
 }

x/oracle/genesis_test.go

@@ -200,6 +200,7 @@ func (s *IntegrationTestSuite) TestGenesis_ExportGenesis() {
 			BlockNum: 0,
 		},
 	}
+	hacp := types.DefaultAvgCounterParams()
 
 	genesisState := types.GenesisState{
 		Params:                        params,
@@ -211,6 +212,7 @@ func (s *IntegrationTestSuite) TestGenesis_ExportGenesis() {
 		Medians:                       medians,
 		HistoricPrices:                historicPrices,
 		MedianDeviations:              medianDeviations,
+		AvgCounterParams:              hacp,
 	}
 
 	oracle.InitGenesis(ctx, keeper, genesisState)
@@ -225,4 +227,5 @@ func (s *IntegrationTestSuite) TestGenesis_ExportGenesis() {
 	assert.DeepEqual(s.T(), medians, result.Medians)
 	assert.DeepEqual(s.T(), historicPrices, result.HistoricPrices)
 	assert.DeepEqual(s.T(), medianDeviations, result.MedianDeviations)
+	assert.DeepEqual(s.T(), hacp, result.AvgCounterParams)
 }

x/oracle/keeper/genesis.go

@@ -2,6 +2,7 @@ package keeper
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	storeutil "github.com/umee-network/umee/v5/util/store"
 	"github.com/umee-network/umee/v5/x/oracle/types"
 )
 
@@ -111,3 +112,20 @@ func (k Keeper) AllMedianDeviationPrices(ctx sdk.Context) types.Prices {
 	})
 	return prices
 }
+
+// SetAvgPeSetHistoricAvgCounterParams sets avg period and avg shift time duration
+func (k Keeper) SetHistoricAvgCounterParams(ctx sdk.Context, acp types.AvgCounterParams) error {
+	kvs := ctx.KVStore(k.storeKey)
+	return storeutil.SetObject(kvs, k.cdc, types.KeyHistoricAvgCounterParams, &acp, "historic avg counter params")
+}
+
+// GetHistoricAvgCounterParams gets the avg period and avg shift time duration from store
+func (k Keeper) GetHistoricAvgCounterParams(ctx sdk.Context) types.AvgCounterParams {
+	kvs := ctx.KVStore(k.storeKey)
+	var acp types.AvgCounterParams
+	ok := storeutil.GetObject(kvs, k.cdc, types.KeyHistoricAvgCounterParams, &acp, "historic avg counter params")
+	if ok {
+		return acp
+	}
+	return types.AvgCounterParams{}
+}

x/oracle/keeper/historic_avg.go

@@ -17,7 +17,8 @@ type AvgKeeper struct {
 }
 
 func (k Keeper) AvgKeeper(ctx sdk.Context) AvgKeeper {
-	return AvgKeeper{store: ctx.KVStore(k.storeKey), period: k.AvgPeriod, shift: k.AvgShift}
+	p := k.GetHistoricAvgCounterParams(ctx)
+	return AvgKeeper{store: ctx.KVStore(k.storeKey), period: p.AvgPeriod, shift: p.AvgShift}
 }
 
 func (k AvgKeeper) numCounters() int64 {

x/oracle/keeper/historic_avg_test.go

@@ -37,7 +37,7 @@ func (s AvgKeeperSuite) newAvgKeeper(t *testing.T, period, shift time.Duration)
 }
 
 func (s AvgKeeperSuite) newDefAvgKeeper(t *testing.T) AvgKeeper {
-	return s.newAvgKeeper(t, defaultAvgPeriod, defaultAvgShift)
+	return s.newAvgKeeper(t, types.DefaultAvgPeriod, types.DefaultAvgPeriod)
 }
 
 func (s AvgKeeperSuite) testNewCounters(t *testing.T) {

x/oracle/keeper/keeper.go

@@ -3,7 +3,6 @@ package keeper
 import (
 	"fmt"
 	"strings"
-	"time"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
@@ -21,7 +20,7 @@ var ten = sdk.MustNewDecFromStr("10")
 
 // Keeper of the oracle store
 type Keeper struct {
-	cdc        codec.BinaryCodec
+	cdc        codec.Codec
 	storeKey   storetypes.StoreKey
 	paramSpace paramstypes.Subspace
 
@@ -31,19 +30,11 @@ type Keeper struct {
 	StakingKeeper types.StakingKeeper
 
 	distrName string
-
-	AvgPeriod time.Duration
-	AvgShift  time.Duration
 }
 
-const (
-	defaultAvgPeriod time.Duration = time.Hour * 16
-	defaultAvgShift  time.Duration = time.Hour * 2
-)
-
 // NewKeeper constructs a new keeper for oracle
 func NewKeeper(
-	cdc codec.BinaryCodec,
+	cdc codec.Codec,
 	storeKey storetypes.StoreKey,
 	paramspace paramstypes.Subspace,
 	accountKeeper types.AccountKeeper,
@@ -71,10 +62,6 @@ func NewKeeper(
 		distrKeeper:   distrKeeper,
 		StakingKeeper: stakingKeeper,
 		distrName:     distrName,
-
-		// AvgPeriod and AvgShift must not be changed after an app started.
-		AvgPeriod: defaultAvgPeriod,
-		AvgShift:  defaultAvgShift,
 	}
 }
 

x/oracle/keeper/migrations.go

@@ -35,6 +35,12 @@ func (m Migrator) HistoracleParams3x4(ctx sdk.Context) error {
 	return nil
 }
 
+// SetAvgPeriodAndShift updates the avg shift and period params
+func (m Migrator) SetAvgPeriodAndShift(ctx sdk.Context) error {
+	p := types.DefaultAvgCounterParams()
+	return m.keeper.SetHistoricAvgCounterParams(ctx, p)
+}
+
 // MigrateBNB fixes the BNB base denom for the 4.1 upgrade without using leverage hooks
 func (m Migrator) MigrateBNB(ctx sdk.Context) {
 	badDenom := "ibc/77BCD42E49E5B7E0FC6B269FEBF0185B15044F13F6F38CA285DF0AF883459F40"

x/oracle/simulations/genesis.go

@@ -4,9 +4,11 @@ import (
 	"encoding/json"
 	"fmt"
 	"math/rand"
+	"time"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+	"github.com/cosmos/cosmos-sdk/types/simulation"
 	"github.com/umee-network/umee/v5/x/oracle/types"
 )
 
@@ -23,13 +25,25 @@ const (
 	medianStampPeriodKey        = "median_stamp_period"
 	maximumPriceStampsKey       = "maximum_price_stamps"
 	maximumMedianStampsKey      = "maximum_median_stamps"
+	avgPeriodKey                = "avg_period"
+	avgShiftKey                 = "avg_shift"
 )
 
 // GenVotePeriod produces a randomized VotePeriod in the range of [5, 100]
 func GenVotePeriod(r *rand.Rand) uint64 {
 	return uint64(5 + r.Intn(100))
 }
 
+// GetAvgPeriod produces a randomized AvgPeriod in the range of 1 second to 1 day
+func GetAvgPeriod(r *rand.Rand) time.Duration {
+	return time.Duration(simulation.RandIntBetween(r, 1, 60*60*24)) * time.Second
+}
+
+// GetAvgShift produces a randomized AvgShift in the range of 1 second to 5 hours
+func GetAvgShift(r *rand.Rand) time.Duration {
+	return time.Duration(simulation.RandIntBetween(r, 1, 60*60*5)) * time.Second
+}
+
 // GenVoteThreshold produces a randomized VoteThreshold in the range of [0.34, 0.67]
 func GenVoteThreshold(r *rand.Rand) sdk.Dec {
 	return sdk.NewDecWithPrec(34, 2).Add(sdk.NewDecWithPrec(int64(r.Intn(33)), 2))
@@ -148,7 +162,23 @@ func RandomizedGenState(simState *module.SimulationState) {
 		func(r *rand.Rand) { maximumMedianStamps = GenMaximumMedianStamps(r) },
 	)
 
+	var avgShift time.Duration
+	simState.AppParams.GetOrGenerate(
+		simState.Cdc, avgShiftKey, &avgShift, simState.Rand,
+		func(r *rand.Rand) { avgShift = GetAvgShift(r) },
+	)
+
+	var avgPeriod time.Duration
+	simState.AppParams.GetOrGenerate(
+		simState.Cdc, avgPeriodKey, &avgPeriod, simState.Rand,
+		func(r *rand.Rand) { avgPeriod = GetAvgPeriod(r) },
+	)
+
 	oracleGenesis := types.DefaultGenesisState()
+	oracleGenesis.AvgCounterParams = types.AvgCounterParams{
+		AvgPeriod: avgPeriod,
+		AvgShift:  avgShift,
+	}
 	oracleGenesis.Params = types.Params{
 		VotePeriod:               votePeriod,
 		VoteThreshold:            voteThreshold,

x/oracle/types/genesis.go

@@ -2,6 +2,7 @@ package types
 
 import (
 	"encoding/json"
+	"fmt"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 )
@@ -17,6 +18,7 @@ func NewGenesisState(
 	historicPrices []Price,
 	medianPrices []Price,
 	medianDeviationPrices []Price,
+	acp AvgCounterParams,
 ) *GenesisState {
 	return &GenesisState{
 		Params:                        params,
@@ -28,6 +30,7 @@ func NewGenesisState(
 		HistoricPrices:                historicPrices,
 		Medians:                       medianPrices,
 		MedianDeviations:              medianDeviationPrices,
+		AvgCounterParams:              acp,
 	}
 }
 
@@ -44,12 +47,17 @@ func DefaultGenesisState() *GenesisState {
 		HistoricPrices:                []Price{},
 		Medians:                       []Price{},
 		MedianDeviations:              []Price{},
+		AvgCounterParams:              DefaultAvgCounterParams(),
 	}
 }
 
 // ValidateGenesis validates the oracle genesis state.
 func ValidateGenesis(data *GenesisState) error {
-	return data.Params.Validate()
+	if err := data.Params.Validate(); err != nil {
+		return err
+	}
+
+	return data.AvgCounterParams.Validate()
 }
 
 // GetGenesisStateFromAppState returns x/oracle GenesisState given raw application
@@ -63,3 +71,26 @@ func GetGenesisStateFromAppState(cdc codec.JSONCodec, appState map[string]json.R
 
 	return &genesisState
 }
+
+func DefaultAvgCounterParams() AvgCounterParams {
+	return AvgCounterParams{
+		AvgPeriod: DefaultAvgPeriod, // 16 hours
+		AvgShift:  DefaultAvgShift,  // 12 hours
+	}
+}
+
+func (acp AvgCounterParams) Equal(other *AvgCounterParams) bool {
+	return acp.AvgPeriod == other.AvgPeriod && acp.AvgShift == other.AvgShift
+}
+
+func (acp AvgCounterParams) Validate() error {
+	if acp.AvgPeriod.Seconds() <= 0 {
+		return fmt.Errorf("avg period must be positive: %d", acp.AvgPeriod)
+	}
+
+	if acp.AvgShift.Seconds() <= 0 {
+		return fmt.Errorf("avg shift must be positive: %d", acp.AvgShift)
+	}
+
+	return nil
+}