@dedot/codegen 0.0.1-next.3 → 0.0.1-next.3662494a.39

package/cjs/generator/RpcGen.js

@@ -1,175 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RpcGen = void 0;
-const specs_1 = require("@dedot/specs");
-const utils_1 = require("@dedot/utils");
-const generator_1 = require("../generator");
-const utils_2 = require("./utils");
-const HIDDEN_RPCS = [
-    // Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
-    'rpc_methods',
-];
-class RpcGen extends generator_1.ApiGen {
-    typesGen;
-    rpcMethods;
-    constructor(typesGen, rpcMethods) {
-        super(typesGen);
-        this.typesGen = typesGen;
-        this.rpcMethods = rpcMethods;
-        HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
-        rpcMethods.sort();
-    }
-    generate() {
-        this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericRpcCalls', 'Unsub', 'Callback', 'GenericRpcCall');
-        const specsByModule = this.rpcMethods
-            .filter((one) => !(0, specs_1.findAliasRpcSpec)(one)) // we'll ignore  alias rpc for now if defined in the specs! TODO should we generate alias rpc as well?
-            .filter((one) => !(0, specs_1.isUnsubscribeMethod)(one)) // we'll ignore unsubscribe method as well
-            .map((one) => {
-            const spec = (0, specs_1.findRpcSpec)(one);
-            if (spec) {
-                return spec;
-            }
-            const [module, ...methodParts] = one.split('_');
-            const method = methodParts.join('_');
-            return {
-                params: [],
-                type: 'GenericRpcCall',
-                module,
-                method,
-            };
-        })
-            .reduce((o, spec) => {
-            const { module, method } = spec;
-            // ignore if rpc name does not confront with the general convention
-            if (!module || !method) {
-                return o;
-            }
-            return {
-                ...o,
-                [module]: o[module] ? [...o[module], spec] : [spec],
-            };
-        }, {});
-        let rpcCallsOut = '';
-        Object.keys(specsByModule).forEach((module) => {
-            const specs = specsByModule[module];
-            // TODO add alias info to docs block!
-            rpcCallsOut += `${module}: {
-      ${specs.map((spec) => this.#generateMethodDef(spec)).join(',\n')},
-
-      [method: string]: GenericRpcCall,
-    },`;
-        });
-        // TODO include & define external types
-        const importTypes = this.typesGen.typeImports.toImports();
-        const template = (0, utils_2.compileTemplate)('rpc.hbs');
-        return (0, utils_2.beautifySourceCode)(template({ importTypes, rpcCallsOut }));
-    }
-    #generateMethodDef(spec) {
-        const { name, type, module, method, docs = [], params, pubsub, deprecated } = spec;
-        const rpcName = name || `${module}_${method}`;
-        let defaultDocs = [`@rpcname: ${rpcName}`];
-        if (deprecated) {
-            defaultDocs.push(`@deprecated: ${deprecated}`);
-        }
-        if (type === 'GenericRpcCall' && params.length === 0) {
-            return `${(0, utils_2.commentBlock)(defaultDocs)}${method}: GenericRpcCall`;
-        }
-        this.addTypeImport(type, false);
-        params.forEach(({ type, isScale }) => {
-            this.addTypeImport(type, !!isScale);
-        });
-        const typedParams = params.map((param) => ({
-            ...param,
-            plainType: this.getGeneratedTypeName(param.type, !!param.isScale),
-        }));
-        const isSubscription = !!pubsub;
-        const paramsOut = typedParams.map(({ name, type, isOptional, isScale, plainType }) => `${name}${isOptional ? '?' : ''}: ${plainType}`);
-        const paramsDoc = typedParams.map(({ name, plainType }) => `@param {${plainType}} ${name}`);
-        const typeOut = this.getGeneratedTypeName(type, false);
-        if (isSubscription) {
-            defaultDocs.shift();
-            defaultDocs.unshift(`@pubsub: ${pubsub?.join(', ')}`);
-            paramsOut.push(`callback: Callback<${typeOut}>`);
-            return `${(0, utils_2.commentBlock)(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
-        }
-        else {
-            return `${(0, utils_2.commentBlock)(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<${typeOut}>>`;
-        }
-    }
-    // TODO check typeIn, typeOut if param type, or rpc type isScale
-    addTypeImport(type, toTypeIn = true) {
-        if (Array.isArray(type)) {
-            type.forEach((one) => this.addTypeImport(one, toTypeIn));
-            return;
-        }
-        type = type.trim();
-        if ((0, utils_1.isNativeType)(type)) {
-            return;
-        }
-        // Handle generic wrapper types
-        const matchArray = type.match(utils_2.WRAPPER_TYPE_REGEX);
-        if (matchArray) {
-            const [_, $1, $2] = matchArray;
-            this.addTypeImport($1, toTypeIn);
-            if ($2.match(utils_2.WRAPPER_TYPE_REGEX) || $2.match(utils_2.TUPLE_TYPE_REGEX)) {
-                this.addTypeImport($2, toTypeIn);
-            }
-            else {
-                this.addTypeImport($2.split(','), toTypeIn);
-            }
-            return;
-        }
-        // Check tuple type
-        if (type.match(utils_2.TUPLE_TYPE_REGEX)) {
-            this.addTypeImport(type.slice(1, -1).split(','), toTypeIn);
-            return;
-        }
-        if (type.includes(' | ')) {
-            this.addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
-            return;
-        }
-        try {
-            const codecType = this.#getCodecType(type, toTypeIn);
-            if ((0, utils_1.isNativeType)(codecType))
-                return;
-            this.typesGen.typeImports.addCodecType(codecType);
-            return;
-        }
-        catch (e) { }
-        this.typesGen.addTypeImport(type);
-    }
-    getGeneratedTypeName(type, toTypeIn = true) {
-        try {
-            const matchArray = type.match(utils_2.WRAPPER_TYPE_REGEX);
-            if (matchArray) {
-                const [_, $1, $2] = matchArray;
-                const wrapperTypeName = this.#getCodecType($1, toTypeIn);
-                if ($2.match(utils_2.WRAPPER_TYPE_REGEX) || $2.match(utils_2.TUPLE_TYPE_REGEX)) {
-                    return `${wrapperTypeName}<${this.getGeneratedTypeName($2, toTypeIn)}>`;
-                }
-                const innerTypeNames = $2
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `${wrapperTypeName}<${innerTypeNames}>`;
-            }
-            else if (type.match(utils_2.TUPLE_TYPE_REGEX)) {
-                const innerTypeNames = type
-                    .slice(1, -1)
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `[${innerTypeNames}]`;
-            }
-            return this.#getCodecType(type, toTypeIn);
-        }
-        catch (e) { }
-        return type;
-    }
-    #getCodecType(type, toTypeIn = true) {
-        const { typeIn, typeOut } = this.registry.findCodecType(type);
-        return toTypeIn ? typeIn : typeOut;
-    }
-}
-exports.RpcGen = RpcGen;

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.25' };

package/cjs/templates/rpc.hbs

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

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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/generator/RpcGen.d.ts

@@ -1,10 +0,0 @@
-import { ApiGen, TypesGen } from '../generator';
-export declare class RpcGen extends ApiGen {
-    #private;
-    readonly typesGen: TypesGen;
-    readonly rpcMethods: string[];
-    constructor(typesGen: TypesGen, rpcMethods: string[]);
-    generate(): Promise<string>;
-    addTypeImport(type: string | string[], toTypeIn?: boolean): void;
-    getGeneratedTypeName(type: string, toTypeIn?: boolean): string;
-}

package/generator/RpcGen.js

@@ -1,171 +0,0 @@
-import { findAliasRpcSpec, findRpcSpec, isUnsubscribeMethod } from '@dedot/specs';
-import { isNativeType } from '@dedot/utils';
-import { ApiGen } from '../generator';
-import { beautifySourceCode, commentBlock, compileTemplate, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX } from './utils';
-const HIDDEN_RPCS = [
-    // Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
-    'rpc_methods',
-];
-export class RpcGen extends ApiGen {
-    typesGen;
-    rpcMethods;
-    constructor(typesGen, rpcMethods) {
-        super(typesGen);
-        this.typesGen = typesGen;
-        this.rpcMethods = rpcMethods;
-        HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
-        rpcMethods.sort();
-    }
-    generate() {
-        this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericRpcCalls', 'Unsub', 'Callback', 'GenericRpcCall');
-        const specsByModule = this.rpcMethods
-            .filter((one) => !findAliasRpcSpec(one)) // we'll ignore  alias rpc for now if defined in the specs! TODO should we generate alias rpc as well?
-            .filter((one) => !isUnsubscribeMethod(one)) // we'll ignore unsubscribe method as well
-            .map((one) => {
-            const spec = findRpcSpec(one);
-            if (spec) {
-                return spec;
-            }
-            const [module, ...methodParts] = one.split('_');
-            const method = methodParts.join('_');
-            return {
-                params: [],
-                type: 'GenericRpcCall',
-                module,
-                method,
-            };
-        })
-            .reduce((o, spec) => {
-            const { module, method } = spec;
-            // ignore if rpc name does not confront with the general convention
-            if (!module || !method) {
-                return o;
-            }
-            return {
-                ...o,
-                [module]: o[module] ? [...o[module], spec] : [spec],
-            };
-        }, {});
-        let rpcCallsOut = '';
-        Object.keys(specsByModule).forEach((module) => {
-            const specs = specsByModule[module];
-            // TODO add alias info to docs block!
-            rpcCallsOut += `${module}: {
-      ${specs.map((spec) => this.#generateMethodDef(spec)).join(',\n')},
-
-      [method: string]: GenericRpcCall,
-    },`;
-        });
-        // TODO include & define external types
-        const importTypes = this.typesGen.typeImports.toImports();
-        const template = compileTemplate('rpc.hbs');
-        return beautifySourceCode(template({ importTypes, rpcCallsOut }));
-    }
-    #generateMethodDef(spec) {
-        const { name, type, module, method, docs = [], params, pubsub, deprecated } = spec;
-        const rpcName = name || `${module}_${method}`;
-        let defaultDocs = [`@rpcname: ${rpcName}`];
-        if (deprecated) {
-            defaultDocs.push(`@deprecated: ${deprecated}`);
-        }
-        if (type === 'GenericRpcCall' && params.length === 0) {
-            return `${commentBlock(defaultDocs)}${method}: GenericRpcCall`;
-        }
-        this.addTypeImport(type, false);
-        params.forEach(({ type, isScale }) => {
-            this.addTypeImport(type, !!isScale);
-        });
-        const typedParams = params.map((param) => ({
-            ...param,
-            plainType: this.getGeneratedTypeName(param.type, !!param.isScale),
-        }));
-        const isSubscription = !!pubsub;
-        const paramsOut = typedParams.map(({ name, type, isOptional, isScale, plainType }) => `${name}${isOptional ? '?' : ''}: ${plainType}`);
-        const paramsDoc = typedParams.map(({ name, plainType }) => `@param {${plainType}} ${name}`);
-        const typeOut = this.getGeneratedTypeName(type, false);
-        if (isSubscription) {
-            defaultDocs.shift();
-            defaultDocs.unshift(`@pubsub: ${pubsub?.join(', ')}`);
-            paramsOut.push(`callback: Callback<${typeOut}>`);
-            return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
-        }
-        else {
-            return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<${typeOut}>>`;
-        }
-    }
-    // TODO check typeIn, typeOut if param type, or rpc type isScale
-    addTypeImport(type, toTypeIn = true) {
-        if (Array.isArray(type)) {
-            type.forEach((one) => this.addTypeImport(one, toTypeIn));
-            return;
-        }
-        type = type.trim();
-        if (isNativeType(type)) {
-            return;
-        }
-        // Handle generic wrapper types
-        const matchArray = type.match(WRAPPER_TYPE_REGEX);
-        if (matchArray) {
-            const [_, $1, $2] = matchArray;
-            this.addTypeImport($1, toTypeIn);
-            if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
-                this.addTypeImport($2, toTypeIn);
-            }
-            else {
-                this.addTypeImport($2.split(','), toTypeIn);
-            }
-            return;
-        }
-        // Check tuple type
-        if (type.match(TUPLE_TYPE_REGEX)) {
-            this.addTypeImport(type.slice(1, -1).split(','), toTypeIn);
-            return;
-        }
-        if (type.includes(' | ')) {
-            this.addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
-            return;
-        }
-        try {
-            const codecType = this.#getCodecType(type, toTypeIn);
-            if (isNativeType(codecType))
-                return;
-            this.typesGen.typeImports.addCodecType(codecType);
-            return;
-        }
-        catch (e) { }
-        this.typesGen.addTypeImport(type);
-    }
-    getGeneratedTypeName(type, toTypeIn = true) {
-        try {
-            const matchArray = type.match(WRAPPER_TYPE_REGEX);
-            if (matchArray) {
-                const [_, $1, $2] = matchArray;
-                const wrapperTypeName = this.#getCodecType($1, toTypeIn);
-                if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
-                    return `${wrapperTypeName}<${this.getGeneratedTypeName($2, toTypeIn)}>`;
-                }
-                const innerTypeNames = $2
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `${wrapperTypeName}<${innerTypeNames}>`;
-            }
-            else if (type.match(TUPLE_TYPE_REGEX)) {
-                const innerTypeNames = type
-                    .slice(1, -1)
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `[${innerTypeNames}]`;
-            }
-            return this.#getCodecType(type, toTypeIn);
-        }
-        catch (e) { }
-        return type;
-    }
-    #getCodecType(type, toTypeIn = true) {
-        const { typeIn, typeOut } = this.registry.findCodecType(type);
-        return toTypeIn ? typeIn : typeOut;
-    }
-}

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.25' };

package/templates/rpc.hbs

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

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 {};