@qevm/abi 5.7.1

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.
Files changed (83) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +52 -0
  3. package/lib/_version.d.ts +2 -0
  4. package/lib/_version.d.ts.map +1 -0
  5. package/lib/_version.js +5 -0
  6. package/lib/_version.js.map +1 -0
  7. package/lib/abi-coder.d.ts +17 -0
  8. package/lib/abi-coder.d.ts.map +1 -0
  9. package/lib/abi-coder.js +99 -0
  10. package/lib/abi-coder.js.map +1 -0
  11. package/lib/coders/abstract-coder.d.ts +53 -0
  12. package/lib/coders/abstract-coder.d.ts.map +1 -0
  13. package/lib/coders/abstract-coder.js +153 -0
  14. package/lib/coders/abstract-coder.js.map +1 -0
  15. package/lib/coders/address.d.ts +8 -0
  16. package/lib/coders/address.d.ts.map +1 -0
  17. package/lib/coders/address.js +28 -0
  18. package/lib/coders/address.js.map +1 -0
  19. package/lib/coders/anonymous.d.ts +9 -0
  20. package/lib/coders/anonymous.d.ts.map +1 -0
  21. package/lib/coders/anonymous.js +22 -0
  22. package/lib/coders/anonymous.js.map +1 -0
  23. package/lib/coders/array.d.ts +14 -0
  24. package/lib/coders/array.d.ts.map +1 -0
  25. package/lib/coders/array.js +214 -0
  26. package/lib/coders/array.js.map +1 -0
  27. package/lib/coders/boolean.d.ts +8 -0
  28. package/lib/coders/boolean.d.ts.map +1 -0
  29. package/lib/coders/boolean.js +20 -0
  30. package/lib/coders/boolean.js.map +1 -0
  31. package/lib/coders/bytes.d.ts +12 -0
  32. package/lib/coders/bytes.d.ts.map +1 -0
  33. package/lib/coders/bytes.js +33 -0
  34. package/lib/coders/bytes.js.map +1 -0
  35. package/lib/coders/fixed-bytes.d.ts +10 -0
  36. package/lib/coders/fixed-bytes.d.ts.map +1 -0
  37. package/lib/coders/fixed-bytes.js +28 -0
  38. package/lib/coders/fixed-bytes.js.map +1 -0
  39. package/lib/coders/null.d.ts +8 -0
  40. package/lib/coders/null.d.ts.map +1 -0
  41. package/lib/coders/null.js +24 -0
  42. package/lib/coders/null.js.map +1 -0
  43. package/lib/coders/number.d.ts +11 -0
  44. package/lib/coders/number.d.ts.map +1 -0
  45. package/lib/coders/number.js +45 -0
  46. package/lib/coders/number.js.map +1 -0
  47. package/lib/coders/string.d.ts +9 -0
  48. package/lib/coders/string.d.ts.map +1 -0
  49. package/lib/coders/string.js +21 -0
  50. package/lib/coders/string.js.map +1 -0
  51. package/lib/coders/tuple.d.ts +11 -0
  52. package/lib/coders/tuple.d.ts.map +1 -0
  53. package/lib/coders/tuple.js +60 -0
  54. package/lib/coders/tuple.js.map +1 -0
  55. package/lib/fragments.d.ts +85 -0
  56. package/lib/fragments.d.ts.map +1 -0
  57. package/lib/fragments.js +863 -0
  58. package/lib/fragments.js.map +1 -0
  59. package/lib/index.d.ts +5 -0
  60. package/lib/index.d.ts.map +1 -0
  61. package/lib/index.js +21 -0
  62. package/lib/index.js.map +1 -0
  63. package/lib/interface.d.ts +89 -0
  64. package/lib/interface.d.ts.map +1 -0
  65. package/lib/interface.js +617 -0
  66. package/lib/interface.js.map +1 -0
  67. package/package.json +33 -0
  68. package/src.ts/_version.ts +1 -0
  69. package/src.ts/abi-coder.ts +123 -0
  70. package/src.ts/coders/abstract-coder.ts +207 -0
  71. package/src.ts/coders/address.ts +31 -0
  72. package/src.ts/coders/anonymous.ts +25 -0
  73. package/src.ts/coders/array.ts +236 -0
  74. package/src.ts/coders/boolean.ts +23 -0
  75. package/src.ts/coders/bytes.ts +38 -0
  76. package/src.ts/coders/fixed-bytes.ts +30 -0
  77. package/src.ts/coders/null.ts +24 -0
  78. package/src.ts/coders/number.ts +57 -0
  79. package/src.ts/coders/string.ts +25 -0
  80. package/src.ts/coders/tuple.ts +61 -0
  81. package/src.ts/fragments.ts +1070 -0
  82. package/src.ts/index.ts +34 -0
  83. package/src.ts/interface.ts +715 -0
