@dedot/codegen 0.0.1-alpha.30 → 0.0.1-alpha.32

package/cjs/index.js

@@ -24,53 +24,54 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateTypes = exports.generateTypesFromEndpoint = void 0;
-const dedot_1 = require("dedot");
+const api_1 = require("@dedot/api");
+const providers_1 = require("@dedot/providers");
+const utils_1 = require("@dedot/utils");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const index_js_1 = require("./generator/index.js");
-const utils_1 = require("@dedot/utils");
-async function generateTypesFromEndpoint(chain, endpoint, outDir) {
-    const api = await dedot_1.Dedot.new(endpoint);
-    const { methods } = await api.rpc.rpc.methods();
-    const apis = api.runtimeVersion?.apis || [];
+async function generateTypesFromEndpoint(chain, endpoint, outDir, extension = 'd.ts', useSubPaths = false) {
+    const api = await api_1.Dedot.new(new providers_1.WsProvider(endpoint));
+    const { methods } = await api.rpc.rpc_methods();
+    const apis = api.runtimeVersion.apis || {};
     if (!chain) {
-        chain = (0, utils_1.stringCamelCase)(api.runtimeVersion?.specName || api.runtimeChain || 'local');
+        chain = (0, utils_1.stringCamelCase)(api.runtimeVersion.specName || 'local');
     }
-    await generateTypes(chain, api.metadataLatest, methods, apis, outDir);
+    await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension, useSubPaths);
     await api.disconnect();
 }
 exports.generateTypesFromEndpoint = generateTypesFromEndpoint;
-async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.') {
+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.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`);
+    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 index_js_1.TypesGen(metadata);
     const constsGen = new index_js_1.ConstsGen(typesGen);
     const queryGen = new index_js_1.QueryGen(typesGen);
-    const rpcGen = new index_js_1.RpcGen(typesGen, rpcMethods);
+    const jsonRpcGen = new index_js_1.JsonRpcGen(typesGen, rpcMethods);
     const indexGen = new index_js_1.IndexGen(chain);
     const errorsGen = new index_js_1.ErrorsGen(typesGen);
     const eventsGen = new index_js_1.EventsGen(typesGen);
     const runtimeApisGen = new index_js_1.RuntimeApisGen(typesGen, runtimeApis);
     const txGen = new index_js_1.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));
 }
 exports.generateTypes = generateTypes;

package/cjs/templates/consts.hbs

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

package/cjs/templates/errors.hbs

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

package/cjs/templates/events.hbs

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

package/cjs/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/cjs/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/cjs/templates/query.hbs

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

package/cjs/templates/runtime.hbs

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

package/cjs/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/generator/ApiGen.d.ts

@@ -1,4 +1,4 @@
-import { TypesGen } from '../generator/index.js';
+import { TypesGen } from './TypesGen.js';
 export declare abstract class ApiGen {
     readonly typesGen: TypesGen;
     constructor(typesGen: TypesGen);

package/generator/ConstsGen.d.ts

@@ -1,4 +1,4 @@
-import { ApiGen } from '../generator/index.js';
+import { ApiGen } from './ApiGen.js';
 export declare class ConstsGen extends ApiGen {
-    generate(): Promise<string>;
+    generate(useSubPaths?: boolean): Promise<string>;
 }

package/generator/ConstsGen.js

@@ -1,11 +1,11 @@
 import { normalizeName, stringCamelCase } from '@dedot/utils';
-import { ApiGen } from '../generator/index.js';
+import { ApiGen } from './ApiGen.js';
 import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
 export class ConstsGen extends ApiGen {
-    generate() {
+    generate(useSubPaths = false) {
         const { pallets } = this.metadata;
         this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericChainConsts');
+        this.typesGen.typeImports.addKnownType('GenericChainConsts', 'RpcVersion');
         let defTypeOut = '';
         for (let pallet of pallets) {
             const typedConstants = pallet.constants.map((one) => ({
@@ -20,7 +20,7 @@ export class ConstsGen extends ApiGen {
         ${commentBlock('Generic pallet constant')}[name: string]: any,
       },`;
         }
-        const importTypes = this.typesGen.typeImports.toImports();
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
         const template = compileTemplate('consts.hbs');
         return beautifySourceCode(template({ importTypes, defTypeOut }));
     }

package/generator/ErrorsGen.d.ts

@@ -1,5 +1,5 @@
 import { ApiGen } from './ApiGen.js';
 export declare class ErrorsGen extends ApiGen {
     #private;
-    generate(): Promise<string>;
+    generate(useSubPaths?: boolean): Promise<string>;
 }

package/generator/ErrorsGen.js

@@ -1,11 +1,11 @@
+import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
 import { ApiGen } from './ApiGen.js';
 import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
