@dedot/codegen 0.0.1-next.c3d95ac1.3 → 0.0.1-next.d9aff57d.57
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 +6 -6
- package/cjs/generator/EventsGen.js +6 -6
- package/cjs/generator/IndexGen.js +7 -3
- package/cjs/generator/JsonRpcGen.js +8 -8
- package/cjs/generator/QueryGen.js +19 -10
- package/cjs/generator/RuntimeApisGen.js +11 -11
- package/cjs/generator/TxGen.js +11 -9
- package/cjs/generator/TypeImports.js +11 -9
- package/cjs/generator/TypesGen.js +3 -3
- package/cjs/generator/known-codecs.js +1 -1
- package/cjs/index.js +17 -16
- 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 +14 -9
- package/cjs/templates/json-rpc.hbs +1 -1
- 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 +4 -4
- package/generator/ConstsGen.d.ts +1 -1
- package/generator/ConstsGen.js +3 -3
- package/generator/ErrorsGen.d.ts +1 -1
- package/generator/ErrorsGen.js +6 -6
- package/generator/EventsGen.d.ts +1 -1
- package/generator/EventsGen.js +6 -6
- package/generator/IndexGen.d.ts +1 -1
- package/generator/IndexGen.js +7 -3
- package/generator/JsonRpcGen.d.ts +3 -2
- package/generator/JsonRpcGen.js +6 -6
- package/generator/QueryGen.d.ts +1 -1
- package/generator/QueryGen.js +19 -10
- package/generator/RuntimeApisGen.d.ts +2 -2
- package/generator/RuntimeApisGen.js +9 -9
- package/generator/TxGen.d.ts +1 -1
- package/generator/TxGen.js +11 -9
- package/generator/TypeImports.d.ts +8 -3
- package/generator/TypeImports.js +11 -9
- package/generator/TypesGen.d.ts +1 -1
- package/generator/TypesGen.js +3 -3
- package/generator/known-codecs.d.ts +1 -1
- package/generator/known-codecs.js +1 -1
- package/index.d.ts +2 -2
- package/index.js +18 -17
- package/package.json +15 -17
- package/templates/consts.hbs +1 -1
- package/templates/errors.hbs +1 -1
- package/templates/events.hbs +1 -1
- package/templates/index.hbs +14 -9
- package/templates/json-rpc.hbs +1 -1
- package/templates/query.hbs +1 -1
- package/templates/runtime.hbs +1 -1
- package/templates/tx.hbs +1 -1
|
@@ -5,10 +5,10 @@ const utils_1 = require("@dedot/utils");
|
|
|
5
5
|
const ApiGen_js_1 = require("./ApiGen.js");
|
|
6
6
|
const utils_js_1 = require("./utils.js");
|
|
7
7
|
class ConstsGen extends ApiGen_js_1.ApiGen {
|
|
8
|
-
generate() {
|
|
8
|
+
generate(useSubPaths = false) {
|
|
9
9
|
const { pallets } = this.metadata;
|
|
10
10
|
this.typesGen.clearCache();
|
|
11
|
-
this.typesGen.typeImports.addKnownType('GenericChainConsts');
|
|
11
|
+
this.typesGen.typeImports.addKnownType('GenericChainConsts', 'RpcVersion');
|
|
12
12
|
let defTypeOut = '';
|
|
13
13
|
for (let pallet of pallets) {
|
|
14
14
|
const typedConstants = pallet.constants.map((one) => ({
|
|
@@ -23,7 +23,7 @@ class ConstsGen extends ApiGen_js_1.ApiGen {
|
|
|
23
23
|
${(0, utils_js_1.commentBlock)('Generic pallet constant')}[name: string]: any,
|
|
24
24
|
},`;
|
|
25
25
|
}
|
|
26
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
26
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
27
27
|
const template = (0, utils_js_1.compileTemplate)('consts.hbs');
|
|
28
28
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
29
29
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ErrorsGen = void 0;
|
|
4
|
+
const utils_1 = require("@dedot/utils");
|
|
4
5
|
const ApiGen_js_1 = require("./ApiGen.js");
|
|
5
6
|
const utils_js_1 = require("./utils.js");
|
|
6
|
-
const utils_1 = require("@dedot/utils");
|
|
7
7
|
class ErrorsGen extends ApiGen_js_1.ApiGen {
|
|
8
|
-
generate() {
|
|
8
|
+
generate(useSubPaths = false) {
|
|
9
9
|
const { pallets } = this.metadata;
|
|
10
10
|
this.typesGen.clearCache();
|
|
11
|
-
this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
|
|
11
|
+
this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError', 'RpcVersion');
|
|
12
12
|
let defTypeOut = '';
|
|
13
13
|
for (let pallet of pallets) {
|
|
14
14
|
const errorTypeId = pallet.error;
|
|
@@ -19,13 +19,13 @@ class ErrorsGen extends ApiGen_js_1.ApiGen {
|
|
|
19
19
|
defTypeOut += (0, utils_js_1.commentBlock)(`Pallet \`${pallet.name}\`'s errors`);
|
|
20
20
|
defTypeOut += `${(0, utils_1.stringCamelCase)(pallet.name)}: {
|
|
21
21
|
${errorDefs
|
|
22
|
-
.map(({ name, docs }) => `${(0, utils_js_1.commentBlock)(docs)}${(0, utils_1.stringPascalCase)(name)}: GenericPalletError
|
|
22
|
+
.map(({ name, docs }) => `${(0, utils_js_1.commentBlock)(docs)}${(0, utils_1.stringPascalCase)(name)}: GenericPalletError<Rv>`)
|
|
23
23
|
.join(',\n')}
|
|
24
24
|
|
|
25
|
-
${(0, utils_js_1.commentBlock)('Generic pallet error')}[error: string]: GenericPalletError
|
|
25
|
+
${(0, utils_js_1.commentBlock)('Generic pallet error')}[error: string]: GenericPalletError<Rv>,
|
|
26
26
|
},`;
|
|
27
27
|
}
|
|
28
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
28
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
29
29
|
const template = (0, utils_js_1.compileTemplate)('errors.hbs');
|
|
30
30
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
31
31
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.EventsGen = void 0;
|
|
4
|
+
const utils_1 = require("@dedot/utils");
|
|
4
5
|
const ApiGen_js_1 = require("./ApiGen.js");
|
|
5
6
|
const utils_js_1 = require("./utils.js");
|
|
6
|
-
const utils_1 = require("@dedot/utils");
|
|
7
7
|
class EventsGen extends ApiGen_js_1.ApiGen {
|
|
8
|
-
generate() {
|
|
8
|
+
generate(useSubPaths = false) {
|
|
9
9
|
const { pallets } = this.metadata;
|
|
10
10
|
this.typesGen.clearCache();
|
|
11
|
-
this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent');
|
|
11
|
+
this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent', 'RpcVersion');
|
|
12
12
|
let defTypeOut = '';
|
|
13
13
|
for (let pallet of pallets) {
|
|
14
14
|
const eventTypeId = pallet.event;
|
|
@@ -31,13 +31,13 @@ class EventsGen extends ApiGen_js_1.ApiGen {
|
|
|
31
31
|
}
|
|
32
32
|
return { ...def, genericParts };
|
|
33
33
|
})
|
|
34
|
-
.map(({ name, docs, fields, genericParts }) => `${(0, utils_js_1.commentBlock)(docs)}${(0, utils_1.stringPascalCase)(name)}: GenericPalletEvent
|
|
34
|
+
.map(({ name, docs, fields, genericParts }) => `${(0, utils_js_1.commentBlock)(docs)}${(0, utils_1.stringPascalCase)(name)}: GenericPalletEvent<Rv, ${genericParts.join(', ')}>`)
|
|
35
35
|
.join(',\n')}
|
|
36
36
|
|
|
37
|
-
${(0, utils_js_1.commentBlock)('Generic pallet event')}[prop: string]: GenericPalletEvent
|
|
37
|
+
${(0, utils_js_1.commentBlock)('Generic pallet event')}[prop: string]: GenericPalletEvent<Rv>,
|
|
38
38
|
},`;
|
|
39
39
|
}
|
|
40
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
40
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
41
41
|
const template = (0, utils_js_1.compileTemplate)('events.hbs');
|
|
42
42
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
43
43
|
}
|
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.IndexGen = void 0;
|
|
4
|
-
const utils_js_1 = require("./utils.js");
|
|
5
4
|
const utils_1 = require("@dedot/utils");
|
|
5
|
+
const TypeImports_js_1 = require("./TypeImports.js");
|
|
6
|
+
const utils_js_1 = require("./utils.js");
|
|
6
7
|
class IndexGen {
|
|
7
8
|
chain;
|
|
8
9
|
constructor(chain) {
|
|
9
10
|
this.chain = chain;
|
|
10
11
|
}
|
|
11
|
-
async generate() {
|
|
12
|
+
async generate(useSubPaths = false) {
|
|
12
13
|
const interfaceName = (0, utils_1.stringPascalCase)(this.chain);
|
|
14
|
+
const typeImports = new TypeImports_js_1.TypeImports();
|
|
15
|
+
typeImports.addKnownType('GenericSubstrateApi', 'RpcLegacy', 'RpcV2', 'RpcVersion');
|
|
16
|
+
const importTypes = typeImports.toImports({ useSubPaths });
|
|
13
17
|
const template = (0, utils_js_1.compileTemplate)('index.hbs');
|
|
14
|
-
return (0, utils_js_1.beautifySourceCode)(template({ interfaceName }));
|
|
18
|
+
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, interfaceName }));
|
|
15
19
|
}
|
|
16
20
|
}
|
|
17
21
|
exports.IndexGen = IndexGen;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.JsonRpcGen = void 0;
|
|
4
|
-
const
|
|
4
|
+
const api_1 = require("@dedot/api");
|
|
5
|
+
const ApiGen_js_1 = require("./ApiGen.js");
|
|
5
6
|
const utils_js_1 = require("./utils.js");
|
|
6
|
-
const specs_1 = require("@dedot/specs");
|
|
7
7
|
const HIDDEN_RPCS = [
|
|
8
8
|
// Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
|
|
9
9
|
'rpc_methods',
|
|
@@ -31,7 +31,7 @@ const ALIAS_RPCS = [
|
|
|
31
31
|
'chain_subscribeFinalisedHeads',
|
|
32
32
|
'chain_unsubscribeFinalisedHeads',
|
|
33
33
|
];
|
|
34
|
-
class JsonRpcGen extends
|
|
34
|
+
class JsonRpcGen extends ApiGen_js_1.ApiGen {
|
|
35
35
|
typesGen;
|
|
36
36
|
rpcMethods;
|
|
37
37
|
constructor(typesGen, rpcMethods) {
|
|
@@ -41,12 +41,12 @@ class JsonRpcGen extends index_js_1.ApiGen {
|
|
|
41
41
|
HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
|
|
42
42
|
rpcMethods.sort();
|
|
43
43
|
}
|
|
44
|
-
generate() {
|
|
44
|
+
generate(useSubPaths = false) {
|
|
45
45
|
this.typesGen.clearCache();
|
|
46
|
-
this.typesGen.typeImports.addKnownType('GenericJsonRpcApis');
|
|
47
|
-
this.typesGen.typeImports.
|
|
48
|
-
const toExclude = Object.values(
|
|
49
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
46
|
+
this.typesGen.typeImports.addKnownType('GenericJsonRpcApis', 'RpcVersion');
|
|
47
|
+
this.typesGen.typeImports.addKnownJsonRpcType('JsonRpcApis');
|
|
48
|
+
const toExclude = Object.values(api_1.subscriptionsInfo).flat();
|
|
49
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
50
50
|
const template = (0, utils_js_1.compileTemplate)('json-rpc.hbs');
|
|
51
51
|
const jsonRpcMethods = this.rpcMethods
|
|
52
52
|
.filter((one) => !ALIAS_RPCS.includes(one)) // exclude alias rpcs
|
|
@@ -5,37 +5,45 @@ const utils_1 = require("@dedot/utils");
|
|
|
5
5
|
const ApiGen_js_1 = require("./ApiGen.js");
|
|
6
6
|
const utils_js_1 = require("./utils.js");
|
|
7
7
|
class QueryGen extends ApiGen_js_1.ApiGen {
|
|
8
|
-
generate() {
|
|
8
|
+
generate(useSubPaths = false) {
|
|
9
9
|
const { pallets } = this.metadata;
|
|
10
10
|
this.typesGen.clearCache();
|
|
11
|
-
this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
|
|
11
|
+
this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback', 'RpcVersion');
|
|
12
12
|
let defTypeOut = '';
|
|
13
13
|
for (let pallet of pallets) {
|
|
14
14
|
const storage = pallet.storage;
|
|
15
15
|
if (!storage)
|
|
16
16
|
continue;
|
|
17
17
|
const queries = storage.entries.map((one) => this.#generateEntry(one));
|
|
18
|
-
const queryDefs = queries.map(({ name, valueType, keyType, docs
|
|
18
|
+
const queryDefs = queries.map(({ name, valueType, keyType, docs, keyTypeOut }) => {
|
|
19
|
+
if (keyTypeOut) {
|
|
20
|
+
return `${(0, utils_js_1.commentBlock)(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}, ${keyTypeOut}>`;
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
return `${(0, utils_js_1.commentBlock)(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}>`;
|
|
24
|
+
}
|
|
25
|
+
});
|
|
19
26
|
defTypeOut += (0, utils_js_1.commentBlock)(`Pallet \`${pallet.name}\`'s storage queries`);
|
|
20
27
|
defTypeOut += `${(0, utils_1.stringCamelCase)(pallet.name)}: {
|
|
21
28
|
${queryDefs.join(',\n')}
|
|
22
29
|
|
|
23
|
-
${(0, utils_js_1.commentBlock)('Generic pallet storage query')}[storage: string]: GenericStorageQuery
|
|
30
|
+
${(0, utils_js_1.commentBlock)('Generic pallet storage query')}[storage: string]: GenericStorageQuery<Rv>;
|
|
24
31
|
},`;
|
|
25
32
|
}
|
|
26
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
33
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
27
34
|
const template = (0, utils_js_1.compileTemplate)('query.hbs');
|
|
28
35
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
29
36
|
}
|
|
30
37
|
#generateEntry(entry) {
|
|
31
38
|
const { name, type, docs, modifier } = entry;
|
|
32
|
-
let valueType,
|
|
39
|
+
let valueType, keyTypeOut, keyTypeIn;
|
|
33
40
|
if (type.tag === 'Plain') {
|
|
34
41
|
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
35
42
|
}
|
|
36
43
|
else if (type.tag === 'Map') {
|
|
37
44
|
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
38
|
-
|
|
45
|
+
keyTypeOut = this.typesGen.generateType(type.value.keyTypeId, 1, true);
|
|
46
|
+
keyTypeIn = this.typesGen.generateType(type.value.keyTypeId, 1);
|
|
39
47
|
}
|
|
40
48
|
else {
|
|
41
49
|
throw Error('Invalid entry type!');
|
|
@@ -43,14 +51,15 @@ class QueryGen extends ApiGen_js_1.ApiGen {
|
|
|
43
51
|
const isOptional = modifier === 'Optional';
|
|
44
52
|
valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
|
|
45
53
|
docs.push('\n');
|
|
46
|
-
if (
|
|
47
|
-
docs.push(`@param {${
|
|
54
|
+
if (keyTypeIn) {
|
|
55
|
+
docs.push(`@param {${keyTypeIn}} arg`);
|
|
48
56
|
}
|
|
49
57
|
docs.push(`@param {Callback<${valueType}> =} callback`);
|
|
50
58
|
return {
|
|
51
59
|
name: (0, utils_1.normalizeName)(name),
|
|
52
60
|
valueType,
|
|
53
|
-
keyType:
|
|
61
|
+
keyType: keyTypeIn ? `arg: ${keyTypeIn}` : '',
|
|
62
|
+
keyTypeOut,
|
|
54
63
|
docs,
|
|
55
64
|
};
|
|
56
65
|
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.RuntimeApisGen = void 0;
|
|
4
|
-
const
|
|
5
|
-
const utils_js_1 = require("./utils.js");
|
|
4
|
+
const runtime_specs_1 = require("@dedot/runtime-specs");
|
|
6
5
|
const utils_1 = require("@dedot/utils");
|
|
7
6
|
const ApiGen_js_1 = require("./ApiGen.js");
|
|
8
7
|
const known_codecs_js_1 = require("./known-codecs.js");
|
|
8
|
+
const utils_js_1 = require("./utils.js");
|
|
9
9
|
class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
10
10
|
typesGen;
|
|
11
11
|
runtimeApis;
|
|
@@ -14,9 +14,9 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
14
14
|
this.typesGen = typesGen;
|
|
15
15
|
this.runtimeApis = runtimeApis;
|
|
16
16
|
}
|
|
17
|
-
generate() {
|
|
17
|
+
generate(useSubPaths = false) {
|
|
18
18
|
this.typesGen.clearCache();
|
|
19
|
-
this.typesGen.typeImports.addKnownType('GenericRuntimeApis', 'GenericRuntimeApiMethod');
|
|
19
|
+
this.typesGen.typeImports.addKnownType('GenericRuntimeApis', 'GenericRuntimeApiMethod', 'RpcVersion');
|
|
20
20
|
let runtimeCallsOut = '';
|
|
21
21
|
if (this.metadata.apis.length > 0) {
|
|
22
22
|
this.metadata.apis.forEach((runtimeApi) => {
|
|
@@ -25,7 +25,7 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
25
25
|
runtimeCallsOut += `${(0, utils_1.stringCamelCase)(runtimeApiName)}: {
|
|
26
26
|
${methods.map((method) => this.#generateMethodDef(runtimeApiName, method)).join('\n')}
|
|
27
27
|
|
|
28
|
-
${(0, utils_js_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
|
|
28
|
+
${(0, utils_js_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod<Rv>
|
|
29
29
|
}`;
|
|
30
30
|
});
|
|
31
31
|
}
|
|
@@ -42,11 +42,11 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
42
42
|
}))
|
|
43
43
|
.join('\n')}
|
|
44
44
|
|
|
45
|
-
${(0, utils_js_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
|
|
45
|
+
${(0, utils_js_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod<Rv>
|
|
46
46
|
}`;
|
|
47
47
|
});
|
|
48
48
|
}
|
|
49
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
49
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
50
50
|
const template = (0, utils_js_1.compileTemplate)('runtime.hbs');
|
|
51
51
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, runtimeCallsOut }));
|
|
52
52
|
}
|
|
@@ -71,7 +71,7 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
71
71
|
.map(({ name, isOptional, plainType }) => `${(0, utils_1.stringCamelCase)(name)}${isOptional ? '?' : ''}: ${plainType}`)
|
|
72
72
|
.join(', ');
|
|
73
73
|
const typeOut = this.#getGeneratedTypeName(type, false);
|
|
74
|
-
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
|
|
74
|
+
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<Rv, (${paramsOut}) => Promise<${typeOut}>>`;
|
|
75
75
|
}
|
|
76
76
|
#generateMethodDef(runtimeApiName, methodDef) {
|
|
77
77
|
const { name: methodName, inputs, output, docs } = methodDef;
|
|
@@ -92,7 +92,7 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
92
92
|
const paramsOut = typedInputs
|
|
93
93
|
.map(({ name, type, isOptional }) => `${(0, utils_1.stringCamelCase)(name)}${isOptional ? '?' : ''}: ${type}`)
|
|
94
94
|
.join(', ');
|
|
95
|
-
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, typedInputs.map(({ type, name }) => `@param {${type}} ${name}`))}${(0, utils_1.stringCamelCase)(methodName)}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
|
|
95
|
+
return `${(0, utils_js_1.commentBlock)(docs, '\n', defaultDocs, typedInputs.map(({ type, name }) => `@param {${type}} ${name}`))}${(0, utils_1.stringCamelCase)(methodName)}: GenericRuntimeApiMethod<Rv, (${paramsOut}) => Promise<${typeOut}>>`;
|
|
96
96
|
}
|
|
97
97
|
#targetRuntimeApiSpecs() {
|
|
98
98
|
const specs = Object.entries(this.runtimeApis).map(([runtimeApiHash, version]) => {
|
|
@@ -112,8 +112,8 @@ class RuntimeApisGen extends ApiGen_js_1.ApiGen {
|
|
|
112
112
|
}, []);
|
|
113
113
|
}
|
|
114
114
|
#findRuntimeApiSpec = (runtimeApiHash, version) => {
|
|
115
|
-
const runtimeApiName = (0,
|
|
116
|
-
return (0,
|
|
115
|
+
const runtimeApiName = (0, runtime_specs_1.getRuntimeApiNames)().find((one) => (0, utils_1.calcRuntimeApiHash)(one) === runtimeApiHash);
|
|
116
|
+
return (0, runtime_specs_1.getRuntimeApiSpecs)().find((one) => one.runtimeApiName === runtimeApiName && one.version === version);
|
|
117
117
|
};
|
|
118
118
|
// TODO check typeIn, typeOut if param type, or rpc type isScale
|
|
119
119
|
#addTypeImport(type, toTypeIn = true) {
|
package/cjs/generator/TxGen.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.TxGen = void 0;
|
|
4
|
-
const index_js_1 = require("../generator/index.js");
|
|
5
4
|
const utils_1 = require("@dedot/utils");
|
|
5
|
+
const index_js_1 = require("../generator/index.js");
|
|
6
6
|
const utils_js_1 = require("./utils.js");
|
|
7
7
|
class TxGen extends index_js_1.ApiGen {
|
|
8
|
-
generate() {
|
|
8
|
+
generate(useSubPaths = false) {
|
|
9
9
|
const { pallets, types } = this.metadata;
|
|
10
10
|
this.typesGen.clearCache();
|
|
11
|
-
this.typesGen.typeImports.addKnownType('GenericChainTx', 'GenericTxCall', 'ISubmittableExtrinsic', 'ISubmittableResult', 'IRuntimeTxCall');
|
|
11
|
+
this.typesGen.typeImports.addKnownType('GenericChainTx', 'GenericTxCall', 'ISubmittableExtrinsic', 'ISubmittableResult', 'IRuntimeTxCall', 'RpcVersion', 'RpcV2', 'ISubmittableExtrinsicLegacy', 'TransactionStatusLegacy', 'TransactionStatusV2');
|
|
12
12
|
const { callTypeId, addressTypeId, signatureTypeId } = this.metadata.extrinsic;
|
|
13
13
|
const callTypeIn = this.typesGen.generateType(callTypeId, 1);
|
|
14
14
|
const addressTypeIn = this.typesGen.generateType(addressTypeId, 1);
|
|
@@ -44,20 +44,22 @@ class TxGen extends index_js_1.ApiGen {
|
|
|
44
44
|
txDefsOut += (0, utils_js_1.commentBlock)(`Pallet \`${pallet.name}\`'s transaction calls`);
|
|
45
45
|
txDefsOut += `${(0, utils_1.stringCamelCase)(pallet.name)}: {
|
|
46
46
|
${typedTxs
|
|
47
|
-
.map(({ functionName, params, docs, callInput }) => `${(0, utils_js_1.commentBlock)(docs, '\n', params.map((p) => `@param {${p.type}} ${p.normalizedName} ${p.docs}`))}${functionName}: GenericTxCall<(${params.map((p) => `${p.normalizedName}: ${p.type}`).join(', ')}) => ChainSubmittableExtrinsic
|
|
47
|
+
.map(({ functionName, params, docs, callInput }) => `${(0, utils_js_1.commentBlock)(docs, '\n', params.map((p) => `@param {${p.type}} ${p.normalizedName} ${p.docs}`))}${functionName}: GenericTxCall<Rv, (${params.map((p) => `${p.normalizedName}: ${p.type}`).join(', ')}) => ChainSubmittableExtrinsic<Rv, ${callInput}>>`)
|
|
48
48
|
.join(',\n')}
|
|
49
49
|
|
|
50
|
-
${(0, utils_js_1.commentBlock)('Generic pallet tx call')}[callName: string]: GenericTxCall<TxCall
|
|
50
|
+
${(0, utils_js_1.commentBlock)('Generic pallet tx call')}[callName: string]: GenericTxCall<Rv, TxCall<Rv>>,
|
|
51
51
|
},`;
|
|
52
52
|
}
|
|
53
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
53
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
54
54
|
// TODO make explicit separate type for Extra
|
|
55
55
|
const defTypes = `
|
|
56
|
-
export type ChainSubmittableExtrinsic<T extends IRuntimeTxCall = ${callTypeIn}> =
|
|
56
|
+
export type ChainSubmittableExtrinsic<Rv extends RpcVersion, T extends IRuntimeTxCall = ${callTypeIn}> =
|
|
57
57
|
Extrinsic<${addressTypeIn}, T, ${signatureTypeIn}, any[]> &
|
|
58
|
-
|
|
58
|
+
(Rv extends RpcV2
|
|
59
|
+
? ISubmittableExtrinsic<ISubmittableResult<FrameSystemEventRecord, TransactionStatusV2>>
|
|
60
|
+
: ISubmittableExtrinsicLegacy<ISubmittableResult<FrameSystemEventRecord, TransactionStatusLegacy>>)
|
|
59
61
|
|
|
60
|
-
export type TxCall = (...args: any[]) => ChainSubmittableExtrinsic
|
|
62
|
+
export type TxCall<Rv extends RpcVersion> = (...args: any[]) => ChainSubmittableExtrinsic<Rv>;
|
|
61
63
|
`;
|
|
62
64
|
const template = (0, utils_js_1.compileTemplate)('tx.hbs');
|
|
63
65
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypes, txDefsOut }));
|
|
@@ -8,29 +8,31 @@ class TypeImports {
|
|
|
8
8
|
codecTypes;
|
|
9
9
|
// Known types that're not codecs or chain/portable types defined in @dedot/types
|
|
10
10
|
knownTypes;
|
|
11
|
-
|
|
11
|
+
knownJsonRpcTypes;
|
|
12
12
|
// External types to define explicitly
|
|
13
13
|
outTypes;
|
|
14
14
|
constructor() {
|
|
15
15
|
this.portableTypes = new Set();
|
|
16
16
|
this.codecTypes = new Set();
|
|
17
17
|
this.knownTypes = new Set();
|
|
18
|
-
this.
|
|
18
|
+
this.knownJsonRpcTypes = new Set();
|
|
19
19
|
this.outTypes = new Set();
|
|
20
20
|
}
|
|
21
21
|
clear() {
|
|
22
22
|
this.portableTypes.clear();
|
|
23
23
|
this.codecTypes.clear();
|
|
24
24
|
this.knownTypes.clear();
|
|
25
|
-
this.
|
|
25
|
+
this.knownJsonRpcTypes.clear();
|
|
26
26
|
this.outTypes.clear();
|
|
27
27
|
}
|
|
28
|
-
toImports(
|
|
28
|
+
toImports(config) {
|
|
29
|
+
const { excludeModules = [], useSubPaths = false } = config || {};
|
|
29
30
|
// TODO generate outTypes!
|
|
31
|
+
const prefix = useSubPaths ? '' : '@';
|
|
30
32
|
const toImports = [
|
|
31
|
-
[this.knownTypes,
|
|
32
|
-
[this.
|
|
33
|
-
[this.codecTypes,
|
|
33
|
+
[this.knownTypes, `${prefix}dedot/types`],
|
|
34
|
+
[this.knownJsonRpcTypes, `${prefix}dedot/types/json-rpc`],
|
|
35
|
+
[this.codecTypes, `${prefix}dedot/codecs`],
|
|
34
36
|
[this.portableTypes, './types'],
|
|
35
37
|
];
|
|
36
38
|
return toImports
|
|
@@ -54,8 +56,8 @@ class TypeImports {
|
|
|
54
56
|
addKnownType(...types) {
|
|
55
57
|
types.forEach((one) => this.knownTypes.add(one));
|
|
56
58
|
}
|
|
57
|
-
|
|
58
|
-
types.forEach((one) => this.
|
|
59
|
+
addKnownJsonRpcType(...types) {
|
|
60
|
+
types.forEach((one) => this.knownJsonRpcTypes.add(one));
|
|
59
61
|
}
|
|
60
62
|
addOutType(...types) {
|
|
61
63
|
types.forEach((one) => this.outTypes.add(one));
|
|
@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.TypesGen = exports.BASIC_KNOWN_TYPES = void 0;
|
|
4
4
|
const codecs_1 = require("@dedot/codecs");
|
|
5
5
|
const utils_1 = require("@dedot/utils");
|
|
6
|
-
const utils_js_1 = require("./utils.js");
|
|
7
6
|
const TypeImports_js_1 = require("./TypeImports.js");
|
|
8
7
|
const known_codecs_js_1 = require("./known-codecs.js");
|
|
8
|
+
const utils_js_1 = require("./utils.js");
|
|
9
9
|
// Skip generate types for these
|
|
10
10
|
// as we do have native types for them
|
|
11
11
|
const SKIP_TYPES = [
|
|
@@ -43,7 +43,7 @@ class TypesGen {
|
|
|
43
43
|
this.includedTypes = this.#includedTypes();
|
|
44
44
|
this.typeImports = new TypeImports_js_1.TypeImports();
|
|
45
45
|
}
|
|
46
|
-
generate() {
|
|
46
|
+
generate(useSubPaths = false) {
|
|
47
47
|
this.clearCache();
|
|
48
48
|
let defTypeOut = '';
|
|
49
49
|
Object.values(this.includedTypes)
|
|
@@ -54,7 +54,7 @@ class TypesGen {
|
|
|
54
54
|
defTypeOut += `export type ${name} = ${this.generateType(id)};\n\n`;
|
|
55
55
|
}
|
|
56
56
|
});
|
|
57
|
-
const importTypes = this.typeImports.toImports('./types');
|
|
57
|
+
const importTypes = this.typeImports.toImports({ useSubPaths, excludeModules: ['./types'] });
|
|
58
58
|
const template = (0, utils_js_1.compileTemplate)('types.hbs');
|
|
59
59
|
return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
60
60
|
}
|
|
@@ -24,9 +24,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
26
|
exports.isKnownCodecType = exports.findKnownWrapperCodec = exports.findKnownCodec = exports.findKnownCodecType = exports.looseTypeCodecs = exports.normalizeCodecName = void 0;
|
|
27
|
-
const $ = __importStar(require("@dedot/shape"));
|
|
28
27
|
const Codecs = __importStar(require("@dedot/codecs"));
|
|
29
28
|
const codecs_1 = require("@dedot/codecs");
|
|
29
|
+
const $ = __importStar(require("@dedot/shape"));
|
|
30
30
|
const utils_1 = require("@dedot/utils");
|
|
31
31
|
const normalizeCodecName = (name) => {
|
|
32
32
|
return name.startsWith('$') ? name : `$${name}`;
|
package/cjs/index.js
CHANGED
|
@@ -24,23 +24,24 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
26
|
exports.generateTypes = exports.generateTypesFromEndpoint = void 0;
|
|
27
|
-
const
|
|
27
|
+
const api_1 = require("@dedot/api");
|
|
28
|
+
const providers_1 = require("@dedot/providers");
|
|
29
|
+
const utils_1 = require("@dedot/utils");
|
|
28
30
|
const fs = __importStar(require("fs"));
|
|
29
31
|
const path = __importStar(require("path"));
|
|
30
32
|
const index_js_1 = require("./generator/index.js");
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
const api = await dedot_1.Dedot.new(endpoint);
|
|
33
|
+
async function generateTypesFromEndpoint(chain, endpoint, outDir, extension = 'd.ts', useSubPaths = false) {
|
|
34
|
+
const api = await api_1.Dedot.new(new providers_1.WsProvider(endpoint));
|
|
34
35
|
const { methods } = await api.rpc.rpc_methods();
|
|
35
36
|
const apis = api.runtimeVersion.apis || {};
|
|
36
37
|
if (!chain) {
|
|
37
|
-
chain = (0, utils_1.stringCamelCase)(api.runtimeVersion.specName ||
|
|
38
|
+
chain = (0, utils_1.stringCamelCase)(api.runtimeVersion.specName || 'local');
|
|
38
39
|
}
|
|
39
|
-
await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension);
|
|
40
|
+
await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension, useSubPaths);
|
|
40
41
|
await api.disconnect();
|
|
41
42
|
}
|
|
42
43
|
exports.generateTypesFromEndpoint = generateTypesFromEndpoint;
|
|
43
|
-
async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.', extension = 'd.ts') {
|
|
44
|
+
async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.', extension = 'd.ts', useSubPaths = false) {
|
|
44
45
|
const dirPath = path.resolve(outDir, chain);
|
|
45
46
|
const defTypesFileName = path.join(dirPath, `types.${extension}`);
|
|
46
47
|
const constsTypesFileName = path.join(dirPath, `consts.${extension}`);
|
|
@@ -63,14 +64,14 @@ async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir =
|
|
|
63
64
|
const eventsGen = new index_js_1.EventsGen(typesGen);
|
|
64
65
|
const runtimeApisGen = new index_js_1.RuntimeApisGen(typesGen, runtimeApis);
|
|
65
66
|
const txGen = new index_js_1.TxGen(typesGen);
|
|
66
|
-
fs.writeFileSync(defTypesFileName, await typesGen.generate());
|
|
67
|
-
fs.writeFileSync(errorsFileName, await errorsGen.generate());
|
|
68
|
-
fs.writeFileSync(eventsFileName, await eventsGen.generate());
|
|
69
|
-
fs.writeFileSync(jsonRpcFileName, await jsonRpcGen.generate());
|
|
70
|
-
fs.writeFileSync(queryTypesFileName, await queryGen.generate());
|
|
71
|
-
fs.writeFileSync(constsTypesFileName, await constsGen.generate());
|
|
72
|
-
fs.writeFileSync(txFileName, await txGen.generate());
|
|
73
|
-
fs.writeFileSync(indexFileName, await indexGen.generate());
|
|
74
|
-
fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate());
|
|
67
|
+
fs.writeFileSync(defTypesFileName, await typesGen.generate(useSubPaths));
|
|
68
|
+
fs.writeFileSync(errorsFileName, await errorsGen.generate(useSubPaths));
|
|
69
|
+
fs.writeFileSync(eventsFileName, await eventsGen.generate(useSubPaths));
|
|
70
|
+
fs.writeFileSync(jsonRpcFileName, await jsonRpcGen.generate(useSubPaths));
|
|
71
|
+
fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
|
|
72
|
+
fs.writeFileSync(constsTypesFileName, await constsGen.generate(useSubPaths));
|
|
73
|
+
fs.writeFileSync(txFileName, await txGen.generate(useSubPaths));
|
|
74
|
+
fs.writeFileSync(indexFileName, await indexGen.generate(useSubPaths));
|
|
75
|
+
fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate(useSubPaths));
|
|
75
76
|
}
|
|
76
77
|
exports.generateTypes = generateTypes;
|
package/cjs/templates/consts.hbs
CHANGED
package/cjs/templates/errors.hbs
CHANGED
package/cjs/templates/events.hbs
CHANGED
package/cjs/templates/index.hbs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Generated by @dedot/codegen
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
{{{importTypes}}}
|
|
4
4
|
import { ChainConsts } from './consts';
|
|
5
5
|
import { ChainStorage } from './query';
|
|
6
6
|
import { ChainJsonRpcApis } from './json-rpc';
|
|
@@ -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: ChainJsonRpcApis
|
|
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/cjs/templates/query.hbs
CHANGED
package/cjs/templates/tx.hbs
CHANGED
package/generator/ApiGen.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { TypesGen } from '
|
|
1
|
+
import { TypesGen } from './TypesGen.js';
|
|
2
2
|
export declare abstract class ApiGen {
|
|
3
3
|
readonly typesGen: TypesGen;
|
|
4
4
|
constructor(typesGen: TypesGen);
|
|
@@ -13,14 +13,14 @@ export declare abstract class ApiGen {
|
|
|
13
13
|
type: {
|
|
14
14
|
tag: "Struct";
|
|
15
15
|
value: {
|
|
16
|
-
fields: import("dedot").Field[];
|
|
16
|
+
fields: import("@dedot/codecs").Field[];
|
|
17
17
|
};
|
|
18
18
|
} | {
|
|
19
19
|
tag: "Enum";
|
|
20
20
|
value: {
|
|
21
21
|
members: {
|
|
22
22
|
name: string;
|
|
23
|
-
fields: import("dedot").Field[];
|
|
23
|
+
fields: import("@dedot/codecs").Field[];
|
|
24
24
|
index: number;
|
|
25
25
|
docs: string[];
|
|
26
26
|
}[];
|
|
@@ -134,5 +134,5 @@ export declare abstract class ApiGen {
|
|
|
134
134
|
}>;
|
|
135
135
|
};
|
|
136
136
|
};
|
|
137
|
-
get registry(): import("dedot").PortableRegistry;
|
|
137
|
+
get registry(): import("@dedot/codecs").PortableRegistry;
|
|
138
138
|
}
|
package/generator/ConstsGen.d.ts
CHANGED