@dedot/codegen 0.0.1-next.f5bf4fc2.1 → 0.1.0
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/{generator → chaintypes/generator}/ApiGen.d.ts +13 -13
- package/chaintypes/generator/ConstsGen.d.ts +4 -0
- package/{generator → chaintypes/generator}/ConstsGen.js +8 -9
- package/chaintypes/generator/ErrorsGen.d.ts +5 -0
- package/{generator → chaintypes/generator}/ErrorsGen.js +11 -12
- package/chaintypes/generator/EventsGen.d.ts +5 -0
- package/{generator → chaintypes/generator}/EventsGen.js +11 -12
- package/chaintypes/generator/IndexGen.d.ts +5 -0
- package/chaintypes/generator/IndexGen.js +17 -0
- package/chaintypes/generator/JsonRpcGen.d.ts +8 -0
- package/chaintypes/generator/JsonRpcGen.js +55 -0
- package/chaintypes/generator/QueryGen.d.ts +5 -0
- package/chaintypes/generator/QueryGen.js +63 -0
- package/chaintypes/generator/RuntimeApisGen.d.ts +9 -0
- package/{generator → chaintypes/generator}/RuntimeApisGen.js +98 -24
- package/chaintypes/generator/TxGen.d.ts +5 -0
- package/{generator → chaintypes/generator}/TxGen.js +18 -16
- package/chaintypes/generator/TypesGen.d.ts +11 -0
- package/chaintypes/generator/TypesGen.js +55 -0
- package/chaintypes/generator/index.d.ts +10 -0
- package/chaintypes/generator/index.js +10 -0
- package/chaintypes/index.d.ts +3 -0
- package/chaintypes/index.js +49 -0
- package/chaintypes/templates/consts.hbs +7 -0
- package/chaintypes/templates/errors.hbs +7 -0
- package/chaintypes/templates/events.hbs +7 -0
- package/chaintypes/templates/index.hbs +27 -0
- package/chaintypes/templates/json-rpc.hbs +5 -0
- package/chaintypes/templates/query.hbs +7 -0
- package/chaintypes/templates/runtime.hbs +8 -0
- package/chaintypes/templates/tx.hbs +9 -0
- package/{cjs → chaintypes}/templates/types.hbs +1 -1
- package/cjs/{generator → chaintypes/generator}/ConstsGen.js +12 -13
- package/cjs/chaintypes/generator/ErrorsGen.js +40 -0
- package/cjs/{generator → chaintypes/generator}/EventsGen.js +17 -18
- package/cjs/chaintypes/generator/IndexGen.js +21 -0
- package/cjs/chaintypes/generator/JsonRpcGen.js +59 -0
- package/cjs/chaintypes/generator/QueryGen.js +67 -0
- package/cjs/chaintypes/generator/RuntimeApisGen.js +193 -0
- package/cjs/{generator → chaintypes/generator}/TxGen.js +27 -25
- package/cjs/chaintypes/generator/TypesGen.js +59 -0
- package/cjs/chaintypes/generator/index.js +26 -0
- package/cjs/chaintypes/index.js +77 -0
- package/cjs/chaintypes/templates/consts.hbs +7 -0
- package/cjs/chaintypes/templates/errors.hbs +7 -0
- package/cjs/chaintypes/templates/events.hbs +7 -0
- package/cjs/chaintypes/templates/index.hbs +27 -0
- package/cjs/chaintypes/templates/json-rpc.hbs +5 -0
- package/cjs/chaintypes/templates/query.hbs +7 -0
- package/cjs/chaintypes/templates/runtime.hbs +8 -0
- package/cjs/chaintypes/templates/tx.hbs +9 -0
- package/{templates → cjs/chaintypes/templates}/types.hbs +1 -1
- package/cjs/index.js +4 -62
- package/cjs/{generator/TypesGen.js → shared/BaseTypesGen.js} +123 -178
- package/cjs/{generator → shared}/TypeImports.js +29 -3
- package/cjs/{generator → shared}/index.js +3 -10
- package/cjs/{generator → shared}/known-codecs.js +24 -5
- package/cjs/typink/generator/ConstructorQueryGen.js +24 -0
- package/cjs/typink/generator/ConstructorTxGen.js +24 -0
- package/cjs/typink/generator/EventsGen.js +35 -0
- package/cjs/typink/generator/IndexGen.js +24 -0
- package/cjs/typink/generator/QueryGen.js +72 -0
- package/cjs/typink/generator/TxGen.js +25 -0
- package/cjs/typink/generator/TypesGen.js +28 -0
- package/cjs/typink/generator/index.js +23 -0
- package/cjs/typink/index.js +40 -0
- package/cjs/typink/templates/constructor-query.hbs +7 -0
- package/cjs/typink/templates/constructor-tx.hbs +7 -0
- package/cjs/typink/templates/events.hbs +8 -0
- package/cjs/typink/templates/index.hbs +16 -0
- package/cjs/typink/templates/query.hbs +7 -0
- package/cjs/typink/templates/tx.hbs +7 -0
- package/cjs/typink/templates/types.hbs +5 -0
- package/cjs/{generator/utils.js → utils.js} +34 -5
- package/index.d.ts +2 -4
- package/index.js +2 -48
- package/package.json +15 -18
- package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts} +13 -12
- package/{generator/TypesGen.js → shared/BaseTypesGen.js} +111 -166
- package/{generator → shared}/TypeImports.d.ts +12 -1
- package/{generator → shared}/TypeImports.js +29 -3
- package/shared/index.d.ts +3 -0
- package/shared/index.js +3 -0
- package/{generator → shared}/known-codecs.d.ts +1 -1
- package/{generator → shared}/known-codecs.js +22 -3
- package/typink/generator/ConstructorQueryGen.d.ts +6 -0
- package/typink/generator/ConstructorQueryGen.js +20 -0
- package/typink/generator/ConstructorTxGen.d.ts +6 -0
- package/typink/generator/ConstructorTxGen.js +20 -0
- package/typink/generator/EventsGen.d.ts +7 -0
- package/typink/generator/EventsGen.js +31 -0
- package/typink/generator/IndexGen.d.ts +6 -0
- package/typink/generator/IndexGen.js +20 -0
- package/typink/generator/QueryGen.d.ts +12 -0
- package/typink/generator/QueryGen.js +68 -0
- package/typink/generator/TxGen.d.ts +6 -0
- package/typink/generator/TxGen.js +21 -0
- package/typink/generator/TypesGen.d.ts +7 -0
- package/typink/generator/TypesGen.js +24 -0
- package/typink/generator/index.d.ts +7 -0
- package/typink/generator/index.js +7 -0
- package/typink/index.d.ts +2 -0
- package/typink/index.js +33 -0
- package/typink/templates/constructor-query.hbs +7 -0
- package/typink/templates/constructor-tx.hbs +7 -0
- package/typink/templates/events.hbs +8 -0
- package/typink/templates/index.hbs +16 -0
- package/typink/templates/query.hbs +7 -0
- package/typink/templates/tx.hbs +7 -0
- package/typink/templates/types.hbs +5 -0
- package/{generator/utils.d.ts → utils.d.ts} +6 -1
- package/{generator/utils.js → utils.js} +32 -4
- package/cjs/genSupportedChainTypes.js +0 -83
- package/cjs/generator/ErrorsGen.js +0 -41
- package/cjs/generator/IndexGen.js +0 -18
- package/cjs/generator/QueryGen.js +0 -59
- package/cjs/generator/RpcGen.js +0 -176
- package/cjs/generator/RuntimeApisGen.js +0 -119
- package/cjs/generator/known-types.js +0 -33
- package/cjs/packageInfo.js +0 -5
- package/cjs/templates/consts.hbs +0 -7
- package/cjs/templates/errors.hbs +0 -7
- package/cjs/templates/events.hbs +0 -7
- package/cjs/templates/index.hbs +0 -22
- package/cjs/templates/query.hbs +0 -7
- package/cjs/templates/rpc.hbs +0 -7
- package/cjs/templates/runtime.hbs +0 -8
- package/cjs/templates/tx.hbs +0 -9
- package/cjs/types.js +0 -2
- package/genSupportedChainTypes.d.ts +0 -1
- package/genSupportedChainTypes.js +0 -78
- package/generator/ConstsGen.d.ts +0 -4
- package/generator/ErrorsGen.d.ts +0 -5
- package/generator/EventsGen.d.ts +0 -5
- package/generator/IndexGen.d.ts +0 -6
- package/generator/IndexGen.js +0 -14
- package/generator/QueryGen.d.ts +0 -5
- package/generator/QueryGen.js +0 -55
- package/generator/RpcGen.d.ts +0 -10
- package/generator/RpcGen.js +0 -172
- package/generator/RuntimeApisGen.d.ts +0 -9
- package/generator/TxGen.d.ts +0 -5
- package/generator/index.d.ts +0 -10
- package/generator/index.js +0 -10
- package/generator/known-types.d.ts +0 -6
- package/generator/known-types.js +0 -30
- package/packageInfo.d.ts +0 -4
- package/packageInfo.js +0 -2
- package/templates/consts.hbs +0 -7
- package/templates/errors.hbs +0 -7
- package/templates/events.hbs +0 -7
- package/templates/index.hbs +0 -22
- package/templates/query.hbs +0 -7
- package/templates/rpc.hbs +0 -7
- package/templates/runtime.hbs +0 -8
- package/templates/tx.hbs +0 -9
- package/types.d.ts +0 -6
- package/types.js +0 -1
- /package/{generator → chaintypes/generator}/ApiGen.js +0 -0
- /package/cjs/{generator → chaintypes/generator}/ApiGen.js +0 -0
- /package/cjs/{generator/dirname.js → dirname.js} +0 -0
- /package/{generator/dirname.d.ts → dirname.d.ts} +0 -0
- /package/{generator/dirname.js → dirname.js} +0 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { stringPascalCase } from '@dedot/utils';
|
|
2
|
+
import { TypeImports } from '../../shared/index.js';
|
|
3
|
+
import { beautifySourceCode, compileTemplate } from '../../utils.js';
|
|
4
|
+
const SUFFIX = 'contract_api';
|
|
5
|
+
export class IndexGen {
|
|
6
|
+
contractMetadata;
|
|
7
|
+
constructor(contractMetadata) {
|
|
8
|
+
this.contractMetadata = contractMetadata;
|
|
9
|
+
}
|
|
10
|
+
generate(useSubPaths = false) {
|
|
11
|
+
const contractName = stringPascalCase(`${this.contractMetadata.contract.name}_${SUFFIX}`);
|
|
12
|
+
const typeImports = new TypeImports();
|
|
13
|
+
typeImports.addKnownType('VersionedGenericSubstrateApi', 'RpcVersion', 'RpcV2');
|
|
14
|
+
typeImports.addContractType('GenericContractApi');
|
|
15
|
+
typeImports.addChainType('SubstrateApi');
|
|
16
|
+
const importTypes = typeImports.toImports({ useSubPaths });
|
|
17
|
+
const template = compileTemplate('typink/templates/index.hbs');
|
|
18
|
+
return beautifySourceCode(template({ contractName, importTypes }));
|
|
19
|
+
}
|
|
20
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ContractMetadata, ContractMessage, ContractMessageArg } from '@dedot/contracts';
|
|
2
|
+
import { TypesGen } from './TypesGen.js';
|
|
3
|
+
export declare class QueryGen {
|
|
4
|
+
contractMetadata: ContractMetadata;
|
|
5
|
+
typesGen: TypesGen;
|
|
6
|
+
constructor(contractMetadata: ContractMetadata, typeGen: TypesGen);
|
|
7
|
+
generate(useSubPaths?: boolean): Promise<string>;
|
|
8
|
+
doGenerate(messages: ContractMessage[], optionsTypeName?: string): string;
|
|
9
|
+
generateMethodDef(def: ContractMessage): string;
|
|
10
|
+
generateParamsOut(args: ContractMessageArg[]): string;
|
|
11
|
+
importType(typeId: number): any;
|
|
12
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { normalizeContractTypeDef, normalizeLabel, } from '@dedot/contracts';
|
|
2
|
+
import { stringCamelCase } from '@dedot/utils';
|
|
3
|
+
import { beautifySourceCode, commentBlock, compileTemplate } from '../../utils.js';
|
|
4
|
+
export class QueryGen {
|
|
5
|
+
contractMetadata;
|
|
6
|
+
typesGen;
|
|
7
|
+
constructor(contractMetadata, typeGen) {
|
|
8
|
+
this.contractMetadata = contractMetadata;
|
|
9
|
+
this.typesGen = typeGen;
|
|
10
|
+
}
|
|
11
|
+
generate(useSubPaths = false) {
|
|
12
|
+
this.typesGen.clearCache();
|
|
13
|
+
this.typesGen.typeImports.addKnownType('GenericSubstrateApi');
|
|
14
|
+
this.typesGen.typeImports.addContractType('GenericContractQuery', 'GenericContractQueryCall', 'ContractCallOptions', 'GenericContractCallResult', 'ContractCallResult');
|
|
15
|
+
const { messages } = this.contractMetadata.spec;
|
|
16
|
+
const queryCallsOut = this.doGenerate(messages, 'ContractCallOptions');
|
|
17
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
18
|
+
const template = compileTemplate('typink/templates/query.hbs');
|
|
19
|
+
return beautifySourceCode(template({ importTypes, queryCallsOut }));
|
|
20
|
+
}
|
|
21
|
+
doGenerate(messages, optionsTypeName) {
|
|
22
|
+
let callsOut = '';
|
|
23
|
+
messages.forEach((messageDef) => {
|
|
24
|
+
const { label, docs, selector, args } = messageDef;
|
|
25
|
+
callsOut += `${commentBlock(docs, '\n', args.map((arg) => `@param {${this.typesGen.generateType(arg.type.type, 1)}} ${stringCamelCase(arg.label)}`), optionsTypeName ? `@param {${optionsTypeName}} options` : '', '\n', `@selector ${selector}`)}`;
|
|
26
|
+
callsOut += `${normalizeLabel(label)}: ${this.generateMethodDef(messageDef)};\n\n`;
|
|
27
|
+
});
|
|
28
|
+
return callsOut;
|
|
29
|
+
}
|
|
30
|
+
generateMethodDef(def) {
|
|
31
|
+
const { args, returnType } = def;
|
|
32
|
+
this.importType(returnType.type);
|
|
33
|
+
args.forEach(({ type: { type } }) => this.importType(type));
|
|
34
|
+
const paramsOut = this.generateParamsOut(args);
|
|
35
|
+
const typeOut = this.typesGen.generateType(returnType.type, 0, true);
|
|
36
|
+
return `GenericContractQueryCall<ChainApi, (${paramsOut && `${paramsOut},`} options: ContractCallOptions) => Promise<GenericContractCallResult<${typeOut}, ContractCallResult<ChainApi>>>>`;
|
|
37
|
+
}
|
|
38
|
+
generateParamsOut(args) {
|
|
39
|
+
return args
|
|
40
|
+
.map(({ type: { type }, label }) => `${stringCamelCase(label)}: ${this.typesGen.generateType(type, 1)}`)
|
|
41
|
+
.join(', ');
|
|
42
|
+
}
|
|
43
|
+
importType(typeId) {
|
|
44
|
+
const contractType = this.contractMetadata.types[typeId];
|
|
45
|
+
const typeDef = normalizeContractTypeDef(this.contractMetadata.types[typeId].type.def);
|
|
46
|
+
if (this.typesGen.includedTypes[contractType.id]) {
|
|
47
|
+
this.typesGen.addTypeImport(this.typesGen.includedTypes[contractType.id].name);
|
|
48
|
+
return;
|
|
49
|
+
}
|
|
50
|
+
const { type, value } = typeDef;
|
|
51
|
+
switch (type) {
|
|
52
|
+
case 'Compact':
|
|
53
|
+
case 'Primitive':
|
|
54
|
+
case 'BitSequence':
|
|
55
|
+
return;
|
|
56
|
+
case 'Struct':
|
|
57
|
+
return value.fields.forEach(({ typeId }) => this.importType(typeId));
|
|
58
|
+
case 'Enum':
|
|
59
|
+
return value.members.forEach(({ fields }) => fields.map(({ typeId }) => this.importType(typeId)).flat());
|
|
60
|
+
case 'Tuple':
|
|
61
|
+
return value.fields.forEach((typeId) => this.importType(typeId));
|
|
62
|
+
case 'SizedVec':
|
|
63
|
+
return this.importType(value.typeParam);
|
|
64
|
+
case 'Sequence':
|
|
65
|
+
return this.importType(value.typeParam);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { beautifySourceCode, compileTemplate } from '../../utils.js';
|
|
2
|
+
import { QueryGen } from './QueryGen.js';
|
|
3
|
+
export class TxGen extends QueryGen {
|
|
4
|
+
generate(useSubPaths = false) {
|
|
5
|
+
this.typesGen.clearCache();
|
|
6
|
+
this.typesGen.typeImports.addKnownType('GenericSubstrateApi');
|
|
7
|
+
this.typesGen.typeImports.addContractType('GenericContractTx', 'GenericContractTxCall', 'ContractTxOptions', 'ContractSubmittableExtrinsic');
|
|
8
|
+
const { messages } = this.contractMetadata.spec;
|
|
9
|
+
const txMessages = messages.filter((one) => one.mutates);
|
|
10
|
+
const txCallsOut = this.doGenerate(txMessages, 'ContractTxOptions');
|
|
11
|
+
const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
|
|
12
|
+
const template = compileTemplate('typink/templates/tx.hbs');
|
|
13
|
+
return beautifySourceCode(template({ importTypes, txCallsOut }));
|
|
14
|
+
}
|
|
15
|
+
generateMethodDef(def) {
|
|
16
|
+
const { args } = def;
|
|
17
|
+
args.forEach(({ type: { type } }) => this.importType(type));
|
|
18
|
+
const paramsOut = this.generateParamsOut(args);
|
|
19
|
+
return `GenericContractTxCall<ChainApi, (${paramsOut && `${paramsOut},`} options: ContractTxOptions) => ContractSubmittableExtrinsic<ChainApi>>`;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ContractMetadata } from '@dedot/contracts';
|
|
2
|
+
import { BaseTypesGen } from '../../shared/index.js';
|
|
3
|
+
export declare class TypesGen extends BaseTypesGen {
|
|
4
|
+
contractMetadata: ContractMetadata;
|
|
5
|
+
constructor(contractMetadata: ContractMetadata);
|
|
6
|
+
generate(useSubPaths?: boolean): Promise<string>;
|
|
7
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { extractContractTypes } from '@dedot/contracts';
|
|
2
|
+
import { BaseTypesGen } from '../../shared/index.js';
|
|
3
|
+
import { beautifySourceCode, compileTemplate } from '../../utils.js';
|
|
4
|
+
const SKIP_TYPES = ['Result', 'Option'];
|
|
5
|
+
export class TypesGen extends BaseTypesGen {
|
|
6
|
+
contractMetadata;
|
|
7
|
+
constructor(contractMetadata) {
|
|
8
|
+
super(extractContractTypes(contractMetadata));
|
|
9
|
+
this.contractMetadata = contractMetadata;
|
|
10
|
+
this.skipTypes = SKIP_TYPES;
|
|
11
|
+
this.includedTypes = this.includeTypes();
|
|
12
|
+
}
|
|
13
|
+
generate(useSubPaths = false) {
|
|
14
|
+
let defTypeOut = '';
|
|
15
|
+
Object.values(this.includedTypes)
|
|
16
|
+
.filter(({ skip, knownType }) => !(skip || knownType))
|
|
17
|
+
.forEach(({ nameOut, id }) => {
|
|
18
|
+
defTypeOut += `export type ${nameOut} = ${this.generateType(id, 0, true)};\n\n`;
|
|
19
|
+
});
|
|
20
|
+
const importTypes = this.typeImports.toImports({ excludeModules: ['./types'], useSubPaths });
|
|
21
|
+
const template = compileTemplate('typink/templates/types.hbs');
|
|
22
|
+
return beautifySourceCode(template({ importTypes, defTypeOut }));
|
|
23
|
+
}
|
|
24
|
+
}
|
package/typink/index.js
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { parseRawMetadata } from '@dedot/contracts';
|
|
2
|
+
import fs from 'fs';
|
|
3
|
+
import path from 'path';
|
|
4
|
+
import { IndexGen, QueryGen, EventsGen, TxGen, TypesGen, ConstructorTxGen, ConstructorQueryGen, } from './generator/index.js';
|
|
5
|
+
export async function generateContractTypes(metadata, contract, outDir = '.', extension = 'd.ts', useSubPaths = false) {
|
|
6
|
+
let contractMetadata = typeof metadata === 'string' ? parseRawMetadata(metadata) : metadata;
|
|
7
|
+
contract = contract || contractMetadata.contract.name;
|
|
8
|
+
const dirPath = path.resolve(outDir, contract);
|
|
9
|
+
const typesFileName = path.join(dirPath, `types.${extension}`);
|
|
10
|
+
const queryTypesFileName = path.join(dirPath, `query.${extension}`);
|
|
11
|
+
const txTypesFileName = path.join(dirPath, `tx.${extension}`);
|
|
12
|
+
const constructorTxTypesFileName = path.join(dirPath, `constructor-tx.${extension}`);
|
|
13
|
+
const constructorQueryTypesFileName = path.join(dirPath, `constructor-query.${extension}`);
|
|
14
|
+
const eventsTypesFile = path.join(dirPath, `events.${extension}`);
|
|
15
|
+
const indexTypesFileName = path.join(dirPath, `index.${extension}`);
|
|
16
|
+
if (!fs.existsSync(dirPath)) {
|
|
17
|
+
fs.mkdirSync(dirPath, { recursive: true });
|
|
18
|
+
}
|
|
19
|
+
const typesGen = new TypesGen(contractMetadata);
|
|
20
|
+
const queryGen = new QueryGen(contractMetadata, typesGen);
|
|
21
|
+
const txGen = new TxGen(contractMetadata, typesGen);
|
|
22
|
+
const constructorTxGen = new ConstructorTxGen(contractMetadata, typesGen);
|
|
23
|
+
const constructorQueryGen = new ConstructorQueryGen(contractMetadata, typesGen);
|
|
24
|
+
const eventsGen = new EventsGen(contractMetadata, typesGen);
|
|
25
|
+
const indexGen = new IndexGen(contractMetadata);
|
|
26
|
+
fs.writeFileSync(typesFileName, await typesGen.generate(useSubPaths));
|
|
27
|
+
fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
|
|
28
|
+
fs.writeFileSync(txTypesFileName, await txGen.generate(useSubPaths));
|
|
29
|
+
fs.writeFileSync(constructorQueryTypesFileName, await constructorQueryGen.generate(useSubPaths));
|
|
30
|
+
fs.writeFileSync(constructorTxTypesFileName, await constructorTxGen.generate(useSubPaths));
|
|
31
|
+
fs.writeFileSync(eventsTypesFile, await eventsGen.generate(useSubPaths));
|
|
32
|
+
fs.writeFileSync(indexTypesFileName, await indexGen.generate(useSubPaths));
|
|
33
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// Generated by dedot cli
|
|
2
|
+
|
|
3
|
+
{{{importTypes}}}
|
|
4
|
+
import { ContractQuery } from './query';
|
|
5
|
+
import { ContractTx } from './tx';
|
|
6
|
+
import { ConstructorQuery } from './constructor-query';
|
|
7
|
+
import { ConstructorTx } from './constructor-tx';
|
|
8
|
+
import { ContractEvents } from './events'
|
|
9
|
+
|
|
10
|
+
export interface {{{contractName}}}<Rv extends RpcVersion = RpcV2, ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends GenericContractApi<Rv, ChainApi> {
|
|
11
|
+
query: ContractQuery<ChainApi[Rv]>;
|
|
12
|
+
tx: ContractTx<ChainApi[Rv]>;
|
|
13
|
+
constructorQuery: ConstructorQuery<ChainApi[Rv]>;
|
|
14
|
+
constructorTx: ConstructorTx<ChainApi[Rv]>;
|
|
15
|
+
events: ContractEvents<ChainApi[Rv]>;
|
|
16
|
+
}
|
|
@@ -2,9 +2,14 @@ export declare const WRAPPER_TYPE_REGEX: RegExp;
|
|
|
2
2
|
export declare const TUPLE_TYPE_REGEX: RegExp;
|
|
3
3
|
export declare const commentBlock: (...docs: (string | string[])[]) => string;
|
|
4
4
|
export declare const beautifySourceCode: (source: string) => Promise<string>;
|
|
5
|
-
export declare const compileTemplate: (
|
|
5
|
+
export declare const compileTemplate: (templateFile: string) => HandlebarsTemplateDelegate<any>;
|
|
6
6
|
/**
|
|
7
7
|
* Check if a word is TypeScript/JavaScript reserved
|
|
8
8
|
* @param word
|
|
9
9
|
*/
|
|
10
10
|
export declare const isReservedWord: (word: string) => boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Check if a type is native JS/TS type
|
|
13
|
+
* @param type
|
|
14
|
+
*/
|
|
15
|
+
export declare const isNativeType: (type: string) => boolean;
|
|
@@ -7,7 +7,7 @@ export const WRAPPER_TYPE_REGEX = /^(\w+)<(.*)>$/;
|
|
|
7
7
|
export const TUPLE_TYPE_REGEX = /^\[(.*)]$/;
|
|
8
8
|
export const commentBlock = (...docs) => {
|
|
9
9
|
const flatLines = docs.flat();
|
|
10
|
-
if (flatLines.length === 0) {
|
|
10
|
+
if (flatLines.length === 0 || !flatLines.some((o) => !!o)) {
|
|
11
11
|
return '';
|
|
12
12
|
}
|
|
13
13
|
else {
|
|
@@ -19,11 +19,11 @@ ${flatLines.map((line) => `* ${line.replaceAll(/\s+/g, ' ').trim()}`).join('\n')
|
|
|
19
19
|
}
|
|
20
20
|
};
|
|
21
21
|
export const beautifySourceCode = async (source) => {
|
|
22
|
-
const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '
|
|
22
|
+
const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '../../../.prettierrc.cjs'));
|
|
23
23
|
return prettier.format(source, { parser: 'babel-ts', ...prettierOptions });
|
|
24
24
|
};
|
|
25
|
-
export const compileTemplate = (
|
|
26
|
-
const templateFilePath = path.resolve(currentDirname(),
|
|
25
|
+
export const compileTemplate = (templateFile) => {
|
|
26
|
+
const templateFilePath = path.resolve(currentDirname(), templateFile);
|
|
27
27
|
return handlebars.compile(fs.readFileSync(templateFilePath, 'utf8'));
|
|
28
28
|
};
|
|
29
29
|
// TODO add more reserved words
|
|
@@ -33,3 +33,31 @@ const TS_RESERVED_WORDS = ['new', 'class'];
|
|
|
33
33
|
* @param word
|
|
34
34
|
*/
|
|
35
35
|
export const isReservedWord = (word) => TS_RESERVED_WORDS.includes(word);
|
|
36
|
+
const TS_PRIMITIVE_TYPES = [
|
|
37
|
+
'void',
|
|
38
|
+
'undefined',
|
|
39
|
+
'null',
|
|
40
|
+
'number',
|
|
41
|
+
'boolean',
|
|
42
|
+
'bigint',
|
|
43
|
+
'Map',
|
|
44
|
+
'Set',
|
|
45
|
+
'string',
|
|
46
|
+
'any',
|
|
47
|
+
'Array',
|
|
48
|
+
'Record',
|
|
49
|
+
];
|
|
50
|
+
/**
|
|
51
|
+
* Check if a type is native JS/TS type
|
|
52
|
+
* @param type
|
|
53
|
+
*/
|
|
54
|
+
export const isNativeType = (type) => {
|
|
55
|
+
return TS_PRIMITIVE_TYPES.some((one) => {
|
|
56
|
+
if (typeof one === 'string') {
|
|
57
|
+
return one === type;
|
|
58
|
+
}
|
|
59
|
+
else {
|
|
60
|
+
return type.match(one);
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
};
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const index_1 = require("./index");
|
|
7
|
-
const static_substrate_1 = require("@polkadot/types-support/metadata/static-substrate");
|
|
8
|
-
const substrate_hex_1 = __importDefault(require("@polkadot/types-support/metadata/v15/substrate-hex"));
|
|
9
|
-
const codecs_1 = require("@dedot/codecs");
|
|
10
|
-
const dedot_1 = require("dedot");
|
|
11
|
-
const NETWORKS = [
|
|
12
|
-
{
|
|
13
|
-
chain: 'substrate',
|
|
14
|
-
metadataHex: substrate_hex_1.default,
|
|
15
|
-
rpcMethods: static_substrate_1.rpc.methods,
|
|
16
|
-
},
|
|
17
|
-
{
|
|
18
|
-
chain: 'polkadot',
|
|
19
|
-
endpoint: 'wss://rpc.polkadot.io',
|
|
20
|
-
},
|
|
21
|
-
{
|
|
22
|
-
chain: 'kusama',
|
|
23
|
-
endpoint: 'wss://kusama-rpc.polkadot.io',
|
|
24
|
-
},
|
|
25
|
-
{
|
|
26
|
-
chain: 'astar',
|
|
27
|
-
endpoint: 'wss://rpc.astar.network',
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
chain: 'moonbeam',
|
|
31
|
-
endpoint: 'wss://moonbeam.api.onfinality.io/public-ws',
|
|
32
|
-
},
|
|
33
|
-
{
|
|
34
|
-
chain: 'polkadotAssetHub',
|
|
35
|
-
endpoint: 'wss://polkadot-asset-hub-rpc.polkadot.io/',
|
|
36
|
-
},
|
|
37
|
-
{
|
|
38
|
-
chain: 'kusamaAssetHub',
|
|
39
|
-
endpoint: 'wss://kusama-asset-hub-rpc.polkadot.io/',
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
chain: 'rococo',
|
|
43
|
-
endpoint: 'wss://rococo-rpc.polkadot.io/',
|
|
44
|
-
},
|
|
45
|
-
{
|
|
46
|
-
chain: 'rococoAssetHub',
|
|
47
|
-
endpoint: 'wss://rococo-asset-hub-rpc.polkadot.io/',
|
|
48
|
-
},
|
|
49
|
-
{
|
|
50
|
-
chain: 'aleph',
|
|
51
|
-
endpoint: 'wss://aleph-zero.api.onfinality.io/public-ws',
|
|
52
|
-
},
|
|
53
|
-
{
|
|
54
|
-
chain: 'westendAssetHub',
|
|
55
|
-
endpoint: 'wss://westend-asset-hub-rpc.polkadot.io',
|
|
56
|
-
},
|
|
57
|
-
];
|
|
58
|
-
const OUT_DIR = 'packages/chaintypes/src';
|
|
59
|
-
async function run() {
|
|
60
|
-
for (const network of NETWORKS) {
|
|
61
|
-
const { chain, endpoint, metadataHex, rpcMethods } = network;
|
|
62
|
-
if (endpoint) {
|
|
63
|
-
console.log(`Generate types for ${chain} via endpoint ${endpoint}`);
|
|
64
|
-
await (0, index_1.generateTypesFromChain)(network, endpoint, OUT_DIR);
|
|
65
|
-
}
|
|
66
|
-
else if (metadataHex && rpcMethods) {
|
|
67
|
-
console.log(`Generate types for ${chain} via raw data`);
|
|
68
|
-
const metadata = codecs_1.$Metadata.tryDecode(metadataHex);
|
|
69
|
-
const runtimeVersion = getRuntimeVersion(metadata);
|
|
70
|
-
await (0, index_1.generateTypes)(network, metadata.latest, rpcMethods, runtimeVersion.apis, OUT_DIR);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
console.log('DONE!');
|
|
74
|
-
}
|
|
75
|
-
const getRuntimeVersion = (metadata) => {
|
|
76
|
-
const registry = new codecs_1.PortableRegistry(metadata.latest);
|
|
77
|
-
const executor = new dedot_1.ConstantExecutor({
|
|
78
|
-
registry,
|
|
79
|
-
metadataLatest: metadata.latest,
|
|
80
|
-
});
|
|
81
|
-
return executor.execute('system', 'version');
|
|
82
|
-
};
|
|
83
|
-
run().catch(console.log);
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ErrorsGen = void 0;
|
|
4
|
-
const ApiGen_1 = require("./ApiGen");
|
|
5
|
-
const utils_1 = require("./utils");
|
|
6
|
-
const util_1 = require("@polkadot/util");
|
|
7
|
-
const utils_2 = require("@dedot/utils");
|
|
8
|
-
class ErrorsGen extends ApiGen_1.ApiGen {
|
|
9
|
-
generate() {
|
|
10
|
-
const { pallets } = this.metadata;
|
|
11
|
-
this.typesGen.clearCache();
|
|
12
|
-
this.typesGen.typeImports.addKnownType('GenericChainErrors', 'GenericPalletError');
|
|
13
|
-
let defTypeOut = '';
|
|
14
|
-
for (let pallet of pallets) {
|
|
15
|
-
const errorTypeId = pallet.error;
|
|
16
|
-
if (!errorTypeId) {
|
|
17
|
-
continue;
|
|
18
|
-
}
|
|
19
|
-
const errorDefs = this.#getErrorDefs(errorTypeId);
|
|
20
|
-
defTypeOut += (0, utils_1.commentBlock)(`Pallet \`${pallet.name}\`'s errors`);
|
|
21
|
-
defTypeOut += `${(0, util_1.stringCamelCase)(pallet.name)}: {
|
|
22
|
-
${errorDefs
|
|
23
|
-
.map(({ name, docs }) => `${(0, utils_1.commentBlock)(docs)}${(0, util_1.stringPascalCase)(name)}: GenericPalletError`)
|
|
24
|
-
.join(',\n')}
|
|
25
|
-
|
|
26
|
-
${(0, utils_1.commentBlock)('Generic pallet error')}[error: string]: GenericPalletError,
|
|
27
|
-
},`;
|
|
28
|
-
}
|
|
29
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
30
|
-
const template = (0, utils_1.compileTemplate)('errors.hbs');
|
|
31
|
-
return (0, utils_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
32
|
-
}
|
|
33
|
-
#getErrorDefs(errorTypeId) {
|
|
34
|
-
const def = this.metadata.types[errorTypeId];
|
|
35
|
-
(0, utils_2.assert)(def, `Error def not found for id ${errorTypeId}`);
|
|
36
|
-
const { tag, value } = def.type;
|
|
37
|
-
(0, utils_2.assert)(tag === 'Enum', `Invalid pallet error type!`);
|
|
38
|
-
return value.members;
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
exports.ErrorsGen = ErrorsGen;
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.IndexGen = void 0;
|
|
4
|
-
const utils_1 = require("./utils");
|
|
5
|
-
const util_1 = require("@polkadot/util");
|
|
6
|
-
class IndexGen {
|
|
7
|
-
networkInfo;
|
|
8
|
-
constructor(networkInfo) {
|
|
9
|
-
this.networkInfo = networkInfo;
|
|
10
|
-
}
|
|
11
|
-
async generate() {
|
|
12
|
-
const { chain } = this.networkInfo;
|
|
13
|
-
const interfaceName = (0, util_1.stringPascalCase)(chain);
|
|
14
|
-
const template = (0, utils_1.compileTemplate)('index.hbs');
|
|
15
|
-
return (0, utils_1.beautifySourceCode)(template({ interfaceName }));
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
exports.IndexGen = IndexGen;
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.QueryGen = void 0;
|
|
4
|
-
const util_1 = require("@polkadot/util");
|
|
5
|
-
const utils_1 = require("@dedot/utils");
|
|
6
|
-
const generator_1 = require("../generator");
|
|
7
|
-
const utils_2 = require("./utils");
|
|
8
|
-
class QueryGen extends generator_1.ApiGen {
|
|
9
|
-
generate() {
|
|
10
|
-
const { pallets } = this.metadata;
|
|
11
|
-
this.typesGen.clearCache();
|
|
12
|
-
this.typesGen.typeImports.addKnownType('GenericChainStorage', 'GenericStorageQuery', 'Callback');
|
|
13
|
-
let defTypeOut = '';
|
|
14
|
-
for (let pallet of pallets) {
|
|
15
|
-
const storage = pallet.storage;
|
|
16
|
-
if (!storage)
|
|
17
|
-
continue;
|
|
18
|
-
const queries = storage.entries.map((one) => this.#generateEntry(one));
|
|
19
|
-
const queryDefs = queries.map(({ name, valueType, keyType, docs }) => `${(0, utils_2.commentBlock)(docs)}${name}: GenericStorageQuery<(${keyType}) => ${valueType}>`);
|
|
20
|
-
defTypeOut += (0, utils_2.commentBlock)(`Pallet \`${pallet.name}\`'s storage queries`);
|
|
21
|
-
defTypeOut += `${(0, util_1.stringLowerFirst)(pallet.name)}: {
|
|
22
|
-
${queryDefs.join(',\n')}
|
|
23
|
-
|
|
24
|
-
${(0, utils_2.commentBlock)('Generic pallet storage query')}[storage: string]: GenericStorageQuery;
|
|
25
|
-
},`;
|
|
26
|
-
}
|
|
27
|
-
const importTypes = this.typesGen.typeImports.toImports();
|
|
28
|
-
const template = (0, utils_2.compileTemplate)('query.hbs');
|
|
29
|
-
return (0, utils_2.beautifySourceCode)(template({ importTypes, defTypeOut }));
|
|
30
|
-
}
|
|
31
|
-
#generateEntry(entry) {
|
|
32
|
-
const { name, type, docs, modifier } = entry;
|
|
33
|
-
let valueType, keyType;
|
|
34
|
-
if (type.tag === 'Plain') {
|
|
35
|
-
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
36
|
-
}
|
|
37
|
-
else if (type.tag === 'Map') {
|
|
38
|
-
valueType = this.typesGen.generateType(type.value.valueTypeId, 1, true);
|
|
39
|
-
keyType = this.typesGen.generateType(type.value.keyTypeId, 1);
|
|
40
|
-
}
|
|
41
|
-
else {
|
|
42
|
-
throw Error('Invalid entry type!');
|
|
43
|
-
}
|
|
44
|
-
const isOptional = modifier === 'Optional';
|
|
45
|
-
valueType = `${valueType}${isOptional ? ' | undefined' : ''}`;
|
|
46
|
-
docs.push('\n');
|
|
47
|
-
if (keyType) {
|
|
48
|
-
docs.push(`@param {${keyType}} arg`);
|
|
49
|
-
}
|
|
50
|
-
docs.push(`@param {Callback<${valueType}> =} callback`);
|
|
51
|
-
return {
|
|
52
|
-
name: (0, utils_1.normalizeName)(name),
|
|
53
|
-
valueType,
|
|
54
|
-
keyType: keyType ? `arg: ${keyType}` : '',
|
|
55
|
-
docs,
|
|
56
|
-
};
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
exports.QueryGen = QueryGen;
|