@dedot/codegen 0.0.1-next.8f4b2c24.6 → 0.0.1-next.9c1d51fe.10

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 (128) hide show
  1. package/{generator → chaintypes/generator}/ApiGen.d.ts +4 -4
  2. package/{generator → chaintypes/generator}/ConstsGen.d.ts +1 -1
  3. package/{generator → chaintypes/generator}/ConstsGen.js +5 -5
  4. package/{generator → chaintypes/generator}/ErrorsGen.d.ts +1 -1
  5. package/{generator → chaintypes/generator}/ErrorsGen.js +8 -8
  6. package/{generator → chaintypes/generator}/EventsGen.d.ts +1 -1
  7. package/{generator → chaintypes/generator}/EventsGen.js +8 -8
  8. package/{generator → chaintypes/generator}/IndexGen.d.ts +1 -1
  9. package/chaintypes/generator/IndexGen.js +17 -0
  10. package/{generator → chaintypes/generator}/JsonRpcGen.d.ts +3 -2
  11. package/{generator → chaintypes/generator}/JsonRpcGen.js +8 -8
  12. package/{generator → chaintypes/generator}/QueryGen.d.ts +1 -1
  13. package/{generator → chaintypes/generator}/QueryGen.js +8 -8
  14. package/{generator → chaintypes/generator}/RuntimeApisGen.d.ts +2 -2
  15. package/{generator → chaintypes/generator}/RuntimeApisGen.js +11 -11
  16. package/{generator → chaintypes/generator}/TxGen.d.ts +1 -1
  17. package/{generator → chaintypes/generator}/TxGen.js +13 -11
  18. package/chaintypes/generator/TypesGen.d.ts +11 -0
  19. package/chaintypes/generator/TypesGen.js +55 -0
  20. package/chaintypes/index.d.ts +3 -0
  21. package/chaintypes/index.js +49 -0
  22. package/chaintypes/templates/consts.hbs +7 -0
  23. package/chaintypes/templates/errors.hbs +7 -0
  24. package/chaintypes/templates/events.hbs +7 -0
  25. package/chaintypes/templates/index.hbs +27 -0
  26. package/chaintypes/templates/json-rpc.hbs +5 -0
  27. package/chaintypes/templates/query.hbs +7 -0
  28. package/chaintypes/templates/runtime.hbs +8 -0
  29. package/{cjs → chaintypes}/templates/tx.hbs +1 -1
  30. package/cjs/{generator → chaintypes/generator}/ConstsGen.js +5 -5
  31. package/cjs/{generator → chaintypes/generator}/ErrorsGen.js +8 -8
  32. package/cjs/{generator → chaintypes/generator}/EventsGen.js +8 -8
  33. package/cjs/chaintypes/generator/IndexGen.js +21 -0
  34. package/cjs/{generator → chaintypes/generator}/JsonRpcGen.js +10 -10
  35. package/cjs/{generator → chaintypes/generator}/QueryGen.js +8 -8
  36. package/cjs/{generator → chaintypes/generator}/RuntimeApisGen.js +14 -14
  37. package/cjs/{generator → chaintypes/generator}/TxGen.js +13 -11
  38. package/cjs/chaintypes/generator/TypesGen.js +59 -0
  39. package/cjs/chaintypes/index.js +77 -0
  40. package/cjs/chaintypes/templates/consts.hbs +7 -0
  41. package/cjs/chaintypes/templates/errors.hbs +7 -0
  42. package/cjs/chaintypes/templates/events.hbs +7 -0
  43. package/cjs/chaintypes/templates/index.hbs +27 -0
  44. package/cjs/chaintypes/templates/json-rpc.hbs +5 -0
  45. package/cjs/chaintypes/templates/query.hbs +7 -0
  46. package/cjs/chaintypes/templates/runtime.hbs +8 -0
  47. package/{templates → cjs/chaintypes/templates}/tx.hbs +1 -1
  48. package/cjs/index.js +4 -62
  49. package/cjs/{generator/TypesGen.js → shared/BaseTypesGen.js} +88 -140
  50. package/cjs/{generator → shared}/TypeImports.js +19 -9
  51. package/cjs/shared/index.js +19 -0
  52. package/cjs/{generator → shared}/known-codecs.js +24 -5
  53. package/cjs/typink/generator/ConstructorQueryGen.js +23 -0
  54. package/cjs/typink/generator/ConstructorTxGen.js +23 -0
  55. package/cjs/typink/generator/IndexGen.js +23 -0
  56. package/cjs/typink/generator/QueryGen.js +71 -0
  57. package/cjs/typink/generator/TxGen.js +24 -0
  58. package/cjs/typink/generator/TypesGen.js +35 -0
  59. package/cjs/typink/generator/index.js +22 -0
  60. package/cjs/typink/index.js +37 -0
  61. package/cjs/typink/templates/constructor-query.hbs +8 -0
  62. package/cjs/typink/templates/constructor-tx.hbs +8 -0
  63. package/cjs/typink/templates/index.hbs +15 -0
  64. package/cjs/typink/templates/query.hbs +8 -0
  65. package/cjs/typink/templates/tx.hbs +8 -0
  66. package/cjs/typink/templates/types.hbs +5 -0
  67. package/cjs/{generator/utils.js → utils.js} +3 -3
  68. package/index.d.ts +2 -3
  69. package/index.js +2 -48
  70. package/package.json +16 -18
  71. package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts} +12 -11
  72. package/{generator/TypesGen.js → shared/BaseTypesGen.js} +85 -137
  73. package/{generator → shared}/TypeImports.d.ts +10 -3
  74. package/{generator → shared}/TypeImports.js +19 -9
  75. package/shared/index.d.ts +3 -0
  76. package/shared/index.js +3 -0
  77. package/{generator → shared}/known-codecs.d.ts +1 -1
  78. package/{generator → shared}/known-codecs.js +22 -3
  79. package/typink/generator/ConstructorQueryGen.d.ts +6 -0
  80. package/typink/generator/ConstructorQueryGen.js +19 -0
  81. package/typink/generator/ConstructorTxGen.d.ts +6 -0
  82. package/typink/generator/ConstructorTxGen.js +19 -0
  83. package/typink/generator/IndexGen.d.ts +6 -0
  84. package/typink/generator/IndexGen.js +19 -0
  85. package/typink/generator/QueryGen.d.ts +12 -0
  86. package/typink/generator/QueryGen.js +67 -0
  87. package/typink/generator/TxGen.d.ts +6 -0
  88. package/typink/generator/TxGen.js +20 -0
  89. package/typink/generator/TypesGen.d.ts +8 -0
  90. package/typink/generator/TypesGen.js +31 -0
  91. package/typink/generator/index.d.ts +6 -0
  92. package/typink/generator/index.js +6 -0
  93. package/typink/index.d.ts +2 -0
  94. package/typink/index.js +30 -0
  95. package/typink/templates/constructor-query.hbs +8 -0
  96. package/typink/templates/constructor-tx.hbs +8 -0
  97. package/typink/templates/index.hbs +15 -0
  98. package/typink/templates/query.hbs +8 -0
  99. package/typink/templates/tx.hbs +8 -0
  100. package/typink/templates/types.hbs +5 -0
  101. package/{generator/utils.d.ts → utils.d.ts} +1 -1
  102. package/{generator/utils.js → utils.js} +3 -3
  103. package/cjs/generator/IndexGen.js +0 -17
  104. package/cjs/templates/consts.hbs +0 -7
  105. package/cjs/templates/errors.hbs +0 -7
  106. package/cjs/templates/events.hbs +0 -7
  107. package/cjs/templates/index.hbs +0 -22
  108. package/cjs/templates/json-rpc.hbs +0 -5
  109. package/cjs/templates/query.hbs +0 -7
  110. package/cjs/templates/runtime.hbs +0 -8
  111. package/generator/IndexGen.js +0 -13
  112. package/templates/consts.hbs +0 -7
  113. package/templates/errors.hbs +0 -7
  114. package/templates/events.hbs +0 -7
  115. package/templates/index.hbs +0 -22
  116. package/templates/json-rpc.hbs +0 -5
  117. package/templates/query.hbs +0 -7
  118. package/templates/runtime.hbs +0 -8
  119. /package/{generator → chaintypes/generator}/ApiGen.js +0 -0
  120. /package/{generator → chaintypes/generator}/index.d.ts +0 -0
  121. /package/{generator → chaintypes/generator}/index.js +0 -0
  122. /package/{cjs → chaintypes}/templates/types.hbs +0 -0
  123. /package/cjs/{generator → chaintypes/generator}/ApiGen.js +0 -0
  124. /package/cjs/{generator → chaintypes/generator}/index.js +0 -0
  125. /package/{templates → cjs/chaintypes/templates}/types.hbs +0 -0
  126. /package/cjs/{generator/dirname.js → dirname.js} +0 -0
  127. /package/{generator/dirname.d.ts → dirname.d.ts} +0 -0
  128. /package/{generator/dirname.js → dirname.js} +0 -0
