changed providerKeeper.GetProposedConsumerChain to return a bool

cosmos · Feb 8, 2024 · 3402f75 · 3402f75
1 parent bef8202
commit 3402f75
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/x/ccv/provider/keeper/hooks.go b/x/ccv/provider/keeper/hooks.go
@@ -175,6 +175,8 @@ func (h Hooks) AfterProposalVotingPeriodEnded(ctx sdk.Context, proposalID uint64
 func (h Hooks) AfterProposalDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress) {
 }
 
+// AfterProposalVote opts in validators that vote YES (with 100% weight) on a `ConsumerAdditionProposal`. If a
+// validator votes multiple times, only the last vote would be considered on whether the validator is opted in or not.
 func (h Hooks) AfterProposalVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress) {
 	validator, found := h.k.stakingKeeper.GetValidator(ctx, voterAddr.Bytes())
 	if !found {
@@ -186,7 +188,10 @@ func (h Hooks) AfterProposalVote(ctx sdk.Context, proposalID uint64, voterAddr s
 		return
 	}
 
-	chainID := h.k.GetProposedConsumerChain(ctx, proposalID)
+	chainID, found := h.k.GetProposedConsumerChain(ctx, proposalID)
+	if !found {
+		return
+	}
 
 	vote, found := h.k.govKeeper.GetVote(ctx, proposalID, voterAddr)
 	if !found {

diff --git a/x/ccv/provider/keeper/hooks_test.go b/x/ccv/provider/keeper/hooks_test.go
@@ -127,11 +127,13 @@ func TestAfterPropSubmissionAndVotingPeriodEnded(t *testing.T) {
 
 	k.Hooks().AfterProposalSubmission(ctx, prop.Id)
 	// verify that the proposal ID is created
-	require.NotEmpty(t, k.GetProposedConsumerChain(ctx, prop.Id))
+	_, found := k.GetProposedConsumerChain(ctx, prop.Id)
+	require.True(t, found)
 
 	k.Hooks().AfterProposalVotingPeriodEnded(ctx, prop.Id)
 	// verify that the proposal ID is deleted
-	require.Empty(t, k.GetProposedConsumerChain(ctx, prop.Id))
+	_, found = k.GetProposedConsumerChain(ctx, prop.Id)
+	require.False(t, found)
 }
 
 func TestGetConsumerAdditionLegacyPropFromProp(t *testing.T) {

diff --git a/x/ccv/provider/keeper/keeper.go b/x/ccv/provider/keeper/keeper.go
@@ -186,9 +186,10 @@ func (k Keeper) SetProposedConsumerChain(ctx sdk.Context, chainID string, propos
 }
 
 // GetProposedConsumerChain returns the proposed chainID for the given consumerAddition proposal ID.
-func (k Keeper) GetProposedConsumerChain(ctx sdk.Context, proposalID uint64) string {
+func (k Keeper) GetProposedConsumerChain(ctx sdk.Context, proposalID uint64) (string, bool) {
 	store := ctx.KVStore(k.storeKey)
-	return string(store.Get(types.ProposedConsumerChainKey(proposalID)))
+	consumerChain := store.Get(types.ProposedConsumerChainKey(proposalID))
+	return string(consumerChain), consumerChain != nil
 }
 
 // DeleteProposedConsumerChainInStore deletes the consumer chainID from store

diff --git a/x/ccv/provider/keeper/keeper_test.go b/x/ccv/provider/keeper/keeper_test.go
@@ -552,7 +552,7 @@ func TestSetProposedConsumerChains(t *testing.T) {
 
 	for _, test := range tests {
 		providerKeeper.SetProposedConsumerChain(ctx, test.chainID, test.proposalID)
-		cID := providerKeeper.GetProposedConsumerChain(ctx, test.proposalID)
+		cID, _ := providerKeeper.GetProposedConsumerChain(ctx, test.proposalID)
 		require.Equal(t, cID, test.chainID)
 	}
 }
@@ -574,9 +574,9 @@ func TestDeleteProposedConsumerChainInStore(t *testing.T) {
 	for _, test := range tests {
 		providerKeeper.SetProposedConsumerChain(ctx, test.chainID, test.proposalID)
 		providerKeeper.DeleteProposedConsumerChainInStore(ctx, test.deleteProposalID)
-		cID := providerKeeper.GetProposedConsumerChain(ctx, test.proposalID)
+		cID, found := providerKeeper.GetProposedConsumerChain(ctx, test.proposalID)
 		if test.ok {
-			require.Equal(t, cID, "")
+			require.False(t, found)
 		} else {
 			require.Equal(t, cID, test.chainID)
 		}