/
generate-transaction.ts
375 lines (362 loc) · 11.4 KB
/
generate-transaction.ts
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
import {
allErrorsAreRecoverable,
extractResolvedVariableBytecodeMap,
} from '../language/language.js';
import type {
AnyCompilerConfiguration,
BytecodeGenerationCompletionInput,
BytecodeGenerationCompletionOutput,
BytecodeGenerationErrorBase,
BytecodeGenerationErrorLocking,
BytecodeGenerationErrorUnlocking,
CompilationContextBCH,
CompilationData,
CompilationError,
CompilationResultParseError,
CompilationResultReduceError,
CompilationResultResolveError,
Compiler,
Input,
InputTemplate,
Output,
OutputTemplate,
TransactionGenerationAttempt,
TransactionGenerationError,
TransactionTemplateFixed,
} from '../lib.js';
const returnFailedCompilationDirective = <
Type extends 'locking' | 'unlocking',
>({
index,
result,
type,
}: {
index: number;
result:
| CompilationResultParseError
| CompilationResultReduceError<unknown>
| CompilationResultResolveError<unknown>;
type: Type;
}) => ({
errors: result.errors.map((error) => ({
...error,
error: `Failed compilation of ${type} directive at index "${index}": ${error.error}`,
})),
index,
...(result.errorType === 'parse' ? {} : { resolved: result.resolve }),
type,
});
// eslint-disable-next-line complexity
export const compileOutputTemplate = <
CompilerType extends Compiler<
unknown,
AnyCompilerConfiguration<unknown>,
unknown
>,
ProgramState,
>({
outputTemplate,
index,
}: {
outputTemplate: OutputTemplate<CompilerType>;
index: number;
}): BytecodeGenerationErrorLocking<ProgramState> | Output => {
if ('script' in outputTemplate.lockingBytecode) {
const directive = outputTemplate.lockingBytecode;
const data = directive.data ?? {};
const result = directive.compiler.generateBytecode({
data,
debug: true,
scriptId: directive.script,
});
return result.success
? {
lockingBytecode: result.bytecode,
...(outputTemplate.token === undefined
? {}
: { token: outputTemplate.token }),
valueSatoshis: outputTemplate.valueSatoshis,
}
: returnFailedCompilationDirective({ index, result, type: 'locking' });
}
return {
lockingBytecode: outputTemplate.lockingBytecode.slice(),
...(outputTemplate.token === undefined
? {}
: { token: outputTemplate.token }),
valueSatoshis: outputTemplate.valueSatoshis,
};
};
export const compileInputTemplate = <
CompilerType extends Compiler<
CompilationContext,
AnyCompilerConfiguration<CompilationContext>,
unknown
>,
ProgramState,
CompilationContext extends CompilationContextBCH = CompilationContextBCH,
>({
inputTemplate,
index,
template,
outputs,
}: {
inputTemplate: InputTemplate<CompilerType>;
index: number;
outputs: Output[];
template: TransactionTemplateFixed<CompilerType>;
}): BytecodeGenerationErrorUnlocking<ProgramState> | Input => {
if ('script' in inputTemplate.unlockingBytecode) {
const directive = inputTemplate.unlockingBytecode;
// TODO: workaround, replace by migrating to PST format
const sourceOutputs = [];
// eslint-disable-next-line functional/no-expression-statements, functional/immutable-data
sourceOutputs[index] = {
lockingBytecode: Uint8Array.of(),
...(inputTemplate.unlockingBytecode.token === undefined
? {}
: { token: inputTemplate.unlockingBytecode.token }),
valueSatoshis: inputTemplate.unlockingBytecode.valueSatoshis,
};
const result = directive.compiler.generateBytecode({
data: {
...directive.data,
compilationContext: {
inputIndex: index,
sourceOutputs,
transaction: {
inputs: template.inputs,
locktime: template.locktime,
outputs,
version: template.version,
},
} as CompilationContext,
},
debug: true,
scriptId: directive.script,
});
return result.success
? {
outpointIndex: inputTemplate.outpointIndex,
outpointTransactionHash:
inputTemplate.outpointTransactionHash.slice(),
sequenceNumber: inputTemplate.sequenceNumber,
unlockingBytecode: result.bytecode,
}
: returnFailedCompilationDirective({ index, result, type: 'unlocking' });
}
return {
outpointIndex: inputTemplate.outpointIndex,
outpointTransactionHash: inputTemplate.outpointTransactionHash.slice(),
sequenceNumber: inputTemplate.sequenceNumber,
unlockingBytecode: inputTemplate.unlockingBytecode.slice(),
};
};
/**
* Generate a `Transaction` given a `TransactionTemplate` and any applicable
* compilers and compilation data.
*
* Returns either a `Transaction` or an array of compilation errors.
*
* For each `CompilationDirective`, the `compilationContext` property will be
* automatically provided to the compiler. All other necessary `CompilationData`
* properties must be specified in the `TransactionTemplate`.
*
* @param template - the `TransactionTemplate` from which to create the
* `Transaction`
*/
export const generateTransaction = <
// eslint-disable-next-line @typescript-eslint/no-explicit-any
CompilerType extends Compiler<any, AnyCompilerConfiguration<any>, any>,
ProgramState,
>(
template: TransactionTemplateFixed<CompilerType>,
): TransactionGenerationAttempt<ProgramState> => {
const outputResults = template.outputs.map((outputTemplate, index) =>
compileOutputTemplate({
index,
outputTemplate,
}),
);
const outputCompilationErrors = outputResults.filter(
(result): result is BytecodeGenerationErrorLocking<ProgramState> =>
'errors' in result,
);
if (outputCompilationErrors.length > 0) {
const outputCompletions = outputResults
.map<
| BytecodeGenerationCompletionOutput
| BytecodeGenerationErrorLocking<ProgramState>
>((result, index) =>
'lockingBytecode' in result
? { index, output: result, type: 'output' }
: result,
)
.filter(
(result): result is BytecodeGenerationCompletionOutput =>
'output' in result,
);
return {
completions: outputCompletions,
errors: outputCompilationErrors,
stage: 'outputs',
success: false,
};
}
const outputs = outputResults as Output[];
const inputResults = template.inputs.map((inputTemplate, index) =>
compileInputTemplate({
index,
inputTemplate,
outputs,
template,
}),
);
const inputCompilationErrors = inputResults.filter(
(result): result is BytecodeGenerationErrorUnlocking<ProgramState> =>
'errors' in result,
);
if (inputCompilationErrors.length > 0) {
const inputCompletions = inputResults
.map<
| BytecodeGenerationCompletionInput
| BytecodeGenerationErrorUnlocking<ProgramState>
>((result, index) =>
'unlockingBytecode' in result
? { index, input: result, type: 'input' }
: result,
)
.filter(
(result): result is BytecodeGenerationCompletionInput =>
'input' in result,
);
return {
completions: inputCompletions,
errors: inputCompilationErrors,
stage: 'inputs',
success: false,
};
}
const inputs = inputResults as Input[];
return {
success: true,
transaction: {
inputs,
locktime: template.locktime,
outputs,
version: template.version,
},
};
};
/**
* TODO: fundamentally unsound, migrate to PST format
*
* Extract a map of successfully resolved variables to their resolved bytecode.
*
* @param transactionGenerationError - a transaction generation attempt where
* `success` is `false`
*/
export const extractResolvedVariables = <ProgramState>(
transactionGenerationError: TransactionGenerationError<ProgramState>,
) =>
(
transactionGenerationError.errors as BytecodeGenerationErrorBase<ProgramState>[]
).reduce<{
[fullIdentifier: string]: Uint8Array;
}>(
(all, error) =>
error.resolved === undefined
? all
: { ...all, ...extractResolvedVariableBytecodeMap(error.resolved) },
{},
);
/**
* TODO: fundamentally unsound, migrate to PST format
*
* Given an unsuccessful transaction generation result, extract a map of the
* identifiers missing from the compilation mapped to the entity that owns each
* variable.
*
* Returns `false` if any errors are fatal (the error either cannot be resolved
* by providing a variable, or the entity ownership of the required variable was
* not provided in the compilation data).
*
* @param transactionGenerationError - a transaction generation result where
* `success` is `false`
*/
export const extractMissingVariables = <ProgramState>(
transactionGenerationError: TransactionGenerationError<ProgramState>,
) => {
const allErrors = (
transactionGenerationError.errors as BytecodeGenerationErrorBase<ProgramState>[]
).reduce<CompilationError[]>((all, error) => [...all, ...error.errors], []);
if (!allErrorsAreRecoverable(allErrors)) {
return false;
}
return allErrors.reduce<{ [fullIdentifier: string]: string }>(
(all, error) => ({
...all,
[error.missingIdentifier]: error.owningEntity,
}),
{},
);
};
/**
* TODO: fundamentally unsound, migrate to PST format
*
* Safely extend a compilation data with resolutions provided by other entities
* (via `extractResolvedVariables`).
*
* It is security-critical that compilation data only be extended with expected
* identifiers from the proper owning entity of each variable. See
* `CompilationData.bytecode` for details.
*
* Returns `false` if any errors are fatal (the error either cannot be resolved
* by providing a variable, or the entity ownership of the required variable was
* not provided in the compilation data).
*
* @remarks
* To determine which identifiers are required by a given compilation, the
* compilation is first attempted with only trusted variables: variables owned
* or previously verified (like `WalletData`) by the compiling entity. If this
* compilation produces a `TransactionGenerationError`, the error can be
* provided to `safelyExtendCompilationData`, along with the trusted compilation
* data and a mapping of untrusted resolutions (where the result of
* `extractResolvedVariables` is assigned to the entity ID of the entity from
* which they were received).
*
* The first compilation must use only trusted compilation data
*/
export const safelyExtendCompilationData = <
ProgramState,
CompilationContext = CompilationContextBCH,
>(
transactionGenerationError: TransactionGenerationError<ProgramState>,
trustedCompilationData: CompilationData<CompilationContext>,
untrustedResolutions: {
[providedByEntityId: string]: ReturnType<typeof extractResolvedVariables>;
},
): CompilationData<CompilationContext> | false => {
const missing = extractMissingVariables(transactionGenerationError);
if (missing === false) return false;
const selectedResolutions = Object.entries(missing).reduce<{
[fullIdentifier: string]: Uint8Array;
}>((all, [identifier, entityId]) => {
const entityResolution = untrustedResolutions[entityId];
if (entityResolution === undefined) {
return all;
}
const resolution = entityResolution[identifier];
if (resolution === undefined) {
return all;
}
return { ...all, [identifier]: resolution };
}, {});
return {
...trustedCompilationData,
bytecode: {
...selectedResolutions,
...trustedCompilationData.bytecode,
},
};
};