refactor(staking): change historicalinfo to contain minimal set of data

docs/architecture/adr-017-historical-header-module.md

@@ -4,6 +4,7 @@
 
 * 26 November 2019: Start of first version
 * 2 December 2019: Final draft of first version
+* 7 September 2023: Reduce HistoricalInfo type
 
 ## Context
 
@@ -16,10 +17,11 @@ The application MUST store the most recent `n` headers in a persistent store. At
 The application MUST store this information by storing new headers immediately when handling `abci.RequestBeginBlock`:
 
 ```go
-func BeginBlock(ctx sdk.Context, keeper HistoricalHeaderKeeper, req abci.RequestBeginBlock) abci.ResponseBeginBlock {
+func BeginBlock(ctx sdk.Context, keeper HistoricalHeaderKeeper) error {
   info := HistoricalInfo{
-    Header: ctx.BlockHeader(),
-    ValSet: keeper.StakingKeeper.GetAllValidators(ctx), // note that this must be stored in a canonical order
+    apphash: ctx.HeaderInfo().AppHash,
+    Time: ctx.HeaderInfo().Time,
+    NextValidatorsHash: ctx.CometInfo().NextValidatorsHash,
   }
   keeper.SetHistoricalInfo(ctx, ctx.BlockHeight(), info)
   n := keeper.GetParamRecentHeadersToStore()

proto/cosmos/staking/v1beta1/staking.proto

@@ -23,6 +23,13 @@ message HistoricalInfo {
   repeated Validator      valset = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 }
 
+// Hsitorical is a set of minimum values needed for ibc.
+message Historical {
+  bytes                     apphash             = 1;
+  google.protobuf.Timestamp update_time         = 2 [(gogoproto.stdtime) = true];
+  bytes                     next_validator_hash = 3;
+}
+
 // CommissionRates defines the initial commission rates to be used for creating
 // a validator.
 message CommissionRates {
@@ -220,7 +227,7 @@ message UnbondingDelegation {
   string validator_address = 2 [(cosmos_proto.scalar) = "cosmos.ValidatorAddressString"];
   // entries are the unbonding delegation entries.
   repeated UnbondingDelegationEntry entries = 3
-      [(gogoproto.nullable) = false, (amino.dont_omitempty) = true]; // unbonding delegation entries
+      [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];  // unbonding delegation entries
 }
 
 // UnbondingDelegationEntry defines an unbonding object with relevant metadata.
@@ -293,7 +300,7 @@ message Redelegation {
   string validator_dst_address = 3 [(cosmos_proto.scalar) = "cosmos.ValidatorAddressString"];
   // entries are the redelegation entries.
   repeated RedelegationEntry entries = 4
-      [(gogoproto.nullable) = false, (amino.dont_omitempty) = true]; // redelegation entries
+      [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];  // redelegation entries
 }
 
 // Params defines the parameters for the x/staking module.

x/feegrant/basic_fee_test.go

@@ -4,10 +4,10 @@ import (
 	"testing"
 	"time"
 
-	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"cosmossdk.io/core/header"
 	storetypes "cosmossdk.io/store/types"
 	"cosmossdk.io/x/feegrant"
 
@@ -19,23 +19,23 @@ func TestBasicFeeValidAllow(t *testing.T) {
 	key := storetypes.NewKVStoreKey(feegrant.StoreKey)
 	testCtx := testutil.DefaultContextWithDB(t, key, storetypes.NewTransientStoreKey("transient_test"))
 
-	ctx := testCtx.Ctx.WithBlockHeader(cmtproto.Header{Height: 1})
+	ctx := testCtx.Ctx.WithHeaderInfo(header.Info{Height: 1})
 
-	badTime := ctx.BlockTime().AddDate(0, 0, -1)
+	badTime := ctx.HeaderInfo().Time.AddDate(0, 0, -1)
 	allowace := &feegrant.BasicAllowance{
 		Expiration: &badTime,
 	}
 	require.Error(t, allowace.ValidateBasic())
 
-	ctx = ctx.WithBlockHeader(cmtproto.Header{
+	ctx = ctx.WithHeaderInfo(header.Info{
 		Time: time.Now(),
 	})
 	eth := sdk.NewCoins(sdk.NewInt64Coin("eth", 10))
 	atom := sdk.NewCoins(sdk.NewInt64Coin("atom", 555))
 	smallAtom := sdk.NewCoins(sdk.NewInt64Coin("atom", 43))
 	bigAtom := sdk.NewCoins(sdk.NewInt64Coin("atom", 1000))
 	leftAtom := sdk.NewCoins(sdk.NewInt64Coin("atom", 512))
-	now := ctx.BlockTime()
+	now := ctx.HeaderInfo().Time
 	oneHour := now.Add(1 * time.Hour)
 
 	cases := map[string]struct {

x/staking/keeper/historical_info.go

@@ -3,6 +3,8 @@ package keeper
 import (
 	"context"
 
+	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/staking/types"
 )
@@ -48,7 +50,14 @@ func (k Keeper) TrackHistoricalInfo(ctx context.Context) error {
 		return err
 	}
 
-	historicalEntry := types.NewHistoricalInfo(sdkCtx.BlockHeader(), types.Validators{Validators: lastVals, ValidatorCodec: k.validatorAddressCodec}, k.PowerReduction(ctx))
+	h := cmtproto.Header{
+		Height:             sdkCtx.BlockHeight(),
+		Time:               sdkCtx.HeaderInfo().Time,
+		ChainID:            sdkCtx.HeaderInfo().ChainID,
+		NextValidatorsHash: sdkCtx.CometInfo().GetValidatorsHash(),
+	}
+
+	historicalEntry := types.NewHistoricalInfo(h, types.Validators{Validators: lastVals, ValidatorCodec: k.validatorAddressCodec}, k.PowerReduction(ctx))
 
 	// Set latest HistoricalInfo at current height
 	return k.HistoricalInfo.Set(ctx, uint64(sdkCtx.BlockHeight()), historicalEntry)

x/staking/keeper/historical_info_test.go

@@ -4,6 +4,7 @@ import (
 	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"
 
 	"cosmossdk.io/collections"
+	coreheader "cosmossdk.io/core/header"
 	"cosmossdk.io/math"
 
 	"github.com/cosmos/cosmos-sdk/x/staking/testutil"
@@ -108,7 +109,15 @@ func (s *KeeperTestSuite) TestTrackHistoricalInfo() {
 		ChainID: "HelloChain",
 		Height:  10,
 	}
-	ctx = ctx.WithBlockHeader(header)
+	ctx = ctx.WithHeaderInfo(coreheader.Info{
+		ChainID: "HelloChain",
+		Height:  10,
+	})
+
+	// ctx = ctx.WithCometInfo(comet.BlockInfo{
+	// 	ChainID: "HelloChain",
+	// 	Height:  10,
+	// })
 
 	require.NoError(keeper.TrackHistoricalInfo(ctx))