Expose retry count for waitForTransactionReceipt action

[t0rbik]

I would like viem to consider having retry count exposed for waitForTransactionReceipt action.

The issue is on slow blockchains and with slow rpcs recently sent transaction end up being not found in blocks with the "Transaction with {hash} could not be found" error thrown.

The issue has been happening since the very beginning of our viem migration. And is hard to reproduce.
There were attempts to fix this in 1218e97, several issues raised: #1543, #1378, #1056. However, we experience it infrequently on fantom. See screenshot attached.

With the retry count exposed we would be able to overwrite it for some chains, such as fantom, by increasing it, to catch some more blocks after transaction submitted.

Workaround I've come up in the meantime is as follows:

function withMaxRetryingTime<TData, TError extends BaseError>(
  fn: () => Promise<TData>,
  {
    maxRetryingTime,
    errorInstance,
  }: {
    maxRetryingTime: number;
    errorInstance: new (..._args: any[]) => TError;
  }
) {
  return new Promise<TData>((resolve, reject) => {
    let doRetry = true;

    setTimeout(() => {
      doRetry = false;
    }, maxRetryingTime);

    const attemptRetry = async () => {
      const retry = async () => {
        attemptRetry();
      };

      try {
        const data = await fn();
        resolve(data);
      } catch (err) {
        if (doRetry && err instanceof errorInstance) return retry();
        reject(err);
      }
    };
    attemptRetry();
  });
}

const receipt = await withMaxRetryingTime(
      async () => {
        const receipt = await viemClient.waitForTransactionReceipt({
          hash: txHash,
        });
        return receipt;
      },
      {
        maxRetryingTime: 1000 * 60,
        errorInstance: TransactionNotFoundError,
      }
    );

[tmm]

PR welcome!

[chybisov]

Hey there! 😊 Would it be possible for you guys to take a look at adding retryCount/retryTime params to improve reliability? I believe your expertise would ensure it's done in the best way possible, enhancing the library's robustness. Thanks a bunch for considering!

[chybisov]

It is also related to #1540. I would love to see retryCount exposed and the whole experience improved. This is really a crucial piece of functionality for many projects.

[jxom]

Should be in 2.7.1 once build passes.

https://viem.sh/docs/actions/public/waitForTransactionReceipt#retrycount-optional

[chybisov]

You are the GOAT! Thank you so much! 🚀

[t0rbik]

That was fast! top