refactor: add FindBallotAndFinalize function

Signed-off-by: Francisco de Borja Aranda Castillejo <[email protected]>

Author: Francisco de Borja Aranda Castillejo

x/observer/keeper/msg_server_vote_blame.go

@@ -13,25 +13,25 @@ import (
 
 func (k msgServer) VoteBlame(
 	goCtx context.Context,
-	vote *types.MsgVoteBlame,
+	msg *types.MsgVoteBlame,
 ) (*types.MsgVoteBlameResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 	observationType := types.ObservationType_TSSKeySign
 
 	// GetChainFromChainID makes sure we are getting only supported chains , if a chain support has been turned on using gov proposal, this function returns nil
-	observationChain, found := k.GetSupportedChainFromChainID(ctx, vote.ChainId)
+	observationChain, found := k.GetSupportedChainFromChainID(ctx, msg.ChainId)
 	if !found {
 		return nil, cosmoserrors.Wrap(
 			crosschainTypes.ErrUnsupportedChain,
-			fmt.Sprintf("ChainID %d, Blame vote", vote.ChainId),
+			fmt.Sprintf("ChainID %d, Blame vote", msg.ChainId),
 		)
 	}
 
-	if ok := k.IsNonTombstonedObserver(ctx, vote.Creator); !ok {
+	if ok := k.IsNonTombstonedObserver(ctx, msg.Creator); !ok {
 		return nil, types.ErrNotObserver
 	}
 
-	index := vote.Digest()
+	index := msg.Digest()
 	// Add votes and Set Ballot
 	// GetBallot checks against the supported chains list before querying for Ballot
 	ballot, isNew, err := k.FindBallot(ctx, index, observationChain, observationType)
@@ -40,11 +40,11 @@ func (k msgServer) VoteBlame(
 	}
 
 	if isNew {
-		EmitEventBallotCreated(ctx, ballot, vote.BlameInfo.Index, observationChain.String())
+		EmitEventBallotCreated(ctx, ballot, msg.BlameInfo.Index, observationChain.String())
 	}
 
 	// AddVoteToBallot adds a vote and sets the ballot
-	ballot, err = k.AddVoteToBallot(ctx, ballot, vote.Creator, types.VoteType_SuccessObservation)
+	ballot, err = k.AddVoteToBallot(ctx, ballot, msg.Creator, types.VoteType_SuccessObservation)
 	if err != nil {
 		return nil, err
 	}
@@ -59,6 +59,6 @@ func (k msgServer) VoteBlame(
 	// below only happens when ballot is finalized: exactly when threshold vote is in
 	// ******************************************************************************
 
-	k.SetBlame(ctx, vote.BlameInfo)
+	k.SetBlame(ctx, msg.BlameInfo)
 	return &types.MsgVoteBlameResponse{}, nil
 }

x/observer/keeper/vote_common.go

@@ -0,0 +1,38 @@
+package keeper
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/zeta-chain/zetacore/pkg/chains"
+	"github.com/zeta-chain/zetacore/x/observer/types"
+)
+
+// VoteOnBallot finds a ballot or creates a new one if not found,
+// and casts a vote on it. Then proceed to check if the vote has been finalized.
+// This function holds generic logic for all types of votes.
+func (k Keeper) VoteOnBallot(
+	ctx sdk.Context,
+	chain chains.Chain,
+	ballotIndex string,
+	observationType types.ObservationType,
+	voter string,
+	voteType types.VoteType,
+) (
+	ballot types.Ballot,
+	isFinalized bool,
+	isNew bool,
+	err error) {
+	ballot, isNew, err = k.FindBallot(ctx, ballotIndex, chain, observationType)
+	if err != nil {
+		return ballot, false, false, err
+	}
+
+	ballot, err = k.AddVoteToBallot(ctx, ballot, voter, voteType)
+	if err != nil {
+		return ballot, false, isNew, err
+	}
+
+	ballot, isFinalized = k.CheckIfFinalizingVote(ctx, ballot)
+
+	return ballot, isFinalized, isNew, nil
+}

x/observer/keeper/vote_inbound.go

@@ -3,8 +3,8 @@ package keeper
 import (
 	"fmt"
 
+	sdkerrors "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 
 	"github.com/zeta-chain/zetacore/pkg/coin"
 	"github.com/zeta-chain/zetacore/x/observer/types"
@@ -64,22 +64,14 @@ func (k Keeper) VoteOnInboundBallot(
 		}
 	}
 
-	// checks against the supported chains list before querying for Ballot
-	ballot, isNew, err := k.FindBallot(ctx, ballotIndex, senderChain, types.ObservationType_InboundTx)
+	ballot, isFinalized, isNew, err := k.VoteOnBallot(ctx, senderChain, ballotIndex, types.ObservationType_InboundTx, voter, types.VoteType_SuccessObservation)
 	if err != nil {
 		return false, false, err
 	}
+
 	if isNew {
 		EmitEventBallotCreated(ctx, ballot, inboundHash, senderChain.String())
 	}
 
-	// adds a vote and sets the ballot
-	ballot, err = k.AddVoteToBallot(ctx, ballot, voter, types.VoteType_SuccessObservation)
-	if err != nil {
-		return false, isNew, err
-	}
-
-	// checks if the ballot is finalized
-	_, isFinalized := k.CheckIfFinalizingVote(ctx, ballot)
 	return isFinalized, isNew, nil
 }

x/observer/keeper/vote_outbound.go

@@ -36,18 +36,10 @@ func (k Keeper) VoteOnOutboundBallot(
 		return false, false, ballot, "", observertypes.ErrNotObserver
 	}
 
-	// fetch or create ballot
-	ballot, isNew, err = k.FindBallot(ctx, ballotIndex, observationChain, observertypes.ObservationType_OutboundTx)
+	ballot, isFinalized, isNew, err = k.VoteOnBallot(ctx, observationChain, ballotIndex, observertypes.ObservationType_OutboundTx, voter, observertypes.ConvertReceiveStatusToVoteType(receiveStatus))
 	if err != nil {
 		return false, false, ballot, "", err
 	}
 
-	// add vote to ballot
-	ballot, err = k.AddVoteToBallot(ctx, ballot, voter, observertypes.ConvertReceiveStatusToVoteType(receiveStatus))
-	if err != nil {
-		return false, false, ballot, "", err
-	}
-
-	ballot, isFinalizedInThisBlock := k.CheckIfFinalizingVote(ctx, ballot)
-	return isFinalizedInThisBlock, isNew, ballot, observationChain.String(), nil
+	return isFinalized, isNew, ballot, observationChain.String(), nil
 }