@dedot/codegen 0.0.1-next.9dacef43.1 → 0.0.1-next.a5b1d2fb.22

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 (154) hide show
  1. package/{generator → chaintypes/generator}/ApiGen.d.ts +2 -2
  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 +9 -10
  6. package/chaintypes/generator/EventsGen.d.ts +5 -0
  7. package/{generator → chaintypes/generator}/EventsGen.js +9 -10
  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/{generator → chaintypes/generator}/QueryGen.js +24 -16
  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 +14 -12
  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/{cjs → chaintypes}/templates/types.hbs +1 -1
  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 +16 -17
  36. package/cjs/chaintypes/generator/IndexGen.js +21 -0
  37. package/cjs/chaintypes/generator/JsonRpcGen.js +59 -0
  38. package/cjs/{generator → chaintypes/generator}/QueryGen.js +26 -18
  39. package/cjs/chaintypes/generator/RuntimeApisGen.js +193 -0
  40. package/cjs/{generator → chaintypes/generator}/TxGen.js +23 -21
  41. package/cjs/chaintypes/generator/TypesGen.js +59 -0
  42. package/cjs/chaintypes/generator/index.js +26 -0
  43. package/cjs/chaintypes/index.js +76 -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/{templates → cjs/chaintypes/templates}/types.hbs +1 -1
  53. package/cjs/{generator/dirname.js → dirname.js} +0 -1
  54. package/cjs/index.js +4 -62
  55. package/cjs/{generator/TypesGen.js → shared/BaseTypesGen.js} +102 -160
  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 +35 -0
  65. package/cjs/typink/generator/index.js +22 -0
  66. package/cjs/typink/index.js +36 -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} +34 -5
  74. package/index.d.ts +2 -4
  75. package/index.js +2 -48
  76. package/package.json +16 -18
  77. package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts} +13 -12
  78. package/{generator/TypesGen.js → shared/BaseTypesGen.js} +89 -147
  79. package/{generator → shared}/TypeImports.d.ts +12 -1
  80. package/{generator → shared}/TypeImports.js +29 -3
  81. package/shared/index.d.ts +3 -0
  82. package/shared/index.js +3 -0
  83. package/shared/known-codecs.d.ts +23 -0
  84. package/shared/known-codecs.js +139 -0
  85. package/typink/generator/ConstructorQueryGen.d.ts +6 -0
  86. package/typink/generator/ConstructorQueryGen.js +20 -0
  87. package/typink/generator/ConstructorTxGen.d.ts +6 -0
  88. package/typink/generator/ConstructorTxGen.js +20 -0
  89. package/typink/generator/IndexGen.d.ts +6 -0
  90. package/typink/generator/IndexGen.js +20 -0
  91. package/typink/generator/QueryGen.d.ts +12 -0
  92. package/typink/generator/QueryGen.js +68 -0
  93. package/typink/generator/TxGen.d.ts +6 -0
  94. package/typink/generator/TxGen.js +21 -0
  95. package/typink/generator/TypesGen.d.ts +8 -0
  96. package/typink/generator/TypesGen.js +31 -0
  97. package/typink/generator/index.d.ts +6 -0
  98. package/typink/generator/index.js +6 -0
  99. package/typink/index.d.ts +2 -0
  100. package/typink/index.js +30 -0
  101. package/typink/templates/constructor-query.hbs +7 -0
  102. package/typink/templates/constructor-tx.hbs +7 -0
  103. package/typink/templates/index.hbs +14 -0
  104. package/typink/templates/query.hbs +7 -0
  105. package/typink/templates/tx.hbs +7 -0
  106. package/typink/templates/types.hbs +5 -0
  107. package/{generator/utils.d.ts → utils.d.ts} +6 -1
  108. package/{generator/utils.js → utils.js} +32 -4
  109. package/cjs/genSupportedChainTypes.js +0 -79
  110. package/cjs/generator/ErrorsGen.js +0 -41
  111. package/cjs/generator/IndexGen.js +0 -18
  112. package/cjs/generator/RpcGen.js +0 -175
  113. package/cjs/generator/RuntimeApisGen.js +0 -115
  114. package/cjs/packageInfo.js +0 -5
  115. package/cjs/templates/consts.hbs +0 -7
  116. package/cjs/templates/errors.hbs +0 -7
  117. package/cjs/templates/events.hbs +0 -7
  118. package/cjs/templates/index.hbs +0 -22
  119. package/cjs/templates/query.hbs +0 -7
  120. package/cjs/templates/rpc.hbs +0 -7
  121. package/cjs/templates/runtime.hbs +0 -8
  122. package/cjs/templates/tx.hbs +0 -9
  123. package/cjs/types.js +0 -2
  124. package/genSupportedChainTypes.d.ts +0 -1
  125. package/genSupportedChainTypes.js +0 -74
  126. package/generator/ConstsGen.d.ts +0 -4
  127. package/generator/ErrorsGen.d.ts +0 -5
  128. package/generator/EventsGen.d.ts +0 -5
  129. package/generator/IndexGen.d.ts +0 -6
  130. package/generator/IndexGen.js +0 -14
  131. package/generator/QueryGen.d.ts +0 -5
  132. package/generator/RpcGen.d.ts +0 -10
  133. package/generator/RpcGen.js +0 -171
  134. package/generator/RuntimeApisGen.d.ts +0 -9
  135. package/generator/RuntimeApisGen.js +0 -111
  136. package/generator/TxGen.d.ts +0 -5
  137. package/generator/index.d.ts +0 -10
  138. package/generator/index.js +0 -10
  139. package/packageInfo.d.ts +0 -4
  140. package/packageInfo.js +0 -2
  141. package/templates/consts.hbs +0 -7
  142. package/templates/errors.hbs +0 -7
  143. package/templates/events.hbs +0 -7
  144. package/templates/index.hbs +0 -22
  145. package/templates/query.hbs +0 -7
  146. package/templates/rpc.hbs +0 -7
  147. package/templates/runtime.hbs +0 -8
  148. package/templates/tx.hbs +0 -9
  149. package/types.d.ts +0 -6
  150. package/types.js +0 -1
  151. /package/{generator → chaintypes/generator}/ApiGen.js +0 -0
  152. /package/cjs/{generator → chaintypes/generator}/ApiGen.js +0 -0
  153. /package/{generator/dirname.d.ts → dirname.d.ts} +0 -0
  154. /package/{generator/dirname.js → dirname.js} +0 -0
