Address PR comments

zeta-chain · Jul 12, 2024 · 4bdf50f · 4bdf50f
1 parent d36876d
commit 4bdf50f
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 36 deletions.
diff --git a/e2e/README.md b/e2e/README.md
@@ -76,9 +76,3 @@ You can also run an alias of `zetae2e run` like so:
 ```shell
   `./e2e/scripts/run.sh bitcoin_withdraw_restricted 0.001`
 ```
-
-To setup BTC suite, run
-
-```shell
-zetae2e setup-bitcoin cmd/zetae2e/config/local.yml
-```
diff --git a/zetaclient/chains/bitcoin/observer/outbound.go b/zetaclient/chains/bitcoin/observer/outbound.go
@@ -127,6 +127,16 @@ func (ob *Observer) IsOutboundProcessed(
 	cctx *crosschaintypes.CrossChainTx,
 	logger zerolog.Logger,
 ) (bool, bool, error) {
+	const (
+		// not used with Bitcoin
+		outboundGasUsed  = 0
+		outboundGasPrice = 0
+		outboundGasLimit = 0
+
+		gasLimit      = zetacore.PostVoteOutboundGasLimit
+		gasRetryLimit = 0
+	)
+
 	params := *cctx.GetCurrentOutboundParam()
 	nonce := cctx.GetCurrentOutboundParam().TssNonce
 
@@ -191,16 +201,6 @@ func (ob *Observer) IsOutboundProcessed(
 
 	signer := ob.ZetacoreClient().GetKeys().GetOperatorAddress()
 
-	const (
-		// not used with Bitcoin
-		outboundGasUsed  = 0
-		outboundGasPrice = 0
-		outboundGasLimit = 0
-
-		gasLimit      = zetacore.PostVoteOutboundGasLimit
-		gasRetryLimit = 0
-	)
-
 	msg := crosschaintypes.NewMsgVoteOutbound(
 		signer.String(),
 		cctx.Index,
@@ -223,17 +223,17 @@ func (ob *Observer) IsOutboundProcessed(
 
 	zetaHash, ballot, err := ob.ZetacoreClient().PostVoteOutbound(ctx, gasLimit, gasRetryLimit, msg)
 
-	lf := map[string]any{
+	logFields := map[string]any{
 		"outbound.external_tx_hash": res.TxID,
 		"outbound.nonce":            nonce,
 		"outbound.zeta_tx_hash":     zetaHash,
 		"outbound.ballot":           ballot,
 	}
 
 	if err != nil {
-		logger.Error().Err(err).Fields(lf).Msg("IsOutboundProcessed: error confirming bitcoin outbound")
+		logger.Error().Err(err).Fields(logFields).Msg("IsOutboundProcessed: error confirming bitcoin outbound")
 	} else if zetaHash != "" {
-		logger.Info().Fields(lf).Msgf("IsOutboundProcessed: confirmed Bitcoin outbound")
+		logger.Info().Fields(logFields).Msgf("IsOutboundProcessed: confirmed Bitcoin outbound")
 	}
 
 	return true, true, nil

diff --git a/zetaclient/chains/evm/observer/outbound.go b/zetaclient/chains/evm/observer/outbound.go
@@ -117,7 +117,7 @@ func (ob *Observer) PostVoteOutbound(
 	logger zerolog.Logger,
 ) {
 	chainID := ob.Chain().ChainId
-	lf := map[string]any{
+	logFields := map[string]any{
 		"outbound.chain_id":         chainID,
 		"outbound.external_tx_hash": receipt.TxHash.String(),
 		"outbound.nonce":            nonce,
@@ -149,18 +149,18 @@ func (ob *Observer) PostVoteOutbound(
 
 	zetaTxHash, ballot, err := ob.ZetacoreClient().PostVoteOutbound(ctx, gasLimit, retryGasLimit, msg)
 	if err != nil {
-		logger.Error().Err(err).Fields(lf).Msgf("PostVoteOutbound: error posting vote for chain %d", chainID)
+		logger.Error().Err(err).Fields(logFields).Msgf("PostVoteOutbound: error posting vote for chain %d", chainID)
 		return
 	}
 
 	if zetaTxHash == "" {
 		return
 	}
 
-	lf["outbound.zeta_tx_hash"] = zetaTxHash
-	lf["outbound.ballot"] = ballot
+	logFields["outbound.zeta_tx_hash"] = zetaTxHash
+	logFields["outbound.ballot"] = ballot
 
-	logger.Info().Fields(lf).Msgf("PostVoteOutbound: posted vote for chain %d", chainID)
+	logger.Info().Fields(logFields).Msgf("PostVoteOutbound: posted vote for chain %d", chainID)
 }
 
 // IsOutboundProcessed checks outbound status and returns (isIncluded, isConfirmed, error)

diff --git a/zetaclient/zetacore/client_monitor.go b/zetaclient/zetacore/client_monitor.go
@@ -58,7 +58,7 @@ func (c *Client) monitorVoteOutboundResult(
 		return errors.Wrap(err, "failed to query tx result")
 	}
 
-	lf := map[string]any{
+	logFields := map[string]any{
 		"outbound.hash":    zetaTxHash,
 		"outbound.raw_log": txResult.RawLog,
 	}
@@ -67,21 +67,21 @@ func (c *Client) monitorVoteOutboundResult(
 	case strings.Contains(txResult.RawLog, "failed to execute message"):
 		// the inbound vote tx shouldn't fail to execute
 		// this shouldn't happen
-		c.logger.Error().Fields(lf).Msg("monitorVoteOutboundResult: failed to execute vote")
+		c.logger.Error().Fields(logFields).Msg("monitorVoteOutboundResult: failed to execute vote")
 	case strings.Contains(txResult.RawLog, "out of gas"):
 		// if the tx fails with an out of gas error, resend the tx with more gas if retryGasLimit > 0
-		c.logger.Debug().Fields(lf).Msg("monitorVoteOutboundResult: out of gas")
+		c.logger.Debug().Fields(logFields).Msg("monitorVoteOutboundResult: out of gas")
 
 		if retryGasLimit > 0 {
 			// new retryGasLimit set to 0 to prevent reentering this function
 			if _, _, err := c.PostVoteOutbound(ctx, retryGasLimit, 0, msg); err != nil {
-				c.logger.Error().Err(err).Fields(lf).Msg("monitorVoteOutboundResult: failed to resend tx")
+				c.logger.Error().Err(err).Fields(logFields).Msg("monitorVoteOutboundResult: failed to resend tx")
 			} else {
-				c.logger.Info().Fields(lf).Msg("monitorVoteOutboundResult: successfully resent tx")
+				c.logger.Info().Fields(logFields).Msg("monitorVoteOutboundResult: successfully resent tx")
 			}
 		}
 	default:
-		c.logger.Debug().Fields(lf).Msg("monitorVoteOutboundResult: successful")
+		c.logger.Debug().Fields(logFields).Msg("monitorVoteOutboundResult: successful")
 	}
 
 	return nil
@@ -133,7 +133,7 @@ func (c *Client) monitorVoteInboundResult(
 		return errors.Wrap(err, "failed to query tx result")
 	}
 
-	lf := map[string]any{
+	logFields := map[string]any{
 		"inbound.hash":    zetaTxHash,
 		"inbound.raw_log": txResult.RawLog,
 	}
@@ -142,23 +142,23 @@ func (c *Client) monitorVoteInboundResult(
 	case strings.Contains(txResult.RawLog, "failed to execute message"):
 		// the inbound vote tx shouldn't fail to execute
 		// this shouldn't happen
-		c.logger.Error().Fields(lf).Msg("monitorVoteInboundResult: failed to execute vote")
+		c.logger.Error().Fields(logFields).Msg("monitorVoteInboundResult: failed to execute vote")
 
 	case strings.Contains(txResult.RawLog, "out of gas"):
 		// if the tx fails with an out of gas error, resend the tx with more gas if retryGasLimit > 0
-		c.logger.Debug().Fields(lf).Msg("monitorVoteInboundResult: out of gas")
+		c.logger.Debug().Fields(logFields).Msg("monitorVoteInboundResult: out of gas")
 
 		if retryGasLimit > 0 {
 			// new retryGasLimit set to 0 to prevent reentering this function
 			if _, _, err := c.PostVoteInbound(ctx, retryGasLimit, 0, msg); err != nil {
-				c.logger.Error().Err(err).Fields(lf).Msg("monitorVoteInboundResult: failed to resend tx")
+				c.logger.Error().Err(err).Fields(logFields).Msg("monitorVoteInboundResult: failed to resend tx")
 			} else {
-				c.logger.Info().Fields(lf).Msg("monitorVoteInboundResult: successfully resent tx")
+				c.logger.Info().Fields(logFields).Msg("monitorVoteInboundResult: successfully resent tx")
 			}
 		}
 
 	default:
-		c.logger.Debug().Fields(lf).Msgf("monitorVoteInboundResult: successful")
+		c.logger.Debug().Fields(logFields).Msgf("monitorVoteInboundResult: successful")
 	}
 
 	return nil