review error messages once more

Author: Tofel

seth/abi_finder.go

@@ -137,28 +137,8 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 	}
 
 	if result.Method == nil {
-		abiCount := len(a.ContractStore.ABIs)
-		abiSample := ""
-		if abiCount > 0 {
-			// Show first few ABIs as examples (max 5)
-			sampleSize := min(abiCount, 5)
-			samples := make([]string, 0, sampleSize)
-			count := 0
-			for abiName := range a.ContractStore.ABIs {
-				if count >= sampleSize {
-					break
-				}
-				samples = append(samples, strings.TrimSuffix(abiName, ".abi"))
-				count++
-			}
-			abiSample = fmt.Sprintf("\nExample ABIs loaded: %s", strings.Join(samples, ", "))
-			if abiCount > sampleSize {
-				abiSample += fmt.Sprintf(" (and %d more)", abiCount-sampleSize)
-			}
-		}
-
 		return ABIFinderResult{}, fmt.Errorf("no ABI found with method signature %s for contract at address %s.\n"+
-			"Checked %d ABIs but none matched.%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"+
 			"  2. Method signature doesn't match any function in loaded ABIs\n"+
@@ -170,7 +150,7 @@ func (a *ABIFinder) FindABIByMethod(address string, signature []byte) (ABIFinder
 			"  3. Ensure ABI file exists in the directory specified by 'abi_dir'\n"+
 			"  4. Review contract_map_file for address-to-name mappings\n"+
 			"  5. Use ContractStore.AddABI() to manually add the ABI",
-			stringSignature, address, abiCount, abiSample)
+			stringSignature, address, len(a.ContractStore.ABIs))
 	}
 
 	return result, nil

seth/client.go

@@ -30,6 +30,9 @@ const (
 	ErrEmptyConfigPath          = "toml config path is empty, set SETH_CONFIG_PATH"
 	ErrContractDeploymentFailed = "contract deployment failed"
 
+	// unused by Seth, but used by upstream
+	ErrNoKeyLoaded = "failed to load private key"
+
 	ContractMapFilePattern          = "deployed_contracts_%s_%s.toml"
 	RevertedTransactionsFilePattern = "reverted_transactions_%s_%s.json"
 )
@@ -148,7 +151,13 @@ func NewClientWithConfig(cfg *Config) (*Client, error) {
 		tr, err := NewTracer(cs, &abiFinder, cfg, contractAddressToNameMap, addrs)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create transaction tracer: %w\n"+
-				"This is usually caused by RPC connection issues. Verify your RPC endpoint is accessible",
+				"Possible causes:\n"+
+				"  1. RPC endpoint is not accessible\n"+
+				"  2. RPC node doesn't support debug_traceTransaction API\n"+
+				"Solutions:\n"+
+				"  1. Verify RPC endpoint URL is correct and accessible\n"+
+				"  2. Use an RPC node with debug API enabled (archive node recommended)\n"+
+				"  3. Set tracing_level = 'NONE' in config to disable tracing",
 				err)
 		}
 		opts = append(opts, WithTracer(tr))
