@dedot/codegen 0.0.1-next.ce93b605.2 → 0.0.1-next.d9aff57d.57

package/generator/TypesGen.js

@@ -1,10 +1,8 @@
-import { stringPascalCase } from '@polkadot/util';
 import { PortableRegistry } from '@dedot/codecs';
-import { isNativeType, normalizeName } from '@dedot/utils';
-import { beautifySourceCode, commentBlock, compileTemplate } from './utils';
-import { knownTypes } from './known-types';
-import { TypeImports } from './TypeImports';
-import { findKnownCodec, findKnownCodecType, isKnownCodecType } from './known-codecs';
+import { normalizeName, stringPascalCase } from '@dedot/utils';
+import { TypeImports } from './TypeImports.js';
+import { findKnownCodec, findKnownCodecType, isKnownCodecType } from './known-codecs.js';
+import { beautifySourceCode, commentBlock, compileTemplate, isNativeType } from './utils.js';
 // Skip generate types for these
 // as we do have native types for them
 const SKIP_TYPES = [
@@ -42,7 +40,7 @@ export class TypesGen {
         this.includedTypes = this.#includedTypes();
         this.typeImports = new TypeImports();
     }
-    generate() {
+    generate(useSubPaths = false) {
         this.clearCache();
         let defTypeOut = '';
         Object.values(this.includedTypes)
@@ -53,7 +51,7 @@ export class TypesGen {
                 defTypeOut += `export type ${name} = ${this.generateType(id)};\n\n`;
             }
         });
-        const importTypes = this.typeImports.toImports('./types');
+        const importTypes = this.typeImports.toImports({ useSubPaths, excludeModules: ['./types'] });
         const template = compileTemplate('types.hbs');
         return beautifySourceCode(template({ importTypes, defTypeOut }));
     }
@@ -423,11 +421,6 @@ export class TypesGen {
             this.typeImports.addCodecType(typeName);
             return;
         }
-        if (knownTypes.includes(typeName)) {
-            this.typeImports.addKnownType(typeName);
-        }
-        else {
-            this.typeImports.addOutType(typeName);
-        }
+        this.typeImports.addOutType(typeName);
     }
 }

package/generator/index.d.ts

@@ -1,10 +1,10 @@
-export * from './TypesGen';
-export * from './ApiGen';
-export * from './ConstsGen';
-export * from './QueryGen';
-export * from './RpcGen';
-export * from './IndexGen';
-export * from './ErrorsGen';
-export * from './EventsGen';
-export * from './TxGen';
-export * from './RuntimeApisGen';
+export * from './TypesGen.js';
+export * from './ApiGen.js';
+export * from './ConstsGen.js';
+export * from './QueryGen.js';
+export * from './JsonRpcGen.js';
+export * from './IndexGen.js';
+export * from './ErrorsGen.js';
+export * from './EventsGen.js';
+export * from './TxGen.js';
+export * from './RuntimeApisGen.js';

package/generator/index.js

@@ -1,10 +1,10 @@
-export * from './TypesGen';
-export * from './ApiGen';
-export * from './ConstsGen';
-export * from './QueryGen';
-export * from './RpcGen';
-export * from './IndexGen';
-export * from './ErrorsGen';
-export * from './EventsGen';
-export * from './TxGen';
-export * from './RuntimeApisGen';
+export * from './TypesGen.js';
+export * from './ApiGen.js';
+export * from './ConstsGen.js';
+export * from './QueryGen.js';
+export * from './JsonRpcGen.js';
+export * from './IndexGen.js';
+export * from './ErrorsGen.js';
+export * from './EventsGen.js';
+export * from './TxGen.js';
+export * from './RuntimeApisGen.js';

package/generator/known-codecs.d.ts

@@ -1,5 +1,5 @@
-import * as $ from '@dedot/shape';
 import { AnyShape } from '@dedot/shape';
