@dedot/codegen 0.0.1-next.70fc26c6.11 → 0.0.1-next.714802d9.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/generator/ConstsGen.js +3 -3
- package/cjs/generator/ErrorsGen.js +4 -4
- package/cjs/generator/EventsGen.js +4 -4
- package/cjs/generator/IndexGen.js +1 -1
- package/cjs/generator/JsonRpcGen.js +59 -0
- package/cjs/generator/QueryGen.js +19 -10
- package/cjs/generator/RuntimeApisGen.js +91 -16
- package/cjs/generator/TxGen.js +9 -7
- package/cjs/generator/TypeImports.js +8 -0
- package/cjs/generator/TypesGen.js +2 -8
- package/cjs/generator/index.js +1 -1
- package/cjs/generator/known-codecs.js +1 -1
- package/cjs/index.js +19 -19
- package/cjs/templates/consts.hbs +1 -1
- package/cjs/templates/errors.hbs +1 -1
- package/cjs/templates/events.hbs +1 -1
- package/cjs/templates/index.hbs +15 -10
- package/cjs/templates/json-rpc.hbs +5 -0
- package/cjs/templates/query.hbs +1 -1
- package/cjs/templates/runtime.hbs +1 -1
- package/cjs/templates/tx.hbs +1 -1
- package/generator/ApiGen.d.ts +3 -3
- package/generator/ConstsGen.d.ts +1 -1
- package/generator/ConstsGen.js +2 -2
- package/generator/ErrorsGen.js +4 -4
- package/generator/EventsGen.js +4 -4
- package/generator/IndexGen.js +1 -1
- package/generator/{RpcGen.d.ts → JsonRpcGen.d.ts} +1 -4
- package/generator/JsonRpcGen.js +55 -0
- package/generator/QueryGen.d.ts +1 -1
- package/generator/QueryGen.js +18 -9
- package/generator/RuntimeApisGen.d.ts +4 -4
- package/generator/RuntimeApisGen.js +91 -16
- package/generator/TxGen.js +9 -7
- package/generator/TypeImports.d.ts +2 -0
- package/generator/TypeImports.js +8 -0
- package/generator/TypesGen.d.ts +1 -1
- package/generator/TypesGen.js +2 -8
- package/generator/index.d.ts +1 -1
- package/generator/index.js +1 -1
- package/generator/known-codecs.js +1 -1
- package/index.d.ts +2 -2
- package/index.js +21 -21
- package/package.json +11 -15
- package/templates/consts.hbs +1 -1
- package/templates/errors.hbs +1 -1
- package/templates/events.hbs +1 -1
- package/templates/index.hbs +15 -10
- package/templates/json-rpc.hbs +5 -0
- package/templates/query.hbs +1 -1
- package/templates/runtime.hbs +1 -1
- package/templates/tx.hbs +1 -1
- package/cjs/generator/RpcGen.js +0 -175
- package/cjs/generator/known-types.js +0 -33
- package/cjs/packageInfo.js +0 -5
- package/cjs/templates/rpc.hbs +0 -7
- package/generator/RpcGen.js +0 -171
- package/generator/known-types.d.ts +0 -6
- package/generator/known-types.js +0 -30
- package/packageInfo.d.ts +0 -4
- package/packageInfo.js +0 -2
- package/templates/rpc.hbs +0 -7
package/generator/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ export * from './TypesGen.js';
|
|
|
2
2
|
export * from './ApiGen.js';
|
|
3
3
|
export * from './ConstsGen.js';
|
|
4
4
|
export * from './QueryGen.js';
|
|
5
|
-
export * from './
|
|
5
|
+
export * from './JsonRpcGen.js';
|
|
6
6
|
export * from './IndexGen.js';
|
|
7
7
|
export * from './ErrorsGen.js';
|
|
8
8
|
export * from './EventsGen.js';
|
package/generator/index.js
CHANGED
|
@@ -2,7 +2,7 @@ export * from './TypesGen.js';
|
|
|
2
2
|
export * from './ApiGen.js';
|
|
3
3
|
export * from './ConstsGen.js';
|
|
4
4
|
export * from './QueryGen.js';
|
|
5
|
-
export * from './
|
|
5
|
+
export * from './JsonRpcGen.js';
|
|
6
6
|
export * from './IndexGen.js';
|
|
7
7
|
export * from './ErrorsGen.js';
|
|
8
8
|
export * from './EventsGen.js';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import * as $ from '@dedot/shape';
|
|
2
1
|
import * as Codecs from '@dedot/codecs';
|
|
3
2
|
import { $AccountId20, $AccountId32, $Bytes, $ConsensusEngineId, $Era, $EthereumAddress, $MultiAddress, $OpaqueExtrinsic, $PrefixedStorageKey, $RawBytes, $StorageData, $StorageKey, $UncheckedExtrinsic, } from '@dedot/codecs';
|
|
3
|
+
import * as $ from '@dedot/shape';
|
|
4
4
|
import { assert } from '@dedot/utils';
|
|
5
5
|
export const normalizeCodecName = (name) => {
|
|
6
6
|
return name.startsWith('$') ? name : `$${name}`;
|
package/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import { MetadataLatest } from '@dedot/codecs';
|
|
2
|
-
export declare function generateTypesFromEndpoint(chain: string, endpoint: string, outDir?: string): Promise<void>;
|
|
3
|
-
export declare function generateTypes(chain: string, metadata: MetadataLatest, rpcMethods: string[], runtimeApis:
|
|
2
|
+
export declare function generateTypesFromEndpoint(chain: string, endpoint: string, outDir?: string, extension?: string): Promise<void>;
|
|
3
|
+
export declare function generateTypes(chain: string, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: Record<string, number>, outDir?: string, extension?: string): Promise<void>;
|
package/index.js
CHANGED
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { stringCamelCase } from '@dedot/utils';
|
|
2
|
+
import { Dedot, WsProvider } from 'dedot';
|
|
2
3
|
import * as fs from 'fs';
|
|
3
4
|
import * as path from 'path';
|
|
4
|
-
import { ConstsGen, ErrorsGen, EventsGen, IndexGen, QueryGen,
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
const
|
|
8
|
-
const
|
|
9
|
-
const apis = api.runtimeVersion?.apis || [];
|
|
5
|
+
import { ConstsGen, ErrorsGen, EventsGen, IndexGen, QueryGen, JsonRpcGen, RuntimeApisGen, TxGen, TypesGen, } from './generator/index.js';
|
|
6
|
+
export async function generateTypesFromEndpoint(chain, endpoint, outDir, extension = 'd.ts') {
|
|
7
|
+
const api = await Dedot.new(new WsProvider(endpoint));
|
|
8
|
+
const { methods } = await api.rpc.rpc_methods();
|
|
9
|
+
const apis = api.runtimeVersion.apis || {};
|
|
10
10
|
if (!chain) {
|
|
11
|
-
chain = stringCamelCase(api.runtimeVersion
|
|
11
|
+
chain = stringCamelCase(api.runtimeVersion.specName || 'local');
|
|
12
12
|
}
|
|
13
|
-
await generateTypes(chain, api.
|
|
13
|
+
await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension);
|
|
14
14
|
await api.disconnect();
|
|
15
15
|
}
|
|
16
|
-
export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.') {
|
|
16
|
+
export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.', extension = 'd.ts') {
|
|
17
17
|
const dirPath = path.resolve(outDir, chain);
|
|
18
|
-
const defTypesFileName = path.join(dirPath, `types
|
|
19
|
-
const constsTypesFileName = path.join(dirPath, `consts
|
|
20
|
-
const queryTypesFileName = path.join(dirPath, `query
|
|
21
|
-
const
|
|
22
|
-
const indexFileName = path.join(dirPath, `index
|
|
23
|
-
const errorsFileName = path.join(dirPath, `errors
|
|
24
|
-
const eventsFileName = path.join(dirPath, `events
|
|
25
|
-
const runtimeApisFileName = path.join(dirPath, `runtime
|
|
26
|
-
const txFileName = path.join(dirPath, `tx
|
|
18
|
+
const defTypesFileName = path.join(dirPath, `types.${extension}`);
|
|
19
|
+
const constsTypesFileName = path.join(dirPath, `consts.${extension}`);
|
|
20
|
+
const queryTypesFileName = path.join(dirPath, `query.${extension}`);
|
|
21
|
+
const jsonRpcFileName = path.join(dirPath, `json-rpc.${extension}`);
|
|
22
|
+
const indexFileName = path.join(dirPath, `index.${extension}`);
|
|
23
|
+
const errorsFileName = path.join(dirPath, `errors.${extension}`);
|
|
24
|
+
const eventsFileName = path.join(dirPath, `events.${extension}`);
|
|
25
|
+
const runtimeApisFileName = path.join(dirPath, `runtime.${extension}`);
|
|
26
|
+
const txFileName = path.join(dirPath, `tx.${extension}`);
|
|
27
27
|
if (!fs.existsSync(dirPath)) {
|
|
28
28
|
fs.mkdirSync(dirPath, { recursive: true });
|
|
29
29
|
}
|
|
30
30
|
const typesGen = new TypesGen(metadata);
|
|
31
31
|
const constsGen = new ConstsGen(typesGen);
|
|
32
32
|
const queryGen = new QueryGen(typesGen);
|
|
33
|
-
const
|
|
33
|
+
const jsonRpcGen = new JsonRpcGen(typesGen, rpcMethods);
|
|
34
34
|
const indexGen = new IndexGen(chain);
|
|
35
35
|
const errorsGen = new ErrorsGen(typesGen);
|
|
36
36
|
const eventsGen = new EventsGen(typesGen);
|
|
@@ -39,7 +39,7 @@ export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, ou
|
|
|
39
39
|
fs.writeFileSync(defTypesFileName, await typesGen.generate());
|
|
40
40
|
fs.writeFileSync(errorsFileName, await errorsGen.generate());
|
|
41
41
|
fs.writeFileSync(eventsFileName, await eventsGen.generate());
|
|
42
|
-
fs.writeFileSync(
|
|
42
|
+
fs.writeFileSync(jsonRpcFileName, await jsonRpcGen.generate());
|
|
43
43
|
fs.writeFileSync(queryTypesFileName, await queryGen.generate());
|
|
44
44
|
fs.writeFileSync(constsTypesFileName, await constsGen.generate());
|
|
45
45
|
fs.writeFileSync(txFileName, await txGen.generate());
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dedot/codegen",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.714802d9.27+714802d",
|
|
4
4
|
"description": "Generate types",
|
|
5
5
|
"author": "Thang X. Vu <thang@coongcrafts.io>",
|
|
6
6
|
"homepage": "https://github.com/dedotdev/dedot/tree/main/packages/codegen",
|
|
@@ -18,11 +18,11 @@
|
|
|
18
18
|
"copy": "cp -R ./src/templates ./dist && cp -R ./src/templates ./dist/cjs"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@dedot/codecs": "0.0.1-next.
|
|
22
|
-
"@dedot/shape": "0.0.1-next.
|
|
23
|
-
"@dedot/specs": "0.0.1-next.
|
|
24
|
-
"@dedot/utils": "0.0.1-next.
|
|
25
|
-
"dedot": "0.0.1-next.
|
|
21
|
+
"@dedot/codecs": "0.0.1-next.714802d9.27+714802d",
|
|
22
|
+
"@dedot/shape": "0.0.1-next.714802d9.27+714802d",
|
|
23
|
+
"@dedot/specs": "0.0.1-next.714802d9.27+714802d",
|
|
24
|
+
"@dedot/utils": "0.0.1-next.714802d9.27+714802d",
|
|
25
|
+
"dedot": "0.0.1-next.714802d9.27+714802d",
|
|
26
26
|
"handlebars": "^4.7.8",
|
|
27
27
|
"prettier": "^3.0.3"
|
|
28
28
|
},
|
|
@@ -31,19 +31,15 @@
|
|
|
31
31
|
"directory": "dist"
|
|
32
32
|
},
|
|
33
33
|
"license": "Apache-2.0",
|
|
34
|
-
"gitHead": "
|
|
34
|
+
"gitHead": "714802d9783ae65d36af3c59307bf9a4c9636e41",
|
|
35
35
|
"module": "./index.js",
|
|
36
36
|
"types": "./index.d.ts",
|
|
37
37
|
"exports": {
|
|
38
38
|
".": {
|
|
39
|
-
"
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
"require": {
|
|
44
|
-
"types": "./index.d.ts",
|
|
45
|
-
"default": "./cjs/index.js"
|
|
46
|
-
}
|
|
39
|
+
"types": "./index.d.ts",
|
|
40
|
+
"import": "./index.js",
|
|
41
|
+
"require": "./cjs/index.js",
|
|
42
|
+
"default": "./index.js"
|
|
47
43
|
}
|
|
48
44
|
}
|
|
49
45
|
}
|
package/templates/consts.hbs
CHANGED
package/templates/errors.hbs
CHANGED
package/templates/events.hbs
CHANGED
package/templates/index.hbs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
// Generated by @dedot/codegen
|
|
2
2
|
|
|
3
|
-
import { GenericSubstrateApi } from '@dedot/types';
|
|
3
|
+
import { GenericSubstrateApi, RpcLegacy, RpcV2, RpcVersion } from '@dedot/types';
|
|
4
4
|
import { ChainConsts } from './consts';
|
|
5
5
|
import { ChainStorage } from './query';
|
|
6
|
-
import {
|
|
6
|
+
import { ChainJsonRpcApis } from './json-rpc';
|
|
7
7
|
import { ChainErrors } from './errors';
|
|
8
8
|
import { ChainEvents } from './events';
|
|
9
9
|
import { RuntimeApis } from './runtime';
|
|
@@ -11,12 +11,17 @@ import { ChainTx } from './tx';
|
|
|
11
11
|
|
|
12
12
|
export * from './types';
|
|
13
13
|
|
|
14
|
-
export interface {{{interfaceName}}}Api extends GenericSubstrateApi {
|
|
15
|
-
rpc:
|
|
16
|
-
consts: ChainConsts
|
|
17
|
-
query: ChainStorage
|
|
18
|
-
errors: ChainErrors
|
|
19
|
-
events: ChainEvents
|
|
20
|
-
call: RuntimeApis
|
|
21
|
-
tx: ChainTx
|
|
14
|
+
export interface Versioned{{{interfaceName}}}Api<Rv extends RpcVersion> extends GenericSubstrateApi<Rv> {
|
|
15
|
+
rpc: ChainJsonRpcApis<Rv>;
|
|
16
|
+
consts: ChainConsts<Rv>;
|
|
17
|
+
query: ChainStorage<Rv>;
|
|
18
|
+
errors: ChainErrors<Rv>;
|
|
19
|
+
events: ChainEvents<Rv>;
|
|
20
|
+
call: RuntimeApis<Rv>;
|
|
21
|
+
tx: ChainTx<Rv>;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface {{{interfaceName}}}Api {
|
|
25
|
+
legacy: Versioned{{{interfaceName}}}Api<RpcLegacy>;
|
|
26
|
+
v2: Versioned{{{interfaceName}}}Api<RpcV2>;
|
|
22
27
|
}
|
package/templates/query.hbs
CHANGED
package/templates/runtime.hbs
CHANGED
package/templates/tx.hbs
CHANGED
package/cjs/generator/RpcGen.js
DELETED
|
@@ -1,175 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RpcGen = void 0;
|
|
4
|
-
const specs_1 = require("@dedot/specs");
|
|
5
|
-
const index_js_1 = require("../generator/index.js");
|
|
6
|
-
const utils_js_1 = require("./utils.js");
|
|
7
|
-
const known_codecs_js_1 = require("./known-codecs.js");
|
|
8
|
-
const HIDDEN_RPCS = [
|
|
9
|
-
// Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
|
|
10
|
-
'rpc_methods',
|
|
11
|
-
];
|
|
12
|
-
class RpcGen extends index_js_1.ApiGen {
|
|
13
|
-
typesGen;
|
|
14
|
-
rpcMethods;
|
|
15
|
-
constructor(typesGen, rpcMethods) {
|
|
16
|
-
super(typesGen);
|
|
17
|
-
this.typesGen = typesGen;
|
|
18
|
-
this.rpcMethods = rpcMethods;
|
|
19
|
-
HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
|
|
20
|
-
rpcMethods.sort();
|
|
21
|
-
}
|
|
22
|
-
generate() {
|
|
23
|
-
this.typesGen.clearCache();
|
|
24
|
-
this.typesGen.typeImports.addKnownType('GenericRpcCalls', 'Unsub', 'Callback', 'GenericRpcCall');
|
|
25
|
-
const specsByModule = this.rpcMethods
|
|
26
|
-
.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?
|
|
27
|
-
.filter((one) => !(0, specs_1.isUnsubscribeMethod)(one)) // we'll ignore unsubscribe method as well
|
|
28
|
-
.map((one) => {
|
|
29
|
-
const spec = (0, specs_1.findRpcSpec)(one);
|
|
30
|
-
if (spec) {
|
|
31
|
-
return spec;
|
|
32
|
-
}
|
|
33
|
-
const [module, ...methodParts] = one.split('_');
|
|
34
|
-
const method = methodParts.join('_');
|
|
35
|
-
return {
|
|
36
|
-
params: [],
|
|
37
|
-
type: 'GenericRpcCall',
|
|
38
|
-
module,
|
|
39
|
-
method,
|
|
40
|
-
};
|
|
41
|
-
})
|
|
42
|
-
.reduce((o, spec) => {
|
|
43
|
-
const { module, method } = spec;
|
|
44
|
-
// ignore if rpc name does not confront with the general convention
|
|
45
|
-
if (!module || !method) {
|
|
46
|
-
return o;
|
|
47
|
-
}
|
|
48
|
-
return {
|
|
49
|
-
...o,
|
|
50
|
-
[module]: o[module] ? [...o[module], spec] : [spec],
|
|
51
|
-
};
|
|
52
|
-
}, {});
|
|
53
|
-
let rpcCallsOut = '';
|
|
54
|
-
Object.keys(specsByModule).forEach((module) => {
|
|
55
|
-
const specs = specsByModule[module];
|
|
56
|
-
// TODO add alias info to docs block!
|
|
57
|
-
rpcCallsOut += `${module}: {
|
|
58
|
-
${specs.map((spec) => this.#generateMethodDef(spec)).join(',\n')},
|
|
59
|
-
|
|
60
|
-
[method: string]: GenericRpcCall,
|
|
61
|
-
},`;
|
|
62
|
-
});
|
|
63
|
-
// TODO include & define external types
|
|
64
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
65
|
-
const template = (0, utils_js_1.compileTemplate)('rpc.hbs');
|
|
66
|
-
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, rpcCallsOut }));
|
|
67
|
-
}
|
|
68
|
-
#generateMethodDef(spec) {
|
|
69
|
-
const { name, type, module, method, docs = [], params, pubsub, deprecated } = spec;
|
|
70
|
-
const rpcName = name || `${module}_${method}`;
|
|
71
|
-
let defaultDocs = [`@rpcname: ${rpcName}`];
|
|
72
|
-
if (deprecated) {
|
|
73
|
-
defaultDocs.push(`@deprecated: ${deprecated}`);
|
|
74
|
-
}
|
|
75
|
-
if (type === 'GenericRpcCall' && params.length === 0) {
|
|
76
|
-
return `${(0, utils_js_1.commentBlock)(defaultDocs)}${method}: GenericRpcCall`;
|
|
77
|
-
}
|
|
78
|
-
this.addTypeImport(type, false);
|
|
79
|
-
params.forEach(({ type, isScale }) => {
|
|
80
|
-
this.addTypeImport(type, !!isScale);
|
|
81
|
-
});
|
|
82
|
-
const typedParams = params.map((param) => ({
|
|
83
|
-
...param,
|
|
84
|
-
plainType: this.getGeneratedTypeName(param.type, !!param.isScale),
|
|
85
|
-
}));
|
|
86
|
-
const isSubscription = !!pubsub;
|
|
87
|
-
const paramsOut = typedParams.map(({ name, type, isOptional, isScale, plainType }) => `${name}${isOptional ? '?' : ''}: ${plainType}`);
|
|
88
|
-
const paramsDoc = typedParams.map(({ name, plainType }) => `@param {${plainType}} ${name}`);
|
|
89
|
-
const typeOut = this.getGeneratedTypeName(type, false);
|
|
90
|
-
if (isSubscription) {
|
|
91
|
-
defaultDocs.shift();
|
|
92
|
-
defaultDocs.unshift(`@pubsub: ${pubsub?.join(', ')}`);
|
|
93
|
-
paramsOut.push(`callback: Callback<${typeOut}>`);
|
|
94
|
-
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
|
|
95
|
-
}
|
|
96
|
-
else {
|
|
97
|
-
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<${typeOut}>>`;
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
// TODO check typeIn, typeOut if param type, or rpc type isScale
|
|
101
|
-
addTypeImport(type, toTypeIn = true) {
|
|
102
|
-
if (Array.isArray(type)) {
|
|
103
|
-
type.forEach((one) => this.addTypeImport(one, toTypeIn));
|
|
104
|
-
return;
|
|
105
|
-
}
|
|
106
|
-
type = type.trim();
|
|
107
|
-
if ((0, utils_js_1.isNativeType)(type)) {
|
|
108
|
-
return;
|
|
109
|
-
}
|
|
110
|
-
// Handle generic wrapper types
|
|
111
|
-
const matchArray = type.match(utils_js_1.WRAPPER_TYPE_REGEX);
|
|
112
|
-
if (matchArray) {
|
|
113
|
-
const [_, $1, $2] = matchArray;
|
|
114
|
-
this.addTypeImport($1, toTypeIn);
|
|
115
|
-
if ($2.match(utils_js_1.WRAPPER_TYPE_REGEX) || $2.match(utils_js_1.TUPLE_TYPE_REGEX)) {
|
|
116
|
-
this.addTypeImport($2, toTypeIn);
|
|
117
|
-
}
|
|
118
|
-
else {
|
|
119
|
-
this.addTypeImport($2.split(','), toTypeIn);
|
|
120
|
-
}
|
|
121
|
-
return;
|
|
122
|
-
}
|
|
123
|
-
// Check tuple type
|
|
124
|
-
if (type.match(utils_js_1.TUPLE_TYPE_REGEX)) {
|
|
125
|
-
this.addTypeImport(type.slice(1, -1).split(','), toTypeIn);
|
|
126
|
-
return;
|
|
127
|
-
}
|
|
128
|
-
if (type.includes(' | ')) {
|
|
129
|
-
this.addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
|
|
130
|
-
return;
|
|
131
|
-
}
|
|
132
|
-
try {
|
|
133
|
-
const codecType = this.#getCodecType(type, toTypeIn);
|
|
134
|
-
if ((0, utils_js_1.isNativeType)(codecType))
|
|
135
|
-
return;
|
|
136
|
-
this.typesGen.typeImports.addCodecType(codecType);
|
|
137
|
-
return;
|
|
138
|
-
}
|
|
139
|
-
catch (e) { }
|
|
140
|
-
this.typesGen.addTypeImport(type);
|
|
141
|
-
}
|
|
142
|
-
getGeneratedTypeName(type, toTypeIn = true) {
|
|
143
|
-
try {
|
|
144
|
-
const matchArray = type.match(utils_js_1.WRAPPER_TYPE_REGEX);
|
|
145
|
-
if (matchArray) {
|
|
146
|
-
const [_, $1, $2] = matchArray;
|
|
147
|
-
const wrapperTypeName = this.#getCodecType($1, toTypeIn);
|
|
148
|
-
if ($2.match(utils_js_1.WRAPPER_TYPE_REGEX) || $2.match(utils_js_1.TUPLE_TYPE_REGEX)) {
|
|
149
|
-
return `${wrapperTypeName}<${this.getGeneratedTypeName($2, toTypeIn)}>`;
|
|
150
|
-
}
|
|
151
|
-
const innerTypeNames = $2
|
|
152
|
-
.split(',')
|
|
153
|
-
.map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
|
|
154
|
-
.join(', ');
|
|
155
|
-
return `${wrapperTypeName}<${innerTypeNames}>`;
|
|
156
|
-
}
|
|
157
|
-
else if (type.match(utils_js_1.TUPLE_TYPE_REGEX)) {
|
|
158
|
-
const innerTypeNames = type
|
|
159
|
-
.slice(1, -1)
|
|
160
|
-
.split(',')
|
|
161
|
-
.map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
|
|
162
|
-
.join(', ');
|
|
163
|
-
return `[${innerTypeNames}]`;
|
|
164
|
-
}
|
|
165
|
-
return this.#getCodecType(type, toTypeIn);
|
|
166
|
-
}
|
|
167
|
-
catch (e) { }
|
|
168
|
-
return type;
|
|
169
|
-
}
|
|
170
|
-
#getCodecType(type, toTypeIn = true) {
|
|
171
|
-
const { typeIn, typeOut } = (0, known_codecs_js_1.findKnownCodecType)(type);
|
|
172
|
-
return toTypeIn ? typeIn : typeOut;
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
exports.RpcGen = RpcGen;
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.knownTypes = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* Known type names registered in @dedot/types
|
|
6
|
-
* Since TS interfaces are trim-off when compiling,
|
|
7
|
-
* So we need to register them explicitly here for RPC codegen process
|
|
8
|
-
*/
|
|
9
|
-
exports.knownTypes = [
|
|
10
|
-
'ExtrinsicOrHash',
|
|
11
|
-
'EpochAuthorship',
|
|
12
|
-
'BlockStats',
|
|
13
|
-
'Prevotes',
|
|
14
|
-
'Precommits',
|
|
15
|
-
'RoundState',
|
|
16
|
-
'ReportedRoundStates',
|
|
17
|
-
'JustificationNotification',
|
|
18
|
-
'EncodedFinalityProofs',
|
|
19
|
-
'LeavesProof',
|
|
20
|
-
'StorageKind',
|
|
21
|
-
'RpcMethods',
|
|
22
|
-
'ReadProof',
|
|
23
|
-
'StorageChangeSet',
|
|
24
|
-
'TraceBlockResponse',
|
|
25
|
-
'MigrationStatusResult',
|
|
26
|
-
'ChainType',
|
|
27
|
-
'ChainProperties',
|
|
28
|
-
'Health',
|
|
29
|
-
'SyncState',
|
|
30
|
-
'PeerInfo',
|
|
31
|
-
'NodeRole',
|
|
32
|
-
'NetworkState',
|
|
33
|
-
];
|
package/cjs/packageInfo.js
DELETED
package/cjs/templates/rpc.hbs
DELETED
package/generator/RpcGen.js
DELETED
|
@@ -1,171 +0,0 @@
|
|
|
1
|
-
import { findAliasRpcSpec, findRpcSpec, isUnsubscribeMethod } from '@dedot/specs';
|
|
2
|
-
import { ApiGen } from '../generator/index.js';
|
|
3
|
-
import { isNativeType, beautifySourceCode, commentBlock, compileTemplate, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX, } from './utils.js';
|
|
4
|
-
import { findKnownCodecType } from './known-codecs.js';
|
|
5
|
-
const HIDDEN_RPCS = [
|
|
6
|
-
// Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
|
|
7
|
-
'rpc_methods',
|
|
8
|
-
];
|
|
9
|
-
export class RpcGen extends ApiGen {
|
|
10
|
-
typesGen;
|
|
11
|
-
rpcMethods;
|
|
12
|
-
constructor(typesGen, rpcMethods) {
|
|
13
|
-
super(typesGen);
|
|
14
|
-
this.typesGen = typesGen;
|
|
15
|
-
this.rpcMethods = rpcMethods;
|
|
16
|
-
HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
|
|
17
|
-
rpcMethods.sort();
|
|
18
|
-
}
|
|
19
|
-
generate() {
|
|
20
|
-
this.typesGen.clearCache();
|
|
21
|
-
this.typesGen.typeImports.addKnownType('GenericRpcCalls', 'Unsub', 'Callback', 'GenericRpcCall');
|
|
22
|
-
const specsByModule = this.rpcMethods
|
|
23
|
-
.filter((one) => !findAliasRpcSpec(one)) // we'll ignore alias rpc for now if defined in the specs! TODO should we generate alias rpc as well?
|
|
24
|
-
.filter((one) => !isUnsubscribeMethod(one)) // we'll ignore unsubscribe method as well
|
|
25
|
-
.map((one) => {
|
|
26
|
-
const spec = findRpcSpec(one);
|
|
27
|
-
if (spec) {
|
|
28
|
-
return spec;
|
|
29
|
-
}
|
|
30
|
-
const [module, ...methodParts] = one.split('_');
|
|
31
|
-
const method = methodParts.join('_');
|
|
32
|
-
return {
|
|
33
|
-
params: [],
|
|
34
|
-
type: 'GenericRpcCall',
|
|
35
|
-
module,
|
|
36
|
-
method,
|
|
37
|
-
};
|
|
38
|
-
})
|
|
39
|
-
.reduce((o, spec) => {
|
|
40
|
-
const { module, method } = spec;
|
|
41
|
-
// ignore if rpc name does not confront with the general convention
|
|
42
|
-
if (!module || !method) {
|
|
43
|
-
return o;
|
|
44
|
-
}
|
|
45
|
-
return {
|
|
46
|
-
...o,
|
|
47
|
-
[module]: o[module] ? [...o[module], spec] : [spec],
|
|
48
|
-
};
|
|
49
|
-
}, {});
|
|
50
|
-
let rpcCallsOut = '';
|
|
51
|
-
Object.keys(specsByModule).forEach((module) => {
|
|
52
|
-
const specs = specsByModule[module];
|
|
53
|
-
// TODO add alias info to docs block!
|
|
54
|
-
rpcCallsOut += `${module}: {
|
|
55
|
-
${specs.map((spec) => this.#generateMethodDef(spec)).join(',\n')},
|
|
56
|
-
|
|
57
|
-
[method: string]: GenericRpcCall,
|
|
58
|
-
},`;
|
|
59
|
-
});
|
|
60
|
-
// TODO include & define external types
|
|
61
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
62
|
-
const template = compileTemplate('rpc.hbs');
|
|
63
|
-
return beautifySourceCode(template({ importTypes, rpcCallsOut }));
|
|
64
|
-
}
|
|
65
|
-
#generateMethodDef(spec) {
|
|
66
|
-
const { name, type, module, method, docs = [], params, pubsub, deprecated } = spec;
|
|
67
|
-
const rpcName = name || `${module}_${method}`;
|
|
68
|
-
let defaultDocs = [`@rpcname: ${rpcName}`];
|
|
69
|
-
if (deprecated) {
|
|
70
|
-
defaultDocs.push(`@deprecated: ${deprecated}`);
|
|
71
|
-
}
|
|
72
|
-
if (type === 'GenericRpcCall' && params.length === 0) {
|
|
73
|
-
return `${commentBlock(defaultDocs)}${method}: GenericRpcCall`;
|
|
74
|
-
}
|
|
75
|
-
this.addTypeImport(type, false);
|
|
76
|
-
params.forEach(({ type, isScale }) => {
|
|
77
|
-
this.addTypeImport(type, !!isScale);
|
|
78
|
-
});
|
|
79
|
-
const typedParams = params.map((param) => ({
|
|
80
|
-
...param,
|
|
81
|
-
plainType: this.getGeneratedTypeName(param.type, !!param.isScale),
|
|
82
|
-
}));
|
|
83
|
-
const isSubscription = !!pubsub;
|
|
84
|
-
const paramsOut = typedParams.map(({ name, type, isOptional, isScale, plainType }) => `${name}${isOptional ? '?' : ''}: ${plainType}`);
|
|
85
|
-
const paramsDoc = typedParams.map(({ name, plainType }) => `@param {${plainType}} ${name}`);
|
|
86
|
-
const typeOut = this.getGeneratedTypeName(type, false);
|
|
87
|
-
if (isSubscription) {
|
|
88
|
-
defaultDocs.shift();
|
|
89
|
-
defaultDocs.unshift(`@pubsub: ${pubsub?.join(', ')}`);
|
|
90
|
-
paramsOut.push(`callback: Callback<${typeOut}>`);
|
|
91
|
-
return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
|
|
92
|
-
}
|
|
93
|
-
else {
|
|
94
|
-
return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<${typeOut}>>`;
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
// TODO check typeIn, typeOut if param type, or rpc type isScale
|
|
98
|
-
addTypeImport(type, toTypeIn = true) {
|
|
99
|
-
if (Array.isArray(type)) {
|
|
100
|
-
type.forEach((one) => this.addTypeImport(one, toTypeIn));
|
|
101
|
-
return;
|
|
102
|
-
}
|
|
103
|
-
type = type.trim();
|
|
104
|
-
if (isNativeType(type)) {
|
|
105
|
-
return;
|
|
106
|
-
}
|
|
107
|
-
// Handle generic wrapper types
|
|
108
|
-
const matchArray = type.match(WRAPPER_TYPE_REGEX);
|
|
109
|
-
if (matchArray) {
|
|
110
|
-
const [_, $1, $2] = matchArray;
|
|
111
|
-
this.addTypeImport($1, toTypeIn);
|
|
112
|
-
if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
|
|
113
|
-
this.addTypeImport($2, toTypeIn);
|
|
114
|
-
}
|
|
115
|
-
else {
|
|
116
|
-
this.addTypeImport($2.split(','), toTypeIn);
|
|
117
|
-
}
|
|
118
|
-
return;
|
|
119
|
-
}
|
|
120
|
-
// Check tuple type
|
|
121
|
-
if (type.match(TUPLE_TYPE_REGEX)) {
|
|
122
|
-
this.addTypeImport(type.slice(1, -1).split(','), toTypeIn);
|
|
123
|
-
return;
|
|
124
|
-
}
|
|
125
|
-
if (type.includes(' | ')) {
|
|
126
|
-
this.addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
|
|
127
|
-
return;
|
|
128
|
-
}
|
|
129
|
-
try {
|
|
130
|
-
const codecType = this.#getCodecType(type, toTypeIn);
|
|
131
|
-
if (isNativeType(codecType))
|
|
132
|
-
return;
|
|
133
|
-
this.typesGen.typeImports.addCodecType(codecType);
|
|
134
|
-
return;
|
|
135
|
-
}
|
|
136
|
-
catch (e) { }
|
|
137
|
-
this.typesGen.addTypeImport(type);
|
|
138
|
-
}
|
|
139
|
-
getGeneratedTypeName(type, toTypeIn = true) {
|
|
140
|
-
try {
|
|
141
|
-
const matchArray = type.match(WRAPPER_TYPE_REGEX);
|
|
142
|
-
if (matchArray) {
|
|
143
|
-
const [_, $1, $2] = matchArray;
|
|
144
|
-
const wrapperTypeName = this.#getCodecType($1, toTypeIn);
|
|
145
|
-
if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
|
|
146
|
-
return `${wrapperTypeName}<${this.getGeneratedTypeName($2, toTypeIn)}>`;
|
|
147
|
-
}
|
|
148
|
-
const innerTypeNames = $2
|
|
149
|
-
.split(',')
|
|
150
|
-
.map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
|
|
151
|
-
.join(', ');
|
|
152
|
-
return `${wrapperTypeName}<${innerTypeNames}>`;
|
|
153
|
-
}
|
|
154
|
-
else if (type.match(TUPLE_TYPE_REGEX)) {
|
|
155
|
-
const innerTypeNames = type
|
|
156
|
-
.slice(1, -1)
|
|
157
|
-
.split(',')
|
|
158
|
-
.map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
|
|
159
|
-
.join(', ');
|
|
160
|
-
return `[${innerTypeNames}]`;
|
|
161
|
-
}
|
|
162
|
-
return this.#getCodecType(type, toTypeIn);
|
|
163
|
-
}
|
|
164
|
-
catch (e) { }
|
|
165
|
-
return type;
|
|
166
|
-
}
|
|
167
|
-
#getCodecType(type, toTypeIn = true) {
|
|
168
|
-
const { typeIn, typeOut } = findKnownCodecType(type);
|
|
169
|
-
return toTypeIn ? typeIn : typeOut;
|
|
170
|
-
}
|
|
171
|
-
}
|