@dedot/api 0.8.1 → 0.9.0

package/storage/NewStorageQuery.js

@@ -0,0 +1,81 @@
+import { BaseStorageQuery } from './BaseStorageQuery.js';
+/**
+ * @name NewStorageQuery
+ * @description
+ * Implementation of BaseStorageQuery for the new JSON-RPC API (v2).
+ * This service handles storage queries using the chainHead_storage RPC method
+ * and chainHead events for subscriptions.
+ *
+ * It provides:
+ * - One-time queries using chainHead_storage
+ * - Subscriptions using chainHead 'bestBlock' events
+ * - Efficient change detection for subscriptions
+ */
+export class NewStorageQuery extends BaseStorageQuery {
+    /**
+     * Query multiple storage items in a single call using chainHead_storage
+     *
+     * @param keys - Array of storage keys to query
+     * @param at - Optional block hash to query at (defaults to best block)
+     * @returns Promise resolving to a record mapping storage keys to their values
+     */
+    async query(keys, at) {
+        // Query storage using ChainHead API
+        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)
+            : await this.client.chainHead.storage(storageQueries);
+        // Create a map of key -> value for easy lookup
+        const results = {};
+        // Initialize all keys with undefined
+        keys.forEach(key => results[key] = undefined);
+        // Update with actual values from the response
+        rawResults.forEach((result) => {
+            results[result.key] = result.value ?? undefined;
+        });
+        return results;
+    }
+    /**
+     * Subscribe to multiple storage items using chainHead 'bestBlock' events
+     *
+     * @param keys - Array of storage keys to subscribe to
+     * @param callback - Function to call when storage values change
+     * @returns Promise resolving to an unsubscribe function
+     */
+    async subscribe(keys, callback) {
+        // Get the best block
+        const best = await this.client.chainHead.bestBlock();
+        // Track the latest changes for each key
+        const latestChanges = {};
+        // 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 rawResults = await this.client.chainHead.storage(storageQueries, undefined, hash);
+            let changed = false;
+            // Create a map for easy lookup
+            const results = {};
+            rawResults.forEach((result) => {
+                results[result.key] = result.value ?? undefined;
+            });
+            keys.forEach((key) => {
+                const newValue = results[key];
+                if (Object.keys(latestChanges).length > 0 && latestChanges[key] === newValue)
+                    return;
+                changed = true;
+                latestChanges[key] = newValue;
+            });
+            if (!changed)
+                return;
+            callback({ ...latestChanges });
+        };
+        // Initial pull
+        await pull(best);
+        // Subscribe to best block events
+        const unsub = this.client.chainHead.on('bestBlock', pull);
+        return async () => {
+            unsub();
+        };
+    }
+}

package/storage/index.d.ts

@@ -1 +1,4 @@
 export * from './QueryableStorage.js';
+export * from './BaseStorageQuery.js';
+export * from './LegacyStorageQuery.js';
+export * from './NewStorageQuery.js';

package/storage/index.js

@@ -1 +1,4 @@
 export * from './QueryableStorage.js';
+export * from './BaseStorageQuery.js';
+export * from './LegacyStorageQuery.js';
+export * from './NewStorageQuery.js';

package/types.d.ts

@@ -2,7 +2,7 @@ import { BlockHash, Hash, Metadata, PortableRegistry } from '@dedot/codecs';
 import type { ConnectionStatus, JsonRpcProvider, ProviderEvent } from '@dedot/providers';
 import type { AnyShape } from '@dedot/shape';
 import type { IStorage } from '@dedot/storage';
-import type { GenericSubstrateApi, InjectedSigner, RpcVersion, RuntimeApiName, RuntimeApiSpec, Unsub } from '@dedot/types';
+import type { Callback, GenericStorageQuery, GenericSubstrateApi, InjectedSigner, Query, QueryFnResult, RpcVersion, RuntimeApiName, RuntimeApiSpec, Unsub } from '@dedot/types';
 import type { HashFn, HexString, IEventEmitter } from '@dedot/utils';
 import type { AnySignedExtension } from './extrinsic/index.js';
 export type MetadataKey = `RAW_META/${string}`;
@@ -119,6 +119,22 @@ export interface ISubstrateClient<ChainApi extends GenericSubstrateApi = Generic
      * @param signer
      */
     setSigner(signer?: InjectedSigner): void;