+import * as $ from '@dedot/shape';
 export type CodecName = `$${string}`;
 export interface CodecType {
     name: CodecName;

package/generator/known-codecs.js

@@ -1,6 +1,6 @@
-import * as $ from '@dedot/shape';
 import * as Codecs from '@dedot/codecs';
 import { $AccountId20, $AccountId32, $Bytes, $ConsensusEngineId, $Era, $EthereumAddress, $MultiAddress, $OpaqueExtrinsic, $PrefixedStorageKey, $RawBytes, $StorageData, $StorageKey, $UncheckedExtrinsic, } from '@dedot/codecs';
+import * as $ from '@dedot/shape';
 import { assert } from '@dedot/utils';
 export const normalizeCodecName = (name) => {
     return name.startsWith('$') ? name : `$${name}`;

package/generator/utils.d.ts

@@ -8,3 +8,8 @@ export declare const compileTemplate: (templateFileName: string) => HandlebarsTe
  * @param word
  */
 export declare const isReservedWord: (word: string) => boolean;
+/**
+ * Check if a type is native JS/TS type
+ * @param type
+ */
+export declare const isNativeType: (type: string) => boolean;

package/generator/utils.js

@@ -33,3 +33,31 @@ const TS_RESERVED_WORDS = ['new', 'class'];
  * @param word
  */
 export const isReservedWord = (word) => TS_RESERVED_WORDS.includes(word);
+const TS_PRIMITIVE_TYPES = [
+    'void',
+    'undefined',
+    'null',
+    'number',
+    'boolean',
+    'bigint',
+    'Map',
+    'Set',
+    'string',
+    'any',
+    'Array',
+    'Record',
+];
+/**
+ * Check if a type is native JS/TS type
+ * @param type
+ */
+export const isNativeType = (type) => {
+    return TS_PRIMITIVE_TYPES.some((one) => {
+        if (typeof one === 'string') {
+            return one === type;
+        }
+        else {
+            return type.match(one);
+        }
+    });
+};

package/index.d.ts

@@ -1,4 +1,3 @@
 import { MetadataLatest } from '@dedot/codecs';
-import { NetworkInfo } from './types';
-export declare function generateTypesFromChain(network: NetworkInfo, endpoint: string, outDir: string): Promise<void>;
-export declare function generateTypes(network: NetworkInfo, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: any[], outDir?: string): Promise<void>;
+export declare function generateTypesFromEndpoint(chain: string, endpoint: string, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;
+export declare function generateTypes(chain: string, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: Record<string, number>, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;

package/index.js

@@ -1,48 +1,49 @@
-import { Dedot } from 'dedot';
+import { Dedot } from '@dedot/api';
+import { WsProvider } from '@dedot/providers';
+import { stringCamelCase } from '@dedot/utils';
 import * as fs from 'fs';
 import * as path from 'path';
-import { ConstsGen, ErrorsGen, EventsGen, IndexGen, QueryGen, RpcGen, RuntimeApisGen, TxGen, TypesGen, } from './generator';
-import { stringCamelCase } from '@polkadot/util';
-export async function generateTypesFromChain(network, endpoint, outDir) {
-    const api = await Dedot.create(endpoint);
-    const { methods } = await api.rpc.rpc.methods();
-    const apis = api.runtimeVersion?.apis || [];
-    if (!network.chain) {
-        network.chain = stringCamelCase(api.runtimeVersion?.specName || api.runtimeChain || 'local');
+import { ConstsGen, ErrorsGen, EventsGen, IndexGen, JsonRpcGen, QueryGen, RuntimeApisGen, TxGen, TypesGen, } from './generator/index.js';
+export async function generateTypesFromEndpoint(chain, endpoint, outDir, extension = 'd.ts', useSubPaths = false) {
+    const api = await Dedot.new(new WsProvider(endpoint));
+    const { methods } = await api.rpc.rpc_methods();
+    const apis = api.runtimeVersion.apis || {};
+    if (!chain) {
+        chain = stringCamelCase(api.runtimeVersion.specName || 'local');
     }
-    await generateTypes(network, api.metadataLatest, methods, apis, outDir);
+    await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension, useSubPaths);
     await api.disconnect();
 }
-export async function generateTypes(network, metadata, rpcMethods, runtimeApis, outDir = '.') {
-    const dirPath = path.resolve(outDir, network.chain);
-    const defTypesFileName = path.join(dirPath, `types.d.ts`);
-    const constsTypesFileName = path.join(dirPath, `consts.d.ts`);
-    const queryTypesFileName = path.join(dirPath, `query.d.ts`);
-    const rpcCallsFileName = path.join(dirPath, `rpc.d.ts`);
-    const indexFileName = path.join(dirPath, `index.d.ts`);
-    const errorsFileName = path.join(dirPath, `errors.d.ts`);
-    const eventsFileName = path.join(dirPath, `events.d.ts`);
-    const runtimeApisFileName = path.join(dirPath, `runtime.d.ts`);
-    const txFileName = path.join(dirPath, `tx.d.ts`);
+export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.', extension = 'd.ts', useSubPaths = false) {
+    const dirPath = path.resolve(outDir, chain);
+    const defTypesFileName = path.join(dirPath, `types.${extension}`);
+    const constsTypesFileName = path.join(dirPath, `consts.${extension}`);
+    const queryTypesFileName = path.join(dirPath, `query.${extension}`);
+    const jsonRpcFileName = path.join(dirPath, `json-rpc.${extension}`);
+    const indexFileName = path.join(dirPath, `index.${extension}`);
+    const errorsFileName = path.join(dirPath, `errors.${extension}`);
+    const eventsFileName = path.join(dirPath, `events.${extension}`);
+    const runtimeApisFileName = path.join(dirPath, `runtime.${extension}`);
+    const txFileName = path.join(dirPath, `tx.${extension}`);
     if (!fs.existsSync(dirPath)) {
         fs.mkdirSync(dirPath, { recursive: true });
     }
     const typesGen = new TypesGen(metadata);
     const constsGen = new ConstsGen(typesGen);
     const queryGen = new QueryGen(typesGen);
-    const rpcGen = new RpcGen(typesGen, rpcMethods);
-    const indexGen = new IndexGen(network);
+    const jsonRpcGen = new JsonRpcGen(typesGen, rpcMethods);
+    const indexGen = new IndexGen(chain);
     const errorsGen = new ErrorsGen(typesGen);
     const eventsGen = new EventsGen(typesGen);
     const runtimeApisGen = new RuntimeApisGen(typesGen, runtimeApis);
     const txGen = new TxGen(typesGen);
-    fs.writeFileSync(defTypesFileName, await typesGen.generate());
-    fs.writeFileSync(errorsFileName, await errorsGen.generate());
-    fs.writeFileSync(eventsFileName, await eventsGen.generate());
-    fs.writeFileSync(rpcCallsFileName, await rpcGen.generate());
-    fs.writeFileSync(queryTypesFileName, await queryGen.generate());
-    fs.writeFileSync(constsTypesFileName, await constsGen.generate());
-    fs.writeFileSync(txFileName, await txGen.generate());
-    fs.writeFileSync(indexFileName, await indexGen.generate());
-    fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate());
+    fs.writeFileSync(defTypesFileName, await typesGen.generate(useSubPaths));
+    fs.writeFileSync(errorsFileName, await errorsGen.generate(useSubPaths));
+    fs.writeFileSync(eventsFileName, await eventsGen.generate(useSubPaths));
+    fs.writeFileSync(jsonRpcFileName, await jsonRpcGen.generate(useSubPaths));
+    fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
+    fs.writeFileSync(constsTypesFileName, await constsGen.generate(useSubPaths));
+    fs.writeFileSync(txFileName, await txGen.generate(useSubPaths));
+    fs.writeFileSync(indexFileName, await indexGen.generate(useSubPaths));
+    fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate(useSubPaths));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/codegen",
-  "version": "0.0.1-next.ce93b605.2+ce93b60",
+  "version": "0.0.1-next.d9aff57d.57+d9aff57",
   "description": "Generate types",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/codegen",
@@ -18,33 +18,30 @@
     "copy": "cp -R ./src/templates ./dist && cp -R ./src/templates ./dist/cjs"
   },
   "dependencies": {
-    "@dedot/codecs": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/shape": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/specs": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/utils": "0.0.1-next.ce93b605.2+ce93b60",
-    "@polkadot/util": "^12.6.2",
-    "dedot": "0.0.1-next.ce93b605.2+ce93b60",
-    "handlebars": "^4.7.8",
-    "prettier": "^3.0.3"
+    "@dedot/api": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/codecs": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/providers": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/runtime-specs": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/shape": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/types": "0.0.1-next.d9aff57d.57+d9aff57",
+    "@dedot/utils": "0.0.1-next.d9aff57d.57+d9aff57",
+    "handlebars": "^4.7.7",
+    "prettier": "^3.2.5"
   },
   "publishConfig": {
     "access": "public",
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "ce93b60580f35ca55e074f94324a8704904257c4",
+  "gitHead": "d9aff57dcbd8e15455da9627cbc43f07cb6c0afc",
   "module": "./index.js",
   "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./cjs/index.js"
-      }
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./cjs/index.js",
+      "default": "./index.js"
     }
   }
 }

