@dedot/codegen 0.0.1-alpha.34 → 0.0.1-alpha.35

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 (112) hide show
  1. package/{generator → chaintypes/generator}/ApiGen.d.ts +12 -12
  2. package/{generator → chaintypes/generator}/ConstsGen.js +2 -2
  3. package/{generator → chaintypes/generator}/ErrorsGen.js +4 -4
  4. package/{generator → chaintypes/generator}/EventsGen.js +4 -4
  5. package/{generator → chaintypes/generator}/IndexGen.js +3 -3
  6. package/{generator → chaintypes/generator}/JsonRpcGen.js +2 -2
  7. package/{generator → chaintypes/generator}/QueryGen.js +9 -9
  8. package/{generator → chaintypes/generator}/RuntimeApisGen.js +3 -3
  9. package/{generator → chaintypes/generator}/TxGen.js +6 -6
  10. package/chaintypes/generator/TypesGen.d.ts +11 -0
  11. package/chaintypes/generator/TypesGen.js +55 -0
  12. package/chaintypes/index.d.ts +3 -0
  13. package/chaintypes/index.js +49 -0
  14. package/{cjs → chaintypes}/templates/consts.hbs +1 -1
  15. package/{templates → chaintypes/templates}/errors.hbs +1 -1
  16. package/{templates → chaintypes/templates}/events.hbs +1 -1
  17. package/{templates → chaintypes/templates}/index.hbs +1 -1
  18. package/{templates → chaintypes/templates}/json-rpc.hbs +1 -1
  19. package/{templates → chaintypes/templates}/query.hbs +1 -1
  20. package/{templates → chaintypes/templates}/runtime.hbs +1 -1
  21. package/{cjs → chaintypes}/templates/tx.hbs +1 -1
  22. package/{cjs → chaintypes}/templates/types.hbs +1 -1
  23. package/cjs/{generator → chaintypes/generator}/ConstsGen.js +2 -2
  24. package/cjs/{generator → chaintypes/generator}/ErrorsGen.js +4 -4
  25. package/cjs/{generator → chaintypes/generator}/EventsGen.js +4 -4
  26. package/cjs/{generator → chaintypes/generator}/IndexGen.js +4 -4
  27. package/cjs/{generator → chaintypes/generator}/JsonRpcGen.js +2 -2
  28. package/cjs/{generator → chaintypes/generator}/QueryGen.js +9 -9
  29. package/cjs/{generator → chaintypes/generator}/RuntimeApisGen.js +4 -4
  30. package/cjs/{generator → chaintypes/generator}/TxGen.js +6 -6
  31. package/cjs/chaintypes/generator/TypesGen.js +59 -0
  32. package/cjs/chaintypes/index.js +77 -0
  33. package/{templates → cjs/chaintypes/templates}/consts.hbs +1 -1
  34. package/cjs/{templates → chaintypes/templates}/errors.hbs +1 -1
  35. package/cjs/{templates → chaintypes/templates}/events.hbs +1 -1
  36. package/cjs/{templates → chaintypes/templates}/index.hbs +1 -1
  37. package/cjs/{templates → chaintypes/templates}/json-rpc.hbs +1 -1
  38. package/cjs/{templates → chaintypes/templates}/query.hbs +1 -1
  39. package/cjs/{templates → chaintypes/templates}/runtime.hbs +1 -1
  40. package/{templates → cjs/chaintypes/templates}/tx.hbs +1 -1
  41. package/{templates → cjs/chaintypes/templates}/types.hbs +1 -1
  42. package/cjs/index.js +4 -63
  43. package/cjs/{generator/TypesGen.js → shared/BaseTypesGen.js} +111 -159
  44. package/cjs/{generator → shared}/TypeImports.js +16 -0
  45. package/cjs/shared/index.js +19 -0
  46. package/cjs/{generator → shared}/known-codecs.js +23 -4
  47. package/cjs/typink/generator/ConstructorQueryGen.js +24 -0
  48. package/cjs/typink/generator/ConstructorTxGen.js +24 -0
  49. package/cjs/typink/generator/IndexGen.js +24 -0
  50. package/cjs/typink/generator/QueryGen.js +72 -0
  51. package/cjs/typink/generator/TxGen.js +25 -0
  52. package/cjs/typink/generator/TypesGen.js +28 -0
  53. package/cjs/typink/generator/index.js +22 -0
  54. package/cjs/typink/index.js +37 -0
  55. package/cjs/typink/templates/constructor-query.hbs +7 -0
  56. package/cjs/typink/templates/constructor-tx.hbs +7 -0
  57. package/cjs/typink/templates/index.hbs +14 -0
  58. package/cjs/typink/templates/query.hbs +7 -0
  59. package/cjs/typink/templates/tx.hbs +7 -0
  60. package/cjs/typink/templates/types.hbs +5 -0
  61. package/cjs/{generator/utils.js → utils.js} +4 -4
  62. package/index.d.ts +2 -3
  63. package/index.js +2 -49
  64. package/package.json +12 -12
  65. package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts} +12 -11
  66. package/{generator/TypesGen.js → shared/BaseTypesGen.js} +108 -156
  67. package/{generator → shared}/TypeImports.d.ts +4 -0
  68. package/{generator → shared}/TypeImports.js +16 -0
  69. package/shared/index.d.ts +3 -0
  70. package/shared/index.js +3 -0
  71. package/{generator → shared}/known-codecs.d.ts +2 -2
  72. package/{generator → shared}/known-codecs.js +21 -2
  73. package/typink/generator/ConstructorQueryGen.d.ts +6 -0
  74. package/typink/generator/ConstructorQueryGen.js +20 -0
  75. package/typink/generator/ConstructorTxGen.d.ts +6 -0
  76. package/typink/generator/ConstructorTxGen.js +20 -0
  77. package/typink/generator/IndexGen.d.ts +6 -0
  78. package/typink/generator/IndexGen.js +20 -0
  79. package/typink/generator/QueryGen.d.ts +12 -0
  80. package/typink/generator/QueryGen.js +68 -0
  81. package/typink/generator/TxGen.d.ts +6 -0
  82. package/typink/generator/TxGen.js +21 -0
  83. package/typink/generator/TypesGen.d.ts +7 -0
  84. package/typink/generator/TypesGen.js +24 -0
  85. package/typink/generator/index.d.ts +6 -0
  86. package/typink/generator/index.js +6 -0
  87. package/typink/index.d.ts +2 -0
  88. package/typink/index.js +30 -0
  89. package/typink/templates/constructor-query.hbs +7 -0
  90. package/typink/templates/constructor-tx.hbs +7 -0
  91. package/typink/templates/index.hbs +14 -0
  92. package/typink/templates/query.hbs +7 -0
  93. package/typink/templates/tx.hbs +7 -0
  94. package/typink/templates/types.hbs +5 -0
  95. package/{generator/utils.d.ts → utils.d.ts} +1 -1
  96. package/{generator/utils.js → utils.js} +4 -4
  97. /package/{generator → chaintypes/generator}/ApiGen.js +0 -0
  98. /package/{generator → chaintypes/generator}/ConstsGen.d.ts +0 -0
  99. /package/{generator → chaintypes/generator}/ErrorsGen.d.ts +0 -0
  100. /package/{generator → chaintypes/generator}/EventsGen.d.ts +0 -0
  101. /package/{generator → chaintypes/generator}/IndexGen.d.ts +0 -0
  102. /package/{generator → chaintypes/generator}/JsonRpcGen.d.ts +0 -0
  103. /package/{generator → chaintypes/generator}/QueryGen.d.ts +0 -0
  104. /package/{generator → chaintypes/generator}/RuntimeApisGen.d.ts +0 -0
  105. /package/{generator → chaintypes/generator}/TxGen.d.ts +0 -0
  106. /package/{generator → chaintypes/generator}/index.d.ts +0 -0
  107. /package/{generator → chaintypes/generator}/index.js +0 -0
  108. /package/cjs/{generator → chaintypes/generator}/ApiGen.js +0 -0
  109. /package/cjs/{generator → chaintypes/generator}/index.js +0 -0
  110. /package/cjs/{generator/dirname.js → dirname.js} +0 -0
  111. /package/{generator/dirname.d.ts → dirname.d.ts} +0 -0
  112. /package/{generator/dirname.js → dirname.js} +0 -0
