@dedot/api 0.18.6 → 0.18.7

package/cjs/extrinsic/submittable/SubmittableExtrinsicV2.js

@@ -63,23 +63,30 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
         };
         let txFound;
         let isSearching = false;
-        let searchQueue = new utils_1.AsyncQueue();
-        // TODO 1. move the searching logic into a different utility
-        //      2. properly cancel the work by actually cancel the on-going operations
+        const searchQueue = new utils_1.AsyncQueue();
+        const finalizedQueue = new utils_1.AsyncQueue();
+        const trackedHashes = [];
         const cancelPendingSearch = () => {
             searchQueue.clear();
         };
         const cancelBodySearch = () => {
             searchQueue.cancel();
         };
-        const startSearching = (block) => {
-            return searchQueue.enqueue(async () => {
-                const found = await checkTxIsOnChain(block.hash);
+        const startSearching = async (block) => {
+            const hash = block.hash;
+            if (!trackedHashes.includes(hash)) {
+                api.chainHead.holdBlock(hash);
+                trackedHashes.push(hash);
+            }
+            return searchQueue
+                .enqueue(async () => {
+                const found = await checkTxIsOnChain(hash);
                 if (found) {
                     cancelPendingSearch();
                 }
                 return found;
-            });
+            })
+                .catch(() => undefined);
         };
         const checkBestBlockIncluded = async (block, bestChainChanged) => {
             if (bestChainChanged) {
@@ -142,43 +149,56 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
             }
         };
         const checkFinalizedBlockIncluded = async (block) => {
-            const inBlock = await checkTxIsOnChain(block.hash);
-            if (inBlock) {
-                const { index: txIndex, events, blockHash, blockNumber } = inBlock;
-                callback(new SubmittableResult_js_1.SubmittableResult({
-                    status: { type: 'Finalized', value: { blockHash, blockNumber, txIndex } },
-                    txHash,
-                    events,
-                    txIndex,
-                }));
-            }
-            else {
-                // Revalidate the tx, just in-case it becomes invalid along the way
-                // Context: https://github.com/paritytech/json-rpc-interface-spec/pull/107#issuecomment-1906008814
-                const validation = await validateTx(block.hash);
-                if (validation.isOk)
-                    return;
-                callback(new SubmittableResult_js_1.SubmittableResult({
-                    status: {
-                        type: 'Invalid',
-                        value: { error: `Invalid Tx: ${validation.err.type} - ${validation.err.value.type}` },
-                    },
-                    txHash,
-                }));
+            const hash = block.hash;
+            if (!trackedHashes.includes(hash)) {
+                api.chainHead.holdBlock(hash);
+                trackedHashes.push(hash);
             }
-            txUnsub().catch(utils_1.noop);
+            finalizedQueue
+                .enqueue(async () => {
+                const inBlock = await checkTxIsOnChain(hash);
+                if (inBlock) {
+                    const { index: txIndex, events, blockHash, blockNumber } = inBlock;
+                    callback(new SubmittableResult_js_1.SubmittableResult({
+                        status: { type: 'Finalized', value: { blockHash, blockNumber, txIndex } },
+                        txHash,
+                        events,
+                        txIndex,
+                    }));
+                }
+                else {
+                    // Revalidate the tx, just in-case it becomes invalid along the way
+                    // Context: https://github.com/paritytech/json-rpc-interface-spec/pull/107#issuecomment-1906008814
+                    const validation = await validateTx(hash);
+                    if (validation.isOk)
+                        return;
+                    callback(new SubmittableResult_js_1.SubmittableResult({
+                        status: {
+                            type: 'Invalid',
+                            value: { error: `Invalid Tx: ${validation.err.type} - ${validation.err.value.type}` },
+                        },
+                        txHash,
+                    }));
+                }
+                txUnsub().catch(utils_1.noop);
+            })
+                .catch(utils_1.noop);
         };
+        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
+        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         stopBroadcastFn = await api.txBroadcaster.broadcastTx(txHex);
         callback(new SubmittableResult_js_1.SubmittableResult({
             status: { type: 'Broadcasting' },
             txHash,
         }));
-        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
-        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         const stopTracking = () => {
             stopBestBlockTrackingFn();
             stopFinalizedBlockTrackingFn();
             cancelBodySearch();
+            finalizedQueue.cancel();
+            trackedHashes.forEach((h) => {
+                api.chainHead.releaseBlock(h);
+            });
         };
         txUnsub = async () => {
             stopTracking();

package/cjs/json-rpc/group/ChainHead/ChainHead.js

@@ -765,5 +765,12 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
         this.#cache.clear();
         this.#archive?.clearCache();
     }
+    holdBlock(hash) {
+        this.#ensurePinnedHash(hash);
+        this.#blockUsage.use(hash);
+    }
+    releaseBlock(hash) {
+        this.#blockUsage.release(hash);
+    }
 }
 exports.ChainHead = ChainHead;

package/extrinsic/submittable/SubmittableExtrinsicV2.js

@@ -60,23 +60,30 @@ export class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic {
         };
         let txFound;
         let isSearching = false;
-        let searchQueue = new AsyncQueue();
-        // TODO 1. move the searching logic into a different utility
-        //      2. properly cancel the work by actually cancel the on-going operations
+        const searchQueue = new AsyncQueue();
+        const finalizedQueue = new AsyncQueue();
+        const trackedHashes = [];
         const cancelPendingSearch = () => {
             searchQueue.clear();
         };
         const cancelBodySearch = () => {
             searchQueue.cancel();
         };
-        const startSearching = (block) => {
-            return searchQueue.enqueue(async () => {
-                const found = await checkTxIsOnChain(block.hash);
+        const startSearching = async (block) => {
+            const hash = block.hash;
+            if (!trackedHashes.includes(hash)) {
+                api.chainHead.holdBlock(hash);
+                trackedHashes.push(hash);
+            }
+            return searchQueue
+                .enqueue(async () => {
+                const found = await checkTxIsOnChain(hash);
                 if (found) {
                     cancelPendingSearch();
                 }
                 return found;
-            });
+            })
+                .catch(() => undefined);
         };
         const checkBestBlockIncluded = async (block, bestChainChanged) => {
             if (bestChainChanged) {
@@ -139,43 +146,56 @@ export class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic {
             }
         };
         const checkFinalizedBlockIncluded = async (block) => {
-            const inBlock = await checkTxIsOnChain(block.hash);
-            if (inBlock) {
-                const { index: txIndex, events, blockHash, blockNumber } = inBlock;
-                callback(new SubmittableResult({
-                    status: { type: 'Finalized', value: { blockHash, blockNumber, txIndex } },
-                    txHash,
-                    events,
-                    txIndex,
-                }));
-            }
-            else {
-                // Revalidate the tx, just in-case it becomes invalid along the way
-                // Context: https://github.com/paritytech/json-rpc-interface-spec/pull/107#issuecomment-1906008814
-                const validation = await validateTx(block.hash);
-                if (validation.isOk)
-                    return;
-                callback(new SubmittableResult({
-                    status: {
-                        type: 'Invalid',
-                        value: { error: `Invalid Tx: ${validation.err.type} - ${validation.err.value.type}` },
-                    },
-                    txHash,
-                }));
+            const hash = block.hash;
+            if (!trackedHashes.includes(hash)) {
+                api.chainHead.holdBlock(hash);
+                trackedHashes.push(hash);
             }
-            txUnsub().catch(noop);
+            finalizedQueue
+                .enqueue(async () => {
+                const inBlock = await checkTxIsOnChain(hash);
+                if (inBlock) {
+                    const { index: txIndex, events, blockHash, blockNumber } = inBlock;
+                    callback(new SubmittableResult({
+                        status: { type: 'Finalized', value: { blockHash, blockNumber, txIndex } },
+                        txHash,
+                        events,
+                        txIndex,
+                    }));
+                }
+                else {
+                    // Revalidate the tx, just in-case it becomes invalid along the way
+                    // Context: https://github.com/paritytech/json-rpc-interface-spec/pull/107#issuecomment-1906008814
+                    const validation = await validateTx(hash);
+                    if (validation.isOk)
+                        return;
+                    callback(new SubmittableResult({
+                        status: {
+                            type: 'Invalid',
+                            value: { error: `Invalid Tx: ${validation.err.type} - ${validation.err.value.type}` },
+                        },
+                        txHash,
+                    }));
+                }
+                txUnsub().catch(noop);
+            })
+                .catch(noop);
         };
+        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
+        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         stopBroadcastFn = await api.txBroadcaster.broadcastTx(txHex);
         callback(new SubmittableResult({
             status: { type: 'Broadcasting' },
             txHash,
         }));
-        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
-        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         const stopTracking = () => {
             stopBestBlockTrackingFn();
             stopFinalizedBlockTrackingFn();
             cancelBodySearch();
+            finalizedQueue.cancel();
+            trackedHashes.forEach((h) => {
+                api.chainHead.releaseBlock(h);
+            });
         };
         txUnsub = async () => {
             stopTracking();

package/json-rpc/group/ChainHead/ChainHead.d.ts

@@ -87,4 +87,6 @@ export declare class ChainHead extends JsonRpcGroup<ChainHeadEvent> {
      * ```
      */
     clearCache(): void;
+    holdBlock(hash: BlockHash): void;
+    releaseBlock(hash: BlockHash): void;
 }

package/json-rpc/group/ChainHead/ChainHead.js

@@ -762,4 +762,11 @@ export class ChainHead extends JsonRpcGroup {
         this.#cache.clear();
         this.#archive?.clearCache();
     }
+    holdBlock(hash) {
+        this.#ensurePinnedHash(hash);
+        this.#blockUsage.use(hash);
+    }
+    releaseBlock(hash) {
+        this.#blockUsage.release(hash);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/api",
-  "version": "0.18.6",
+  "version": "0.18.7",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@dedot.dev>",
   "homepage": "https://dedot.dev",
@@ -13,13 +13,13 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@dedot/codecs": "0.18.6",
-    "@dedot/providers": "0.18.6",
-    "@dedot/runtime-specs": "0.18.6",
-    "@dedot/shape": "0.18.6",
-    "@dedot/storage": "0.18.6",
-    "@dedot/types": "0.18.6",
-    "@dedot/utils": "0.18.6"
+    "@dedot/codecs": "0.18.7",
+    "@dedot/providers": "0.18.7",
+    "@dedot/runtime-specs": "0.18.7",
+    "@dedot/shape": "0.18.7",
+    "@dedot/storage": "0.18.7",
+    "@dedot/types": "0.18.7",
+    "@dedot/utils": "0.18.7"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
@@ -48,7 +48,7 @@
     "node": ">=18"
   },
   "license": "Apache-2.0",
-  "gitHead": "2ff0200696aa2e42505d30369fe84b2416838791",
+  "gitHead": "07f47f75512087407e03f301fc18c2059b3f613a",
   "module": "./index.js",
   "types": "./index.d.ts"
 }