@dedot/api 0.9.1 → 0.9.3

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

@@ -360,7 +360,17 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
         if (!runtimeEvent)
             return;
         if (runtimeEvent.type == 'valid') {
-            return runtimeEvent.spec;
+            const newRuntimeVersion = runtimeEvent.spec;
+            // fix inconsistent type of returned apis
+            // in some network endpoints this newRuntimeVersion.apis is an array (maybe using an old version of the sdk)
+            // here we convert it to a map format for consistency.
+            if (Array.isArray(newRuntimeVersion.apis)) {
+                newRuntimeVersion.apis = newRuntimeVersion.apis.reduce((o, [name, version]) => {
+                    o[name] = version;
+                    return o;
+                }, {});
+            }
+            return newRuntimeVersion;
         }
         // If the runtime is invalid,
         // we safely return an undefined runtime for now
@@ -400,7 +410,7 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
         }
         catch (e) {
             if (e instanceof error_js_1.ChainHeadError && e.retryStrategy) {
-                return this.#retryOperation(e.retryStrategy, operation);
+                return await this.#retryOperation(e.retryStrategy, operation);
             }
             throw e;
         }
@@ -427,7 +437,7 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
         catch (e) {
             // retry again until success, TODO we might need to limit the number of retries
             if (e instanceof error_js_1.ChainHeadError && e.retryStrategy) {
-                return this.#retryOperation(e.retryStrategy, retry);
+                return await this.#retryOperation(e.retryStrategy, retry);
             }
             throw e;
         }
@@ -540,19 +550,36 @@ class ChainHead extends JsonRpcGroup_js_1.JsonRpcGroup {
                 return this.#cache.get(cacheKey);
             }
             this.#blockUsage.use(hash);
-            const results = [];
-            let queryItems = items;
-            while (queryItems.length > 0) {
-                const [newBatch, newDiscardedItems] = await this.#getStorage(queryItems, childTrie ?? null, hash);
-                results.push(...newBatch);
-                queryItems = newDiscardedItems;
+            let results = [];
+            // @ts-ignore a trick internally to check whether a provider is using smoldot connection
+            const isSmoldot = typeof this.client.provider['chain'] === 'function';
+            if (isSmoldot) {
+                const fetchItem = async (item) => {
+                    const [newBatch, newDiscardedItems] = await this.#getStorage([item], childTrie ?? null, hash);
+                    if (newDiscardedItems.length > 0) {
+                        return fetchItem(item);
+                    }
+                    if (newBatch.length === 0) {
+                        return { key: item.key, value: undefined };
+                    }
+                    return newBatch[0];
+                };
+                results = await Promise.all(items.map((one) => fetchItem(one)));
+            }
+            else {
+                let queryItems = items;
+                while (queryItems.length > 0) {
+                    const [newBatch, newDiscardedItems] = await this.#getStorage(queryItems, childTrie ?? null, hash);
+                    results.push(...newBatch);
+                    queryItems = newDiscardedItems;
+                }
             }
             this.#cache.set(cacheKey, results);
             return results;
         }
         catch (e) {
             if (e instanceof error_js_1.ChainHeadBlockPrunedError && shouldRetryOnPrunedBlock) {
-                return this.storage(items, childTrie);
+                return await this.storage(items, childTrie);
             }
             throw e;
         }