@@ -10,13 +10,13 @@ export declare abstract class ApiGen {
10
10
  name: string;
11
11
  typeId: number | undefined;
12
12
  }[];
13
- type: {
14
- tag: "Struct";
13
+ typeDef: {
14
+ type: "Struct";
15
15
  value: {
16
16
  fields: import("@dedot/codecs").Field[];
17
17
  };
18
18
  } | {
19
- tag: "Enum";
19
+ type: "Enum";
20
20
  value: {
21
21
  members: {
22
22
  name: string;
@@ -26,33 +26,33 @@ export declare abstract class ApiGen {
26
26
  }[];
27
27
  };
28
28
  } | {
29
- tag: "Sequence";
29
+ type: "Sequence";
30
30
  value: {
31
31
  typeParam: number;
32
32
  };
33
33
  } | {
34
- tag: "SizedVec";
34
+ type: "SizedVec";
35
35
  value: {
36
36
  len: number;
37
37
  typeParam: number;
38
38
  };
39
39
  } | {
40
- tag: "Tuple";
40
+ type: "Tuple";
41
41
  value: {
42
42
  fields: number[];
43
43
  };
44
44
  } | {
45
- tag: "Primitive";
45
+ type: "Primitive";
46
46
  value: {
47
47
  kind: "bool" | "u8" | "i8" | "u16" | "i16" | "u32" | "i32" | "u64" | "i64" | "u128" | "i128" | "u256" | "i256" | "str" | "char";
48
48
  };
49
49
  } | {
50
- tag: "Compact";
50
+ type: "Compact";
51
51
  value: {
52
52
  typeParam: number;
53
53
  };
54
54
  } | {
55
- tag: "BitSequence";
55
+ type: "BitSequence";
56
56
  value: {
57
57
  bitOrderType: number;
58
58
  bitStoreType: number;
@@ -67,13 +67,13 @@ export declare abstract class ApiGen {
67
67
  entries: {
68
68
  name: string;
69
69
  modifier: string;
70
- type: {
71
- tag: "Plain";
70
+ storageType: {
71
+ type: "Plain";
72
72
  value: {
73
73
  valueTypeId: number;
74
74
  };
75
75
  } | {
76
- tag: "Map";
76
+ type: "Map";
77
77
  value: {
78
78
  hashers: ("identity" | "blake2_128" | "blake2_256" | "blake2_128Concat" | "twox128" | "twox256" | "twox64Concat")[];
79
79
  keyTypeId: number;
@@ -1,6 +1,6 @@
1
1
  import { normalizeName, stringCamelCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
2
3
  import { ApiGen } from './ApiGen.js';
3
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
4
4
  export class ConstsGen extends ApiGen {
5
5
  generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
@@ -21,7 +21,7 @@ export class ConstsGen extends ApiGen {
21
21
  },`;
22
22
  }
23
23
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
24
- const template = compileTemplate('consts.hbs');
24
+ const template = compileTemplate('chaintypes/templates/consts.hbs');
25
25
  return beautifySourceCode(template({ importTypes, defTypeOut }));
26
26
  }
27
27
  }
@@ -1,6 +1,6 @@
1
1
  import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
2
3
  import { ApiGen } from './ApiGen.js';
3
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
4
4
  export class ErrorsGen extends ApiGen {
5
5
  generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
@@ -23,14 +23,14 @@ export class ErrorsGen extends ApiGen {
23
23
  },`;
24
24
  }
25
25
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
26
- const template = compileTemplate('errors.hbs');
26
+ const template = compileTemplate('chaintypes/templates/errors.hbs');
27
27
  return beautifySourceCode(template({ importTypes, defTypeOut }));
28
28
  }
29
29
  #getErrorDefs(errorTypeId) {
30
30
  const def = this.metadata.types[errorTypeId];
31
31
  assert(def, `Error def not found for id ${errorTypeId}`);
32
- const { tag, value } = def.type;
33
- assert(tag === 'Enum', `Invalid pallet error type!`);
32
+ const { type, value } = def.typeDef;
33
+ assert(type === 'Enum', 'Invalid pallet error type!');
34
34
  return value.members;
35
35
  }
36
36
  }
@@ -1,6 +1,6 @@
1
1
  import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
2
3
  import { ApiGen } from './ApiGen.js';
3
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
4
4
  export class EventsGen extends ApiGen {
5
5
  generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
@@ -35,14 +35,14 @@ export class EventsGen extends ApiGen {
35
35
  },`;
36
36
  }
37
37
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
38
- const template = compileTemplate('events.hbs');
38
+ const template = compileTemplate('chaintypes/templates/events.hbs');
39
39
  return beautifySourceCode(template({ importTypes, defTypeOut }));
40
40
  }
41
41
  #getEventDefs(typeId) {
42
42
  const def = this.metadata.types[typeId];
43
43
  assert(def, `Event def not found for id ${typeId}`);
44
- const { tag, value } = def.type;
45
- assert(tag === 'Enum', 'Invalid pallet event type!');
44
+ const { type, value } = def.typeDef;
45
+ assert(type === 'Enum', 'Invalid pallet event type!');
46
46
  return value.members;
47
47
  }
48
48
  #generateMemberDefType(fields) {
@@ -1,6 +1,6 @@
1
1
  import { stringPascalCase } from '@dedot/utils';
2
- import { TypeImports } from './TypeImports.js';
3
- import { beautifySourceCode, compileTemplate } from './utils.js';
2
+ import { TypeImports } from '../../shared/index.js';
3
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
4
4
  export class IndexGen {
5
5
  chain;
6
6
  constructor(chain) {
@@ -11,7 +11,7 @@ export class IndexGen {
11
11
  const typeImports = new TypeImports();
12
12
  typeImports.addKnownType('GenericSubstrateApi', 'RpcLegacy', 'RpcV2', 'RpcVersion');
13
13
  const importTypes = typeImports.toImports({ useSubPaths });
14
- const template = compileTemplate('index.hbs');
14
+ const template = compileTemplate('chaintypes/templates/index.hbs');
15
15
  return beautifySourceCode(template({ importTypes, interfaceName }));
16
16
  }
17
17
  }
@@ -1,6 +1,6 @@
1
1
  import { subscriptionsInfo } from '@dedot/api';
2
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
2
3
  import { ApiGen } from './ApiGen.js';
3
- import { beautifySourceCode, compileTemplate } from './utils.js';
4
4
  const HIDDEN_RPCS = [
5
5
  // Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
6
6
  'rpc_methods',
@@ -44,7 +44,7 @@ export class JsonRpcGen extends ApiGen {
44
44
  this.typesGen.typeImports.addKnownJsonRpcType('JsonRpcApis');
45
45
  const toExclude = Object.values(subscriptionsInfo).flat();
46
46
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
47
- const template = compileTemplate('json-rpc.hbs');
47
+ const template = compileTemplate('chaintypes/templates/json-rpc.hbs');
48
48
  const jsonRpcMethods = this.rpcMethods
49
49
  .filter((one) => !ALIAS_RPCS.includes(one)) // exclude alias rpcs
50
50
  .filter((one) => !toExclude.includes(one)) // exclude unsubscribe methods
@@ -1,6 +1,6 @@
1
1
  import { normalizeName, stringCamelCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
2
3
  import { ApiGen } from './ApiGen.js';
3
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
4
4
  export class QueryGen extends ApiGen {
5
5
  generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
@@ -28,19 +28,19 @@ export class QueryGen extends ApiGen {
28
28
  },`;
29
29
  }
30
30
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
31
- const template = compileTemplate('query.hbs');
31
+ const template = compileTemplate('chaintypes/templates/query.hbs');
32
32
  return beautifySourceCode(template({ importTypes, defTypeOut }));
33
33
  }
34
34
  #generateEntry(entry) {
35
- const { name, type, docs, modifier } = entry;
35
+ const { name, storageType, docs, modifier } = entry;
36
36
  let valueType, keyTypeOut, keyTypeIn;
37
- if (type.tag === 'Plain') {
38
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
37
+ if (storageType.type === 'Plain') {
38
+ valueType = this.typesGen.generateType(storageType.value.valueTypeId, 1, true);
39
39
  }
40
- else if (type.tag === 'Map') {
41
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
42
- keyTypeOut = this.typesGen.generateType(type.value.keyTypeId, 1, true);
43
- keyTypeIn = this.typesGen.generateType(type.value.keyTypeId, 1);
40
+ else if (storageType.type === 'Map') {
41
+ valueType = this.typesGen.generateType(storageType.value.valueTypeId, 1, true);
42
+ keyTypeOut = this.typesGen.generateType(storageType.value.keyTypeId, 1, true);
43
+ keyTypeIn = this.typesGen.generateType(storageType.value.keyTypeId, 1);
44
44
  }
45
45
  else {
46
46
  throw Error('Invalid entry type!');
@@ -1,8 +1,8 @@
1
1
  import { getRuntimeApiNames, getRuntimeApiSpecs } from '@dedot/runtime-specs';
2
2
  import { calcRuntimeApiHash, stringSnakeCase, stringCamelCase } from '@dedot/utils';
3
+ import { findKnownCodecType } from '../../shared/index.js';
4
+ import { beautifySourceCode, commentBlock, compileTemplate, isNativeType, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX, } from '../../utils.js';
3
5
  import { ApiGen } from './ApiGen.js';
4
- import { findKnownCodecType } from './known-codecs.js';
5
- import { beautifySourceCode, commentBlock, compileTemplate, isNativeType, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX, } from './utils.js';
6
6
  export class RuntimeApisGen extends ApiGen {
7
7
  typesGen;
8
8
  runtimeApis;
@@ -44,7 +44,7 @@ export class RuntimeApisGen extends ApiGen {
44
44
  });
45
45
  }
46
46
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
47
- const template = compileTemplate('runtime.hbs');
47
+ const template = compileTemplate('chaintypes/templates/runtime.hbs');
48
48
  return beautifySourceCode(template({ importTypes, runtimeCallsOut }));
49
49
  }
50
50
  #isOptionalType(type) {
@@ -1,6 +1,6 @@
1
1
  import { stringCamelCase, stringPascalCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate, isReservedWord } from '../../utils.js';
2
3
  import { ApiGen } from '../generator/index.js';
3
- import { beautifySourceCode, commentBlock, compileTemplate, isReservedWord } from './utils.js';
4
4
  export class TxGen extends ApiGen {
5
5
  generate(useSubPaths = false) {
6
6
  const { pallets, types } = this.metadata;
@@ -17,11 +17,11 @@ export class TxGen extends ApiGen {
17
17
  for (let pallet of pallets) {
18
18
  if (pallet.calls === undefined)
19
19
  continue;
20
- const { type } = types[pallet.calls];
21
- if (type.tag !== 'Enum')
20
+ const { typeDef } = types[pallet.calls];
21
+ if (typeDef.type !== 'Enum')
22
22
  continue;
23
- const isFlatEnum = type.value.members.every((m) => m.fields.length === 0);
24
- const typedTxs = type.value.members
23
+ const isFlatEnum = typeDef.value.members.every((m) => m.fields.length === 0);
24
+ const typedTxs = typeDef.value.members
25
25
  .map((one) => ({
26
26
  functionName: stringCamelCase(one.name),
27
27
  params: one.fields.map((f) => ({
@@ -58,7 +58,7 @@ export class TxGen extends ApiGen {
58
58
 
59
59
  export type TxCall<Rv extends RpcVersion> = (...args: any[]) => ChainSubmittableExtrinsic<Rv>;
60
60
  `;
61
- const template = compileTemplate('tx.hbs');
61
+ const template = compileTemplate('chaintypes/templates/tx.hbs');
62
62
  return beautifySourceCode(template({ importTypes, defTypes, txDefsOut }));
63
63
  }
64
64
  #normalizeParamName(name) {
@@ -0,0 +1,11 @@
1
+ import { MetadataLatest, PortableRegistry, TypeId } from '@dedot/codecs';
2
+ import { EnumOptions } from '@dedot/shape';
3
+ import { BaseTypesGen } from '../../shared/index.js';
4
+ export declare class TypesGen extends BaseTypesGen {
5
+ metadata: MetadataLatest;
6
+ registry: PortableRegistry;
7
+ constructor(metadata: MetadataLatest);
8
+ generate(useSubPaths?: boolean): Promise<string>;
9
+ shouldGenerateTypeIn(id: TypeId): boolean;
10
+ getEnumOptions(typeId: TypeId): EnumOptions;
11
+ }
@@ -0,0 +1,55 @@
1
+ import { PortableRegistry } from '@dedot/codecs';
2
+ import { BaseTypesGen } from '../../shared/index.js';
3
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
4
+ // Skip generate types for these
5
+ // as we do have native types for them
6
+ const SKIP_TYPES = [
7
+ 'BoundedBTreeMap',
8
+ 'BoundedBTreeSet',
9
+ 'BoundedVec',
10
+ 'Box',
11
+ 'BTreeMap',
12
+ 'BTreeSet',
13
+ 'Cow',
14
+ 'Option',
15
+ 'Range',
16
+ 'RangeInclusive',
17
+ 'Result',
18
+ 'WeakBoundedVec',
19
+ 'WrapperKeepOpaque',
20
+ 'WrapperOpaque',
21
+ ];
22
+ export class TypesGen extends BaseTypesGen {
23
+ metadata;
24
+ registry;
25
+ constructor(metadata) {
26
+ super(metadata.types);
27
+ this.metadata = metadata;
28
+ this.skipTypes = SKIP_TYPES;
29
+ this.registry = new PortableRegistry(this.metadata);
30
+ this.includedTypes = this.includeTypes();
31
+ }
32
+ generate(useSubPaths = false) {
33
+ this.clearCache();
34
+ let defTypeOut = '';
35
+ Object.values(this.includedTypes)
36
+ .filter(({ skip, knownType }) => !(skip || knownType))
37
+ .forEach(({ name, nameOut, id, docs }) => {
38
+ defTypeOut += `${commentBlock(docs)}export type ${nameOut} = ${this.generateType(id, 0, true)};\n\n`;
39
+ if (this.shouldGenerateTypeIn(id)) {
40
+ defTypeOut += `export type ${name} = ${this.generateType(id)};\n\n`;
41
+ }
42
+ });
43
+ const importTypes = this.typeImports.toImports({ excludeModules: ['./types'], useSubPaths });
44
+ const template = compileTemplate('chaintypes/templates/types.hbs');
45
+ return beautifySourceCode(template({ importTypes, defTypeOut }));
46
+ }
47
+ shouldGenerateTypeIn(id) {
48
+ const { callTypeId } = this.metadata.extrinsic;
49
+ const palletCallTypeIds = this.registry.getFieldTypeIdsFromEnum(callTypeId);
50
+ return callTypeId === id || palletCallTypeIds.includes(id);
51
+ }
52
+ getEnumOptions(typeId) {
53
+ return this.registry.getEnumOptions(typeId);
54
+ }
55
+ }
@@ -0,0 +1,3 @@
1
+ import { MetadataLatest } from '@dedot/codecs';
2
+ export declare function generateTypesFromEndpoint(chain: string, endpoint: string, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;
3
+ export declare function generateTypes(chain: string, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: Record<string, number>, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;
@@ -0,0 +1,49 @@
1
+ import { LegacyClient } from '@dedot/api';
2
+ import { WsProvider } from '@dedot/providers';
3
+ import { stringCamelCase } from '@dedot/utils';
4
+ import * as fs from 'fs';
5
+ import * as path from 'path';
6
+ import { ConstsGen, ErrorsGen, EventsGen, IndexGen, JsonRpcGen, QueryGen, RuntimeApisGen, TxGen, TypesGen, } from './generator/index.js';
7
+ export async function generateTypesFromEndpoint(chain, endpoint, outDir, extension = 'd.ts', useSubPaths = false) {
8
+ const api = await LegacyClient.new(new WsProvider(endpoint));
9
+ const { methods } = await api.rpc.rpc_methods();
10
+ const apis = api.runtimeVersion.apis || {};
11
+ if (!chain) {
12
+ chain = stringCamelCase(api.runtimeVersion.specName || 'local');
13
+ }
14
+ await generateTypes(chain, api.metadata.latest, methods, apis, outDir, extension, useSubPaths);
15
+ await api.disconnect();
16
+ }
17
+ export async function generateTypes(chain, metadata, rpcMethods, runtimeApis, outDir = '.', extension = 'd.ts', useSubPaths = false) {
18
+ const dirPath = path.resolve(outDir, chain);
19
+ const defTypesFileName = path.join(dirPath, `types.${extension}`);
20
+ const constsTypesFileName = path.join(dirPath, `consts.${extension}`);
21
+ const queryTypesFileName = path.join(dirPath, `query.${extension}`);
22
+ const jsonRpcFileName = path.join(dirPath, `json-rpc.${extension}`);
23
+ const indexFileName = path.join(dirPath, `index.${extension}`);
24
+ const errorsFileName = path.join(dirPath, `errors.${extension}`);
25
+ const eventsFileName = path.join(dirPath, `events.${extension}`);
26
+ const runtimeApisFileName = path.join(dirPath, `runtime.${extension}`);
27
+ const txFileName = path.join(dirPath, `tx.${extension}`);
28
+ if (!fs.existsSync(dirPath)) {
29
+ fs.mkdirSync(dirPath, { recursive: true });
30
+ }
31
+ const typesGen = new TypesGen(metadata);
32
+ const constsGen = new ConstsGen(typesGen);
33
+ const queryGen = new QueryGen(typesGen);
34
+ const jsonRpcGen = new JsonRpcGen(typesGen, rpcMethods);
35
+ const indexGen = new IndexGen(chain);
36
+ const errorsGen = new ErrorsGen(typesGen);
37
+ const eventsGen = new EventsGen(typesGen);
38
+ const runtimeApisGen = new RuntimeApisGen(typesGen, runtimeApis);
39
+ const txGen = new TxGen(typesGen);
40
+ fs.writeFileSync(defTypesFileName, await typesGen.generate(useSubPaths));
41
+ fs.writeFileSync(errorsFileName, await errorsGen.generate(useSubPaths));
42
+ fs.writeFileSync(eventsFileName, await eventsGen.generate(useSubPaths));
43
+ fs.writeFileSync(jsonRpcFileName, await jsonRpcGen.generate(useSubPaths));
44
+ fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
45
+ fs.writeFileSync(constsTypesFileName, await constsGen.generate(useSubPaths));
46
+ fs.writeFileSync(txFileName, await txGen.generate(useSubPaths));
47
+ fs.writeFileSync(indexFileName, await indexGen.generate(useSubPaths));
48
+ fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate(useSubPaths));
49
+ }
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{importTypes}}}
4
4
  import { ChainConsts } from './consts';
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -1,4 +1,4 @@
1
- // Generated by @dedot/codegen
1
+ // Generated by dedot cli
2
2
 
3
3
  {{{ importTypes }}}
4
4
 
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ConstsGen = void 0;
4
4
  const utils_1 = require("@dedot/utils");
5
+ const utils_js_1 = require("../../utils.js");
5
6
  const ApiGen_js_1 = require("./ApiGen.js");
6
- const utils_js_1 = require("./utils.js");
7
7
  class ConstsGen extends ApiGen_js_1.ApiGen {
8
8
  generate(useSubPaths = false) {
9
9
  const { pallets } = this.metadata;
@@ -24,7 +24,7 @@ class ConstsGen extends ApiGen_js_1.ApiGen {
24
24
  },`;
25
25
  }
26
26
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
27
- const template = (0, utils_js_1.compileTemplate)('consts.hbs');
27
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/consts.hbs');
28
28
  return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
29
29
  }
30
30
  }
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ErrorsGen = void 0;
4
4
  const utils_1 = require("@dedot/utils");
5
+ const utils_js_1 = require("../../utils.js");
5
6
  const ApiGen_js_1 = require("./ApiGen.js");
6
- const utils_js_1 = require("./utils.js");
7
7
  class ErrorsGen extends ApiGen_js_1.ApiGen {
8
8
  generate(useSubPaths = false) {
9
9
  const { pallets } = this.metadata;
@@ -26,14 +26,14 @@ class ErrorsGen extends ApiGen_js_1.ApiGen {
26
26
  },`;
27
27
  }
28
28
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
29
- const template = (0, utils_js_1.compileTemplate)('errors.hbs');
29
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/errors.hbs');
30
30
  return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
31
31
  }
32
32
  #getErrorDefs(errorTypeId) {
33
33
  const def = this.metadata.types[errorTypeId];
34
34
  (0, utils_1.assert)(def, `Error def not found for id ${errorTypeId}`);
35
- const { tag, value } = def.type;
36
- (0, utils_1.assert)(tag === 'Enum', `Invalid pallet error type!`);
35
+ const { type, value } = def.typeDef;
36
+ (0, utils_1.assert)(type === 'Enum', 'Invalid pallet error type!');
37
37
  return value.members;
38
38
  }
39
39
  }
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.EventsGen = void 0;
4
4
  const utils_1 = require("@dedot/utils");
5
+ const utils_js_1 = require("../../utils.js");
5
6
  const ApiGen_js_1 = require("./ApiGen.js");
6
- const utils_js_1 = require("./utils.js");
7
7
  class EventsGen extends ApiGen_js_1.ApiGen {
8
8
  generate(useSubPaths = false) {
9
9
  const { pallets } = this.metadata;
@@ -38,14 +38,14 @@ class EventsGen extends ApiGen_js_1.ApiGen {
38
38
  },`;
39
39
  }
40
40
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
41
- const template = (0, utils_js_1.compileTemplate)('events.hbs');
41
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/events.hbs');
42
42
  return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
43
43
  }
44
44
  #getEventDefs(typeId) {
45
45
  const def = this.metadata.types[typeId];
46
46
  (0, utils_1.assert)(def, `Event def not found for id ${typeId}`);
47
- const { tag, value } = def.type;
48
- (0, utils_1.assert)(tag === 'Enum', 'Invalid pallet event type!');
47
+ const { type, value } = def.typeDef;
48
+ (0, utils_1.assert)(type === 'Enum', 'Invalid pallet event type!');
49
49
  return value.members;
50
50
  }
51
51
  #generateMemberDefType(fields) {
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.IndexGen = void 0;
4
4
  const utils_1 = require("@dedot/utils");
5
- const TypeImports_js_1 = require("./TypeImports.js");
6
- const utils_js_1 = require("./utils.js");
5
+ const index_js_1 = require("../../shared/index.js");
6
+ const utils_js_1 = require("../../utils.js");
7
7
  class IndexGen {
8
8
  chain;
9
9
  constructor(chain) {
@@ -11,10 +11,10 @@ class IndexGen {
11
11
  }
12
12
  async generate(useSubPaths = false) {
13
13
  const interfaceName = (0, utils_1.stringPascalCase)(this.chain);
14
- const typeImports = new TypeImports_js_1.TypeImports();
14
+ const typeImports = new index_js_1.TypeImports();
15
15
  typeImports.addKnownType('GenericSubstrateApi', 'RpcLegacy', 'RpcV2', 'RpcVersion');
16
16
  const importTypes = typeImports.toImports({ useSubPaths });
17
- const template = (0, utils_js_1.compileTemplate)('index.hbs');
17
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/index.hbs');
18
18
  return (0, utils_js_1.beautifySourceCode)(template({ importTypes, interfaceName }));
19
19
  }
20
20
  }
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.JsonRpcGen = void 0;
4
4
  const api_1 = require("@dedot/api");
5
+ const utils_js_1 = require("../../utils.js");
5
6
  const ApiGen_js_1 = require("./ApiGen.js");
6
- const utils_js_1 = require("./utils.js");
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',
@@ -47,7 +47,7 @@ class JsonRpcGen extends ApiGen_js_1.ApiGen {
47
47
  this.typesGen.typeImports.addKnownJsonRpcType('JsonRpcApis');
48
48
  const toExclude = Object.values(api_1.subscriptionsInfo).flat();
49
49
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
50
- const template = (0, utils_js_1.compileTemplate)('json-rpc.hbs');
50
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/json-rpc.hbs');
51
51
  const jsonRpcMethods = this.rpcMethods
52
52
  .filter((one) => !ALIAS_RPCS.includes(one)) // exclude alias rpcs
53
53
  .filter((one) => !toExclude.includes(one)) // exclude unsubscribe methods
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.QueryGen = void 0;
4
4
  const utils_1 = require("@dedot/utils");
5
+ const utils_js_1 = require("../../utils.js");
5
6
  const ApiGen_js_1 = require("./ApiGen.js");
6
- const utils_js_1 = require("./utils.js");
7
7
  class QueryGen extends ApiGen_js_1.ApiGen {
8
8
  generate(useSubPaths = false) {
9
9
  const { pallets } = this.metadata;
@@ -31,19 +31,19 @@ class QueryGen extends ApiGen_js_1.ApiGen {
31
31
  },`;
32
32
  }
33
33
  const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
34
- const template = (0, utils_js_1.compileTemplate)('query.hbs');
34
+ const template = (0, utils_js_1.compileTemplate)('chaintypes/templates/query.hbs');
35
35
  return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
36
36
  }
37
37
  #generateEntry(entry) {
38
- const { name, type, docs, modifier } = entry;
38
+ const { name, storageType, docs, modifier } = entry;
39
39
  let valueType, keyTypeOut, keyTypeIn;
40
- if (type.tag === 'Plain') {
41
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
40
+ if (storageType.type === 'Plain') {
41
+ valueType = this.typesGen.generateType(storageType.value.valueTypeId, 1, true);
42
42
  }
43
- else if (type.tag === 'Map') {
44
- valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
45
- keyTypeOut = this.typesGen.generateType(type.value.keyTypeId, 1, true);
46
- keyTypeIn = this.typesGen.generateType(type.value.keyTypeId, 1);
43
+ else if (storageType.type === 'Map') {
44
+ valueType = this.typesGen.generateType(storageType.value.valueTypeId, 1, true);
45
+ keyTypeOut = this.typesGen.generateType(storageType.value.keyTypeId, 1, true);
46
+ keyTypeIn = this.typesGen.generateType(storageType.value.keyTypeId, 1);
47
47
  }
48
48
  else {
49
49
  throw Error('Invalid entry type!');