-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathtransaction.ts
More file actions
1556 lines (1322 loc) · 51.7 KB
/
Copy pathtransaction.ts
File metadata and controls
1556 lines (1322 loc) · 51.7 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
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { getAddress } from "../address/index.js";
import { ZeroAddress } from "../constants/addresses.js";
import {
keccak256, sha256, Signature, SigningKey
} from "../crypto/index.js";
import {
concat, decodeRlp, encodeRlp, getBytes, getBigInt, getNumber, hexlify,
assert, assertArgument, isBytesLike, isHexString, toBeArray, zeroPadValue
} from "../utils/index.js";
import { accessListify } from "./accesslist.js";
import { authorizationify } from "./authorization.js";
import { recoverAddress } from "./address.js";
import type { BigNumberish, BytesLike } from "../utils/index.js";
import type { SignatureLike } from "../crypto/index.js";
import type {
AccessList, AccessListish, Authorization, AuthorizationLike
} from "./index.js";
const BN_0 = BigInt(0);
const BN_2 = BigInt(2);
const BN_27 = BigInt(27)
const BN_28 = BigInt(28)
const BN_35 = BigInt(35);
const BN_MAX_UINT = BigInt("0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
const inspect = Symbol.for("nodejs.util.inspect.custom");
const BLOB_SIZE = 4096 * 32;
const CELL_COUNT = 128;
/**
* Returns a BLOb proof as its cells for [[link-eip-7594]] BLOb.
*
* The default %%cellCount%% is 128.
*/
export function splitBlobCells(_proof: BytesLike, cellCount?: number): Array<string> {
if (cellCount == null) { cellCount = CELL_COUNT; }
const cellProofs: Array<string> = [ ];
const proof = getBytes(_proof);
const cellSize = proof.length / cellCount;
for (let i = 0; i < proof.length; i += cellSize) {
cellProofs.push(hexlify(proof.subarray(i, i + cellSize)));
}
return cellProofs;
}
// The BLS Modulo; each field within a BLOb must be less than this
//const BLOB_BLS_MODULO = BigInt("0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001");
/**
* A **TransactionLike** is an object which is appropriate as a loose
* input for many operations which will populate missing properties of
* a transaction.
*/
export interface TransactionLike<A = string> {
/**
* The type.
*/
type?: null | number;
/**
* The recipient address or ``null`` for an ``init`` transaction.
*/
to?: null | A;
/**
* The sender.
*/
from?: null | A;
/**
* The nonce.
*/
nonce?: null | number;
/**
* The maximum amount of gas that can be used.
*/
gasLimit?: null | BigNumberish;
/**
* The gas price for legacy and berlin transactions.
*/
gasPrice?: null | BigNumberish;
/**
* The maximum priority fee per gas for london transactions.
*/
maxPriorityFeePerGas?: null | BigNumberish;
/**
* The maximum total fee per gas for london transactions.
*/
maxFeePerGas?: null | BigNumberish;
/**
* The data.
*/
data?: null | string;
/**
* The value (in wei) to send.
*/
value?: null | BigNumberish;
/**
* The chain ID the transaction is valid on.
*/
chainId?: null | BigNumberish;
/**
* The transaction hash.
*/
hash?: null | string;
/**
* The signature provided by the sender.
*/
signature?: null | SignatureLike;
/**
* The access list for berlin and london transactions.
*/
accessList?: null | AccessListish;
/**
* The maximum fee per blob gas (see [[link-eip-4844]]).
*/
maxFeePerBlobGas?: null | BigNumberish;
/**
* The versioned hashes (see [[link-eip-4844]]).
*/
blobVersionedHashes?: null | Array<string>;
/**
* The blobs (if any) attached to this transaction (see [[link-eip-4844]]).
*/
blobs?: null | Array<BlobLike>
/**
* An external library for computing the KZG commitments and
* proofs necessary for EIP-4844 transactions (see [[link-eip-4844]]).
*
* This is generally ``null``, unless you are creating BLOb
* transactions.
*/
kzg?: null | KzgLibraryLike;
/**
* The [[link-eip-7594]] BLOb Wrapper Version used for PeerDAS.
*
* For networks that use EIP-7594, this property is required to
* serialize the sidecar correctly.
*/
blobWrapperVersion?: null | number;
/**
* The [[link-eip-7702]] authorizations (if any).
*/
authorizationList?: null | Array<Authorization>;
}
/**
* A full-valid BLOb object for [[link-eip-4844]] transactions.
*
* The commitment and proof should have been computed using a
* KZG library.
*/
export interface Blob {
/**
* The blob data.
*/
data: string;
/**
* A EIP-4844 BLOb uses a string proof, while EIP-7594 use an
* array of strings representing the cells of the proof.
*/
proof: string;
/**
* The BLOb commitment.
*/
commitment: string;
}
/**
* A BLOb object that can be passed for [[link-eip-4844]]
* transactions.
*
* It may have had its commitment and proof already provided
* or rely on an attached [[KzgLibrary]] to compute them.
*/
export type BlobLike = BytesLike | {
data: BytesLike;
proof: BytesLike;
commitment: BytesLike;
};
/**
* A KZG Library with the necessary functions to compute
* BLOb commitments and proofs.
*/
export interface KzgLibrary {
blobToKzgCommitment: (blob: Uint8Array) => Uint8Array;
computeBlobKzgProof: (blob: Uint8Array, commitment: Uint8Array) => Uint8Array;
}
/**
* A KZG Library with any of the various API configurations.
* As the library is still experimental and the API is not
* stable, depending on the version used the method names and
* signatures are still in flux.
*
* This allows any of the versions to be passed into Transaction
* while providing a stable external API.
*/
export type KzgLibraryLike = KzgLibrary | {
// kzg-wasm >= 0.5.0
blobToKZGCommitment: (blob: string) => string;
computeBlobKZGProof: (blob: string, commitment: string) => string;
} | {
// micro-ecc-signer
blobToKzgCommitment: (blob: string) => string | Uint8Array;
computeBlobProof: (blob: string, commitment: string) => string | Uint8Array;
};
function getKzgLibrary(kzg: KzgLibraryLike): KzgLibrary {
const blobToKzgCommitment = (blob: Uint8Array) => {
if ("computeBlobProof" in kzg) {
// micro-ecc-signer; check for computeBlobProof since this API
// expects a string while the kzg-wasm below expects a Unit8Array
if ("blobToKzgCommitment" in kzg && typeof(kzg.blobToKzgCommitment) === "function") {
return getBytes(kzg.blobToKzgCommitment(hexlify(blob)))
}
} else if ("blobToKzgCommitment" in kzg && typeof(kzg.blobToKzgCommitment) === "function") {
// kzg-wasm <0.5.0; blobToKzgCommitment(Uint8Array) => Uint8Array
return getBytes(kzg.blobToKzgCommitment(blob));
}
// kzg-wasm >= 0.5.0; blobToKZGCommitment(string) => string
if ("blobToKZGCommitment" in kzg && typeof(kzg.blobToKZGCommitment) === "function") {
return getBytes(kzg.blobToKZGCommitment(hexlify(blob)));
}
assertArgument(false, "unsupported KZG library", "kzg", kzg);
};
const computeBlobKzgProof = (blob: Uint8Array, commitment: Uint8Array) => {
// micro-ecc-signer
if ("computeBlobProof" in kzg && typeof(kzg.computeBlobProof) === "function") {
return getBytes(kzg.computeBlobProof(hexlify(blob), hexlify(commitment)))
}
// kzg-wasm <0.5.0; computeBlobKzgProof(Uint8Array, Uint8Array) => Uint8Array
if ("computeBlobKzgProof" in kzg && typeof(kzg.computeBlobKzgProof) === "function") {
return kzg.computeBlobKzgProof(blob, commitment);
}
// kzg-wasm >= 0.5.0; computeBlobKZGProof(string, string) => string
if ("computeBlobKZGProof" in kzg && typeof(kzg.computeBlobKZGProof) === "function") {
return getBytes(kzg.computeBlobKZGProof(hexlify(blob), hexlify(commitment)));
}
assertArgument(false, "unsupported KZG library", "kzg", kzg);
};
return { blobToKzgCommitment, computeBlobKzgProof };
}
function getVersionedHash(version: number, hash: BytesLike): string {
let versioned = version.toString(16);
while (versioned.length < 2) { versioned = "0" + versioned; }
versioned += sha256(hash).substring(4);
return "0x" + versioned;
}
function handleAddress(value: string): null | string {
if (value === "0x") { return null; }
return getAddress(value);
}
function handleAccessList(value: any, param: string): AccessList {
try {
return accessListify(value);
} catch (error: any) {
assertArgument(false, error.message, param, value);
}
}
function handleAuthorizationList(value: any, param: string): Array<Authorization> {
try {
if (!Array.isArray(value)) { throw new Error("authorizationList: invalid array"); }
const result: Array<Authorization> = [ ];
for (let i = 0; i < value.length; i++) {
const auth: Array<string> = value[i];
if (!Array.isArray(auth)) { throw new Error(`authorization[${ i }]: invalid array`); }
if (auth.length !== 6) { throw new Error(`authorization[${ i }]: wrong length`); }
if (!auth[1]) { throw new Error(`authorization[${ i }]: null address`); }
result.push({
address: <string>handleAddress(auth[1]),
nonce: handleUint(auth[2], "nonce"),
chainId: handleUint(auth[0], "chainId"),
signature: Signature.from({
yParity: <0 | 1>handleNumber(auth[3], "yParity"),
r: zeroPadValue(auth[4], 32),
s: zeroPadValue(auth[5], 32)
})
});
}
return result;
} catch (error: any) {
assertArgument(false, error.message, param, value);
}
}
function handleNumber(_value: string, param: string): number {
if (_value === "0x") { return 0; }
return getNumber(_value, param);
}
function handleUint(_value: string, param: string): bigint {
if (_value === "0x") { return BN_0; }
const value = getBigInt(_value, param);
assertArgument(value <= BN_MAX_UINT, "value exceeds uint size", param, value);
return value;
}
function formatNumber(_value: BigNumberish, name: string): Uint8Array {
const value = getBigInt(_value, "value");
const result = toBeArray(value);
assertArgument(result.length <= 32, `value too large`, `tx.${ name }`, value);
return result;
}
function formatAccessList(value: AccessListish): Array<[ string, Array<string> ]> {
return accessListify(value).map((set) => [ set.address, set.storageKeys ]);
}
function formatAuthorizationList(value: Array<Authorization>): Array<Array<string | Uint8Array>> {
return value.map((a) => {
return [
formatNumber(a.chainId, "chainId"),
a.address,
formatNumber(a.nonce, "nonce"),
formatNumber(a.signature.yParity, "yParity"),
toBeArray(a.signature.r),
toBeArray(a.signature._s)
];
});
}
function formatHashes(value: Array<string>, param: string): Array<string> {
assertArgument(Array.isArray(value), `invalid ${ param }`, "value", value);
for (let i = 0; i < value.length; i++) {
assertArgument(isHexString(value[i], 32), "invalid ${ param } hash", `value[${ i }]`, value[i]);
}
return value;
}
function _parseLegacy(data: Uint8Array): TransactionLike {
const fields: any = decodeRlp(data);
assertArgument(Array.isArray(fields) && (fields.length === 9 || fields.length === 6),
"invalid field count for legacy transaction", "data", data);
const tx: TransactionLike = {
type: 0,
nonce: handleNumber(fields[0], "nonce"),
gasPrice: handleUint(fields[1], "gasPrice"),
gasLimit: handleUint(fields[2], "gasLimit"),
to: handleAddress(fields[3]),
value: handleUint(fields[4], "value"),
data: hexlify(fields[5]),
chainId: BN_0
};
// Legacy unsigned transaction
if (fields.length === 6) { return tx; }
const v = handleUint(fields[6], "v");
const r = handleUint(fields[7], "r");
const s = handleUint(fields[8], "s");
if (r === BN_0 && s === BN_0) {
// EIP-155 unsigned transaction
tx.chainId = v;
} else {
// Compute the EIP-155 chain ID (or 0 for legacy)
let chainId = (v - BN_35) / BN_2;
if (chainId < BN_0) { chainId = BN_0; }
tx.chainId = chainId
// Signed Legacy Transaction
assertArgument(chainId !== BN_0 || (v === BN_27 || v === BN_28), "non-canonical legacy v", "v", fields[6]);
tx.signature = Signature.from({
r: zeroPadValue(fields[7], 32),
s: zeroPadValue(fields[8], 32),
v
});
//tx.hash = keccak256(data);
}
return tx;
}
function _serializeLegacy(tx: Transaction, sig: null | Signature): string {
const fields: Array<any> = [
formatNumber(tx.nonce, "nonce"),
formatNumber(tx.gasPrice || 0, "gasPrice"),
formatNumber(tx.gasLimit, "gasLimit"),
(tx.to || "0x"),
formatNumber(tx.value, "value"),
tx.data,
];
let chainId = BN_0;
if (tx.chainId != BN_0) {
// A chainId was provided; if non-zero we'll use EIP-155
chainId = getBigInt(tx.chainId, "tx.chainId");
// We have a chainId in the tx and an EIP-155 v in the signature,
// make sure they agree with each other
assertArgument(!sig || sig.networkV == null || sig.legacyChainId === chainId,
"tx.chainId/sig.v mismatch", "sig", sig);
} else if (tx.signature) {
// No explicit chainId, but EIP-155 have a derived implicit chainId
const legacy = tx.signature.legacyChainId;
if (legacy != null) { chainId = legacy; }
}
// Requesting an unsigned transaction
if (!sig) {
// We have an EIP-155 transaction (chainId was specified and non-zero)
if (chainId !== BN_0) {
fields.push(toBeArray(chainId));
fields.push("0x");
fields.push("0x");
}
return encodeRlp(fields);
}
// @TODO: We should probably check that tx.signature, chainId, and sig
// match but that logic could break existing code, so schedule
// this for the next major bump.
// Compute the EIP-155 v
let v = BigInt(27 + sig.yParity);
if (chainId !== BN_0) {
v = Signature.getChainIdV(chainId, sig.v);
} else if (BigInt(sig.v) !== v) {
assertArgument(false, "tx.chainId/sig.v mismatch", "sig", sig);
}
// Add the signature
fields.push(toBeArray(v));
fields.push(toBeArray(sig.r));
fields.push(toBeArray(sig._s));
return encodeRlp(fields);
}
function _parseEipSignature(tx: TransactionLike, fields: Array<string>): void {
let yParity: number;
try {
yParity = handleNumber(fields[0], "yParity");
if (yParity !== 0 && yParity !== 1) { throw new Error("bad yParity"); }
} catch (error) {
assertArgument(false, "invalid yParity", "yParity", fields[0]);
}
const r = zeroPadValue(fields[1], 32);
const s = zeroPadValue(fields[2], 32);
const signature = Signature.from({ r, s, yParity });
tx.signature = signature;
}
function _parseEip1559(data: Uint8Array): TransactionLike {
const fields: any = decodeRlp(getBytes(data).slice(1));
assertArgument(Array.isArray(fields) && (fields.length === 9 || fields.length === 12),
"invalid field count for transaction type: 2", "data", hexlify(data));
const tx: TransactionLike = {
type: 2,
chainId: handleUint(fields[0], "chainId"),
nonce: handleNumber(fields[1], "nonce"),
maxPriorityFeePerGas: handleUint(fields[2], "maxPriorityFeePerGas"),
maxFeePerGas: handleUint(fields[3], "maxFeePerGas"),
gasPrice: null,
gasLimit: handleUint(fields[4], "gasLimit"),
to: handleAddress(fields[5]),
value: handleUint(fields[6], "value"),
data: hexlify(fields[7]),
accessList: handleAccessList(fields[8], "accessList"),
};
// Unsigned EIP-1559 Transaction
if (fields.length === 9) { return tx; }
//tx.hash = keccak256(data);
_parseEipSignature(tx, fields.slice(9));
return tx;
}
function _serializeEip1559(tx: Transaction, sig: null | Signature): string {
const fields: Array<any> = [
formatNumber(tx.chainId, "chainId"),
formatNumber(tx.nonce, "nonce"),
formatNumber(tx.maxPriorityFeePerGas || 0, "maxPriorityFeePerGas"),
formatNumber(tx.maxFeePerGas || 0, "maxFeePerGas"),
formatNumber(tx.gasLimit, "gasLimit"),
(tx.to || "0x"),
formatNumber(tx.value, "value"),
tx.data,
formatAccessList(tx.accessList || [ ])
];
if (sig) {
fields.push(formatNumber(sig.yParity, "yParity"));
fields.push(toBeArray(sig.r));
fields.push(toBeArray(sig.s));
}
return concat([ "0x02", encodeRlp(fields)]);
}
function _parseEip2930(data: Uint8Array): TransactionLike {
const fields: any = decodeRlp(getBytes(data).slice(1));
assertArgument(Array.isArray(fields) && (fields.length === 8 || fields.length === 11),
"invalid field count for transaction type: 1", "data", hexlify(data));
const tx: TransactionLike = {
type: 1,
chainId: handleUint(fields[0], "chainId"),
nonce: handleNumber(fields[1], "nonce"),
gasPrice: handleUint(fields[2], "gasPrice"),
gasLimit: handleUint(fields[3], "gasLimit"),
to: handleAddress(fields[4]),
value: handleUint(fields[5], "value"),
data: hexlify(fields[6]),
accessList: handleAccessList(fields[7], "accessList")
};
// Unsigned EIP-2930 Transaction
if (fields.length === 8) { return tx; }
//tx.hash = keccak256(data);
_parseEipSignature(tx, fields.slice(8));
return tx;
}
function _serializeEip2930(tx: Transaction, sig: null | Signature): string {
const fields: any = [
formatNumber(tx.chainId, "chainId"),
formatNumber(tx.nonce, "nonce"),
formatNumber(tx.gasPrice || 0, "gasPrice"),
formatNumber(tx.gasLimit, "gasLimit"),
(tx.to || "0x"),
formatNumber(tx.value, "value"),
tx.data,
formatAccessList(tx.accessList || [ ])
];
if (sig) {
fields.push(formatNumber(sig.yParity, "recoveryParam"));
fields.push(toBeArray(sig.r));
fields.push(toBeArray(sig.s));
}
return concat([ "0x01", encodeRlp(fields)]);
}
function _parseEip4844(data: Uint8Array): TransactionLike {
let fields: any = decodeRlp(getBytes(data).slice(1));
let typeName = "3";
let blobWrapperVersion: null | number = null;
let blobs: null | Array<Blob> = null;
// Parse the network format
if (fields.length === 4 && Array.isArray(fields[0])) {
// EIP-4844 format with sidecar
typeName = "3 (network format)";
const fBlobs = fields[1], fCommits = fields[2], fProofs = fields[3];
assertArgument(Array.isArray(fBlobs), "invalid network format: blobs not an array", "fields[1]", fBlobs);
assertArgument(Array.isArray(fCommits), "invalid network format: commitments not an array", "fields[2]", fCommits);
assertArgument(Array.isArray(fProofs), "invalid network format: proofs not an array", "fields[3]", fProofs);
assertArgument(fBlobs.length === fCommits.length, "invalid network format: blobs/commitments length mismatch", "fields", fields);
assertArgument(fBlobs.length === fProofs.length, "invalid network format: blobs/proofs length mismatch", "fields", fields);
blobs = [ ];
for (let i = 0; i < fields[1].length; i++) {
blobs.push({
data: fBlobs[i],
commitment: fCommits[i],
proof: fProofs[i],
});
}
fields = fields[0];
} else if (fields.length === 5 && Array.isArray(fields[0])) {
// EIP-7594 format with sidecar
typeName = "3 (EIP-7594 network format)";
blobWrapperVersion = getNumber(fields[1]);
const fBlobs = fields[2], fCommits = fields[3], fProofs = fields[4];
assertArgument(blobWrapperVersion === 1, `unsupported EIP-7594 network format version: ${ blobWrapperVersion }`, "fields[1]", blobWrapperVersion);
assertArgument(Array.isArray(fBlobs), "invalid EIP-7594 network format: blobs not an array", "fields[2]", fBlobs);
assertArgument(Array.isArray(fCommits), "invalid EIP-7594 network format: commitments not an array", "fields[3]", fCommits);
assertArgument(Array.isArray(fProofs), "invalid EIP-7594 network format: proofs not an array", "fields[4]", fProofs);
assertArgument(fBlobs.length === fCommits.length, "invalid network format: blobs/commitments length mismatch", "fields", fields);
assertArgument(fBlobs.length * CELL_COUNT === fProofs.length, "invalid network format: blobs/proofs length mismatch", "fields", fields);
blobs = [ ];
for (let i = 0; i < fBlobs.length; i++) {
const proof = [ ];
for (let j = 0; j < CELL_COUNT; j++) {
proof.push(fProofs[(i * CELL_COUNT) + j]);
}
blobs.push({
data: fBlobs[i],
commitment: fCommits[i],
proof: concat(proof)
});
}
fields = fields[0];
}
assertArgument(Array.isArray(fields) && (fields.length === 11 || fields.length === 14),
`invalid field count for transaction type: ${ typeName }`, "data", hexlify(data));
const tx: TransactionLike = {
type: 3,
chainId: handleUint(fields[0], "chainId"),
nonce: handleNumber(fields[1], "nonce"),
maxPriorityFeePerGas: handleUint(fields[2], "maxPriorityFeePerGas"),
maxFeePerGas: handleUint(fields[3], "maxFeePerGas"),
gasPrice: null,
gasLimit: handleUint(fields[4], "gasLimit"),
to: handleAddress(fields[5]),
value: handleUint(fields[6], "value"),
data: hexlify(fields[7]),
accessList: handleAccessList(fields[8], "accessList"),
maxFeePerBlobGas: handleUint(fields[9], "maxFeePerBlobGas"),
blobVersionedHashes: fields[10],
blobWrapperVersion
};
if (blobs) { tx.blobs = blobs; }
assertArgument(tx.to != null, `invalid address for transaction type: ${ typeName }`, "data", data);
assertArgument(Array.isArray(tx.blobVersionedHashes), "invalid blobVersionedHashes: must be an array", "data", data);
for (let i = 0; i < tx.blobVersionedHashes.length; i++) {
assertArgument(isHexString(tx.blobVersionedHashes[i], 32), `invalid blobVersionedHash at index ${ i }: must be length 32`, "data", data);
}
// Unsigned EIP-4844 Transaction
if (fields.length === 11) { return tx; }
// @TODO: Do we need to do this? This is only called internally
// and used to verify hashes; it might save time to not do this
//tx.hash = keccak256(concat([ "0x03", encodeRlp(fields) ]));
_parseEipSignature(tx, fields.slice(11));
return tx;
}
function _serializeEip4844(tx: Transaction, sig: null | Signature, blobs: null | Array<Blob>): string {
const fields: Array<any> = [
formatNumber(tx.chainId, "chainId"),
formatNumber(tx.nonce, "nonce"),
formatNumber(tx.maxPriorityFeePerGas || 0, "maxPriorityFeePerGas"),
formatNumber(tx.maxFeePerGas || 0, "maxFeePerGas"),
formatNumber(tx.gasLimit, "gasLimit"),
(tx.to || ZeroAddress),
formatNumber(tx.value, "value"),
tx.data,
formatAccessList(tx.accessList || [ ]),
formatNumber(tx.maxFeePerBlobGas || 0, "maxFeePerBlobGas"),
formatHashes(tx.blobVersionedHashes || [ ], "blobVersionedHashes")
];
if (sig) {
fields.push(formatNumber(sig.yParity, "yParity"));
fields.push(toBeArray(sig.r));
fields.push(toBeArray(sig.s));
// We have blobs; return the network wrapped format
if (blobs) {
// Use EIP-7594
if (tx.blobWrapperVersion != null) {
const wrapperVersion = toBeArray(tx.blobWrapperVersion);
const cellProofs: Array<Uint8Array> = [ ];
for (const { proof } of blobs) {
const p = getBytes(proof);
const cellSize = p.length / CELL_COUNT;
for (let i = 0; i < p.length; i += cellSize) {
cellProofs.push(p.subarray(i, i + cellSize));
}
}
return concat([
"0x03",
encodeRlp([
fields,
wrapperVersion,
blobs.map((b) => b.data),
blobs.map((b) => b.commitment),
cellProofs
])
]);
}
// Fall back onto classic EIP-4844 behavior
return concat([
"0x03",
encodeRlp([
fields,
blobs.map((b) => b.data),
blobs.map((b) => b.commitment),
blobs.map((b) => b.proof),
])
]);
}
}
return concat([ "0x03", encodeRlp(fields)]);
}
function _parseEip7702(data: Uint8Array): TransactionLike {
const fields: any = decodeRlp(getBytes(data).slice(1));
assertArgument(Array.isArray(fields) && (fields.length === 10 || fields.length === 13),
"invalid field count for transaction type: 4", "data", hexlify(data));
const tx: TransactionLike = {
type: 4,
chainId: handleUint(fields[0], "chainId"),
nonce: handleNumber(fields[1], "nonce"),
maxPriorityFeePerGas: handleUint(fields[2], "maxPriorityFeePerGas"),
maxFeePerGas: handleUint(fields[3], "maxFeePerGas"),
gasPrice: null,
gasLimit: handleUint(fields[4], "gasLimit"),
to: handleAddress(fields[5]),
value: handleUint(fields[6], "value"),
data: hexlify(fields[7]),
accessList: handleAccessList(fields[8], "accessList"),
authorizationList: handleAuthorizationList(fields[9], "authorizationList"),
};
// Unsigned EIP-7702 Transaction
if (fields.length === 10) { return tx; }
_parseEipSignature(tx, fields.slice(10));
return tx;
}
function _serializeEip7702(tx: Transaction, sig: null | Signature): string {
const fields: Array<any> = [
formatNumber(tx.chainId, "chainId"),
formatNumber(tx.nonce, "nonce"),
formatNumber(tx.maxPriorityFeePerGas || 0, "maxPriorityFeePerGas"),
formatNumber(tx.maxFeePerGas || 0, "maxFeePerGas"),
formatNumber(tx.gasLimit, "gasLimit"),
(tx.to || "0x"),
formatNumber(tx.value, "value"),
tx.data,
formatAccessList(tx.accessList || [ ]),
formatAuthorizationList(tx.authorizationList || [ ])
];
if (sig) {
fields.push(formatNumber(sig.yParity, "yParity"));
fields.push(toBeArray(sig.r));
fields.push(toBeArray(sig.s));
}
return concat([ "0x04", encodeRlp(fields)]);
}
/**
* A **Transaction** describes an operation to be executed on
* Ethereum by an Externally Owned Account (EOA). It includes
* who (the [[to]] address), what (the [[data]]) and how much (the
* [[value]] in ether) the operation should entail.
*
* @example:
* tx = new Transaction()
* //_result:
*
* tx.data = "0x1234";
* //_result:
*/
export class Transaction implements TransactionLike<string> {
#type: null | number;
#to: null | string;
#data: string;
#nonce: number;
#gasLimit: bigint;
#gasPrice: null | bigint;
#maxPriorityFeePerGas: null | bigint;
#maxFeePerGas: null | bigint;
#value: bigint;
#chainId: bigint;
#sig: null | Signature;
#accessList: null | AccessList;
#maxFeePerBlobGas: null | bigint;
#blobVersionedHashes: null | Array<string>;
#kzg: null | KzgLibrary;
#blobs: null | Array<Blob>;
#auths: null | Array<Authorization>;
#blobWrapperVersion: null | number;
/**
* The transaction type.
*
* If null, the type will be automatically inferred based on
* explicit properties.
*/
get type(): null | number { return this.#type; }
set type(value: null | number | string) {
switch (value) {
case null:
this.#type = null;
break;
case 0: case "legacy":
this.#type = 0;
break;
case 1: case "berlin": case "eip-2930":
this.#type = 1;
break;
case 2: case "london": case "eip-1559":
this.#type = 2;
break;
case 3: case "cancun": case "eip-4844":
this.#type = 3;
break;
case 4: case "pectra": case "eip-7702":
this.#type = 4;
break;
default:
assertArgument(false, "unsupported transaction type", "type", value);
}
}
/**
* The name of the transaction type.
*/
get typeName(): null | string {
switch (this.type) {
case 0: return "legacy";
case 1: return "eip-2930";
case 2: return "eip-1559";
case 3: return "eip-4844";
case 4: return "eip-7702";
}
return null;
}
/**
* The ``to`` address for the transaction or ``null`` if the
* transaction is an ``init`` transaction.
*/
get to(): null | string {
const value = this.#to;
if (value == null && this.type === 3) { return ZeroAddress; }
return value;
}
set to(value: null | string) {
this.#to = (value == null) ? null: getAddress(value);
}
/**
* The transaction nonce.
*/
get nonce(): number { return this.#nonce; }
set nonce(value: BigNumberish) { this.#nonce = getNumber(value, "value"); }
/**
* The gas limit.
*/
get gasLimit(): bigint { return this.#gasLimit; }
set gasLimit(value: BigNumberish) { this.#gasLimit = getBigInt(value); }
/**
* The gas price.
*
* On legacy networks this defines the fee that will be paid. On
* EIP-1559 networks, this should be ``null``.
*/
get gasPrice(): null | bigint {
const value = this.#gasPrice;
if (value == null && (this.type === 0 || this.type === 1)) { return BN_0; }
return value;
}
set gasPrice(value: null | BigNumberish) {
this.#gasPrice = (value == null) ? null: getBigInt(value, "gasPrice");
}
/**
* The maximum priority fee per unit of gas to pay. On legacy
* networks this should be ``null``.
*/
get maxPriorityFeePerGas(): null | bigint {
const value = this.#maxPriorityFeePerGas;
if (value == null) {
if (this.type === 2 || this.type === 3) { return BN_0; }
return null;
}
return value;
}
set maxPriorityFeePerGas(value: null | BigNumberish) {
this.#maxPriorityFeePerGas = (value == null) ? null: getBigInt(value, "maxPriorityFeePerGas");
}
/**
* The maximum total fee per unit of gas to pay. On legacy
* networks this should be ``null``.
*/
get maxFeePerGas(): null | bigint {
const value = this.#maxFeePerGas;
if (value == null) {
if (this.type === 2 || this.type === 3) { return BN_0; }
return null;
}
return value;
}
set maxFeePerGas(value: null | BigNumberish) {
this.#maxFeePerGas = (value == null) ? null: getBigInt(value, "maxFeePerGas");
}
/**
* The transaction data. For ``init`` transactions this is the
* deployment code.
*/
get data(): string { return this.#data; }
set data(value: BytesLike) { this.#data = hexlify(value); }
/**
* The amount of ether (in wei) to send in this transactions.
*/
get value(): bigint { return this.#value; }
set value(value: BigNumberish) {
this.#value = getBigInt(value, "value");
}
/**
* The chain ID this transaction is valid on.
*/
get chainId(): bigint { return this.#chainId; }
set chainId(value: BigNumberish) { this.#chainId = getBigInt(value); }
/**
* If signed, the signature for this transaction.
*/