@@ -181,7 +190,7 @@ func NewClientRaw(
 	opts ...ClientOpt,
 ) (*Client, error) {
 	if cfg == nil {
-		return nil, fmt.Errorf("Seth configuration is nil. " +
+		return nil, fmt.Errorf("seth configuration is nil. " +
 			"Provide a valid Config when calling NewClientRaw(). " +
 			"Consider using NewClient() or NewClientWithConfig() instead")
 	}
@@ -393,7 +402,13 @@ func NewClientRaw(
 		tr, err := NewTracer(c.ContractStore, c.ABIFinder, cfg, c.ContractAddressToNameMap, addrs)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create transaction tracer: %w\n"+
-				"Ensure RPC endpoint supports debug_traceTransaction or set tracing_level = 'NONE'",
+				"Possible causes:\n"+
+				"  1. RPC endpoint is not accessible\n"+
+				"  2. RPC node doesn't support debug_traceTransaction API\n"+
+				"Solutions:\n"+
+				"  1. Verify RPC endpoint URL is correct and accessible\n"+
+				"  2. Use an RPC node with debug API enabled (archive node recommended)\n"+
+				"  3. Set tracing_level = 'NONE' in config to disable tracing",
 				err)
 		}
 
@@ -1280,70 +1295,29 @@ func (m *Client) DeployContractFromContractStore(auth *bind.TransactOpts, name s
 			"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")
+			"Solutions:\n" +
+			"  1. Set 'abi_dir' and 'bin_dir' in seth.toml config file\n" +
+			"  2. Use ClientBuilder: builder.WithABIDir(path).WithBINDir(path)\n" +
+			"  3. Use DeployContract() method with explicit ABI/bytecode instead")
 	}
 
 	name = strings.TrimSuffix(name, ".abi")
 	name = strings.TrimSuffix(name, ".bin")
 
 	contractAbi, ok := m.ContractStore.ABIs[name+".abi"]
 	if !ok {
-		abiCount := len(m.ContractStore.ABIs)
-		abiSample := ""
-		if abiCount > 0 {
-			// Show first few ABIs as examples (max 5)
-			sampleSize := 5
-			if abiCount < sampleSize {
-				sampleSize = abiCount
-			}
-			samples := make([]string, 0, sampleSize)
-			count := 0
-			for abiName := range m.ContractStore.ABIs {
-				if count >= sampleSize {
-					break
-				}
-				samples = append(samples, strings.TrimSuffix(abiName, ".abi"))
-				count++
-			}
-			abiSample = fmt.Sprintf("\nExample ABIs available: %s", strings.Join(samples, ", "))
-			if abiCount > sampleSize {
-				abiSample += fmt.Sprintf(" (and %d more)", abiCount-sampleSize)
-			}
-		}
 		return DeploymentData{}, fmt.Errorf("ABI for contract '%s' not found in contract store.\n"+
-			"Total ABIs loaded: %d%s\n"+
+			"Total ABIs loaded: %d\n"+
 			"Ensure the ABI file '%s.abi' exists in the directory specified by 'abi_dir' in your config",
-			name, abiCount, abiSample, name)
+			name, len(m.ContractStore.ABIs), name)
 	}
 
 	bytecode, ok := m.ContractStore.BINs[name+".bin"]
 	if !ok {
-		binCount := len(m.ContractStore.BINs)
-		binSample := ""
-		if binCount > 0 {
-			// Show first few BINs as examples (max 5)
-			sampleSize := 5
-			if binCount < sampleSize {
-				sampleSize = binCount
-			}
-			samples := make([]string, 0, sampleSize)
-			count := 0
-			for binName := range m.ContractStore.BINs {
-				if count >= sampleSize {
-					break
-				}
-				samples = append(samples, strings.TrimSuffix(binName, ".bin"))
-				count++
-			}
-			binSample = fmt.Sprintf("\nExample BINs available: %s", strings.Join(samples, ", "))
-			if binCount > sampleSize {
-				binSample += fmt.Sprintf(" (and %d more)", binCount-sampleSize)
-			}
-		}
 		return DeploymentData{}, fmt.Errorf("bytecode (BIN) for contract '%s' not found in contract store.\n"+
-			"Total BINs loaded: %d%s\n"+
+			"Total BINs loaded: %d\n"+
 			"Ensure the BIN file '%s.bin' exists in the directory specified by 'bin_dir' in your config",
-			name, binCount, binSample, name)
+			name, len(m.ContractStore.BINs), name)
 	}
 
 	data, err := m.DeployContract(auth, name, contractAbi, bytecode, params...)