package/templates/consts.hbs

@@ -2,6 +2,6 @@
 
 {{{ importTypes }}}
 
-export interface ChainConsts extends GenericChainConsts {
+export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<Rv> {
   {{{ defTypeOut }}}
 }

package/templates/errors.hbs

@@ -2,6 +2,6 @@
 
 {{{ importTypes }}}
 
-export interface ChainErrors extends GenericChainErrors {
+export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<Rv> {
   {{{ defTypeOut }}}
 }

package/templates/events.hbs

@@ -2,6 +2,6 @@
 
 {{{ importTypes }}}
 
-export interface ChainEvents extends GenericChainEvents {
+export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<Rv> {
   {{{ defTypeOut }}}
 }

package/templates/index.hbs

@@ -1,9 +1,9 @@
 // Generated by @dedot/codegen
 
-import { GenericSubstrateApi } from '@dedot/types';
+{{{importTypes}}}
 import { ChainConsts } from './consts';
 import { ChainStorage } from './query';
-import { RpcCalls } from './rpc';
+import { ChainJsonRpcApis } from './json-rpc';
 import { ChainErrors } from './errors';
 import { ChainEvents } from './events';
 import { RuntimeApis } from './runtime';
@@ -11,12 +11,17 @@ import { ChainTx } from './tx';
 
 export * from './types';
 
-export interface {{{interfaceName}}}Api extends GenericSubstrateApi {
-  rpc: RpcCalls;
-  consts: ChainConsts;
-  query: ChainStorage;
-  errors: ChainErrors;
-  events: ChainEvents;
-  call: RuntimeApis;
-  tx: ChainTx;
+export interface Versioned{{{interfaceName}}}Api<Rv extends RpcVersion> extends GenericSubstrateApi<Rv> {
+  rpc: ChainJsonRpcApis<Rv>;
+  consts: ChainConsts<Rv>;
+  query: ChainStorage<Rv>;
+  errors: ChainErrors<Rv>;
+  events: ChainEvents<Rv>;
+  call: RuntimeApis<Rv>;
+  tx: ChainTx<Rv>;
+}
+
+export interface {{{interfaceName}}}Api {
+  legacy: Versioned{{{interfaceName}}}Api<RpcLegacy>;
+  v2: Versioned{{{interfaceName}}}Api<RpcV2>;
 }

package/templates/json-rpc.hbs

@@ -0,0 +1,5 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export type ChainJsonRpcApis<Rv extends RpcVersion> = Pick<JsonRpcApis, {{{jsonRpcMethods}}}> & GenericJsonRpcApis<Rv>;

package/templates/query.hbs

@@ -2,6 +2,6 @@
 
 {{{ importTypes }}}
 
-export interface ChainStorage extends GenericChainStorage {
+export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage<Rv> {
   {{{ defTypeOut }}}
 }

package/templates/runtime.hbs

@@ -2,7 +2,7 @@
 
 {{{ importTypes }}}
 
-export interface RuntimeApis extends GenericRuntimeApis {
+export interface RuntimeApis<Rv extends RpcVersion> extends GenericRuntimeApis<Rv> {
 {{{ runtimeCallsOut }}}
 }
 

package/templates/tx.hbs

@@ -4,6 +4,6 @@
 
 {{{ defTypes }}}
 
-export interface ChainTx extends GenericChainTx<TxCall> {
+export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCall<Rv>> {
   {{{ txDefsOut }}}
 }

package/cjs/genSupportedChainTypes.js

@@ -1,83 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-const static_substrate_1 = require("@polkadot/types-support/metadata/static-substrate");
-const substrate_hex_1 = __importDefault(require("@polkadot/types-support/metadata/v15/substrate-hex"));
-const codecs_1 = require("@dedot/codecs");
-const dedot_1 = require("dedot");
-const NETWORKS = [
-    {
-        chain: 'substrate',
-        metadataHex: substrate_hex_1.default,
-        rpcMethods: static_substrate_1.rpc.methods,
-    },
-    {
-        chain: 'polkadot',
-        endpoint: 'wss://rpc.polkadot.io',
-    },
-    {
-        chain: 'kusama',
-        endpoint: 'wss://kusama-rpc.polkadot.io',
-    },
-    {
-        chain: 'astar',
-        endpoint: 'wss://rpc.astar.network',
-    },
-    {
-        chain: 'moonbeam',
-        endpoint: 'wss://moonbeam.api.onfinality.io/public-ws',
-    },
-    {
-        chain: 'polkadotAssetHub',
-        endpoint: 'wss://polkadot-asset-hub-rpc.polkadot.io/',
-    },
-    {
-        chain: 'kusamaAssetHub',
-        endpoint: 'wss://kusama-asset-hub-rpc.polkadot.io/',
-    },
-    {
-        chain: 'rococo',
-        endpoint: 'wss://rococo-rpc.polkadot.io/',
-    },
-    {
-        chain: 'rococoAssetHub',
-        endpoint: 'wss://rococo-asset-hub-rpc.polkadot.io/',
-    },
-    {
-        chain: 'aleph',
-        endpoint: 'wss://aleph-zero.api.onfinality.io/public-ws',
-    },
-    {
-        chain: 'westendAssetHub',
-        endpoint: 'wss://westend-asset-hub-rpc.polkadot.io',
-    },
-];
-const OUT_DIR = 'packages/chaintypes/src';
-async function run() {
-    for (const network of NETWORKS) {
-        const { chain, endpoint, metadataHex, rpcMethods } = network;
-        if (endpoint) {
-            console.log(`Generate types for ${chain} via endpoint ${endpoint}`);
-            await (0, index_1.generateTypesFromChain)(network, endpoint, OUT_DIR);
-        }
-        else if (metadataHex && rpcMethods) {
-            console.log(`Generate types for ${chain} via raw data`);
-            const metadata = codecs_1.$Metadata.tryDecode(metadataHex);
-            const runtimeVersion = getRuntimeVersion(metadata);
-            await (0, index_1.generateTypes)(network, metadata.latest, rpcMethods, runtimeVersion.apis, OUT_DIR);
-        }
-    }
-    console.log('DONE!');
-}
-const getRuntimeVersion = (metadata) => {
-    const registry = new codecs_1.PortableRegistry(metadata.latest);
-    const executor = new dedot_1.ConstantExecutor({
-        registry,
-        metadataLatest: metadata.latest,
-    });
-    return executor.execute('system', 'version');
-};
-run().catch(console.log);