@@ -0,0 +1,12 @@
1
+ import { ContractMetadata, Message, ContractMessageArg } from '@dedot/contracts';
2
+ import { TypesGen } from './TypesGen.js';
3
+ export declare class QueryGen {
4
+ contractMetadata: ContractMetadata;
5
+ typesGen: TypesGen;
6
+ constructor(contractMetadata: ContractMetadata, typeGen: TypesGen);
7
+ generate(useSubPaths?: boolean): Promise<string>;
8
+ doGenerate(messages: Message[], optionsTypeName?: string): string;
9
+ generateMethodDef(def: Message): string;
10
+ generateParamsOut(args: ContractMessageArg[]): string;
11
+ importType(typeId: number): any;
12
+ }
@@ -0,0 +1,68 @@
1
+ import { normalizeContractTypeDef, normalizeLabel, } from '@dedot/contracts';
2
+ import { stringCamelCase } from '@dedot/utils';
3
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
4
+ export class QueryGen {
5
+ contractMetadata;
6
+ typesGen;
7
+ constructor(contractMetadata, typeGen) {
8
+ this.contractMetadata = contractMetadata;
9
+ this.typesGen = typeGen;
10
+ }
11
+ generate(useSubPaths = false) {
12
+ this.typesGen.clearCache();
13
+ this.typesGen.typeImports.addKnownType('GenericSubstrateApi');
14
+ this.typesGen.typeImports.addContractType('GenericContractQuery', 'GenericContractQueryCall', 'ContractCallOptions', 'GenericContractCallResult', 'ContractCallResult');
15
+ const { messages } = this.contractMetadata.spec;
16
+ const queryCallsOut = this.doGenerate(messages, 'ContractCallOptions');
17
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
18
+ const template = compileTemplate('typink/templates/query.hbs');
19
+ return beautifySourceCode(template({ importTypes, queryCallsOut }));
20
+ }
21
+ doGenerate(messages, optionsTypeName) {
22
+ let callsOut = '';
23
+ messages.forEach((messageDef) => {
24
+ const { label, docs, selector, args } = messageDef;
25
+ callsOut += `${commentBlock(docs, '\n', args.map((arg) => `@param {${this.typesGen.generateType(arg.type.type, 1)}} ${stringCamelCase(arg.label)}`), optionsTypeName ? `@param {${optionsTypeName}} options` : '', '\n', `@selector ${selector}`)}`;
26
+ callsOut += `${normalizeLabel(label)}: ${this.generateMethodDef(messageDef)};\n\n`;
27
+ });
28
+ return callsOut;
29
+ }
30
+ generateMethodDef(def) {
31
+ const { args, returnType } = def;
32
+ this.importType(returnType.type);
33
+ args.forEach(({ type: { type } }) => this.importType(type));
34
+ const paramsOut = this.generateParamsOut(args);
35
+ const typeOut = this.typesGen.generateType(returnType.type, 0, true);
36
+ return `GenericContractQueryCall<ChainApi, (${paramsOut && `${paramsOut},`} options: ContractCallOptions) => Promise<GenericContractCallResult<${typeOut}, ContractCallResult<ChainApi>>>>`;
37
+ }
38
+ generateParamsOut(args) {
39
+ return args
40
+ .map(({ type: { type }, label }) => `${stringCamelCase(label)}: ${this.typesGen.generateType(type, 1)}`)
41
+ .join(', ');
42
+ }
43
+ importType(typeId) {
44
+ const type = this.contractMetadata.types[typeId];
45
+ const def = normalizeContractTypeDef(this.contractMetadata.types[typeId].type.def);
46
+ if (this.typesGen.includedTypes[type.id]) {
47
+ this.typesGen.addTypeImport(this.typesGen.includedTypes[type.id].name);
48
+ return;
49
+ }
50
+ const { tag, value } = def;
51
+ switch (tag) {
52
+ case 'Compact':
53
+ case 'Primitive':
54
+ case 'BitSequence':
55
+ return;
56
+ case 'Struct':
57
+ return value.fields.forEach(({ typeId }) => this.importType(typeId));
58
+ case 'Enum':
59
+ return value.members.forEach(({ fields }) => fields.map(({ typeId }) => this.importType(typeId)).flat());
60
+ case 'Tuple':
61
+ return value.fields.forEach((typeId) => this.importType(typeId));
62
+ case 'SizedVec':
63
+ return this.importType(value.typeParam);
64
+ case 'Sequence':
65
+ return this.importType(value.typeParam);
66
+ }
67
+ }
68
+ }
@@ -0,0 +1,6 @@
1
+ import { Message } from '@dedot/contracts';
2
+ import { QueryGen } from './QueryGen.js';
3
+ export declare class TxGen extends QueryGen {
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
+ generateMethodDef(def: Message): string;
6
+ }
@@ -0,0 +1,21 @@
1
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
2
+ import { QueryGen } from './QueryGen.js';
3
+ export class TxGen extends QueryGen {
4
+ generate(useSubPaths = false) {
5
+ this.typesGen.clearCache();
6
+ this.typesGen.typeImports.addKnownType('GenericSubstrateApi');
7
+ this.typesGen.typeImports.addContractType('GenericContractTx', 'GenericContractTxCall', 'ContractTxOptions', 'ContractSubmittableExtrinsic');
8
+ const { messages } = this.contractMetadata.spec;
9
+ const txMessages = messages.filter((one) => one.mutates);
10
+ const txCallsOut = this.doGenerate(txMessages, 'ContractTxOptions');
11
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
12
+ const template = compileTemplate('typink/templates/tx.hbs');
13
+ return beautifySourceCode(template({ importTypes, txCallsOut }));
14
+ }
15
+ generateMethodDef(def) {
16
+ const { args } = def;
17
+ args.forEach(({ type: { type } }) => this.importType(type));
18
+ const paramsOut = this.generateParamsOut(args);
19
+ return `GenericContractTxCall<ChainApi, (${paramsOut && `${paramsOut},`} options: ContractTxOptions) => ContractSubmittableExtrinsic<ChainApi>>`;
20
+ }
21
+ }
@@ -0,0 +1,8 @@
1
+ import { ContractMetadata } from '@dedot/contracts';
2
+ import { BaseTypesGen } from '../../shared/index.js';
3
+ export declare class TypesGen extends BaseTypesGen {
4
+ contractMetadata: ContractMetadata;
5
+ constructor(contractMetadata: ContractMetadata);
6
+ generate(useSubPaths?: boolean): Promise<string>;
7
+ shouldGenerateTypeIn(id: number): boolean;
8
+ }
@@ -0,0 +1,31 @@
1
+ import { extractContractTypes } from '@dedot/contracts';
2
+ import { BaseTypesGen } from '../../shared/index.js';
3
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
4
+ const SKIP_TYPES = ['Result', 'Option'];
5
+ export class TypesGen extends BaseTypesGen {
6
+ contractMetadata;
7
+ constructor(contractMetadata) {
8
+ super(extractContractTypes(contractMetadata));
9
+ this.contractMetadata = contractMetadata;
10
+ this.skipTypes = SKIP_TYPES;
11
+ this.includedTypes = this.includeTypes();
12
+ }
13
+ generate(useSubPaths = false) {
14
+ let defTypeOut = '';
15
+ Object.values(this.includedTypes)
16
+ .filter(({ skip, knownType }) => !(skip || knownType))
17
+ .forEach(({ name, nameOut, id }) => {
18
+ defTypeOut += `export type ${nameOut} = ${this.generateType(id, 0, true)};\n\n`;
19
+ if (this.shouldGenerateTypeIn(id)) {
20
+ defTypeOut += `export type ${name} = ${this.generateType(id)};\n\n`;
21
+ }
22
+ });
23
+ const importTypes = this.typeImports.toImports({ excludeModules: ['./types'], useSubPaths });
24
+ const template = compileTemplate('typink/templates/types.hbs');
25
+ return beautifySourceCode(template({ importTypes, defTypeOut }));
26
+ }
27
+ shouldGenerateTypeIn(id) {
28
+ const { messages } = this.contractMetadata.spec;
29
+ return messages.some((message) => message.returnType.type === id);
30
+ }
31
+ }
@@ -0,0 +1,6 @@
1
+ export * from './IndexGen.js';
2
+ export * from './QueryGen.js';
3
+ export * from './TypesGen.js';
4
+ export * from './TxGen.js';
5
+ export * from './ConstructorTxGen.js';
6
+ export * from './ConstructorQueryGen.js';
@@ -0,0 +1,6 @@
1
+ export * from './IndexGen.js';
2
+ export * from './QueryGen.js';
3
+ export * from './TypesGen.js';
4
+ export * from './TxGen.js';
5
+ export * from './ConstructorTxGen.js';
6
+ export * from './ConstructorQueryGen.js';
@@ -0,0 +1,2 @@
1
+ import { ContractMetadata } from '@dedot/contracts';
2
+ export declare function generateContractTypes(metadata: ContractMetadata | string, contract?: string, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;
@@ -0,0 +1,30 @@
1
+ import { parseRawMetadata } from '@dedot/contracts';
2
+ import fs from 'fs';
3
+ import path from 'path';
4
+ import { IndexGen, QueryGen, TxGen, TypesGen, ConstructorTxGen, ConstructorQueryGen } from './generator/index.js';
5
+ export async function generateContractTypes(metadata, contract, outDir = '.', extension = 'd.ts', useSubPaths = false) {
6
+ let contractMetadata = typeof metadata === 'string' ? parseRawMetadata(metadata) : metadata;
7
+ contract = contract || contractMetadata.contract.name;
8
+ const dirPath = path.resolve(outDir, contract);
9
+ const typesFileName = path.join(dirPath, `types.${extension}`);
10
+ const queryTypesFileName = path.join(dirPath, `query.${extension}`);
11
+ const txTypesFileName = path.join(dirPath, `tx.${extension}`);
12
+ const constructorTxTypesFileName = path.join(dirPath, `constructor-tx.${extension}`);
13
+ const constructorQueryTypesFileName = path.join(dirPath, `constructor-query.${extension}`);
14
+ const indexTypesFileName = path.join(dirPath, `index.${extension}`);
15
+ if (!fs.existsSync(dirPath)) {
16
+ fs.mkdirSync(dirPath, { recursive: true });
17
+ }
18
+ const typesGen = new TypesGen(contractMetadata);
19
+ const queryGen = new QueryGen(contractMetadata, typesGen);
20
+ const txGen = new TxGen(contractMetadata, typesGen);
21
+ const constructorTxGen = new ConstructorTxGen(contractMetadata, typesGen);
22
+ const constructorQueryGen = new ConstructorQueryGen(contractMetadata, typesGen);
23
+ const indexGen = new IndexGen(contractMetadata);
24
+ fs.writeFileSync(typesFileName, await typesGen.generate(useSubPaths));
25
+ fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
26
+ fs.writeFileSync(txTypesFileName, await txGen.generate(useSubPaths));
27
+ fs.writeFileSync(constructorQueryTypesFileName, await constructorQueryGen.generate(useSubPaths));
28
+ fs.writeFileSync(constructorTxTypesFileName, await constructorTxGen.generate(useSubPaths));
29
+ fs.writeFileSync(indexTypesFileName, await indexGen.generate(useSubPaths));
30
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ConstructorQuery<ChainApi extends GenericSubstrateApi> extends GenericConstructorQuery<ChainApi> {
6
+ {{{ constructorsOut }}}
7
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ConstructorTx<ChainApi extends GenericSubstrateApi> extends GenericConstructorTx<ChainApi> {
6
+ {{{ constructorsOut }}}
7
+ }
@@ -0,0 +1,14 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{importTypes}}}
4
+ import { ContractQuery } from './query';
5
+ import { ContractTx } from './tx';
6
+ import { ConstructorQuery } from './constructor-query';
7
+ import { ConstructorTx } from './constructor-tx';
8
+
9
+ export interface {{{contractName}}}<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends GenericContractApi<ChainApi> {
10
+ query: ContractQuery<ChainApi[RpcVersion]>;
11
+ tx: ContractTx<ChainApi[RpcVersion]>;
12
+ constructorQuery: ConstructorQuery<ChainApi[RpcVersion]>;
13
+ constructorTx: ConstructorTx<ChainApi[RpcVersion]>;
14
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ContractQuery<ChainApi extends GenericSubstrateApi> extends GenericContractQuery<ChainApi> {
6
+ {{{ queryCallsOut }}}
7
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ContractTx<ChainApi extends GenericSubstrateApi> extends GenericContractTx<ChainApi> {
6
+ {{{ txCallsOut }}}
7
+ }
@@ -0,0 +1,5 @@
1
+ // Generated by dedot cli
2
+
3
+ {{{ importTypes }}}
4
+
5
+ {{{ defTypeOut }}}
@@ -2,9 +2,14 @@ export declare const WRAPPER_TYPE_REGEX: RegExp;
2
2
  export declare const TUPLE_TYPE_REGEX: RegExp;
3
3
  export declare const commentBlock: (...docs: (string | string[])[]) => string;
4
4
  export declare const beautifySourceCode: (source: string) => Promise<string>;
5
- export declare const compileTemplate: (templateFileName: string) => HandlebarsTemplateDelegate<any>;
5
+ export declare const compileTemplate: (templateFile: string) => HandlebarsTemplateDelegate<any>;
6
6
  /**
7
7
  * Check if a word is TypeScript/JavaScript reserved
8
8
  * @param word
9
9
  */
10
10
  export declare const isReservedWord: (word: string) => boolean;
11
+ /**
12
+ * Check if a type is native JS/TS type
13
+ * @param type
14
+ */
15
+ export declare const isNativeType: (type: string) => boolean;
@@ -7,7 +7,7 @@ export const WRAPPER_TYPE_REGEX = /^(\w+)<(.*)>$/;
7
7
  export const TUPLE_TYPE_REGEX = /^\[(.*)]$/;
8
8
  export const commentBlock = (...docs) => {
9
9
  const flatLines = docs.flat();
10
- if (flatLines.length === 0) {
10
+ if (flatLines.length === 0 || !flatLines.find((o) => !!o)) {
11
11
  return '';
12
12
  }
13
13
  else {
@@ -19,11 +19,11 @@ ${flatLines.map((line) => `* ${line.replaceAll(/\s+/g, ' ').trim()}`).join('\n')
19
19
  }
20
20
  };
21
21
  export const beautifySourceCode = async (source) => {
22
- const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '../../../../.prettierrc.js'));
22
+ const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '../../../.prettierrc.cjs'));
23
23
  return prettier.format(source, { parser: 'babel-ts', ...prettierOptions });
24
24
  };
25
- export const compileTemplate = (templateFileName) => {
26
- const templateFilePath = path.resolve(currentDirname(), `../templates/${templateFileName}`);
25
+ export const compileTemplate = (templateFile) => {
26
+ const templateFilePath = path.resolve(currentDirname(), templateFile);
27
27
  return handlebars.compile(fs.readFileSync(templateFilePath, 'utf8'));
28
28
  };
29
29
  // TODO add more reserved words
@@ -33,3 +33,31 @@ const TS_RESERVED_WORDS = ['new', 'class'];
33
33
  * @param word
34
34
  */
35
35
  export const isReservedWord = (word) => TS_RESERVED_WORDS.includes(word);
36
+ const TS_PRIMITIVE_TYPES = [
37
+ 'void',
38
+ 'undefined',
39
+ 'null',
40
+ 'number',
41
+ 'boolean',
42
+ 'bigint',
43
+ 'Map',
44
+ 'Set',
45
+ 'string',
46
+ 'any',
47
+ 'Array',
48
+ 'Record',
49
+ ];
50
+ /**
51
+ * Check if a type is native JS/TS type
52
+ * @param type
53
+ */
54
+ export const isNativeType = (type) => {
55
+ return TS_PRIMITIVE_TYPES.some((one) => {
56
+ if (typeof one === 'string') {
57
+ return one === type;
58
+ }
59
+ else {
60
+ return type.match(one);
61
+ }
62
+ });
63
+ };
@@ -1,79 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const index_1 = require("./index");
7
- const static_substrate_1 = require("@polkadot/types-support/metadata/static-substrate");
8
- const substrate_hex_1 = __importDefault(require("@polkadot/types-support/metadata/v15/substrate-hex"));
9
- const codecs_1 = require("@dedot/codecs");
10
- const dedot_1 = require("dedot");
11
- const NETWORKS = [
12
- {
13
- chain: 'substrate',
14
- metadataHex: substrate_hex_1.default,
15
- rpcMethods: static_substrate_1.rpc.methods,
16
- },
17
- {
18
- chain: 'polkadot',
19
- endpoint: 'wss://rpc.polkadot.io',
20
- },
21
- {
22
- chain: 'kusama',
23
- endpoint: 'wss://kusama-rpc.polkadot.io',
24
- },
25
- {
26
- chain: 'astar',
27
- endpoint: 'wss://rpc.astar.network',
28
- },
29
- {
30
- chain: 'moonbeam',
31
- endpoint: 'wss://moonbeam.api.onfinality.io/public-ws',
32
- },
33
- {
34
- chain: 'polkadotAssetHub',
35
- endpoint: 'wss://polkadot-asset-hub-rpc.polkadot.io/',
36
- },
37
- {
38
- chain: 'kusamaAssetHub',
39
- endpoint: 'wss://kusama-asset-hub-rpc.polkadot.io/',
40
- },
41
- {
42
- chain: 'rococoAssetHub',
43
- endpoint: 'wss://rococo-asset-hub-rpc.polkadot.io/',
44
- },
45
- {
46
- chain: 'aleph',
47
- endpoint: 'wss://aleph-zero.api.onfinality.io/public-ws',
48
- },
49
- {
50
- chain: 'westendAssetHub',
51
- endpoint: 'wss://westend-asset-hub-rpc.polkadot.io',
52
- },
53
- ];
54
- const OUT_DIR = 'packages/chaintypes/src';
55
- async function run() {
56
- for (const network of NETWORKS) {
57
- const { chain, endpoint, metadataHex, rpcMethods } = network;
58
- if (endpoint) {
59
- console.log(`Generate types for ${chain} via endpoint ${endpoint}`);
60
- await (0, index_1.generateTypesFromChain)(network, endpoint, OUT_DIR);
61
- }
62
- else if (metadataHex && rpcMethods) {
63
- console.log(`Generate types for ${chain} via raw data`);
64
- const metadata = codecs_1.$Metadata.tryDecode(metadataHex);
65
- const runtimeVersion = getRuntimeVersion(metadata);
66
- await (0, index_1.generateTypes)(network, metadata.latest, rpcMethods, runtimeVersion.apis, OUT_DIR);
67
- }
68
- }
69
- console.log('DONE!');
70
- }
71
- const getRuntimeVersion = (metadata) => {
72
- const registry = new codecs_1.CodecRegistry(metadata.latest);
73
- const executor = new dedot_1.ConstantExecutor({
74
- registry,
75
- metadataLatest: metadata.latest,
76
- });
77
- return executor.execute('system', 'version');
78
- };
79
- run().catch(console.log);
@@ -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,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;