@dedot/api 0.0.1-next.cfee875e.21 → 0.1.0

package/cjs/client/BaseSubstrateClient.js

@@ -26,6 +26,7 @@ class BaseSubstrateClient extends index_js_2.JsonRpcClient {
     _genesisHash;
     _runtimeVersion;
     _localCache;
+    _runtimeUpgrading;
     constructor(rpcVersion, options) {
         super(options);
         this.rpcVersion = rpcVersion;
@@ -197,6 +198,22 @@ class BaseSubstrateClient extends index_js_2.JsonRpcClient {
             }, {}),
         };
     }
+    startRuntimeUpgrade() {
+        this._runtimeUpgrading = (0, utils_1.deferred)();
+    }
+    doneRuntimeUpgrade() {
+        if (!this._runtimeUpgrading)
+            return;
+        this._runtimeUpgrading.resolve();
+        setTimeout(() => {
+            this._runtimeUpgrading = undefined;
+        });
+    }
+    async ensureRuntimeUpgraded() {
+        if (!this._runtimeUpgrading)
+            return;
+        await this._runtimeUpgrading.promise;
+    }
     /// --- Public APIs ---
     /**
      * @description Connect to blockchain node
@@ -228,6 +245,10 @@ class BaseSubstrateClient extends index_js_2.JsonRpcClient {
     get runtimeVersion() {
         return ensurePresence(this._runtimeVersion);
     }
+    async getRuntimeVersion() {
+        await this.ensureRuntimeUpgraded();
+        return this.runtimeVersion;
+    }
     get consts() {
         return (0, proxychain_js_1.newProxyChain)({ executor: new index_js_1.ConstantExecutor(this) });
     }

package/cjs/client/DedotClient.js

@@ -14,7 +14,8 @@ const BaseSubstrateClient_js_1 = require("./BaseSubstrateClient.js");
  *
  * __Unstable, use with caution.__
  */
