refactor: defined constants and better comments

Author: MarcosNicolau

core/chainio/avs_writer.go

@@ -21,8 +21,11 @@ import (
 )
 
 const (
-	GasBumpPercentage int = 20
-	// wait as much as 3 blocks time for the receipt
+	// How much to bump every retry (constant)
+	GasBaseBumpPercentage int = 20
+	// An extra percentage to bump every retry i*5 (linear)
+	GasBumpIncrementalBumpPercentage int = 5
+	// Wait as much as 3 blocks time for the receipt
 	SendAggregateResponseReceiptTimeout time.Duration = time.Second * 36
 )
 
@@ -82,9 +85,9 @@ func NewAvsWriterFromConfig(baseConfig *config.BaseConfig, ecdsaConfig *config.E
 // it will try again bumping the last tx gas price based on `CalculateGasPriceBump`
 // This process happens indefinitely until the transaction is included.
 //
-// Note: If the rpc endpoints fail, the retry will stop it returning a permanent error.
-// This is because the retries are infinite and we want to prevent increasing the time between them too much as it is exponential.
-// And we might also if the rpc is down for a good period of time, we might fall into an infinite waiting.
+// Note: If the rpc endpoints fail, the retry mechanism stops, returning a permanent error.
+// This is because retries are infinite and we want to prevent increasing the time between them too much as it is exponential.
+// And, if the rpc is down for a good period of time, we might fall into an infinite waiting.
 func (w *AvsWriter) SendAggregatedResponse(batchIdentifierHash [32]byte, batchMerkleRoot [32]byte, senderAddress [20]byte, nonSignerStakesAndSignature servicemanager.IBLSSignatureCheckerNonSignerStakesAndSignature, onRetry func()) (*types.Receipt, error) {
 	txOpts := *w.Signer.GetTxOpts()
 	txOpts.NoSend = true // simulate the transaction
@@ -124,7 +127,7 @@ func (w *AvsWriter) SendAggregatedResponse(batchIdentifierHash [32]byte, batchMe
 				return nil, connection.PermanentError{Inner: err}
 			}
 		}
-		txOpts.GasPrice = utils.CalculateGasPriceBumpBasedOnRetry(gasPrice, GasBumpPercentage, i)
+		txOpts.GasPrice = utils.CalculateGasPriceBumpBasedOnRetry(gasPrice, GasBaseBumpPercentage, GasBumpIncrementalBumpPercentage, i)
 
 		w.logger.Infof("Sending ResponseToTask transaction with a gas price of %v", txOpts.GasPrice)
 		err = w.checkRespondToTaskFeeLimit(tx, txOpts, batchIdentifierHash, senderAddress)

core/connection.go

@@ -19,11 +19,13 @@ func (e PermanentError) Is(err error) bool {
 	return ok
 }
 
-// Same as Retry only that the functionToRetry can return a value upon correct execution
+// Retries a given function in an exponential backoff manner and returns a value upon correct execution.
+// It will retry calling the function while it returns a non permanent error, until the max retries.
+// If maxTries == 0 then the retry function will run indefinitely until success or until a `PermanentError` is returned.
 func RetryWithData[T any](functionToRetry func() (*T, error), minDelay uint64, factor float64, maxTries uint64) (*T, error) {
 	f := func() (*T, error) {
 		val, err := functionToRetry()
-		if perm, ok := err.(PermanentError); err != nil && ok {
+		if perm, ok := err.(PermanentError); ok && err != nil {
 			return nil, backoff.Permanent(perm.Inner)
 		}
 		return val, err
@@ -46,15 +48,12 @@ func RetryWithData[T any](functionToRetry func() (*T, error), minDelay uint64, f
 }
 
 // Retries a given function in an exponential backoff manner.
-// It will retry calling the function while it returns an error, until the max retries.
-// If maxTries == 0 then the retry function will run indefinitely until success
-// from the configuration are reached, or until a `PermanentError` is returned.
-// The function to be retried should return `PermanentError` when the condition for stop retrying
-// is met.
+// It will retry calling the function while it returns a non permanent error, until the max retries.
+// If maxTries == 0 then the retry function will run indefinitely.
 func Retry(functionToRetry func() error, minDelay uint64, factor float64, maxTries uint64) error {
 	f := func() error {
 		err := functionToRetry()
-		if perm, ok := err.(PermanentError); err != nil && ok {
+		if perm, ok := err.(PermanentError); ok && err != nil {
 			return backoff.Permanent(perm.Inner)
 		}
 		return err

core/utils/eth_client_utils.go

@@ -48,13 +48,13 @@ func BytesToQuorumThresholdPercentages(quorumThresholdPercentagesBytes []byte) e
 }
 
 // Simple algorithm to calculate the gasPrice bump based on:
-// the currentGasPrice, a base bump percentage, and the retry count.
+// the currentGasPrice, a base bump percentage, a retry percentage, and the retry count.
 // Formula: currentGasPrice + (currentGasPrice * (baseBumpPercentage + retryCount * incrementalRetryPercentage) / 100)
-func CalculateGasPriceBumpBasedOnRetry(currentGasPrice *big.Int, baseBumpPercentage int, retryCount int) *big.Int {
-	// Incremental percentage increase for each retry attempt (5%)
-	incrementalRetryPercentage := new(big.Int).Mul(big.NewInt(5), big.NewInt(int64(retryCount)))
+func CalculateGasPriceBumpBasedOnRetry(currentGasPrice *big.Int, baseBumpPercentage int, retryAttemptPercentage int, retryCount int) *big.Int {
+	// Incremental percentage increase for each retry attempt (i*5%)
+	incrementalRetryPercentage := new(big.Int).Mul(big.NewInt(int64(retryAttemptPercentage)), big.NewInt(int64(retryCount)))
 
-	// Total bump percentage: base bump + incremental percentage based on retry count
+	// Total bump percentage: base bump + incremental retry percentage
 	totalBumpPercentage := new(big.Int).Add(big.NewInt(int64(baseBumpPercentage)), incrementalRetryPercentage)
 
 	// Calculate the bump amount: currentGasPrice * totalBumpPercentage / 100