@dedot/api 0.18.5 → 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

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChainHead = exports.MIN_FINALIZED_QUEUE_SIZE = void 0;
+exports.ChainHead = void 0;
 const codecs_1 = require("@dedot/codecs");
 const utils_1 = require("@dedot/utils");
 const JsonRpcGroup_js_1 = require("../JsonRpcGroup.js");
 const BlockUsage_js_1 = require("./BlockUsage.js");
 const error_js_1 = require("./error.js");
-exports.MIN_FINALIZED_QUEUE_SIZE = 10; // finalized queue size
+const MIN_FINALIZED_QUEUE_SIZE = 16; // finalized queue size
 const CHAINHEAD_CACHE_CAPACITY = 256;
 const CHAINHEAD_CACHE_TTL = 30_000; // 30 seconds
 class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
@@ -25,6 +25,7 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
     #blockUsage;
     #cache;
     #operationQueue;
+    #minQueueSize;
     /**
      * Archive instance used as fallback when ChainHead blocks are not pinned.
      *
@@ -48,6 +49,7 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
         this.#cache = new utils_1.LRUCache(CHAINHEAD_CACHE_CAPACITY, CHAINHEAD_CACHE_TTL);
         // This helps us to not accidentally putting too much stress on the JSON-RPC server, especially smoldot/light-client
         this.#operationQueue = new utils_1.ThrottleQueue(this.#__unsafe__isSmoldot() ? 25 : 250);
+        this.#minQueueSize = MIN_FINALIZED_QUEUE_SIZE;
     }
     /**
      * Attach an Archive instance as fallback for operations that fail due to unpinned blocks.
@@ -140,6 +142,9 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
                     finalizedBlockHashes.push(finalizedBlockHash);
                 this.#subscriptionId = subscription.subscriptionId;
                 this.#finalizedQueue = finalizedBlockHashes;
+                if (finalizedBlockHashes.length > MIN_FINALIZED_QUEUE_SIZE) {
+                    this.#minQueueSize = finalizedBlockHashes.length;
+                }
                 this.#finalizedRuntime = this.#extractRuntime(finalizedBlockRuntime);
                 (0, utils_1.assert)(this.#finalizedRuntime, 'Invalid finalized runtime');
                 this.#bestHash = this.#finalizedHash = finalizedBlockHashes.at(-1);
@@ -224,9 +229,9 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
                 const pinnedHashes = Object.keys(this.#pinnedBlocks);
                 const hashesToUnpin = new Set(prunedBlockHashes.filter((hash) => pinnedHashes.includes(hash)));
                 // Unpin the oldest finalized pinned blocks to maintain the queue size
-                if (this.#finalizedQueue.length > exports.MIN_FINALIZED_QUEUE_SIZE) {
+                if (this.#finalizedQueue.length > this.#minQueueSize) {
                     const finalizedQueue = this.#finalizedQueue.slice();
-                    const numOfItemsToUnpin = finalizedQueue.length - exports.MIN_FINALIZED_QUEUE_SIZE;
+                    const numOfItemsToUnpin = finalizedQueue.length - this.#minQueueSize;
                     const queuedHashesToUnpin = finalizedQueue.splice(0, numOfItemsToUnpin);
                     queuedHashesToUnpin.forEach((hash) => {
                         // if the block is being used, we'll keep it pinned
@@ -553,9 +558,15 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
                 const resp = await this.send('body', this.#subscriptionId, hash);
                 return this.#awaitOperation(resp, hash);
             };
-            const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(bodyOperation, atHash));
-            this.#cache.set(cacheKey, resp);
-            return resp;
+            try {
+                this.#blockUsage.use(atHash);
+                const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(bodyOperation, atHash));
+                this.#cache.set(cacheKey, resp);
+                return resp;
+            }
+            finally {
+                this.#blockUsage.release(atHash);
+            }
         };
         const fallback = async (archive, hash) => {
             const result = await archive.body(hash);
@@ -593,9 +604,15 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
                 const resp = await this.send('call', this.#subscriptionId, hash, func, params);
                 return this.#awaitOperation(resp, hash);
             };
-            const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(callOperation, atHash));
-            this.#cache.set(cacheKey, resp);
-            return resp;
+            try {
+                this.#blockUsage.use(atHash);
+                const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(callOperation, atHash));
+                this.#cache.set(cacheKey, resp);
+                return resp;
+            }
+            finally {
+                this.#blockUsage.release(atHash);
+            }
         };
         const fallback = (archive, hash) => archive.call(func, params, hash);
         try {
@@ -687,7 +704,13 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
     }
     async #getStorage(items, childTrie, at) {
         const operation = () => this.#getStorageOperation(items, childTrie, this.#ensurePinnedHash(at));
-        return this.#operationQueue.add(() => this.#performOperationWithRetry(operation, at));
+        try {
+            this.#blockUsage.use(at);
+            return await this.#operationQueue.add(() => this.#performOperationWithRetry(operation, at));
+        }
+        finally {
+            this.#blockUsage.release(at);
+        }
     }
     async #getStorageOperation(items, childTrie, at) {
         await this.#ensureFollowed();
@@ -742,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

@@ -17,7 +17,6 @@ export type PinnedBlock = {
     runtime?: ChainHeadRuntimeVersion;
 };
 export type ChainHeadEvent = 'newBlock' | 'bestBlock' | 'finalizedBlock' | 'bestChainChanged';
-export declare const MIN_FINALIZED_QUEUE_SIZE = 10;
 export declare class ChainHead extends JsonRpcGroup<ChainHeadEvent> {
     #private;
     constructor(client: IJsonRpcClient, options?: Partial<JsonRpcGroupOptions>);
@@ -88,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

@@ -3,7 +3,7 @@ import { assert, AsyncQueue, deferred, ensurePresence, noop, ThrottleQueue, wait
 import { JsonRpcGroup } from '../JsonRpcGroup.js';
 import { BlockUsage } from './BlockUsage.js';
 import { ChainHeadBlockNotPinnedError, ChainHeadBlockPrunedError, ChainHeadError, ChainHeadLimitReachedError, ChainHeadOperationError, ChainHeadOperationInaccessibleError, ChainHeadStopError, RetryStrategy, } from './error.js';
-export const MIN_FINALIZED_QUEUE_SIZE = 10; // finalized queue size
+const MIN_FINALIZED_QUEUE_SIZE = 16; // finalized queue size
 const CHAINHEAD_CACHE_CAPACITY = 256;
 const CHAINHEAD_CACHE_TTL = 30_000; // 30 seconds
 export class ChainHead extends JsonRpcGroup {
@@ -22,6 +22,7 @@ export class ChainHead extends JsonRpcGroup {
     #blockUsage;
     #cache;
     #operationQueue;
+    #minQueueSize;
     /**
      * Archive instance used as fallback when ChainHead blocks are not pinned.
      *
@@ -45,6 +46,7 @@ export class ChainHead extends JsonRpcGroup {
         this.#cache = new LRUCache(CHAINHEAD_CACHE_CAPACITY, CHAINHEAD_CACHE_TTL);
         // This helps us to not accidentally putting too much stress on the JSON-RPC server, especially smoldot/light-client
         this.#operationQueue = new ThrottleQueue(this.#__unsafe__isSmoldot() ? 25 : 250);
+        this.#minQueueSize = MIN_FINALIZED_QUEUE_SIZE;
     }
     /**
      * Attach an Archive instance as fallback for operations that fail due to unpinned blocks.
@@ -137,6 +139,9 @@ export class ChainHead extends JsonRpcGroup {
                     finalizedBlockHashes.push(finalizedBlockHash);
                 this.#subscriptionId = subscription.subscriptionId;
                 this.#finalizedQueue = finalizedBlockHashes;
+                if (finalizedBlockHashes.length > MIN_FINALIZED_QUEUE_SIZE) {
+                    this.#minQueueSize = finalizedBlockHashes.length;
+                }
                 this.#finalizedRuntime = this.#extractRuntime(finalizedBlockRuntime);
                 assert(this.#finalizedRuntime, 'Invalid finalized runtime');
                 this.#bestHash = this.#finalizedHash = finalizedBlockHashes.at(-1);
@@ -221,9 +226,9 @@ export class ChainHead extends JsonRpcGroup {
                 const pinnedHashes = Object.keys(this.#pinnedBlocks);
                 const hashesToUnpin = new Set(prunedBlockHashes.filter((hash) => pinnedHashes.includes(hash)));
                 // Unpin the oldest finalized pinned blocks to maintain the queue size
-                if (this.#finalizedQueue.length > MIN_FINALIZED_QUEUE_SIZE) {
+                if (this.#finalizedQueue.length > this.#minQueueSize) {
                     const finalizedQueue = this.#finalizedQueue.slice();
-                    const numOfItemsToUnpin = finalizedQueue.length - MIN_FINALIZED_QUEUE_SIZE;
+                    const numOfItemsToUnpin = finalizedQueue.length - this.#minQueueSize;
                     const queuedHashesToUnpin = finalizedQueue.splice(0, numOfItemsToUnpin);
                     queuedHashesToUnpin.forEach((hash) => {
                         // if the block is being used, we'll keep it pinned
@@ -550,9 +555,15 @@ export class ChainHead extends JsonRpcGroup {
                 const resp = await this.send('body', this.#subscriptionId, hash);
                 return this.#awaitOperation(resp, hash);
             };
-            const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(bodyOperation, atHash));
-            this.#cache.set(cacheKey, resp);
-            return resp;
+            try {
+                this.#blockUsage.use(atHash);
+                const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(bodyOperation, atHash));
+                this.#cache.set(cacheKey, resp);
+                return resp;
+            }
+            finally {
+                this.#blockUsage.release(atHash);
+            }
         };
         const fallback = async (archive, hash) => {
             const result = await archive.body(hash);
@@ -590,9 +601,15 @@ export class ChainHead extends JsonRpcGroup {
                 const resp = await this.send('call', this.#subscriptionId, hash, func, params);
                 return this.#awaitOperation(resp, hash);
             };
-            const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(callOperation, atHash));
-            this.#cache.set(cacheKey, resp);
-            return resp;
+            try {
+                this.#blockUsage.use(atHash);
+                const resp = await this.#operationQueue.add(() => this.#performOperationWithRetry(callOperation, atHash));
+                this.#cache.set(cacheKey, resp);
+                return resp;
+            }
+            finally {
+                this.#blockUsage.release(atHash);
+            }
         };
         const fallback = (archive, hash) => archive.call(func, params, hash);
         try {
@@ -684,7 +701,13 @@ export class ChainHead extends JsonRpcGroup {
     }
     async #getStorage(items, childTrie, at) {
         const operation = () => this.#getStorageOperation(items, childTrie, this.#ensurePinnedHash(at));
-        return this.#operationQueue.add(() => this.#performOperationWithRetry(operation, at));
+        try {
+            this.#blockUsage.use(at);
+            return await this.#operationQueue.add(() => this.#performOperationWithRetry(operation, at));
+        }
+        finally {
+            this.#blockUsage.release(at);
+        }
     }
     async #getStorageOperation(items, childTrie, at) {
         await this.#ensureFollowed();
@@ -739,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.5",
+  "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.5",
-    "@dedot/providers": "0.18.5",
-    "@dedot/runtime-specs": "0.18.5",
-    "@dedot/shape": "0.18.5",
-    "@dedot/storage": "0.18.5",
-    "@dedot/types": "0.18.5",
-    "@dedot/utils": "0.18.5"
+    "@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": "54b0dcfddfc775009eacd1858441b1b2b12b9cae",
+  "gitHead": "07f47f75512087407e03f301fc18c2059b3f613a",
   "module": "./index.js",
   "types": "./index.d.ts"
 }