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

package/extrinsic/submittable/utils.js

@@ -1,4 +1,4 @@
-import { blake2AsU8a, hexToU8a, isFunction } from '@dedot/utils';
+import { assert, blake2AsU8a, hexToU8a, isFunction } from '@dedot/utils';
 export function isKeyringPair(account) {
     return isFunction(account.sign);
 }
@@ -13,3 +13,67 @@ export function signRaw(signerPair, raw) {
     const toSignRaw = u8a.length > 256 ? blake2AsU8a(u8a, 256) : u8a;
     return signerPair.sign(toSignRaw, { withType: true });
 }
+/**
+ * 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
+ */
+export 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':
+            assert(txIndex, 'TxIndex is required');
+            return {
+                type: 'BestChainBlockIncluded',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'Finalized':
+            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',
+                },
+            };
+    }
+}

package/json-rpc/JsonRpcClient.d.ts

@@ -1,10 +1,11 @@
 import type { ConnectionStatus, JsonRpcProvider, ProviderEvent } from '@dedot/providers';
-import type { GenericSubstrateApi, RpcVersion } from '@dedot/types';
+import type { RpcVersion, VersionedGenericSubstrateApi } from '@dedot/types';
 import { EventEmitter } from '@dedot/utils';
 import type { SubstrateApi } from '../chaintypes/index.js';
 import type { IJsonRpcClient, JsonRpcClientOptions } from '../types.js';
 export declare const isJsonRpcProvider: (provider: any) => provider is JsonRpcProvider;
-export declare class JsonRpcClient<ChainApi extends GenericSubstrateApi = SubstrateApi[RpcVersion], Events extends string = ProviderEvent> extends EventEmitter<Events> implements IJsonRpcClient<ChainApi, Events> {
+export declare class JsonRpcClient<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi, // prettier-end-here
+Events extends string = ProviderEvent> extends EventEmitter<Events> implements IJsonRpcClient<ChainApi[RpcVersion], Events> {
     #private;
     constructor(options: JsonRpcClientOptions | JsonRpcProvider);
     /**
@@ -12,13 +13,13 @@ export declare class JsonRpcClient<ChainApi extends GenericSubstrateApi = Substr
      *
      * @param options
      */
-    static create<ChainApi extends GenericSubstrateApi = SubstrateApi[RpcVersion]>(options: JsonRpcClientOptions | JsonRpcProvider): Promise<JsonRpcClient<ChainApi>>;
+    static create<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: JsonRpcClientOptions | JsonRpcProvider): Promise<JsonRpcClient<ChainApi>>;
     /**
      * Alias for __JsonRpcClient.create__
      *
      * @param options
      */
-    static new<ChainApi extends GenericSubstrateApi = SubstrateApi[RpcVersion]>(options: JsonRpcClientOptions | JsonRpcProvider): Promise<JsonRpcClient<ChainApi>>;
+    static new<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi>(options: JsonRpcClientOptions | JsonRpcProvider): Promise<JsonRpcClient<ChainApi>>;
     get options(): JsonRpcClientOptions;
     /**
      * @description Check connection status of the api instance
@@ -46,5 +47,5 @@ export declare class JsonRpcClient<ChainApi extends GenericSubstrateApi = Substr
      * const result = await client.rpc.module_rpc_name();
      * ```
      */
-    get rpc(): ChainApi['rpc'];
+    get rpc(): ChainApi[RpcVersion]['rpc'];
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dedot/api",
-  "version": "0.0.1-next.cfee875e.21+cfee875",
+  "version": "0.1.0",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
-  "homepage": "https://github.com/dedotdev/dedot",
+  "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/api",
   "repository": {
     "directory": "packages/api",
     "type": "git",
@@ -13,13 +13,13 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@dedot/codecs": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/providers": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/runtime-specs": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/shape": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/storage": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/types": "0.0.1-next.cfee875e.21+cfee875",
-    "@dedot/utils": "0.0.1-next.cfee875e.21+cfee875"
+    "@dedot/codecs": "0.1.0",
+    "@dedot/providers": "0.1.0",
+    "@dedot/runtime-specs": "0.1.0",
+    "@dedot/shape": "0.1.0",
+    "@dedot/storage": "0.1.0",
+    "@dedot/types": "0.1.0",
+    "@dedot/utils": "0.1.0"
   },
   "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.2.1"
+    "@polkadot/types": "^12.2.1"
   },
-  "gitHead": "cfee875eafba07e0fbb8a72556ca549a62ddceff",
+  "gitHead": "c8220a4ab4b171fe04adb49759318bde865d7c17",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/storage/QueryableStorage.js

@@ -36,14 +36,14 @@ export class QueryableStorage {
         const storageItemHash = xxhashAsU8a(this.storageEntry.name, 128);
         return concatU8a(palletNameHash, storageItemHash);
     }
-    #getStorageMapInfo(type) {
-        assert(type.tag === 'Map');
-        const { hashers, keyTypeId } = type.value;
+    #getStorageMapInfo(storageType) {
+        assert(storageType.type === 'Map');
+        const { hashers, keyTypeId } = storageType.value;
         let keyTypeIds = [keyTypeId];
         if (hashers.length > 1) {
-            const { type } = this.registry.findType(keyTypeId);
-            assert(type.tag === 'Tuple', 'Key type should be a tuple!');
-            keyTypeIds = type.value.fields;
+            const { typeDef } = this.registry.findType(keyTypeId);
+            assert(typeDef.type === 'Tuple', 'Key type should be a tuple!');
+            keyTypeIds = typeDef.value.fields;
         }
         return { hashers, keyTypeIds };
     }
@@ -53,12 +53,12 @@ export 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];
@@ -68,7 +68,7 @@ export class QueryableStorage {
             });
             return u8aToHex(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
@@ -77,16 +77,16 @@ export 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 = hexToU8a(hexAddPrefix(key.slice(prefix.length)));
             const results = keyTypeIds.map((keyId, index) => {
                 const [hashLen, canDecode] = HASHER_INFO[hashers[index]];
@@ -101,7 +101,7 @@ export 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
@@ -109,7 +109,7 @@ export 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/types.d.ts

@@ -56,7 +56,7 @@ export interface ApiOptions extends JsonRpcClientOptions {
      */
     hasher?: HashFn;
 }
-export type ApiEvent = ProviderEvent | 'ready';
+export type ApiEvent = ProviderEvent | 'ready' | 'runtimeUpgraded';
 export interface SubstrateRuntimeVersion {
     specName: string;
     implName: string;
@@ -101,6 +101,14 @@ export interface ISubstrateClient<ChainApi extends GenericSubstrateApi = Generic
     options: ApiOptions;
     tx: ChainApi['tx'];
     at<ChainApiAt extends GenericSubstrateApi = ChainApi>(hash: BlockHash): Promise<ISubstrateClientAt<ChainApiAt>>;
+    /**
+     * Get current version of the runtime
+     * This is similar to `.runtimeVersion` but also ensure
+     * the corresponding metadata of this runtime version is downloaded & setup.
+     *
+     * This is helpful when you want to check runtime version to prepare for runtime upgrade
+     */
+    getRuntimeVersion(): Promise<SubstrateRuntimeVersion>;
 }
 /**
  * A generic interface for broadcasting transactions