@@ -1,4 +1,4 @@
1
- import { TypesGen } from '../generator/index.js';
1
+ import { TypesGen } from './TypesGen.js';
2
2
  export declare abstract class ApiGen {
3
3
  readonly typesGen: TypesGen;
4
4
  constructor(typesGen: TypesGen);
@@ -13,14 +13,14 @@ export declare abstract class ApiGen {
13
13
  type: {
14
14
  tag: "Struct";
15
15
  value: {
16
- fields: import("dedot").Field[];
16
+ fields: import("@dedot/codecs").Field[];
17
17
  };
18
18
  } | {
19
19
  tag: "Enum";
20
20
  value: {
21
21
  members: {
22
22
  name: string;
23
- fields: import("dedot").Field[];
23
+ fields: import("@dedot/codecs").Field[];
24
24
  index: number;
25
25
  docs: string[];
26
26
  }[];
@@ -134,5 +134,5 @@ export declare abstract class ApiGen {
134
134
  }>;
135
135
  };
136
136
  };
137
- get registry(): import("dedot").PortableRegistry;
137
+ get registry(): import("@dedot/codecs").PortableRegistry;
138
138
  }
@@ -1,4 +1,4 @@
1
1
  import { ApiGen } from './ApiGen.js';
2
2
  export declare class ConstsGen extends ApiGen {
3
- generate(): Promise<string>;
3
+ generate(useSubPaths?: boolean): Promise<string>;
4
4
  }
@@ -1,11 +1,11 @@
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
- generate() {
5
+ generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
7
7
  this.typesGen.clearCache();
8
- this.typesGen.typeImports.addKnownType('GenericChainConsts');
8
+ this.typesGen.typeImports.addKnownType('GenericChainConsts', 'RpcVersion');
9
9
  let defTypeOut = '';
10
10
  for (let pallet of pallets) {
11
11
  const typedConstants = pallet.constants.map((one) => ({
@@ -20,8 +20,8 @@ export class ConstsGen extends ApiGen {
20
20
  ${commentBlock('Generic pallet constant')}[name: string]: any,
21
21
  },`;
22
22
  }
23
- const importTypes = this.typesGen.typeImports.toImports();
24
- const template = compileTemplate('consts.hbs');
23
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
24
+ const template = compileTemplate('chaintypes/templates/consts.hbs');
25
25
  return beautifySourceCode(template({ importTypes, defTypeOut }));
26
26
  }
27
27
  }
@@ -1,5 +1,5 @@
1
1
  import { ApiGen } from './ApiGen.js';
2
2
  export declare class ErrorsGen extends ApiGen {
3
3
  #private;
4
- generate(): Promise<string>;
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
5
  }
@@ -1,11 +1,11 @@
1
- import { ApiGen } from './ApiGen.js';
2
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
3
1
  import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
3
+ import { ApiGen } from './ApiGen.js';
4
4
  export class ErrorsGen extends ApiGen {
5
- generate() {
5
+ generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
7
7
  this.typesGen.clearCache();
8
- this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
8
+ this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError', 'RpcVersion');
9
9
  let defTypeOut = '';
10
10
  for (let pallet of pallets) {
11
11
  const errorTypeId = pallet.error;
@@ -16,14 +16,14 @@ export class ErrorsGen extends ApiGen {
16
16
  defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s errors`);
17
17
  defTypeOut += `${stringCamelCase(pallet.name)}: {
18
18
  ${errorDefs
19
- .map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError`)
19
+ .map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError<Rv>`)
20
20
  .join(',\n')}
21
21
 
22
- ${commentBlock('Generic pallet error')}[error: string]: GenericPalletError,
22
+ ${commentBlock('Generic pallet error')}[error: string]: GenericPalletError<Rv>,
23
23
  },`;
24
24
  }
25
- const importTypes = this.typesGen.typeImports.toImports();
26
- const template = compileTemplate('errors.hbs');
25
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
26
+ const template = compileTemplate('chaintypes/templates/errors.hbs');
27
27
  return beautifySourceCode(template({ importTypes, defTypeOut }));
28
28
  }
29
29
  #getErrorDefs(errorTypeId) {
@@ -1,5 +1,5 @@
1
1
  import { ApiGen } from './ApiGen.js';
2
2
  export declare class EventsGen extends ApiGen {
3
3
  #private;
4
- generate(): Promise<string>;
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
5
  }
@@ -1,11 +1,11 @@
1
- import { ApiGen } from './ApiGen.js';
2
- import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
3
1
  import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
2
+ import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
3
+ import { ApiGen } from './ApiGen.js';
4
4
  export class EventsGen extends ApiGen {
5
- generate() {
5
+ generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
7
7
  this.typesGen.clearCache();
8
- this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent');
8
+ this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent', 'RpcVersion');
9
9
  let defTypeOut = '';
10
10
  for (let pallet of pallets) {
11
11
  const eventTypeId = pallet.event;
@@ -28,14 +28,14 @@ export class EventsGen extends ApiGen {
28
28
  }
29
29
  return { ...def, genericParts };
30
30
  })
31
- .map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent<${genericParts.join(', ')}>`)
31
+ .map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent<Rv, ${genericParts.join(', ')}>`)
32
32
  .join(',\n')}
33
33
 
34
- ${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent,
34
+ ${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent<Rv>,
35
35
  },`;
36
36
  }
37
- const importTypes = this.typesGen.typeImports.toImports();
38
- const template = compileTemplate('events.hbs');
37
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
38
+ const template = compileTemplate('chaintypes/templates/events.hbs');
39
39
  return beautifySourceCode(template({ importTypes, defTypeOut }));
40
40
  }
41
41
  #getEventDefs(typeId) {
@@ -1,5 +1,5 @@
1
1
  export declare class IndexGen {
2
2
  readonly chain: string;
3
3
  constructor(chain: string);
4
- generate(): Promise<string>;
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
5
  }
@@ -0,0 +1,17 @@
1
+ import { stringPascalCase } from '@dedot/utils';
2
+ import { TypeImports } from '../../shared/index.js';
3
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
4
+ export class IndexGen {
5
+ chain;
6
+ constructor(chain) {
7
+ this.chain = chain;
8
+ }
9
+ async generate(useSubPaths = false) {
10
+ const interfaceName = stringPascalCase(this.chain);
11
+ const typeImports = new TypeImports();
12
+ typeImports.addKnownType('GenericSubstrateApi', 'RpcLegacy', 'RpcV2', 'RpcVersion');
13
+ const importTypes = typeImports.toImports({ useSubPaths });
14
+ const template = compileTemplate('chaintypes/templates/index.hbs');
15
+ return beautifySourceCode(template({ importTypes, interfaceName }));
16
+ }
17
+ }
@@ -1,7 +1,8 @@
1
- import { ApiGen, TypesGen } from '../generator/index.js';
1
+ import { ApiGen } from './ApiGen.js';
2
+ import { TypesGen } from './TypesGen.js';
2
3
  export declare class JsonRpcGen extends ApiGen {
3
4
  readonly typesGen: TypesGen;
4
5
  readonly rpcMethods: string[];
5
6
  constructor(typesGen: TypesGen, rpcMethods: string[]);
6
- generate(): Promise<string>;
7
+ generate(useSubPaths?: boolean): Promise<string>;
7
8
  }
@@ -1,6 +1,6 @@
1
- import { ApiGen } from '../generator/index.js';
2
- import { beautifySourceCode, compileTemplate } from './utils.js';
3
- import { subscriptionsInfo } from '@dedot/specs';
1
+ import { subscriptionsInfo } from '@dedot/api';
2
+ import { beautifySourceCode, compileTemplate } from '../../utils.js';
3
+ import { ApiGen } from './ApiGen.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',
@@ -38,13 +38,13 @@ export class JsonRpcGen extends ApiGen {
38
38
  HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
39
39
  rpcMethods.sort();
40
40
  }
41
- generate() {
41
+ generate(useSubPaths = false) {
42
42
  this.typesGen.clearCache();
43
- this.typesGen.typeImports.addKnownType('GenericJsonRpcApis');
44
- this.typesGen.typeImports.addSpecType('JsonRpcApis');
43
+ this.typesGen.typeImports.addKnownType('GenericJsonRpcApis', 'RpcVersion');
44
+ this.typesGen.typeImports.addKnownJsonRpcType('JsonRpcApis');
45
45
  const toExclude = Object.values(subscriptionsInfo).flat();
46
- const importTypes = this.typesGen.typeImports.toImports();
47
- const template = compileTemplate('json-rpc.hbs');
46
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
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,5 +1,5 @@
1
1
  import { ApiGen } from './ApiGen.js';
2
2
  export declare class QueryGen extends ApiGen {
3
3
  #private;
4
- generate(): Promise<string>;
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
5
  }
@@ -1,11 +1,11 @@
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
- generate() {
5
+ generate(useSubPaths = false) {
6
6
  const { pallets } = this.metadata;
7
7
  this.typesGen.clearCache();
8
- this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
8
+ this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback', 'RpcVersion');
9
9
  let defTypeOut = '';
10
10
  for (let pallet of pallets) {
11
11
  const storage = pallet.storage;
@@ -14,21 +14,21 @@ export class QueryGen extends ApiGen {
14
14
  const queries = storage.entries.map((one) => this.#generateEntry(one));
15
15
  const queryDefs = queries.map(({ name, valueType, keyType, docs, keyTypeOut }) => {
16
16
  if (keyTypeOut) {
17
- return `${commentBlock(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}, ${keyTypeOut}>`;
17
+ return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}, ${keyTypeOut}>`;
18
18
  }
19
19
  else {
20
- return `${commentBlock(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}>`;
20
+ return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}>`;
21
21
  }
22
22
  });
23
23
  defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s storage queries`);
24
24
  defTypeOut += `${stringCamelCase(pallet.name)}: {
25
25
  ${queryDefs.join(',\n')}
26
26
 
27
- ${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery;
27
+ ${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery<Rv>;
28
28
  },`;
29
29
  }
