dedot 0.0.1-alpha.23 → 0.0.1-alpha.25

package/README.md

@@ -115,7 +115,7 @@ yarn add -D @dedot/chaintypes
 npm i -D @dedot/chaintypes
 ```
 
-Initialize a `DelighfulApi` instance using the `ChainApi` interface for a target chain to enable types & APIs suggestion/autocompletion for that particular chain:
+Initialize a `Dedot` instance using the `ChainApi` interface for a target chain to enable types & APIs suggestion/autocompletion for that particular chain:
 ```typescript
 import { Dedot } from 'dedot';
 import type { PolkadotApi, KusamaApi, MoonbeamApi, AstarApi } from '@dedot/chaintypes';
@@ -239,6 +239,12 @@ await api.query.system.events(async (eventRecords) => {
 
 `dedot` take a lot of inspirations from project [@polkadot/api](https://github.com/polkadot-js/api). A big thank to all the maintainers/contributors of this awesome library.
 
+Proudly supported by Web3 Foundation Grants Program.
+<p align="left">
+  <img width="479" src="https://user-images.githubusercontent.com/6867026/227230786-0796214a-3e3f-42af-94e9-d4122c730b62.png">
+</p>
+
+
 ### License
 
 [Apache-2.0](https://github.com/dedotdev/dedot/blob/main/LICENSE)

package/cjs/client/Dedot.js

@@ -259,7 +259,7 @@ class Dedot {
             return { endpoint: options };
         }
         else {
-            let { metadata } = options;
+            let { metadata } = options || {};
             if (metadata && typeof metadata === 'string') {
                 metadata = {
                     [exports.CATCH_ALL_METADATA_KEY]: (0, util_1.hexAddPrefix)(metadata),

package/cjs/executor/RuntimeApiExecutor.js

@@ -10,10 +10,10 @@ exports.FallbackRuntimeApis = [
 ];
 class RuntimeApiExecutor extends Executor_1.Executor {
     execute(runtimeApi, method) {
-        runtimeApi = (0, util_1.stringPascalCase)(runtimeApi);
-        method = (0, utils_1.stringSnakeCase)(method);
-        const callName = `${runtimeApi}_${method}`;
-        const callSpec = this.#findRuntimeApiMethodSpec(runtimeApi, method);
+        const runtimeApiName = (0, util_1.stringPascalCase)(runtimeApi);
+        const methodName = (0, utils_1.stringSnakeCase)(method);
+        const callName = this.#callName({ runtimeApiName, methodName });
+        const callSpec = this.#findRuntimeApiMethodSpec(runtimeApiName, methodName);
         (0, utils_1.assert)(callSpec, `Runtime Api not found: ${callName}`);
         const callFn = async (...args) => {
             const { params } = callSpec;
@@ -30,23 +30,40 @@ class RuntimeApiExecutor extends Executor_1.Executor {
         return callFn;
     }
     tryDecode(callSpec, raw) {
-        const { type, typeId } = callSpec;
-        if ((0, util_1.isNumber)(typeId)) {
-            return this.registry.findPortableCodec(typeId).tryDecode(raw);
-        }
-        return this.registry.findCodec(type).tryDecode(raw);
+        const $codec = this.#findCodec(callSpec, `Codec not found to decode respond data for ${this.#callName(callSpec)}`);
+        return $codec.tryDecode(raw);
     }
     tryEncode(paramSpec, value) {
-        const { type, typeId } = paramSpec;
-        const $codec = (0, util_1.isNumber)(typeId) ? this.registry.findPortableCodec(typeId) : this.registry.findCodec(type);
+        const $codec = this.#findCodec(paramSpec, `Codec not found to encode input for param ${paramSpec.name}`);
         return $codec.tryEncode(value);
     }
+    #findCodec(spec, error) {
+        const { codec, typeId, type } = spec;
+        if (codec)
+            return codec;
+        if ((0, util_1.isNumber)(typeId)) {
+            return this.registry.findPortableCodec(typeId);
+        }
+        if (type) {
+            return this.registry.findCodec(type);
+        }
+        throw new Error(error || 'Codec not found');
+    }
+    #callName({ runtimeApiName, methodName }) {
+        return `${runtimeApiName}_${methodName}`;
+    }
     #findRuntimeApiMethodSpec(runtimeApi, method) {
+        const targetVersion = this.#findTargetRuntimeApiVersion(runtimeApi);
+        if (!(0, util_1.isNumber)(targetVersion))
+            return undefined;
+        const userDefinedSpec = this.#findUserDefinedSpec(runtimeApi, method, targetVersion);
+        if (userDefinedSpec)
+            return userDefinedSpec;
         const methodDef = this.#findRuntimeApiMethodDef(runtimeApi, method);
         if (methodDef) {
             return this.#toMethodSpec(runtimeApi, methodDef);
         }
-        return this.#findRuntimeApiMethodExternalSpec(runtimeApi, method);
+        return this.#findExternalSpec(runtimeApi, method, targetVersion);
     }
     #findRuntimeApiMethodDef(runtimeApi, method) {
         try {
@@ -62,32 +79,36 @@ class RuntimeApiExecutor extends Executor_1.Executor {
         catch { }
     }
     #toMethodSpec(runtimeApi, methodDef) {
-        if (!methodDef)
-            return undefined;
         const { name, inputs, output, docs } = methodDef;
         return {
             docs,
             runtimeApiName: runtimeApi,
             methodName: name,
-            type: '', // TODO generate type name
             typeId: output,
             params: inputs.map(({ name, typeId }) => ({
                 name,
-                type: '', // TODO generate type name
                 typeId,
             })),
         };
     }
-    #findRuntimeApiMethodExternalSpec(runtimeApi, method) {
-        const targetRuntimeApiHash = (0, utils_1.calculateRuntimeApiHash)(runtimeApi);
+    #findTargetRuntimeApiVersion(runtimeApi) {
+        const runtimeApiHash = (0, utils_1.calculateRuntimeApiHash)(runtimeApi);
         const runtimeApiVersions = this.api.runtimeVersion?.apis || exports.FallbackRuntimeApis;
-        const targetRuntimeApiVersion = runtimeApiVersions
-            .find(([supportedRuntimeApiHash]) => targetRuntimeApiHash === supportedRuntimeApiHash)
+        const foundVersion = runtimeApiVersions
+            .find(([supportedRuntimeApiHash]) => runtimeApiHash === supportedRuntimeApiHash)
             ?.at(1);
-        if (!(0, util_1.isNumber)(targetRuntimeApiVersion)) {
+        return foundVersion;
+    }
+    #findExternalSpec(runtimeApiName, methodName, targetRuntimeApiVersion) {
+        return (0, specs_1.findRuntimeApiMethodSpec)(this.#callName({ runtimeApiName, methodName }), targetRuntimeApiVersion);
+    }
+    #findUserDefinedSpec(runtimeApi, method, runtimeApiVersion) {
+        const userDefinedSpecs = this.api.options.runtime;
+        if (!userDefinedSpecs)
             return undefined;
-        }
-        return (0, specs_1.findRuntimeApiMethodSpec)(`${runtimeApi}_${method}`, targetRuntimeApiVersion);
+        const methodSpecs = (0, specs_1.extractRuntimeApisModule)(userDefinedSpecs).map(specs_1.extractRuntimeApiSpec).flat();
+        return methodSpecs.find(({ runtimeApiName, methodName, version }) => `${(0, util_1.stringPascalCase)(runtimeApiName)}_${(0, utils_1.stringSnakeCase)(methodName)}` === `${runtimeApi}_${method}` &&
+            runtimeApiVersion === version);
     }
 }
 exports.RuntimeApiExecutor = RuntimeApiExecutor;

package/cjs/packageInfo.js

@@ -2,4 +2,4 @@
 // THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageInfo = void 0;
-exports.packageInfo = { name: 'dedot', version: '0.0.1-alpha.22' };
+exports.packageInfo = { name: 'dedot', version: '0.0.1-alpha.24' };

package/client/Dedot.js

@@ -253,7 +253,7 @@ export class Dedot {
             return { endpoint: options };
         }
         else {
-            let { metadata } = options;
+            let { metadata } = options || {};
             if (metadata && typeof metadata === 'string') {
                 metadata = {
                     [CATCH_ALL_METADATA_KEY]: hexAddPrefix(metadata),

package/executor/RuntimeApiExecutor.d.ts

@@ -1,5 +1,5 @@
+import type { GenericRuntimeApiMethod, GenericSubstrateApi, RuntimeApiMethodSpec, RuntimeApiMethodParamSpec } from '@dedot/types';
 import { Executor } from './Executor';
-import { GenericRuntimeApiMethod, GenericSubstrateApi, RuntimeApiMethodParamSpec, RuntimeApiMethodSpec } from '@dedot/types';
 export declare const FallbackRuntimeApis: (string | number)[][];
 export declare class RuntimeApiExecutor<ChainApi extends GenericSubstrateApi = GenericSubstrateApi> extends Executor<ChainApi> {
     #private;

package/executor/RuntimeApiExecutor.js

@@ -1,16 +1,16 @@
 import { Executor } from './Executor';
 import { assert, calculateRuntimeApiHash, stringSnakeCase } from '@dedot/utils';
 import { isNumber, stringPascalCase, u8aConcat, u8aToHex } from '@polkadot/util';
-import { findRuntimeApiMethodSpec } from '@dedot/specs';
+import { extractRuntimeApisModule, extractRuntimeApiSpec, findRuntimeApiMethodSpec } from '@dedot/specs';
 export const FallbackRuntimeApis = [
     ['0x37e397fc7c91f5e4', 2], // Metadata Api v2
 ];
 export class RuntimeApiExecutor extends Executor {
     execute(runtimeApi, method) {
-        runtimeApi = stringPascalCase(runtimeApi);
-        method = stringSnakeCase(method);
-        const callName = `${runtimeApi}_${method}`;
-        const callSpec = this.#findRuntimeApiMethodSpec(runtimeApi, method);
+        const runtimeApiName = stringPascalCase(runtimeApi);
+        const methodName = stringSnakeCase(method);
+        const callName = this.#callName({ runtimeApiName, methodName });
+        const callSpec = this.#findRuntimeApiMethodSpec(runtimeApiName, methodName);
         assert(callSpec, `Runtime Api not found: ${callName}`);
         const callFn = async (...args) => {
             const { params } = callSpec;
@@ -27,23 +27,40 @@ export class RuntimeApiExecutor extends Executor {
         return callFn;
     }
     tryDecode(callSpec, raw) {
-        const { type, typeId } = callSpec;
-        if (isNumber(typeId)) {
-            return this.registry.findPortableCodec(typeId).tryDecode(raw);
-        }
-        return this.registry.findCodec(type).tryDecode(raw);
+        const $codec = this.#findCodec(callSpec, `Codec not found to decode respond data for ${this.#callName(callSpec)}`);
+        return $codec.tryDecode(raw);
     }
     tryEncode(paramSpec, value) {
-        const { type, typeId } = paramSpec;
-        const $codec = isNumber(typeId) ? this.registry.findPortableCodec(typeId) : this.registry.findCodec(type);
+        const $codec = this.#findCodec(paramSpec, `Codec not found to encode input for param ${paramSpec.name}`);
         return $codec.tryEncode(value);
     }
+    #findCodec(spec, error) {
+        const { codec, typeId, type } = spec;
+        if (codec)
+            return codec;
+        if (isNumber(typeId)) {
+            return this.registry.findPortableCodec(typeId);
+        }
+        if (type) {
+            return this.registry.findCodec(type);
+        }
+        throw new Error(error || 'Codec not found');
+    }
+    #callName({ runtimeApiName, methodName }) {
+        return `${runtimeApiName}_${methodName}`;
+    }
     #findRuntimeApiMethodSpec(runtimeApi, method) {
+        const targetVersion = this.#findTargetRuntimeApiVersion(runtimeApi);
+        if (!isNumber(targetVersion))
+            return undefined;
+        const userDefinedSpec = this.#findUserDefinedSpec(runtimeApi, method, targetVersion);
+        if (userDefinedSpec)
+            return userDefinedSpec;
         const methodDef = this.#findRuntimeApiMethodDef(runtimeApi, method);
         if (methodDef) {
             return this.#toMethodSpec(runtimeApi, methodDef);
         }
-        return this.#findRuntimeApiMethodExternalSpec(runtimeApi, method);
+        return this.#findExternalSpec(runtimeApi, method, targetVersion);
     }
     #findRuntimeApiMethodDef(runtimeApi, method) {
         try {
@@ -59,31 +76,35 @@ export class RuntimeApiExecutor extends Executor {
         catch { }
     }
     #toMethodSpec(runtimeApi, methodDef) {
-        if (!methodDef)
-            return undefined;
         const { name, inputs, output, docs } = methodDef;
         return {
             docs,
             runtimeApiName: runtimeApi,
             methodName: name,
-            type: '', // TODO generate type name
             typeId: output,
             params: inputs.map(({ name, typeId }) => ({
                 name,
-                type: '', // TODO generate type name
                 typeId,
             })),
         };
     }
-    #findRuntimeApiMethodExternalSpec(runtimeApi, method) {
-        const targetRuntimeApiHash = calculateRuntimeApiHash(runtimeApi);
+    #findTargetRuntimeApiVersion(runtimeApi) {
+        const runtimeApiHash = calculateRuntimeApiHash(runtimeApi);
         const runtimeApiVersions = this.api.runtimeVersion?.apis || FallbackRuntimeApis;
-        const targetRuntimeApiVersion = runtimeApiVersions
-            .find(([supportedRuntimeApiHash]) => targetRuntimeApiHash === supportedRuntimeApiHash)
+        const foundVersion = runtimeApiVersions
+            .find(([supportedRuntimeApiHash]) => runtimeApiHash === supportedRuntimeApiHash)
             ?.at(1);
-        if (!isNumber(targetRuntimeApiVersion)) {
+        return foundVersion;
+    }
+    #findExternalSpec(runtimeApiName, methodName, targetRuntimeApiVersion) {
+        return findRuntimeApiMethodSpec(this.#callName({ runtimeApiName, methodName }), targetRuntimeApiVersion);
+    }
+    #findUserDefinedSpec(runtimeApi, method, runtimeApiVersion) {
+        const userDefinedSpecs = this.api.options.runtime;
+        if (!userDefinedSpecs)
             return undefined;
-        }
-        return findRuntimeApiMethodSpec(`${runtimeApi}_${method}`, targetRuntimeApiVersion);
+        const methodSpecs = extractRuntimeApisModule(userDefinedSpecs).map(extractRuntimeApiSpec).flat();
+        return methodSpecs.find(({ runtimeApiName, methodName, version }) => `${stringPascalCase(runtimeApiName)}_${stringSnakeCase(methodName)}` === `${runtimeApi}_${method}` &&
+            runtimeApiVersion === version);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dedot",
-  "version": "0.0.1-alpha.23",
+  "version": "0.0.1-alpha.25",
   "description": "A fast & lightweight JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot",
@@ -12,11 +12,11 @@
   "main": "./cjs/index.js",
   "type": "module",
   "dependencies": {
-    "@dedot/chaintypes": "0.0.1-alpha.23",
-    "@dedot/codecs": "0.0.1-alpha.23",
-    "@dedot/shape": "0.0.1-alpha.23",
-    "@dedot/specs": "0.0.1-alpha.23",
-    "@dedot/utils": "0.0.1-alpha.23",
+    "@dedot/chaintypes": "0.0.1-alpha.25",
+    "@dedot/codecs": "0.0.1-alpha.25",
+    "@dedot/shape": "0.0.1-alpha.25",
+    "@dedot/specs": "0.0.1-alpha.25",
+    "@dedot/utils": "0.0.1-alpha.25",
     "@polkadot/rpc-provider": "^10.11.2",
     "@polkadot/util": "^12.6.2",
     "@polkadot/util-crypto": "^12.6.2",
@@ -36,7 +36,7 @@
     "@polkadot/keyring": "^12.6.2",
     "@polkadot/types": "^10.11.2"
   },
-  "gitHead": "d0aaaf353a6596d5dcd9277b241799bd544a2bd2",
+  "gitHead": "44b180e85a3126e45dcf408fcb3d32adc4bedeca",
   "module": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/packageInfo.js

@@ -1,3 +1,3 @@
 // THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
 
-export const packageInfo = { name: 'dedot', version: '0.0.1-alpha.23' };
+export const packageInfo = { name: 'dedot', version: '0.0.1-alpha.25' };

package/types.d.ts

@@ -1,6 +1,7 @@
 import { ProviderInterface } from '@polkadot/rpc-provider/types';
 import { HexString } from '@dedot/utils';
 import { AnySignedExtension } from './extrinsic';
+import { RuntimeApiSpec } from '@dedot/types';
 export type NetworkEndpoint = string;
 export type MetadataKey = `RAW_META/${string}`;
 export interface ApiOptions {
@@ -38,6 +39,7 @@ export interface ApiOptions {
      * @description User-defined chain-specific signed extensions
      */
     signedExtensions?: Record<string, AnySignedExtension>;
+    runtime?: Record<string, RuntimeApiSpec[]>;
 }
 export interface NormalizedApiOptions extends ApiOptions {
     metadata?: Record<string, HexString>;