feat: you can now abort transaction confirmations in web3.js

[steveluscher]

Problem

Now that we have long-running transaction confirmation strategies, like #25839, one might like to cancel outstanding transaction confirmations that they no longer care about. For instance, if a user takes an action, but then visits a different page on your site before the transaction has confirmed, you might like to dispose of it.

Summary of Changes

• Add abortSignal as an input to confirmTransaction()

Now, callers can do this:

const abortController = new AbortController();
try {
  await connection.confirmTransaction({
    abortSignal: abortController.signal,
    /* ... usual transaction confirmation strategy properties */
  });
} catch (e) {
  if (e.name === 'AbortError') {
    // Handle aborted confirmation.
  }
}

// ...then some time later:
abortController.abort();

Fixes #25304.

[steveluscher]

Side note: I would have written more test coverage here, to assert that when cancelled, the subscription gets disposed and the nonce account no longer gets pinged. Our test framework, however, just doesn't work. I tried setting up sinon spies, and they never fired. I tested other spies in previous tests and – surprise – they don't work either.

I, for one, can't wait to return to Jest as we rewrite web3.js.

[codecov]

Codecov Report

Merging #29057 (fa6e0fe) into master (9725a45) will decrease coverage by 0.0%.
The diff coverage is 64.7%.

@@            Coverage Diff            @@
##           master   #29057     +/-   ##
=========================================
- Coverage    76.8%    76.8%   -0.1%     
=========================================
  Files          55       55             
  Lines        3112     3127     +15     
  Branches      460      466      +6     
=========================================
+ Hits         2393     2402      +9     
- Misses        556      561      +5     
- Partials      163      164      +1     

[mergify]

automerge label removed due to a CI failure