Submitter: don't bump transactions without sufficient gas

ethergo/submitter/chain_queue.go

@@ -81,11 +81,18 @@ func (t *txSubmitterImpl) chainPendingQueue(parentCtx context.Context, chainID *
 		client:          chainClient,
 	}
 
+	sufficientGas, err := cq.hasSufficientGas(gCtx)
+	if err != nil {
+		return fmt.Errorf("could not check gas balance: %w", err)
+	}
+	span.SetAttributes(attribute.Bool("sufficient_gas", sufficientGas))
+
 	// so now, we have a list of transactions that need to be resubmitted.
 	// these are already ordered by nonce and we should have at most one per nonce, so we can just iterate through them.
 	// we need to figure out which ones are still valid, and which ones need to be bumped.
-	// once this is done, we'll be ready to submit them
-	// we're going to handle this by updating txes in place
+	// once this is done, we'll be ready to submit them.
+	// we're going to handle this by updating txes in place.
+	// note that if we do not have sufficient gas on this chain, no txes will be bumped.
 	for i := range txes {
 		tx := txes[i]
 
@@ -94,7 +101,9 @@ func (t *txSubmitterImpl) chainPendingQueue(parentCtx context.Context, chainID *
 			continue
 		}
 
-		cq.bumpTX(gCtx, tx)
+		if sufficientGas {
+			cq.bumpTX(gCtx, tx)
+		}
 	}
 	cq.updateOldTxStatuses(gCtx)
 
@@ -337,3 +346,29 @@ func (c *chainQueue) updateOldTxStatuses(parentCtx context.Context) {
 		return nil
 	})
 }
+
+func (c *chainQueue) hasSufficientGas(parentCtx context.Context) (sufficient bool, err error) {
+	ctx, span := c.metrics.Tracer().Start(parentCtx, "hasSufficientGas")
+	defer func() {
+		metrics.EndSpanWithErr(span, err)
+	}()
+
+	// assume that if we don't have a min gas balance, we have enough gas.
+	minGasBalance := c.config.GetMinGasBalance(c.chainIDInt())
+	if minGasBalance == nil || minGasBalance.Cmp(big.NewInt(0)) == 0 {
+		return true, nil
+	}
+
+	gasBalance, err := c.client.BalanceAt(ctx, c.signer.Address(), nil)
+	if err != nil {
+		return false, fmt.Errorf("could not get gas balance: %w", err)
+	}
+	sufficient = gasBalance.Cmp(minGasBalance) >= 0
+
+	span.SetAttributes(
+		attribute.String("min_gas_balance", minGasBalance.String()),
+		attribute.String("gas_balance", gasBalance.String()),
+		attribute.Bool("sufficient", sufficient),
+	)
+	return sufficient, nil
+}

ethergo/submitter/config/config.go

@@ -45,6 +45,8 @@ type ChainConfig struct {
 	DynamicGasEstimate bool `yaml:"dynamic_gas_estimate"`
 	// SupportsEIP1559 is whether or not this chain supports EIP1559
 	SupportsEIP1559 bool `yaml:"supports_eip_1559"`
+	// MinGasBalance is the minimum gas balance needed to bump a transaction
+	MinGasBalance *big.Int `yaml:"min_gas_balance"`
 }
 
 const (
@@ -200,6 +202,15 @@ func (c *Config) SupportsEIP1559(chainID int) bool {
 	return c.ChainConfig.SupportsEIP1559
 }
 
+// GetMinGasBalance returns the minimum gas balance needed to bump a transaction.
+func (c *Config) GetMinGasBalance(chainID int) *big.Int {
+	chainConfig, ok := c.Chains[chainID]
+	if ok {
+		return chainConfig.MinGasBalance
+	}
+	return c.MinGasBalance
+}
+
 // SetGlobalMaxGasPrice is a helper function that sets the global gas price.
 func (c *Config) SetGlobalMaxGasPrice(maxPrice *big.Int) {
 	c.MaxGasPrice = maxPrice