@@ -14,6 +14,8 @@ import (
1414 observerkeeper "github.com/zeta-chain/zetacore/x/observer/keeper"
1515)
1616
17+ const voteOutboundID = "Vote Outbound"
18+
1719// VoteOutbound casts a vote on an outbound transaction observed on a connected chain (after
1820// it has been broadcasted to and finalized on a connected chain). If this is
1921// the first vote, a new ballot is created. When a threshold of votes is
@@ -61,45 +63,48 @@ func (k msgServer) VoteOutbound(
6163) (* types.MsgVoteOutboundResponse , error ) {
6264 ctx := sdk .UnwrapSDKContext (goCtx )
6365
64- // Validate the message params to verify it against an existing cctx
66+ // Validate the message params to verify it against an existing CCTX.
6567 cctx , err := k .ValidateOutboundMessage (ctx , * msg )
6668 if err != nil {
67- return nil , err
69+ return nil , cosmoserrors . Wrap ( err , voteOutboundID )
6870 }
69- // get ballot index
71+
7072 ballotIndex := msg .Digest ()
71- // vote on outbound ballot
7273 isFinalizingVote , isNew , ballot , observationChain , err := k .zetaObserverKeeper .VoteOnOutboundBallot (
7374 ctx ,
7475 ballotIndex ,
7576 msg .OutboundChain ,
7677 msg .Status ,
7778 msg .Creator )
7879 if err != nil {
79- return nil , err
80+ return nil , cosmoserrors . Wrap ( err , voteOutboundID )
8081 }
81- // if the ballot is new, set the index to the CCTX
82+
83+ // If the ballot is new, set the index to the CCTX.
8284 if isNew {
8385 observerkeeper .EmitEventBallotCreated (ctx , ballot , msg .ObservedOutboundHash , observationChain )
8486 }
85- // if not finalized commit state here
87+
88+ // If not finalized commit state here.
8689 if ! isFinalizingVote {
8790 return & types.MsgVoteOutboundResponse {}, nil
8891 }
8992
90- // if ballot successful, the value received should be the out tx amount
93+ // If ballot is successful, the value received should be the out tx amount.
9194 err = cctx .AddOutbound (ctx , * msg , ballot .BallotStatus )
9295 if err != nil {
93- return nil , err
96+ return nil , cosmoserrors . Wrap ( err , voteOutboundID )
9497 }
95- // Fund the gas stability pool with the remaining funds
98+
99+ // Fund the gas stability pool with the remaining funds.
96100 k .FundStabilityPool (ctx , & cctx )
97101
98102 err = k .ValidateOutboundObservers (ctx , & cctx , ballot .BallotStatus , msg .ValueReceived .String ())
99103 if err != nil {
100104 k .SaveFailedOutbound (ctx , & cctx , err .Error (), ballotIndex )
101105 return & types.MsgVoteOutboundResponse {}, nil
102106 }
107+
103108 k .SaveSuccessfulOutbound (ctx , & cctx , ballotIndex )
104109 return & types.MsgVoteOutboundResponse {}, nil
105110}
@@ -112,7 +117,7 @@ func (k Keeper) FundStabilityPool(ctx sdk.Context, cctx *types.CrossChainTx) {
112117 // Fund the gas stability pool with the remaining funds
113118 if err := k .FundGasStabilityPoolFromRemainingFees (ctx , * cctx .GetCurrentOutboundParam (), cctx .GetCurrentOutboundParam ().ReceiverChainId ); err != nil {
114119 ctx .Logger ().
115- Error (fmt . Sprintf ( "VoteOutbound : CCTX: %s Can't fund the gas stability pool with remaining fees %s"cctx .Index , err .Error () ))
120+ Error ("%s : CCTX: %s Can't fund the gas stability pool with remaining fees %s"voteOutboundID , cctx .Index , err .Error ())
116121 }
117122}
118123
@@ -136,16 +141,18 @@ func (k Keeper) FundGasStabilityPoolFromRemainingFees(
136141 remainingGas := gasLimit - gasUsed
137142 remainingFees := math .NewUint (remainingGas ).Mul (gasPrice ).BigInt ()
138143
139- // We fund the stability pool with a portion of the remaining fees
144+ // We fund the stability pool with a portion of the remaining fees.
140145 remainingFees = percentOf (remainingFees , RemainingFeesToStabilityPoolPercent )
141- // Fund the gas stability pool
146+
147+ // Fund the gas stability pool.
142148 if err := k .fungibleKeeper .FundGasStabilityPool (ctx , chainID , remainingFees ); err != nil {
143149 return err
144150 }
145151 } else {
146- return fmt .Errorf ("VoteOutbound : The gas limit %d is less than the gas used %d" , gasLimit , gasUsed )
152+ return fmt .Errorf ("%s : The gas limit %d is less than the gas used %d" , voteOutboundID , gasLimit , gasUsed )
147153 }
148154 }
155+
149156 return nil
150157}
151158
@@ -167,7 +174,6 @@ SaveFailedOutbound saves a failed outbound transaction.It does the following thi
167174func (k Keeper ) SaveFailedOutbound (ctx sdk.Context , cctx * types.CrossChainTx , errMessage string , ballotIndex string ) {
168175 cctx .SetAbort (errMessage )
169176 ctx .Logger ().Error (errMessage )
170-
171177 k .SaveOutbound (ctx , cctx , ballotIndex )
172178}
173179
@@ -195,48 +201,51 @@ func (k Keeper) SaveOutbound(ctx sdk.Context, cctx *types.CrossChainTx, ballotIn
195201 outTxTssNonce := cctx .GetCurrentOutboundParam ().TssNonce
196202
197203 cctx .GetCurrentOutboundParam ().BallotIndex = ballotIndex
204+
198205 // #nosec G115 always in range
199206 k .GetObserverKeeper ().RemoveFromPendingNonces (ctx , tssPubkey , receiverChain , int64 (outTxTssNonce ))
200207 k .RemoveOutboundTrackerFromStore (ctx , receiverChain , outTxTssNonce )
201208 ctx .Logger ().
202- Info (fmt .Sprintf ("Remove tracker %s: , Block Height : %d " , getOutboundTrackerIndex (receiverChain , outTxTssNonce ), ctx .BlockHeight ()))
209+ Info ("%s: Remove tracker %s: , Block Height : %d " , voteOutboundID , getOutboundTrackerIndex (receiverChain , outTxTssNonce ), ctx .BlockHeight ())
210+
203211 // This should set nonce to cctx only if a new revert is created.
204212 k .SetCctxAndNonceToCctxAndInboundHashToCctx (ctx , * cctx )
205213}
206214
207215func (k Keeper ) ValidateOutboundMessage (ctx sdk.Context , msg types.MsgVoteOutbound ) (types.CrossChainTx , error ) {
208- // check if CCTX exists and if the nonce matches
216+ // Check if CCTX exists and if the nonce matches.
209217 cctx , found := k .GetCrossChainTx (ctx , msg .CctxHash )
210218 if ! found {
211- return types.CrossChainTx {}, cosmoserrors .Wrap (
219+ return types.CrossChainTx {}, cosmoserrors .Wrapf (
212220 sdkerrors .ErrInvalidRequest ,
213- fmt .Sprintf ("CCTX %s does not exist" , msg .CctxHash ),
214- )
221+ "%s, CCTX %s does not exist" , voteOutboundID , msg .CctxHash )
215222 }
223+
216224 if cctx .GetCurrentOutboundParam ().TssNonce != msg .OutboundTssNonce {
217- return types.CrossChainTx {}, cosmoserrors .Wrap (
225+ return types.CrossChainTx {}, cosmoserrors .Wrapf (
218226 sdkerrors .ErrInvalidRequest ,
219- fmt .Sprintf (
220- "OutboundTssNonce %d does not match CCTX OutboundTssNonce %d" ,
221- msg .OutboundTssNonce ,
222- cctx .GetCurrentOutboundParam ().TssNonce ,
223- ),
227+ "%s, OutboundTssNonce %d does not match CCTX OutboundTssNonce %d" ,
228+ voteOutboundID ,
229+ msg .OutboundTssNonce ,
230+ cctx .GetCurrentOutboundParam ().TssNonce ,
224231 )
225232 }
226- // do not process an outbound vote if TSS is not found
233+
234+ // Do not process an outbound vote if TSS is not found.
227235 _ , found = k .zetaObserverKeeper .GetTSS (ctx )
228236 if ! found {
229- return types.CrossChainTx {}, types .ErrCannotFindTSSKeys
237+ return types.CrossChainTx {}, cosmoserrors . Wrap ( types .ErrCannotFindTSSKeys , voteOutboundID )
230238 }
239+
231240 if cctx .GetCurrentOutboundParam ().ReceiverChainId != msg .OutboundChain {
232- return types.CrossChainTx {}, cosmoserrors .Wrap (
241+ return types.CrossChainTx {}, cosmoserrors .Wrapf (
233242 sdkerrors .ErrInvalidRequest ,
234- fmt .Sprintf (
235- "OutboundChain %d does not match CCTX OutboundChain %d" ,
236- msg .OutboundChain ,
237- cctx .GetCurrentOutboundParam ().ReceiverChainId ,
238- ),
243+ "%s, OutboundChain %d does not match CCTX OutboundChain %d" ,
244+ voteOutboundID ,
245+ msg .OutboundChain ,
246+ cctx .GetCurrentOutboundParam ().ReceiverChainId ,
239247 )
240248 }
249+
241250 return cctx , nil
242251}
0 commit comments