30
- const importTypes = this.typesGen.typeImports.toImports();
31
- const template = compileTemplate('query.hbs');
30
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
31
+ const template = compileTemplate('chaintypes/templates/query.hbs');
32
32
  return beautifySourceCode(template({ importTypes, defTypeOut }));
33
33
  }
34
34
  #generateEntry(entry) {
@@ -1,9 +1,9 @@
1
- import { TypesGen } from './TypesGen.js';
2
1
  import { ApiGen } from './ApiGen.js';
2
+ import { TypesGen } from './TypesGen.js';
3
3
  export declare class RuntimeApisGen extends ApiGen {
4
4
  #private;
5
5
  readonly typesGen: TypesGen;
6
6
  readonly runtimeApis: Record<string, number>;
7
7
  constructor(typesGen: TypesGen, runtimeApis: Record<string, number>);
8
- generate(): Promise<string>;
8
+ generate(useSubPaths?: boolean): Promise<string>;
9
9
  }
@@ -1,8 +1,8 @@
1
- import { getRuntimeApiNames, getRuntimeApiSpecs } from '@dedot/specs';
2
- import { beautifySourceCode, commentBlock, compileTemplate, isNativeType, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX, } from './utils.js';
1
+ import { getRuntimeApiNames, getRuntimeApiSpecs } from '@dedot/runtime-specs';
3
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';
4
5
  import { ApiGen } from './ApiGen.js';
