feat!: introduce epochs

proto/interchain_security/ccv/provider/v1/provider.proto

@@ -188,6 +188,9 @@ message Params {
   // The fee required to be paid to add a reward denom
   cosmos.base.v1beta1.Coin consumer_reward_denom_registration_fee = 9
       [ (gogoproto.nullable) = false ];
+
+  // The number of blocks that comprise an epoch.
+  uint32 blocks_per_epoch = 10;
 }
 
 // SlashAcks contains cons addresses of consumer chain validators
@@ -295,3 +298,17 @@ message ConsumerAddrsToPrune {
   uint64 vsc_id = 2;
   AddressList consumer_addrs = 3;
 }
+
+// EpochValidator is used to facilitate epoch-based transitions. It contains relevant info for
+// a validator that is opted in, in an epoch, on a consumer chain.
+message EpochValidator {
+  // validator's consensus address on the provider chain
+  bytes provider_cons_addr = 1;
+  // The block height the provider chain had when the validator opted in for the first time. If the validator
+  // remains opted in during subsequent epochs, `start_block_height` remains unchanged.
+  int64 start_block_height = 2;
+  // voting power the validator has during this epoch
+  int64 power = 3;
+  // public key the validator uses on the consumer chain during this epoch
+  bytes consumer_public_key = 4;
+}

tests/e2e/actions.go

