@bigmi/core 0.7.1 → 0.8.0

package/dist/esm/actions/waitForTransaction.js

@@ -1,232 +1,156 @@
-import { address, Transaction } from 'bitcoinjs-lib';
-import { TransactionNotFoundError, TransactionReceiptNotFoundError, WaitForTransactionReceiptTimeoutError, } from '../errors/transaction.js';
-import { getAction } from '../utils/getAction.js';
-import { observe } from '../utils/observe.js';
-import { stringify } from '../utils/stringify.js';
-import { withRetry } from '../utils/withRetry.js';
-import { getBlock } from './getBlock.js';
-import { getBlockStats } from './getBlockStats.js';
-import { getUTXOTransaction } from './getUTXOTransaction.js';
-import { watchBlockNumber } from './watchBlockNumber.js';
+import { getBlock } from "./getBlock.js";
+import { getBlockStats } from "./getBlockStats.js";
+import { TransactionNotFoundError, TransactionReceiptNotFoundError, WaitForTransactionReceiptTimeoutError } from "../errors/transaction.js";
+import { getUTXOTransaction } from "./getUTXOTransaction.js";
+import { getAction } from "../utils/getAction.js";
+import { observe } from "../utils/observe.js";
+import { stringify } from "../utils/stringify.js";
+import { withRetry } from "../utils/withRetry.js";
+import { watchBlockNumber } from "./watchBlockNumber.js";
+import { Transaction, address } from "bitcoinjs-lib";
+//#region src/actions/waitForTransaction.ts
 /**
- * Waits for the transaction to be included on a block (one confirmation), and then returns the transaction.
- * - JSON-RPC Methods:
- * - Polls getrawtransaction on each block until it has been processed.
- * - If a transaction has been replaced:
- * - Calls getblock and extracts the transactions
- * - Checks if one of the transactions is a replacement
- * - If so, calls getrawtransaction.
- *
- * The `waitForTransaction` action additionally supports replacement detection (e.g. RBF - transactions replaced-by-fee ).
- *
- * Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel).
- * https://bitcoinops.org/en/topics/replace-by-fee/
- *
- * There are 3 types of Transaction Replacement reasons:
- *
- * - `repriced`: The fee has been modified (e.g. same outputs, different amounts)
- * - `cancelled`: The Transaction has been cancelled (e.g. output is sender address)
- * - `replaced`: The Transaction has been replaced (e.g. different outputs)
- * @param client - Client to use
- * @param parameters - {@link WaitForTransactionReceiptParameters}
- * @returns The UTXO transaction. {@link WaitForTransactionReceiptReturnType}
- */
-export async function waitForTransaction(client, { confirmations = 1, txId, txHex, senderAddress, onReplaced, pollingInterval = client.pollingInterval, retryCount = 10, retryDelay = 3000, timeout, }) {
-    const observerId = stringify(['waitForTransaction', client.uid, txId]);
-    let count = 0;
-    let transaction;
-    let replacedTransaction;
-    let retrying = false;
-    return new Promise((resolve, reject) => {
-        if (timeout) {
-            setTimeout(() => reject(new WaitForTransactionReceiptTimeoutError({ hash: txId })), timeout);
-        }
-        const _unobserve = observe(observerId, { onReplaced, resolve, reject }, (emit) => {
-            const _unwatch = getAction(client, watchBlockNumber, 'watchBlockNumber')({
-                emitMissed: true,
-                emitOnBegin: true,
-                pollingInterval,
-                async onBlockNumber(blockNumber_) {
-                    const done = (fn) => {
-                        _unwatch();
-                        fn();
-                        _unobserve();
-                    };
-                    let blockNumber = blockNumber_;
-                    if (retrying) {
-                        return;
-                    }
-                    if (count > retryCount) {
-                        done(() => emit.reject(new WaitForTransactionReceiptTimeoutError({
-                            hash: txId,
-                        })));
-                    }
-                    try {
-                        // If we already have a valid receipt, let's check if we have enough
-                        // confirmations. If we do, then we can resolve.
-                        if (transaction?.blockhash) {
-                            const blockStats = await getAction(client, getBlockStats, 'getBlockStats')({
-                                blockHash: transaction.blockhash,
-                                stats: ['height'],
-                            });
-                            if (confirmations > 1 &&
-                                (!blockStats.height ||
-                                    blockNumber - blockStats.height + 1 < confirmations)) {
-                                return;
-                            }
-                            done(() => emit.resolve(transaction));
-                            return;
-                        }
-                        // Get the transaction to check if it's been replaced.
-                        // We need to retry as some RPC Providers may be slow to sync
-                        // up mined transactions.
-                        retrying = true;
-                        transaction = await withRetry(() => getAction(client, getUTXOTransaction, 'getUTXOTransaction'
-                        // If transaction exists it might be the replaced one with different txId
-                        )({ txId: transaction?.txid || txId }), {
-                            delay: retryDelay,
-                            retryCount,
-                        });
-                        if (transaction.blockhash) {
-                            const blockStats = await getAction(client, getBlockStats, 'getBlockStats')({
-                                blockHash: transaction.blockhash,
-                                stats: ['height'],
-                            });
-                            if (blockStats.height) {
-                                blockNumber = blockStats.height;
-                            }
-                        }
-                        retrying = false;
-                        // Check if transaction has been processed.
-                        if (!transaction?.confirmations) {
-                            throw new TransactionReceiptNotFoundError({
-                                hash: txId,
-                            });
-                        }
-                        // Check if we have enough confirmations. If not, continue polling.
-                        if (transaction.confirmations < confirmations) {
-                            return;
-                        }
-                        done(() => emit.resolve(transaction));
-                    }
-                    catch (err) {
-                        // If the receipt is not found, the transaction will be pending.
-                        // We need to check if it has potentially been replaced.
-                        if (err instanceof TransactionNotFoundError ||
-                            err instanceof TransactionReceiptNotFoundError) {
-                            try {
-                                replacedTransaction = Transaction.fromHex(transaction?.hex || txHex);
-                                // Let's retrieve the transactions from the current block.
-                                // We need to retry as some RPC Providers may be slow to sync
-                                // up mined blocks.
-                                retrying = true;
-                                const block = await withRetry(() => getAction(client, getBlock, 'getBlock')({
-                                    blockNumber,
-                                }), {
-                                    delay: retryDelay,
-                                    retryCount,
-                                    // shouldRetry: ({ error }) =>
-                                    //   error instanceof BlockNotFoundError,
-                                });
-                                retrying = false;
-                                // Create a set of input identifiers for mempool transaction
-                                const replacedTransactionInputs = new Set();
-                                for (const input of replacedTransaction.ins) {
-                                    const txid = Array.from(input.hash)
-                                        .reverse()
-                                        .map((byte) => `00${byte.toString(16)}`.slice(-2))
-                                        .join('');
-                                    const vout = input.index;
-                                    const inputId = `${txid}:${vout}`;
-                                    replacedTransactionInputs.add(inputId);
-                                }
-                                let replacementTransaction;
-                                for (const tx of block.transactions) {
-                                    if (tx.isCoinbase()) {
-                                        continue;
-                                    }
-                                    // Check if any input of this transaction matches an input of mempool transaction
-                                    for (const input of tx.ins) {
-                                        const txid = Array.from(input.hash)
-                                            .reverse()
-                                            .map((byte) => `00${byte.toString(16)}`.slice(-2))
-                                            .join('');
-                                        const vout = input.index;
-                                        const inputId = `${txid}:${vout}`;
-                                        if (replacedTransactionInputs.has(inputId)) {
-                                            replacementTransaction = tx;
-                                            break;
-                                        }
-                                    }
-                                    if (replacementTransaction) {
-                                        break;
-                                    }
-                                }
-                                // If we couldn't find a replacement transaction, continue polling.
-                                if (!replacementTransaction) {
-                                    return;
-                                }
-                                // If we found a replacement transaction, return it's receipt.
-                                transaction = await getAction(client, getUTXOTransaction, 'getUTXOTransaction')({
-                                    txId: replacementTransaction.getId(),
-                                });
-                                // Check if we have enough confirmations. If not, continue polling.
-                                if (transaction.confirmations &&
-                                    transaction.confirmations < confirmations) {
-                                    return;
-                                }
-                                let reason = 'replaced';
-                                // Function to get output addresses
-                                function getOutputAddresses(tx) {
-                                    const addresses = [];
-                                    for (const output of tx.outs) {
-                                        try {
-                                            const outputAddress = address.fromOutputScript(output.script);
-                                            addresses.push(outputAddress);
-                                        }
-                                        catch (_e) {
-                                            // Handle non-standard scripts (e.g., OP_RETURN)
-                                        }
-                                    }
-                                    return addresses;
-                                }
-                                // Get the recipient addresses from the original transaction
-                                const originalOutputAddresses = getOutputAddresses(replacedTransaction);
-                                // Get the recipient addresses from the replacement transaction
-                                const replacementOutputAddresses = getOutputAddresses(replacementTransaction);
-                                if (originalOutputAddresses.length ===
-                                    replacementOutputAddresses.length &&
-                                    originalOutputAddresses.every((address) => replacementOutputAddresses.includes(address))) {
-                                    reason = 'repriced';
-                                }
-                                else if (senderAddress &&
-                                    replacementOutputAddresses.length === 1 &&
-                                    replacementOutputAddresses.includes(senderAddress)) {
-                                    reason = 'cancelled';
-                                }
-                                done(() => {
-                                    emit.onReplaced?.({
-                                        reason,
-                                        replacedTransaction: replacedTransaction,
-                                        transaction: transaction,
-                                    });
-                                    emit.resolve(transaction);
-                                });
-                            }
-                            catch (err_) {
-                                done(() => emit.reject(err_));
-                            }
-                        }
-                        else {
-                            done(() => emit.reject(err));
-                        }
-                    }
-                    finally {
-                        count++;
-                    }
-                },
-            });
-        });
-    });
+* Waits for the transaction to be included on a block (one confirmation), and then returns the transaction.
+* - JSON-RPC Methods:
+* - Polls getrawtransaction on each block until it has been processed.
+* - If a transaction has been replaced:
+* - Calls getblock and extracts the transactions
+* - Checks if one of the transactions is a replacement
+* - If so, calls getrawtransaction.
+*
+* The `waitForTransaction` action additionally supports replacement detection (e.g. RBF - transactions replaced-by-fee ).
+*
+* Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel).
+* https://bitcoinops.org/en/topics/replace-by-fee/
+*
+* There are 3 types of Transaction Replacement reasons:
+*
+* - `repriced`: The fee has been modified (e.g. same outputs, different amounts)
+* - `cancelled`: The Transaction has been cancelled (e.g. output is sender address)
+* - `replaced`: The Transaction has been replaced (e.g. different outputs)
+* @param client - Client to use
+* @param parameters - {@link WaitForTransactionReceiptParameters}
+* @returns The UTXO transaction. {@link WaitForTransactionReceiptReturnType}
+*/
+async function waitForTransaction(client, { confirmations = 1, txId, txHex, senderAddress, onReplaced, pollingInterval = client.pollingInterval, retryCount = 10, retryDelay = 3e3, timeout }) {
+	const observerId = stringify([
+		"waitForTransaction",
+		client.uid,
+		txId
+	]);
+	let count = 0;
+	let transaction;
+	let replacedTransaction;
+	let retrying = false;
+	return new Promise((resolve, reject) => {
+		if (timeout) setTimeout(() => reject(new WaitForTransactionReceiptTimeoutError({ hash: txId })), timeout);
+		const _unobserve = observe(observerId, {
+			onReplaced,
+			resolve,
+			reject
+		}, (emit) => {
+			const _unwatch = getAction(client, watchBlockNumber, "watchBlockNumber")({
+				emitMissed: true,
+				emitOnBegin: true,
+				pollingInterval,
+				async onBlockNumber(blockNumber_) {
+					const done = (fn) => {
+						_unwatch();
+						fn();
+						_unobserve();
+					};
+					let blockNumber = blockNumber_;
+					if (retrying) return;
+					if (count > retryCount) done(() => emit.reject(new WaitForTransactionReceiptTimeoutError({ hash: txId })));
+					try {
+						if (transaction?.blockhash) {
+							const blockStats = await getAction(client, getBlockStats, "getBlockStats")({
+								blockHash: transaction.blockhash,
+								stats: ["height"]
+							});
+							if (confirmations > 1 && (!blockStats.height || blockNumber - blockStats.height + 1 < confirmations)) return;
+							done(() => emit.resolve(transaction));
+							return;
+						}
+						retrying = true;
+						transaction = await withRetry(() => getAction(client, getUTXOTransaction, "getUTXOTransaction")({ txId: transaction?.txid || txId }), {
+							delay: retryDelay,
+							retryCount
+						});
+						if (transaction.blockhash) {
+							const blockStats = await getAction(client, getBlockStats, "getBlockStats")({
+								blockHash: transaction.blockhash,
+								stats: ["height"]
+							});
+							if (blockStats.height) blockNumber = blockStats.height;
+						}
+						retrying = false;
+						if (!transaction?.confirmations) throw new TransactionReceiptNotFoundError({ hash: txId });
+						if (transaction.confirmations < confirmations) return;
+						done(() => emit.resolve(transaction));
+					} catch (err) {
+						if (err instanceof TransactionNotFoundError || err instanceof TransactionReceiptNotFoundError) try {
+							replacedTransaction = Transaction.fromHex(transaction?.hex || txHex);
+							retrying = true;
+							const block = await withRetry(() => getAction(client, getBlock, "getBlock")({ blockNumber }), {
+								delay: retryDelay,
+								retryCount
+							});
+							retrying = false;
+							const replacedTransactionInputs = /* @__PURE__ */ new Set();
+							for (const input of replacedTransaction.ins) {
+								const inputId = `${Array.from(input.hash).reverse().map((byte) => `00${byte.toString(16)}`.slice(-2)).join("")}:${input.index}`;
+								replacedTransactionInputs.add(inputId);
+							}
+							let replacementTransaction;
+							for (const tx of block.transactions) {
+								if (tx.isCoinbase()) continue;
+								for (const input of tx.ins) {
+									const inputId = `${Array.from(input.hash).reverse().map((byte) => `00${byte.toString(16)}`.slice(-2)).join("")}:${input.index}`;
+									if (replacedTransactionInputs.has(inputId)) {
+										replacementTransaction = tx;
+										break;
+									}
+								}
+								if (replacementTransaction) break;
+							}
+							if (!replacementTransaction) return;
+							transaction = await getAction(client, getUTXOTransaction, "getUTXOTransaction")({ txId: replacementTransaction.getId() });
+							if (transaction.confirmations && transaction.confirmations < confirmations) return;
+							let reason = "replaced";
+							function getOutputAddresses(tx) {
+								const addresses = [];
+								for (const output of tx.outs) try {
+									const outputAddress = address.fromOutputScript(output.script);
+									addresses.push(outputAddress);
+								} catch (_e) {}
+								return addresses;
+							}
+							const originalOutputAddresses = getOutputAddresses(replacedTransaction);
+							const replacementOutputAddresses = getOutputAddresses(replacementTransaction);
+							if (originalOutputAddresses.length === replacementOutputAddresses.length && originalOutputAddresses.every((address) => replacementOutputAddresses.includes(address))) reason = "repriced";
+							else if (senderAddress && replacementOutputAddresses.length === 1 && replacementOutputAddresses.includes(senderAddress)) reason = "cancelled";
+							done(() => {
+								emit.onReplaced?.({
+									reason,
+									replacedTransaction,
+									transaction
+								});
+								emit.resolve(transaction);
+							});
+						} catch (err_) {
+							done(() => emit.reject(err_));
+						}
+						else done(() => emit.reject(err));
+					} finally {
+						count++;
+					}
+				}
+			});
+		});
+	});
 }