@@ -1587,7 +1561,7 @@ func (m *Client) validateAddressesKeyNum(keyNum int) error {
 		if len(m.Addresses) == 0 {
 			return fmt.Errorf("no addresses loaded, but tried to use key #%d.\n"+
 				"This should not happen if private keys were loaded correctly. "+
-				"Please report this as a bug",
+				"Please report this issue at https://github.com/smartcontractkit/chainlink-testing-framework/issues with the stack trace",
 				keyNum)
 		}
 		return fmt.Errorf("keyNum %d is out of range. Available addresses: 0-%d (total: %d addresses loaded).\n"+

seth/config.go

@@ -139,9 +139,8 @@ func ReadConfig() (*Config, error) {
 	if err != nil {
 		return nil, fmt.Errorf("failed to read Seth config file at '%s': %w\n"+
 			"Ensure:\n"+
-			"  1. The file exists at the specified path\n"+
-			"  2. You have read permissions for the file\n"+
-			"  3. The path is correct (set via SETH_CONFIG_PATH or parameter)",
+			"  1. The file exists at the specified path (set via SETH_CONFIG_PATH)\n"+
+			"  2. You have read permissions for the file",
 			cfgPath, err)
 	}
 	err = toml.Unmarshal(d, &cfg)
@@ -214,9 +213,8 @@ func ReadConfig() (*Config, error) {
 		return nil, fmt.Errorf("no root private key was set. "+
 			"You can provide the root private key via:\n"+
 			"  1. %s environment variable (without 0x prefix)\n"+
-			"  2. 'root_private_key' field in seth.toml\n"+
-			"  3. WithPrivateKeys() when using ClientBuilder\n"+
-			"WARNING: Never commit private keys to source control. Use environment variables or secure secret management",
+			"  2. 'private_keys_secret' array in seth.toml [[networks]] section\n"+
+			"WARNING: Never commit private keys to source control. We recommend to use the environment variable.",
 			ROOT_PRIVATE_KEY_ENV_VAR)
 	}
 	cfg.Network.PrivateKeys = append(cfg.Network.PrivateKeys, rootPrivateKey)
@@ -298,7 +296,7 @@ func (c *Config) Validate() error {
 	case TracingLevel_All:
 	default:
 		return fmt.Errorf("invalid tracing level '%s'. Must be one of: 'NONE', 'REVERTED', 'ALL'. "+
-			"Set 'tracing_level' in your seth.toml config.\n"+
+			"Set 'tracing_level' in your seth.toml config or via WithTracing() option, if using ClientBuilder().\n"+
 			"Recommended: 'REVERTED' for debugging failed transactions, 'NONE' to disable tracing completely",
 			c.TracingLevel)
 	}
@@ -310,7 +308,7 @@ func (c *Config) Validate() error {
 		case TraceOutput_DOT:
 		default:
 			return fmt.Errorf("invalid trace output '%s'. Must be one of: 'console', 'json', 'dot'. "+
-				"Set 'trace_outputs' in your seth.toml config. "+
+				"Set 'trace_outputs' in your seth.toml config or via WithTracing() option, if using ClientBuilder()"+
 				"You can specify multiple outputs as an array",
 				output)
 		}

seth/contract_store.go

@@ -243,7 +243,7 @@ func (c *ContractStore) loadGethWrappers(gethWrappersPaths []string) error {
 			"  2. Generate wrappers using abigen:\n"+
 			"     abigen --abi contract.abi --bin contract.bin --pkg wrappers --out contract_wrapper.go\n"+
 			"  3. Ensure wrapper files contain ABI metadata (check for 'ABI' variable)\n"+
-			"  4. If not using geth wrappers, remove 'geth_wrappers_dirs' from config",
+			"  4. If not using geth wrappers, remove 'geth_wrappers_dirs' from config (seth.toml or ClientBuilder)",
 			gethWrappersPaths)
 	}
 

seth/decode.go

@@ -440,7 +440,10 @@ func (m *Client) decodeTransaction(l zerolog.Logger, tx *types.Transaction, rece
 	txInput, err = decodeTxInputs(l, txData, abiResult.Method)
 	if err != nil {
 		return defaultTxn, fmt.Errorf("failed to decode transaction input for method '%s': %w\n"+
-			"The transaction data doesn't match the expected ABI method signature",
+			"This could be due to:\n"+
+			"  1. Transaction data doesn't match the ABI method signature\n"+
+			"  2. Incorrect ABI for this contract\n"+
+			"  3. Malformed transaction data",
 			abiResult.Method.Name, err)
 	}
 

seth/gas_adjuster.go

@@ -679,7 +679,7 @@ func (m *Client) HistoricalFeeData(ctx context.Context, priority string) (baseFe
 		percentileTip = 25
 	default:
 		err = fmt.Errorf("unsupported transaction priority '%s'. "+
-			"Valid priorities: 'fast', 'standard', 'slow'. "+
+			"Valid priorities: 'degen' (internal), 'fast', 'standard', 'slow'. "+
 			"Set 'gas_price_estimation_tx_priority' in your config (seth.toml or ClientBuilder)",
 			priority)
 		L.Debug().
@@ -712,7 +712,7 @@ func (m *Client) HistoricalFeeData(ctx context.Context, priority string) (baseFe
 		baseFee = stats.BaseFeePerc.Perc25
 	default:
 		err = fmt.Errorf("unsupported transaction priority '%s'. "+
-			"Valid priorities: 'fast', 'standard', 'slow'. "+
+			"Valid priorities: 'degen' (internal), 'fast', 'standard', 'slow'. "+
 			"Set 'gas_price_estimation_tx_priority' in your config (seth.toml or ClientBuilder)",
 			priority)
 		L.Debug().

seth/nonce.go

@@ -65,7 +65,7 @@ func validateNonceManagerConfig(nonceManagerCfg *NonceManagerCfg) error {
 // NewNonceManager creates a new nonce manager that tracks nonce for each address
 func NewNonceManager(cfg *Config, addrs []common.Address, privKeys []*ecdsa.PrivateKey) (*NonceManager, error) {
 	if cfg == nil {
-		return nil, fmt.Errorf("Seth configuration is nil. Cannot create nonce manager without valid configuration.\n" +
+		return nil, fmt.Errorf("seth configuration is nil. Cannot create nonce manager without valid configuration.\n" +
 			"This usually means you're trying to create a nonce manager before initializing Seth.\n" +
 			"Solutions:\n" +
 			"  1. Use NewClient() or NewClientWithConfig() to create a Seth client first\n" +