@dedot/codegen 0.0.1-alpha.4 → 0.0.1-alpha.40

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.
Files changed (139) hide show
  1. package/{generator → chaintypes/generator}/ApiGen.d.ts +15 -15
  2. package/chaintypes/generator/ConstsGen.d.ts +4 -0
  3. package/{generator → chaintypes/generator}/ConstsGen.js +8 -9
  4. package/chaintypes/generator/ErrorsGen.d.ts +5 -0
  5. package/{generator → chaintypes/generator}/ErrorsGen.js +11 -12
  6. package/chaintypes/generator/EventsGen.d.ts +5 -0
  7. package/{generator → chaintypes/generator}/EventsGen.js +11 -12
  8. package/chaintypes/generator/IndexGen.d.ts +5 -0
  9. package/chaintypes/generator/IndexGen.js +17 -0
  10. package/chaintypes/generator/JsonRpcGen.d.ts +8 -0
  11. package/chaintypes/generator/JsonRpcGen.js +55 -0
  12. package/chaintypes/generator/QueryGen.d.ts +5 -0
  13. package/chaintypes/generator/QueryGen.js +63 -0
  14. package/chaintypes/generator/RuntimeApisGen.d.ts +9 -0
  15. package/chaintypes/generator/RuntimeApisGen.js +189 -0
  16. package/chaintypes/generator/TxGen.d.ts +5 -0
  17. package/{generator → chaintypes/generator}/TxGen.js +18 -16
  18. package/chaintypes/generator/TypesGen.d.ts +11 -0
  19. package/chaintypes/generator/TypesGen.js +55 -0
  20. package/chaintypes/generator/index.d.ts +10 -0
  21. package/chaintypes/generator/index.js +10 -0
  22. package/chaintypes/index.d.ts +3 -0
  23. package/chaintypes/index.js +49 -0
  24. package/chaintypes/templates/consts.hbs +7 -0
  25. package/chaintypes/templates/errors.hbs +7 -0
  26. package/chaintypes/templates/events.hbs +7 -0
  27. package/chaintypes/templates/index.hbs +27 -0
  28. package/chaintypes/templates/json-rpc.hbs +5 -0
  29. package/chaintypes/templates/query.hbs +7 -0
  30. package/chaintypes/templates/runtime.hbs +8 -0
  31. package/chaintypes/templates/tx.hbs +9 -0
  32. package/chaintypes/templates/types.hbs +5 -0
  33. package/cjs/{generator → chaintypes/generator}/ConstsGen.js +12 -13
  34. package/cjs/chaintypes/generator/ErrorsGen.js +40 -0
  35. package/cjs/{generator → chaintypes/generator}/EventsGen.js +17 -18
  36. package/cjs/chaintypes/generator/IndexGen.js +21 -0
  37. package/cjs/chaintypes/generator/JsonRpcGen.js +59 -0
  38. package/cjs/chaintypes/generator/QueryGen.js +67 -0
  39. package/cjs/chaintypes/generator/RuntimeApisGen.js +193 -0
  40. package/cjs/{generator → chaintypes/generator}/TxGen.js +27 -25
  41. package/cjs/chaintypes/generator/TypesGen.js +59 -0
  42. package/cjs/chaintypes/generator/index.js +26 -0
  43. package/cjs/chaintypes/index.js +77 -0
  44. package/cjs/chaintypes/templates/consts.hbs +7 -0
  45. package/cjs/chaintypes/templates/errors.hbs +7 -0
  46. package/cjs/chaintypes/templates/events.hbs +7 -0
  47. package/cjs/chaintypes/templates/index.hbs +27 -0
  48. package/cjs/chaintypes/templates/json-rpc.hbs +5 -0
  49. package/cjs/chaintypes/templates/query.hbs +7 -0
  50. package/cjs/chaintypes/templates/runtime.hbs +8 -0
  51. package/cjs/chaintypes/templates/tx.hbs +9 -0
  52. package/cjs/chaintypes/templates/types.hbs +5 -0
  53. package/cjs/{types.js → dirname.js} +3 -0
  54. package/cjs/index.js +4 -62
  55. package/cjs/{generator/TypesGen.js → shared/BaseTypesGen.js} +123 -177
  56. package/cjs/{generator → shared}/TypeImports.js +29 -3
  57. package/cjs/{generator → shared}/index.js +3 -10
  58. package/cjs/shared/known-codecs.js +170 -0
  59. package/cjs/typink/generator/ConstructorQueryGen.js +24 -0
  60. package/cjs/typink/generator/ConstructorTxGen.js +24 -0
  61. package/cjs/typink/generator/IndexGen.js +24 -0
  62. package/cjs/typink/generator/QueryGen.js +72 -0
  63. package/cjs/typink/generator/TxGen.js +25 -0
  64. package/cjs/typink/generator/TypesGen.js +28 -0
  65. package/cjs/typink/generator/index.js +22 -0
  66. package/cjs/typink/index.js +37 -0
  67. package/cjs/typink/templates/constructor-query.hbs +7 -0
  68. package/cjs/typink/templates/constructor-tx.hbs +7 -0
  69. package/cjs/typink/templates/index.hbs +14 -0
  70. package/cjs/typink/templates/query.hbs +7 -0
  71. package/cjs/typink/templates/tx.hbs +7 -0
  72. package/cjs/typink/templates/types.hbs +5 -0
  73. package/cjs/{generator/utils.js → utils.js} +35 -11
  74. package/dirname.d.ts +1 -0
  75. package/dirname.js +6 -0
  76. package/index.d.ts +2 -4
  77. package/index.js +2 -48
  78. package/package.json +18 -19
  79. package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts} +13 -12
  80. package/{generator/TypesGen.js → shared/BaseTypesGen.js} +112 -166
  81. package/{generator → shared}/TypeImports.d.ts +12 -1
  82. package/{generator → shared}/TypeImports.js +29 -3
  83. package/shared/index.d.ts +3 -0
  84. package/shared/index.js +3 -0
  85. package/shared/known-codecs.d.ts +23 -0
  86. package/shared/known-codecs.js +139 -0
  87. package/typink/generator/ConstructorQueryGen.d.ts +6 -0
  88. package/typink/generator/ConstructorQueryGen.js +20 -0
  89. package/typink/generator/ConstructorTxGen.d.ts +6 -0
  90. package/typink/generator/ConstructorTxGen.js +20 -0
  91. package/typink/generator/IndexGen.d.ts +6 -0
  92. package/typink/generator/IndexGen.js +20 -0
  93. package/typink/generator/QueryGen.d.ts +12 -0
  94. package/typink/generator/QueryGen.js +68 -0
  95. package/typink/generator/TxGen.d.ts +6 -0
  96. package/typink/generator/TxGen.js +21 -0
  97. package/typink/generator/TypesGen.d.ts +7 -0
  98. package/typink/generator/TypesGen.js +24 -0
  99. package/typink/generator/index.d.ts +6 -0
  100. package/typink/generator/index.js +6 -0
  101. package/typink/index.d.ts +2 -0
  102. package/typink/index.js +30 -0
  103. package/typink/templates/constructor-query.hbs +7 -0
  104. package/typink/templates/constructor-tx.hbs +7 -0
  105. package/typink/templates/index.hbs +14 -0
  106. package/typink/templates/query.hbs +7 -0
  107. package/typink/templates/tx.hbs +7 -0
  108. package/typink/templates/types.hbs +5 -0
  109. package/{generator/utils.d.ts → utils.d.ts} +6 -2
  110. package/{generator/utils.js → utils.js} +33 -9
  111. package/cjs/genSupportedChainTypes.js +0 -79
  112. package/cjs/generator/ErrorsGen.js +0 -41
  113. package/cjs/generator/IndexGen.js +0 -18
  114. package/cjs/generator/QueryGen.js +0 -59
  115. package/cjs/generator/RpcGen.js +0 -175
  116. package/cjs/generator/RuntimeApisGen.js +0 -120
  117. package/cjs/packageInfo.js +0 -5
  118. package/genSupportedChainTypes.d.ts +0 -1
  119. package/genSupportedChainTypes.js +0 -74
  120. package/generator/ConstsGen.d.ts +0 -4
  121. package/generator/ErrorsGen.d.ts +0 -5
  122. package/generator/EventsGen.d.ts +0 -5
  123. package/generator/IndexGen.d.ts +0 -6
  124. package/generator/IndexGen.js +0 -14
  125. package/generator/QueryGen.d.ts +0 -5
  126. package/generator/QueryGen.js +0 -55
  127. package/generator/RpcGen.d.ts +0 -10
  128. package/generator/RpcGen.js +0 -171
  129. package/generator/RuntimeApisGen.d.ts +0 -9
  130. package/generator/RuntimeApisGen.js +0 -116
  131. package/generator/TxGen.d.ts +0 -5
  132. package/generator/index.d.ts +0 -10
  133. package/generator/index.js +0 -10
  134. package/packageInfo.d.ts +0 -4
  135. package/packageInfo.js +0 -2
  136. package/types.d.ts +0 -6
  137. package/types.js +0 -1
  138. /package/{generator → chaintypes/generator}/ApiGen.js +0 -0
  139. /package/cjs/{generator → chaintypes/generator}/ApiGen.js +0 -0