+//#endregion
+export { waitForTransaction };
+
 //# sourceMappingURL=waitForTransaction.js.map

package/dist/esm/actions/waitForTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitForTransaction.js","sourceRoot":"","sources":["../../../src/actions/waitForTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,qCAAqC,GACtC,MAAM,0BAA0B,CAAA;AAKjC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAqDxD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAgC,EAChC,EACE,aAAa,GAAG,CAAC,EACjB,IAAI,EACJ,KAAK,EACL,aAAa,EACb,UAAU,EACV,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,UAAU,GAAG,EAAE,EACf,UAAU,GAAG,IAAK,EAClB,OAAO,GAC6B;IAEtC,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IAEtE,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,WAAwC,CAAA;IAC5C,IAAI,mBAA4C,CAAA;IAChD,IAAI,QAAQ,GAAG,KAAK,CAAA;IAEpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,CACR,GAAG,EAAE,CACH,MAAM,CACJ,IAAI,qCAAqC,CAAC,EAAE,IAAI,EAAE,IAAa,EAAE,CAAC,CACnE,EACH,OAAO,CACR,CAAA;QACH,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CACxB,UAAU,EACV,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,EAC/B,CAAC,IAAI,EAAE,EAAE;YACP,MAAM,QAAQ,GAAG,SAAS,CACxB,MAAM,EACN,gBAAgB,EAChB,kBAAkB,CACnB,CAAC;gBACA,UAAU,EAAE,IAAI;gBAChB,WAAW,EAAE,IAAI;gBACjB,eAAe;gBACf,KAAK,CAAC,aAAa,CAAC,YAAY;oBAC9B,MAAM,IAAI,GAAG,CAAC,EAAc,EAAE,EAAE;wBAC9B,QAAQ,EAAE,CAAA;wBACV,EAAE,EAAE,CAAA;wBACJ,UAAU,EAAE,CAAA;oBACd,CAAC,CAAA;oBAED,IAAI,WAAW,GAAG,YAAY,CAAA;oBAE9B,IAAI,QAAQ,EAAE,CAAC;wBACb,OAAM;oBACR,CAAC;oBACD,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;wBACvB,IAAI,CAAC,GAAG,EAAE,CACR,IAAI,CAAC,MAAM,CACT,IAAI,qCAAqC,CAAC;4BACxC,IAAI,EAAE,IAAa;yBACpB,CAAC,CACH,CACF,CAAA;oBACH,CAAC;oBAED,IAAI,CAAC;wBACH,oEAAoE;wBACpE,gDAAgD;wBAChD,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;4BAC3B,MAAM,UAAU,GAAG,MAAM,SAAS,CAChC,MAAM,EACN,aAAa,EACb,eAAe,CAChB,CAAC;gCACA,SAAS,EAAE,WAAW,CAAC,SAAS;gCAChC,KAAK,EAAE,CAAC,QAAQ,CAAC;6BAClB,CAAC,CAAA;4BACF,IACE,aAAa,GAAG,CAAC;gCACjB,CAAC,CAAC,UAAU,CAAC,MAAM;oCACjB,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,CAAC,EACtD,CAAC;gCACD,OAAM;4BACR,CAAC;4BACD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC,CAAA;4BACtC,OAAM;wBACR,CAAC;wBAED,sDAAsD;wBACtD,6DAA6D;wBAC7D,yBAAyB;wBACzB,QAAQ,GAAG,IAAI,CAAA;wBACf,WAAW,GAAG,MAAM,SAAS,CAC3B,GAAG,EAAE,CACH,SAAS,CACP,MAAM,EACN,kBAAkB,EAClB,oBAAoB;wBACpB,yEAAyE;yBAC1E,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,EACxC;4BACE,KAAK,EAAE,UAAU;4BACjB,UAAU;yBACX,CACF,CAAA;wBACD,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;4BAC1B,MAAM,UAAU,GAAG,MAAM,SAAS,CAChC,MAAM,EACN,aAAa,EACb,eAAe,CAChB,CAAC;gCACA,SAAS,EAAE,WAAW,CAAC,SAAS;gCAChC,KAAK,EAAE,CAAC,QAAQ,CAAC;6BAClB,CAAC,CAAA;4BACF,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gCACtB,WAAW,GAAG,UAAU,CAAC,MAAM,CAAA;4BACjC,CAAC;wBACH,CAAC;wBACD,QAAQ,GAAG,KAAK,CAAA;wBAEhB,2CAA2C;wBAC3C,IAAI,CAAC,WAAW,EAAE,aAAa,EAAE,CAAC;4BAChC,MAAM,IAAI,+BAA+B,CAAC;gCACxC,IAAI,EAAE,IAAa;6BACpB,CAAC,CAAA;wBACJ,CAAC;wBAED,mEAAmE;wBACnE,IAAI,WAAW,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC;4BAC9C,OAAM;wBACR,CAAC;wBAED,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC,CAAA;oBACxC,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,gEAAgE;wBAChE,wDAAwD;wBACxD,IACE,GAAG,YAAY,wBAAwB;4BACvC,GAAG,YAAY,+BAA+B,EAC9C,CAAC;4BACD,IAAI,CAAC;gCACH,mBAAmB,GAAG,WAAW,CAAC,OAAO,CACvC,WAAW,EAAE,GAAG,IAAI,KAAK,CAC1B,CAAA;gCAED,0DAA0D;gCAC1D,6DAA6D;gCAC7D,mBAAmB;gCACnB,QAAQ,GAAG,IAAI,CAAA;gCACf,MAAM,KAAK,GAAG,MAAM,SAAS,CAC3B,GAAG,EAAE,CACH,SAAS,CACP,MAAM,EACN,QAAQ,EACR,UAAU,CACX,CAAC;oCACA,WAAW;iCACZ,CAAC,EACJ;oCACE,KAAK,EAAE,UAAU;oCACjB,UAAU;oCACV,8BAA8B;oCAC9B,yCAAyC;iCAC1C,CACF,CAAA;gCACD,QAAQ,GAAG,KAAK,CAAA;gCAEhB,4DAA4D;gCAC5D,MAAM,yBAAyB,GAAG,IAAI,GAAG,EAAU,CAAA;gCAEnD,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC,GAAG,EAAE,CAAC;oCAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;yCAChC,OAAO,EAAE;yCACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;yCACjD,IAAI,CAAC,EAAE,CAAC,CAAA;oCACX,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAA;oCACxB,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;oCACjC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gCACxC,CAAC;gCAED,IAAI,sBAA+C,CAAA;gCAEnD,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,YAAa,EAAE,CAAC;oCACrC,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;wCACpB,SAAQ;oCACV,CAAC;oCAED,iFAAiF;oCACjF,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;wCAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;6CAChC,OAAO,EAAE;6CACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;6CACjD,IAAI,CAAC,EAAE,CAAC,CAAA;wCACX,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAA;wCACxB,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;wCACjC,IAAI,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;4CAC3C,sBAAsB,GAAG,EAAE,CAAA;4CAC3B,MAAK;wCACP,CAAC;oCACH,CAAC;oCACD,IAAI,sBAAsB,EAAE,CAAC;wCAC3B,MAAK;oCACP,CAAC;gCACH,CAAC;gCAED,mEAAmE;gCACnE,IAAI,CAAC,sBAAsB,EAAE,CAAC;oCAC5B,OAAM;gCACR,CAAC;gCAED,8DAA8D;gCAC9D,WAAW,GAAG,MAAM,SAAS,CAC3B,MAAM,EACN,kBAAkB,EAClB,oBAAoB,CACrB,CAAC;oCACA,IAAI,EAAE,sBAAsB,CAAC,KAAK,EAAE;iCACrC,CAAC,CAAA;gCAEF,mEAAmE;gCACnE,IACE,WAAW,CAAC,aAAa;oCACzB,WAAW,CAAC,aAAa,GAAG,aAAa,EACzC,CAAC;oCACD,OAAM;gCACR,CAAC;gCAED,IAAI,MAAM,GAAsB,UAAU,CAAA;gCAE1C,mCAAmC;gCACnC,SAAS,kBAAkB,CAAC,EAAe;oCACzC,MAAM,SAAS,GAAa,EAAE,CAAA;oCAC9B,KAAK,MAAM,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;wCAC7B,IAAI,CAAC;4CACH,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAC5C,MAAM,CAAC,MAAM,CACd,CAAA;4CACD,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;wCAC/B,CAAC;wCAAC,OAAO,EAAE,EAAE,CAAC;4CACZ,gDAAgD;wCAClD,CAAC;oCACH,CAAC;oCACD,OAAO,SAAS,CAAA;gCAClB,CAAC;gCAED,4DAA4D;gCAC5D,MAAM,uBAAuB,GAC3B,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;gCAEzC,+DAA+D;gCAC/D,MAAM,0BAA0B,GAAG,kBAAkB,CACnD,sBAAsB,CACvB,CAAA;gCAED,IACE,uBAAuB,CAAC,MAAM;oCAC5B,0BAA0B,CAAC,MAAM;oCACnC,uBAAuB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CACxC,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7C,EACD,CAAC;oCACD,MAAM,GAAG,UAAU,CAAA;gCACrB,CAAC;qCAAM,IACL,aAAa;oCACb,0BAA0B,CAAC,MAAM,KAAK,CAAC;oCACvC,0BAA0B,CAAC,QAAQ,CAAC,aAAa,CAAC,EAClD,CAAC;oCACD,MAAM,GAAG,WAAW,CAAA;gCACtB,CAAC;gCAED,IAAI,CAAC,GAAG,EAAE;oCACR,IAAI,CAAC,UAAU,EAAE,CAAC;wCAChB,MAAM;wCACN,mBAAmB,EAAE,mBAAoB;wCACzC,WAAW,EAAE,WAAY;qCAC1B,CAAC,CAAA;oCACF,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAA;gCAC5B,CAAC,CAAC,CAAA;4BACJ,CAAC;4BAAC,OAAO,IAAI,EAAE,CAAC;gCACd,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;4BAC/B,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;wBAC9B,CAAC;oBACH,CAAC;4BAAS,CAAC;wBACT,KAAK,EAAE,CAAA;oBACT,CAAC;gBACH,CAAC;aACF,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"waitForTransaction.js","names":[],"sources":["../../../src/actions/waitForTransaction.ts"],"sourcesContent":["import { address, Transaction } from 'bitcoinjs-lib'\nimport {\n  TransactionNotFoundError,\n  TransactionReceiptNotFoundError,\n  WaitForTransactionReceiptTimeoutError,\n} from '../errors/transaction.js'\nimport type { Chain } from '../types/chain.js'\nimport type { Client } from '../types/client.js'\nimport type { UTXOTransaction } from '../types/transaction.js'\nimport type { Transport } from '../types/transport.js'\nimport { getAction } from '../utils/getAction.js'\nimport { observe } from '../utils/observe.js'\nimport { stringify } from '../utils/stringify.js'\nimport { withRetry } from '../utils/withRetry.js'\nimport { getBlock } from './getBlock.js'\nimport { getBlockStats } from './getBlockStats.js'\nimport { getUTXOTransaction } from './getUTXOTransaction.js'\nimport { watchBlockNumber } from './watchBlockNumber.js'\n\nexport type ReplacementReason = 'cancelled' | 'replaced' | 'repriced'\nexport type ReplacementReturnType = {\n  reason: ReplacementReason\n  replacedTransaction: Transaction\n  transaction: UTXOTransaction\n}\n\nexport type WaitForTransactionReceiptReturnType = UTXOTransaction\n\nexport type WithRetryParameters = {\n  // The delay (in ms) between retries.\n  delay?:\n    | ((config: { count: number; error: Error }) => number)\n    | number\n    | undefined\n  // The max number of times to retry.\n  retryCount?: number | undefined\n}\n\nexport type WaitForTransactionReceiptParameters = {\n  /** The Id of the transaction. */\n  txId: string\n  /** The hex string of the raw transaction. */\n  txHex: string\n  /** The sender address of the transaction. */\n  senderAddress?: string\n  /**\n   * The number of confirmations (blocks that have passed) to wait before resolving.\n   * @default 1\n   */\n  confirmations?: number | undefined\n  /** Optional callback to emit if the transaction has been replaced. */\n  onReplaced?: ((response: ReplacementReturnType) => void) | undefined\n  /**\n   * Polling frequency (in ms). Defaults to the client's pollingInterval config.\n   * @default client.pollingInterval\n   */\n  pollingInterval?: number | undefined\n  /**\n   * Number of times to retry if the transaction or block is not found.\n   * @default 6 (exponential backoff)\n   */\n  retryCount?: number\n  /**\n   * Time to wait (in ms) between retries.\n   */\n  retryDelay?: ((config: { count: number; error: Error }) => number) | number\n  /** Optional timeout (in milliseconds) to wait before stopping polling. */\n  timeout?: number | undefined\n}\n\n/**\n * Waits for the transaction to be included on a block (one confirmation), and then returns the transaction.\n * - JSON-RPC Methods:\n * - Polls getrawtransaction on each block until it has been processed.\n * - If a transaction has been replaced:\n * - Calls getblock and extracts the transactions\n * - Checks if one of the transactions is a replacement\n * - If so, calls getrawtransaction.\n *\n * The `waitForTransaction` action additionally supports replacement detection (e.g. RBF - transactions replaced-by-fee ).\n *\n * Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel).\n * https://bitcoinops.org/en/topics/replace-by-fee/\n *\n * There are 3 types of Transaction Replacement reasons:\n *\n * - `repriced`: The fee has been modified (e.g. same outputs, different amounts)\n * - `cancelled`: The Transaction has been cancelled (e.g. output is sender address)\n * - `replaced`: The Transaction has been replaced (e.g. different outputs)\n * @param client - Client to use\n * @param parameters - {@link WaitForTransactionReceiptParameters}\n * @returns The UTXO transaction. {@link WaitForTransactionReceiptReturnType}\n */\nexport async function waitForTransaction<chain extends Chain | undefined>(\n  client: Client<Transport, chain>,\n  {\n    confirmations = 1,\n    txId,\n    txHex,\n    senderAddress,\n    onReplaced,\n    pollingInterval = client.pollingInterval,\n    retryCount = 10,\n    retryDelay = 3_000,\n    timeout,\n  }: WaitForTransactionReceiptParameters\n): Promise<WaitForTransactionReceiptReturnType> {\n  const observerId = stringify(['waitForTransaction', client.uid, txId])\n\n  let count = 0\n  let transaction: UTXOTransaction | undefined\n  let replacedTransaction: Transaction | undefined\n  let retrying = false\n\n  return new Promise((resolve, reject) => {\n    if (timeout) {\n      setTimeout(\n        () =>\n          reject(\n            new WaitForTransactionReceiptTimeoutError({ hash: txId as never })\n          ),\n        timeout\n      )\n    }\n\n    const _unobserve = observe(\n      observerId,\n      { onReplaced, resolve, reject },\n      (emit) => {\n        const _unwatch = getAction(\n          client,\n          watchBlockNumber,\n          'watchBlockNumber'\n        )({\n          emitMissed: true,\n          emitOnBegin: true,\n          pollingInterval,\n          async onBlockNumber(blockNumber_) {\n            const done = (fn: () => void) => {\n              _unwatch()\n              fn()\n              _unobserve()\n            }\n\n            let blockNumber = blockNumber_\n\n            if (retrying) {\n              return\n            }\n            if (count > retryCount) {\n              done(() =>\n                emit.reject(\n                  new WaitForTransactionReceiptTimeoutError({\n                    hash: txId as never,\n                  })\n                )\n              )\n            }\n\n            try {\n              // If we already have a valid receipt, let's check if we have enough\n              // confirmations. If we do, then we can resolve.\n              if (transaction?.blockhash) {\n                const blockStats = await getAction(\n                  client,\n                  getBlockStats,\n                  'getBlockStats'\n                )({\n                  blockHash: transaction.blockhash,\n                  stats: ['height'],\n                })\n                if (\n                  confirmations > 1 &&\n                  (!blockStats.height ||\n                    blockNumber - blockStats.height + 1 < confirmations)\n                ) {\n                  return\n                }\n                done(() => emit.resolve(transaction!))\n                return\n              }\n\n              // Get the transaction to check if it's been replaced.\n              // We need to retry as some RPC Providers may be slow to sync\n              // up mined transactions.\n              retrying = true\n              transaction = await withRetry(\n                () =>\n                  getAction(\n                    client,\n                    getUTXOTransaction,\n                    'getUTXOTransaction'\n                    // If transaction exists it might be the replaced one with different txId\n                  )({ txId: transaction?.txid || txId }),\n                {\n                  delay: retryDelay,\n                  retryCount,\n                }\n              )\n              if (transaction.blockhash) {\n                const blockStats = await getAction(\n                  client,\n                  getBlockStats,\n                  'getBlockStats'\n                )({\n                  blockHash: transaction.blockhash,\n                  stats: ['height'],\n                })\n                if (blockStats.height) {\n                  blockNumber = blockStats.height\n                }\n              }\n              retrying = false\n\n              // Check if transaction has been processed.\n              if (!transaction?.confirmations) {\n                throw new TransactionReceiptNotFoundError({\n                  hash: txId as never,\n                })\n              }\n\n              // Check if we have enough confirmations. If not, continue polling.\n              if (transaction.confirmations < confirmations) {\n                return\n              }\n\n              done(() => emit.resolve(transaction!))\n            } catch (err) {\n              // If the receipt is not found, the transaction will be pending.\n              // We need to check if it has potentially been replaced.\n              if (\n                err instanceof TransactionNotFoundError ||\n                err instanceof TransactionReceiptNotFoundError\n              ) {\n                try {\n                  replacedTransaction = Transaction.fromHex(\n                    transaction?.hex || txHex\n                  )\n\n                  // Let's retrieve the transactions from the current block.\n                  // We need to retry as some RPC Providers may be slow to sync\n                  // up mined blocks.\n                  retrying = true\n                  const block = await withRetry(\n                    () =>\n                      getAction(\n                        client,\n                        getBlock,\n                        'getBlock'\n                      )({\n                        blockNumber,\n                      }),\n                    {\n                      delay: retryDelay,\n                      retryCount,\n                      // shouldRetry: ({ error }) =>\n                      //   error instanceof BlockNotFoundError,\n                    }\n                  )\n                  retrying = false\n\n                  // Create a set of input identifiers for mempool transaction\n                  const replacedTransactionInputs = new Set<string>()\n\n                  for (const input of replacedTransaction.ins) {\n                    const txid = Array.from(input.hash)\n                      .reverse()\n                      .map((byte) => `00${byte.toString(16)}`.slice(-2))\n                      .join('')\n                    const vout = input.index\n                    const inputId = `${txid}:${vout}`\n                    replacedTransactionInputs.add(inputId)\n                  }\n\n                  let replacementTransaction: Transaction | undefined\n\n                  for (const tx of block.transactions!) {\n                    if (tx.isCoinbase()) {\n                      continue\n                    }\n\n                    // Check if any input of this transaction matches an input of mempool transaction\n                    for (const input of tx.ins) {\n                      const txid = Array.from(input.hash)\n                        .reverse()\n                        .map((byte) => `00${byte.toString(16)}`.slice(-2))\n                        .join('')\n                      const vout = input.index\n                      const inputId = `${txid}:${vout}`\n                      if (replacedTransactionInputs.has(inputId)) {\n                        replacementTransaction = tx\n                        break\n                      }\n                    }\n                    if (replacementTransaction) {\n                      break\n                    }\n                  }\n\n                  // If we couldn't find a replacement transaction, continue polling.\n                  if (!replacementTransaction) {\n                    return\n                  }\n\n                  // If we found a replacement transaction, return it's receipt.\n                  transaction = await getAction(\n                    client,\n                    getUTXOTransaction,\n                    'getUTXOTransaction'\n                  )({\n                    txId: replacementTransaction.getId(),\n                  })\n\n                  // Check if we have enough confirmations. If not, continue polling.\n                  if (\n                    transaction.confirmations &&\n                    transaction.confirmations < confirmations\n                  ) {\n                    return\n                  }\n\n                  let reason: ReplacementReason = 'replaced'\n\n                  // Function to get output addresses\n                  function getOutputAddresses(tx: Transaction): string[] {\n                    const addresses: string[] = []\n                    for (const output of tx.outs) {\n                      try {\n                        const outputAddress = address.fromOutputScript(\n                          output.script\n                        )\n                        addresses.push(outputAddress)\n                      } catch (_e) {\n                        // Handle non-standard scripts (e.g., OP_RETURN)\n                      }\n                    }\n                    return addresses\n                  }\n\n                  // Get the recipient addresses from the original transaction\n                  const originalOutputAddresses =\n                    getOutputAddresses(replacedTransaction)\n\n                  // Get the recipient addresses from the replacement transaction\n                  const replacementOutputAddresses = getOutputAddresses(\n                    replacementTransaction\n                  )\n\n                  if (\n                    originalOutputAddresses.length ===\n                      replacementOutputAddresses.length &&\n                    originalOutputAddresses.every((address) =>\n                      replacementOutputAddresses.includes(address)\n                    )\n                  ) {\n                    reason = 'repriced'\n                  } else if (\n                    senderAddress &&\n                    replacementOutputAddresses.length === 1 &&\n                    replacementOutputAddresses.includes(senderAddress)\n                  ) {\n                    reason = 'cancelled'\n                  }\n\n                  done(() => {\n                    emit.onReplaced?.({\n                      reason,\n                      replacedTransaction: replacedTransaction!,\n                      transaction: transaction!,\n                    })\n                    emit.resolve(transaction!)\n                  })\n                } catch (err_) {\n                  done(() => emit.reject(err_))\n                }\n              } else {\n                done(() => emit.reject(err))\n              }\n            } finally {\n              count++\n            }\n          },\n        })\n      }\n    )\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,eAAsB,mBACpB,QACA,EACE,gBAAgB,GAChB,MACA,OACA,eACA,YACA,kBAAkB,OAAO,iBACzB,aAAa,IACb,aAAa,KACb,WAE4C;CAC9C,MAAM,aAAa,UAAU;EAAC;EAAsB,OAAO;EAAK;EAAK,CAAC;CAEtE,IAAI,QAAQ;CACZ,IAAI;CACJ,IAAI;CACJ,IAAI,WAAW;AAEf,QAAO,IAAI,SAAS,SAAS,WAAW;AACtC,MAAI,QACF,kBAEI,OACE,IAAI,sCAAsC,EAAE,MAAM,MAAe,CAAC,CACnE,EACH,QACD;EAGH,MAAM,aAAa,QACjB,YACA;GAAE;GAAY;GAAS;GAAQ,GAC9B,SAAS;GACR,MAAM,WAAW,UACf,QACA,kBACA,mBACD,CAAC;IACA,YAAY;IACZ,aAAa;IACb;IACA,MAAM,cAAc,cAAc;KAChC,MAAM,QAAQ,OAAmB;AAC/B,gBAAU;AACV,UAAI;AACJ,kBAAY;;KAGd,IAAI,cAAc;AAElB,SAAI,SACF;AAEF,SAAI,QAAQ,WACV,YACE,KAAK,OACH,IAAI,sCAAsC,EACxC,MAAM,MACP,CAAC,CACH,CACF;AAGH,SAAI;AAGF,UAAI,aAAa,WAAW;OAC1B,MAAM,aAAa,MAAM,UACvB,QACA,eACA,gBACD,CAAC;QACA,WAAW,YAAY;QACvB,OAAO,CAAC,SAAS;QAClB,CAAC;AACF,WACE,gBAAgB,MACf,CAAC,WAAW,UACX,cAAc,WAAW,SAAS,IAAI,eAExC;AAEF,kBAAW,KAAK,QAAQ,YAAa,CAAC;AACtC;;AAMF,iBAAW;AACX,oBAAc,MAAM,gBAEhB,UACE,QACA,oBACA,qBAED,CAAC,EAAE,MAAM,aAAa,QAAQ,MAAM,CAAC,EACxC;OACE,OAAO;OACP;OACD,CACF;AACD,UAAI,YAAY,WAAW;OACzB,MAAM,aAAa,MAAM,UACvB,QACA,eACA,gBACD,CAAC;QACA,WAAW,YAAY;QACvB,OAAO,CAAC,SAAS;QAClB,CAAC;AACF,WAAI,WAAW,OACb,eAAc,WAAW;;AAG7B,iBAAW;AAGX,UAAI,CAAC,aAAa,cAChB,OAAM,IAAI,gCAAgC,EACxC,MAAM,MACP,CAAC;AAIJ,UAAI,YAAY,gBAAgB,cAC9B;AAGF,iBAAW,KAAK,QAAQ,YAAa,CAAC;cAC/B,KAAK;AAGZ,UACE,eAAe,4BACf,eAAe,gCAEf,KAAI;AACF,6BAAsB,YAAY,QAChC,aAAa,OAAO,MACrB;AAKD,kBAAW;OACX,MAAM,QAAQ,MAAM,gBAEhB,UACE,QACA,UACA,WACD,CAAC,EACA,aACD,CAAC,EACJ;QACE,OAAO;QACP;QAGD,CACF;AACD,kBAAW;OAGX,MAAM,4CAA4B,IAAI,KAAa;AAEnD,YAAK,MAAM,SAAS,oBAAoB,KAAK;QAM3C,MAAM,UAAU,GALH,MAAM,KAAK,MAAM,KAAK,CAChC,SAAS,CACT,KAAK,SAAS,KAAK,KAAK,SAAS,GAAG,GAAG,MAAM,GAAG,CAAC,CACjD,KAAK,GAAG,CAEa,GADX,MAAM;AAEnB,kCAA0B,IAAI,QAAQ;;OAGxC,IAAI;AAEJ,YAAK,MAAM,MAAM,MAAM,cAAe;AACpC,YAAI,GAAG,YAAY,CACjB;AAIF,aAAK,MAAM,SAAS,GAAG,KAAK;SAM1B,MAAM,UAAU,GALH,MAAM,KAAK,MAAM,KAAK,CAChC,SAAS,CACT,KAAK,SAAS,KAAK,KAAK,SAAS,GAAG,GAAG,MAAM,GAAG,CAAC,CACjD,KAAK,GAAG,CAEa,GADX,MAAM;AAEnB,aAAI,0BAA0B,IAAI,QAAQ,EAAE;AAC1C,mCAAyB;AACzB;;;AAGJ,YAAI,uBACF;;AAKJ,WAAI,CAAC,uBACH;AAIF,qBAAc,MAAM,UAClB,QACA,oBACA,qBACD,CAAC,EACA,MAAM,uBAAuB,OAAO,EACrC,CAAC;AAGF,WACE,YAAY,iBACZ,YAAY,gBAAgB,cAE5B;OAGF,IAAI,SAA4B;OAGhC,SAAS,mBAAmB,IAA2B;QACrD,MAAM,YAAsB,EAAE;AAC9B,aAAK,MAAM,UAAU,GAAG,KACtB,KAAI;SACF,MAAM,gBAAgB,QAAQ,iBAC5B,OAAO,OACR;AACD,mBAAU,KAAK,cAAc;iBACtB,IAAI;AAIf,eAAO;;OAIT,MAAM,0BACJ,mBAAmB,oBAAoB;OAGzC,MAAM,6BAA6B,mBACjC,uBACD;AAED,WACE,wBAAwB,WACtB,2BAA2B,UAC7B,wBAAwB,OAAO,YAC7B,2BAA2B,SAAS,QAAQ,CAC7C,CAED,UAAS;gBAET,iBACA,2BAA2B,WAAW,KACtC,2BAA2B,SAAS,cAAc,CAElD,UAAS;AAGX,kBAAW;AACT,aAAK,aAAa;SAChB;SACqB;SACR;SACd,CAAC;AACF,aAAK,QAAQ,YAAa;SAC1B;eACK,MAAM;AACb,kBAAW,KAAK,OAAO,KAAK,CAAC;;UAG/B,YAAW,KAAK,OAAO,IAAI,CAAC;eAEtB;AACR;;;IAGL,CAAC;IAEL;GACD"}