@@ -1307,6 +1307,9 @@ func (tr TestConfig) relayPacketsGorelayer(
 	target ExecutionTarget,
 	verbose bool,
 ) {
+	tr.waitBlocks(action.ChainA, 3, 90*time.Second)
+	tr.waitBlocks(action.ChainB, 3, 90*time.Second)
+
 	pathName := tr.GetPathNameForGorelayer(action.ChainA, action.ChainB)
 
 	// rly transact relay-packets [path-name] --channel [channel-id]
@@ -1331,6 +1334,9 @@ func (tr TestConfig) relayPacketsHermes(
 	target ExecutionTarget,
 	verbose bool,
 ) {
+	tr.waitBlocks(action.ChainA, 3, 90*time.Second)
+	tr.waitBlocks(action.ChainB, 3, 90*time.Second)
+
 	// hermes clear packets ibc0 transfer channel-13
 	cmd := target.ExecCommand("hermes", "clear", "packets",
 		"--chain", string(tr.chainConfigs[action.ChainA].ChainId),

tests/e2e/config.go

@@ -240,7 +240,8 @@ func SlashThrottleTestConfig() TestConfig {
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
 					".app_state.provider.params.slash_meter_replenish_fraction = \"0.10\" | " +
-					".app_state.provider.params.slash_meter_replenish_period = \"20s\"",
+					".app_state.provider.params.slash_meter_replenish_period = \"20s\" | " +
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("consu"): {
 				ChainId:        ChainID("consu"),
@@ -288,7 +289,8 @@ func DefaultTestConfig() TestConfig {
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
 					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
-					".app_state.provider.params.slash_meter_replenish_period = \"3s\"",
+					".app_state.provider.params.slash_meter_replenish_period = \"3s\" | " +
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("consu"): {
 				ChainId:        ChainID("consu"),
@@ -317,7 +319,8 @@ func DemocracyTestConfig(allowReward bool) TestConfig {
 		".app_state.slashing.params.min_signed_per_window = \"0.500000000000000000\" | " +
 		".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 		".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
-		".app_state.transfer.params.send_enabled = false"
+		".app_state.transfer.params.send_enabled = false | " +
+		".app_state.provider.params.blocks_per_epoch = 3"
 
 	if allowReward {
 		// This allows the consumer chain to send rewards in the stake denom
@@ -347,7 +350,8 @@ func DemocracyTestConfig(allowReward bool) TestConfig {
 					".app_state.slashing.params.min_signed_per_window = \"0.500000000000000000\" | " +
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
-					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\"", // This disables slash packet throttling
+					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("democ"): {
 				ChainId:        ChainID("democ"),
@@ -389,7 +393,8 @@ func MultiConsumerTestConfig() TestConfig {
 					".app_state.slashing.params.min_signed_per_window = \"0.500000000000000000\" | " +
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
-					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\"", // This disables slash packet throttling
+					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("consu"): {
 				ChainId:        ChainID("consu"),
@@ -448,7 +453,8 @@ func ChangeoverTestConfig() TestConfig {
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
 					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
-					".app_state.provider.params.slash_meter_replenish_period = \"3s\"",
+					".app_state.provider.params.slash_meter_replenish_period = \"3s\" | " +
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("sover"): {
 				ChainId:        ChainID("sover"),
@@ -548,7 +554,8 @@ func ConsumerMisbehaviourTestConfig() TestConfig {
 					".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
 					".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
 					".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
-					".app_state.provider.params.slash_meter_replenish_period = \"3s\"",
+					".app_state.provider.params.slash_meter_replenish_period = \"3s\" | " +
+					".app_state.provider.params.blocks_per_epoch = 3",
 			},
 			ChainID("consu"): {
 				ChainId:        ChainID("consu"),

tests/integration/common.go

@@ -128,6 +128,7 @@ func delegateAndRedelegate(s *CCVTestSuite, delAddr sdk.AccAddress,
 	s.Require().Equal(srcValTokensAfter.Sub(srcValTokensBefore), amount)
 
 	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch)
 
 	dstValTokensBefore := s.getVal(s.providerCtx(), dstValAddr).GetBondedTokens()
 
@@ -625,3 +626,10 @@ func (s *CCVTestSuite) mustGetStakingValFromTmVal(tmVal tmtypes.Validator) (stak
 	s.Require().True(found)
 	return stakingVal
 }
+
+// nextBlocks moves `chain` forward by a `numberOfBlocks` blocks
+func nextBlocks(chain *ibctesting.TestChain, numberOfBlocks uint32) {
+	for i := uint32(0); i < numberOfBlocks; i++ {
+		chain.NextBlock()
+	}
+}

tests/integration/distribution.go

@@ -23,7 +23,7 @@ func (s *CCVTestSuite) TestRewardsDistribution() {
 	bondAmt := sdk.NewInt(10000000)
 	delAddr := s.providerChain.SenderAccount.GetAddress()
 	delegate(s, delAddr, bondAmt)
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch)
 
 	// register a consumer reward denom
 	params := s.consumerApp.GetConsumerKeeper().GetConsumerParams(s.consumerCtx())
@@ -124,7 +124,7 @@ func (s *CCVTestSuite) TestSendRewardsRetries() {
 	bondAmt := sdk.NewInt(10000000)
 	delAddr := s.providerChain.SenderAccount.GetAddress()
 	delegate(s, delAddr, bondAmt)
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch)
 
 	// Register denom on consumer chain
 	params := s.consumerApp.GetConsumerKeeper().GetConsumerParams(s.consumerCtx())
@@ -253,6 +253,7 @@ func (s *CCVTestSuite) TestEndBlockRD() {
 		bondAmt := sdk.NewInt(10000000)
 		delAddr := s.providerChain.SenderAccount.GetAddress()
 		delegate(s, delAddr, bondAmt)
+		nextBlocks(s.providerChain, s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch)
 		s.providerChain.NextBlock()
 
 		if tc.denomRegistered {

tests/integration/expired_client.go

@@ -33,15 +33,16 @@ func (s *CCVTestSuite) TestVSCPacketSendExpiredClient() {
 	delegate(s, delAddr, bondAmt)
 
 	// try to send CCV packet to consumer
-	s.providerChain.NextBlock()
+	blocksPerEpoch := s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch
+	nextBlocks(s.providerChain, blocksPerEpoch)
 
 	// check that the packet was added to the list of pending VSC packets
 	packets := providerKeeper.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
 	s.Require().NotEmpty(packets, "no pending VSC packets found")
 	s.Require().Equal(1, len(packets), "unexpected number of pending VSC packets")
 
 	// try again to send CCV packet to consumer
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, blocksPerEpoch)
 
 	// check that the packet is still in the list of pending VSC packets
 	packets = providerKeeper.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
@@ -52,7 +53,7 @@ func (s *CCVTestSuite) TestVSCPacketSendExpiredClient() {
 	delegate(s, delAddr, bondAmt)
 
 	// try again to send CCV packets to consumer
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, blocksPerEpoch)
 
 	// check that the packets are still in the list of pending VSC packets
 	packets = providerKeeper.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
@@ -63,7 +64,7 @@ func (s *CCVTestSuite) TestVSCPacketSendExpiredClient() {
 	upgradeExpiredClient(s, Consumer)
 
 	// go to next block
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, blocksPerEpoch)
 
 	// check that the packets are not in the list of pending VSC packets
 	packets = providerKeeper.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
@@ -73,7 +74,7 @@ func (s *CCVTestSuite) TestVSCPacketSendExpiredClient() {
 	// - bond more tokens on provider to change validator powers
 	delegate(s, delAddr, bondAmt)
 	// - send CCV packet to consumer
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, blocksPerEpoch)
 	// - relay all VSC packet from provider to consumer
 	relayAllCommittedPackets(s, s.providerChain, s.path, ccv.ProviderPortID, s.path.EndpointB.ChannelID, 3)
 	// - increment time so that the unbonding period ends on the consumer
@@ -102,7 +103,8 @@ func (s *CCVTestSuite) TestConsumerPacketSendExpiredClient() {
 	delegate(s, delAddr, bondAmt)
 
 	// send CCV packets to consumer
-	s.providerChain.NextBlock()
+	blocksPerEpoch := s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch
+	nextBlocks(s.providerChain, blocksPerEpoch)
 
 	// check that the packets are not in the list of pending VSC packets
 	providerPackets := providerKeeper.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
@@ -172,7 +174,7 @@ func (s *CCVTestSuite) TestConsumerPacketSendExpiredClient() {
 	// - bond more tokens on provider to change validator powers
 	delegate(s, delAddr, bondAmt)
 	// - send CCV packet to consumer
-	s.providerChain.NextBlock()
+	nextBlocks(s.providerChain, blocksPerEpoch)
 	// - relay 1 VSC packet from provider to consumer
 	relayAllCommittedPackets(s, s.providerChain, s.path, ccv.ProviderPortID, s.path.EndpointB.ChannelID, 1)
 	// - increment time so that the unbonding period ends on the provider

tests/integration/key_assignment.go

@@ -14,6 +14,7 @@ import (
 )
 
 func (s *CCVTestSuite) TestKeyAssignment() {
+	blocksPerEpoch := s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch
 	testCases := []struct {
 		name           string
 		assignFunc     func(*providerkeeper.Keeper) error
@@ -30,7 +31,7 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				}
 
 				// check that a VSCPacket is queued
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 				pendingPackets := pk.GetPendingVSCPackets(s.providerCtx(), s.consumerChain.ChainID)
 				s.Require().Len(pendingPackets, 1)
 
@@ -51,7 +52,7 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, false, 2,
@@ -73,7 +74,7 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				delAddr := s.providerChain.SenderAccount.GetAddress()
 				delegate(s, delAddr, bondAmt)
 
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, false, 2,
@@ -95,7 +96,7 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, true, 2,
@@ -118,7 +119,7 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, false, 2,
@@ -134,14 +135,14 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				// same key assignment
 				err = pk.AssignConsumerKey(s.providerCtx(), s.consumerChain.ChainID, validator, consumerKey)
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, true, 2,
@@ -157,15 +158,15 @@ func (s *CCVTestSuite) TestKeyAssignment() {
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				// same key assignment
 				validator, consumerKey = generateNewConsumerKey(s, 0)
 				err = pk.AssignConsumerKey(s.providerCtx(), s.consumerChain.ChainID, validator, consumerKey)
 				if err != nil {
 					return err
 				}
-				s.providerChain.NextBlock()
+				nextBlocks(s.providerChain, blocksPerEpoch)
 
 				return nil
 			}, false, 3,

tests/integration/setup.go

@@ -129,6 +129,12 @@ func (suite *CCVTestSuite) SetupTest() {
 	suite.registerPacketSniffer(suite.providerChain)
 	providerKeeper := suite.providerApp.GetProviderKeeper()
 
+	// set `BlocksPerEpoch` to 10: a reasonable small value greater than 1 that prevents waiting for too
+	// many blocks and slowing down the integration tests
+	params := providerKeeper.GetParams(suite.providerCtx())
+	params.BlocksPerEpoch = 10
+	providerKeeper.SetParams(suite.providerCtx(), params)
+
 	// re-assign all validator keys for the first consumer chain
 	providerKeeper.SetPendingConsumerAdditionProp(suite.providerCtx(), &types.ConsumerAdditionProposal{
 		ChainId: icstestingutils.FirstConsumerChainID,

tests/integration/slashing.go

@@ -107,6 +107,9 @@ func (s *CCVTestSuite) TestRelayAndApplyDowntimePacket() {
 		s.Require().True(found)
 	}
 
+	// increase FIXME
+	nextBlocks(s.providerChain, s.providerApp.GetProviderKeeper().GetParams(s.providerCtx()).BlocksPerEpoch)
+
 	// Confirm the valset update Id was incremented twice on provider,
 	// since two endblockers have passed.
 	s.Require().Equal(valsetUpdateIdN+2,

tests/integration/soft_opt_out.go

@@ -20,6 +20,8 @@ import (
 func (suite *CCVTestSuite) TestSoftOptOut() {
 	var votes []abci.VoteInfo
 
+	blocksPerEpoch := suite.providerApp.GetProviderKeeper().GetParams(suite.providerCtx()).BlocksPerEpoch
+
 	testCases := []struct {
 		name            string
 		downtimeFunc    func(*consumerKeeper.Keeper, *slashingkeeper.Keeper, []byte, int)
@@ -73,7 +75,7 @@ func (suite *CCVTestSuite) TestSoftOptOut() {
 				bondAmt := sdk.NewInt(100).Mul(sdk.DefaultPowerReduction)
 				delegateByIdx(suite, delAddr, bondAmt, valIdx)
 
-				suite.providerChain.NextBlock()
+				nextBlocks(suite.providerChain, blocksPerEpoch)
 
 				// Relay 1 VSC packet from provider to consumer
 				relayAllCommittedPackets(suite, suite.providerChain, suite.path, ccv.ProviderPortID, suite.path.EndpointB.ChannelID, 1)
@@ -112,7 +114,7 @@ func (suite *CCVTestSuite) TestSoftOptOut() {
 				bondAmt := sdk.NewInt(100).Mul(sdk.DefaultPowerReduction)
 				delegateByIdx(suite, delAddr, bondAmt, valIdx)
 
-				suite.providerChain.NextBlock()
+				nextBlocks(suite.providerChain, blocksPerEpoch)
 
 				// Relay 1 VSC packet from provider to consumer
 				relayAllCommittedPackets(suite, suite.providerChain, suite.path, ccv.ProviderPortID, suite.path.EndpointB.ChannelID, 1)
@@ -149,6 +151,8 @@ func (suite *CCVTestSuite) TestSoftOptOut() {
 		validatorPowers := []int64{1000, 500, 50, 10}
 		suite.setupValidatorPowers(validatorPowers)
 
+		nextBlocks(suite.providerChain, blocksPerEpoch)
+
 		// Relay 1 VSC packet from provider to consumer
 		relayAllCommittedPackets(suite, suite.providerChain, suite.path, ccv.ProviderPortID, suite.path.EndpointB.ChannelID, 1)