5
- import { findKnownCodecType } from './known-codecs.js';
6
6
  export class RuntimeApisGen extends ApiGen {
7
7
  typesGen;
8
8
  runtimeApis;
@@ -11,9 +11,9 @@ export class RuntimeApisGen extends ApiGen {
11
11
  this.typesGen = typesGen;
12
12
  this.runtimeApis = runtimeApis;
13
13
  }
14
- generate() {
14
+ generate(useSubPaths = false) {
15
15
  this.typesGen.clearCache();
16
- this.typesGen.typeImports.addKnownType('GenericRuntimeApis', 'GenericRuntimeApiMethod');
16
+ this.typesGen.typeImports.addKnownType('GenericRuntimeApis', 'GenericRuntimeApiMethod', 'RpcVersion');
17
17
  let runtimeCallsOut = '';
18
18
  if (this.metadata.apis.length > 0) {
19
19
  this.metadata.apis.forEach((runtimeApi) => {
@@ -22,7 +22,7 @@ export class RuntimeApisGen extends ApiGen {
22
22
  runtimeCallsOut += `${stringCamelCase(runtimeApiName)}: {
23
23
  ${methods.map((method) => this.#generateMethodDef(runtimeApiName, method)).join('\n')}
24
24
 
25
- ${commentBlock('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
25
+ ${commentBlock('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod<Rv>
26
26
  }`;
27
27
  });
28
28
  }
@@ -39,12 +39,12 @@ export class RuntimeApisGen extends ApiGen {
39
39
  }))
40
40
  .join('\n')}
41
41
 
42
- ${commentBlock('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod
42
+ ${commentBlock('Generic runtime api call')}[method: string]: GenericRuntimeApiMethod<Rv>
43
43
  }`;
44
44
  });
45
45
  }
46
- const importTypes = this.typesGen.typeImports.toImports();
47
- const template = compileTemplate('runtime.hbs');
46
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
47
+ const template = compileTemplate('chaintypes/templates/runtime.hbs');
48
48
  return beautifySourceCode(template({ importTypes, runtimeCallsOut }));
49
49
  }
50
50
  #isOptionalType(type) {
@@ -68,7 +68,7 @@ export class RuntimeApisGen extends ApiGen {
68
68
  .map(({ name, isOptional, plainType }) => `${stringCamelCase(name)}${isOptional ? '?' : ''}: ${plainType}`)
69
69
  .join(', ');
70
70
  const typeOut = this.#getGeneratedTypeName(type, false);
71
- return `${commentBlock(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
71
+ return `${commentBlock(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<Rv, (${paramsOut}) => Promise<${typeOut}>>`;
72
72
  }
73
73
  #generateMethodDef(runtimeApiName, methodDef) {
74
74
  const { name: methodName, inputs, output, docs } = methodDef;
@@ -89,7 +89,7 @@ export class RuntimeApisGen extends ApiGen {
89
89
  const paramsOut = typedInputs
90
90
  .map(({ name, type, isOptional }) => `${stringCamelCase(name)}${isOptional ? '?' : ''}: ${type}`)
91
91
  .join(', ');
92
- return `${commentBlock(docs, '\n', defaultDocs, typedInputs.map(({ type, name }) => `@param {${type}} ${name}`))}${stringCamelCase(methodName)}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
92
+ return `${commentBlock(docs, '\n', defaultDocs, typedInputs.map(({ type, name }) => `@param {${type}} ${name}`))}${stringCamelCase(methodName)}: GenericRuntimeApiMethod<Rv, (${paramsOut}) => Promise<${typeOut}>>`;
93
93
  }
94
94
  #targetRuntimeApiSpecs() {
95
95
  const specs = Object.entries(this.runtimeApis).map(([runtimeApiHash, version]) => {
@@ -1,5 +1,5 @@
1
1
  import { ApiGen } from '../generator/index.js';
2
2
  export declare class TxGen extends ApiGen {
3
3
  #private;
4
- generate(): Promise<string>;
4
+ generate(useSubPaths?: boolean): Promise<string>;
5
5
  }
@@ -1,11 +1,11 @@
1
- import { ApiGen } from '../generator/index.js';
2
1
  import { stringCamelCase, stringPascalCase } from '@dedot/utils';
3
- import { beautifySourceCode, commentBlock, compileTemplate, isReservedWord } from './utils.js';
2
+ import { beautifySourceCode, commentBlock, compileTemplate, isReservedWord } from '../../utils.js';
3
+ import { ApiGen } from '../generator/index.js';
4
4
  export class TxGen extends ApiGen {
5
- generate() {
5
+ generate(useSubPaths = false) {
6
6
  const { pallets, types } = this.metadata;
7
7
  this.typesGen.clearCache();
8
- this.typesGen.typeImports.addKnownType('GenericChainTx', 'GenericTxCall', 'ISubmittableExtrinsic', 'ISubmittableResult', 'IRuntimeTxCall');
8
+ this.typesGen.typeImports.addKnownType('GenericChainTx', 'GenericTxCall', 'ISubmittableExtrinsic', 'ISubmittableResult', 'IRuntimeTxCall', 'RpcVersion', 'RpcV2', 'ISubmittableExtrinsicLegacy', 'TransactionStatusLegacy', 'TransactionStatusV2');
9
9
  const { callTypeId, addressTypeId, signatureTypeId } = this.metadata.extrinsic;
10
10
  const callTypeIn = this.typesGen.generateType(callTypeId, 1);
11
11
  const addressTypeIn = this.typesGen.generateType(addressTypeId, 1);
@@ -41,22 +41,24 @@ export class TxGen extends ApiGen {
41
41
  txDefsOut += commentBlock(`Pallet \`${pallet.name}\`'s transaction calls`);
42
42
  txDefsOut += `${stringCamelCase(pallet.name)}: {
43
43
  ${typedTxs
44
- .map(({ functionName, params, docs, callInput }) => `${commentBlock(docs, '\n', params.map((p) => `@param {${p.type}} ${p.normalizedName} ${p.docs}`))}${functionName}: GenericTxCall<(${params.map((p) => `${p.normalizedName}: ${p.type}`).join(', ')}) => ChainSubmittableExtrinsic<${callInput}>>`)
44
+ .map(({ functionName, params, docs, callInput }) => `${commentBlock(docs, '\n', params.map((p) => `@param {${p.type}} ${p.normalizedName} ${p.docs}`))}${functionName}: GenericTxCall<Rv, (${params.map((p) => `${p.normalizedName}: ${p.type}`).join(', ')}) => ChainSubmittableExtrinsic<Rv, ${callInput}>>`)
45
45
  .join(',\n')}
46
46
 
47
- ${commentBlock('Generic pallet tx call')}[callName: string]: GenericTxCall<TxCall>,
47
+ ${commentBlock('Generic pallet tx call')}[callName: string]: GenericTxCall<Rv, TxCall<Rv>>,
48
48
  },`;
49
49
  }
50
- const importTypes = this.typesGen.typeImports.toImports();
50
+ const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
51
51
  // TODO make explicit separate type for Extra
52
52
  const defTypes = `
53
- export type ChainSubmittableExtrinsic<T extends IRuntimeTxCall = ${callTypeIn}> =
53
+ export type ChainSubmittableExtrinsic<Rv extends RpcVersion, T extends IRuntimeTxCall = ${callTypeIn}> =
54
54
  Extrinsic<${addressTypeIn}, T, ${signatureTypeIn}, any[]> &
55
- ISubmittableExtrinsic<ISubmittableResult<FrameSystemEventRecord>>
55
+ (Rv extends RpcV2
56
+ ? ISubmittableExtrinsic<ISubmittableResult<FrameSystemEventRecord, TransactionStatusV2>>
57
+ : ISubmittableExtrinsicLegacy<ISubmittableResult<FrameSystemEventRecord, TransactionStatusLegacy>>)
56
58
 
57
- export type TxCall = (...args: any[]) => ChainSubmittableExtrinsic;
59
+ export type TxCall<Rv extends RpcVersion> = (...args: any[]) => ChainSubmittableExtrinsic<Rv>;
58
60
  `;
59
- const template = compileTemplate('tx.hbs');
61
+ const template = compileTemplate('chaintypes/templates/tx.hbs');
60
62
  return beautifySourceCode(template({ importTypes, defTypes, txDefsOut }));
61
63
  }
62
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.getPalletCallTypeIds();
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 { Dedot } 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 Dedot.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
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ChainConsts<Rv extends RpcVersion> extends GenericChainConsts<Rv> {
6
+ {{{ defTypeOut }}}
7
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ChainErrors<Rv extends RpcVersion> extends GenericChainErrors<Rv> {
6
+ {{{ defTypeOut }}}
7
+ }
@@ -0,0 +1,7 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ChainEvents<Rv extends RpcVersion> extends GenericChainEvents<Rv> {
6
+ {{{ defTypeOut }}}
7
+ }
@@ -0,0 +1,27 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{importTypes}}}
4
+ import { ChainConsts } from './consts';
5
+ import { ChainStorage } from './query';
6
+ import { ChainJsonRpcApis } from './json-rpc';
7
+ import { ChainErrors } from './errors';
8
+ import { ChainEvents } from './events';
9
+ import { RuntimeApis } from './runtime';
10
+ import { ChainTx } from './tx';
11
+
12
+ export * from './types';
13
+
14
+ export interface Versioned{{{interfaceName}}}Api<Rv extends RpcVersion> extends GenericSubstrateApi<Rv> {
15
+ rpc: ChainJsonRpcApis<Rv>;
16
+ consts: ChainConsts<Rv>;
17
+ query: ChainStorage<Rv>;
18
+ errors: ChainErrors<Rv>;
19
+ events: ChainEvents<Rv>;
20
+ call: RuntimeApis<Rv>;
21
+ tx: ChainTx<Rv>;
22
+ }
23
+
24
+ export interface {{{interfaceName}}}Api {
25
+ legacy: Versioned{{{interfaceName}}}Api<RpcLegacy>;
26
+ v2: Versioned{{{interfaceName}}}Api<RpcV2>;
27
+ }
@@ -0,0 +1,5 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export type ChainJsonRpcApis<Rv extends RpcVersion> = Pick<JsonRpcApis, {{{jsonRpcMethods}}}> & GenericJsonRpcApis<Rv>;
@@ -0,0 +1,7 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface ChainStorage<Rv extends RpcVersion> extends GenericChainStorage<Rv> {
6
+ {{{ defTypeOut }}}
7
+ }
@@ -0,0 +1,8 @@
1
+ // Generated by @dedot/codegen
2
+
3
+ {{{ importTypes }}}
4
+
5
+ export interface RuntimeApis<Rv extends RpcVersion> extends GenericRuntimeApis<Rv> {
6
+ {{{ runtimeCallsOut }}}
7
+ }
8
+
@@ -4,6 +4,6 @@
4
4
 
5
5
  {{{ defTypes }}}
6
6
 
7
- export interface ChainTx extends GenericChainTx<TxCall> {
7
+ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCall<Rv>> {
8
8
  {{{ txDefsOut }}}
9
9
  }