package/dist/esm/actions/watchBlockNumber.d.ts

@@ -1,27 +1,33 @@
-import type { Chain } from '../types/chain.js';
-import type { Client } from '../types/client.js';
-import type { Transport } from '../types/transport.js';
-import { type GetBlockCountReturnType } from './getBlockCount.js';
-export type OnBlockNumberParameter = GetBlockCountReturnType;
-export type OnBlockNumberFn = (blockNumber: OnBlockNumberParameter, prevBlockNumber: OnBlockNumberParameter | undefined) => Promise<void>;
-export type WatchBlockNumberParameters = {
-    /** The callback to call when a new block number is received. */
-    onBlockNumber: OnBlockNumberFn;
-    /** The callback to call when an error occurred when trying to get for a new block. */
-    onError?: ((error: Error) => void) | undefined;
+import { Chain } from "../types/chain.js";
+import { Transport } from "../types/transport.js";
+import { Client } from "../types/client.js";
+import { GetBlockCountReturnType } from "./getBlockCount.js";
+
+//#region src/actions/watchBlockNumber.d.ts
+type OnBlockNumberParameter = GetBlockCountReturnType;
+type OnBlockNumberFn = (blockNumber: OnBlockNumberParameter, prevBlockNumber: OnBlockNumberParameter | undefined) => Promise<void>;
+type WatchBlockNumberParameters = {
+  /** The callback to call when a new block number is received. */onBlockNumber: OnBlockNumberFn; /** The callback to call when an error occurred when trying to get for a new block. */
+  onError?: ((error: Error) => void) | undefined;
 } & {
-    /** Whether or not to emit the missed block numbers to the callback. */
-    emitMissed?: boolean | undefined;
-    /** Whether or not to emit the latest block number to the callback when the subscription opens. */
-    emitOnBegin?: boolean | undefined;
-    /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
-    pollingInterval?: number | undefined;
+  /** Whether or not to emit the missed block numbers to the callback. */emitMissed?: boolean | undefined; /** Whether or not to emit the latest block number to the callback when the subscription opens. */
+  emitOnBegin?: boolean | undefined; /** Polling frequency (in ms). Defaults to Client's pollingInterval config. */
+  pollingInterval?: number | undefined;
 };
-export type WatchBlockNumberReturnType = () => void;
+type WatchBlockNumberReturnType = () => void;
 /**
- * Watches and returns incoming block numbers.
- * @param client - Client to use
- * @param parameters - {@link WatchBlockNumberParameters}
- * @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlockNumberReturnType}
- */
-export declare function watchBlockNumber<chain extends Chain | undefined, transport extends Transport>(client: Client<transport, chain>, { emitOnBegin, emitMissed, onBlockNumber, onError, pollingInterval, }: WatchBlockNumberParameters): WatchBlockNumberReturnType;
+* Watches and returns incoming block numbers.
+* @param client - Client to use
+* @param parameters - {@link WatchBlockNumberParameters}
+* @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlockNumberReturnType}
+*/
+declare function watchBlockNumber<chain extends Chain | undefined, transport extends Transport>(client: Client<transport, chain>, {
+  emitOnBegin,
+  emitMissed,
+  onBlockNumber,
+  onError,
+  pollingInterval
+}: WatchBlockNumberParameters): WatchBlockNumberReturnType;
+//#endregion
+export { OnBlockNumberFn, OnBlockNumberParameter, WatchBlockNumberParameters, WatchBlockNumberReturnType, watchBlockNumber };
+//# sourceMappingURL=watchBlockNumber.d.ts.map

