@dedot/api 0.9.0 → 0.9.2

package/cjs/client/BaseSubstrateClient.js

@@ -197,9 +197,12 @@ class BaseSubstrateClient extends index_js_2.JsonRpcClient {
         await this._localCache?.clear();
     }
     async doConnect() {
+        // @ts-ignore
         this.on('connected', this.onConnected);
+        // @ts-ignore
         this.on('disconnected', this.onDisconnected);
         return new Promise((resolve) => {
+            // @ts-ignore
             this.once('ready', () => {
                 resolve(this);
             });
@@ -212,6 +215,7 @@ class BaseSubstrateClient extends index_js_2.JsonRpcClient {
     async initialize() {
         await this.initializeLocalCache();
         await this.doInitialize();
+        // @ts-ignore
         this.emit('ready');
     }
     async doInitialize() {

package/cjs/client/DedotClient.js

@@ -85,6 +85,11 @@ class DedotClient// prettier-end-here
         }
         await this.setupMetadata(metadata);
         this.subscribeRuntimeUpgrades();
+        // relegate events
+        this.chainHead.on('newBlock', (...args) => this.emit('newBlock', ...args));
+        this.chainHead.on('bestBlock', (...args) => this.emit('bestBlock', ...args));
+        this.chainHead.on('finalizedBlock', (...args) => this.emit('finalizedBlock', ...args));
+        this.chainHead.on('bestChainChanged', (...args) => this.emit('bestChainChanged', ...args));
     }
     /**
      * Ref: https://github.com/paritytech/polkadot-sdk/blob/bbd51ce867967f71657b901f1a956ad4f75d352e/substrate/frame/system/src/lib.rs#L909-L913

package/cjs/client/LegacyClient.js

@@ -138,8 +138,13 @@ class LegacyClient// prettier-end-here
         if (!this.#runtimeSubscriptionUnsub) {
             return;
         }
-        await this.#runtimeSubscriptionUnsub();
-        this.#runtimeSubscriptionUnsub = undefined;
+        try {
+            await this.#runtimeSubscriptionUnsub();
+            this.#runtimeSubscriptionUnsub = undefined;
+        }
+        catch {
+            // ignore
+        }
     }
     #subscribeUpdates() {
         this.#subscribeRuntimeUpgrades();

package/cjs/extrinsic/submittable/SubmittableExtrinsicV2.js

@@ -163,8 +163,8 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
             status: { type: 'Broadcasting' },
             txHash,
         }));
-        const stopBestBlockTrackingFn = api.chainHead.on('bestBlock', checkBestBlockIncluded);
-        const stopFinalizedBlockTrackingFn = api.chainHead.on('finalizedBlock', checkFinalizedBlockIncluded);
+        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
+        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         const stopTracking = () => {
             stopBestBlockTrackingFn();
             stopFinalizedBlockTrackingFn();

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

package/cjs/storage/NewStorageQuery.js

@@ -24,7 +24,7 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
      */
     async query(keys, at) {
         // Query storage using ChainHead API
-        const storageQueries = keys.map(key => ({ type: 'value', key }));
+        const storageQueries = keys.map((key) => ({ type: 'value', key }));
         // Use the provided block hash or skip it in tests
         const rawResults = at
             ? await this.client.chainHead.storage(storageQueries, undefined, at)
@@ -32,7 +32,7 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
         // Create a map of key -> value for easy lookup
         const results = {};
         // Initialize all keys with undefined
-        keys.forEach(key => results[key] = undefined);
+        keys.forEach((key) => (results[key] = undefined));
         // Update with actual values from the response
         rawResults.forEach((result) => {
             results[result.key] = result.value ?? undefined;
@@ -54,7 +54,7 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
         // Function to pull storage values and call the callback if there are changes
         const pull = async ({ hash }) => {
             // Query storage using ChainHead API
-            const storageQueries = keys.map(key => ({ type: 'value', key }));
+            const storageQueries = keys.map((key) => ({ type: 'value', key }));
             const rawResults = await this.client.chainHead.storage(storageQueries, undefined, hash);
             let changed = false;
             // Create a map for easy lookup
@@ -76,7 +76,7 @@ class NewStorageQuery extends BaseStorageQuery_js_1.BaseStorageQuery {
         // Initial pull
         await pull(best);
         // Subscribe to best block events
-        const unsub = this.client.chainHead.on('bestBlock', pull);
+        const unsub = this.client.on('bestBlock', pull);
         return async () => {
             unsub();
         };

package/client/BaseSubstrateClient.d.ts

@@ -12,7 +12,7 @@ export declare function ensurePresence<T>(value: T): NonNullable<T>;
  * @name BaseSubstrateClient
  * @description Base & shared abstraction for Substrate API Clients
  */
-export declare abstract class BaseSubstrateClient<Rv extends RpcVersion, ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends JsonRpcClient<ChainApi, ApiEvent> implements ISubstrateClient<ChainApi[Rv]> {
+export declare abstract class BaseSubstrateClient<Rv extends RpcVersion, ChainApi extends VersionedGenericSubstrateApi = SubstrateApi, Events extends string = ApiEvent> extends JsonRpcClient<ChainApi, Events> implements ISubstrateClient<ChainApi[Rv], Events> {
     rpcVersion: RpcVersion;
     protected _options: ApiOptions;
     protected _registry?: PortableRegistry;

package/client/BaseSubstrateClient.js

@@ -193,9 +193,12 @@ export class BaseSubstrateClient extends JsonRpcClient {
         await this._localCache?.clear();
     }
     async doConnect() {
+        // @ts-ignore
         this.on('connected', this.onConnected);
+        // @ts-ignore
         this.on('disconnected', this.onDisconnected);
         return new Promise((resolve) => {
+            // @ts-ignore
             this.once('ready', () => {
                 resolve(this);
             });
@@ -208,6 +211,7 @@ export class BaseSubstrateClient extends JsonRpcClient {
     async initialize() {
         await this.initializeLocalCache();
         await this.doInitialize();
+        // @ts-ignore
         this.emit('ready');
     }
     async doInitialize() {

package/client/DedotClient.d.ts

@@ -4,7 +4,7 @@ import { GenericSubstrateApi, RpcV2, RpcVersion, VersionedGenericSubstrateApi }
 import type { SubstrateApi } from '../chaintypes/index.js';
 import { ChainHead, ChainSpec, PinnedBlock } from '../json-rpc/index.js';
 import { BaseStorageQuery } from '../storage/index.js';
-import type { ApiOptions, ISubstrateClientAt, TxBroadcaster } from '../types.js';
+import type { ApiOptions, DedotClientEvent, ISubstrateClientAt, TxBroadcaster } from '../types.js';
 import { BaseSubstrateClient } from './BaseSubstrateClient.js';
 /**
  * @name DedotClient
@@ -13,7 +13,7 @@ import { BaseSubstrateClient } from './BaseSubstrateClient.js';
  * __Unstable, use with caution.__
  */
 export declare class DedotClient<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>// prettier-end-here
- extends BaseSubstrateClient<RpcV2, ChainApi> {
+ extends BaseSubstrateClient<RpcV2, ChainApi, DedotClientEvent> {
     #private;
     protected _chainHead?: ChainHead;
     protected _chainSpec?: ChainSpec;

package/client/DedotClient.js

@@ -82,6 +82,11 @@ export class DedotClient// prettier-end-here
         }
         await this.setupMetadata(metadata);
         this.subscribeRuntimeUpgrades();
+        // relegate events
+        this.chainHead.on('newBlock', (...args) => this.emit('newBlock', ...args));
+        this.chainHead.on('bestBlock', (...args) => this.emit('bestBlock', ...args));
+        this.chainHead.on('finalizedBlock', (...args) => this.emit('finalizedBlock', ...args));
+        this.chainHead.on('bestChainChanged', (...args) => this.emit('bestChainChanged', ...args));
     }
     /**
      * Ref: https://github.com/paritytech/polkadot-sdk/blob/bbd51ce867967f71657b901f1a956ad4f75d352e/substrate/frame/system/src/lib.rs#L909-L913

package/client/LegacyClient.js

@@ -135,8 +135,13 @@ export class LegacyClient// prettier-end-here
         if (!this.#runtimeSubscriptionUnsub) {
             return;
         }
-        await this.#runtimeSubscriptionUnsub();
-        this.#runtimeSubscriptionUnsub = undefined;
+        try {
+            await this.#runtimeSubscriptionUnsub();
+            this.#runtimeSubscriptionUnsub = undefined;
+        }
+        catch {
+            // ignore
+        }
     }
     #subscribeUpdates() {
         this.#subscribeRuntimeUpgrades();

package/extrinsic/submittable/SubmittableExtrinsicV2.js

@@ -160,8 +160,8 @@ export class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic {
             status: { type: 'Broadcasting' },
             txHash,
         }));
-        const stopBestBlockTrackingFn = api.chainHead.on('bestBlock', checkBestBlockIncluded);
-        const stopFinalizedBlockTrackingFn = api.chainHead.on('finalizedBlock', checkFinalizedBlockIncluded);
+        const stopBestBlockTrackingFn = api.on('bestBlock', checkBestBlockIncluded);
+        const stopFinalizedBlockTrackingFn = api.on('finalizedBlock', checkFinalizedBlockIncluded);
         const stopTracking = () => {
             stopBestBlockTrackingFn();
             stopFinalizedBlockTrackingFn();

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

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dedot/api",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "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.0",
-    "@dedot/providers": "0.9.0",
-    "@dedot/runtime-specs": "0.9.0",
-    "@dedot/shape": "0.9.0",
-    "@dedot/storage": "0.9.0",
-    "@dedot/types": "0.9.0",
-    "@dedot/utils": "0.9.0"
+    "@dedot/codecs": "0.9.2",
+    "@dedot/providers": "0.9.2",
+    "@dedot/runtime-specs": "0.9.2",
+    "@dedot/shape": "0.9.2",
+    "@dedot/storage": "0.9.2",
+    "@dedot/types": "0.9.2",
+    "@dedot/utils": "0.9.2"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
@@ -48,7 +48,7 @@
     "node": ">=18"
   },
   "license": "Apache-2.0",
-  "gitHead": "cebae55a3525e2c9bcdd70322027855a594a287d",
+  "gitHead": "b28ae48371785d44bf734cf45a5b8d0716d9bd70",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/storage/NewStorageQuery.js

@@ -21,7 +21,7 @@ export class NewStorageQuery extends BaseStorageQuery {
      */
     async query(keys, at) {
         // Query storage using ChainHead API
-        const storageQueries = keys.map(key => ({ type: 'value', key }));
+        const storageQueries = keys.map((key) => ({ type: 'value', key }));
         // Use the provided block hash or skip it in tests
         const rawResults = at
             ? await this.client.chainHead.storage(storageQueries, undefined, at)
@@ -29,7 +29,7 @@ export class NewStorageQuery extends BaseStorageQuery {
         // Create a map of key -> value for easy lookup
         const results = {};
         // Initialize all keys with undefined
-        keys.forEach(key => results[key] = undefined);
+        keys.forEach((key) => (results[key] = undefined));
         // Update with actual values from the response
         rawResults.forEach((result) => {
             results[result.key] = result.value ?? undefined;
@@ -51,7 +51,7 @@ export class NewStorageQuery extends BaseStorageQuery {
         // Function to pull storage values and call the callback if there are changes
         const pull = async ({ hash }) => {
             // Query storage using ChainHead API
-            const storageQueries = keys.map(key => ({ type: 'value', key }));
+            const storageQueries = keys.map((key) => ({ type: 'value', key }));
             const rawResults = await this.client.chainHead.storage(storageQueries, undefined, hash);
             let changed = false;
             // Create a map for easy lookup
@@ -73,7 +73,7 @@ export class NewStorageQuery extends BaseStorageQuery {
         // Initial pull
         await pull(best);
         // Subscribe to best block events
-        const unsub = this.client.chainHead.on('bestBlock', pull);
+        const unsub = this.client.on('bestBlock', pull);
         return async () => {
             unsub();
         };

package/types.d.ts

@@ -1,3 +1,4 @@
+import { ChainHeadEvent } from '@dedot/api/json-rpc';
 import { BlockHash, Hash, Metadata, PortableRegistry } from '@dedot/codecs';
 import type { ConnectionStatus, JsonRpcProvider, ProviderEvent } from '@dedot/providers';
 import type { AnyShape } from '@dedot/shape';
@@ -61,6 +62,7 @@ export interface ApiOptions extends JsonRpcClientOptions {
     signer?: InjectedSigner;
 }
 export type ApiEvent = ProviderEvent | 'ready' | 'runtimeUpgraded';
+export type DedotClientEvent = ApiEvent | ChainHeadEvent;
 export interface SubstrateRuntimeVersion {
     specName: string;
     implName: string;