@dedot/codegen 0.0.1-alpha.3 → 0.0.1-alpha.31

package/generator/utils.js

@@ -1,8 +1,8 @@
 import * as fs from 'fs';
 import handlebars from 'handlebars';
 import * as path from 'path';
-import * as process from 'process';
 import * as prettier from 'prettier';
+import { currentDirname } from './dirname';
 export const WRAPPER_TYPE_REGEX = /^(\w+)<(.*)>$/;
 export const TUPLE_TYPE_REGEX = /^\[(.*)]$/;
 export const commentBlock = (...docs) => {
@@ -18,16 +18,12 @@ ${flatLines.map((line) => `* ${line.replaceAll(/\s+/g, ' ').trim()}`).join('\n')
       `;
     }
 };
-export const resolveFilePath = (relativePath) => {
-    relativePath = Array.isArray(relativePath) ? relativePath : [relativePath];
-    return path.resolve(process.cwd(), ...relativePath);
-};
 export const beautifySourceCode = async (source) => {
-    const prettierOptions = await prettier.resolveConfig(resolveFilePath('./.prettierrc.js'));
+    const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '../../../../.prettierrc.js'));
     return prettier.format(source, { parser: 'babel-ts', ...prettierOptions });
 };
 export const compileTemplate = (templateFileName) => {
-    const templateFilePath = resolveFilePath(`packages/codegen/src/templates/${templateFileName}`);
+    const templateFilePath = path.resolve(currentDirname(), `../templates/${templateFileName}`);
     return handlebars.compile(fs.readFileSync(templateFilePath, 'utf8'));
 };
 // TODO add more reserved words
@@ -37,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): Promise<void>;
+export declare function generateTypes(chain: string, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: any[], outDir?: string): Promise<void>;

package/index.js

@@ -1,29 +1,29 @@
 import { Dedot } from 'dedot';
 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);
+import { ConstsGen, ErrorsGen, EventsGen, IndexGen, QueryGen, RpcGen, RuntimeApisGen, TxGen, TypesGen, } from './generator/index.js';
+import { stringCamelCase } from '@dedot/utils';
+export async function generateTypesFromEndpoint(chain, endpoint, outDir) {
+    const api = await Dedot.new(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');
+    if (!chain) {
+        chain = stringCamelCase(api.runtimeVersion?.specName || api.runtimeChain || 'local');
     }
-    await generateTypes(network, api.metadataLatest, methods, apis, outDir);
+    await generateTypes(chain, api.metadataLatest, methods, apis, outDir);
     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.ts`);
-    const constsTypesFileName = path.join(dirPath, `consts.ts`);
-    const queryTypesFileName = path.join(dirPath, `query.ts`);
-    const rpcCallsFileName = path.join(dirPath, `rpc.ts`);
-    const indexFileName = path.join(dirPath, `index.ts`);
-    const errorsFileName = path.join(dirPath, `errors.ts`);
-    const eventsFileName = path.join(dirPath, `events.ts`);
-    const runtimeApisFileName = path.join(dirPath, `runtime.ts`);
-    const txFileName = path.join(dirPath, `tx.ts`);
+export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.') {
+    const dirPath = path.resolve(outDir, 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`);
     if (!fs.existsSync(dirPath)) {
         fs.mkdirSync(dirPath, { recursive: true });
     }
@@ -31,7 +31,7 @@ export async function generateTypes(network, metadata, rpcMethods, runtimeApis,
     const constsGen = new ConstsGen(typesGen);
     const queryGen = new QueryGen(typesGen);
     const rpcGen = new RpcGen(typesGen, rpcMethods);
-    const indexGen = new IndexGen(network);
+    const indexGen = new IndexGen(chain);
     const errorsGen = new ErrorsGen(typesGen);
     const eventsGen = new EventsGen(typesGen);
     const runtimeApisGen = new RuntimeApisGen(typesGen, runtimeApis);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/codegen",
-  "version": "0.0.1-alpha.3+a40e2d2",
+  "version": "0.0.1-alpha.31",
   "description": "Generate types",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/codegen",
@@ -10,18 +10,19 @@
     "url": "https://github.com/dedotdev/dedot.git"
   },
   "main": "./cjs/index.js",
+  "sideEffects": false,
   "type": "module",
   "scripts": {
-    "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
-    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo"
+    "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && yarn copy",
+    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo",
+    "copy": "cp -R ./src/templates ./dist && cp -R ./src/templates ./dist/cjs"
   },
   "dependencies": {
-    "@dedot/codecs": "0.0.1-alpha.3+a40e2d2",
-    "@dedot/shape": "0.0.1-alpha.3+a40e2d2",
-    "@dedot/specs": "0.0.1-alpha.3+a40e2d2",
-    "@dedot/utils": "0.0.1-alpha.3+a40e2d2",
-    "@polkadot/util": "^12.6.2",
-    "dedot": "0.0.1-alpha.3+a40e2d2",
+    "@dedot/codecs": "0.0.1-alpha.31",
+    "@dedot/shape": "0.0.1-alpha.31",
+    "@dedot/specs": "0.0.1-alpha.31",
+    "@dedot/utils": "0.0.1-alpha.31",
+    "dedot": "0.0.1-alpha.31",
     "handlebars": "^4.7.8",
     "prettier": "^3.0.3"
   },
@@ -30,7 +31,7 @@
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "a40e2d23db9f7245e816c026cd44c7a4313d5434",
+  "gitHead": "082111d893805a81cff92968cfb5b7b2446a08c5",
   "module": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/templates/consts.hbs

@@ -0,0 +1,7 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface ChainConsts extends GenericChainConsts {
+  {{{ defTypeOut }}}
+}

package/templates/errors.hbs

@@ -0,0 +1,7 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface ChainErrors extends GenericChainErrors {
+  {{{ defTypeOut }}}
+}

package/templates/events.hbs

@@ -0,0 +1,7 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface ChainEvents extends GenericChainEvents {
+  {{{ defTypeOut }}}
+}

package/templates/index.hbs

@@ -0,0 +1,22 @@
+// Generated by @dedot/codegen
+
+import { GenericSubstrateApi } from '@dedot/types';
+import { ChainConsts } from './consts';
+import { ChainStorage } from './query';
+import { RpcCalls } from './rpc';
+import { ChainErrors } from './errors';
+import { ChainEvents } from './events';
+import { RuntimeApis } from './runtime';
+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;
+}

package/templates/query.hbs

@@ -0,0 +1,7 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface ChainStorage extends GenericChainStorage {
+  {{{ defTypeOut }}}
+}

package/templates/rpc.hbs

@@ -0,0 +1,7 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface RpcCalls extends GenericRpcCalls {
+  {{{rpcCallsOut}}}
+}

package/templates/runtime.hbs

@@ -0,0 +1,8 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+export interface RuntimeApis extends GenericRuntimeApis {
+{{{ runtimeCallsOut }}}
+}
+

package/templates/tx.hbs

@@ -0,0 +1,9 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+{{{ defTypes }}}
+
+export interface ChainTx extends GenericChainTx<TxCall> {
+  {{{ txDefsOut }}}
+}

package/templates/types.hbs

@@ -0,0 +1,5 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+{{{ defTypeOut }}}

package/cjs/genSupportedChainTypes.js

@@ -1,79 +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: '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.CodecRegistry(metadata.latest);
-    const executor = new dedot_1.ConstantExecutor({
-        registry,
-        metadataLatest: metadata.latest,
-    });
-    return executor.execute('system', 'version');
-};
-run().catch(console.log);

package/cjs/packageInfo.js

@@ -1,5 +0,0 @@
-"use strict";
-// THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.packageInfo = void 0;
-exports.packageInfo = { name: '@dedot/codegen', version: '0.0.1-alpha.23' };

package/genSupportedChainTypes.d.ts

@@ -1 +0,0 @@
-export {};

package/genSupportedChainTypes.js

@@ -1,74 +0,0 @@
-import { generateTypes, generateTypesFromChain } from './index';
-import { rpc } from '@polkadot/types-support/metadata/static-substrate';
-import staticSubstrate from '@polkadot/types-support/metadata/v15/substrate-hex';
-import { $Metadata, CodecRegistry } from '@dedot/codecs';
-import { ConstantExecutor } from 'dedot';
-const NETWORKS = [
-    {
-        chain: 'substrate',
-        metadataHex: staticSubstrate,
-        rpcMethods: 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: '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 generateTypesFromChain(network, endpoint, OUT_DIR);
-        }
-        else if (metadataHex && rpcMethods) {
-            console.log(`Generate types for ${chain} via raw data`);
-            const metadata = $Metadata.tryDecode(metadataHex);
-            const runtimeVersion = getRuntimeVersion(metadata);
-            await generateTypes(network, metadata.latest, rpcMethods, runtimeVersion.apis, OUT_DIR);
-        }
-    }
-    console.log('DONE!');
-}
-const getRuntimeVersion = (metadata) => {
-    const registry = new CodecRegistry(metadata.latest);
-    const executor = new ConstantExecutor({
-        registry,
-        metadataLatest: metadata.latest,
-    });
-    return executor.execute('system', 'version');
-};
-run().catch(console.log);

package/packageInfo.d.ts

@@ -1,4 +0,0 @@
-export declare const packageInfo: {
-    name: string;
-    version: string;
-};

package/packageInfo.js

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

package/types.d.ts

@@ -1,6 +0,0 @@
-export type NetworkInfo = {
-    chain: string;
-    endpoint?: string;
-    metadataHex?: string;
-    rpcMethods?: string[];
-};

package/types.js

@@ -1 +0,0 @@
-export {};