package/dist/esm/actions/watchBlockNumber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watchBlockNumber.d.ts","names":[],"sources":["../../../src/actions/watchBlockNumber.ts"],"mappings":";;;;;;KASY,sBAAA,GAAyB,uBAAA;AAAA,KACzB,eAAA,IACV,WAAA,EAAa,sBAAA,EACb,eAAA,EAAiB,sBAAA,iBACd,OAAA;AAAA,KAEO,0BAAA;EANA,gEAQV,aAAA,EAAe,eAAA,EARoB;EAUnC,OAAA,KAAY,KAAA,EAAO,KAAA;AAAA;EATT,uEAYV,UAAA;EAEA,WAAA;EAEA,eAAA;AAAA;AAAA,KAGU,0BAAA;;;;;;;iBAQI,gBAAA,eACA,KAAA,gCACI,SAAA,CAAA,CAElB,MAAA,EAAQ,MAAA,CAAO,SAAA,EAAW,KAAA;EAExB,WAAA;EACA,UAAA;EACA,aAAA;EACA,OAAA;EACA;AAAA,GACC,0BAAA,GACF,0BAAA"}

package/dist/esm/actions/watchBlockNumber.js

@@ -1,58 +1,49 @@
-import { getAction } from '../utils/getAction.js';
-import { observe } from '../utils/observe.js';
-import { poll } from '../utils/poll.js';
-import { stringify } from '../utils/stringify.js';
-import { getBlockCount } from './getBlockCount.js';
+import { getBlockCount } from "./getBlockCount.js";
+import { getAction } from "../utils/getAction.js";
+import { observe } from "../utils/observe.js";
+import { stringify } from "../utils/stringify.js";
+import { poll } from "../utils/poll.js";
+//#region src/actions/watchBlockNumber.ts
 /**
- * Watches and returns incoming block numbers.
- * @param client - Client to use
- * @param parameters - {@link WatchBlockNumberParameters}
- * @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlockNumberReturnType}
- */
-export function watchBlockNumber(client, { emitOnBegin = false, emitMissed = false, onBlockNumber, onError, pollingInterval = client.pollingInterval, }) {
-    let prevBlockNumber;
-    const observerId = stringify([
-        'watchBlockNumber',
-        client.uid,
-        emitOnBegin,
-        emitMissed,
-        pollingInterval,
-    ]);
-    // TODO (edge cases):
-    // 1) Stop iterating block numbers if we are happy with the result of one onBlockNumber execution but there is more in the queue.
-    // 2) If we missed some time - user closed the page and came back when the block is already mined.
-    // In this case we probably want to save the block when we send the transaction and track the currently checked blocks until we find the relevant one.
-    return observe(observerId, { onBlockNumber, onError }, (emit) => poll(async () => {
-        try {
-            const blockNumber = await getAction(client, getBlockCount, 'getBlockCount')({ cacheTime: 0 });
-            if (prevBlockNumber) {
-                // If the current block number is the same as the previous,
-                // we can skip.
-                if (blockNumber === prevBlockNumber) {
-                    return;
-                }
-                // If we have missed out on some previous blocks, and the
-                // `emitMissed` flag is truthy, let's emit those blocks.
-                if (blockNumber - prevBlockNumber > 1 && emitMissed) {
-                    for (let i = prevBlockNumber + 1; i < blockNumber; i++) {
-                        await emit.onBlockNumber(i, prevBlockNumber);
-                        prevBlockNumber = i;
-                    }
-                }
-            }
-            // If the next block number is greater than the previous,
-            // it is not in the past, and we can emit the new block number.
-            if (!prevBlockNumber || blockNumber > prevBlockNumber) {
-                await emit.onBlockNumber(blockNumber, prevBlockNumber);
-                prevBlockNumber = blockNumber;
-            }
-        }
-        catch (err) {
-            emit.onError?.(err);
-        }
-    }, {
-        emitOnBegin,
-        interval: pollingInterval,
-    }));
+* Watches and returns incoming block numbers.
+* @param client - Client to use
+* @param parameters - {@link WatchBlockNumberParameters}
+* @returns A function that can be invoked to stop watching for new block numbers. {@link WatchBlockNumberReturnType}
+*/
+function watchBlockNumber(client, { emitOnBegin = false, emitMissed = false, onBlockNumber, onError, pollingInterval = client.pollingInterval }) {
+	let prevBlockNumber;
+	return observe(stringify([
+		"watchBlockNumber",
+		client.uid,
+		emitOnBegin,
+		emitMissed,
+		pollingInterval
+	]), {
+		onBlockNumber,
+		onError
+	}, (emit) => poll(async () => {
+		try {
+			const blockNumber = await getAction(client, getBlockCount, "getBlockCount")({ cacheTime: 0 });
+			if (prevBlockNumber) {
+				if (blockNumber === prevBlockNumber) return;
+				if (blockNumber - prevBlockNumber > 1 && emitMissed) for (let i = prevBlockNumber + 1; i < blockNumber; i++) {
+					await emit.onBlockNumber(i, prevBlockNumber);
+					prevBlockNumber = i;
+				}
+			}
+			if (!prevBlockNumber || blockNumber > prevBlockNumber) {
+				await emit.onBlockNumber(blockNumber, prevBlockNumber);
+				prevBlockNumber = blockNumber;
+			}
+		} catch (err) {
+			emit.onError?.(err);
+		}
+	}, {
+		emitOnBegin,
+		interval: pollingInterval
+	}));
 }
+//#endregion
+export { watchBlockNumber };
+
 //# sourceMappingURL=watchBlockNumber.js.map