+    /**
+     * Perform multiple storage queries in parallel
+     * @param queries - An array of query objects
+     * @param callback - Optional callback function to handle results
+     * @returns A promise resolving to an array of results or an Unsub function
+     */
+    queryMulti<Fns extends GenericStorageQuery[]>(queries: {
+        [K in keyof Fns]: Query<Fns[K]>;
+    }): Promise<{
+        [K in keyof Fns]: QueryFnResult<Fns[K]>;
+    }>;
+    queryMulti<Fns extends GenericStorageQuery[]>(queries: {
+        [K in keyof Fns]: Query<Fns[K]>;
+    }, callback: Callback<{
+        [K in keyof Fns]: QueryFnResult<Fns[K]>;
+    }>): Promise<Unsub>;
 }
 /**
  * A generic interface for broadcasting transactions

package/cjs/extrinsic/extensions/known/CheckNonZeroSender.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckNonZeroSender = void 0;
-const SignedExtension_js_1 = require("../SignedExtension.js");
-/**
- * @description Check to ensure that the sender is not the zero address
- */
-class CheckNonZeroSender extends SignedExtension_js_1.SignedExtension {
-}
-exports.CheckNonZeroSender = CheckNonZeroSender;

package/cjs/extrinsic/extensions/known/CheckWeight.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckWeight = void 0;
-const SignedExtension_js_1 = require("../SignedExtension.js");
-/**
- * @description Block resource (weight) limit check.
- */
-class CheckWeight extends SignedExtension_js_1.SignedExtension {
-}
-exports.CheckWeight = CheckWeight;

package/cjs/extrinsic/extensions/known/PrevalidateAttests.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrevalidateAttests = void 0;
-const SignedExtension_js_1 = require("../SignedExtension.js");
-/**
- * @description Validate `attest` calls prior to execution.
- * Needed to avoid a DoS attack since they are otherwise free to place on chain.
- */
-class PrevalidateAttests extends SignedExtension_js_1.SignedExtension {
-}
-exports.PrevalidateAttests = PrevalidateAttests;

package/cjs/extrinsic/extensions/known/StorageWeightReclaim.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageWeightReclaim = void 0;
-const SignedExtension_js_1 = require("../SignedExtension.js");
-/**
- * @description Storage weight reclaim mechanism.
- */
-class StorageWeightReclaim extends SignedExtension_js_1.SignedExtension {
-}
-exports.StorageWeightReclaim = StorageWeightReclaim;

package/extrinsic/extensions/known/CheckNonZeroSender.d.ts

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Check to ensure that the sender is not the zero address
- */
-export declare class CheckNonZeroSender extends SignedExtension {
-}

package/extrinsic/extensions/known/CheckNonZeroSender.js

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Check to ensure that the sender is not the zero address
- */
-export class CheckNonZeroSender extends SignedExtension {
-}

package/extrinsic/extensions/known/CheckWeight.d.ts

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Block resource (weight) limit check.
- */
-export declare class CheckWeight extends SignedExtension {
-}

package/extrinsic/extensions/known/CheckWeight.js

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Block resource (weight) limit check.
- */
-export class CheckWeight extends SignedExtension {
-}

package/extrinsic/extensions/known/PrevalidateAttests.d.ts

@@ -1,7 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Validate `attest` calls prior to execution.
- * Needed to avoid a DoS attack since they are otherwise free to place on chain.
- */
-export declare class PrevalidateAttests extends SignedExtension {
-}

package/extrinsic/extensions/known/PrevalidateAttests.js

@@ -1,7 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Validate `attest` calls prior to execution.
- * Needed to avoid a DoS attack since they are otherwise free to place on chain.
- */
-export class PrevalidateAttests extends SignedExtension {
-}

package/extrinsic/extensions/known/StorageWeightReclaim.d.ts

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Storage weight reclaim mechanism.
- */
-export declare class StorageWeightReclaim extends SignedExtension {
-}

package/extrinsic/extensions/known/StorageWeightReclaim.js

@@ -1,6 +0,0 @@
-import { SignedExtension } from '../SignedExtension.js';
-/**
- * @description Storage weight reclaim mechanism.
- */
-export class StorageWeightReclaim extends SignedExtension {
-}