-class DedotClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
+class DedotClient// prettier-end-here
+ extends BaseSubstrateClient_js_1.BaseSubstrateClient {
     _chainHead;
     _chainSpec;
     _txBroadcaster;
@@ -102,16 +103,16 @@ class DedotClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
     subscribeRuntimeUpgrades() {
         this.chainHead.on('bestBlock', this.onRuntimeUpgrade);
     }
-    unsubscribeRuntimeUpgrades() {
-        this.chainHead.off('bestBlock', this.onRuntimeUpgrade);
-    }
     onRuntimeUpgrade = async (block) => {
         const runtimeUpgraded = block.runtime && block.runtime.specVersion !== this._runtimeVersion?.specVersion;
         if (!runtimeUpgraded)
             return;
+        this.startRuntimeUpgrade();
         this._runtimeVersion = block.runtime;
         const newMetadata = await this.fetchMetadata(undefined, this._runtimeVersion);
         await this.setupMetadata(newMetadata);
+        this.emit('runtimeUpgraded', this._runtimeVersion);
+        this.doneRuntimeUpgrade();
     };
     async beforeDisconnect() {
         await this.chainHead.unfollow();

package/cjs/client/LegacyClient.js

@@ -44,7 +44,8 @@ const KEEP_ALIVE_INTERVAL = 10_000; // in ms
  * run().catch(console.error);
  * ```
  */
-class LegacyClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
+class LegacyClient// prettier-end-here
+ extends BaseSubstrateClient_js_1.BaseSubstrateClient {
     #runtimeSubscriptionUnsub;
     #healthTimer;
     #apiAtCache = {};
@@ -104,9 +105,12 @@ class LegacyClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
         this.rpc
             .state_subscribeRuntimeVersion(async (runtimeVersion) => {
             if (runtimeVersion.specVersion !== this.runtimeVersion?.specVersion) {
+                this.startRuntimeUpgrade();
                 this._runtimeVersion = this.toSubstrateRuntimeVersion(runtimeVersion);
                 const newMetadata = await this.fetchMetadata(undefined, this._runtimeVersion);
                 await this.setupMetadata(newMetadata);
+                this.emit('runtimeUpgraded', this._runtimeVersion);
+                this.doneRuntimeUpgrade();
             }
         })
             .then((unsub) => {
@@ -205,7 +209,7 @@ class LegacyClient extends BaseSubstrateClient_js_1.BaseSubstrateClient {
      * // Make a transfer balance transaction
      * api.tx.balances.transferKeepAlive(<address>, <amount>)
      *    .signAndSend(<keyPair|address>, { signer }, ({ status }) => {
-     *      console.log('Transaction status', status.tag);
+     *      console.log('Transaction status', status.type);
      *    });
      * ```
      */

package/cjs/executor/ErrorExecutor.js

@@ -20,7 +20,7 @@ class ErrorExecutor extends Executor_js_1.Executor {
                 palletIndex: targetPallet.index,
             },
             is: (errorInfo) => {
-                if ((0, utils_1.isObject)(errorInfo) && errorInfo.tag === 'Module') {
+                if ((0, utils_1.isObject)(errorInfo) && errorInfo.type === 'Module') {
                     errorInfo = errorInfo.value;
                 }
                 if ((0, utils_1.isObject)(errorInfo) && (0, utils_1.isNumber)(errorInfo.index) && (0, utils_1.isHex)(errorInfo.error)) {
@@ -33,8 +33,8 @@ class ErrorExecutor extends Executor_js_1.Executor {
     #getErrorDef(errorTypeId, errorName) {
         const def = this.metadata.types[errorTypeId];
         (0, utils_1.assert)(def, new utils_1.UnknownApiError(`Error def not found for id ${errorTypeId}`));
-        const { tag, value } = def.type;
-        (0, utils_1.assert)(tag === 'Enum', new utils_1.UnknownApiError(`Error type should be an enum, found: ${tag}`));
+        const { type, value } = def.typeDef;
+        (0, utils_1.assert)(type === 'Enum', new utils_1.UnknownApiError(`Error type should be an enum, found: ${type}`));
         const errorDef = value.members.find(({ name }) => (0, utils_1.stringPascalCase)(name) === errorName);
         (0, utils_1.assert)(errorDef, new utils_1.UnknownApiError(`Error def not found for ${errorName}`));
         return {

package/cjs/executor/EventExecutor.js

@@ -39,8 +39,8 @@ class EventExecutor extends Executor_js_1.Executor {
     #getEventDef(eventTypeId, errorName) {
         const def = this.metadata.types[eventTypeId];
         (0, utils_1.assert)(def, new utils_1.UnknownApiError(`Event def not found for id ${eventTypeId}`));
-        const { tag, value } = def.type;
-        (0, utils_1.assert)(tag === 'Enum', new utils_1.UnknownApiError(`Event type should be an enum, found: ${tag}`));
+        const { type, value } = def.typeDef;
+        (0, utils_1.assert)(type === 'Enum', new utils_1.UnknownApiError(`Event type should be an enum, found: ${type}`));
         const eventDef = value.members.find(({ name }) => (0, utils_1.stringPascalCase)(name) === errorName);
         (0, utils_1.assert)(eventDef, new utils_1.UnknownApiError(`Event def not found for ${errorName}`));
         return {

package/cjs/executor/StorageQueryExecutor.js

@@ -52,7 +52,7 @@ class StorageQueryExecutor extends Executor_js_1.Executor {
             palletIndex: entry.pallet.index,
             ...entry.storageEntry,
         };
-        const isMap = entry.storageEntry.type.tag === 'Map';
+        const isMap = entry.storageEntry.storageType.type === 'Map';
         if (isMap) {
             const queryMultiFn = async (...args) => {
                 const [inArgs, callback] = extractArgs(args);

package/cjs/executor/TxExecutor.js

@@ -13,9 +13,9 @@ class TxExecutor extends Executor_js_1.Executor {
         const targetPallet = this.getPallet(pallet);
         (0, utils_1.assert)(targetPallet.calls, new utils_1.UnknownApiError(`Tx calls are not available for pallet ${targetPallet.name}`));
         const txType = this.metadata.types[targetPallet.calls];
-        (0, utils_1.assert)(txType.type.tag === 'Enum', new utils_1.UnknownApiError('Tx type defs should be enum'));
-        const isFlatEnum = txType.type.value.members.every((m) => m.fields.length === 0);
-        const txCallDef = txType.type.value.members.find((m) => (0, utils_1.stringCamelCase)(m.name) === functionName);
+        (0, utils_1.assert)(txType.typeDef.type === 'Enum', new utils_1.UnknownApiError('Tx type defs should be enum'));
+        const isFlatEnum = txType.typeDef.value.members.every((m) => m.fields.length === 0);
+        const txCallDef = txType.typeDef.value.members.find((m) => (0, utils_1.stringCamelCase)(m.name) === functionName);
         (0, utils_1.assert)(txCallDef, new utils_1.UnknownApiError(`Tx call spec not found for ${pallet}.${functionName}`));
         const txCallFn = (...args) => {
             let call;

package/cjs/executor/v2/StorageQueryExecutorV2.js

@@ -40,20 +40,20 @@ class StorageQueryExecutorV2 extends StorageQueryExecutor_js_1.StorageQueryExecu
         // TODO subscribe to finalized data source
         // initialHash = this.chainHead.finalizedHash;
         // eventToListen = 'finalizedBlock';
-        const latestChanges = {};
+        const latestChanges = new Map();
         const pull = async ({ hash }) => {
             const results = await this.queryStorage(keys, hash);
             let changed = false;
             keys.forEach((key) => {
                 const newValue = results[key];
-                if (latestChanges[key] === newValue)
+                if (latestChanges.size > 0 && latestChanges.get(key) === newValue)
                     return;
                 changed = true;
-                latestChanges[key] = newValue;
+                latestChanges.set(key, newValue);
             });
             if (!changed)
                 return;
-            callback(keys.map((key) => latestChanges[key]));
+            callback(keys.map((key) => latestChanges.get(key)));
         };
         await pull(best);
         const unsub = this.chainHead.on(eventToListen, pull);

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

@@ -30,8 +30,8 @@ class ChargeAssetTxPayment extends SignedExtension_js_1.SignedExtension {
     }
     $AssetId() {
         const extensionTypeDef = this.registry.findType(this.signedExtensionDef.typeId);
-        (0, utils_1.assert)(extensionTypeDef.type.tag === 'Struct');
-        const assetIdTypeDef = extensionTypeDef.type.value.fields.find((f) => f.name === 'asset_id');
+        (0, utils_1.assert)(extensionTypeDef.typeDef.type === 'Struct');
+        const assetIdTypeDef = extensionTypeDef.typeDef.value.fields.find((f) => f.name === 'asset_id');
         const $codec = this.registry.findCodec(assetIdTypeDef.typeId);
         const codecMetadata = $codec.metadata[0];
         if (codecMetadata.name === '$.option') {

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

@@ -0,0 +1,10 @@
+"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/cjs/extrinsic/extensions/known/index.js

@@ -12,6 +12,7 @@ const CheckSpecVersion_js_1 = require("./CheckSpecVersion.js");
 const CheckTxVersion_js_1 = require("./CheckTxVersion.js");
 const CheckWeight_js_1 = require("./CheckWeight.js");
 const PrevalidateAttests_js_1 = require("./PrevalidateAttests.js");
+const StorageWeightReclaim_js_1 = require("./StorageWeightReclaim.js");
 exports.knownSignedExtensions = {
     CheckNonZeroSender: CheckNonZeroSender_js_1.CheckNonZeroSender,
     CheckSpecVersion: CheckSpecVersion_js_1.CheckSpecVersion,
@@ -24,4 +25,5 @@ exports.knownSignedExtensions = {
     PrevalidateAttests: PrevalidateAttests_js_1.PrevalidateAttests,
     ChargeAssetTxPayment: ChargeAssetTxPayment_js_1.ChargeAssetTxPayment,
     CheckMetadataHash: CheckMetadataHash_js_1.CheckMetadataHash,
+    StorageWeightReclaim: StorageWeightReclaim_js_1.StorageWeightReclaim,
 };

package/cjs/extrinsic/submittable/BaseSubmittableExtrinsic.js

@@ -8,6 +8,7 @@ const fakeSigner_js_1 = require("./fakeSigner.js");
 const utils_js_1 = require("./utils.js");
 class BaseSubmittableExtrinsic extends codecs_1.Extrinsic {
     api;
+    #alterTx;
     constructor(api, call) {
         super(api.registry, call);
         this.api = api;
@@ -26,13 +27,14 @@ class BaseSubmittableExtrinsic extends codecs_1.Extrinsic {
         });
         await extra.init();
         const { signer } = options || {};
-        let signature;
+        let signature, alteredTx;
         if ((0, utils_js_1.isKeyringPair)(fromAccount)) {
             signature = (0, utils_1.u8aToHex)((0, utils_js_1.signRaw)(fromAccount, extra.toRawPayload(this.callHex).data));
         }
         else if (signer?.signPayload) {
             const result = await signer.signPayload(extra.toPayload(this.callHex));
             signature = result.signature;
+            alteredTx = result.signedTransaction;
         }
         else {
             throw new Error('Signer not found. Cannot sign the extrinsic!');
@@ -44,6 +46,13 @@ class BaseSubmittableExtrinsic extends codecs_1.Extrinsic {
             signature: $Signature.tryDecode(signature),
             extra: extra.data,
         });
+        // If the tx payload are altered from signer
+        // We'll need to validate the altered tx
+        // and broadcast it instead of the original tx
+        if (alteredTx) {
+            this.#validateSignedTx(alteredTx);
+            this.#alterTx = (0, utils_1.toHex)(alteredTx);
+        }
         return this;
     }
     async signAndSend(fromAccount, partialOptions, maybeCallback) {
@@ -66,5 +75,26 @@ class BaseSubmittableExtrinsic extends codecs_1.Extrinsic {
         const atApi = (await this.api.at(hash));
         return await atApi.query.system.events();
     }
+    toHex() {
+        return this.#alterTx || super.toHex();
+    }
+    /**
+     * Validate a raw signed transaction coming from signer
+     * We need to make sure the tx is signed and call-data is intact/not-changing
+     *
+     * @param tx
+     * @private
+     */
+    #validateSignedTx(tx) {
+        const alteredTx = this.$Codec.tryDecode(tx);
+        // The alter tx should be signed
+        if (!alteredTx.signed) {
+            throw new utils_1.DedotError('Altered transaction from signer is not signed');
+        }
+        // Signer's not allow the change the call data
+        if (alteredTx.callHex !== this.callHex) {
+            throw new utils_1.DedotError('Call data does not match, signer is not allowed to change tx call data.');
+        }
+    }
 }
 exports.BaseSubmittableExtrinsic = BaseSubmittableExtrinsic;

package/cjs/extrinsic/submittable/SubmittableExtrinsic.js

@@ -4,6 +4,7 @@ exports.SubmittableExtrinsic = void 0;
 const utils_1 = require("@dedot/utils");
 const BaseSubmittableExtrinsic_js_1 = require("./BaseSubmittableExtrinsic.js");
 const SubmittableResult_js_1 = require("./SubmittableResult.js");
+const utils_js_1 = require("./utils.js");
 /**
  * @name SubmittableExtrinsic
  * @description A wrapper around an Extrinsic that exposes methods to sign, send, and other utility around Extrinsic.
@@ -22,19 +23,21 @@ class SubmittableExtrinsic extends BaseSubmittableExtrinsic_js_1.BaseSubmittable
         const txHex = this.toHex();
         const txHash = this.hash;
         if (isSubscription) {
-            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (status) => {
-                if (status.tag === 'InBlock' || status.tag === 'Finalized') {
-                    const blockHash = status.value;
+            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (txStatus) => {
+                if (txStatus.type === 'InBlock' || txStatus.type === 'Finalized') {
+                    const blockHash = txStatus.value;
                     const [signedBlock, blockEvents] = await Promise.all([
                         this.api.rpc.chain_getBlock(blockHash),
                         this.getSystemEventsAt(blockHash),
                     ]);
                     const txIndex = signedBlock.block.extrinsics.indexOf(txHex);
                     (0, utils_1.assert)(txIndex >= 0, 'Extrinsic not found!');
-                    const events = blockEvents.filter(({ phase }) => phase.tag === 'ApplyExtrinsic' && phase.value === txIndex);
+                    const events = blockEvents.filter(({ phase }) => phase.type === 'ApplyExtrinsic' && phase.value === txIndex);
+                    const status = (0, utils_js_1.toTxStatus)(txStatus, txIndex);
                     return callback(new SubmittableResult_js_1.SubmittableResult({ status, txHash, events, txIndex }));
                 }
                 else {
+                    const status = (0, utils_js_1.toTxStatus)(txStatus);
                     return callback(new SubmittableResult_js_1.SubmittableResult({ status, txHash }));
                 }
             });

package/cjs/extrinsic/submittable/SubmittableExtrinsicV2.js

@@ -28,10 +28,10 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
         };
         const validation = await validateTx(finalizedHash);
         if (validation.isOk) {
-            callback(new SubmittableResult_js_1.SubmittableResult({ status: { tag: 'Validated' }, txHash }));
+            callback(new SubmittableResult_js_1.SubmittableResult({ status: { type: 'Validated' }, txHash }));
         }
         else if (validation.isErr) {
-            throw new errors_js_1.InvalidTxError(`Invalid Tx: ${validation.err.tag} - ${validation.err.value.tag}`, validation);
+            throw new errors_js_1.InvalidTxError(`Invalid Tx: ${validation.err.type} - ${validation.err.value.type}`, validation);
         }
         const checkTxIsOnChain = async (blockHash) => {
             if (blockHash === finalizedHash)
@@ -42,7 +42,7 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
                 return checkTxIsOnChain(api.chainHead.findBlock(blockHash).parent);
             }
             const events = await this.getSystemEventsAt(blockHash);
-            const txEvents = events.filter(({ phase }) => phase.tag == 'ApplyExtrinsic' && phase.value === txIndex);
+            const txEvents = events.filter(({ phase }) => phase.type == 'ApplyExtrinsic' && phase.value === txIndex);
             return {
                 blockHash,
                 index: txIndex,
@@ -88,7 +88,7 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
                     if (txFound && bestChainChanged) {
                         txFound = undefined;
                         callback(new SubmittableResult_js_1.SubmittableResult({
-                            status: { tag: 'NoLongerInBestChain' },
+                            status: { type: 'NoLongerInBestChain' },
                             txHash,
                         }));
                     }
@@ -101,7 +101,7 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
                 txFound = inBlock;
                 const { index: txIndex, events, blockHash } = inBlock;
                 callback(new SubmittableResult_js_1.SubmittableResult({
-                    status: { tag: 'BestChainBlockIncluded', value: { blockHash, txIndex } },
+                    status: { type: 'BestChainBlockIncluded', value: { blockHash, txIndex } },
                     txHash,
                     events,
                     txIndex,
@@ -134,7 +134,7 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
             if (inBlock) {
                 const { index: txIndex, events, blockHash } = inBlock;
                 callback(new SubmittableResult_js_1.SubmittableResult({
-                    status: { tag: 'Finalized', value: { blockHash, txIndex } },
+                    status: { type: 'Finalized', value: { blockHash, txIndex } },
                     txHash,
                     events,
                     txIndex,
@@ -148,8 +148,8 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
                     return;
                 callback(new SubmittableResult_js_1.SubmittableResult({
                     status: {
-                        tag: 'Invalid',
-                        value: { error: `Invalid Tx: ${validation.err.tag} - ${validation.err.value.tag}` },
+                        type: 'Invalid',
+                        value: { error: `Invalid Tx: ${validation.err.type} - ${validation.err.value.type}` },
                     },
                     txHash,
                 }));
@@ -158,7 +158,7 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
         };
         stopBroadcastFn = await api.txBroadcaster.broadcastTx(txHex);
         callback(new SubmittableResult_js_1.SubmittableResult({
-            status: { tag: 'Broadcasting' },
+            status: { type: 'Broadcasting' },
             txHash,
         }));
         const stopBestBlockTrackingFn = api.chainHead.on('bestBlock', checkBestBlockIncluded);
@@ -184,11 +184,11 @@ class SubmittableExtrinsicV2 extends BaseSubmittableExtrinsic_js_1.BaseSubmittab
             try {
                 // TODO handle timeout for this with the Drop status, just in-case we somehow can't find the tx in any block
                 const unsub = await this.#send(({ status, txHash }) => {
-                    if (status.tag === 'BestChainBlockIncluded' || status.tag === 'Finalized') {
+                    if (status.type === 'BestChainBlockIncluded' || status.type === 'Finalized') {
                         defer.resolve(txHash);
                         unsub().catch(utils_1.noop);
                     }
-                    else if (status.tag === 'Invalid' || status.tag === 'Drop') {
+                    else if (status.type === 'Invalid' || status.type === 'Drop') {
                         defer.reject(new Error(status.value.error));
                         unsub().catch(utils_1.noop);
                     }

package/cjs/extrinsic/submittable/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.signRaw = exports.isKeyringPair = void 0;
+exports.toTxStatus = exports.signRaw = exports.isKeyringPair = void 0;
 const utils_1 = require("@dedot/utils");
 function isKeyringPair(account) {
     return (0, utils_1.isFunction)(account.sign);
@@ -18,3 +18,68 @@ function signRaw(signerPair, raw) {
     return signerPair.sign(toSignRaw, { withType: true });
 }
 exports.signRaw = signRaw;
+/**
+ * Convert transaction status to transaction event
+ *
+ * Ref: https://github.com/paritytech/polkadot-sdk/blob/98a364fe6e7abf10819f5fddd3de0588f7c38700/substrate/client/rpc-spec-v2/src/transaction/transaction.rs#L132-L159
+ * @param txStatus
+ * @param txIndex
+ */
+function toTxStatus(txStatus, txIndex) {
+    switch (txStatus.type) {
+        case 'Ready':
+        case 'Future':
+            return { type: 'Validated' };
+        case 'Broadcast':
+            return { type: 'Broadcasting' };
+        case 'Retracted':
+            return { type: 'NoLongerInBestChain' };
+        case 'InBlock':
+            (0, utils_1.assert)(txIndex, 'TxIndex is required');
+            return {
+                type: 'BestChainBlockIncluded',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'Finalized':
+            (0, utils_1.assert)(txIndex, 'TxIndex is required');
+            return {
+                type: 'Finalized',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'FinalityTimeout':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Maximum number of finality watchers has been reached',
+                },
+            };
+        case 'Dropped':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Extrinsic dropped from the pool due to exceeding limits',
+                },
+            };
+        case 'Usurped':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic was rendered invalid by another extrinsic',
+                },
+            };
+        case 'Invalid':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic marked as invalid',
+                },
+            };
+    }
+}
+exports.toTxStatus = toTxStatus;

package/cjs/storage/QueryableStorage.js

@@ -39,14 +39,14 @@ class QueryableStorage {
         const storageItemHash = (0, utils_2.xxhashAsU8a)(this.storageEntry.name, 128);
         return (0, utils_2.concatU8a)(palletNameHash, storageItemHash);
     }
-    #getStorageMapInfo(type) {
-        (0, utils_1.assert)(type.tag === 'Map');
-        const { hashers, keyTypeId } = type.value;
+    #getStorageMapInfo(storageType) {
+        (0, utils_1.assert)(storageType.type === 'Map');
+        const { hashers, keyTypeId } = storageType.value;
         let keyTypeIds = [keyTypeId];
         if (hashers.length > 1) {
-            const { type } = this.registry.findType(keyTypeId);
-            (0, utils_1.assert)(type.tag === 'Tuple', 'Key type should be a tuple!');
-            keyTypeIds = type.value.fields;
+            const { typeDef } = this.registry.findType(keyTypeId);
+            (0, utils_1.assert)(typeDef.type === 'Tuple', 'Key type should be a tuple!');
+            keyTypeIds = typeDef.value.fields;
         }
         return { hashers, keyTypeIds };
     }
@@ -56,12 +56,12 @@ class QueryableStorage {
      * @param keyInput
      */
     encodeKey(keyInput) {
-        const { type } = this.storageEntry;
-        if (type.tag === 'Plain') {
+        const { storageType } = this.storageEntry;
+        if (storageType.type === 'Plain') {
             return this.prefixKey;
         }
-        else if (type.tag === 'Map') {
-            const { hashers, keyTypeIds } = this.#getStorageMapInfo(type);
+        else if (storageType.type === 'Map') {
+            const { hashers, keyTypeIds } = this.#getStorageMapInfo(storageType);
             const extractedInputs = this.#extractRequiredKeyInputs(keyInput, hashers.length);
             const keyParts = keyTypeIds.map((keyId, index) => {
                 const input = extractedInputs[index];
@@ -71,7 +71,7 @@ class QueryableStorage {
             });
             return (0, utils_2.u8aToHex)((0, utils_2.concatU8a)(this.prefixKeyAsU8a, ...keyParts));
         }
-        throw Error(`Invalid storage entry type: ${type}`);
+        throw Error(`Invalid storage entry type: ${JSON.stringify(storageType)}`);
     }
     /**
      * Decode storage key to plain key input
@@ -80,16 +80,16 @@ class QueryableStorage {
      * @param key
      */
     decodeKey(key) {
-        const { type } = this.storageEntry;
-        if (type.tag === 'Plain') {
+        const { storageType } = this.storageEntry;
+        if (storageType.type === 'Plain') {
             return;
         }
-        else if (type.tag === 'Map') {
+        else if (storageType.type === 'Map') {
             const prefix = this.prefixKey;
             if (!key.startsWith(prefix)) {
                 throw new Error(`Storage key does not match this storage entry (${this.palletName}.${this.storageItem})`);
             }
-            const { hashers, keyTypeIds } = this.#getStorageMapInfo(type);
+            const { hashers, keyTypeIds } = this.#getStorageMapInfo(storageType);
             let keyData = (0, utils_2.hexToU8a)((0, utils_1.hexAddPrefix)(key.slice(prefix.length)));
             const results = keyTypeIds.map((keyId, index) => {
                 const [hashLen, canDecode] = HASHER_INFO[hashers[index]];
@@ -104,7 +104,7 @@ class QueryableStorage {
             });
             return hashers.length > 1 ? results : results[0];
         }
-        throw Error(`Invalid storage entry type: ${type}`);
+        throw Error(`Invalid storage entry type: ${JSON.stringify(storageType)}`);
     }
     /**
      * Decode raw/bytes storage data to plain value
@@ -112,7 +112,7 @@ class QueryableStorage {
      * @param raw
      */
     decodeValue(raw) {
-        const { modifier, type: { value: { valueTypeId }, }, default: defaultValue, } = this.storageEntry;
+        const { modifier, storageType: { value: { valueTypeId }, }, default: defaultValue, } = this.storageEntry;
         if (raw === null || raw === undefined) {
             if (modifier === 'Optional') {
                 return undefined;

package/client/BaseSubstrateClient.d.ts

@@ -2,6 +2,7 @@ import { BlockHash, Hash, Metadata, PortableRegistry, RuntimeVersion } from '@de
 import type { JsonRpcProvider } from '@dedot/providers';
 import { type IStorage } from '@dedot/storage';
 import { GenericSubstrateApi, RpcVersion, VersionedGenericSubstrateApi } from '@dedot/types';
+import { Deferred } from '@dedot/utils';
 import type { SubstrateApi } from '../chaintypes/index.js';
 import { JsonRpcClient } from '../json-rpc/index.js';
 import type { ApiEvent, ApiOptions, ISubstrateClient, ISubstrateClientAt, JsonRpcClientOptions, MetadataKey, SubstrateRuntimeVersion } from '../types.js';
@@ -10,7 +11,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<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends JsonRpcClient<ChainApi[RpcVersion], ApiEvent> implements ISubstrateClient<ChainApi[RpcVersion]> {
+export declare abstract class BaseSubstrateClient<Rv extends RpcVersion, ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends JsonRpcClient<ChainApi, ApiEvent> implements ISubstrateClient<ChainApi[Rv]> {
     rpcVersion: RpcVersion;
     protected _options: ApiOptions;
     protected _registry?: PortableRegistry;
@@ -18,6 +19,7 @@ export declare abstract class BaseSubstrateClient<ChainApi extends VersionedGene
     protected _genesisHash?: Hash;
     protected _runtimeVersion?: SubstrateRuntimeVersion;
     protected _localCache?: IStorage;
+    protected _runtimeUpgrading?: Deferred<void>;
     protected constructor(rpcVersion: RpcVersion, options: JsonRpcClientOptions | JsonRpcProvider);
     protected normalizeOptions(options: ApiOptions | JsonRpcProvider): ApiOptions;
     protected initializeLocalCache(): Promise<void>;
@@ -41,6 +43,9 @@ export declare abstract class BaseSubstrateClient<ChainApi extends VersionedGene
     protected beforeDisconnect(): Promise<void>;
     protected afterDisconnect(): Promise<void>;
     protected toSubstrateRuntimeVersion(runtimeVersion: RuntimeVersion): SubstrateRuntimeVersion;
+    protected startRuntimeUpgrade(): void;
+    protected doneRuntimeUpgrade(): void;
+    protected ensureRuntimeUpgraded(): Promise<void>;
     /**
      * @description Connect to blockchain node
      */
@@ -54,12 +59,13 @@ export declare abstract class BaseSubstrateClient<ChainApi extends VersionedGene
     get registry(): PortableRegistry;
     get genesisHash(): Hash;
     get runtimeVersion(): SubstrateRuntimeVersion;
-    get consts(): ChainApi[RpcVersion]['consts'];
-    get errors(): ChainApi[RpcVersion]['errors'];
-    get events(): ChainApi[RpcVersion]['events'];
-    get query(): ChainApi[RpcVersion]['query'];
-    get call(): ChainApi[RpcVersion]['call'];
-    protected callAt(hash?: BlockHash): ChainApi[RpcVersion]['call'];
-    get tx(): ChainApi[RpcVersion]['tx'];
-    at<ChainApiAt extends GenericSubstrateApi = ChainApi[RpcVersion]>(hash: BlockHash): Promise<ISubstrateClientAt<ChainApiAt>>;
+    getRuntimeVersion(): Promise<SubstrateRuntimeVersion>;
+    get consts(): ChainApi[Rv]['consts'];
+    get errors(): ChainApi[Rv]['errors'];
+    get events(): ChainApi[Rv]['events'];
+    get query(): ChainApi[Rv]['query'];
+    get call(): ChainApi[Rv]['call'];
+    protected callAt(hash?: BlockHash): ChainApi[Rv]['call'];
+    get tx(): ChainApi[Rv]['tx'];
+    at<ChainApiAt extends GenericSubstrateApi = ChainApi[Rv]>(hash: BlockHash): Promise<ISubstrateClientAt<ChainApiAt>>;
 }