@dedot/api 0.0.1-alpha.32 → 0.0.1-alpha.34

package/chaintypes/substrate/consts.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/errors.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/events.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/index.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export * from './types.js';

package/chaintypes/substrate/json-rpc.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/query.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/runtime.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/tx.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/chaintypes/substrate/types.js

@@ -1,2 +1 @@
-// Generated by @dedot/codegen
 export {};

package/cjs/chaintypes/substrate/consts.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/errors.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/events.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/index.js

@@ -1,5 +1,4 @@
 "use strict";
-// Generated by @dedot/codegen
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/cjs/chaintypes/substrate/json-rpc.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/query.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/runtime.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/tx.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/chaintypes/substrate/types.js

@@ -1,3 +1,2 @@
 "use strict";
-// Generated by @dedot/codegen
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/client/{Dedot.js → LegacyClient.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Dedot = void 0;
+exports.LegacyClient = void 0;
 const codecs_1 = require("@dedot/codecs");
 const index_js_1 = require("../executor/index.js");
 const proxychain_js_1 = require("../proxychain.js");
 const BaseSubstrateClient_js_1 = require("./BaseSubstrateClient.js");
 const KEEP_ALIVE_INTERVAL = 10_000; // in ms
 /**
- * @name Dedot
+ * @name LegacyClient
  * @description Promised-based API Client for Polkadot & Substrate
  *
  * Initialize API instance and interact with substrate-based network
@@ -44,7 +44,7 @@ const KEEP_ALIVE_INTERVAL = 10_000; // in ms
  * run().catch(console.error);
  * ```
  */
-class Dedot extends BaseSubstrateClient_js_1.BaseSubstrateClient {
+class LegacyClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
     #runtimeSubscriptionUnsub;
     #healthTimer;
     #apiAtCache = {};
@@ -62,7 +62,7 @@ class Dedot extends BaseSubstrateClient_js_1.BaseSubstrateClient {
      * @param options
      */
     static async create(options) {
-        return new Dedot(options).connect();
+        return new LegacyClient(options).connect();
     }
     /**
      * Alias for __Dedot.create__
@@ -70,7 +70,7 @@ class Dedot extends BaseSubstrateClient_js_1.BaseSubstrateClient {
      * @param options
      */
     static async new(options) {
-        return Dedot.create(options);
+        return LegacyClient.create(options);
     }
     onDisconnected = async () => {
         await this.#unsubscribeUpdates();
@@ -247,4 +247,4 @@ class Dedot extends BaseSubstrateClient_js_1.BaseSubstrateClient {
         return api;
     }
 }
-exports.Dedot = Dedot;
+exports.LegacyClient = LegacyClient;

package/cjs/client/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Dedot.js"), exports);
+__exportStar(require("./LegacyClient.js"), exports);
 __exportStar(require("./DedotClient.js"), exports);

package/cjs/executor/v2/StorageQueryExecutorV2.js

@@ -35,13 +35,13 @@ class StorageQueryExecutorV2 extends StorageQueryExecutor_js_1.StorageQueryExecu
         }, {});
     }
     async subscribeStorage(keys, callback) {
-        let initialHash = await this.chainHead.bestHash();
+        let best = await this.chainHead.bestBlock();
         let eventToListen = 'bestBlock';
         // TODO subscribe to finalized data source
         // initialHash = this.chainHead.finalizedHash;
         // eventToListen = 'finalizedBlock';
         const latestChanges = {};
-        const pull = async (hash) => {
+        const pull = async ({ hash }) => {
             const results = await this.queryStorage(keys, hash);
             let changed = false;
             keys.forEach((key) => {
@@ -55,7 +55,7 @@ class StorageQueryExecutorV2 extends StorageQueryExecutor_js_1.StorageQueryExecu
                 return;
             callback(keys.map((key) => latestChanges[key]));
         };
-        await pull(initialHash);
+        await pull(best);
         const unsub = this.chainHead.on(eventToListen, pull);
         return async () => {
             unsub();

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

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckMetadataHash = void 0;
+const utils_1 = require("@dedot/utils");
+const SignedExtension_js_1 = require("../SignedExtension.js");
+/**
+ * @description Genesis hash check to provide replay protection between different networks.
+ */
+class CheckMetadataHash extends SignedExtension_js_1.SignedExtension {
+    async init() {
+        let metadataHash = this.payloadOptions.metadataHash;
+        if (metadataHash) {
+            (0, utils_1.assert)((0, utils_1.isHex)(metadataHash), 'Metadata hash is not a valid hex string');
+            this.data = { mode: 'Enabled' };
+            this.additionalSigned = metadataHash;
+        }
+        else {
+            this.data = { mode: 'Disabled' };
+            this.additionalSigned = undefined;
+        }
+    }
+    toPayload() {
+        // Ref: https://github.com/paritytech/polkadot-sdk/blob/8dbe4ee80734bba6644c7e5f879a363ce7c0a19f/substrate/frame/metadata-hash-extension/src/lib.rs#L55-L58
+        let enabled = this.data.mode === 'Enabled';
+        return {
+            mode: enabled ? 1 : 0, // 0 -> disabled, 1 -> enabled
+            metadataHash: this.additionalSigned,
+        };
+    }
+}
+exports.CheckMetadataHash = CheckMetadataHash;

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

@@ -4,6 +4,7 @@ exports.knownSignedExtensions = void 0;
 const ChargeAssetTxPayment_js_1 = require("./ChargeAssetTxPayment.js");
 const ChargeTransactionPayment_js_1 = require("./ChargeTransactionPayment.js");
 const CheckGenesis_js_1 = require("./CheckGenesis.js");
+const CheckMetadataHash_js_1 = require("./CheckMetadataHash.js");
 const CheckMortality_js_1 = require("./CheckMortality.js");
 const CheckNonZeroSender_js_1 = require("./CheckNonZeroSender.js");
 const CheckNonce_js_1 = require("./CheckNonce.js");
@@ -22,4 +23,5 @@ exports.knownSignedExtensions = {
     ChargeTransactionPayment: ChargeTransactionPayment_js_1.ChargeTransactionPayment,
     PrevalidateAttests: PrevalidateAttests_js_1.PrevalidateAttests,
     ChargeAssetTxPayment: ChargeAssetTxPayment_js_1.ChargeAssetTxPayment,
+    CheckMetadataHash: CheckMetadataHash_js_1.CheckMetadataHash,
 };

package/client/{Dedot.d.ts → LegacyClient.d.ts}

@@ -5,7 +5,7 @@ import type { SubstrateApi } from '../chaintypes/index.js';
 import type { ApiOptions, ISubstrateClientAt } from '../types.js';
 import { BaseSubstrateClient } from './BaseSubstrateClient.js';
 /**
- * @name Dedot
+ * @name LegacyClient
  * @description Promised-based API Client for Polkadot & Substrate
  *
  * Initialize API instance and interact with substrate-based network
@@ -42,7 +42,7 @@ import { BaseSubstrateClient } from './BaseSubstrateClient.js';
  * run().catch(console.error);
  * ```
  */
-export declare class Dedot<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends BaseSubstrateClient<ChainApi> {
+export declare class LegacyClient<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends BaseSubstrateClient<ChainApi> {
     #private;
     /**
      * Use factory methods (`create`, `new`) to create `Dedot` instances.
@@ -55,13 +55,13 @@ export declare class Dedot<ChainApi extends VersionedGenericSubstrateApi = Subst
      *
      * @param options
      */
-    static create<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: ApiOptions | JsonRpcProvider): Promise<Dedot<ChainApi>>;
+    static create<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: ApiOptions | JsonRpcProvider): Promise<LegacyClient<ChainApi>>;
     /**
      * Alias for __Dedot.create__
      *
      * @param options
      */
-    static new<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: ApiOptions | JsonRpcProvider): Promise<Dedot<ChainApi>>;
+    static new<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: ApiOptions | JsonRpcProvider): Promise<LegacyClient<ChainApi>>;
     protected onDisconnected: () => Promise<void>;
     protected beforeDisconnect(): Promise<void>;
     /**

package/client/{Dedot.js → LegacyClient.js}

@@ -4,7 +4,7 @@ import { newProxyChain } from '../proxychain.js';
 import { BaseSubstrateClient } from './BaseSubstrateClient.js';
 const KEEP_ALIVE_INTERVAL = 10_000; // in ms
 /**
- * @name Dedot
+ * @name LegacyClient
  * @description Promised-based API Client for Polkadot & Substrate
  *
  * Initialize API instance and interact with substrate-based network
@@ -41,7 +41,7 @@ const KEEP_ALIVE_INTERVAL = 10_000; // in ms
  * run().catch(console.error);
  * ```
  */
-export class Dedot extends BaseSubstrateClient {
+export class LegacyClient extends BaseSubstrateClient {
     #runtimeSubscriptionUnsub;
     #healthTimer;
     #apiAtCache = {};
@@ -59,7 +59,7 @@ export class Dedot extends BaseSubstrateClient {
      * @param options
      */
     static async create(options) {
-        return new Dedot(options).connect();
+        return new LegacyClient(options).connect();
     }
     /**
      * Alias for __Dedot.create__
@@ -67,7 +67,7 @@ export class Dedot extends BaseSubstrateClient {
      * @param options
      */
     static async new(options) {
-        return Dedot.create(options);
+        return LegacyClient.create(options);
     }
     onDisconnected = async () => {
         await this.#unsubscribeUpdates();

package/client/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Dedot.js';
+export * from './LegacyClient.js';
 export * from './DedotClient.js';

package/client/index.js

@@ -1,2 +1,2 @@
-export * from './Dedot.js';
+export * from './LegacyClient.js';
 export * from './DedotClient.js';

package/executor/v2/StorageQueryExecutorV2.js

@@ -32,13 +32,13 @@ export class StorageQueryExecutorV2 extends StorageQueryExecutor {
         }, {});
     }
     async subscribeStorage(keys, callback) {
-        let initialHash = await this.chainHead.bestHash();
+        let best = await this.chainHead.bestBlock();
         let eventToListen = 'bestBlock';
         // TODO subscribe to finalized data source
         // initialHash = this.chainHead.finalizedHash;
         // eventToListen = 'finalizedBlock';
         const latestChanges = {};
-        const pull = async (hash) => {
+        const pull = async ({ hash }) => {
             const results = await this.queryStorage(keys, hash);
             let changed = false;
             keys.forEach((key) => {
@@ -52,7 +52,7 @@ export class StorageQueryExecutorV2 extends StorageQueryExecutor {
                 return;
             callback(keys.map((key) => latestChanges[key]));
         };
-        await pull(initialHash);
+        await pull(best);
         const unsub = this.chainHead.on(eventToListen, pull);
         return async () => {
             unsub();

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

@@ -0,0 +1,13 @@
+import { SignerPayloadJSON } from '@polkadot/types/types';
+import { Hash } from '@dedot/codecs';
+import { SignedExtension } from '../SignedExtension.js';
+export type CheckMetadataHashMode = 'Disabled' | 'Enabled';
+/**
+ * @description Genesis hash check to provide replay protection between different networks.
+ */
+export declare class CheckMetadataHash extends SignedExtension<{
+    mode: CheckMetadataHashMode;
+}, Hash | undefined> {
+    init(): Promise<void>;
+    toPayload(): Partial<SignerPayloadJSON>;
+}

package/extrinsic/extensions/known/CheckMetadataHash.js

@@ -0,0 +1,27 @@
+import { assert, isHex } from '@dedot/utils';
+import { SignedExtension } from '../SignedExtension.js';
+/**
+ * @description Genesis hash check to provide replay protection between different networks.
+ */
+export class CheckMetadataHash extends SignedExtension {
+    async init() {
+        let metadataHash = this.payloadOptions.metadataHash;
+        if (metadataHash) {
+            assert(isHex(metadataHash), 'Metadata hash is not a valid hex string');
+            this.data = { mode: 'Enabled' };
+            this.additionalSigned = metadataHash;
+        }
+        else {
+            this.data = { mode: 'Disabled' };
+            this.additionalSigned = undefined;
+        }
+    }
+    toPayload() {
+        // Ref: https://github.com/paritytech/polkadot-sdk/blob/8dbe4ee80734bba6644c7e5f879a363ce7c0a19f/substrate/frame/metadata-hash-extension/src/lib.rs#L55-L58
+        let enabled = this.data.mode === 'Enabled';
+        return {
+            mode: enabled ? 1 : 0, // 0 -> disabled, 1 -> enabled
+            metadataHash: this.additionalSigned,
+        };
+    }
+}

package/extrinsic/extensions/known/index.js

@@ -1,6 +1,7 @@
 import { ChargeAssetTxPayment } from './ChargeAssetTxPayment.js';
 import { ChargeTransactionPayment } from './ChargeTransactionPayment.js';
 import { CheckGenesis } from './CheckGenesis.js';
+import { CheckMetadataHash } from './CheckMetadataHash.js';
 import { CheckMortality } from './CheckMortality.js';
 import { CheckNonZeroSender } from './CheckNonZeroSender.js';
 import { CheckNonce } from './CheckNonce.js';
@@ -19,4 +20,5 @@ export const knownSignedExtensions = {
     ChargeTransactionPayment,
     PrevalidateAttests,
     ChargeAssetTxPayment,
+    CheckMetadataHash,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/api",
-  "version": "0.0.1-alpha.32",
+  "version": "0.0.1-alpha.34",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot",
@@ -13,13 +13,13 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@dedot/codecs": "0.0.1-alpha.32",
-    "@dedot/providers": "0.0.1-alpha.32",
-    "@dedot/runtime-specs": "0.0.1-alpha.32",
-    "@dedot/shape": "0.0.1-alpha.32",
-    "@dedot/storage": "0.0.1-alpha.32",
-    "@dedot/types": "0.0.1-alpha.32",
-    "@dedot/utils": "0.0.1-alpha.32"
+    "@dedot/codecs": "0.0.1-alpha.34",
+    "@dedot/providers": "0.0.1-alpha.34",
+    "@dedot/runtime-specs": "0.0.1-alpha.34",
+    "@dedot/shape": "0.0.1-alpha.34",
+    "@dedot/storage": "0.0.1-alpha.34",
+    "@dedot/types": "0.0.1-alpha.34",
+    "@dedot/utils": "0.0.1-alpha.34"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
@@ -46,9 +46,9 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@polkadot/types": "^11.0.2"
+    "@polkadot/types": "^11.2.1"
   },
-  "gitHead": "43501104eee360a19ae18a70fe506e16d9357835",
+  "gitHead": "053078f3aed79a3044314421967325b9fe0e6f57",
   "module": "./index.js",
   "types": "./index.d.ts"
 }