package/cjs/storage/NewStorageQuery.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NewStorageQuery = void 0;
+const utils_1 = require("@dedot/utils");
 const BaseStorageQuery_js_1 = require("./BaseStorageQuery.js");
 /**
  * @name NewStorageQuery
@@ -51,6 +52,11 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
         const best = await this.client.chainHead.bestBlock();
         // Track the latest changes for each key
         const latestChanges = {};
+        // Using a queue here to make sure we don't accidentally
+        // put a pressure the json-rpc server in-case new blocks stack up too fast
+        // in case we send a lot of requests at the same time
+        // or the block time is small enough with elastic scaling
+        const pullQueue = new utils_1.AsyncQueue();
         // Function to pull storage values and call the callback if there are changes
         const pull = async ({ hash }) => {
             // Query storage using ChainHead API
@@ -76,9 +82,12 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
         // Initial pull
         await pull(best);
         // Subscribe to best block events
-        const unsub = this.client.on('bestBlock', pull);
+        const unsub = this.client.on('bestBlock', (block) => {
+            pullQueue.enqueue(() => pull(block)).catch(console.error);
+        });
         return async () => {
             unsub();
+            pullQueue.cancel();
         };
     }
 }

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

@@ -357,7 +357,17 @@ export class ChainHead extends JsonRpcGroup {
         if (!runtimeEvent)
             return;
         if (runtimeEvent.type == 'valid') {
-            return runtimeEvent.spec;
+            const newRuntimeVersion = runtimeEvent.spec;
+            // fix inconsistent type of returned apis
+            // in some network endpoints this newRuntimeVersion.apis is an array (maybe using an old version of the sdk)
+            // here we convert it to a map format for consistency.
+            if (Array.isArray(newRuntimeVersion.apis)) {
+                newRuntimeVersion.apis = newRuntimeVersion.apis.reduce((o, [name, version]) => {
+                    o[name] = version;
+                    return o;
+                }, {});
+            }
+            return newRuntimeVersion;
         }
         // If the runtime is invalid,
         // we safely return an undefined runtime for now
@@ -397,7 +407,7 @@ export class ChainHead extends JsonRpcGroup {
         }
         catch (e) {
             if (e instanceof ChainHeadError && e.retryStrategy) {
-                return this.#retryOperation(e.retryStrategy, operation);
+                return await this.#retryOperation(e.retryStrategy, operation);
             }
             throw e;
         }
@@ -424,7 +434,7 @@ export class ChainHead extends JsonRpcGroup {
         catch (e) {
             // retry again until success, TODO we might need to limit the number of retries
             if (e instanceof ChainHeadError && e.retryStrategy) {
-                return this.#retryOperation(e.retryStrategy, retry);
+                return await this.#retryOperation(e.retryStrategy, retry);
             }
             throw e;
         }
@@ -537,19 +547,36 @@ export class ChainHead extends JsonRpcGroup {
                 return this.#cache.get(cacheKey);
             }
             this.#blockUsage.use(hash);
-            const results = [];
-            let queryItems = items;
-            while (queryItems.length > 0) {
-                const [newBatch, newDiscardedItems] = await this.#getStorage(queryItems, childTrie ?? null, hash);
-                results.push(...newBatch);
-                queryItems = newDiscardedItems;
+            let results = [];
+            // @ts-ignore a trick internally to check whether a provider is using smoldot connection
+            const isSmoldot = typeof this.client.provider['chain'] === 'function';
+            if (isSmoldot) {
+                const fetchItem = async (item) => {
+                    const [newBatch, newDiscardedItems] = await this.#getStorage([item], childTrie ?? null, hash);
+                    if (newDiscardedItems.length > 0) {
+                        return fetchItem(item);
+                    }
+                    if (newBatch.length === 0) {
+                        return { key: item.key, value: undefined };
+                    }
+                    return newBatch[0];
+                };
+                results = await Promise.all(items.map((one) => fetchItem(one)));
+            }
+            else {
+                let queryItems = items;
+                while (queryItems.length > 0) {
+                    const [newBatch, newDiscardedItems] = await this.#getStorage(queryItems, childTrie ?? null, hash);
+                    results.push(...newBatch);
+                    queryItems = newDiscardedItems;
+                }
             }
             this.#cache.set(cacheKey, results);
             return results;
         }
         catch (e) {
             if (e instanceof ChainHeadBlockPrunedError && shouldRetryOnPrunedBlock) {
-                return this.storage(items, childTrie);
+                return await this.storage(items, childTrie);
             }
             throw e;
         }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dedot/api",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
-  "author": "Thang X. Vu <thang@coongcrafts.io>",
-  "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/api",
+  "author": "Thang X. Vu <thang@dedot.dev>",
+  "homepage": "https://dedot.dev",
   "repository": {
     "directory": "packages/api",
     "type": "git",
@@ -13,13 +13,13 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@dedot/codecs": "0.9.1",
-    "@dedot/providers": "0.9.1",
-    "@dedot/runtime-specs": "0.9.1",
-    "@dedot/shape": "0.9.1",
-    "@dedot/storage": "0.9.1",
-    "@dedot/types": "0.9.1",
-    "@dedot/utils": "0.9.1"
+    "@dedot/codecs": "0.9.3",
+    "@dedot/providers": "0.9.3",
+    "@dedot/runtime-specs": "0.9.3",
+    "@dedot/shape": "0.9.3",
+    "@dedot/storage": "0.9.3",
+    "@dedot/types": "0.9.3",
+    "@dedot/utils": "0.9.3"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
@@ -48,7 +48,7 @@
     "node": ">=18"
   },
   "license": "Apache-2.0",
-  "gitHead": "9329cadcd2062d0f10dc1d8f700d8ade25214199",
+  "gitHead": "206c4999865cddbd1078bf5b059c7b49822e20d0",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/storage/NewStorageQuery.js

@@ -1,3 +1,4 @@
+import { AsyncQueue } from '@dedot/utils';
 import { BaseStorageQuery } from './BaseStorageQuery.js';
 /**
  * @name NewStorageQuery
@@ -48,6 +49,11 @@ export class NewStorageQuery extends BaseStorageQuery {
         const best = await this.client.chainHead.bestBlock();
         // Track the latest changes for each key
         const latestChanges = {};
+        // Using a queue here to make sure we don't accidentally
+        // put a pressure the json-rpc server in-case new blocks stack up too fast
+        // in case we send a lot of requests at the same time
+        // or the block time is small enough with elastic scaling
+        const pullQueue = new AsyncQueue();
         // Function to pull storage values and call the callback if there are changes
         const pull = async ({ hash }) => {
             // Query storage using ChainHead API
@@ -73,9 +79,12 @@ export class NewStorageQuery extends BaseStorageQuery {
         // Initial pull
         await pull(best);
         // Subscribe to best block events
-        const unsub = this.client.on('bestBlock', pull);
+        const unsub = this.client.on('bestBlock', (block) => {
+            pullQueue.enqueue(() => pull(block)).catch(console.error);
+        });
         return async () => {
             unsub();
+            pullQueue.cancel();
         };
     }
 }