-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
script-request.ts
265 lines (241 loc) · 7.77 KB
/
script-request.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
/* eslint-disable @typescript-eslint/no-explicit-any */
import {
ASSET_ID_LEN,
CONTRACT_ID_LEN,
SCRIPT_FIXED_SIZE,
WORD_SIZE,
calculateVmTxMemory,
} from '@fuel-ts/abi-coder';
import type {
TransactionResultReturnDataReceipt,
TransactionResultRevertReceipt,
CallResult,
TransactionResultReceipt,
TransactionResultReturnReceipt,
TransactionResultScriptResultReceipt,
DryRunFailureStatusFragment,
} from '@fuel-ts/account';
import { extractTxError } from '@fuel-ts/account';
import { ErrorCode, FuelError } from '@fuel-ts/errors';
import type { BytesLike } from '@fuel-ts/interfaces';
import type { BN } from '@fuel-ts/math';
import type { ReceiptScriptResult } from '@fuel-ts/transactions';
import { ReceiptType } from '@fuel-ts/transactions';
import { arrayify } from '@fuel-ts/utils';
import type { CallConfig } from './types';
export const calculateScriptDataBaseOffset = (maxInputs: number) =>
SCRIPT_FIXED_SIZE + calculateVmTxMemory({ maxInputs });
export const POINTER_DATA_OFFSET =
WORD_SIZE + ASSET_ID_LEN + CONTRACT_ID_LEN + WORD_SIZE + WORD_SIZE;
/**
* Represents a script result, containing information about the script execution.
*/
export type ScriptResult = {
code: BN;
gasUsed: BN;
receipts: TransactionResultReceipt[];
scriptResultReceipt: TransactionResultScriptResultReceipt;
returnReceipt:
| TransactionResultReturnReceipt
| TransactionResultReturnDataReceipt
| TransactionResultRevertReceipt;
callResult: CallResult;
};
/**
* Converts a CallResult to a ScriptResult by extracting relevant information.
*
* @param callResult - The CallResult from the script call.
* @returns The converted ScriptResult.
*/
function callResultToScriptResult(callResult: CallResult): ScriptResult {
const receipts = [...callResult.receipts];
let scriptResultReceipt: ReceiptScriptResult | undefined;
let returnReceipt:
| TransactionResultReturnReceipt
| TransactionResultReturnDataReceipt
| TransactionResultRevertReceipt
| undefined;
receipts.forEach((receipt) => {
if (receipt.type === ReceiptType.ScriptResult) {
scriptResultReceipt = receipt;
} else if (
receipt.type === ReceiptType.Return ||
receipt.type === ReceiptType.ReturnData ||
receipt.type === ReceiptType.Revert
) {
returnReceipt = receipt;
}
});
if (!scriptResultReceipt || !returnReceipt) {
throw new FuelError(ErrorCode.SCRIPT_REVERTED, `Transaction reverted.`);
}
const scriptResult: ScriptResult = {
code: scriptResultReceipt.result,
gasUsed: scriptResultReceipt.gasUsed,
receipts,
scriptResultReceipt,
returnReceipt,
callResult,
};
return scriptResult;
}
/**
* Decodes a CallResult using the provided decoder function.
*
* @param callResult - The CallResult to decode.
* @param decoder - The decoding function to apply on the ScriptResult.
* @param logs - Optional logs associated with the decoding.
* @returns The decoded result.
* @throws Throws an error if decoding fails.
*/
export function decodeCallResult<TResult>(
callResult: CallResult,
decoder: (scriptResult: ScriptResult) => TResult,
logs: Array<any> = []
): TResult {
try {
const scriptResult = callResultToScriptResult(callResult);
return decoder(scriptResult);
} catch (error) {
if ((<FuelError>error).code === ErrorCode.SCRIPT_REVERTED) {
const statusReason = (<DryRunFailureStatusFragment>callResult?.dryRunStatus)?.reason;
throw extractTxError({
logs,
receipts: callResult.receipts,
statusReason,
});
}
throw error;
}
}
/**
* Converts a CallResult to an invocation result based on the provided call configuration.
*
* @param callResult - The CallResult from the script call.
* @param call - The call configuration.
* @param logs - Optional logs associated with the decoding.
* @returns The decoded invocation result.
*/
export function callResultToInvocationResult<TReturn>(
callResult: CallResult,
call: CallConfig,
logs?: unknown[]
): TReturn {
return decodeCallResult(
callResult,
(scriptResult: ScriptResult) => {
if (scriptResult.returnReceipt.type === ReceiptType.Revert) {
throw new FuelError(
ErrorCode.SCRIPT_REVERTED,
`Script Reverted. Logs: ${JSON.stringify(logs)}`
);
}
if (
scriptResult.returnReceipt.type !== ReceiptType.Return &&
scriptResult.returnReceipt.type !== ReceiptType.ReturnData
) {
const { type } = scriptResult.returnReceipt;
throw new FuelError(
ErrorCode.SCRIPT_REVERTED,
`Script Return Type [${type}] Invalid. Logs: ${JSON.stringify({
logs,
receipt: scriptResult.returnReceipt,
})}`
);
}
let value;
if (scriptResult.returnReceipt.type === ReceiptType.Return) {
value = scriptResult.returnReceipt.val;
}
if (scriptResult.returnReceipt.type === ReceiptType.ReturnData) {
const decoded = call.func.decodeOutput(scriptResult.returnReceipt.data);
value = decoded[0];
}
return value as TReturn;
},
logs
);
}
export type EncodedScriptCall = Uint8Array | { data: Uint8Array; script: Uint8Array };
/**
* `ScriptRequest` provides functionality to encode and decode script data and results.
*
* @template TData - Type of the script data.
* @template TResult - Type of the script result.
*/
export class ScriptRequest<TData = void, TResult = void> {
/**
* The bytes of the script.
*/
bytes: Uint8Array;
/**
* A function to encode the script data.
*/
scriptDataEncoder: (data: TData) => EncodedScriptCall;
/**
* A function to decode the script result.
*/
scriptResultDecoder: (scriptResult: ScriptResult) => TResult;
/**
* Creates an instance of the ScriptRequest class.
*
* @param bytes - The bytes of the script.
* @param scriptDataEncoder - The script data encoder function.
* @param scriptResultDecoder - The script result decoder function.
*/
constructor(
bytes: BytesLike,
scriptDataEncoder: (data: TData) => EncodedScriptCall,
scriptResultDecoder: (scriptResult: ScriptResult) => TResult
) {
this.bytes = arrayify(bytes);
this.scriptDataEncoder = scriptDataEncoder;
this.scriptResultDecoder = scriptResultDecoder;
}
/**
* Gets the script data offset for the given bytes.
*
* @param byteLength - The byte length of the script.
* @param maxInputs - The maxInputs value from the chain's consensus params.
* @returns The script data offset.
*/
static getScriptDataOffsetWithScriptBytes(byteLength: number, maxInputs: number): number {
const scriptDataBaseOffset = calculateVmTxMemory({ maxInputs }) + SCRIPT_FIXED_SIZE;
return scriptDataBaseOffset + byteLength;
}
/**
* Gets the script data offset.
*
* @param maxInputs - The maxInputs value from the chain's consensus params.
* @returns The script data offset.
*/
getScriptDataOffset(maxInputs: number) {
return ScriptRequest.getScriptDataOffsetWithScriptBytes(this.bytes.length, maxInputs);
}
/**
* Encodes the data for a script call.
*
* @param data - The script data.
* @returns The encoded data.
*/
encodeScriptData(data: TData): Uint8Array {
const callScript = this.scriptDataEncoder(data);
// if Uint8Array
if (ArrayBuffer.isView(callScript)) {
return callScript;
}
// object
this.bytes = arrayify(callScript.script);
return callScript.data;
}
/**
* Decodes the result of a script call.
*
* @param callResult - The CallResult from the script call.
* @param logs - Optional logs associated with the decoding.
* @returns The decoded result.
*/
decodeCallResult(callResult: CallResult, logs: Array<any> = []): TResult {
return decodeCallResult(callResult, this.scriptResultDecoder, logs);
}
}