separate retryable logic from functions

Author: PatStiles

core/chainio/retryable.go

@@ -15,14 +15,7 @@ import (
 
 // |---AVS_WRITER---|
 
-/*
-RespondToTaskV2Retryable
-Send a transaction to the AVS contract to respond to a task.
-- All errors are considered Transient Errors
-- Retry times (3 retries): 12 sec (1 Blocks), 24 sec (2 Blocks), 48 sec (4 Blocks)
-- NOTE: Contract call reverts are not considered `PermanentError`'s as block reorg's may lead to contract call revert in which case the aggregator should retry.
-*/
-func (w *AvsWriter) RespondToTaskV2Retryable(opts *bind.TransactOpts, batchMerkleRoot [32]byte, senderAddress common.Address, nonSignerStakesAndSignature servicemanager.IBLSSignatureCheckerNonSignerStakesAndSignature) (*types.Transaction, error) {
+func RespondToTaskV2(w *AvsWriter, opts *bind.TransactOpts, batchMerkleRoot [32]byte, senderAddress common.Address, nonSignerStakesAndSignature servicemanager.IBLSSignatureCheckerNonSignerStakesAndSignature) func() (*types.Transaction, error) {
 	respondToTaskV2_func := func() (*types.Transaction, error) {
 		// Try with main connection
 		tx, err := w.AvsContractBindings.ServiceManager.RespondToTaskV2(opts, batchMerkleRoot, senderAddress, nonSignerStakesAndSignature)
@@ -32,21 +25,25 @@ func (w *AvsWriter) RespondToTaskV2Retryable(opts *bind.TransactOpts, batchMerkl
 		}
 		return tx, err
 	}
-	return retry.RetryWithData(respondToTaskV2_func, retry.ChainRetryConfig())
+	return respondToTaskV2_func
 }
 
 /*
-BatchesStateRetryable
-Get the state of a batch from the AVS contract.
+RespondToTaskV2Retryable
+Send a transaction to the AVS contract to respond to a task.
 - All errors are considered Transient Errors
-- Retry times (3 retries): 1 sec, 2 sec, 4 sec
+- Retry times (3 retries): 12 sec (1 Blocks), 24 sec (2 Blocks), 48 sec (4 Blocks)
+- NOTE: Contract call reverts are not considered `PermanentError`'s as block reorg's may lead to contract call revert in which case the aggregator should retry.
 */
-func (w *AvsWriter) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte) (struct {
+func (w *AvsWriter) RespondToTaskV2Retryable(opts *bind.TransactOpts, batchMerkleRoot [32]byte, senderAddress common.Address, nonSignerStakesAndSignature servicemanager.IBLSSignatureCheckerNonSignerStakesAndSignature) (*types.Transaction, error) {
+	return retry.RetryWithData(RespondToTaskV2(w, opts, batchMerkleRoot, senderAddress, nonSignerStakesAndSignature), retry.ChainRetryConfig())
+}
+
+func BatchesState(w *AvsWriter, opts *bind.CallOpts, arg0 [32]byte) func() (struct {
 	TaskCreatedBlock      uint32
 	Responded             bool
 	RespondToTaskFeeLimit *big.Int
 }, error) {
-
 	batchesState_func := func() (struct {
 		TaskCreatedBlock      uint32
 		Responded             bool
@@ -60,16 +57,24 @@ func (w *AvsWriter) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte) (s
 		}
 		return state, err
 	}
-	return retry.RetryWithData(batchesState_func, retry.DefaultRetryConfig())
+	return batchesState_func
 }
 
 /*
-BatcherBalancesRetryable
-Get the balance of a batcher from the AVS contract.
+BatchesStateRetryable
+Get the state of a batch from the AVS contract.
 - All errors are considered Transient Errors
 - Retry times (3 retries): 1 sec, 2 sec, 4 sec
 */
-func (w *AvsWriter) BatcherBalancesRetryable(opts *bind.CallOpts, senderAddress common.Address) (*big.Int, error) {
+func (w *AvsWriter) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte) (struct {
+	TaskCreatedBlock      uint32
+	Responded             bool
+	RespondToTaskFeeLimit *big.Int
+}, error) {
+	return retry.RetryWithData(BatchesState(w, opts, arg0), retry.DefaultRetryConfig())
+}
+
+func BatcherBalances(w *AvsWriter, opts *bind.CallOpts, senderAddress common.Address) func() (*big.Int, error) {
 	batcherBalances_func := func() (*big.Int, error) {
 		// Try with main connection
 		batcherBalance, err := w.AvsContractBindings.ServiceManager.BatchersBalances(opts, senderAddress)
@@ -79,18 +84,20 @@ func (w *AvsWriter) BatcherBalancesRetryable(opts *bind.CallOpts, senderAddress
 		}
 		return batcherBalance, err
 	}
-	return retry.RetryWithData(batcherBalances_func, retry.DefaultRetryConfig())
+	return batcherBalances_func
 }
 
 /*
-BalanceAtRetryable
-Get the balance of aggregatorAddress at blockNumber.
-If blockNumber is nil, it gets the latest balance.
-TODO: it gets the balance from an Address, not necessarily an aggregator. The name of the parameter should be changed.
+BatcherBalancesRetryable
+Get the balance of a batcher from the AVS contract.
 - All errors are considered Transient Errors
-- Retry times (3 retries): 1 sec, 2 sec, 4 sec.
+- Retry times (3 retries): 1 sec, 2 sec, 4 sec
 */
-func (w *AvsWriter) BalanceAtRetryable(ctx context.Context, aggregatorAddress common.Address, blockNumber *big.Int) (*big.Int, error) {
+func (w *AvsWriter) BatcherBalancesRetryable(opts *bind.CallOpts, senderAddress common.Address) (*big.Int, error) {
+	return retry.RetryWithData(BatcherBalances(w, opts, senderAddress), retry.DefaultRetryConfig())
+}
+
+func BalanceAt(w *AvsWriter, ctx context.Context, aggregatorAddress common.Address, blockNumber *big.Int) func() (*big.Int, error) {
 	balanceAt_func := func() (*big.Int, error) {
 		// Try with main connection
 		aggregatorBalance, err := w.Client.BalanceAt(ctx, aggregatorAddress, blockNumber)
@@ -100,18 +107,24 @@ func (w *AvsWriter) BalanceAtRetryable(ctx context.Context, aggregatorAddress co
 		}
 		return aggregatorBalance, err
 	}
-	return retry.RetryWithData(balanceAt_func, retry.DefaultRetryConfig())
+	return balanceAt_func
 }
 
-// |---AVS_SUBSCRIBER---|
-
 /*
-BlockNumberRetryable
-Get the latest block number from Ethereum
+BalanceAtRetryable
+Get the balance of aggregatorAddress at blockNumber.
+If blockNumber is nil, it gets the latest balance.
+TODO: it gets the balance from an Address, not necessarily an aggregator. The name of the parameter should be changed.
 - All errors are considered Transient Errors
 - Retry times (3 retries): 1 sec, 2 sec, 4 sec.
 */
-func (s *AvsSubscriber) BlockNumberRetryable(ctx context.Context) (uint64, error) {
+func (w *AvsWriter) BalanceAtRetryable(ctx context.Context, aggregatorAddress common.Address, blockNumber *big.Int) (*big.Int, error) {
+	return retry.RetryWithData(BalanceAt(w, ctx, aggregatorAddress, blockNumber), retry.DefaultRetryConfig())
+}
+
+// |---AVS_SUBSCRIBER---|
+
+func BlockNumber(s *AvsSubscriber, ctx context.Context) func() (uint64, error) {
 	latestBlock_func := func() (uint64, error) {
 		// Try with main connection
 		latestBlock, err := s.AvsContractBindings.ethClient.BlockNumber(ctx)
@@ -121,42 +134,54 @@ func (s *AvsSubscriber) BlockNumberRetryable(ctx context.Context) (uint64, error
 		}
 		return latestBlock, err
 	}
-	return retry.RetryWithData(latestBlock_func, retry.DefaultRetryConfig())
+	return latestBlock_func
 }
 
 /*
-FilterBatchV2Retryable
-Get NewBatchV2 logs from the AVS contract.
+BlockNumberRetryable
+Get the latest block number from Ethereum
 - All errors are considered Transient Errors
 - Retry times (3 retries): 1 sec, 2 sec, 4 sec.
 */
-func (s *AvsSubscriber) FilterBatchV2Retryable(opts *bind.FilterOpts, batchMerkleRoot [][32]byte) (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV2Iterator, error) {
+func (s *AvsSubscriber) BlockNumberRetryable(ctx context.Context) (uint64, error) {
+	return retry.RetryWithData(BlockNumber(s, ctx), retry.DefaultRetryConfig())
+}
+
+func FilterBatchV2(s *AvsSubscriber, opts *bind.FilterOpts, batchMerkleRoot [][32]byte) func() (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV2Iterator, error) {
 	filterNewBatchV2_func := func() (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV2Iterator, error) {
 		return s.AvsContractBindings.ServiceManager.FilterNewBatchV2(opts, batchMerkleRoot)
 	}
-	return retry.RetryWithData(filterNewBatchV2_func, retry.DefaultRetryConfig())
+	return filterNewBatchV2_func
 }
 
 /*
-FilterBatchV3Retryable
-Get NewBatchV3 logs from the AVS contract.
+FilterBatchV2Retryable
+Get NewBatchV2 logs from the AVS contract.
 - All errors are considered Transient Errors
 - Retry times (3 retries): 1 sec, 2 sec, 4 sec.
 */
-func (s *AvsSubscriber) FilterBatchV3Retryable(opts *bind.FilterOpts, batchMerkleRoot [][32]byte) (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV3Iterator, error) {
-	filterNewBatchV2_func := func() (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV3Iterator, error) {
+func (s *AvsSubscriber) FilterBatchV2Retryable(opts *bind.FilterOpts, batchMerkleRoot [][32]byte) (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV2Iterator, error) {
+	return retry.RetryWithData(FilterBatchV2(s, opts, batchMerkleRoot), retry.DefaultRetryConfig())
+}
+
+func FilterBatchV3(s *AvsSubscriber, opts *bind.FilterOpts, batchMerkleRoot [][32]byte) func() (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV3Iterator, error) {
+	filterNewBatchV3_func := func() (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV3Iterator, error) {
 		return s.AvsContractBindings.ServiceManager.FilterNewBatchV3(opts, batchMerkleRoot)
 	}
-	return retry.RetryWithData(filterNewBatchV2_func, retry.DefaultRetryConfig())
+	return filterNewBatchV3_func
 }
 
 /*
-BatchesStateRetryable
-Get the state of a batch from the AVS contract.
+FilterBatchV3Retryable
+Get NewBatchV3 logs from the AVS contract.
 - All errors are considered Transient Errors
-- Retry times (3 retries): 1 sec, 2 sec, 4 sec
+- Retry times (3 retries): 1 sec, 2 sec, 4 sec.
 */
-func (s *AvsSubscriber) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte) (struct {
+func (s *AvsSubscriber) FilterBatchV3Retryable(opts *bind.FilterOpts, batchMerkleRoot [][32]byte) (*servicemanager.ContractAlignedLayerServiceManagerNewBatchV3Iterator, error) {
+	return retry.RetryWithData(FilterBatchV3(s, opts, batchMerkleRoot), retry.DefaultRetryConfig())
+}
+
+func BatchState(s *AvsSubscriber, opts *bind.CallOpts, arg0 [32]byte) func() (struct {
 	TaskCreatedBlock      uint32
 	Responded             bool
 	RespondToTaskFeeLimit *big.Int
@@ -168,17 +193,25 @@ func (s *AvsSubscriber) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte
 	}, error) {
 		return s.AvsContractBindings.ServiceManager.ContractAlignedLayerServiceManagerCaller.BatchesState(opts, arg0)
 	}
-
-	return retry.RetryWithData(batchState_func, retry.DefaultRetryConfig())
+	return batchState_func
 }
 
 /*
-SubscribeNewHeadRetryable
-Subscribe to new heads from the Ethereum node.
+BatchesStateRetryable
+Get the state of a batch from the AVS contract.
 - All errors are considered Transient Errors
-- Retry times (3 retries): 1 sec, 2 sec, 4 sec.
+- Retry times (3 retries): 1 sec, 2 sec, 4 sec
 */
-func (s *AvsSubscriber) SubscribeNewHeadRetryable(ctx context.Context, c chan<- *types.Header) (ethereum.Subscription, error) {
+func (s *AvsSubscriber) BatchesStateRetryable(opts *bind.CallOpts, arg0 [32]byte) (struct {
+	TaskCreatedBlock      uint32
+	Responded             bool
+	RespondToTaskFeeLimit *big.Int
+}, error) {
+
+	return retry.RetryWithData(BatchState(s, opts, arg0), retry.DefaultRetryConfig())
+}
+
+func SubscribeNewHead(s *AvsSubscriber, ctx context.Context, c chan<- *types.Header) func() (ethereum.Subscription, error) {
 	subscribeNewHead_func := func() (ethereum.Subscription, error) {
 		// Try with main connection
 		sub, err := s.AvsContractBindings.ethClient.SubscribeNewHead(ctx, c)
@@ -188,7 +221,29 @@ func (s *AvsSubscriber) SubscribeNewHeadRetryable(ctx context.Context, c chan<-
 		}
 		return sub, err
 	}
-	return retry.RetryWithData(subscribeNewHead_func, retry.DefaultRetryConfig())
+	return subscribeNewHead_func
+}
+
+/*
+SubscribeNewHeadRetryable
+Subscribe to new heads from the Ethereum node.
+- All errors are considered Transient Errors
+- Retry times (3 retries): 1 sec, 2 sec, 4 sec.
+*/
+func (s *AvsSubscriber) SubscribeNewHeadRetryable(ctx context.Context, c chan<- *types.Header) (ethereum.Subscription, error) {
+	return retry.RetryWithData(SubscribeNewHead(s, ctx, c), retry.DefaultRetryConfig())
+}
+
+func SubscribeToNewTasksV2(
+	opts *bind.WatchOpts,
+	serviceManager *servicemanager.ContractAlignedLayerServiceManager,
+	newTaskCreatedChan chan *servicemanager.ContractAlignedLayerServiceManagerNewBatchV2,
+	batchMerkleRoot [][32]byte,
+) func() (event.Subscription, error) {
+	subscribe_func := func() (event.Subscription, error) {
+		return serviceManager.WatchNewBatchV2(opts, newTaskCreatedChan, batchMerkleRoot)
+	}
+	return subscribe_func
 }
 
 /*
@@ -203,10 +258,19 @@ func SubscribeToNewTasksV2Retryable(
 	newTaskCreatedChan chan *servicemanager.ContractAlignedLayerServiceManagerNewBatchV2,
 	batchMerkleRoot [][32]byte,
 ) (event.Subscription, error) {
+	return retry.RetryWithData(SubscribeToNewTasksV2(opts, serviceManager, newTaskCreatedChan, batchMerkleRoot), retry.DefaultRetryConfig())
+}
+
+func SubscribeToNewTasksV3(
+	opts *bind.WatchOpts,
+	serviceManager *servicemanager.ContractAlignedLayerServiceManager,
+	newTaskCreatedChan chan *servicemanager.ContractAlignedLayerServiceManagerNewBatchV3,
+	batchMerkleRoot [][32]byte,
+) func() (event.Subscription, error) {
 	subscribe_func := func() (event.Subscription, error) {
-		return serviceManager.WatchNewBatchV2(opts, newTaskCreatedChan, batchMerkleRoot)
+		return serviceManager.WatchNewBatchV3(opts, newTaskCreatedChan, batchMerkleRoot)
 	}
-	return retry.RetryWithData(subscribe_func, retry.DefaultRetryConfig())
+	return subscribe_func
 }
 
 /*
@@ -221,8 +285,5 @@ func SubscribeToNewTasksV3Retryable(
 	newTaskCreatedChan chan *servicemanager.ContractAlignedLayerServiceManagerNewBatchV3,
 	batchMerkleRoot [][32]byte,
 ) (event.Subscription, error) {
-	subscribe_func := func() (event.Subscription, error) {
-		return serviceManager.WatchNewBatchV3(opts, newTaskCreatedChan, batchMerkleRoot)
-	}
-	return retry.RetryWithData(subscribe_func, retry.DefaultRetryConfig())
+	return retry.RetryWithData(SubscribeToNewTasksV3(opts, serviceManager, newTaskCreatedChan, batchMerkleRoot), retry.DefaultRetryConfig())
 }