Remove timeout when waiting for tx to be included in a block

Author: 0xfornax

bindings/utils/wait.go

@@ -3,7 +3,6 @@ package utils
 import (
 	"context"
 	"errors"
-	"fmt"
 	"time"
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
@@ -12,32 +11,30 @@ import (
 	"github.com/rocket-pool/smartnode/bindings/rocketpool"
 )
 
-// Wait for a transaction to get mined
-func WaitForTransaction(client rocketpool.ExecutionClient, hash common.Hash) (*types.Receipt, error) {
-
+// Wait for a transaction to get included, respecting the provided context for cancellation.
+// The transaction lookup retries indefinitely (with 1-second pauses) until found or ctx is done.
+func WaitForTransactionWithContext(ctx context.Context, client rocketpool.ExecutionClient, hash common.Hash) (*types.Receipt, error) {
 	var tx *types.Transaction
-	var err error
 
-	// Get the transaction from its hash, retrying for 30 sec if it wasn't found
-	for i := 0; i < 30; i++ {
-		if i == 29 {
-			return nil, fmt.Errorf("Transaction not found after 30 seconds.")
+	// Get the transaction from its hash, retrying until found or ctx is cancelled.
+	for {
+		var err error
+		tx, _, err = client.TransactionByHash(ctx, hash)
+		if err == nil {
+			break
 		}
-
-		tx, _, err = client.TransactionByHash(context.Background(), hash)
-		if err != nil {
-			if err.Error() == "not found" {
-				time.Sleep(1 * time.Second)
-				continue
-			}
+		if err.Error() != "not found" {
 			return nil, err
-		} else {
-			break
+		}
+		select {
+		case <-ctx.Done():
+			return nil, ctx.Err()
+		case <-time.After(1 * time.Second):
 		}
 	}
 
 	// Wait for transaction to be mined
-	txReceipt, err := bind.WaitMined(context.Background(), client, tx)
+	txReceipt, err := bind.WaitMined(ctx, client, tx)
 	if err != nil {
 		return nil, err
 	}
@@ -47,6 +44,10 @@ func WaitForTransaction(client rocketpool.ExecutionClient, hash common.Hash) (*t
 		return txReceipt, errors.New("Transaction failed with status 0")
 	}
 
-	// Return
 	return txReceipt, nil
 }
+
+// Wait for a transaction to get mined
+func WaitForTransaction(client rocketpool.ExecutionClient, hash common.Hash) (*types.Receipt, error) {
+	return WaitForTransactionWithContext(context.Background(), client, hash)
+}

rocketpool/api/wait.go

@@ -23,7 +23,7 @@ func RegisterWaitRoute(mux *http.ServeMux, c *cli.Command) {
 			return
 		}
 		response := apitypes.APIResponse{}
-		_, err = utils.WaitForTransaction(rp.Client, hash)
+		_, err = utils.WaitForTransactionWithContext(r.Context(), rp.Client, hash)
 		apiutils.WriteResponse(w, &response, err)
 	})
 }

shared/services/rocketpool/api.go

@@ -1,6 +1,7 @@
 package rocketpool
 
 import (
+	"context"
 	"fmt"
 	"net/url"
 
@@ -9,9 +10,9 @@ import (
 	"github.com/rocket-pool/smartnode/shared/types/api"
 )
 
-// Wait for a transaction
+// Wait for a transaction — no timeout; blocks until the tx is included or the caller cancels.
 func (c *Client) WaitForTransaction(txHash common.Hash) (api.APIResponse, error) {
-	responseBytes, err := c.callHTTPAPI("GET", "/api/wait", url.Values{"txHash": {txHash.Hex()}})
+	responseBytes, err := c.callHTTPAPICtx(context.Background(), "GET", "/api/wait", url.Values{"txHash": {txHash.Hex()}})
 	if err != nil {
 		return api.APIResponse{}, fmt.Errorf("Error waiting for tx: %w", err)
 	}

shared/services/rocketpool/client.go

@@ -1253,7 +1253,6 @@ func (c *Client) getAPIURL() string {
 // path is the URL path, e.g. "/api/node/status".
 // params are appended as query string parameters for GET or as a form body for POST.
 // The response body is returned as-is; callers unmarshal it the same way
-// The response body is returned as-is; callers unmarshal it.
 func (c *Client) callHTTPAPI(method, path string, params url.Values) ([]byte, error) {
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
 	defer cancel()