wrap error correctly

Author: Tofel

seth/abi_finder.go

@@ -61,7 +61,7 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 				Str("Contract", contractName).
 				Str("Address", address).
 				Msg("ABI not found for known contract")
-			return ABIFinderResult{}, err
+			return ABIFinderResult{}, fmt.Errorf("%w: %v", ErrNoABIMethod, err)
 		}
 
 		methodCandidate, err := abiInstanceCandidate.MethodById(signature)
@@ -99,7 +99,7 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 				Str("Supposed address", address).
 				Msg("Method not found in known ABI instance. This should not happen. Contract map might be corrupted")
 
-			return ABIFinderResult{}, err
+			return ABIFinderResult{}, fmt.Errorf("%w: %v", ErrNoABIMethod, err)
 		}
 
 		result.Method = methodCandidate
@@ -137,7 +137,7 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 	}
 
 	if result.Method == nil {
-		return ABIFinderResult{}, fmt.Errorf("no ABI found with method signature %s for contract at address %s.\n"+
+		err := fmt.Errorf("no ABI found with method signature %s for contract at address %s.\n"+
 			"Checked %d ABIs but none matched.\n"+
 			"Possible causes:\n"+
 			"  1. Contract ABI not loaded (check abi_dir and contract_map_file)\n"+
@@ -151,6 +151,8 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 			"  4. Review contract_map_file for address-to-name mappings\n"+
 			"  5. Use ContractStore.AddABI() to manually add the ABI",
 			stringSignature, address, len(a.ContractStore.ABIs))
+
+		return ABIFinderResult{}, fmt.Errorf("%w: %v", ErrNoABIMethod, err)
 	}
 
 	return result, nil

seth/client.go

@@ -987,7 +987,7 @@ func (m *Client) CalculateGasEstimations(request GasEstimationRequest) GasEstima
 	defer cancel()
 
 	var disableEstimationsIfNeeded = func(err error) {
-		if strings.Contains(err.Error(), ZeroGasSuggestedErr) {
+		if errors.Is(err, GasEstimationErr) {
 			L.Warn().Msg("Received incorrect gas estimations. Disabling them and reverting to hardcoded values. Remember to update your config!")
 			m.Cfg.Network.GasPriceEstimationEnabled = false
 		}
@@ -1469,7 +1469,7 @@ func (m *Client) decodeContractLogs(l zerolog.Logger, logs []types.Log, allABIs
 			for i, topic := range lo.Topics {
 				topics[i] = topic.Hex()
 			}
-			
+
 			decodeError := EventDecodingError{
 				Signature: eventSig,
 				LogIndex:  lo.Index,
@@ -1478,12 +1478,12 @@ func (m *Client) decodeContractLogs(l zerolog.Logger, logs []types.Log, allABIs
 				Errors:    decodeAttempts,
 			}
 			decodeErrors = append(decodeErrors, decodeError)
-			
+
 			abiNames := make([]string, len(decodeAttempts))
 			for i, attempt := range decodeAttempts {
 				abiNames[i] = attempt.ABIName
 			}
-			
+
 			l.Warn().
 				Str("Signature", eventSig).
 				Uint("LogIndex", lo.Index).
@@ -1522,13 +1522,13 @@ func (m *Client) findABIName(targetABI *abi.ABI) string {
 	if m.ContractStore == nil {
 		return "unknown"
 	}
-	
+
 	for name, storedABI := range m.ContractStore.ABIs {
 		if reflect.DeepEqual(storedABI, *targetABI) {
 			return strings.TrimSuffix(name, ".abi")
 		}
 	}
-	
+
 	return "unknown"
 }
 

seth/decode.go

@@ -20,45 +20,40 @@ import (
 	"github.com/rs/zerolog"
 )
 
-const (
-	ErrDecodeInput          = "failed to decode transaction input"
-	ErrDecodeOutput         = "failed to decode transaction output"
-	ErrDecodeLog            = "failed to decode log"
-	ErrDecodedLogNonIndexed = "failed to decode non-indexed log data"
-	ErrDecodeILogIndexed    = "failed to decode indexed log data"
-	ErrTooShortTxData       = "tx data is less than 4 bytes, can't decode"
-	ErrRPCJSONCastError     = "failed to cast CallMsg error as rpc.DataError"
-	ErrUnableToDecode       = "unable to decode revert reason"
+var (
+	ErrNoABIMethod = errors.New("no ABI method found")
+)
 
+const (
 	WarnNoContractStore = "ContractStore is nil, use seth.NewContractStore(...) to decode transactions"
 )
 
 // DecodedTransaction decoded transaction
 type DecodedTransaction struct {
 	CommonData
-	Index              uint                    `json:"index"`
-	Hash               string                  `json:"hash,omitempty"`
-	Protected          bool                    `json:"protected,omitempty"`
-	Transaction        *types.Transaction      `json:"transaction,omitempty"`
-	Receipt            *types.Receipt          `json:"receipt,omitempty"`
-	Events             []DecodedTransactionLog `json:"events,omitempty"`
+	Index               uint                    `json:"index"`
+	Hash                string                  `json:"hash,omitempty"`
+	Protected           bool                    `json:"protected,omitempty"`
+	Transaction         *types.Transaction      `json:"transaction,omitempty"`
+	Receipt             *types.Receipt          `json:"receipt,omitempty"`
+	Events              []DecodedTransactionLog `json:"events,omitempty"`
 	EventDecodingErrors []EventDecodingError    `json:"event_decoding_errors,omitempty"`
 }
 
 // EventDecodingError represents a failed event decode attempt
 type EventDecodingError struct {
-	Signature    string                 `json:"signature"`
-	LogIndex     uint                   `json:"log_index"`
-	Address      string                 `json:"address"`
-	Topics       []string               `json:"topics,omitempty"`
-	Errors       []ABIDecodingError     `json:"errors,omitempty"`
+	Signature string             `json:"signature"`
+	LogIndex  uint               `json:"log_index"`
+	Address   string             `json:"address"`
+	Topics    []string           `json:"topics,omitempty"`
+	Errors    []ABIDecodingError `json:"errors,omitempty"`
 }
 
 // ABIDecodingError represents a single ABI decode attempt failure
 type ABIDecodingError struct {
-	ABIName    string `json:"abi_name"`
-	EventName  string `json:"event_name"`
-	Error      string `json:"error"`
+	ABIName   string `json:"abi_name"`
+	EventName string `json:"event_name"`
+	Error     string `json:"error"`
 }
 
 type CommonData struct {
@@ -196,7 +191,7 @@ func (m *Client) DecodeTx(tx *types.Transaction) (*DecodedTransaction, error) {
 			Msg("No post-decode hook found. Skipping")
 	}
 
-	if decodeErr != nil && errors.Is(decodeErr, errors.New(ErrNoABIMethod)) {
+	if decodeErr != nil && errors.Is(decodeErr, ErrNoABIMethod) {
 		m.handleTxDecodingError(l, *decoded, decodeErr)
 		return decoded, revertErr
 	}
@@ -524,21 +519,21 @@ func (m *Client) printDecodedTXData(l zerolog.Logger, ptx *DecodedTransaction) {
 			Interface("Data", e.EventData).
 			Msg("Event emitted")
 	}
-	
+
 	// Print event decoding errors separately
 	if len(ptx.EventDecodingErrors) > 0 {
 		l.Warn().
 			Int("Failed event decodes", len(ptx.EventDecodingErrors)).
 			Msg("Some events could not be decoded")
-		
+
 		for _, decodeErr := range ptx.EventDecodingErrors {
 			abiNames := make([]string, len(decodeErr.Errors))
 			errorMsgs := make([]string, len(decodeErr.Errors))
 			for i, abiErr := range decodeErr.Errors {
 				abiNames[i] = abiErr.ABIName
 				errorMsgs[i] = fmt.Sprintf("%s.%s: %s", abiErr.ABIName, abiErr.EventName, abiErr.Error)
 			}
-			
+
 			l.Warn().
 				Str("Signature", decodeErr.Signature).
 				Uint("LogIndex", decodeErr.LogIndex).

seth/gas_adjuster.go

@@ -7,7 +7,6 @@ import (
 	"math"
 	"math/big"
 	"slices"
-	"strings"
 	"sync"
 	"time"
 
@@ -37,17 +36,19 @@ const (
 )
 
 var (
-	ZeroGasSuggestedErr = "either base fee or suggested tip is 0"
-	BlockFetchingErr    = "failed to fetch enough block headers for congestion calculation"
+	GasEstimationErr = errors.New("incorrect gas data received from node. Skipping gas estimation")
+	BlockFetchingErr = errors.New("failed to fetch enough block headers for congestion calculation")
 )
 
 // CalculateNetworkCongestionMetric calculates a simple congestion metric based on the last N blocks
 // according to selected strategy.
 func (m *Client) CalculateNetworkCongestionMetric(blocksNumber uint64, strategy string) (float64, error) {
 	if m.HeaderCache == nil {
-		return 0, fmt.Errorf("header cache is not initialized. " +
+		err := fmt.Errorf("header cache is not initialized. " +
 			"This is an internal error that shouldn't happen. " +
 			"If you see this, please open a GitHub issue at https://github.com/smartcontractkit/chainlink-testing-framework/issues with your configuration details")
+		err = fmt.Errorf("%w: %v", BlockFetchingErr, err)
+		return 0, err
 	}
 	var getHeaderData = func(bn *big.Int) (*types.Header, error) {
 		if bn == nil {
@@ -80,13 +81,15 @@ func (m *Client) CalculateNetworkCongestionMetric(blocksNumber uint64, strategy
 	defer cancel()
 	lastBlockNumber, err := m.Client.BlockNumber(ctx)
 	if err != nil {
+		err = fmt.Errorf("%w: %v", BlockFetchingErr, err)
 		return 0, err
 	}
 
 	L.Trace().Msgf("Block range for gas calculation: %d - %d", lastBlockNumber-blocksNumber, lastBlockNumber)
 
 	lastBlock, err := getHeaderData(big.NewInt(mustSafeInt64(lastBlockNumber)))
 	if err != nil {
+		err = fmt.Errorf("%w: %v", BlockFetchingErr, err)
 		return 0, err
 	}
 
@@ -133,7 +136,7 @@ func (m *Client) CalculateNetworkCongestionMetric(blocksNumber uint64, strategy
 
 	minBlockCount := int(float64(blocksNumber) * 0.8)
 	if len(headers) < minBlockCount {
-		return 0, fmt.Errorf("failed to fetch sufficient block headers for gas estimation. "+
+		err := fmt.Errorf("failed to fetch sufficient block headers for gas estimation. "+
 			"Needed at least %d blocks, but only got %d (%.1f%% success rate).\n"+
 			"This usually indicates:\n"+
 			"  1. RPC node is experiencing high latency or load\n"+
@@ -145,6 +148,9 @@ func (m *Client) CalculateNetworkCongestionMetric(blocksNumber uint64, strategy
 			"  3. Disable gas estimation: set gas_price_estimation_enabled = false\n"+
 			"  4. Reduce gas_price_estimation_blocks to fetch fewer blocks",
 			minBlockCount, len(headers), float64(len(headers))/float64(blocksNumber)*100)
+		err = fmt.Errorf("%w: %v", BlockFetchingErr, err)
+
+		return 0, err
 	}
 
 	switch strategy {
@@ -153,10 +159,12 @@ func (m *Client) CalculateNetworkCongestionMetric(blocksNumber uint64, strategy
 	case CongestionStrategy_NewestFirst:
 		return calculateNewestFirstNetworkCongestionMetric(headers), nil
 	default:
-		return 0, fmt.Errorf("unknown network congestion strategy '%s'. "+
+		err := fmt.Errorf("unknown network congestion strategy '%s'. "+
 			"Valid strategies are: 'simple' (equal weight) or 'newest_first' (recent blocks weighted more).\n"+
 			"This is likely a configuration error. Check your gas estimation settings",
 			strategy)
+		err = fmt.Errorf("%w: %v", BlockFetchingErr, err)
+		return 0, err
 	}
 }
 
@@ -209,13 +217,15 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 			// fallback to current fees if historical fetching fails
 			baseFee, currentGasTip, err = m.currentIP1559Fees(ctx)
 			if err != nil {
+				err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 				return
 			}
 			L.Debug().Msg("Falling back to current EIP-1559 fees for gas estimation")
 		}
 	} else {
 		baseFee, currentGasTip, err = m.currentIP1559Fees(ctx)
 		if err != nil {
+			err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 			return
 		}
 	}
@@ -227,6 +237,7 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 			"  1. Use a different RPC endpoint\n" +
 			"  2. Disable gas estimation: set gas_price_estimation_enabled = false in config\n" +
 			"  3. Set explicit gas values: gas_price, gas_fee_cap, and gas_tip_cap (in your config (seth.toml or ClientBuilder)")
+		err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 		return
 	}
 
@@ -267,6 +278,7 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 			Int64("SuggestedTip", currentGasTip.Int64()).
 			Msgf("Incorrect gas data received from node: base fee was 0. Skipping gas estimation")
 		err = errors.New("incorrect gas data received from node: base fee was 0. Skipping gas estimation")
+		err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 		return
 	}
 
@@ -283,6 +295,7 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 	var adjustmentFactor float64
 	adjustmentFactor, err = getAdjustmentFactor(priority)
 	if err != nil {
+		err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 		return
 	}
 
@@ -315,6 +328,7 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 			var bufferAdjustment float64
 			bufferAdjustment, err = getCongestionFactor(congestionClassification)
 			if err != nil {
+				err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 				return
 			}
 
@@ -325,7 +339,8 @@ func (m *Client) GetSuggestedEIP1559Fees(ctx context.Context, priority string) (
 			// Apply buffer also to the tip
 			bufferedTipCapFloat := new(big.Float).Mul(new(big.Float).SetInt(adjustedTipCap), big.NewFloat(bufferAdjustment))
 			adjustedTipCap, _ = bufferedTipCapFloat.Int(nil)
-		} else if !strings.Contains(err.Error(), BlockFetchingErr) {
+		} else if !errors.Is(err, BlockFetchingErr) {
+			err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 			return
 		} else {
 			L.Debug().
@@ -550,7 +565,7 @@ func (m *Client) GetSuggestedLegacyFees(ctx context.Context, priority string) (a
 		}))
 
 	if retryErr != nil {
-		err = retryErr
+		err = fmt.Errorf("%w: %v", GasEstimationErr, retryErr)
 		return
 	}
 
@@ -562,6 +577,7 @@ func (m *Client) GetSuggestedLegacyFees(ctx context.Context, priority string) (a
 	var adjustmentFactor float64
 	adjustmentFactor, err = getAdjustmentFactor(priority)
 	if err != nil {
+		err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 		return
 	}
 
@@ -589,13 +605,15 @@ func (m *Client) GetSuggestedLegacyFees(ctx context.Context, priority string) (a
 			var bufferAdjustment float64
 			bufferAdjustment, err = getCongestionFactor(congestionClassification)
 			if err != nil {
+				err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 				return
 			}
 
 			// Calculate and apply the buffer.
 			bufferedGasPriceFloat := new(big.Float).Mul(new(big.Float).SetInt(adjustedGasPrice), big.NewFloat(bufferAdjustment))
 			adjustedGasPrice, _ = bufferedGasPriceFloat.Int(nil)
-		} else if !strings.Contains(err.Error(), BlockFetchingErr) {
+		} else if !errors.Is(err, BlockFetchingErr) {
+			err = fmt.Errorf("%w: %v", GasEstimationErr, err)
 			return
 		} else {
 			L.Debug().