-
Notifications
You must be signed in to change notification settings - Fork 346
Expand file tree
/
Copy pathclient.ts
More file actions
192 lines (166 loc) · 5.29 KB
/
client.ts
File metadata and controls
192 lines (166 loc) · 5.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
import { xdr } from "@stellar/stellar-base";
import { Spec } from "../contract";
import {
parseTypeFromTypeDef,
generateTypeImports,
sanitizeIdentifier,
formatJSDocComment,
formatImports,
} from "./utils";
/**
* Generates TypeScript client class for contract methods
*/
export class ClientGenerator {
private spec: Spec;
constructor(spec: Spec) {
this.spec = spec;
}
/**
* Generate client class
*/
generate(): string {
// Generate constructor method if it exists
let deployMethod = "";
try {
const constructorFunc = this.spec.getFunc("__constructor");
deployMethod = this.generateDeployMethod(constructorFunc);
} catch {
// For specs without a constructor, generate a deploy method without params
deployMethod = this.generateDeployMethod(undefined);
}
// Generate interface methods
const interfaceMethods = this.spec
.funcs()
.filter((func) => func.name().toString() !== "__constructor")
.map((func) => this.generateInterfaceMethod(func))
.join("\n");
const imports = this.generateImports();
const specEntries = this.spec.entries.map(
(entry) => `"${entry.toXDR("base64")}"`,
);
const fromJSON = this.spec
.funcs()
.filter((func) => func.name().toString() !== "__constructor")
.map((func) => this.generateFromJSONMethod(func))
.join(",");
return `${imports}
export interface Client {
${interfaceMethods}
}
export class Client extends ContractClient {
constructor(public readonly options: ContractClientOptions) {
super(
new Spec([${specEntries.join(", ")}]),
options
);
}
${deployMethod}
public readonly fromJSON = {
${fromJSON}
};
}`;
}
private generateImports(): string {
const imports = generateTypeImports(
this.spec.funcs().flatMap((func) => {
const inputs = func.inputs();
const outputs = func.outputs();
const defs = inputs.map((input) => input.type()).concat(outputs);
return defs;
}),
);
return formatImports(imports, {
includeTypeFileImports: true, // Client imports types
additionalStellarContractImports: [
"Spec",
"AssembledTransaction",
"Client as ContractClient",
"ClientOptions as ContractClientOptions",
"MethodOptions",
],
});
}
/**
* Generate interface method signature
*/
private generateInterfaceMethod(func: xdr.ScSpecFunctionV0): string {
const name = sanitizeIdentifier(func.name().toString());
const inputs = func.inputs().map((input: any) => ({
name: input.name().toString(),
type: parseTypeFromTypeDef(input.type(), true),
}));
const outputType =
func.outputs().length > 0
? parseTypeFromTypeDef(func.outputs()[0])
: "void";
const docs = formatJSDocComment(func.doc().toString(), 2);
const params = this.formatMethodParameters(inputs);
return `${docs} ${name}(${params}): Promise<AssembledTransaction<${outputType}>>;`;
}
private generateFromJSONMethod(func: xdr.ScSpecFunctionV0): string {
const name = func.name().toString();
const outputType =
func.outputs().length > 0
? parseTypeFromTypeDef(func.outputs()[0])
: "void";
return ` ${name} : this.txFromJSON<${outputType}>`;
}
/**
* Generate deploy method
*/
private generateDeployMethod(
constructorFunc: xdr.ScSpecFunctionV0 | undefined,
): string {
// If no constructor, generate deploy with no params
if (!constructorFunc) {
const params = this.formatConstructorParameters([]);
return ` static deploy<T = Client>(${params}): Promise<AssembledTransaction<T>> {
return ContractClient.deploy(null, options);
}`;
}
const inputs = constructorFunc.inputs().map((input) => ({
name: input.name().toString(),
type: parseTypeFromTypeDef(input.type(), true),
}));
const params = this.formatConstructorParameters(inputs);
const inputsDestructure =
inputs.length > 0 ? `{ ${inputs.map((i) => i.name).join(", ")} }, ` : "";
return ` static deploy<T = Client>(${params}): Promise<AssembledTransaction<T>> {
return ContractClient.deploy(${inputsDestructure}options);
}`;
}
/**
* Format method parameters
*/
private formatMethodParameters(
inputs: Array<{ name: string; type: string }>,
): string {
const params: string[] = [];
if (inputs.length > 0) {
const inputsParam = `{ ${inputs.map((i) => `${i.name}: ${i.type}`).join("; ")} }`;
params.push(
`{ ${inputs.map((i) => i.name).join(", ")} }: ${inputsParam}`,
);
}
params.push("options?: MethodOptions");
return params.join(", ");
}
/**
* Format constructor parameters
*/
private formatConstructorParameters(
inputs: Array<{ name: string; type: string }>,
): string {
const params: string[] = [];
if (inputs.length > 0) {
const inputsParam = `{ ${inputs.map((i) => `${i.name}: ${i.type}`).join("; ")} }`;
params.push(
`{ ${inputs.map((i) => i.name).join(", ")} }: ${inputsParam}`,
);
}
params.push(
'options: MethodOptions & Omit<ContractClientOptions, \'contractId\'> & { wasmHash: Buffer | string; salt?: Buffer | Uint8Array; format?: "hex" | "base64"; address?: string; }',
);
return params.join(", ");
}
}