Refactor: Convert iterators to array getters

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

@@ -9,6 +9,7 @@ import "google/protobuf/timestamp.proto";
 import "google/protobuf/duration.proto";
 import "ibc/core/client/v1/client.proto";
 import "ibc/lightclients/tendermint/v1/tendermint.proto";
+import "tendermint/crypto/keys.proto";
 
 // ConsumerAdditionProposal is a governance proposal on the provider chain to spawn a new consumer chain.
 // If it passes, then all validators on the provider chain are expected to validate the consumer chain at spawn time
@@ -133,4 +134,31 @@ message ConsumerRemovalProposals {
 // AddressList contains a list of consensus addresses
 message AddressList {
   repeated bytes addresses = 1;
-}
+}
+
+message ChannelToChain {
+  string channel_id = 1;
+  string chain_id = 2;
+}
+
+message VscUnbondingOps {
+  uint64 vsc_id = 1;
+  repeated uint64 unbonding_op_ids = 2;
+}
+
+message InitTimeoutTimestamp {
+  string chain_id = 1;
+  uint64 timestamp = 2;
+}
+
+message VscSendTimestamp {
+  uint64 vsc_id = 1;
+  google.protobuf.Timestamp timestamp = 2 [(gogoproto.stdtime) = true, (gogoproto.nullable) = false];
+}
+
+message KeyAssignmentReplacement {
+  bytes provider_addr = 1;
+  tendermint.crypto.PublicKey prev_c_key = 2;
+  int64 power = 3;
+}
+

tests/difference/core/driver/core_test.go