@@ -0,0 +1,715 @@
1
+ "use strict";
2
+
3
+ import { getAddress } from "@qevm/address";
4
+ import { BigNumber, BigNumberish } from "@qevm/bignumber";
5
+ import { arrayify, BytesLike, concat, hexDataSlice, hexlify, hexZeroPad, isHexString } from "@qevm/bytes";
6
+ import { id } from "@qevm/hash";
7
+ import { keccak256 } from "@ethersproject/keccak256"
8
+ import { defineReadOnly, Description, getStatic } from "@ethersproject/properties";
9
+
10
+ import { AbiCoder, defaultAbiCoder } from "./abi-coder";
11
+ import { checkResultErrors, Result } from "./coders/abstract-coder";
12
+ import { ConstructorFragment, ErrorFragment, EventFragment, FormatTypes, Fragment, FunctionFragment, JsonFragment, ParamType } from "./fragments";
13
+
14
+ import { Logger } from "@ethersproject/logger";
15
+ import { version } from "./_version";
16
+ const logger = new Logger(version);
17
+
18
+ export { checkResultErrors, Result };
19
+
20
+ export class LogDescription extends Description<LogDescription> {
21
+ readonly eventFragment: EventFragment;
22
+ readonly name: string;
23
+ readonly signature: string;
24
+ readonly topic: string;
25
+ readonly args: Result
26
+ }
27
+
28
+ export class TransactionDescription extends Description<TransactionDescription> {
29
+ readonly functionFragment: FunctionFragment;
30
+ readonly name: string;
31
+ readonly args: Result;
32
+ readonly signature: string;
33
+ readonly sighash: string;
34
+ readonly value: BigNumber;
35
+ }
36
+
37
+ export class ErrorDescription extends Description<ErrorDescription> {
38
+ readonly errorFragment: ErrorFragment;
39
+ readonly name: string;
40
+ readonly args: Result;
41
+ readonly signature: string;
42
+ readonly sighash: string;
43
+ }
44
+
45
+ export class Indexed extends Description<Indexed> {
46
+ readonly hash: string;
47
+ readonly _isIndexed: boolean;
48
+
49
+ static isIndexed(value: any): value is Indexed {
50
+ return !!(value && value._isIndexed);
51
+ }
52
+ }
53
+
54
+ const BuiltinErrors: Record<string, { signature: string, inputs: Array<string>, name: string, reason?: boolean }> = {
55
+ "0x08c379a0": { signature: "Error(string)", name: "Error", inputs: [ "string" ], reason: true },
56
+ "0x4e487b71": { signature: "Panic(uint256)", name: "Panic", inputs: [ "uint256" ] }
57
+ }
58
+
59
+ function wrapAccessError(property: string, error: Error): Error {
60
+ const wrap = new Error(`deferred error during ABI decoding triggered accessing ${ property }`);
61
+ (<any>wrap).error = error;
62
+ return wrap;
63
+ }
64
+
65
+ /*
66
+ function checkNames(fragment: Fragment, type: "input" | "output", params: Array<ParamType>): void {
67
+ params.reduce((accum, param) => {
68
+ if (param.name) {
69
+ if (accum[param.name]) {
70
+ logger.throwArgumentError(`duplicate ${ type } parameter ${ JSON.stringify(param.name) } in ${ fragment.format("full") }`, "fragment", fragment);
71
+ }
72
+ accum[param.name] = true;
73
+ }
74
+ return accum;
75
+ }, <{ [ name: string ]: boolean }>{ });
76
+ }
77
+ */
78
+ export class Interface {
79
+ readonly fragments: ReadonlyArray<Fragment>;
80
+
81
+ readonly errors: { [ name: string ]: ErrorFragment };
82
+ readonly events: { [ name: string ]: EventFragment };
83
+ readonly functions: { [ name: string ]: FunctionFragment };
84
+ readonly structs: { [ name: string ]: any };
85
+
86
+ readonly deploy: ConstructorFragment;
87
+
88
+ readonly _abiCoder: AbiCoder;
89
+
90
+ readonly _isInterface: boolean;
91
+
92
+ constructor(fragments: string | ReadonlyArray<Fragment | JsonFragment | string>) {
93
+ let abi: ReadonlyArray<Fragment | JsonFragment | string> = [ ];
94
+ if (typeof(fragments) === "string") {
95
+ abi = JSON.parse(fragments);
96
+ } else {
97
+ abi = fragments;
98
+ }
99
+
100
+ defineReadOnly(this, "fragments", abi.map((fragment) => {
101
+ return Fragment.from(fragment);
102
+ }).filter((fragment) => (fragment != null)));
103
+
104
+ defineReadOnly(this, "_abiCoder", getStatic<() => AbiCoder>(new.target, "getAbiCoder")());
105
+
106
+ defineReadOnly(this, "functions", { });
107
+ defineReadOnly(this, "errors", { });
108
+ defineReadOnly(this, "events", { });
109
+ defineReadOnly(this, "structs", { });
110
+
111
+ // Add all fragments by their signature
112
+ this.fragments.forEach((fragment) => {
113
+ let bucket: { [ name: string ]: Fragment } = null;
114
+ switch (fragment.type) {
115
+ case "constructor":
116
+ if (this.deploy) {
117
+ logger.warn("duplicate definition - constructor");
118
+ return;
119
+ }
120
+ //checkNames(fragment, "input", fragment.inputs);
121
+ defineReadOnly(this, "deploy", <ConstructorFragment>fragment);
122
+ return;
123
+ case "function":
124
+ //checkNames(fragment, "input", fragment.inputs);
125
+ //checkNames(fragment, "output", (<FunctionFragment>fragment).outputs);
126
+ bucket = this.functions;
127
+ break;
128
+ case "event":
129
+ //checkNames(fragment, "input", fragment.inputs);
130
+ bucket = this.events;
131
+ break;
132
+ case "error":
133
+ bucket = this.errors;
134
+ break;
135
+ default:
136
+ return;
137
+ }
138
+
139
+ let signature = fragment.format();
140
+ if (bucket[signature]) {
141
+ logger.warn("duplicate definition - " + signature);
142
+ return;
143
+ }
144
+
145
+ bucket[signature] = fragment;
146
+ });
147
+
148
+ // If we do not have a constructor add a default
149
+ if (!this.deploy) {
150
+ defineReadOnly(this, "deploy", ConstructorFragment.from({
151
+ payable: false,
152
+ type: "constructor"
153
+ }));
154
+ }
155
+
156
+ defineReadOnly(this, "_isInterface", true);
157
+ }
158
+
159
+ format(format?: string): string | Array<string> {
160
+ if (!format) { format = FormatTypes.full; }
161
+ if (format === FormatTypes.sighash) {
162
+ logger.throwArgumentError("interface does not support formatting sighash", "format", format);
163
+ }
164
+
165
+ const abi = this.fragments.map((fragment) => fragment.format(format));
166
+
167
+ // We need to re-bundle the JSON fragments a bit
168
+ if (format === FormatTypes.json) {
169
+ return JSON.stringify(abi.map((j) => JSON.parse(j)));
170
+ }
171
+
172
+ return abi;
173
+ }
174
+
175
+ // Sub-classes can override these to handle other blockchains
176
+ static getAbiCoder(): AbiCoder {
177
+ return defaultAbiCoder;
178
+ }
179
+
180
+ static getAddress(address: string): string {
181
+ return getAddress(address);
182
+ }
183
+
184
+ static getSighash(fragment: ErrorFragment | FunctionFragment): string {
185
+ return hexDataSlice(id(fragment.format()), 0, 4);
186
+ }
187
+
188
+ static getEventTopic(eventFragment: EventFragment): string {
189
+ return id(eventFragment.format());
190
+ }
191
+
192
+ // Find a function definition by any means necessary (unless it is ambiguous)
193
+ getFunction(nameOrSignatureOrSighash: string): FunctionFragment {
194
+ if (isHexString(nameOrSignatureOrSighash)) {
195
+ for (const name in this.functions) {
196
+ if (nameOrSignatureOrSighash === this.getSighash(name)) {
197
+ return this.functions[name];
198
+ }
199
+ }
200
+ logger.throwArgumentError("no matching function", "sighash", nameOrSignatureOrSighash);
201
+ }
202
+
203
+ // It is a bare name, look up the function (will return null if ambiguous)
204
+ if (nameOrSignatureOrSighash.indexOf("(") === -1) {
205
+ const name = nameOrSignatureOrSighash.trim();
206
+ const matching = Object.keys(this.functions).filter((f) => (f.split("("/* fix:) */)[0] === name));
207
+ if (matching.length === 0) {
208
+ logger.throwArgumentError("no matching function", "name", name);
209
+ } else if (matching.length > 1) {
210
+ logger.throwArgumentError("multiple matching functions", "name", name);
211
+ }
212
+
213
+ return this.functions[matching[0]];
214
+ }
215
+
216
+ // Normalize the signature and lookup the function
217
+ const result = this.functions[FunctionFragment.fromString(nameOrSignatureOrSighash).format()];
218
+ if (!result) {
219
+ logger.throwArgumentError("no matching function", "signature", nameOrSignatureOrSighash);
220
+ }
221
+ return result;
222
+ }
223
+
224
+ // Find an event definition by any means necessary (unless it is ambiguous)
225
+ getEvent(nameOrSignatureOrTopic: string): EventFragment {
226
+ if (isHexString(nameOrSignatureOrTopic)) {
227
+ const topichash = nameOrSignatureOrTopic.toLowerCase();
228
+ for (const name in this.events) {
229
+ if (topichash === this.getEventTopic(name)) {
230
+ return this.events[name];
231
+ }
232
+ }
233
+ logger.throwArgumentError("no matching event", "topichash", topichash);
234
+ }
235
+
236
+ // It is a bare name, look up the function (will return null if ambiguous)
237
+ if (nameOrSignatureOrTopic.indexOf("(") === -1) {
238
+ const name = nameOrSignatureOrTopic.trim();
239
+ const matching = Object.keys(this.events).filter((f) => (f.split("("/* fix:) */)[0] === name));
240
+ if (matching.length === 0) {
241
+ logger.throwArgumentError("no matching event", "name", name);
242
+ } else if (matching.length > 1) {
243
+ logger.throwArgumentError("multiple matching events", "name", name);
244
+ }
245
+
246
+ return this.events[matching[0]];
247
+ }
248
+
249
+ // Normalize the signature and lookup the function
250
+ const result = this.events[EventFragment.fromString(nameOrSignatureOrTopic).format()];
251
+ if (!result) {
252
+ logger.throwArgumentError("no matching event", "signature", nameOrSignatureOrTopic);
253
+ }
254
+ return result;
255
+ }
256
+
257
+ // Find a function definition by any means necessary (unless it is ambiguous)
258
+ getError(nameOrSignatureOrSighash: string): ErrorFragment {
259
+ if (isHexString(nameOrSignatureOrSighash)) {
260
+ const getSighash = getStatic<(f: ErrorFragment | FunctionFragment) => string>(this.constructor, "getSighash");
261
+ for (const name in this.errors) {
262
+ const error = this.errors[name];
263
+ if (nameOrSignatureOrSighash === getSighash(error)) {
264
+ return this.errors[name];
265
+ }
266
+ }
267
+ logger.throwArgumentError("no matching error", "sighash", nameOrSignatureOrSighash);
268
+ }
269
+
270
+ // It is a bare name, look up the function (will return null if ambiguous)
271
+ if (nameOrSignatureOrSighash.indexOf("(") === -1) {
272
+ const name = nameOrSignatureOrSighash.trim();
273
+ const matching = Object.keys(this.errors).filter((f) => (f.split("("/* fix:) */)[0] === name));
274
+ if (matching.length === 0) {
275
+ logger.throwArgumentError("no matching error", "name", name);
276
+ } else if (matching.length > 1) {
277
+ logger.throwArgumentError("multiple matching errors", "name", name);
278
+ }
279
+
280
+ return this.errors[matching[0]];
281
+ }
282
+
283
+ // Normalize the signature and lookup the function
284
+ const result = this.errors[FunctionFragment.fromString(nameOrSignatureOrSighash).format()];
285
+ if (!result) {
286
+ logger.throwArgumentError("no matching error", "signature", nameOrSignatureOrSighash);
287
+ }
288
+ return result;
289
+ }
290
+
291
+ // Get the sighash (the bytes4 selector) used by Solidity to identify a function
292
+ getSighash(fragment: ErrorFragment | FunctionFragment | string): string {
293
+ if (typeof(fragment) === "string") {
294
+ try {
295
+ fragment = this.getFunction(fragment);
296
+ } catch (error) {
297
+ try {
298
+ fragment = this.getError(<string>fragment);
299
+ } catch (_) {
300
+ throw error;
301
+ }
302
+ }
303
+ }
304
+
305
+ return getStatic<(f: ErrorFragment | FunctionFragment) => string>(this.constructor, "getSighash")(fragment);
306
+ }
307
+
308
+ // Get the topic (the bytes32 hash) used by Solidity to identify an event
309
+ getEventTopic(eventFragment: EventFragment | string): string {
310
+ if (typeof(eventFragment) === "string") {
311
+ eventFragment = this.getEvent(eventFragment);
312
+ }
313
+
314
+ return getStatic<(e: EventFragment) => string>(this.constructor, "getEventTopic")(eventFragment);
315
+ }
316
+
317
+
318
+ _decodeParams(params: ReadonlyArray<ParamType>, data: BytesLike): Result {
319
+ return this._abiCoder.decode(params, data)
320
+ }
321
+
322
+ _encodeParams(params: ReadonlyArray<ParamType>, values: ReadonlyArray<any>): string {
323
+ return this._abiCoder.encode(params, values)
324
+ }
325
+
326
+ encodeDeploy(values?: ReadonlyArray<any>): string {
327
+ return this._encodeParams(this.deploy.inputs, values || [ ]);
328
+ }
329
+
330
+ decodeErrorResult(fragment: ErrorFragment | string, data: BytesLike): Result {
331
+ if (typeof(fragment) === "string") {
332
+ fragment = this.getError(fragment);
333
+ }
334
+
335
+ const bytes = arrayify(data);
336
+
337
+ if (hexlify(bytes.slice(0, 4)) !== this.getSighash(fragment)) {
338
+ logger.throwArgumentError(`data signature does not match error ${ fragment.name }.`, "data", hexlify(bytes));
339
+ }
340
+
341
+ return this._decodeParams(fragment.inputs, bytes.slice(4));
342
+ }
343
+
344
+ encodeErrorResult(fragment: ErrorFragment | string, values?: ReadonlyArray<any>): string {
345
+ if (typeof(fragment) === "string") {
346
+ fragment = this.getError(fragment);
347
+ }
348
+
349
+ return hexlify(concat([
350
+ this.getSighash(fragment),
351
+ this._encodeParams(fragment.inputs, values || [ ])
352
+ ]));
353
+ }
354
+
355
+ // Decode the data for a function call (e.g. tx.data)
356
+ decodeFunctionData(functionFragment: FunctionFragment | string, data: BytesLike): Result {
357
+ if (typeof(functionFragment) === "string") {
358
+ functionFragment = this.getFunction(functionFragment);
359
+ }
360
+
361
+ const bytes = arrayify(data);
362
+
363
+ if (hexlify(bytes.slice(0, 4)) !== this.getSighash(functionFragment)) {
364
+ logger.throwArgumentError(`data signature does not match function ${ functionFragment.name }.`, "data", hexlify(bytes));
365
+ }
366
+
367
+ return this._decodeParams(functionFragment.inputs, bytes.slice(4));
368
+ }
369
+
370
+ // Encode the data for a function call (e.g. tx.data)
371
+ encodeFunctionData(functionFragment: FunctionFragment | string, values?: ReadonlyArray<any>): string {
372
+ if (typeof(functionFragment) === "string") {
373
+ functionFragment = this.getFunction(functionFragment);
374
+ }
375
+
376
+ return hexlify(concat([
377
+ this.getSighash(functionFragment),
378
+ this._encodeParams(functionFragment.inputs, values || [ ])
379
+ ]));
380
+ }
381
+
382
+ // Decode the result from a function call (e.g. from eth_call)
383
+ decodeFunctionResult(functionFragment: FunctionFragment | string, data: BytesLike): Result {
384
+ if (typeof(functionFragment) === "string") {
385
+ functionFragment = this.getFunction(functionFragment);
386
+ }
387
+
388
+ let bytes = arrayify(data);
389
+
390
+ let reason: string = null;
391
+ let message = "";
392
+ let errorArgs: Result = null;
393
+ let errorName: string = null;
394
+ let errorSignature: string = null;
395
+ switch (bytes.length % this._abiCoder._getWordSize()) {
396
+ case 0:
397
+ try {
398
+ return this._abiCoder.decode(functionFragment.outputs, bytes);
399
+ } catch (error) { }
400
+ break;
401
+
402
+ case 4: {
403
+ const selector = hexlify(bytes.slice(0, 4));
404
+ const builtin = BuiltinErrors[selector];
405
+ if (builtin) {
406
+ errorArgs = this._abiCoder.decode(builtin.inputs, bytes.slice(4));
407
+ errorName = builtin.name;
408
+ errorSignature = builtin.signature;
409
+ if (builtin.reason) { reason = errorArgs[0]; }
410
+ if (errorName === "Error") {
411
+ message = `; VM Exception while processing transaction: reverted with reason string ${ JSON.stringify(errorArgs[0]) }`;
412
+ } else if (errorName === "Panic") {
413
+ message = `; VM Exception while processing transaction: reverted with panic code ${ errorArgs[0] }`;
414
+ }
415
+ } else {
416
+ try {
417
+ const error = this.getError(selector);
418
+ errorArgs = this._abiCoder.decode(error.inputs, bytes.slice(4));
419
+ errorName = error.name;
420
+ errorSignature = error.format();
421
+ } catch (error) { }
422
+ }
423
+ break;
424
+ }
425
+ }
426
+
427
+ return logger.throwError("call revert exception" + message, Logger.errors.CALL_EXCEPTION, {
428
+ method: functionFragment.format(),
429
+ data: hexlify(data), errorArgs, errorName, errorSignature, reason
430
+ });
431
+ }
432
+
433
+ // Encode the result for a function call (e.g. for eth_call)
434
+ encodeFunctionResult(functionFragment: FunctionFragment | string, values?: ReadonlyArray<any>): string {
435
+ if (typeof(functionFragment) === "string") {
436
+ functionFragment = this.getFunction(functionFragment);
437
+ }
438
+
439
+ return hexlify(this._abiCoder.encode(functionFragment.outputs, values || [ ]));
440
+ }
441
+
442
+ // Create the filter for the event with search criteria (e.g. for eth_filterLog)
443
+ encodeFilterTopics(eventFragment: EventFragment | string, values: ReadonlyArray<any>): Array<string | Array<string>> {
444
+ if (typeof(eventFragment) === "string") {
445
+ eventFragment = this.getEvent(eventFragment);
446
+ }
447
+
448
+ if (values.length > eventFragment.inputs.length) {
449
+ logger.throwError("too many arguments for " + eventFragment.format(), Logger.errors.UNEXPECTED_ARGUMENT, {
450
+ argument: "values",
451
+ value: values
452
+ })
453
+ }
454
+
455
+ let topics: Array<string | Array<string>> = [];
456
+ if (!eventFragment.anonymous) { topics.push(this.getEventTopic(eventFragment)); }
457
+
458
+ const encodeTopic = (param: ParamType, value: any): string => {
459
+ if (param.type === "string") {
460
+ return id(value);
461
+ } else if (param.type === "bytes") {
462
+ return keccak256(hexlify(value));
463
+ }
464
+
465
+ if (param.type === "bool" && typeof(value) === "boolean") {
466
+ value = (value ? "0x01": "0x00");
467
+ }
468
+
469
+ if (param.type.match(/^u?int/)) {
470
+ value = BigNumber.from(value).toHexString();
471
+ }
472
+
473
+ // Check addresses are valid
474
+ if (param.type === "address") { this._abiCoder.encode( [ "address" ], [ value ]); }
475
+ return hexZeroPad(hexlify(value), 32);
476
+ };
477
+
478
+ values.forEach((value, index) => {
479
+
480
+ let param = (<EventFragment>eventFragment).inputs[index];
481
+
482
+ if (!param.indexed) {
483
+ if (value != null) {
484
+ logger.throwArgumentError("cannot filter non-indexed parameters; must be null", ("contract." + param.name), value);
485
+ }
486
+ return;
487
+ }
488
+
489
+ if (value == null) {
490
+ topics.push(null);
491
+ } else if (param.baseType === "array" || param.baseType === "tuple") {
492
+ logger.throwArgumentError("filtering with tuples or arrays not supported", ("contract." + param.name), value);
493
+ } else if (Array.isArray(value)) {
494
+ topics.push(value.map((value) => encodeTopic(param, value)));
495
+ } else {
496
+ topics.push(encodeTopic(param, value));
497
+ }
498
+ });
499
+
500
+ // Trim off trailing nulls
501
+ while (topics.length && topics[topics.length - 1] === null) {
502
+ topics.pop();
503
+ }
504
+
505
+ return topics;
506
+ }
507
+
508
+ encodeEventLog(eventFragment: EventFragment | string, values: ReadonlyArray<any>): { data: string, topics: Array<string> } {
509
+ if (typeof(eventFragment) === "string") {
510
+ eventFragment = this.getEvent(eventFragment);
511
+ }
512
+
513
+ const topics: Array<string> = [ ];
514
+
515
+ const dataTypes: Array<ParamType> = [ ];
516
+ const dataValues: Array<string> = [ ];
517
+
518
+ if (!eventFragment.anonymous) {
519
+ topics.push(this.getEventTopic(eventFragment));
520
+ }
521
+
522
+ if (values.length !== eventFragment.inputs.length) {
523
+ logger.throwArgumentError("event arguments/values mismatch", "values", values);
524
+ }
525
+
526
+ eventFragment.inputs.forEach((param, index) => {
527
+ const value = values[index];
528
+ if (param.indexed) {
529
+ if (param.type === "string") {
530
+ topics.push(id(value))
531
+ } else if (param.type === "bytes") {
532
+ topics.push(keccak256(value))
533
+ } else if (param.baseType === "tuple" || param.baseType === "array") {
534
+ // @TODO
535
+ throw new Error("not implemented");
536
+ } else {
537
+ topics.push(this._abiCoder.encode([ param.type] , [ value ]));
538
+ }
539
+ } else {
540
+ dataTypes.push(param);
541
+ dataValues.push(value);
542
+ }
543
+ });
544
+
545
+ return {
546
+ data: this._abiCoder.encode(dataTypes , dataValues),
547
+ topics: topics
548
+ };
549
+ }
550
+
551
+ // Decode a filter for the event and the search criteria
552
+ decodeEventLog(eventFragment: EventFragment | string, data: BytesLike, topics?: ReadonlyArray<string>): Result {
553
+ if (typeof(eventFragment) === "string") {
554
+ eventFragment = this.getEvent(eventFragment);
555
+ }
556
+
557
+ if (topics != null && !eventFragment.anonymous) {
558
+ let topicHash = this.getEventTopic(eventFragment);
559
+ if (!isHexString(topics[0], 32) || topics[0].toLowerCase() !== topicHash) {
560
+ logger.throwError("fragment/topic mismatch", Logger.errors.INVALID_ARGUMENT, { argument: "topics[0]", expected: topicHash, value: topics[0] });
561
+ }
562
+ topics = topics.slice(1);
563
+ }
564
+
565
+ let indexed: Array<ParamType> = [];
566
+ let nonIndexed: Array<ParamType> = [];
567
+ let dynamic: Array<boolean> = [];
568
+
569
+ eventFragment.inputs.forEach((param, index) => {
570
+ if (param.indexed) {
571
+ if (param.type === "string" || param.type === "bytes" || param.baseType === "tuple" || param.baseType === "array") {
572
+ indexed.push(ParamType.fromObject({ type: "bytes32", name: param.name }));
573
+ dynamic.push(true);
574
+ } else {
575
+ indexed.push(param);
576
+ dynamic.push(false);
577
+ }
578
+ } else {
579
+ nonIndexed.push(param);
580
+ dynamic.push(false);
581
+ }
582
+ });
583
+
584
+ let resultIndexed = (topics != null) ? this._abiCoder.decode(indexed, concat(topics)): null;
585
+ let resultNonIndexed = this._abiCoder.decode(nonIndexed, data, true);
586
+
587
+ let result: (Array<any> & { [ key: string ]: any }) = [ ];
588
+ let nonIndexedIndex = 0, indexedIndex = 0;
589
+ eventFragment.inputs.forEach((param, index) => {
590
+ if (param.indexed) {
591
+ if (resultIndexed == null) {
592
+ result[index] = new Indexed({ _isIndexed: true, hash: null });
593
+
594
+ } else if (dynamic[index]) {
595
+ result[index] = new Indexed({ _isIndexed: true, hash: resultIndexed[indexedIndex++] });
596
+
597
+ } else {
598
+ try {
599
+ result[index] = resultIndexed[indexedIndex++];
600
+ } catch (error) {
601
+ result[index] = error;
602
+ }
603
+ }
604
+ } else {
605
+ try {
606
+ result[index] = resultNonIndexed[nonIndexedIndex++];
607
+ } catch (error) {
608
+ result[index] = error;
609
+ }
610
+ }
611
+
612
+ // Add the keyword argument if named and safe
613
+ if (param.name && result[param.name] == null) {
614
+ const value = result[index];
615
+
616
+ // Make error named values throw on access
617
+ if (value instanceof Error) {
618
+ Object.defineProperty(result, param.name, {
619
+ enumerable: true,
620
+ get: () => { throw wrapAccessError(`property ${ JSON.stringify(param.name) }`, value); }
621
+ });
622
+ } else {
623
+ result[param.name] = value;
624
+ }
625
+ }
626
+ });
627
+
628
+ // Make all error indexed values throw on access
629
+ for (let i = 0; i < result.length; i++) {
630
+ const value = result[i];
631
+ if (value instanceof Error) {
632
+ Object.defineProperty(result, i, {
633
+ enumerable: true,
634
+ get: () => { throw wrapAccessError(`index ${ i }`, value); }
635
+ });
636
+ }
637
+ }
638
+
639
+ return Object.freeze(result);
640
+ }
641
+
642
+ // Given a transaction, find the matching function fragment (if any) and
643
+ // determine all its properties and call parameters
644
+ parseTransaction(tx: { data: string, value?: BigNumberish }): TransactionDescription {
645
+ let fragment = this.getFunction(tx.data.substring(0, 10).toLowerCase())
646
+
647
+ if (!fragment) { return null; }
648
+
649
+ return new TransactionDescription({
650
+ args: this._abiCoder.decode(fragment.inputs, "0x" + tx.data.substring(10)),
651
+ functionFragment: fragment,
652
+ name: fragment.name,
653
+ signature: fragment.format(),
654
+ sighash: this.getSighash(fragment),
655
+ value: BigNumber.from(tx.value || "0"),
656
+ });
657
+ }
658
+
659
+ // @TODO
660
+ //parseCallResult(data: BytesLike): ??
661
+
662
+ // Given an event log, find the matching event fragment (if any) and
663
+ // determine all its properties and values
664
+ parseLog(log: { topics: Array<string>, data: string}): LogDescription {
665
+ let fragment = this.getEvent(log.topics[0]);
666
+
667
+ if (!fragment || fragment.anonymous) { return null; }
668
+
669
+ // @TODO: If anonymous, and the only method, and the input count matches, should we parse?
670
+ // Probably not, because just because it is the only event in the ABI does
671
+ // not mean we have the full ABI; maybe just a fragment?
672
+
673
+
674
+ return new LogDescription({
675
+ eventFragment: fragment,
676
+ name: fragment.name,
677
+ signature: fragment.format(),
678
+ topic: this.getEventTopic(fragment),
679
+ args: this.decodeEventLog(fragment, log.data, log.topics)
680
+ });
681
+ }
682
+
683
+ parseError(data: BytesLike): ErrorDescription {
684
+ const hexData = hexlify(data);
685
+ let fragment = this.getError(hexData.substring(0, 10).toLowerCase())
686
+
687
+ if (!fragment) { return null; }
688
+
689
+ return new ErrorDescription({
690
+ args: this._abiCoder.decode(fragment.inputs, "0x" + hexData.substring(10)),
691
+ errorFragment: fragment,
692
+ name: fragment.name,
693
+ signature: fragment.format(),
694
+ sighash: this.getSighash(fragment),
695
+ });
696
+ }
697
+
698
+
699
+ /*
700
+ static from(value: Array<Fragment | string | JsonAbi> | string | Interface) {
701
+ if (Interface.isInterface(value)) {
702
+ return value;
703
+ }
704
+ if (typeof(value) === "string") {
705
+ return new Interface(JSON.parse(value));
706
+ }
707
+ return new Interface(value);
708
+ }
709
+ */
710
+
711
+ static isInterface(value: any): value is Interface {
712
+ return !!(value && value._isInterface);
713
+ }
714
+ }
715
+