Add missing docs for public functions

Author: lukaszcl

seth/client.go

@@ -155,6 +155,11 @@ func NewClientWithConfig(cfg *Config) (*Client, error) {
 	)
 }
 
+// ValidateConfig checks and validates the provided Config struct.
+// It ensures essential fields have valid values or default to appropriate values
+// when necessary. This function performs validation on gas price estimation,
+// gas limit, tracing level, trace outputs, network dial timeout, and pending nonce protection timeout.
+// If any configuration is invalid, it returns an error.
 func ValidateConfig(cfg *Config) error {
 	if cfg.Network.GasPriceEstimationEnabled {
 		if cfg.Network.GasPriceEstimationBlocks == 0 {
@@ -454,6 +459,10 @@ func (m *Client) checkRPCHealth() error {
 	return nil
 }
 
+// TransferETHFromKey initiates a transfer of Ether from a specified key to a recipient address.
+// It validates the private key index, estimates gas limit if not provided, and sends the transaction.
+// The function signs and sends an Ethereum transaction using the specified fromKeyNum and recipient address,
+// with the specified amount and gas price.
 func (m *Client) TransferETHFromKey(ctx context.Context, fromKeyNum int, to string, value *big.Int, gasPrice *big.Int) error {
 	if err := m.validatePrivateKeysKeyNum(fromKeyNum); err != nil {
 		return err

seth/decode.go

@@ -337,6 +337,7 @@ func (m *Client) handleDisabledTracing(l zerolog.Logger, decoded DecodedTransact
 	}
 }
 
+// MergeEventData merges new event data into the existing EventData map in the DecodedTransactionLog.
 func (d *DecodedCommonLog) MergeEventData(newEventData map[string]interface{}) {
 	if d.EventData == nil {
 		d.EventData = make(map[string]interface{})
@@ -541,6 +542,8 @@ func (m *Client) CallMsgFromTx(tx *types.Transaction) (ethereum.CallMsg, error)
 	}, nil
 }
 
+// DownloadContractAndGetPragma retrieves the bytecode of a contract at a specified address and block,
+// then decodes it to extract the pragma version. Returns the pragma version or an error if retrieval or decoding fails.
 func (m *Client) DownloadContractAndGetPragma(address common.Address, block *big.Int) (Pragma, error) {
 	bytecode, err := m.Client.CodeAt(context.Background(), address, block)
 	if err != nil {

seth/gas.go

@@ -19,7 +19,8 @@ func NewGasEstimator(c *Client) *GasEstimator {
 	return &GasEstimator{Client: c}
 }
 
-// Stats prints gas stats
+// Stats calculates gas price and tip cap suggestions based on historical fee data over a specified number of blocks.
+// It computes quantiles for base fees and tip caps and provides suggested gas price and tip cap values.
 func (m *GasEstimator) Stats(fromNumber uint64, priorityPerc float64) (GasSuggestions, error) {
 	bn, err := m.Client.Client.BlockNumber(context.Background())
 	if err != nil {