more error messages fixes + removal of pkg/errors

Author: Tofel

lib/utils/seth/seth.go

@@ -1,11 +1,11 @@
 package seth
 
 import (
+	"errors"
 	"fmt"
 	"regexp"
 	"strings"
 
-	"github.com/pkg/errors"
 	"github.com/rs/zerolog"
 
 	pkg_seth "github.com/smartcontractkit/chainlink-testing-framework/seth"
@@ -112,27 +112,29 @@ func GetChainClient(c config.SethConfig, network blockchain.EVMNetwork) (*pkg_se
 func GetChainClientWithConfigFunction(c config.SethConfig, network blockchain.EVMNetwork, configFn ConfigFunction) (*pkg_seth.Client, error) {
 	readSethCfg := c.GetSethConfig()
 	if readSethCfg == nil {
-		return nil, errors.New("Seth config not found")
+		return nil, fmt.Errorf("Seth config not found in the provided configuration. " +
+			"Ensure your TOML config file has a [Seth] section with required settings. " +
+			"See example: https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/seth/seth.toml")
 	}
 
 	sethCfg, err := MergeSethAndEvmNetworkConfigs(network, *readSethCfg)
 	if err != nil {
-		return nil, errors.Wrapf(err, "Error merging seth and evm network configs")
+		return nil, fmt.Errorf("error merging seth and evm network configs: %w", err)
 	}
 
 	err = configFn(&sethCfg)
 	if err != nil {
-		return nil, errors.Wrapf(err, "Error applying seth config function")
+		return nil, fmt.Errorf("error applying seth config function: %w", err)
 	}
 
 	err = ValidateSethNetworkConfig(sethCfg.Network)
 	if err != nil {
-		return nil, errors.Wrapf(err, "Error validating seth network config")
+		return nil, fmt.Errorf("error validating seth network config: %w", err)
 	}
 
 	chainClient, err := pkg_seth.NewClientWithConfig(&sethCfg)
 	if err != nil {
-		return nil, errors.Wrapf(err, "Error creating seth client")
+		return nil, fmt.Errorf("error creating seth client: %w", err)
 	}
 
 	return chainClient, nil
@@ -255,33 +257,47 @@ func MustReplaceSimulatedNetworkUrlWithK8(l zerolog.Logger, network blockchain.E
 // ValidateSethNetworkConfig validates the Seth network config
 func ValidateSethNetworkConfig(cfg *pkg_seth.Network) error {
 	if cfg == nil {
-		return errors.New("network cannot be nil")
+		return fmt.Errorf("network configuration cannot be nil. " +
+			"Ensure your Seth config has properly configured network settings")
 	}
 	if len(cfg.URLs) == 0 {
-		return errors.New("URLs are required")
+		return fmt.Errorf("network URLs are required. " +
+			"Add RPC endpoint URLs in the 'urls_secret' field of your network config")
 	}
 	if len(cfg.PrivateKeys) == 0 {
-		return errors.New("PrivateKeys are required")
+		return fmt.Errorf("private keys are required. " +
+			"Add at least one private key in 'private_keys_secret' or via environment variables")
 	}
 	if cfg.TransferGasFee == 0 {
-		return errors.New("TransferGasFee needs to be above 0. It's the gas fee for a simple transfer transaction")
+		return fmt.Errorf("transfer_gas_fee must be greater than 0. " +
+			"This is the gas fee for a simple transfer transaction. " +
+			"Set 'transfer_gas_fee' in your network config")
 	}
 	if cfg.TxnTimeout.Duration() == 0 {
-		return errors.New("TxnTimeout needs to be above 0. It's the timeout for a transaction")
+		return fmt.Errorf("transaction timeout must be greater than 0. " +
+			"Set 'txn_timeout' in your network config (e.g., '30s', '1m')")
 	}
 	if cfg.EIP1559DynamicFees {
 		if cfg.GasFeeCap == 0 {
-			return errors.New("GasFeeCap needs to be above 0. It's the maximum fee per gas for a transaction (including tip)")
+			return fmt.Errorf("gas_fee_cap must be greater than 0 for EIP-1559 transactions. " +
+				"This is the maximum fee per gas (base fee + tip). " +
+				"Set 'gas_fee_cap' in your network config")
 		}
 		if cfg.GasTipCap == 0 {
-			return errors.New("GasTipCap needs to be above 0. It's the maximum tip per gas for a transaction")
+			return fmt.Errorf("gas_tip_cap must be greater than 0 for EIP-1559 transactions. " +
+				"This is the maximum priority fee per gas. " +
+				"Set 'gas_tip_cap' in your network config")
 		}
 		if cfg.GasFeeCap <= cfg.GasTipCap {
-			return errors.New("GasFeeCap needs to be above GasTipCap (as it is base fee + tip cap)")
+			return fmt.Errorf("gas_fee_cap (%d) must be greater than gas_tip_cap (%d). "+
+				"Fee cap should be base fee + tip cap. "+
+				"Adjust your network config accordingly",
+				cfg.GasFeeCap, cfg.GasTipCap)
 		}
 	} else {
 		if cfg.GasPrice == 0 {
-			return errors.New("GasPrice needs to be above 0. It's the price of gas for a transaction")
+			return fmt.Errorf("gas_price must be greater than 0 for legacy transactions. " +
+				"Set 'gas_price' in your network config")
 		}
 	}
 

seth/abi_finder.go

@@ -1,12 +1,12 @@
 package seth
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/common"
-	"github.com/pkg/errors"
 )
 
 type ABIFinder struct {

seth/client.go

@@ -3,6 +3,7 @@ package seth
 import (
 	"context"
 	"crypto/ecdsa"
+	"errors"
 	"fmt"
 	"math/big"
 	"net/http"
@@ -21,7 +22,6 @@ import (
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
-	"github.com/pkg/errors"
 	"github.com/rs/zerolog"
 	"golang.org/x/sync/errgroup"
 )
@@ -89,8 +89,8 @@ func NewClientWithConfig(cfg *Config) (*Client, error) {
 	initDefaultLogging()
 
 	if cfg == nil {
-		return nil, fmt.Errorf("Seth configuration is nil. "+
-			"Ensure you're calling NewClientWithConfig() with a valid config, or use NewClient() to load from SETH_CONFIG_PATH environment variable. "+
+		return nil, fmt.Errorf("Seth configuration is nil. " +
+			"Ensure you're calling NewClientWithConfig() with a valid config, or use NewClient() to load from SETH_CONFIG_PATH environment variable. " +
 			"See documentation for configuration examples")
 	}
 	if cfgErr := cfg.Validate(); cfgErr != nil {
@@ -199,18 +199,18 @@ func NewClientRaw(
 	opts ...ClientOpt,
 ) (*Client, error) {
 	if cfg == nil {
-		return nil, fmt.Errorf("Seth configuration is nil. "+
-			"Provide a valid Config when calling NewClientRaw(). "+
+		return nil, fmt.Errorf("Seth configuration is nil. " +
+			"Provide a valid Config when calling NewClientRaw(). " +
 			"Consider using NewClient() or NewClientWithConfig() instead")
 	}
 	if cfgErr := cfg.Validate(); cfgErr != nil {
 		return nil, cfgErr
 	}
 	if cfg.ReadOnly && (len(addrs) > 0 || len(pkeys) > 0) {
-		return nil, fmt.Errorf("configuration conflict: read-only mode is enabled, but private keys were provided. "+
-			"Read-only mode is for querying blockchain state only (no transactions).\n"+
-			"To fix:\n"+
-			"  1. Remove private keys if you only need to read data\n"+
+		return nil, fmt.Errorf("configuration conflict: read-only mode is enabled, but private keys were provided. " +
+			"Read-only mode is for querying blockchain state only (no transactions).\n" +
+			"To fix:\n" +
+			"  1. Remove private keys if you only need to read data\n" +
 			"  2. Set 'read_only = false' in config if you need to send transactions")
 	}
 
@@ -219,7 +219,7 @@ func NewClientRaw(
 	if cfg.ethclient == nil {
 		L.Info().Msg("Creating new ethereum client")
 		if len(cfg.Network.URLs) == 0 {
-			return nil, fmt.Errorf("no RPC URLs provided. "+
+			return nil, fmt.Errorf("no RPC URLs provided. " +
 				"Set RPC URLs in your seth.toml config under 'urls_secret = [\"http://...\"]' or provide via WithRpcUrl() when using ClientBuilder")
 		}
 
@@ -323,9 +323,9 @@ func NewClientRaw(
 
 	if cfg.CheckRpcHealthOnStart {
 		if cfg.ReadOnly {
-			return nil, fmt.Errorf("RPC health check is not supported in read-only mode because it requires sending transactions. "+
-				"Either:\n"+
-				"  1. Set 'read_only = false' to enable transaction capabilities\n"+
+			return nil, fmt.Errorf("RPC health check is not supported in read-only mode because it requires sending transactions. " +
+				"Either:\n" +
+				"  1. Set 'read_only = false' to enable transaction capabilities\n" +
 				"  2. Set 'check_rpc_health_on_start = false' to skip the health check")
 		}
 		if c.NonceManager == nil {
@@ -338,9 +338,9 @@ func NewClientRaw(
 	}
 
 	if cfg.PendingNonceProtectionEnabled && cfg.ReadOnly {
-		return nil, fmt.Errorf("pending nonce protection is not supported in read-only mode because it requires transaction monitoring. "+
-			"Either:\n"+
-			"  1. Set 'read_only = false' to enable transaction capabilities\n"+
+		return nil, fmt.Errorf("pending nonce protection is not supported in read-only mode because it requires transaction monitoring. " +
+			"Either:\n" +
+			"  1. Set 'read_only = false' to enable transaction capabilities\n" +
 			"  2. Set 'pending_nonce_protection_enabled = false'")
 	}
 
@@ -356,14 +356,14 @@ func NewClientRaw(
 
 	if cfg.ephemeral {
 		if len(c.Addresses) == 0 {
-			return nil, fmt.Errorf("ephemeral mode requires exactly one root private key to fund ephemeral addresses, but no keys were loaded. "+
-				"Load the root private key via:\n"+
-				"  1. SETH_ROOT_PRIVATE_KEY environment variable\n"+
-				"  2. 'root_private_key' in seth.toml\n"+
+			return nil, fmt.Errorf("ephemeral mode requires exactly one root private key to fund ephemeral addresses, but no keys were loaded. " +
+				"Load the root private key via:\n" +
+				"  1. SETH_ROOT_PRIVATE_KEY environment variable\n" +
+				"  2. 'root_private_key' in seth.toml\n" +
 				"  3. WithPrivateKeys() when using ClientBuilder")
 		}
 		if cfg.ReadOnly {
-			return nil, fmt.Errorf("ephemeral mode is not supported in read-only mode because it requires funding transactions. "+
+			return nil, fmt.Errorf("ephemeral mode is not supported in read-only mode because it requires funding transactions. " +
 				"Set 'read_only = false' or disable ephemeral mode by removing 'ephemeral_addresses_number' from config")
 		}
 		ctx, cancel := context.WithTimeout(context.Background(), c.Cfg.Network.TxnTimeout.D)
@@ -439,9 +439,9 @@ func NewClientRaw(
 	}
 
 	if c.Cfg.GasBump != nil && c.Cfg.GasBump.Retries != 0 && c.Cfg.ReadOnly {
-		return nil, fmt.Errorf("gas bumping is not supported in read-only mode because it requires sending replacement transactions. "+
-			"Either:\n"+
-			"  1. Set 'read_only = false' to enable transaction capabilities\n"+
+		return nil, fmt.Errorf("gas bumping is not supported in read-only mode because it requires sending replacement transactions. " +
+			"Either:\n" +
+			"  1. Set 'read_only = false' to enable transaction capabilities\n" +
 			"  2. Set 'gas_bump.retries = 0' to disable gas bumping")
 	}
 
@@ -1294,10 +1294,10 @@ type DeploymentData struct {
 // name of ABI file (you can omit the .abi suffix).
 func (m *Client) DeployContractFromContractStore(auth *bind.TransactOpts, name string, params ...interface{}) (DeploymentData, error) {
 	if m.ContractStore == nil {
-		return DeploymentData{}, fmt.Errorf("contract store is nil. Cannot deploy contract from store.\n"+
-			"This usually means:\n"+
-			"  1. Seth client wasn't properly initialized\n"+
-			"  2. ABI directory path is incorrect in config\n"+
+		return DeploymentData{}, fmt.Errorf("contract store is nil. Cannot deploy contract from store.\n" +
+			"This usually means:\n" +
+			"  1. Seth client wasn't properly initialized\n" +
+			"  2. ABI directory path is incorrect in config\n" +
 			"Ensure 'abi_dir' and 'bin_dir' are set in seth.toml or use DeployContract() with explicit ABI/bytecode")
 	}
 

seth/client_api_test.go

@@ -2,13 +2,13 @@ package seth_test
 
 import (
 	"context"
+	"errors"
 	"math/big"
 	"sync"
 	"testing"
 	"time"
 
 	"github.com/ethereum/go-ethereum/core/types"
-	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/seth"

seth/client_builder.go

@@ -1,11 +1,11 @@
 package seth
 
 import (
+	"errors"
 	"fmt"
 	"time"
 
 	"github.com/ethereum/go-ethereum/ethclient/simulated"
-	"github.com/pkg/errors"
 )
 
 const (

seth/client_builder_test.go

@@ -2,6 +2,7 @@ package seth_test
 
 import (
 	"crypto/ecdsa"
+	"errors"
 	"math/big"
 	"os"
 	"strings"
@@ -13,7 +14,6 @@ import (
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/pkg/errors"
 
 	"github.com/pelletier/go-toml/v2"
 

seth/client_main_test.go

@@ -2,6 +2,8 @@ package seth_test
 
 import (
 	"context"
+	"errors"
+	"fmt"
 	"math/big"
 	"os"
 	"testing"
@@ -11,7 +13,6 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/ethclient/simulated"
-	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/seth"
@@ -150,7 +151,7 @@ func NewDebugContractSetup() (
 
 	nm, err := seth.NewNonceManager(cfg, addrs, pkeys)
 	if err != nil {
-		return nil, nil, common.Address{}, common.Address{}, nil, errors.Wrap(err, seth.ErrCreateNonceManager)
+		return nil, nil, common.Address{}, common.Address{}, nil, fmt.Errorf("failed to create nonce manager: %w", err)
 	}
 
 	c, err := seth.NewClientRaw(cfg, addrs, pkeys, seth.WithContractStore(cs), seth.WithTracer(tracer), seth.WithNonceManager(nm))

seth/cmd/seth.go

@@ -2,6 +2,7 @@ package seth
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"math/big"
 	"os"
@@ -12,7 +13,6 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/pelletier/go-toml/v2"
-	"github.com/pkg/errors"
 	"github.com/urfave/cli/v2"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/seth"
@@ -205,11 +205,11 @@ func RunCLI(args []string) error {
 					var cfg *seth.Config
 					d, err := os.ReadFile(cfgPath)
 					if err != nil {
-						return errors.Wrap(err, seth.ErrReadSethConfig)
+						return fmt.Errorf("%s: %w", seth.ErrReadSethConfig, err)
 					}
 					err = toml.Unmarshal(d, &cfg)
 					if err != nil {
-						return errors.Wrap(err, seth.ErrUnmarshalSethConfig)
+						return fmt.Errorf("%s: %w", seth.ErrUnmarshalSethConfig, err)
 					}
 					absPath, err := filepath.Abs(cfgPath)
 					if err != nil {
@@ -272,7 +272,7 @@ func RunCLI(args []string) error {
 						if cfg.Network.Name == seth.DefaultNetworkName {
 							chainId, err := client.ChainID(context.Background())
 							if err != nil {
-								return errors.Wrap(err, "failed to get chain ID")
+								return fmt.Errorf("failed to get chain ID: %w", err)
 							}
 							cfg.Network.ChainID = chainId.Uint64()
 						}
@@ -298,7 +298,7 @@ func RunCLI(args []string) error {
 						tx, _, err := client.Client.TransactionByHash(ctx, common.HexToHash(txHash))
 						cancel()
 						if err != nil {
-							return errors.Wrapf(err, "failed to get transaction %s", txHash)
+							return fmt.Errorf("failed to get transaction %s: %w", txHash, err)
 						}
 
 						_, err = client.Decode(tx, nil)