-import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
 export class ErrorsGen extends ApiGen {
-    generate() {
+    generate(useSubPaths = false) {
         const { pallets } = this.metadata;
         this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
+        this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError', 'RpcVersion');
         let defTypeOut = '';
         for (let pallet of pallets) {
             const errorTypeId = pallet.error;
@@ -16,13 +16,13 @@ export class ErrorsGen extends ApiGen {
             defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s errors`);
             defTypeOut += `${stringCamelCase(pallet.name)}: {
         ${errorDefs
-                .map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError`)
+                .map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError<Rv>`)
                 .join(',\n')}
           
-        ${commentBlock('Generic pallet error')}[error: string]: GenericPalletError,
+        ${commentBlock('Generic pallet error')}[error: string]: GenericPalletError<Rv>,
       },`;
         }
-        const importTypes = this.typesGen.typeImports.toImports();
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
         const template = compileTemplate('errors.hbs');
         return beautifySourceCode(template({ importTypes, defTypeOut }));
     }

package/generator/EventsGen.d.ts

@@ -1,5 +1,5 @@
 import { ApiGen } from './ApiGen.js';
 export declare class EventsGen extends ApiGen {
     #private;
-    generate(): Promise<string>;
+    generate(useSubPaths?: boolean): Promise<string>;
 }

package/generator/EventsGen.js

@@ -1,11 +1,11 @@
+import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
 import { ApiGen } from './ApiGen.js';
 import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
-import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
 export class EventsGen extends ApiGen {
-    generate() {
+    generate(useSubPaths = false) {
         const { pallets } = this.metadata;
         this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent');
+        this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent', 'RpcVersion');
         let defTypeOut = '';
         for (let pallet of pallets) {
             const eventTypeId = pallet.event;
@@ -28,13 +28,13 @@ export class EventsGen extends ApiGen {
                 }
                 return { ...def, genericParts };
             })
-                .map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent<${genericParts.join(', ')}>`)
+                .map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent<Rv, ${genericParts.join(', ')}>`)
                 .join(',\n')}
           
-        ${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent,
+        ${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent<Rv>,
       },`;
         }
-        const importTypes = this.typesGen.typeImports.toImports();
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
         const template = compileTemplate('events.hbs');
         return beautifySourceCode(template({ importTypes, defTypeOut }));
     }

package/generator/IndexGen.d.ts

@@ -1,5 +1,5 @@
 export declare class IndexGen {
     readonly chain: string;
     constructor(chain: string);
-    generate(): Promise<string>;
+    generate(useSubPaths?: boolean): Promise<string>;
 }

package/generator/IndexGen.js

@@ -1,13 +1,17 @@
-import { beautifySourceCode, compileTemplate } from './utils.js';
 import { stringPascalCase } from '@dedot/utils';
+import { TypeImports } from './TypeImports.js';
+import { beautifySourceCode, compileTemplate } from './utils.js';
 export class IndexGen {
     chain;
     constructor(chain) {
         this.chain = chain;
     }
-    async generate() {
+    async generate(useSubPaths = false) {
         const interfaceName = stringPascalCase(this.chain);
+        const typeImports = new TypeImports();
+        typeImports.addKnownType('GenericSubstrateApi', 'RpcLegacy', 'RpcV2', 'RpcVersion');
+        const importTypes = typeImports.toImports({ useSubPaths });
         const template = compileTemplate('index.hbs');
-        return beautifySourceCode(template({ interfaceName }));
+        return beautifySourceCode(template({ importTypes, interfaceName }));
     }
 }

package/generator/JsonRpcGen.d.ts

@@ -0,0 +1,8 @@
+import { ApiGen } from './ApiGen.js';
+import { TypesGen } from './TypesGen.js';
+export declare class JsonRpcGen extends ApiGen {
+    readonly typesGen: TypesGen;
+    readonly rpcMethods: string[];
+    constructor(typesGen: TypesGen, rpcMethods: string[]);
+    generate(useSubPaths?: boolean): Promise<string>;
+}

package/generator/JsonRpcGen.js

@@ -0,0 +1,55 @@
+import { subscriptionsInfo } from '@dedot/api';
+import { ApiGen } from './ApiGen.js';
+import { beautifySourceCode, compileTemplate } from './utils.js';
+const HIDDEN_RPCS = [
+    // Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
+    'rpc_methods',
+];
+const ALIAS_RPCS = [
+    // TODO include these into the specs
+    'account_nextIndex',
+    'system_dryRunAt',
+    'state_callAt',
+    'state_getKeysPagedAt',
+    'state_getStorageAt',
+    'state_getStorageHashAt',
+    'state_getStorageSizeAt',
+    'chain_getRuntimeVersion',
+    'chain_getHead',
+    'chain_getFinalisedHead',
+    'childstate_getKeysPagedAt',
+    // Subscription pairs
+    'chain_subscribeRuntimeVersion',
+    'chain_unsubscribeRuntimeVersion',
+    'chain_unsubscribeNewHead',
+    'chain_subscribeNewHead',
+    'subscribe_newHead',
+    'unsubscribe_newHead',
+    'chain_subscribeFinalisedHeads',
+    'chain_unsubscribeFinalisedHeads',
+];
+export class JsonRpcGen 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(useSubPaths = false) {
+        this.typesGen.clearCache();
+        this.typesGen.typeImports.addKnownType('GenericJsonRpcApis', 'RpcVersion');
+        this.typesGen.typeImports.addKnownJsonRpcType('JsonRpcApis');
+        const toExclude = Object.values(subscriptionsInfo).flat();
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
+        const template = compileTemplate('json-rpc.hbs');
+        const jsonRpcMethods = this.rpcMethods
+            .filter((one) => !ALIAS_RPCS.includes(one)) // exclude alias rpcs
+            .filter((one) => !toExclude.includes(one)) // exclude unsubscribe methods
+            .map((one) => `'${one}'`)
+            .join(' | ');
+        return beautifySourceCode(template({ importTypes, jsonRpcMethods }));
+    }
+}

package/generator/QueryGen.d.ts

@@ -1,5 +1,5 @@
-import { ApiGen } from '../generator/index.js';
+import { ApiGen } from './ApiGen.js';
 export declare class QueryGen extends ApiGen {
     #private;
-    generate(): Promise<string>;
+    generate(useSubPaths?: boolean): Promise<string>;
 }

package/generator/QueryGen.js

@@ -1,38 +1,46 @@
 import { normalizeName, stringCamelCase } from '@dedot/utils';
-import { ApiGen } from '../generator/index.js';
+import { ApiGen } from './ApiGen.js';
 import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
 export class QueryGen extends ApiGen {
-    generate() {
+    generate(useSubPaths = false) {
         const { pallets } = this.metadata;
         this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
+        this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback', 'RpcVersion');
         let defTypeOut = '';
         for (let pallet of pallets) {
             const storage = pallet.storage;
             if (!storage)
                 continue;
             const queries = storage.entries.map((one) => this.#generateEntry(one));
-            const queryDefs = queries.map(({ name, valueType, keyType, docs }) => `${commentBlock(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}>`);
+            const queryDefs = queries.map(({ name, valueType, keyType, docs, keyTypeOut }) => {
+                if (keyTypeOut) {
+                    return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}, ${keyTypeOut}>`;
+                }
+                else {
+                    return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}>`;
+                }
+            });
             defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s storage queries`);
             defTypeOut += `${stringCamelCase(pallet.name)}: {
         ${queryDefs.join(',\n')}
         
-        ${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery;
+        ${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery<Rv>;
       },`;
         }
-        const importTypes = this.typesGen.typeImports.toImports();
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
         const template = compileTemplate('query.hbs');
         return beautifySourceCode(template({ importTypes, defTypeOut }));
     }
     #generateEntry(entry) {
         const { name, type, docs, modifier } = entry;
-        let valueType, keyType;
+        let valueType, keyTypeOut, keyTypeIn;
         if (type.tag === 'Plain') {
             valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
         }
         else if (type.tag === 'Map') {
             valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
-            keyType = this.typesGen.generateType(type.value.keyTypeId, 1);
+            keyTypeOut = this.typesGen.generateType(type.value.keyTypeId, 1, true);
+            keyTypeIn = this.typesGen.generateType(type.value.keyTypeId, 1);
         }
         else {
             throw Error('Invalid entry type!');
@@ -40,14 +48,15 @@ export class QueryGen extends ApiGen {
         const isOptional = modifier === 'Optional';
         valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
         docs.push('\n');
-        if (keyType) {
-            docs.push(`@param {${keyType}} arg`);
+        if (keyTypeIn) {
+            docs.push(`@param {${keyTypeIn}} arg`);
         }
         docs.push(`@param {Callback<${valueType}> =} callback`);
         return {
             name: normalizeName(name),
             valueType,
-            keyType: keyType ? `arg: ${keyType}` : '',
+            keyType: keyTypeIn ? `arg: ${keyTypeIn}` : '',
+            keyTypeOut,
             docs,
         };
     }

package/generator/RuntimeApisGen.d.ts

@@ -1,9 +1,9 @@
+import { ApiGen } from './ApiGen.js';
 import { TypesGen } from './TypesGen.js';
-import { RpcGen } from './RpcGen.js';
-export declare class RuntimeApisGen extends RpcGen {
+export declare class RuntimeApisGen extends ApiGen {
     #private;
     readonly typesGen: TypesGen;
-    readonly runtimeApis: [string, number][];
-    constructor(typesGen: TypesGen, runtimeApis: [string, number][]);
-    generate(): Promise<string>;
+    readonly runtimeApis: Record<string, number>;
+    constructor(typesGen: TypesGen, runtimeApis: Record<string, number>);
+    generate(useSubPaths?: boolean): Promise<string>;
 }