feat: Update oracle endblocker for historic #

x/oracle/abci.go

@@ -40,6 +40,14 @@ func EndBlocker(ctx sdk.Context, k keeper.Keeper) error {
 		}
 
 		k.ClearExchangeRates(ctx)
+		// // Clear median and median deviations
+		// if isPeriodLastBlock(ctx, params.MedianPeriod) {
+		// 	for _, v := range params.HistoricAcceptList {
+		// 		denom := v.String()
+		// 		k.DeleteMedian(ctx, denom)
+		// 		k.DeleteMedianDeviation(ctx, denom)
+		// 	}
+		// }
 
 		// NOTE: it filters out inactive or jailed validators
 		ballotDenomSlice := k.OrganizeBallotByDenom(ctx, validatorClaimMap)
@@ -56,6 +64,16 @@ func EndBlocker(ctx sdk.Context, k keeper.Keeper) error {
 			if err = k.SetExchangeRateWithEvent(ctx, ballotDenom.Denom, exchangeRate); err != nil {
 				return err
 			}
+
+			// Stamp rate every stamp period if asset is set to have historic stats tracked
+			if isPeriodLastBlock(ctx, params.StampPeriod) && params.HistoricAcceptList.Contains(ballotDenom.Denom) {
+				k.AddHistoricPrice(ctx, ballotDenom.Denom, exchangeRate)
+			}
+
+			// // Set median price every median period if asset is set to have historic stats tracked
+			// if isPeriodLastBlock(ctx, params.MedianPeriod) && params.HistoricAcceptList.Contains(ballotDenom.Denom) {
+			// 	k.CalcAndSetMedian(ctx, ballotDenom.Denom)
+			// }
 		}
 
 		// update miss counting & slashing
@@ -91,6 +109,14 @@ func EndBlocker(ctx sdk.Context, k keeper.Keeper) error {
 		k.SlashAndResetMissCounters(ctx)
 	}
 
+	// Prune historic prices every prune period
+	if isPeriodLastBlock(ctx, params.PrunePeriod) {
+		pruneBlock := uint64(ctx.BlockHeight()) - params.PrunePeriod
+		for _, v := range params.HistoricAcceptList {
+			k.DeleteHistoricPrice(ctx, v.String(), pruneBlock)
+		}
+	}
+
 	return nil
 }
 

x/oracle/keeper/historic_price.go

@@ -200,8 +200,7 @@ func (k Keeper) DeleteHistoricPrice(
 	store.Delete(types.KeyHistoricPrice(denom, blockNum))
 }
 
-// DeleteMedian deletes a given denom's median price in the last prune
-// period since a given block.
+// DeleteMedian deletes a given denom's median price.
 func (k Keeper) DeleteMedian(
 	ctx sdk.Context,
 	denom string,
@@ -211,7 +210,7 @@ func (k Keeper) DeleteMedian(
 }
 
 // DeleteMedianDeviation deletes a given denom's standard deviation around
-// its median price in the last prune period since a given block.
+// its median price.
 func (k Keeper) DeleteMedianDeviation(
 	ctx sdk.Context,
 	denom string,

x/oracle/keeper/historic_price_test.go

@@ -16,13 +16,14 @@ func (s *IntegrationTestSuite) TestSetHistoracle#() {
 	s.Require().NoError(err)
 	s.Require().Equal(rate, sdk.OneDec())
 
-	// add multiple historic prices to store
+	// add multiple historic prices to store and set median each time
 	exchangeRates := []string{"1.0", "1.2", "1.1", "1.4"}
-	for _, exchangeRate := range exchangeRates {
-		app.OracleKeeper.AddHistoricPrice(ctx, displayDenom, sdk.MustNewDecFromStr(exchangeRate))
-
+	for i, exchangeRate := range exchangeRates {
 		// update blockheight
-		ctx = ctx.WithBlockHeight(ctx.BlockHeight() + 1)
+		ctx = ctx.WithBlockHeight(ctx.BlockHeight() + int64(i))
+
+		app.OracleKeeper.AddHistoricPrice(ctx, displayDenom, sdk.MustNewDecFromStr(exchangeRate))
+		app.OracleKeeper.CalcAndSetMedian(ctx, displayDenom)
 	}
 
 	// set and check median and median standard deviation

x/oracle/types/params.go

@@ -194,6 +194,10 @@ func (p Params) Validate() error {
 		return fmt.Errorf("oracle parameter MedianPeriod must be greater than or equal with StampPeriod")
 	}
 
+	if p.StampPeriod%p.VotePeriod != 0 || p.MedianPeriod%p.VotePeriod != 0 || p.PrunePeriod%p.VotePeriod != 0 {
+		return fmt.Errorf("oracle parameters StampPeriod, MedianPeriod, and PrunePeriod must be exact multiples of VotePeiod")
+	}
+
 	for _, denom := range p.AcceptList {
 		if len(denom.BaseDenom) == 0 {
 			return fmt.Errorf("oracle parameter AcceptList Denom must have BaseDenom")

x/oracle/types/params_test.go

@@ -241,21 +241,34 @@ func TestParamsEqual(t *testing.T) {
 	err = p10.Validate()
 	require.Error(t, err)
 
-	// empty name
+	// StampPeriod, MedianPeriod, PrunePeriod are multiples of VotePeriod
 	p11 := DefaultParams()
-	p11.AcceptList[0].BaseDenom = ""
-	p11.AcceptList[0].SymbolDenom = "ATOM"
+	p11.StampPeriod = 10
+	p11.VotePeriod = 3
+	err = p11.Validate()
+	require.Error(t, err)
+	p11.MedianPeriod = 10
+	err = p11.Validate()
+	require.Error(t, err)
+	p11.PrunePeriod = 10
 	err = p11.Validate()
 	require.Error(t, err)
 
-	// empty
+	// empty name
 	p12 := DefaultParams()
-	p12.AcceptList[0].BaseDenom = "uatom"
-	p12.AcceptList[0].SymbolDenom = ""
+	p12.AcceptList[0].BaseDenom = ""
+	p12.AcceptList[0].SymbolDenom = "ATOM"
 	err = p12.Validate()
 	require.Error(t, err)
 
+	// empty
 	p13 := DefaultParams()
-	require.NotNil(t, p13.ParamSetPairs())
-	require.NotNil(t, p13.String())
+	p13.AcceptList[0].BaseDenom = "uatom"
+	p13.AcceptList[0].SymbolDenom = ""
+	err = p13.Validate()
+	require.Error(t, err)
+
+	p14 := DefaultParams()
+	require.NotNil(t, p14.ParamSetPairs())
+	require.NotNil(t, p14.String())
 }