@dedot/codegen 0.0.1-next.3 → 0.0.1-next.3662494a.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/generator/ConstsGen.js +10 -11
- package/cjs/generator/ErrorsGen.js +13 -14
- package/cjs/generator/EventsGen.js +14 -15
- package/cjs/generator/IndexGen.js +8 -9
- package/cjs/generator/JsonRpcGen.js +59 -0
- package/cjs/generator/QueryGen.js +24 -16
- package/cjs/generator/RuntimeApisGen.js +107 -29
- package/cjs/generator/TxGen.js +21 -19
- package/cjs/generator/TypeImports.js +8 -0
- package/cjs/generator/TypesGen.js +23 -29
- package/cjs/generator/index.js +10 -10
- package/cjs/generator/known-codecs.js +151 -0
- package/cjs/generator/utils.js +30 -1
- package/cjs/index.js +32 -32
- package/cjs/templates/consts.hbs +1 -1
- package/cjs/templates/errors.hbs +1 -1
- package/cjs/templates/events.hbs +1 -1
- package/cjs/templates/index.hbs +15 -10
- package/cjs/templates/json-rpc.hbs +5 -0
- package/cjs/templates/query.hbs +1 -1
- package/cjs/templates/runtime.hbs +1 -1
- package/cjs/templates/tx.hbs +1 -1
- package/generator/ApiGen.d.ts +5 -5
- package/generator/ConstsGen.d.ts +1 -1
- package/generator/ConstsGen.js +5 -6
- package/generator/ErrorsGen.d.ts +1 -1
- package/generator/ErrorsGen.js +6 -7
- package/generator/EventsGen.d.ts +1 -1
- package/generator/EventsGen.js +6 -7
- package/generator/IndexGen.d.ts +2 -3
- package/generator/IndexGen.js +6 -7
- package/generator/JsonRpcGen.d.ts +7 -0
- package/generator/JsonRpcGen.js +55 -0
- package/generator/QueryGen.d.ts +1 -1
- package/generator/QueryGen.js +21 -13
- package/generator/RuntimeApisGen.d.ts +5 -5
- package/generator/RuntimeApisGen.js +99 -21
- package/generator/TxGen.d.ts +1 -1
- package/generator/TxGen.js +11 -9
- package/generator/TypeImports.d.ts +2 -0
- package/generator/TypeImports.js +8 -0
- package/generator/TypesGen.d.ts +3 -3
- package/generator/TypesGen.js +12 -18
- package/generator/index.d.ts +10 -10
- package/generator/index.js +10 -10
- package/generator/known-codecs.d.ts +23 -0
- package/generator/known-codecs.js +120 -0
- package/generator/utils.d.ts +5 -0
- package/generator/utils.js +28 -0
- package/index.d.ts +2 -3
- package/index.js +24 -24
- package/package.json +14 -18
- package/templates/consts.hbs +1 -1
- package/templates/errors.hbs +1 -1
- package/templates/events.hbs +1 -1
- package/templates/index.hbs +15 -10
- package/templates/json-rpc.hbs +5 -0
- package/templates/query.hbs +1 -1
- package/templates/runtime.hbs +1 -1
- package/templates/tx.hbs +1 -1
- package/cjs/genSupportedChainTypes.js +0 -79
- package/cjs/generator/RpcGen.js +0 -175
- package/cjs/packageInfo.js +0 -5
- package/cjs/templates/rpc.hbs +0 -7
- package/cjs/types.js +0 -2
- package/genSupportedChainTypes.d.ts +0 -1
- package/genSupportedChainTypes.js +0 -74
- package/generator/RpcGen.d.ts +0 -10
- package/generator/RpcGen.js +0 -171
- package/packageInfo.d.ts +0 -4
- package/packageInfo.js +0 -2
- package/templates/rpc.hbs +0 -7
- package/types.d.ts +0 -6
- package/types.js +0 -1
package/generator/ConstsGen.js
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { beautifySourceCode, commentBlock, compileTemplate } from './utils';
|
|
1
|
+
import { normalizeName, stringCamelCase } from '@dedot/utils';
|
|
2
|
+
import { ApiGen } from './ApiGen.js';
|
|
3
|
+
import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
|
|
5
4
|
export class ConstsGen extends ApiGen {
|
|
6
5
|
generate() {
|
|
7
6
|
const { pallets } = this.metadata;
|
|
8
7
|
this.typesGen.clearCache();
|
|
9
|
-
this.typesGen.typeImports.addKnownType('GenericChainConsts');
|
|
8
|
+
this.typesGen.typeImports.addKnownType('GenericChainConsts', 'RpcVersion');
|
|
10
9
|
let defTypeOut = '';
|
|
11
10
|
for (let pallet of pallets) {
|
|
12
11
|
const typedConstants = pallet.constants.map((one) => ({
|
|
@@ -15,7 +14,7 @@ export class ConstsGen extends ApiGen {
|
|
|
15
14
|
docs: one.docs,
|
|
16
15
|
}));
|
|
17
16
|
defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s constants`);
|
|
18
|
-
defTypeOut += `${
|
|
17
|
+
defTypeOut += `${stringCamelCase(pallet.name)}: {
|
|
19
18
|
${typedConstants.map(({ name, type, docs }) => `${commentBlock(docs)}${name}: ${type}`).join(',\n')}
|
|
20
19
|
|
|
21
20
|
${commentBlock('Generic pallet constant')}[name: string]: any,
|
package/generator/ErrorsGen.d.ts
CHANGED
package/generator/ErrorsGen.js
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { assert } from '@dedot/utils';
|
|
1
|
+
import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
|
|
2
|
+
import { ApiGen } from './ApiGen.js';
|
|
3
|
+
import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
|
|
5
4
|
export class ErrorsGen extends ApiGen {
|
|
6
5
|
generate() {
|
|
7
6
|
const { pallets } = this.metadata;
|
|
8
7
|
this.typesGen.clearCache();
|
|
9
|
-
this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
|
|
8
|
+
this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError', 'RpcVersion');
|
|
10
9
|
let defTypeOut = '';
|
|
11
10
|
for (let pallet of pallets) {
|
|
12
11
|
const errorTypeId = pallet.error;
|
|
@@ -17,10 +16,10 @@ export class ErrorsGen extends ApiGen {
|
|
|
17
16
|
defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s errors`);
|
|
18
17
|
defTypeOut += `${stringCamelCase(pallet.name)}: {
|
|
19
18
|
${errorDefs
|
|
20
|
-
.map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError
|
|
19
|
+
.map(({ name, docs }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletError<Rv>`)
|
|
21
20
|
.join(',\n')}
|
|
22
21
|
|
|
23
|
-
${commentBlock('Generic pallet error')}[error: string]: GenericPalletError
|
|
22
|
+
${commentBlock('Generic pallet error')}[error: string]: GenericPalletError<Rv>,
|
|
24
23
|
},`;
|
|
25
24
|
}
|
|
26
25
|
const importTypes = this.typesGen.typeImports.toImports();
|
package/generator/EventsGen.d.ts
CHANGED
package/generator/EventsGen.js
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { assert } from '@dedot/utils';
|
|
1
|
+
import { assert, stringCamelCase, stringPascalCase } from '@dedot/utils';
|
|
2
|
+
import { ApiGen } from './ApiGen.js';
|
|
3
|
+
import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
|
|
5
4
|
export class EventsGen extends ApiGen {
|
|
6
5
|
generate() {
|
|
7
6
|
const { pallets } = this.metadata;
|
|
8
7
|
this.typesGen.clearCache();
|
|
9
|
-
this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent');
|
|
8
|
+
this.typesGen.typeImports.addKnownType('GenericChainEvents', 'GenericPalletEvent', 'RpcVersion');
|
|
10
9
|
let defTypeOut = '';
|
|
11
10
|
for (let pallet of pallets) {
|
|
12
11
|
const eventTypeId = pallet.event;
|
|
@@ -29,10 +28,10 @@ export class EventsGen extends ApiGen {
|
|
|
29
28
|
}
|
|
30
29
|
return { ...def, genericParts };
|
|
31
30
|
})
|
|
32
|
-
.map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent
|
|
31
|
+
.map(({ name, docs, fields, genericParts }) => `${commentBlock(docs)}${stringPascalCase(name)}: GenericPalletEvent<Rv, ${genericParts.join(', ')}>`)
|
|
33
32
|
.join(',\n')}
|
|
34
33
|
|
|
35
|
-
${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent
|
|
34
|
+
${commentBlock('Generic pallet event')}[prop: string]: GenericPalletEvent<Rv>,
|
|
36
35
|
},`;
|
|
37
36
|
}
|
|
38
37
|
const importTypes = this.typesGen.typeImports.toImports();
|
package/generator/IndexGen.d.ts
CHANGED
package/generator/IndexGen.js
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { stringPascalCase } from '@dedot/utils';
|
|
2
|
+
import { beautifySourceCode, compileTemplate } from './utils.js';
|
|
3
3
|
export class IndexGen {
|
|
4
|
-
|
|
5
|
-
constructor(
|
|
6
|
-
this.
|
|
4
|
+
chain;
|
|
5
|
+
constructor(chain) {
|
|
6
|
+
this.chain = chain;
|
|
7
7
|
}
|
|
8
8
|
async generate() {
|
|
9
|
-
const
|
|
10
|
-
const interfaceName = stringPascalCase(chain);
|
|
9
|
+
const interfaceName = stringPascalCase(this.chain);
|
|
11
10
|
const template = compileTemplate('index.hbs');
|
|
12
11
|
return beautifySourceCode(template({ interfaceName }));
|
|
13
12
|
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { subscriptionsInfo } from '@dedot/specs';
|
|
2
|
+
import { ApiGen } from '../generator/index.js';
|
|
3
|
+
import { beautifySourceCode, compileTemplate } from './utils.js';
|
|
4
|
+
const HIDDEN_RPCS = [
|
|
5
|
+
// Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
|
|
6
|
+
'rpc_methods',
|
|
7
|
+
];
|
|
8
|
+
const ALIAS_RPCS = [
|
|
9
|
+
// TODO include these into the specs
|
|
10
|
+
'account_nextIndex',
|
|
11
|
+
'system_dryRunAt',
|
|
12
|
+
'state_callAt',
|
|
13
|
+
'state_getKeysPagedAt',
|
|
14
|
+
'state_getStorageAt',
|
|
15
|
+
'state_getStorageHashAt',
|
|
16
|
+
'state_getStorageSizeAt',
|
|
17
|
+
'chain_getRuntimeVersion',
|
|
18
|
+
'chain_getHead',
|
|
19
|
+
'chain_getFinalisedHead',
|
|
20
|
+
'childstate_getKeysPagedAt',
|
|
21
|
+
// Subscription pairs
|
|
22
|
+
'chain_subscribeRuntimeVersion',
|
|
23
|
+
'chain_unsubscribeRuntimeVersion',
|
|
24
|
+
'chain_unsubscribeNewHead',
|
|
25
|
+
'chain_subscribeNewHead',
|
|
26
|
+
'subscribe_newHead',
|
|
27
|
+
'unsubscribe_newHead',
|
|
28
|
+
'chain_subscribeFinalisedHeads',
|
|
29
|
+
'chain_unsubscribeFinalisedHeads',
|
|
30
|
+
];
|
|
31
|
+
export class JsonRpcGen extends ApiGen {
|
|
32
|
+
typesGen;
|
|
33
|
+
rpcMethods;
|
|
34
|
+
constructor(typesGen, rpcMethods) {
|
|
35
|
+
super(typesGen);
|
|
36
|
+
this.typesGen = typesGen;
|
|
37
|
+
this.rpcMethods = rpcMethods;
|
|
38
|
+
HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
|
|
39
|
+
rpcMethods.sort();
|
|
40
|
+
}
|
|
41
|
+
generate() {
|
|
42
|
+
this.typesGen.clearCache();
|
|
43
|
+
this.typesGen.typeImports.addKnownType('GenericJsonRpcApis', 'RpcVersion');
|
|
44
|
+
this.typesGen.typeImports.addSpecType('JsonRpcApis');
|
|
45
|
+
const toExclude = Object.values(subscriptionsInfo).flat();
|
|
46
|
+
const importTypes = this.typesGen.typeImports.toImports();
|
|
47
|
+
const template = compileTemplate('json-rpc.hbs');
|
|
48
|
+
const jsonRpcMethods = this.rpcMethods
|
|
49
|
+
.filter((one) => !ALIAS_RPCS.includes(one)) // exclude alias rpcs
|
|
50
|
+
.filter((one) => !toExclude.includes(one)) // exclude unsubscribe methods
|
|
51
|
+
.map((one) => `'${one}'`)
|
|
52
|
+
.join(' | ');
|
|
53
|
+
return beautifySourceCode(template({ importTypes, jsonRpcMethods }));
|
|
54
|
+
}
|
|
55
|
+
}
|
package/generator/QueryGen.d.ts
CHANGED
package/generator/QueryGen.js
CHANGED
|
@@ -1,24 +1,30 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { beautifySourceCode, commentBlock, compileTemplate } from './utils';
|
|
1
|
+
import { normalizeName, stringCamelCase } from '@dedot/utils';
|
|
2
|
+
import { ApiGen } from './ApiGen.js';
|
|
3
|
+
import { beautifySourceCode, commentBlock, compileTemplate } from './utils.js';
|
|
5
4
|
export class QueryGen extends ApiGen {
|
|
6
5
|
generate() {
|
|
7
6
|
const { pallets } = this.metadata;
|
|
8
7
|
this.typesGen.clearCache();
|
|
9
|
-
this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
|
|
8
|
+
this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback', 'RpcVersion');
|
|
10
9
|
let defTypeOut = '';
|
|
11
10
|
for (let pallet of pallets) {
|
|
12
11
|
const storage = pallet.storage;
|
|
13
12
|
if (!storage)
|
|
14
13
|
continue;
|
|
15
14
|
const queries = storage.entries.map((one) => this.#generateEntry(one));
|
|
16
|
-
const queryDefs = queries.map(({ name, valueType, keyType, docs
|
|
15
|
+
const queryDefs = queries.map(({ name, valueType, keyType, docs, keyTypeOut }) => {
|
|
16
|
+
if (keyTypeOut) {
|
|
17
|
+
return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}, ${keyTypeOut}>`;
|
|
18
|
+
}
|
|
19
|
+
else {
|
|
20
|
+
return `${commentBlock(docs)}${name}: GenericStorageQuery<Rv, (${keyType}) => ${valueType}>`;
|
|
21
|
+
}
|
|
22
|
+
});
|
|
17
23
|
defTypeOut += commentBlock(`Pallet \`${pallet.name}\`'s storage queries`);
|
|
18
|
-
defTypeOut += `${
|
|
24
|
+
defTypeOut += `${stringCamelCase(pallet.name)}: {
|
|
19
25
|
${queryDefs.join(',\n')}
|
|
20
26
|
|
|
21
|
-
${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery
|
|
27
|
+
${commentBlock('Generic pallet storage query')}[storage: string]: GenericStorageQuery<Rv>;
|
|
22
28
|
},`;
|
|
23
29
|
}
|
|
24
30
|
const importTypes = this.typesGen.typeImports.toImports();
|
|
@@ -27,13 +33,14 @@ export class QueryGen extends ApiGen {
|
|
|
27
33
|
}
|
|
28
34
|
#generateEntry(entry) {
|
|
29
35
|
const { name, type, docs, modifier } = entry;
|
|
30
|
-
let valueType,
|
|
36
|
+
let valueType, keyTypeOut, keyTypeIn;
|
|
31
37
|
if (type.tag === 'Plain') {
|
|
32
38
|
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
33
39
|
}
|
|
34
40
|
else if (type.tag === 'Map') {
|
|
35
41
|
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
36
|
-
|
|
42
|
+
keyTypeOut = this.typesGen.generateType(type.value.keyTypeId, 1, true);
|
|
43
|
+
keyTypeIn = this.typesGen.generateType(type.value.keyTypeId, 1);
|
|
37
44
|
}
|
|
38
45
|
else {
|
|
39
46
|
throw Error('Invalid entry type!');
|
|
@@ -41,14 +48,15 @@ export class QueryGen extends ApiGen {
|
|
|
41
48
|
const isOptional = modifier === 'Optional';
|
|
42
49
|
valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
|
|
43
50
|
docs.push('\n');
|
|
44
|
-
if (
|
|
45
|
-
docs.push(`@param {${
|
|
51
|
+
if (keyTypeIn) {
|
|
52
|
+
docs.push(`@param {${keyTypeIn}} arg`);
|
|
46
53
|
}
|
|
47
54
|
docs.push(`@param {Callback<${valueType}> =} callback`);
|
|
48
55
|
return {
|
|
49
56
|
name: normalizeName(name),
|
|
50
57
|
valueType,
|
|
51
|
-
keyType:
|
|
58
|
+
keyType: keyTypeIn ? `arg: ${keyTypeIn}` : '',
|
|
59
|
+
keyTypeOut,
|
|
52
60
|
docs,
|
|
53
61
|
};
|
|
54
62
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
export declare class RuntimeApisGen extends
|
|
1
|
+
import { ApiGen } from './ApiGen.js';
|
|
2
|
+
import { TypesGen } from './TypesGen.js';
|
|
3
|
+
export declare class RuntimeApisGen extends ApiGen {
|
|
4
4
|
#private;
|
|
5
5
|
readonly typesGen: TypesGen;
|
|
6
|
-
readonly runtimeApis:
|
|
7
|
-
constructor(typesGen: TypesGen, runtimeApis:
|
|
6
|
+
readonly runtimeApis: Record<string, number>;
|
|
7
|
+
constructor(typesGen: TypesGen, runtimeApis: Record<string, number>);
|
|
8
8
|
generate(): Promise<string>;
|
|
9
9
|
}
|
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
export class RuntimeApisGen extends
|
|
1
|
+
import { getRuntimeApiNames, getRuntimeApiSpecs } from '@dedot/specs';
|
|
2
|
+
import { calcRuntimeApiHash, stringSnakeCase, stringCamelCase } from '@dedot/utils';
|
|
3
|
+
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
|
+
export class RuntimeApisGen extends ApiGen {
|
|
7
7
|
typesGen;
|
|
8
8
|
runtimeApis;
|
|
9
9
|
constructor(typesGen, runtimeApis) {
|
|
10
|
-
super(typesGen
|
|
10
|
+
super(typesGen);
|
|
11
11
|
this.typesGen = typesGen;
|
|
12
12
|
this.runtimeApis = runtimeApis;
|
|
13
13
|
}
|
|
14
14
|
generate() {
|
|
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) => {
|
|
20
20
|
const { name: runtimeApiName, methods } = runtimeApi;
|
|
21
|
-
runtimeCallsOut += commentBlock(`@runtimeapi: ${runtimeApiName} - ${
|
|
21
|
+
runtimeCallsOut += commentBlock(`@runtimeapi: ${runtimeApiName} - ${calcRuntimeApiHash(runtimeApiName)}`);
|
|
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,7 +39,7 @@ export class RuntimeApisGen extends RpcGen {
|
|
|
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
|
}
|
|
@@ -57,25 +57,25 @@ export class RuntimeApisGen extends RpcGen {
|
|
|
57
57
|
const { docs = [], params, type, runtimeApiName, methodName } = spec;
|
|
58
58
|
const callName = `${runtimeApiName}_${stringSnakeCase(methodName)}`;
|
|
59
59
|
const defaultDocs = [`@callname: ${callName}`];
|
|
60
|
-
this
|
|
61
|
-
params.forEach(({ type }) => this
|
|
60
|
+
this.#addTypeImport(type, false);
|
|
61
|
+
params.forEach(({ type }) => this.#addTypeImport(type));
|
|
62
62
|
const typedParams = params.map((param, idx) => ({
|
|
63
63
|
...param,
|
|
64
64
|
isOptional: this.#isOptionalParam(params, param.type, idx),
|
|
65
|
-
plainType: this
|
|
65
|
+
plainType: this.#getGeneratedTypeName(param.type),
|
|
66
66
|
}));
|
|
67
67
|
const paramsOut = typedParams
|
|
68
68
|
.map(({ name, isOptional, plainType }) => `${stringCamelCase(name)}${isOptional ? '?' : ''}: ${plainType}`)
|
|
69
69
|
.join(', ');
|
|
70
|
-
const typeOut = this
|
|
71
|
-
return `${commentBlock(docs, '\n', defaultDocs, typedParams.map(({ plainType, name }) => `@param {${plainType}} ${name}`))}${methodName}: GenericRuntimeApiMethod<(${paramsOut}) => Promise<${typeOut}>>`;
|
|
70
|
+
const typeOut = this.#getGeneratedTypeName(type, false);
|
|
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;
|
|
75
75
|
const callName = `${runtimeApiName}_${stringSnakeCase(methodName)}`;
|
|
76
76
|
const defaultDocs = [`@callname: ${callName}`];
|
|
77
77
|
const typeOut = this.typesGen.generateType(output, 1, true);
|
|
78
|
-
this
|
|
78
|
+
this.#addTypeImport(typeOut, false);
|
|
79
79
|
const typedInputs = inputs
|
|
80
80
|
.map((input, idx) => ({
|
|
81
81
|
...input,
|
|
@@ -85,15 +85,15 @@ export class RuntimeApisGen extends RpcGen {
|
|
|
85
85
|
...input,
|
|
86
86
|
isOptional: this.#isOptionalParam(inputs, input.type, idx),
|
|
87
87
|
}));
|
|
88
|
-
this
|
|
88
|
+
this.#addTypeImport(typedInputs.map((t) => t.type));
|
|
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
|
-
const specs = this.runtimeApis.map(([runtimeApiHash, version]) => {
|
|
96
|
-
const runtimeApiSpec = findRuntimeApiSpec(runtimeApiHash, version);
|
|
95
|
+
const specs = Object.entries(this.runtimeApis).map(([runtimeApiHash, version]) => {
|
|
96
|
+
const runtimeApiSpec = this.#findRuntimeApiSpec(runtimeApiHash, version);
|
|
97
97
|
if (!runtimeApiSpec)
|
|
98
98
|
return;
|
|
99
99
|
return {
|
|
@@ -108,4 +108,82 @@ export class RuntimeApisGen extends RpcGen {
|
|
|
108
108
|
return [...o, spec];
|
|
109
109
|
}, []);
|
|
110
110
|
}
|
|
111
|
+
#findRuntimeApiSpec = (runtimeApiHash, version) => {
|
|
112
|
+
const runtimeApiName = getRuntimeApiNames().find((one) => calcRuntimeApiHash(one) === runtimeApiHash);
|
|
113
|
+
return getRuntimeApiSpecs().find((one) => one.runtimeApiName === runtimeApiName && one.version === version);
|
|
114
|
+
};
|
|
115
|
+
// TODO check typeIn, typeOut if param type, or rpc type isScale
|
|
116
|
+
#addTypeImport(type, toTypeIn = true) {
|
|
117
|
+
if (Array.isArray(type)) {
|
|
118
|
+
type.forEach((one) => this.#addTypeImport(one, toTypeIn));
|
|
119
|
+
return;
|
|
120
|
+
}
|
|
121
|
+
type = type.trim();
|
|
122
|
+
if (isNativeType(type)) {
|
|
123
|
+
return;
|
|
124
|
+
}
|
|
125
|
+
// Handle generic wrapper types
|
|
126
|
+
const matchArray = type.match(WRAPPER_TYPE_REGEX);
|
|
127
|
+
if (matchArray) {
|
|
128
|
+
const [_, $1, $2] = matchArray;
|
|
129
|
+
this.#addTypeImport($1, toTypeIn);
|
|
130
|
+
if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
|
|
131
|
+
this.#addTypeImport($2, toTypeIn);
|
|
132
|
+
}
|
|
133
|
+
else {
|
|
134
|
+
this.#addTypeImport($2.split(','), toTypeIn);
|
|
135
|
+
}
|
|
136
|
+
return;
|
|
137
|
+
}
|
|
138
|
+
// Check tuple type
|
|
139
|
+
if (type.match(TUPLE_TYPE_REGEX)) {
|
|
140
|
+
this.#addTypeImport(type.slice(1, -1).split(','), toTypeIn);
|
|
141
|
+
return;
|
|
142
|
+
}
|
|
143
|
+
if (type.includes(' | ')) {
|
|
144
|
+
this.#addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
|
|
145
|
+
return;
|
|
146
|
+
}
|
|
147
|
+
try {
|
|
148
|
+
const codecType = this.#getCodecType(type, toTypeIn);
|
|
149
|
+
if (isNativeType(codecType))
|
|
150
|
+
return;
|
|
151
|
+
this.typesGen.typeImports.addCodecType(codecType);
|
|
152
|
+
return;
|
|
153
|
+
}
|
|
154
|
+
catch (e) { }
|
|
155
|
+
this.typesGen.addTypeImport(type);
|
|
156
|
+
}
|
|
157
|
+
#getGeneratedTypeName(type, toTypeIn = true) {
|
|
158
|
+
try {
|
|
159
|
+
const matchArray = type.match(WRAPPER_TYPE_REGEX);
|
|
160
|
+
if (matchArray) {
|
|
161
|
+
const [_, $1, $2] = matchArray;
|
|
162
|
+
const wrapperTypeName = this.#getCodecType($1, toTypeIn);
|
|
163
|
+
if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
|
|
164
|
+
return `${wrapperTypeName}<${this.#getGeneratedTypeName($2, toTypeIn)}>`;
|
|
165
|
+
}
|
|
166
|
+
const innerTypeNames = $2
|
|
167
|
+
.split(',')
|
|
168
|
+
.map((one) => this.#getGeneratedTypeName(one.trim(), toTypeIn))
|
|
169
|
+
.join(', ');
|
|
170
|
+
return `${wrapperTypeName}<${innerTypeNames}>`;
|
|
171
|
+
}
|
|
172
|
+
else if (type.match(TUPLE_TYPE_REGEX)) {
|
|
173
|
+
const innerTypeNames = type
|
|
174
|
+
.slice(1, -1)
|
|
175
|
+
.split(',')
|
|
176
|
+
.map((one) => this.#getGeneratedTypeName(one.trim(), toTypeIn))
|
|
177
|
+
.join(', ');
|
|
178
|
+
return `[${innerTypeNames}]`;
|
|
179
|
+
}
|
|
180
|
+
return this.#getCodecType(type, toTypeIn);
|
|
181
|
+
}
|
|
182
|
+
catch (e) { }
|
|
183
|
+
return type;
|
|
184
|
+
}
|
|
185
|
+
#getCodecType(type, toTypeIn = true) {
|
|
186
|
+
const { typeIn, typeOut } = findKnownCodecType(type);
|
|
187
|
+
return toTypeIn ? typeIn : typeOut;
|
|
188
|
+
}
|
|
111
189
|
}
|
package/generator/TxGen.d.ts
CHANGED
package/generator/TxGen.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { beautifySourceCode, commentBlock, compileTemplate, isReservedWord } from './utils';
|
|
1
|
+
import { stringCamelCase, stringPascalCase } from '@dedot/utils';
|
|
2
|
+
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() {
|
|
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,20 +41,22 @@ 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
|
|
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
50
|
const importTypes = this.typesGen.typeImports.toImports();
|
|
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
|
-
|
|
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
61
|
const template = compileTemplate('tx.hbs');
|
|
60
62
|
return beautifySourceCode(template({ importTypes, defTypes, txDefsOut }));
|
|
@@ -3,6 +3,7 @@ export declare class TypeImports {
|
|
|
3
3
|
portableTypes: Set<string>;
|
|
4
4
|
codecTypes: Set<string>;
|
|
5
5
|
knownTypes: Set<string>;
|
|
6
|
+
specTypes: Set<string>;
|
|
6
7
|
outTypes: Set<string>;
|
|
7
8
|
constructor();
|
|
8
9
|
clear(): void;
|
|
@@ -10,5 +11,6 @@ export declare class TypeImports {
|
|
|
10
11
|
addPortableType(...types: string[]): void;
|
|
11
12
|
addCodecType(...types: string[]): void;
|
|
12
13
|
addKnownType(...types: string[]): void;
|
|
14
|
+
addSpecType(...types: string[]): void;
|
|
13
15
|
addOutType(...types: string[]): void;
|
|
14
16
|
}
|
package/generator/TypeImports.js
CHANGED
|
@@ -5,30 +5,35 @@ export class TypeImports {
|
|
|
5
5
|
codecTypes;
|
|
6
6
|
// Known types that're not codecs or chain/portable types defined in @dedot/types
|
|
7
7
|
knownTypes;
|
|
8
|
+
specTypes;
|
|
8
9
|
// External types to define explicitly
|
|
9
10
|
outTypes;
|
|
10
11
|
constructor() {
|
|
11
12
|
this.portableTypes = new Set();
|
|
12
13
|
this.codecTypes = new Set();
|
|
13
14
|
this.knownTypes = new Set();
|
|
15
|
+
this.specTypes = new Set();
|
|
14
16
|
this.outTypes = new Set();
|
|
15
17
|
}
|
|
16
18
|
clear() {
|
|
17
19
|
this.portableTypes.clear();
|
|
18
20
|
this.codecTypes.clear();
|
|
19
21
|
this.knownTypes.clear();
|
|
22
|
+
this.specTypes.clear();
|
|
20
23
|
this.outTypes.clear();
|
|
21
24
|
}
|
|
22
25
|
toImports(...excludeModules) {
|
|
23
26
|
// TODO generate outTypes!
|
|
24
27
|
const toImports = [
|
|
25
28
|
[this.knownTypes, '@dedot/types'],
|
|
29
|
+
[this.specTypes, '@dedot/specs'],
|
|
26
30
|
[this.codecTypes, '@dedot/codecs'],
|
|
27
31
|
[this.portableTypes, './types'],
|
|
28
32
|
];
|
|
29
33
|
return toImports
|
|
30
34
|
.filter(([_, module]) => !excludeModules.includes(module))
|
|
31
35
|
.map(([types, module]) => this.#toImportLine(types, module))
|
|
36
|
+
.filter((line) => line.length > 0)
|
|
32
37
|
.join('\n');
|
|
33
38
|
}
|
|
34
39
|
#toImportLine(types, module) {
|
|
@@ -46,6 +51,9 @@ export class TypeImports {
|
|
|
46
51
|
addKnownType(...types) {
|
|
47
52
|
types.forEach((one) => this.knownTypes.add(one));
|
|
48
53
|
}
|
|
54
|
+
addSpecType(...types) {
|
|
55
|
+
types.forEach((one) => this.specTypes.add(one));
|
|
56
|
+
}
|
|
49
57
|
addOutType(...types) {
|
|
50
58
|
types.forEach((one) => this.outTypes.add(one));
|
|
51
59
|
}
|
package/generator/TypesGen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { TypeImports } from './TypeImports';
|
|
1
|
+
import { Field, MetadataLatest, PortableRegistry, PortableType, TypeId } from '@dedot/codecs';
|
|
2
|
+
import { TypeImports } from './TypeImports.js';
|
|
3
3
|
interface NamedType extends PortableType {
|
|
4
4
|
name: string;
|
|
5
5
|
nameOut: string;
|
|
@@ -15,7 +15,7 @@ export declare class TypesGen {
|
|
|
15
15
|
* Types will be generated its definition out.
|
|
16
16
|
*/
|
|
17
17
|
includedTypes: Record<TypeId, NamedType>;
|
|
18
|
-
registry:
|
|
18
|
+
registry: PortableRegistry;
|
|
19
19
|
typeImports: TypeImports;
|
|
20
20
|
constructor(metadata: MetadataLatest);
|
|
21
21
|
generate(): Promise<string>;
|