-
Notifications
You must be signed in to change notification settings - Fork 12
/
FunctionCallAnalyzer.ts
381 lines (346 loc) · 15.1 KB
/
FunctionCallAnalyzer.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
376
377
378
379
380
381
/*-
*
* Hedera Mirror Node Explorer
*
* Copyright (C) 2021 - 2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import {computed, ComputedRef, ref, Ref, shallowRef, watch, WatchStopHandle} from "vue";
import {ethers} from "ethers";
import {labelForResponseCode} from "@/schemas/HederaUtils";
import {ContractAnalyzer} from "@/utils/analyzer/ContractAnalyzer";
import {SignatureCache, SignatureRecord, SignatureResponse} from "@/utils/cache/SignatureCache";
export class FunctionCallAnalyzer {
public readonly input: Ref<string|null>
public readonly output: Ref<string|null>
public readonly error: Ref<string|null>
private readonly contractAnalyzer: ContractAnalyzer
private readonly signatureResponse = shallowRef<SignatureResponse|null>(null)
private readonly functionFragment = shallowRef<ethers.FunctionFragment|null>(null)
private readonly is4byteFunctionFragment = ref<boolean>(false)
private readonly functionDecodingFailure = shallowRef<unknown>(null)
private readonly inputResult = shallowRef<ethers.Result|null>(null)
private readonly inputDecodingFailure = shallowRef<unknown>(null)
private readonly outputResult = shallowRef<ethers.Result|null>(null)
private readonly outputDecodingFailure = shallowRef<unknown>(null)
private readonly errorDescription = shallowRef<ethers.ErrorDescription|null>(null)
private readonly errorDecodingFailure = shallowRef<unknown>(null)
private readonly watchHandle: Ref<WatchStopHandle[]> = ref([])
//
// Public
//
public constructor(input: Ref<string|null>, output: Ref<string|null>, error: Ref<string|null>, contractId: Ref<string|null>) {
this.input = input
this.output = output
this.error = error
this.contractAnalyzer = new ContractAnalyzer(contractId)
}
public mount(): void {
this.watchHandle.value = [
watch([this.functionHash], this.updateSignatureResponse, {immediate: true}),
watch([this.functionHash, this.contractAnalyzer.interface, this.signatureResponse, this.input], this.updateFunctionFragment, { immediate: true}),
watch([this.input, this.functionFragment], this.updateInputResult, { immediate: true}),
watch([this.output, this.functionFragment], this.updateOutputResult, { immediate: true}),
watch([this.error, this.contractAnalyzer.interface], this.updateErrorDescription, { immediate: true})
]
this.contractAnalyzer.mount()
}
public unmount(): void {
this.contractAnalyzer.unmount()
for (const wh of this.watchHandle.value) {
wh()
}
this.watchHandle.value = []
this.signatureResponse.value = null
this.functionFragment.value = null
this.functionDecodingFailure.value = null
this.inputResult.value = null
this.inputDecodingFailure.value = null
this.outputResult.value = null
this.outputDecodingFailure.value = null
this.errorDescription.value = null
this.errorDecodingFailure.value = null
}
public readonly normalizedInput: ComputedRef<string|null> = computed(() => {
return this.input.value == "0x" ? null : this.input.value
})
public readonly normalizedOutput: ComputedRef<string|null> = computed(() => {
return this.output.value == "0x" ? null : this.output.value
})
public readonly normalizedError: ComputedRef<string|null> = computed(() => {
return this.error.value == "0x" ? null : this.error.value
})
public readonly functionHash: ComputedRef<string|null> = computed(() => {
const input = this.normalizedInput.value
return input !== null ? input.slice(0, 10) : null
})
public readonly signature: ComputedRef<string|null> = computed(() => {
return this.functionFragment.value?.format() ?? null
})
public readonly is4byteSignature: ComputedRef<boolean> = computed(() => {
return this.is4byteFunctionFragment.value
})
public readonly errorSignature: ComputedRef<string|null> = computed(() => {
return this.errorDescription.value?.signature ?? null
})
public readonly errorHash: ComputedRef<string|null> = computed(() => {
return this.errorDescription.value?.selector ?? null
})
public readonly inputs: ComputedRef<NameTypeValue[]> = computed(() => {
const result: NameTypeValue[] = []
if (this.functionFragment.value !== null && this.inputResult.value !== null) {
const results = this.inputResult.value
const fragmentInputs = this.functionFragment.value.inputs
for (let i = 0, count = results.length; i < count; i += 1) {
const value = results[i]
const name = i < fragmentInputs.length ? fragmentInputs[i].name : "?"
const type = i < fragmentInputs.length ? fragmentInputs[i].type : "?"
result.push(new NameTypeValue(name, type, value, null, null))
}
}
return result
})
public readonly outputs: ComputedRef<NameTypeValue[]> = computed(() => {
const result: NameTypeValue[] = []
if (this.functionFragment.value !== null && this.outputResult.value !== null) {
const results = this.outputResult.value
const fragmentOutputs = this.functionFragment.value.outputs
for (let i = 0, count = results.length; i < count; i += 1) {
const value = results[i]
const name = i < fragmentOutputs.length ? fragmentOutputs[i].name : "?"
const type = i < fragmentOutputs.length ? fragmentOutputs[i].type : "?"
const comment = i < fragmentOutputs.length ? this.makeComment(value, fragmentOutputs[i]) : null
result.push(new NameTypeValue(name, type, value, null, comment))
}
}
return result
})
public readonly errorInputs: ComputedRef<NameTypeValue[]> = computed(() => {
const result: NameTypeValue[] = []
if (this.errorDescription.value !== null) {
const results = this.errorDescription.value.args
const fragmentInputs = this.errorDescription.value?.fragment.inputs ?? []
for (let i = 0, count = results.length; i < count; i += 1) {
const value = results[i]
const name = i < fragmentInputs.length ? fragmentInputs[i].name : "?"
const type = i < fragmentInputs.length ? fragmentInputs[i].type : "?"
result.push(new NameTypeValue(name, type, value, null, null))
}
}
return result
})
public readonly functionDecodingStatus = computed(() => {
let result: string|null
if (this.functionDecodingFailure.value !== null) {
result = this.makeDecodingErrorMessage(this.functionDecodingFailure.value)
} else {
result = null
}
return result
})
public readonly inputDecodingStatus = computed(() => {
let result: string|null
if (this.inputDecodingFailure.value !== null) {
result = this.makeDecodingErrorMessage(this.inputDecodingFailure.value)
} else {
result = null
}
return result
})
public readonly outputDecodingStatus = computed(() => {
let result: string|null
if (this.outputDecodingFailure.value !== null) {
result = this.makeDecodingErrorMessage(this.outputDecodingFailure.value)
} else {
result = null
}
return result
})
public readonly errorDecodingStatus = computed(() => {
let result: string|null
if (this.errorDecodingFailure.value !== null) {
result = this.makeDecodingErrorMessage(this.errorDecodingFailure.value)
} else {
result = null
}
return result
})
public readonly inputArgsOnly = computed(() => {
let result: string|null
if (this.normalizedInput.value !== null) {
result = "0x" + this.normalizedInput.value.slice(10) // "0x" + 2x4 bytes
} else {
result = null
}
return result
})
//
// Private
//
private makeDecodingErrorMessage(failure: unknown): string {
const f = failure as ethers.EthersError
return "Decoding Error (" + f.shortMessage + ")"
}
private readonly updateSignatureResponse = async () => {
if (this.functionHash.value !== null) {
try {
this.signatureResponse.value = await SignatureCache.instance.lookup(this.functionHash.value)
} catch {
this.signatureResponse.value = null
}
} else {
this.signatureResponse.value = null
}
}
private readonly updateFunctionFragment = async () => {
const i = this.contractAnalyzer.interface.value
const r = this.signatureResponse.value
const functionHash = this.functionHash.value
if (functionHash !== null) {
if (i !== null) {
try {
this.functionFragment.value = i.getFunction(functionHash)
this.functionDecodingFailure.value = null
this.is4byteFunctionFragment.value = false
} catch(failure) {
this.functionFragment.value = null
this.functionDecodingFailure.value = failure
this.is4byteFunctionFragment.value = false
}
} else if (r !== null && r.results.length >= 1) {
let r0: SignatureRecord|null
if (r.results.length == 1) {
r0 = r.results[0]
} else {
// Mmmm ... we have multiple signatures for this selector … :(
// We take the first one which enables to decode input… if we have input … :/
if (this.inputArgsOnly.value !== null) {
r0 = FunctionCallAnalyzer.resolveSignatureCollisions(r.results, this.inputArgsOnly.value)
} else {
r0 = null // We'll see later when this.input.value is available
}
}
if (r0 !== null) {
this.functionFragment.value = ethers.FunctionFragment.from(r0.text_signature)
this.functionDecodingFailure.value = null
this.is4byteFunctionFragment.value = true
} else {
this.functionFragment.value = null
this.functionDecodingFailure.value = null
this.is4byteFunctionFragment.value = false
}
} else {
this.functionFragment.value = null
this.functionDecodingFailure.value = null
this.is4byteFunctionFragment.value = false
}
} else {
this.functionFragment.value = null
this.functionDecodingFailure.value = null
this.is4byteFunctionFragment.value = false
}
}
private readonly updateInputResult = () => {
const ff = this.functionFragment.value
const inputArgs = this.inputArgsOnly.value
if (ff !== null && inputArgs !== null) {
try {
this.inputResult.value = ethers.AbiCoder.defaultAbiCoder().decode(ff.inputs, inputArgs)
this.inputDecodingFailure.value = null
} catch(failure) {
this.inputResult.value = null
this.inputDecodingFailure.value = failure
}
} else {
this.inputResult.value = null
this.inputDecodingFailure.value = null
}
}
private readonly updateOutputResult = () => {
const ff = this.functionFragment.value
const output = this.normalizedOutput.value
if (ff !== null && output !== null) {
try {
this.outputResult.value = ethers.AbiCoder.defaultAbiCoder().decode(ff.outputs, output)
this.outputDecodingFailure.value = null
} catch(failure) {
this.outputResult.value = null
this.outputDecodingFailure.value = failure
}
} else {
this.outputResult.value = null
this.outputDecodingFailure.value = null
}
}
private readonly updateErrorDescription = async() => {
const i = this.contractAnalyzer.interface.value
const error = this.normalizedError.value
if (i !== null && error !== null && error !== "0x") {
try {
this.errorDescription.value = i.parseError(error)
this.errorDecodingFailure.value = null
} catch(failure) {
this.errorDescription.value = null
this.errorDecodingFailure.value = failure
}
} else {
this.errorDescription.value = null
this.errorDecodingFailure.value = null
}
}
private static resolveSignatureCollisions(records: SignatureRecord[], inputArgs: string): SignatureRecord|null {
//
// Some selectors (like 0x70a08231) have multiple signatures registered on 4bytes.directory.
// We select the first signature which enables to decode inputArgs.
//
let result: SignatureRecord|null = null
for (const r of records) {
try {
const ff = ethers.FunctionFragment.from(r.text_signature)
const decodedArgs = ethers.AbiCoder.defaultAbiCoder().decode(ff.inputs, inputArgs)
const encodedArgs = ethers.AbiCoder.defaultAbiCoder().encode(ff.inputs, decodedArgs)
if (encodedArgs == inputArgs) {
result = r
break
}
} catch {}
}
return result
}
private makeComment(value: unknown, paramType: ethers.ParamType): string|null {
if (this.contractAnalyzer.systemContractEntry.value !== null
&& paramType.name == "responseCode"
&& typeof value == "bigint") {
// It's a responseCode from a system contract
return labelForResponseCode(value)
} else {
return null
}
}
}
export class NameTypeValue {
public readonly name: string
public readonly type: string
public readonly value: unknown
public readonly indexed: boolean | null
public readonly comment: string | null
public constructor(name: string, type: string, value: unknown, indexed: boolean|null = null, comment: string|null) {
this.name = name
this.type = type
this.value = value
this.indexed = indexed
this.comment = comment
}
}