fix: add max delay to retries

Author: pedrocrvz

.changeset/every-ducks-yell.md

@@ -0,0 +1,5 @@
+---
+"@gelatocloud/gasless": patch
+---
+
+fix: add max delay to retries

README.md

@@ -578,7 +578,6 @@ const receipt = await relayer.sendTransactionSync(
   },
   {
     retries: {
-      max: 3,          // Retry up to 3 times (default: 0, max: 10)
       max: 3,          // Retry up to 3 times (default: 0, max: 5)
       delay: 1000,     // Wait 1s between retries (default: 200ms)
       backoff: 'fixed', // 'exponential' (default) or 'fixed'
@@ -592,11 +591,10 @@ const receipt = await relayer.sendTransactionSync(
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `max` | `number` | `0` | Maximum number of retries (0–10). Clamped to 10. |
-| `delay` | `number` | `200` | Delay in milliseconds before each retry. |
 | `max` | `number` | `0` | Maximum number of retries (0–5). Clamped to 5. |
 | `delay` | `number` | `200` | Base delay in milliseconds before each retry. |
 | `backoff` | `'fixed' \| 'exponential'` | `'exponential'` | Backoff strategy. `'fixed'` keeps constant delay; `'exponential'` doubles each retry (`delay × 2^attempt`). |
+| `maxDelay` | `number` | `10000` | Maximum delay in ms. Caps exponential backoff so it never exceeds this value. |
 | `errorCodes` | `number[]` | `[4211]` | RPC error codes that trigger a retry. Default is `SimulationFailedRpcError`. |
 
 Works with both async and sync relayer methods:

src/README.md

@@ -594,6 +594,7 @@ const receipt = await relayer.sendTransactionSync(
 | `max` | `number` | `0` | Maximum number of retries (0–5). Clamped to 5. |
 | `delay` | `number` | `200` | Base delay in milliseconds before each retry. |
 | `backoff` | `'fixed' \| 'exponential'` | `'exponential'` | Backoff strategy. `'fixed'` keeps constant delay; `'exponential'` doubles each retry (`delay × 2^attempt`). |
+| `maxDelay` | `number` | `10000` | Maximum delay in ms. Caps exponential backoff so it never exceeds this value. |
 | `errorCodes` | `number[]` | `[4211]` | RPC error codes that trigger a retry. Default is `SimulationFailedRpcError`. |
 
 Works with both async and sync relayer methods:

src/utils/withRetries.test.ts

@@ -132,6 +132,42 @@ describe('withRetries', () => {
     expect(result).toBe('ok');
   });
 
+  it('caps exponential backoff at maxDelay', async () => {
+    const fn = vi
+      .fn()
+      .mockRejectedValueOnce({ code: SimulationFailedRpcError.code })
+      .mockRejectedValueOnce({ code: SimulationFailedRpcError.code })
+      .mockRejectedValueOnce({ code: SimulationFailedRpcError.code })
+      .mockResolvedValue('ok');
+
+    // delay=1000, exponential: 1000, 2000, 4000 — but maxDelay=2500 caps it
+    const promise = withRetries(fn, {
+      backoff: 'exponential',
+      delay: 1000,
+      max: 3,
+      maxDelay: 2500
+    });
+
+    // First call fails immediately
+    await vi.advanceTimersByTimeAsync(0);
+    expect(fn).toHaveBeenCalledTimes(1);
+
+    // Retry 0: delay = min(1000 * 2^0, 2500) = 1000ms
+    await vi.advanceTimersByTimeAsync(1000);
+    expect(fn).toHaveBeenCalledTimes(2);
+
+    // Retry 1: delay = min(1000 * 2^1, 2500) = 2000ms
+    await vi.advanceTimersByTimeAsync(2000);
+    expect(fn).toHaveBeenCalledTimes(3);
+
+    // Retry 2: delay = min(1000 * 2^2, 2500) = 2500ms (capped)
+    await vi.advanceTimersByTimeAsync(2500);
+    expect(fn).toHaveBeenCalledTimes(4);
+
+    const result = await promise;
+    expect(result).toBe('ok');
+  });
+
   it('clamps max retries to MAX_RETRIES', async () => {
     const fn = vi.fn().mockRejectedValue({ code: SimulationFailedRpcError.code });
 

src/utils/withRetries.ts

@@ -11,6 +11,8 @@ export interface WithRetriesOptions {
   delay?: number;
   /** Backoff strategy. 'fixed' keeps constant delay, 'exponential' doubles each retry. Default: 'exponential' */
   backoff?: 'fixed' | 'exponential';
+  /** Maximum delay in ms. Caps exponential backoff so it never exceeds this value. Default: 10000 */
+  maxDelay?: number;
 }
 
 export async function withRetries<T>(
@@ -21,14 +23,15 @@ export async function withRetries<T>(
   const errorCodes = options?.errorCodes ?? [SimulationFailedRpcError.code];
   const delay = options?.delay ?? 200;
   const backoff = options?.backoff ?? 'exponential';
+  const maxDelay = options?.maxDelay ?? 12_000;
 
   for (let attempt = 0; attempt <= max; attempt++) {
     try {
       return await fn();
     } catch (error) {
       const code = (error as { code?: number }).code;
       if (attempt < max && code !== undefined && errorCodes.includes(code)) {
-        const wait = backoff === 'exponential' ? delay * 2 ** attempt : delay;
+        const wait = backoff === 'exponential' ? Math.min(delay * 2 ** attempt, maxDelay) : delay;
         if (wait > 0) await new Promise((r) => setTimeout(r, wait));
         continue;
       }