@@ -1,41 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ErrorsGen = void 0;
4
- const ApiGen_1 = require("./ApiGen");
5
- const utils_1 = require("./utils");
6
- const util_1 = require("@polkadot/util");
7
- const utils_2 = require("@dedot/utils");
8
- class ErrorsGen extends ApiGen_1.ApiGen {
9
- generate() {
10
- const { pallets } = this.metadata;
11
- this.typesGen.clearCache();
12
- this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
13
- let defTypeOut = '';
14
- for (let pallet of pallets) {
15
- const errorTypeId = pallet.error;
16
- if (!errorTypeId) {
17
- continue;
18
- }
19
- const errorDefs = this.#getErrorDefs(errorTypeId);
20
- defTypeOut += (0, utils_1.commentBlock)(`Pallet \`${pallet.name}\`'s errors`);
21
- defTypeOut += `${(0, util_1.stringCamelCase)(pallet.name)}: {
22
- ${errorDefs
23
- .map(({ name, docs }) => `${(0, utils_1.commentBlock)(docs)}${(0, util_1.stringPascalCase)(name)}: GenericPalletError`)
24
- .join(',\n')}
25
-
26
- ${(0, utils_1.commentBlock)('Generic pallet error')}[error: string]: GenericPalletError,
27
- },`;
28
- }
29
- const importTypes = this.typesGen.typeImports.toImports();
30
- const template = (0, utils_1.compileTemplate)('errors.hbs');
31
- return (0, utils_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
32
- }
33
- #getErrorDefs(errorTypeId) {
34
- const def = this.metadata.types[errorTypeId];
35
- (0, utils_2.assert)(def, `Error def not found for id ${errorTypeId}`);
36
- const { tag, value } = def.type;
37
- (0, utils_2.assert)(tag === 'Enum', `Invalid pallet error type!`);
38
- return value.members;
39
- }
40
- }
41
- exports.ErrorsGen = ErrorsGen;
@@ -1,18 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.IndexGen = void 0;
4
- const utils_1 = require("./utils");
5
- const util_1 = require("@polkadot/util");
6
- class IndexGen {
7
- networkInfo;
8
- constructor(networkInfo) {
9
- this.networkInfo = networkInfo;
10
- }
11
- async generate() {
12
- const { chain } = this.networkInfo;
13
- const interfaceName = (0, util_1.stringPascalCase)(chain);
14
- const template = (0, utils_1.compileTemplate)('index.hbs');
15
- return (0, utils_1.beautifySourceCode)(template({ interfaceName }));
16
- }
17
- }
18
- exports.IndexGen = IndexGen;
@@ -1,59 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.QueryGen = void 0;
4
- const util_1 = require("@polkadot/util");
5
- const utils_1 = require("@dedot/utils");
6
- const generator_1 = require("../generator");
7
- const utils_2 = require("./utils");
8
- class QueryGen extends generator_1.ApiGen {
9
- generate() {
10
- const { pallets } = this.metadata;
11
- this.typesGen.clearCache();
12
- this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
13
- let defTypeOut = '';
14
- for (let pallet of pallets) {
15
- const storage = pallet.storage;
16
- if (!storage)
17
- continue;
18
- const queries = storage.entries.map((one) => this.#generateEntry(one));
19
- const queryDefs = queries.map(({ name, valueType, keyType, docs }) => `${(0, utils_2.commentBlock)(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}>`);
20
- defTypeOut += (0, utils_2.commentBlock)(`Pallet \`${pallet.name}\`'s storage queries`);
21
- defTypeOut += `${(0, util_1.stringLowerFirst)(pallet.name)}: {
22
- ${queryDefs.join(',\n')}
23
-
24
- ${(0, utils_2.commentBlock)('Generic pallet storage query')}[storage: string]: GenericStorageQuery;
25
- },`;
26
- }
27
- const importTypes = this.typesGen.typeImports.toImports();
28
- const template = (0, utils_2.compileTemplate)('query.hbs');
29
- return (0, utils_2.beautifySourceCode)(template({ importTypes, defTypeOut }));
30
- }
31
- #generateEntry(entry) {
32
- const { name, type, docs, modifier } = entry;
33
- let valueType, keyType;
34
- if (type.tag === 'Plain') {
35
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
36
- }
37
- else if (type.tag === 'Map') {
38
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
39
- keyType = this.typesGen.generateType(type.value.keyTypeId, 1);
40
- }
41
- else {
42
- throw Error('Invalid entry type!');
43
- }
44
- const isOptional = modifier === 'Optional';
45
- valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
46
- docs.push('\n');
47
- if (keyType) {
48
- docs.push(`@param {${keyType}} arg`);
49
- }
50
- docs.push(`@param {Callback<${valueType}> =} callback`);
51
- return {
52
- name: (0, utils_1.normalizeName)(name),
53
- valueType,
54
- keyType: keyType ? `arg: ${keyType}` : '',
55
- docs,
56
- };
57
- }
58
- }
59
- exports.QueryGen = QueryGen;
@@ -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 utils_1 = require("@dedot/utils");
6
- const generator_1 = require("../generator");
7
- const utils_2 = require("./utils");
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 generator_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_2.compileTemplate)('rpc.hbs');
66
- return (0, utils_2.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_2.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_2.commentBlock)(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
95
- }
96
- else {
97
- return `${(0, utils_2.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_1.isNativeType)(type)) {
108
- return;
109
- }
110
- // Handle generic wrapper types
111
- const matchArray = type.match(utils_2.WRAPPER_TYPE_REGEX);
112
- if (matchArray) {
113
- const [_, $1, $2] = matchArray;
114
- this.addTypeImport($1, toTypeIn);
115
- if ($2.match(utils_2.WRAPPER_TYPE_REGEX) || $2.match(utils_2.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_2.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_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_2.WRAPPER_TYPE_REGEX);
145
- if (matchArray) {
146
- const [_, $1, $2] = matchArray;
147
- const wrapperTypeName = this.#getCodecType($1, toTypeIn);
148
- if ($2.match(utils_2.WRAPPER_TYPE_REGEX) || $2.match(utils_2.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_2.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 } = this.registry.findCodecType(type);
172
- return toTypeIn ? typeIn : typeOut;
173
- }
174
- }
175
- exports.RpcGen = RpcGen;
@@ -1,120 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RuntimeApisGen = void 0;
4
- const specs_1 = require("@dedot/specs");
5
- const utils_1 = require("./utils");
6
- const utils_2 = require("@dedot/utils");
7
- const RpcGen_1 = require("./RpcGen");
8
- const util_1 = require("@polkadot/util");
9
- class RuntimeApisGen extends RpcGen_1.RpcGen {
10
- typesGen;
11
- runtimeApis;
12
- constructor(typesGen, runtimeApis) {
13
- super(typesGen, []);
14
- this.typesGen = typesGen;
15
- this.runtimeApis = runtimeApis;
16
- }
17
- generate() {
18
- this.typesGen.clearCache();
19
- this.typesGen.typeImports.addKnownType('GenericRuntimeApis', 'GenericRuntimeApiMethod');
20
- let runtimeCallsOut = '';
21
- if (this.metadata.apis.length > 0) {
22
- this.metadata.apis.forEach((runtimeApi) => {
23
- const { name: runtimeApiName, methods } = runtimeApi;
24
- runtimeCallsOut += (0, utils_1.commentBlock)(`@runtimeapi: ${runtimeApiName} - ${(0, utils_2.calculateRuntimeApiHash)(runtimeApiName)}`);
25
- runtimeCallsOut += `${(0, util_1.stringCamelCase)(runtimeApiName)}: {
26
- ${methods.map((method) => this.#generateMethodDef(runtimeApiName, method)).join('\n')}
27
-
28
- ${(0, utils_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
29
- }`;
30
- });
31
- }
32
- else {
33
- const specsByModule = this.#runtimeApisSpecsByModule();
34
- Object.values(specsByModule).forEach((specs) => {
35
- specs.forEach(({ methods, runtimeApiName, runtimeApiHash, version }) => {
36
- runtimeCallsOut += (0, utils_1.commentBlock)(`@runtimeapi: ${runtimeApiName} - ${runtimeApiHash}`, `@version: ${version}`);
37
- runtimeCallsOut += `${(0, util_1.stringCamelCase)(runtimeApiName)}: {
38
- ${Object.keys(methods)
39
- .map((methodName) => this.#generateMethodDefFromSpec({ ...methods[methodName], runtimeApiName, methodName }))
40
- .join('\n')}
41
-
42
- ${(0, utils_1.commentBlock)('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
43
- }`;
44
- });
45
- });
46
- }
47
- const importTypes = this.typesGen.typeImports.toImports();
48
- const template = (0, utils_1.compileTemplate)('runtime.hbs');
49
- return (0, utils_1.beautifySourceCode)(template({ importTypes, runtimeCallsOut }));
50
- }
51
- #isOptionalType(type) {
52
- return type.startsWith('Option<') || type.endsWith('| undefined');
53
- }
54
- #isOptionalParam(params, type, idx) {
55
- return this.#isOptionalType(type) && params.slice(idx + 1).every(({ type }) => this.#isOptionalType(type));
56
- }
57
- #generateMethodDefFromSpec(spec) {
58
- const { docs = [], params, type, runtimeApiName, methodName } = spec;
59
- const callName = `${runtimeApiName}_${(0, utils_2.stringSnakeCase)(methodName)}`;
60
- const defaultDocs = [`@callname: ${callName}`];
61
- this.addTypeImport(type, false);
62
- params.forEach(({ type }) => this.addTypeImport(type));
63
- const typedParams = params.map((param, idx) => ({
64
- ...param,
65
- isOptional: this.#isOptionalParam(params, param.type, idx),
66
- plainType: this.getGeneratedTypeName(param.type),
67
- }));
68
- const paramsOut = typedParams
69
- .map(({ name, isOptional, plainType }) => `${(0, util_1.stringCamelCase)(name)}${isOptional ? '?' : ''}: ${plainType}`)
70
- .join(', ');
71
- const typeOut = this.getGeneratedTypeName(type, false);
72
- return `${(0, utils_1.commentBlock)(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
73
- }
74
- #generateMethodDef(runtimeApiName, methodDef) {
75
- const { name: methodName, inputs, output, docs } = methodDef;
76
- const callName = `${runtimeApiName}_${(0, utils_2.stringSnakeCase)(methodName)}`;
77
- const defaultDocs = [`@callname: ${callName}`];
78
- const typeOut = this.typesGen.generateType(output, 1, true);
79
- this.addTypeImport(typeOut, false);
80
- const typedInputs = inputs
81
- .map((input, idx) => ({
82
- ...input,
83
- type: this.typesGen.generateType(input.typeId, 1),
84
- }))
85
- .map((input, idx, inputs) => ({
86
- ...input,
87
- isOptional: this.#isOptionalParam(inputs, input.type, idx),
88
- }));
89
- this.addTypeImport(typedInputs.map((t) => t.type));
90
- const paramsOut = typedInputs
91
- .map(({ name, type, isOptional }) => `${(0, util_1.stringCamelCase)(name)}${isOptional ? '?' : ''}: ${type}`)
92
- .join(', ');
93
- return `${(0, utils_1.commentBlock)(docs, '\n', defaultDocs, typedInputs.map(({ type, name }) => `@param {${type}} ${name}`))}${(0, util_1.stringCamelCase)(methodName)}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
94
- }
95
- #runtimeApisSpecsByModule() {
96
- const specs = this.runtimeApis.map(([runtimeApiHash, version]) => {
97
- const runtimeApiSpec = (0, specs_1.findRuntimeApiSpec)(runtimeApiHash, version);
98
- if (!runtimeApiSpec)
99
- return;
100
- return {
101
- ...runtimeApiSpec,
102
- runtimeApiHash,
103
- };
104
- });
105
- return specs.reduce((o, spec) => {
106
- if (!spec) {
107
- return o;
108
- }
109
- const { moduleName } = spec;
110
- if (!moduleName) {
111
- return o;
112
- }
113
- return {
114
- ...o,
115
- [moduleName]: o[moduleName] ? [...o[moduleName], spec] : [spec],
116
- };
117
- }, {});
118
- }
119
- }
120
- exports.RuntimeApisGen = RuntimeApisGen;
@@ -1,5 +0,0 @@
1
- "use strict";
2
- // THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.packageInfo = void 0;
5
- exports.packageInfo = { name: '@dedot/codegen', version: '0.0.1-alpha.23' };
@@ -1 +0,0 @@
1
- export {};
@@ -1,74 +0,0 @@
1
- import { generateTypes, generateTypesFromChain } from './index';
2
- import { rpc } from '@polkadot/types-support/metadata/static-substrate';
3
- import staticSubstrate from '@polkadot/types-support/metadata/v15/substrate-hex';
4
- import { $Metadata, CodecRegistry } from '@dedot/codecs';
5
- import { ConstantExecutor } from 'dedot';
6
- const NETWORKS = [
7
- {
8
- chain: 'substrate',
9
- metadataHex: staticSubstrate,
10
- rpcMethods: rpc.methods,
11
- },
12
- {
13
- chain: 'polkadot',
14
- endpoint: 'wss://rpc.polkadot.io',
15
- },
16
- {
17
- chain: 'kusama',
18
- endpoint: 'wss://kusama-rpc.polkadot.io',
19
- },
20
- {
21
- chain: 'astar',
22
- endpoint: 'wss://rpc.astar.network',
23
- },
24
- {
25
- chain: 'moonbeam',
26
- endpoint: 'wss://moonbeam.api.onfinality.io/public-ws',
27
- },
28
- {
29
- chain: 'polkadotAssetHub',
30
- endpoint: 'wss://polkadot-asset-hub-rpc.polkadot.io/',
31
- },
32
- {
33
- chain: 'kusamaAssetHub',
34
- endpoint: 'wss://kusama-asset-hub-rpc.polkadot.io/',
35
- },
36
- {
37
- chain: 'rococoAssetHub',
38
- endpoint: 'wss://rococo-asset-hub-rpc.polkadot.io/',
39
- },
40
- {
41
- chain: 'aleph',
42
- endpoint: 'wss://aleph-zero.api.onfinality.io/public-ws',
43
- },
44
- {
45
- chain: 'westendAssetHub',
46
- endpoint: 'wss://westend-asset-hub-rpc.polkadot.io',
47
- },
48
- ];
49
- const OUT_DIR = 'packages/chaintypes/src';
50
- async function run() {
51
- for (const network of NETWORKS) {
52
- const { chain, endpoint, metadataHex, rpcMethods } = network;
53
- if (endpoint) {
54
- console.log(`Generate types for ${chain} via endpoint ${endpoint}`);
55
- await generateTypesFromChain(network, endpoint, OUT_DIR);
56
- }
57
- else if (metadataHex && rpcMethods) {
58
- console.log(`Generate types for ${chain} via raw data`);
59
- const metadata = $Metadata.tryDecode(metadataHex);
60
- const runtimeVersion = getRuntimeVersion(metadata);
61
- await generateTypes(network, metadata.latest, rpcMethods, runtimeVersion.apis, OUT_DIR);
62
- }
63
- }
64
- console.log('DONE!');
65
- }
66
- const getRuntimeVersion = (metadata) => {
67
- const registry = new CodecRegistry(metadata.latest);
68
- const executor = new ConstantExecutor({
69
- registry,
70
- metadataLatest: metadata.latest,
71
- });
72
- return executor.execute('system', 'version');
73
- };
74
- run().catch(console.log);
@@ -1,4 +0,0 @@
1
- import { ApiGen } from '../generator';
2
- export declare class ConstsGen extends ApiGen {
3
- generate(): Promise<string>;
4
- }
@@ -1,5 +0,0 @@
1
- import { ApiGen } from './ApiGen';
2
- export declare class ErrorsGen extends ApiGen {
3
- #private;
4
- generate(): Promise<string>;
5
- }
@@ -1,5 +0,0 @@
1
- import { ApiGen } from './ApiGen';
2
- export declare class EventsGen extends ApiGen {
3
- #private;
4
- generate(): Promise<string>;
5
- }
@@ -1,6 +0,0 @@
1
- import { NetworkInfo } from '../types';
2
- export declare class IndexGen {
3
- readonly networkInfo: NetworkInfo;
4
- constructor(networkInfo: NetworkInfo);
5
- generate(): Promise<string>;
6
- }
@@ -1,14 +0,0 @@
1
- import { beautifySourceCode, compileTemplate } from './utils';
2
- import { stringPascalCase } from '@polkadot/util';
3
- export class IndexGen {
4
- networkInfo;
5
- constructor(networkInfo) {
6
- this.networkInfo = networkInfo;
7
- }
8
- async generate() {
9
- const { chain } = this.networkInfo;
10
- const interfaceName = stringPascalCase(chain);
11
- const template = compileTemplate('index.hbs');
12
- return beautifySourceCode(template({ interfaceName }));
13
- }
14
- }
@@ -1,5 +0,0 @@
1
- import { ApiGen } from '../generator';
2
- export declare class QueryGen extends ApiGen {
3
- #private;
4
- generate(): Promise<string>;
5
- }
@@ -1,55 +0,0 @@
1
- import { stringLowerFirst } from '@polkadot/util';
2
- import { normalizeName } from '@dedot/utils';
3
- import { ApiGen } from '../generator';
4
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils';
5
- export class QueryGen extends ApiGen {
6
- generate() {
7
- const { pallets } = this.metadata;
8
- this.typesGen.clearCache();
9
- this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
10
- let defTypeOut = '';
11
- for (let pallet of pallets) {
12
- const storage = pallet.storage;
13
- if (!storage)
14
- continue;
15
- const queries = storage.entries.map((one) => this.#generateEntry(one));
16
- const queryDefs = queries.map(({ name, valueType, keyType, docs }) => `${commentBlock(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}>`);
17
- defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s storage queries`);
18
- defTypeOut += `${stringLowerFirst(pallet.name)}: {
19
- ${queryDefs.join(',\n')}
20
-
21
- ${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery;
22
- },`;
23
- }
24
- const importTypes = this.typesGen.typeImports.toImports();
25
- const template = compileTemplate('query.hbs');
26
- return beautifySourceCode(template({ importTypes, defTypeOut }));
27
- }
28
- #generateEntry(entry) {
29
- const { name, type, docs, modifier } = entry;
30
- let valueType, keyType;
31
- if (type.tag === 'Plain') {
32
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
33
- }
34
- else if (type.tag === 'Map') {
35
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
36
- keyType = this.typesGen.generateType(type.value.keyTypeId, 1);
37
- }
38
- else {
39
- throw Error('Invalid entry type!');
40
- }
41
- const isOptional = modifier === 'Optional';
42
- valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
43
- docs.push('\n');
44
- if (keyType) {
45
- docs.push(`@param {${keyType}} arg`);
46
- }
47
- docs.push(`@param {Callback<${valueType}> =} callback`);
48
- return {
49
- name: normalizeName(name),
50
- valueType,
51
- keyType: keyType ? `arg: ${keyType}` : '',
52
- docs,
53
- };
54
- }
55
- }
@@ -1,10 +0,0 @@
1
- import { ApiGen, TypesGen } from '../generator';
2
- export declare class RpcGen extends ApiGen {
3
- #private;
4
- readonly typesGen: TypesGen;
5
- readonly rpcMethods: string[];
6
- constructor(typesGen: TypesGen, rpcMethods: string[]);
7
- generate(): Promise<string>;
8
- addTypeImport(type: string | string[], toTypeIn?: boolean): void;
9
- getGeneratedTypeName(type: string, toTypeIn?: boolean): string;
10
- }