@@ -385,11 +385,9 @@ func (s *CoreSuite) TestAssumptions() {
 	s.Require().Empty(s.consumerKeeper().GetPendingPackets(s.ctx(C)))
 
 	// Consumer has no maturities
-	s.consumerKeeper().IteratePacketMaturityTime(s.ctx(C),
-		func(vscId uint64, timeNs uint64) (stop bool) {
-			s.T().Fatal(FAIL_MSG)
-			return false // Don't stop
-		})
+	for _, _ = range s.consumerKeeper().GetAllPacketMaturityTimes(s.ctx(C), nil) {
+		s.T().Fatal(FAIL_MSG)
+	}
 
 	// Consumer power
 	for i := 0; i < len(initState.ValStates.Status); i++ {

tests/e2e/stop_consumer.go

@@ -137,21 +137,16 @@ func (s *CCVTestSuite) checkConsumerChainIsRemoved(chainID string, checkChannel
 	}
 
 	// check UnbondingOps were deleted and undelegation entries aren't onHold
-	providerKeeper.IterateOverUnbondingOpIndex(
-		s.providerCtx(),
-		chainID,
-		func(vscID uint64, ubdIndex []uint64) (stop bool) {
-			_, found := providerKeeper.GetUnbondingOpIndex(s.providerCtx(), chainID, uint64(vscID))
+	for _, unbondingOpsIndex := range providerKeeper.GetAllUnbondingOpIndexes(s.providerCtx(), chainID) {
+		_, found := providerKeeper.GetUnbondingOpIndex(s.providerCtx(), chainID, unbondingOpsIndex.VscId)
+		s.Require().False(found)
+		for _, ubdID := range unbondingOpsIndex.UnbondingOpIds {
+			_, found = providerKeeper.GetUnbondingOp(s.providerCtx(), unbondingOpsIndex.UnbondingOpIds[ubdID])
 			s.Require().False(found)
-			for _, ubdID := range ubdIndex {
-				_, found = providerKeeper.GetUnbondingOp(s.providerCtx(), ubdIndex[ubdID])
-				s.Require().False(found)
-				ubd, _ := providerStakingKeeper.GetUnbondingDelegationByUnbondingID(s.providerCtx(), ubdIndex[ubdID])
-				s.Require().Zero(ubd.Entries[ubdID].UnbondingOnHoldRefCount)
-			}
-			return false // do not stop the iteration
-		},
-	)
+			ubd, _ := providerStakingKeeper.GetUnbondingDelegationByUnbondingID(s.providerCtx(), unbondingOpsIndex.UnbondingOpIds[ubdID])
+			s.Require().Zero(ubd.Entries[ubdID].UnbondingOnHoldRefCount)
+		}
+	}
 
 	// verify consumer chain's states are removed
 	_, found := providerKeeper.GetConsumerGenesis(s.providerCtx(), chainID)

x/ccv/consumer/keeper/genesis.go

@@ -118,34 +118,9 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisSt
 			panic("provider client does not exist")
 		}
 
-		maturingPackets := []consumertypes.MaturingVSCPacket{}
-		k.IteratePacketMaturityTime(ctx, func(vscId, timeNs uint64) (stop bool) {
-			mat := consumertypes.MaturingVSCPacket{
-				VscId:        vscId,
-				MaturityTime: timeNs,
-			}
-			maturingPackets = append(maturingPackets, mat)
-			return false // do not stop the iteration
-		})
-
-		heightToVCIDs := []consumertypes.HeightToValsetUpdateID{}
-		k.IterateHeightToValsetUpdateID(ctx, func(height, vscID uint64) (stop bool) {
-			hv := consumertypes.HeightToValsetUpdateID{
-				Height:         height,
-				ValsetUpdateId: vscID,
-			}
-			heightToVCIDs = append(heightToVCIDs, hv)
-			return false // do not stop the iteration
-		})
-
-		outstandingDowntimes := []consumertypes.OutstandingDowntime{}
-		k.IterateOutstandingDowntime(ctx, func(addr string) (stop bool) {
-			od := consumertypes.OutstandingDowntime{
-				ValidatorConsensusAddress: addr,
-			}
-			outstandingDowntimes = append(outstandingDowntimes, od)
-			return false // do not stop the iteration
-		})
+		maturingPackets := k.GetAllPacketMaturityTimes(ctx, nil)
+
+		outstandingDowntimes := k.GetAllOutstandingDowntimes(ctx)
 
 		// TODO: update GetLastTransmissionBlockHeight to not return an error
 		ltbh, err := k.GetLastTransmissionBlockHeight(ctx)
@@ -158,7 +133,7 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisSt
 			channelID,
 			maturingPackets,
 			valset,
-			k.GetHeightToValsetUpdateIDs(ctx),
+			k.GetAllHeightToValsetUpdateIDs(ctx),
 			k.GetPendingPackets(ctx),
 			outstandingDowntimes,
 			*ltbh,
@@ -178,7 +153,7 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisSt
 			"",
 			nil,
 			valset,
-			k.GetHeightToValsetUpdateIDs(ctx),
+			k.GetAllHeightToValsetUpdateIDs(ctx),
 			k.GetPendingPackets(ctx),
 			nil,
 			consumertypes.LastTransmissionBlockHeight{},

x/ccv/consumer/keeper/genesis_test.go

@@ -187,7 +187,7 @@ func TestInitGenesis(t *testing.T) {
 				require.Equal(t, vscID, ck.GetPacketMaturityTime(ctx, vscID))
 				require.Equal(t, pendingDataPackets, ck.GetPendingPackets(ctx))
 
-				require.Equal(t, gs.OutstandingDowntimeSlashing, ck.GetOutstandingDowntimes(ctx))
+				require.Equal(t, gs.OutstandingDowntimeSlashing, ck.GetAllOutstandingDowntimes(ctx))
 
 				ltbh, err := ck.GetLastTransmissionBlockHeight(ctx)
 				require.NoError(t, err)
@@ -382,10 +382,10 @@ func assertProviderClientID(t *testing.T, ctx sdk.Context, ck *consumerkeeper.Ke
 // assert that the given input match the height to valset update ID mappings in the store
 func assertHeightValsetUpdateIDs(t *testing.T, ctx sdk.Context, ck *consumerkeeper.Keeper, heighValsetUpdateIDs []consumertypes.HeightToValsetUpdateID) {
 	ctr := 0
-	ck.IterateHeightToValsetUpdateID(ctx, func(height uint64, vscID uint64) (stop bool) {
-		require.Equal(t, heighValsetUpdateIDs[ctr].Height, height)
-		require.Equal(t, heighValsetUpdateIDs[ctr].ValsetUpdateId, vscID)
+
+	for _, heightToValsetUpdateID := range ck.GetAllHeightToValsetUpdateIDs(ctx) {
+		require.Equal(t, heighValsetUpdateIDs[ctr].Height, heightToValsetUpdateID.Height)
+		require.Equal(t, heighValsetUpdateIDs[ctr].ValsetUpdateId, heightToValsetUpdateID.ValsetUpdateId)
 		ctr++
-		return false
-	})
+	}
 }

x/ccv/consumer/keeper/keeper.go

@@ -206,24 +206,32 @@ func (k Keeper) DeletePendingChanges(ctx sdk.Context) {
 	store.Delete(types.PendingChangesKey())
 }
 
-// IteratePacketMaturityTime iterates through the VSC packet maturity times set in the store
-func (k Keeper) IteratePacketMaturityTime(ctx sdk.Context, cb func(vscId, timeNs uint64) (stop bool)) {
+// GetAllPacketMaturityTimes returns a slice of PacketMaturityTimes, sorted by maturity time.
+func (k Keeper) GetAllPacketMaturityTimes(ctx sdk.Context, latest *uint64) (packetMaturityTimes []consumertypes.MaturingVSCPacket) {
 	store := ctx.KVStore(k.storeKey)
 	iterator := sdk.KVStorePrefixIterator(store, []byte{types.PacketMaturityTimeBytePrefix})
 
 	defer iterator.Close()
 	for ; iterator.Valid(); iterator.Next() {
 		// Extract bytes following the 1 byte prefix
-		seqBytes := iterator.Key()[1:]
-		seq := binary.BigEndian.Uint64(seqBytes)
+		vscIdBytes := iterator.Key()[1:]
+		vscId := binary.BigEndian.Uint64(vscIdBytes)
 
 		timeNs := binary.BigEndian.Uint64(iterator.Value())
 
-		stop := cb(seq, timeNs)
-		if stop {
+		// If the `latest` parameter is not nil, we want to stop iterating when we reach
+		// a maturityTime that is after the `latest` time, because we want no maturities
+		// after the `latest` time.
+		if latest != nil && *latest < timeNs {
 			break
 		}
+
+		packetMaturityTimes = append(packetMaturityTimes, consumertypes.MaturingVSCPacket{
+			VscId:        vscId,
+			MaturityTime: timeNs,
+		})
 	}
+	return packetMaturityTimes
 }
 
 // SetPacketMaturityTime sets the maturity time for a given received VSC packet id
@@ -299,8 +307,8 @@ func (k Keeper) DeleteHeightValsetUpdateID(ctx sdk.Context, height uint64) {
 	store.Delete(types.HeightValsetUpdateIDKey(height))
 }
 
-// IterateHeightToValsetUpdateID iterates over the block height to valset update ID mapping in store
-func (k Keeper) IterateHeightToValsetUpdateID(ctx sdk.Context, cb func(height, vscID uint64) (stop bool)) {
+// GetAllHeightToValsetUpdateIDs returns a list of all the block heights to valset update IDs in the store
+func (k Keeper) GetAllHeightToValsetUpdateIDs(ctx sdk.Context) (heightToValsetUpdateIDs []types.HeightToValsetUpdateID) {
 	store := ctx.KVStore(k.storeKey)
 	iterator := sdk.KVStorePrefixIterator(store, []byte{types.HeightValsetUpdateIDBytePrefix})
 
@@ -311,11 +319,13 @@ func (k Keeper) IterateHeightToValsetUpdateID(ctx sdk.Context, cb func(height, v
 
 		vscID := binary.BigEndian.Uint64(iterator.Value())
 
-		stop := cb(height, vscID)
-		if stop {
-			break
-		}
+		heightToValsetUpdateIDs = append(heightToValsetUpdateIDs, types.HeightToValsetUpdateID{
+			Height:         height,
+			ValsetUpdateId: vscID,
+		})
 	}
+
+	return heightToValsetUpdateIDs
 }
 
 // OutstandingDowntime returns the outstanding downtime flag for a given validator
@@ -341,20 +351,22 @@ func (k Keeper) DeleteOutstandingDowntime(ctx sdk.Context, consAddress string) {
 	store.Delete(types.OutstandingDowntimeKey(consAddr))
 }
 
-// IterateOutstandingDowntime iterates over the validator addresses of outstanding downtime flags
-func (k Keeper) IterateOutstandingDowntime(ctx sdk.Context, cb func(address string) (stop bool)) {
+// GetAllOutstandingDowntimes gets an array of the validator addresses of outstanding downtime flags
+func (k Keeper) GetAllOutstandingDowntimes(ctx sdk.Context) (downtimes []consumertypes.OutstandingDowntime) {
 	store := ctx.KVStore(k.storeKey)
 	iterator := sdk.KVStorePrefixIterator(store, []byte{types.OutstandingDowntimeBytePrefix})
 
 	defer iterator.Close()
 	for ; iterator.Valid(); iterator.Next() {
 		addrBytes := iterator.Key()[1:]
 		addr := sdk.ConsAddress(addrBytes).String()
-		stop := cb(addr)
-		if stop {
-			break
-		}
+
+		downtimes = append(downtimes, consumertypes.OutstandingDowntime{
+			ValidatorConsensusAddress: addr,
+		})
 	}
+
+	return downtimes
 }
 
 // SetCCValidator sets a cross-chain validator under its validator address
@@ -439,31 +451,3 @@ func (k Keeper) AppendPendingPacket(ctx sdk.Context, packet ...types.ConsumerPac
 	list := append(pending.GetList(), packet...)
 	k.SetPendingPackets(ctx, types.ConsumerPackets{List: list})
 }
-
-// GetHeightToValsetUpdateIDs returns all height to valset update id mappings in store
-func (k Keeper) GetHeightToValsetUpdateIDs(ctx sdk.Context) []types.HeightToValsetUpdateID {
-	heightToVCIDs := []types.HeightToValsetUpdateID{}
-	k.IterateHeightToValsetUpdateID(ctx, func(height, vscID uint64) (stop bool) {
-		hv := types.HeightToValsetUpdateID{
-			Height:         height,
-			ValsetUpdateId: vscID,
-		}
-		heightToVCIDs = append(heightToVCIDs, hv)
-		return false // do not stop iteration
-	})
-
-	return heightToVCIDs
-}
-
-// GetOutstandingDowntimes returns all outstanding downtimes in store
-func (k Keeper) GetOutstandingDowntimes(ctx sdk.Context) []consumertypes.OutstandingDowntime {
-	outstandingDowntimes := []types.OutstandingDowntime{}
-	k.IterateOutstandingDowntime(ctx, func(addr string) bool {
-		od := types.OutstandingDowntime{
-			ValidatorConsensusAddress: addr,
-		}
-		outstandingDowntimes = append(outstandingDowntimes, od)
-		return false
-	})
-	return outstandingDowntimes
-}

x/ccv/consumer/keeper/keeper_test.go

@@ -103,13 +103,12 @@ func TestPacketMaturityTime(t *testing.T) {
 	orderedTimes := [][]uint64{{1, 10}, {2, 25}, {5, 15}}
 	i := 0
 
-	consumerKeeper.IteratePacketMaturityTime(ctx, func(seq, time uint64) (stop bool) {
+	for _, maturingVSCPacket := range consumerKeeper.GetAllPacketMaturityTimes(ctx, nil) {
 		// require that we iterate through unbonding time in order of sequence
-		require.Equal(t, orderedTimes[i][0], seq)
-		require.Equal(t, orderedTimes[i][1], time)
+		require.Equal(t, orderedTimes[i][0], maturingVSCPacket.VscId)
+		require.Equal(t, orderedTimes[i][1], maturingVSCPacket.MaturityTime)
 		i++
-		return false // do not stop the iteration
-	})
+	}
 
 	// delete all vscs remaining in state
 	consumerKeeper.DeletePacketMaturityTimes(ctx, 1, 2, 5)

x/ccv/consumer/keeper/relay.go

@@ -1,7 +1,6 @@
 package keeper
 
 import (
-	"encoding/binary"
 	"fmt"
 	"strconv"
 
@@ -86,43 +85,36 @@ func (k Keeper) OnRecvVSCPacket(ctx sdk.Context, packet channeltypes.Packet, new
 // operations that resulted in validator updates included in that VSC have matured on
 // the consumer chain.
 func (k Keeper) QueueVSCMaturedPackets(ctx sdk.Context) {
-	store := ctx.KVStore(k.storeKey)
-	maturityIterator := sdk.KVStorePrefixIterator(store, []byte{types.PacketMaturityTimeBytePrefix})
-	defer maturityIterator.Close()
-
 	currentTime := uint64(ctx.BlockTime().UnixNano())
 
 	maturedVscIds := []uint64{}
-	for maturityIterator.Valid() {
-		vscId := types.IdFromPacketMaturityTimeKey(maturityIterator.Key())
-		if currentTime >= binary.BigEndian.Uint64(maturityIterator.Value()) {
-			// construct validator set change packet data
-			vscPacket := ccv.NewVSCMaturedPacketData(vscId)
-
-			// append VSCMatured packet to pending packets
-			// sending packets is attempted each EndBlock
-			// unsent packets remain in the queue until sent
-			k.AppendPendingPacket(ctx, types.ConsumerPacket{
-				Type: types.VscMaturedPacket,
-				Data: vscPacket.GetBytes(),
-			})
-
-			ctx.EventManager().EmitEvent(
-				sdk.NewEvent(
-					ccv.EventTypeVSCMatured,
-					sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
-					sdk.NewAttribute(ccv.AttributeChainID, ctx.ChainID()),
-					sdk.NewAttribute(ccv.AttributeConsumerHeight, strconv.Itoa(int(ctx.BlockHeight()))),
-					sdk.NewAttribute(ccv.AttributeValSetUpdateID, strconv.Itoa(int(vscId))),
-					sdk.NewAttribute(ccv.AttributeTimestamp, strconv.Itoa(int(currentTime))),
-				),
-			)
-
-			maturedVscIds = append(maturedVscIds, vscId)
-		} else {
-			break
+	for _, maturityTime := range k.GetAllPacketMaturityTimes(ctx, &currentTime) {
+		if currentTime < maturityTime.MaturityTime {
+			panic(fmt.Errorf("maturity time %d is greater than current time %d", maturityTime.MaturityTime, currentTime))
 		}
-		maturityIterator.Next()
+		// construct validator set change packet data
+		vscPacket := ccv.NewVSCMaturedPacketData(maturityTime.VscId)
+
+		// append VSCMatured packet to pending packets
+		// sending packets is attempted each EndBlock
+		// unsent packets remain in the queue until sent
+		k.AppendPendingPacket(ctx, types.ConsumerPacket{
+			Type: types.VscMaturedPacket,
+			Data: vscPacket.GetBytes(),
+		})
+
+		ctx.EventManager().EmitEvent(
+			sdk.NewEvent(
+				ccv.EventTypeVSCMatured,
+				sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
+				sdk.NewAttribute(ccv.AttributeChainID, ctx.ChainID()),
+				sdk.NewAttribute(ccv.AttributeConsumerHeight, strconv.Itoa(int(ctx.BlockHeight()))),
+				sdk.NewAttribute(ccv.AttributeValSetUpdateID, strconv.Itoa(int(maturityTime.VscId))),
+				sdk.NewAttribute(ccv.AttributeTimestamp, strconv.Itoa(int(currentTime))),
+			),
+		)
+
+		maturedVscIds = append(maturedVscIds, uint64(maturityTime.VscId))
 	}
 
 	k.DeletePacketMaturityTimes(ctx, maturedVscIds...)