123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985 |
- "use strict";
- Object.defineProperty(exports, "__esModule", { value: true });
- exports.Transaction = void 0;
- const index_js_1 = require("../address/index.js");
- const addresses_js_1 = require("../constants/addresses.js");
- const index_js_2 = require("../crypto/index.js");
- const index_js_3 = require("../utils/index.js");
- const accesslist_js_1 = require("./accesslist.js");
- const address_js_1 = require("./address.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 BLOB_SIZE = 4096 * 32;
- function getVersionedHash(version, hash) {
- let versioned = version.toString(16);
- while (versioned.length < 2) {
- versioned = "0" + versioned;
- }
- versioned += (0, index_js_2.sha256)(hash).substring(4);
- return "0x" + versioned;
- }
- function handleAddress(value) {
- if (value === "0x") {
- return null;
- }
- return (0, index_js_1.getAddress)(value);
- }
- function handleAccessList(value, param) {
- try {
- return (0, accesslist_js_1.accessListify)(value);
- }
- catch (error) {
- (0, index_js_3.assertArgument)(false, error.message, param, value);
- }
- }
- function handleNumber(_value, param) {
- if (_value === "0x") {
- return 0;
- }
- return (0, index_js_3.getNumber)(_value, param);
- }
- function handleUint(_value, param) {
- if (_value === "0x") {
- return BN_0;
- }
- const value = (0, index_js_3.getBigInt)(_value, param);
- (0, index_js_3.assertArgument)(value <= BN_MAX_UINT, "value exceeds uint size", param, value);
- return value;
- }
- function formatNumber(_value, name) {
- const value = (0, index_js_3.getBigInt)(_value, "value");
- const result = (0, index_js_3.toBeArray)(value);
- (0, index_js_3.assertArgument)(result.length <= 32, `value too large`, `tx.${name}`, value);
- return result;
- }
- function formatAccessList(value) {
- return (0, accesslist_js_1.accessListify)(value).map((set) => [set.address, set.storageKeys]);
- }
- function formatHashes(value, param) {
- (0, index_js_3.assertArgument)(Array.isArray(value), `invalid ${param}`, "value", value);
- for (let i = 0; i < value.length; i++) {
- (0, index_js_3.assertArgument)((0, index_js_3.isHexString)(value[i], 32), "invalid ${ param } hash", `value[${i}]`, value[i]);
- }
- return value;
- }
- function _parseLegacy(data) {
- const fields = (0, index_js_3.decodeRlp)(data);
- (0, index_js_3.assertArgument)(Array.isArray(fields) && (fields.length === 9 || fields.length === 6), "invalid field count for legacy transaction", "data", data);
- const tx = {
- 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: (0, index_js_3.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
- (0, index_js_3.assertArgument)(chainId !== BN_0 || (v === BN_27 || v === BN_28), "non-canonical legacy v", "v", fields[6]);
- tx.signature = index_js_2.Signature.from({
- r: (0, index_js_3.zeroPadValue)(fields[7], 32),
- s: (0, index_js_3.zeroPadValue)(fields[8], 32),
- v
- });
- //tx.hash = keccak256(data);
- }
- return tx;
- }
- function _serializeLegacy(tx, sig) {
- const fields = [
- 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 = (0, index_js_3.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
- (0, index_js_3.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((0, index_js_3.toBeArray)(chainId));
- fields.push("0x");
- fields.push("0x");
- }
- return (0, index_js_3.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 = index_js_2.Signature.getChainIdV(chainId, sig.v);
- }
- else if (BigInt(sig.v) !== v) {
- (0, index_js_3.assertArgument)(false, "tx.chainId/sig.v mismatch", "sig", sig);
- }
- // Add the signature
- fields.push((0, index_js_3.toBeArray)(v));
- fields.push((0, index_js_3.toBeArray)(sig.r));
- fields.push((0, index_js_3.toBeArray)(sig.s));
- return (0, index_js_3.encodeRlp)(fields);
- }
- function _parseEipSignature(tx, fields) {
- let yParity;
- try {
- yParity = handleNumber(fields[0], "yParity");
- if (yParity !== 0 && yParity !== 1) {
- throw new Error("bad yParity");
- }
- }
- catch (error) {
- (0, index_js_3.assertArgument)(false, "invalid yParity", "yParity", fields[0]);
- }
- const r = (0, index_js_3.zeroPadValue)(fields[1], 32);
- const s = (0, index_js_3.zeroPadValue)(fields[2], 32);
- const signature = index_js_2.Signature.from({ r, s, yParity });
- tx.signature = signature;
- }
- function _parseEip1559(data) {
- const fields = (0, index_js_3.decodeRlp)((0, index_js_3.getBytes)(data).slice(1));
- (0, index_js_3.assertArgument)(Array.isArray(fields) && (fields.length === 9 || fields.length === 12), "invalid field count for transaction type: 2", "data", (0, index_js_3.hexlify)(data));
- const tx = {
- 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: (0, index_js_3.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, sig) {
- const fields = [
- 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((0, index_js_3.toBeArray)(sig.r));
- fields.push((0, index_js_3.toBeArray)(sig.s));
- }
- return (0, index_js_3.concat)(["0x02", (0, index_js_3.encodeRlp)(fields)]);
- }
- function _parseEip2930(data) {
- const fields = (0, index_js_3.decodeRlp)((0, index_js_3.getBytes)(data).slice(1));
- (0, index_js_3.assertArgument)(Array.isArray(fields) && (fields.length === 8 || fields.length === 11), "invalid field count for transaction type: 1", "data", (0, index_js_3.hexlify)(data));
- const tx = {
- 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: (0, index_js_3.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, sig) {
- const fields = [
- 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((0, index_js_3.toBeArray)(sig.r));
- fields.push((0, index_js_3.toBeArray)(sig.s));
- }
- return (0, index_js_3.concat)(["0x01", (0, index_js_3.encodeRlp)(fields)]);
- }
- function _parseEip4844(data) {
- let fields = (0, index_js_3.decodeRlp)((0, index_js_3.getBytes)(data).slice(1));
- let typeName = "3";
- let blobs = null;
- // Parse the network format
- if (fields.length === 4 && Array.isArray(fields[0])) {
- typeName = "3 (network format)";
- const fBlobs = fields[1], fCommits = fields[2], fProofs = fields[3];
- (0, index_js_3.assertArgument)(Array.isArray(fBlobs), "invalid network format: blobs not an array", "fields[1]", fBlobs);
- (0, index_js_3.assertArgument)(Array.isArray(fCommits), "invalid network format: commitments not an array", "fields[2]", fCommits);
- (0, index_js_3.assertArgument)(Array.isArray(fProofs), "invalid network format: proofs not an array", "fields[3]", fProofs);
- (0, index_js_3.assertArgument)(fBlobs.length === fCommits.length, "invalid network format: blobs/commitments length mismatch", "fields", fields);
- (0, index_js_3.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];
- }
- (0, index_js_3.assertArgument)(Array.isArray(fields) && (fields.length === 11 || fields.length === 14), `invalid field count for transaction type: ${typeName}`, "data", (0, index_js_3.hexlify)(data));
- const tx = {
- 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: (0, index_js_3.hexlify)(fields[7]),
- accessList: handleAccessList(fields[8], "accessList"),
- maxFeePerBlobGas: handleUint(fields[9], "maxFeePerBlobGas"),
- blobVersionedHashes: fields[10]
- };
- if (blobs) {
- tx.blobs = blobs;
- }
- (0, index_js_3.assertArgument)(tx.to != null, `invalid address for transaction type: ${typeName}`, "data", data);
- (0, index_js_3.assertArgument)(Array.isArray(tx.blobVersionedHashes), "invalid blobVersionedHashes: must be an array", "data", data);
- for (let i = 0; i < tx.blobVersionedHashes.length; i++) {
- (0, index_js_3.assertArgument)((0, index_js_3.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, sig, blobs) {
- const fields = [
- formatNumber(tx.chainId, "chainId"),
- formatNumber(tx.nonce, "nonce"),
- formatNumber(tx.maxPriorityFeePerGas || 0, "maxPriorityFeePerGas"),
- formatNumber(tx.maxFeePerGas || 0, "maxFeePerGas"),
- formatNumber(tx.gasLimit, "gasLimit"),
- (tx.to || addresses_js_1.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((0, index_js_3.toBeArray)(sig.r));
- fields.push((0, index_js_3.toBeArray)(sig.s));
- // We have blobs; return the network wrapped format
- if (blobs) {
- return (0, index_js_3.concat)([
- "0x03",
- (0, index_js_3.encodeRlp)([
- fields,
- blobs.map((b) => b.data),
- blobs.map((b) => b.commitment),
- blobs.map((b) => b.proof),
- ])
- ]);
- }
- }
- return (0, index_js_3.concat)(["0x03", (0, index_js_3.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:
- */
- class Transaction {
- #type;
- #to;
- #data;
- #nonce;
- #gasLimit;
- #gasPrice;
- #maxPriorityFeePerGas;
- #maxFeePerGas;
- #value;
- #chainId;
- #sig;
- #accessList;
- #maxFeePerBlobGas;
- #blobVersionedHashes;
- #kzg;
- #blobs;
- /**
- * The transaction type.
- *
- * If null, the type will be automatically inferred based on
- * explicit properties.
- */
- get type() { return this.#type; }
- set type(value) {
- 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;
- default:
- (0, index_js_3.assertArgument)(false, "unsupported transaction type", "type", value);
- }
- }
- /**
- * The name of the transaction type.
- */
- get typeName() {
- switch (this.type) {
- case 0: return "legacy";
- case 1: return "eip-2930";
- case 2: return "eip-1559";
- case 3: return "eip-4844";
- }
- return null;
- }
- /**
- * The ``to`` address for the transaction or ``null`` if the
- * transaction is an ``init`` transaction.
- */
- get to() {
- const value = this.#to;
- if (value == null && this.type === 3) {
- return addresses_js_1.ZeroAddress;
- }
- return value;
- }
- set to(value) {
- this.#to = (value == null) ? null : (0, index_js_1.getAddress)(value);
- }
- /**
- * The transaction nonce.
- */
- get nonce() { return this.#nonce; }
- set nonce(value) { this.#nonce = (0, index_js_3.getNumber)(value, "value"); }
- /**
- * The gas limit.
- */
- get gasLimit() { return this.#gasLimit; }
- set gasLimit(value) { this.#gasLimit = (0, index_js_3.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() {
- const value = this.#gasPrice;
- if (value == null && (this.type === 0 || this.type === 1)) {
- return BN_0;
- }
- return value;
- }
- set gasPrice(value) {
- this.#gasPrice = (value == null) ? null : (0, index_js_3.getBigInt)(value, "gasPrice");
- }
- /**
- * The maximum priority fee per unit of gas to pay. On legacy
- * networks this should be ``null``.
- */
- get maxPriorityFeePerGas() {
- const value = this.#maxPriorityFeePerGas;
- if (value == null) {
- if (this.type === 2 || this.type === 3) {
- return BN_0;
- }
- return null;
- }
- return value;
- }
- set maxPriorityFeePerGas(value) {
- this.#maxPriorityFeePerGas = (value == null) ? null : (0, index_js_3.getBigInt)(value, "maxPriorityFeePerGas");
- }
- /**
- * The maximum total fee per unit of gas to pay. On legacy
- * networks this should be ``null``.
- */
- get maxFeePerGas() {
- const value = this.#maxFeePerGas;
- if (value == null) {
- if (this.type === 2 || this.type === 3) {
- return BN_0;
- }
- return null;
- }
- return value;
- }
- set maxFeePerGas(value) {
- this.#maxFeePerGas = (value == null) ? null : (0, index_js_3.getBigInt)(value, "maxFeePerGas");
- }
- /**
- * The transaction data. For ``init`` transactions this is the
- * deployment code.
- */
- get data() { return this.#data; }
- set data(value) { this.#data = (0, index_js_3.hexlify)(value); }
- /**
- * The amount of ether (in wei) to send in this transactions.
- */
- get value() { return this.#value; }
- set value(value) {
- this.#value = (0, index_js_3.getBigInt)(value, "value");
- }
- /**
- * The chain ID this transaction is valid on.
- */
- get chainId() { return this.#chainId; }
- set chainId(value) { this.#chainId = (0, index_js_3.getBigInt)(value); }
- /**
- * If signed, the signature for this transaction.
- */
- get signature() { return this.#sig || null; }
- set signature(value) {
- this.#sig = (value == null) ? null : index_js_2.Signature.from(value);
- }
- /**
- * The access list.
- *
- * An access list permits discounted (but pre-paid) access to
- * bytecode and state variable access within contract execution.
- */
- get accessList() {
- const value = this.#accessList || null;
- if (value == null) {
- if (this.type === 1 || this.type === 2 || this.type === 3) {
- // @TODO: in v7, this should assign the value or become
- // a live object itself, otherwise mutation is inconsistent
- return [];
- }
- return null;
- }
- return value;
- }
- set accessList(value) {
- this.#accessList = (value == null) ? null : (0, accesslist_js_1.accessListify)(value);
- }
- /**
- * The max fee per blob gas for Cancun transactions.
- */
- get maxFeePerBlobGas() {
- const value = this.#maxFeePerBlobGas;
- if (value == null && this.type === 3) {
- return BN_0;
- }
- return value;
- }
- set maxFeePerBlobGas(value) {
- this.#maxFeePerBlobGas = (value == null) ? null : (0, index_js_3.getBigInt)(value, "maxFeePerBlobGas");
- }
- /**
- * The BLOb versioned hashes for Cancun transactions.
- */
- get blobVersionedHashes() {
- // @TODO: Mutation is inconsistent; if unset, the returned value
- // cannot mutate the object, if set it can
- let value = this.#blobVersionedHashes;
- if (value == null && this.type === 3) {
- return [];
- }
- return value;
- }
- set blobVersionedHashes(value) {
- if (value != null) {
- (0, index_js_3.assertArgument)(Array.isArray(value), "blobVersionedHashes must be an Array", "value", value);
- value = value.slice();
- for (let i = 0; i < value.length; i++) {
- (0, index_js_3.assertArgument)((0, index_js_3.isHexString)(value[i], 32), "invalid blobVersionedHash", `value[${i}]`, value[i]);
- }
- }
- this.#blobVersionedHashes = value;
- }
- /**
- * The BLObs for the Transaction, if any.
- *
- * If ``blobs`` is non-``null``, then the [[seriailized]]
- * will return the network formatted sidecar, otherwise it
- * will return the standard [[link-eip-2718]] payload. The
- * [[unsignedSerialized]] is unaffected regardless.
- *
- * When setting ``blobs``, either fully valid [[Blob]] objects
- * may be specified (i.e. correctly padded, with correct
- * committments and proofs) or a raw [[BytesLike]] may
- * be provided.
- *
- * If raw [[BytesLike]] are provided, the [[kzg]] property **must**
- * be already set. The blob will be correctly padded and the
- * [[KzgLibrary]] will be used to compute the committment and
- * proof for the blob.
- *
- * A BLOb is a sequence of field elements, each of which must
- * be within the BLS field modulo, so some additional processing
- * may be required to encode arbitrary data to ensure each 32 byte
- * field is within the valid range.
- *
- * Setting this automatically populates [[blobVersionedHashes]],
- * overwriting any existing values. Setting this to ``null``
- * does **not** remove the [[blobVersionedHashes]], leaving them
- * present.
- */
- get blobs() {
- if (this.#blobs == null) {
- return null;
- }
- return this.#blobs.map((b) => Object.assign({}, b));
- }
- set blobs(_blobs) {
- if (_blobs == null) {
- this.#blobs = null;
- return;
- }
- const blobs = [];
- const versionedHashes = [];
- for (let i = 0; i < _blobs.length; i++) {
- const blob = _blobs[i];
- if ((0, index_js_3.isBytesLike)(blob)) {
- (0, index_js_3.assert)(this.#kzg, "adding a raw blob requires a KZG library", "UNSUPPORTED_OPERATION", {
- operation: "set blobs()"
- });
- let data = (0, index_js_3.getBytes)(blob);
- (0, index_js_3.assertArgument)(data.length <= BLOB_SIZE, "blob is too large", `blobs[${i}]`, blob);
- // Pad blob if necessary
- if (data.length !== BLOB_SIZE) {
- const padded = new Uint8Array(BLOB_SIZE);
- padded.set(data);
- data = padded;
- }
- const commit = this.#kzg.blobToKzgCommitment(data);
- const proof = (0, index_js_3.hexlify)(this.#kzg.computeBlobKzgProof(data, commit));
- blobs.push({
- data: (0, index_js_3.hexlify)(data),
- commitment: (0, index_js_3.hexlify)(commit),
- proof
- });
- versionedHashes.push(getVersionedHash(1, commit));
- }
- else {
- const commit = (0, index_js_3.hexlify)(blob.commitment);
- blobs.push({
- data: (0, index_js_3.hexlify)(blob.data),
- commitment: commit,
- proof: (0, index_js_3.hexlify)(blob.proof)
- });
- versionedHashes.push(getVersionedHash(1, commit));
- }
- }
- this.#blobs = blobs;
- this.#blobVersionedHashes = versionedHashes;
- }
- get kzg() { return this.#kzg; }
- set kzg(kzg) {
- this.#kzg = kzg;
- }
- /**
- * Creates a new Transaction with default values.
- */
- constructor() {
- this.#type = null;
- this.#to = null;
- this.#nonce = 0;
- this.#gasLimit = BN_0;
- this.#gasPrice = null;
- this.#maxPriorityFeePerGas = null;
- this.#maxFeePerGas = null;
- this.#data = "0x";
- this.#value = BN_0;
- this.#chainId = BN_0;
- this.#sig = null;
- this.#accessList = null;
- this.#maxFeePerBlobGas = null;
- this.#blobVersionedHashes = null;
- this.#blobs = null;
- this.#kzg = null;
- }
- /**
- * The transaction hash, if signed. Otherwise, ``null``.
- */
- get hash() {
- if (this.signature == null) {
- return null;
- }
- return (0, index_js_2.keccak256)(this.#getSerialized(true, false));
- }
- /**
- * The pre-image hash of this transaction.
- *
- * This is the digest that a [[Signer]] must sign to authorize
- * this transaction.
- */
- get unsignedHash() {
- return (0, index_js_2.keccak256)(this.unsignedSerialized);
- }
- /**
- * The sending address, if signed. Otherwise, ``null``.
- */
- get from() {
- if (this.signature == null) {
- return null;
- }
- return (0, address_js_1.recoverAddress)(this.unsignedHash, this.signature);
- }
- /**
- * The public key of the sender, if signed. Otherwise, ``null``.
- */
- get fromPublicKey() {
- if (this.signature == null) {
- return null;
- }
- return index_js_2.SigningKey.recoverPublicKey(this.unsignedHash, this.signature);
- }
- /**
- * Returns true if signed.
- *
- * This provides a Type Guard that properties requiring a signed
- * transaction are non-null.
- */
- isSigned() {
- return this.signature != null;
- }
- #getSerialized(signed, sidecar) {
- (0, index_js_3.assert)(!signed || this.signature != null, "cannot serialize unsigned transaction; maybe you meant .unsignedSerialized", "UNSUPPORTED_OPERATION", { operation: ".serialized" });
- const sig = signed ? this.signature : null;
- switch (this.inferType()) {
- case 0:
- return _serializeLegacy(this, sig);
- case 1:
- return _serializeEip2930(this, sig);
- case 2:
- return _serializeEip1559(this, sig);
- case 3:
- return _serializeEip4844(this, sig, sidecar ? this.blobs : null);
- }
- (0, index_js_3.assert)(false, "unsupported transaction type", "UNSUPPORTED_OPERATION", { operation: ".serialized" });
- }
- /**
- * The serialized transaction.
- *
- * This throws if the transaction is unsigned. For the pre-image,
- * use [[unsignedSerialized]].
- */
- get serialized() {
- return this.#getSerialized(true, true);
- }
- /**
- * The transaction pre-image.
- *
- * The hash of this is the digest which needs to be signed to
- * authorize this transaction.
- */
- get unsignedSerialized() {
- return this.#getSerialized(false, false);
- }
- /**
- * Return the most "likely" type; currently the highest
- * supported transaction type.
- */
- inferType() {
- const types = this.inferTypes();
- // Prefer London (EIP-1559) over Cancun (BLOb)
- if (types.indexOf(2) >= 0) {
- return 2;
- }
- // Return the highest inferred type
- return (types.pop());
- }
- /**
- * Validates the explicit properties and returns a list of compatible
- * transaction types.
- */
- inferTypes() {
- // Checks that there are no conflicting properties set
- const hasGasPrice = this.gasPrice != null;
- const hasFee = (this.maxFeePerGas != null || this.maxPriorityFeePerGas != null);
- const hasAccessList = (this.accessList != null);
- const hasBlob = (this.#maxFeePerBlobGas != null || this.#blobVersionedHashes);
- //if (hasGasPrice && hasFee) {
- // throw new Error("transaction cannot have gasPrice and maxFeePerGas");
- //}
- if (this.maxFeePerGas != null && this.maxPriorityFeePerGas != null) {
- (0, index_js_3.assert)(this.maxFeePerGas >= this.maxPriorityFeePerGas, "priorityFee cannot be more than maxFee", "BAD_DATA", { value: this });
- }
- //if (this.type === 2 && hasGasPrice) {
- // throw new Error("eip-1559 transaction cannot have gasPrice");
- //}
- (0, index_js_3.assert)(!hasFee || (this.type !== 0 && this.type !== 1), "transaction type cannot have maxFeePerGas or maxPriorityFeePerGas", "BAD_DATA", { value: this });
- (0, index_js_3.assert)(this.type !== 0 || !hasAccessList, "legacy transaction cannot have accessList", "BAD_DATA", { value: this });
- const types = [];
- // Explicit type
- if (this.type != null) {
- types.push(this.type);
- }
- else {
- if (hasFee) {
- types.push(2);
- }
- else if (hasGasPrice) {
- types.push(1);
- if (!hasAccessList) {
- types.push(0);
- }
- }
- else if (hasAccessList) {
- types.push(1);
- types.push(2);
- }
- else if (hasBlob && this.to) {
- types.push(3);
- }
- else {
- types.push(0);
- types.push(1);
- types.push(2);
- types.push(3);
- }
- }
- types.sort();
- return types;
- }
- /**
- * Returns true if this transaction is a legacy transaction (i.e.
- * ``type === 0``).
- *
- * This provides a Type Guard that the related properties are
- * non-null.
- */
- isLegacy() {
- return (this.type === 0);
- }
- /**
- * Returns true if this transaction is berlin hardform transaction (i.e.
- * ``type === 1``).
- *
- * This provides a Type Guard that the related properties are
- * non-null.
- */
- isBerlin() {
- return (this.type === 1);
- }
- /**
- * Returns true if this transaction is london hardform transaction (i.e.
- * ``type === 2``).
- *
- * This provides a Type Guard that the related properties are
- * non-null.
- */
- isLondon() {
- return (this.type === 2);
- }
- /**
- * Returns true if this transaction is an [[link-eip-4844]] BLOB
- * transaction.
- *
- * This provides a Type Guard that the related properties are
- * non-null.
- */
- isCancun() {
- return (this.type === 3);
- }
- /**
- * Create a copy of this transaciton.
- */
- clone() {
- return Transaction.from(this);
- }
- /**
- * Return a JSON-friendly object.
- */
- toJSON() {
- const s = (v) => {
- if (v == null) {
- return null;
- }
- return v.toString();
- };
- return {
- type: this.type,
- to: this.to,
- // from: this.from,
- data: this.data,
- nonce: this.nonce,
- gasLimit: s(this.gasLimit),
- gasPrice: s(this.gasPrice),
- maxPriorityFeePerGas: s(this.maxPriorityFeePerGas),
- maxFeePerGas: s(this.maxFeePerGas),
- value: s(this.value),
- chainId: s(this.chainId),
- sig: this.signature ? this.signature.toJSON() : null,
- accessList: this.accessList
- };
- }
- /**
- * Create a **Transaction** from a serialized transaction or a
- * Transaction-like object.
- */
- static from(tx) {
- if (tx == null) {
- return new Transaction();
- }
- if (typeof (tx) === "string") {
- const payload = (0, index_js_3.getBytes)(tx);
- if (payload[0] >= 0x7f) { // @TODO: > vs >= ??
- return Transaction.from(_parseLegacy(payload));
- }
- switch (payload[0]) {
- case 1: return Transaction.from(_parseEip2930(payload));
- case 2: return Transaction.from(_parseEip1559(payload));
- case 3: return Transaction.from(_parseEip4844(payload));
- }
- (0, index_js_3.assert)(false, "unsupported transaction type", "UNSUPPORTED_OPERATION", { operation: "from" });
- }
- const result = new Transaction();
- if (tx.type != null) {
- result.type = tx.type;
- }
- if (tx.to != null) {
- result.to = tx.to;
- }
- if (tx.nonce != null) {
- result.nonce = tx.nonce;
- }
- if (tx.gasLimit != null) {
- result.gasLimit = tx.gasLimit;
- }
- if (tx.gasPrice != null) {
- result.gasPrice = tx.gasPrice;
- }
- if (tx.maxPriorityFeePerGas != null) {
- result.maxPriorityFeePerGas = tx.maxPriorityFeePerGas;
- }
- if (tx.maxFeePerGas != null) {
- result.maxFeePerGas = tx.maxFeePerGas;
- }
- if (tx.maxFeePerBlobGas != null) {
- result.maxFeePerBlobGas = tx.maxFeePerBlobGas;
- }
- if (tx.data != null) {
- result.data = tx.data;
- }
- if (tx.value != null) {
- result.value = tx.value;
- }
- if (tx.chainId != null) {
- result.chainId = tx.chainId;
- }
- if (tx.signature != null) {
- result.signature = index_js_2.Signature.from(tx.signature);
- }
- if (tx.accessList != null) {
- result.accessList = tx.accessList;
- }
- // This will get overwritten by blobs, if present
- if (tx.blobVersionedHashes != null) {
- result.blobVersionedHashes = tx.blobVersionedHashes;
- }
- // Make sure we assign the kzg before assigning blobs, which
- // require the library in the event raw blob data is provided.
- if (tx.kzg != null) {
- result.kzg = tx.kzg;
- }
- if (tx.blobs != null) {
- result.blobs = tx.blobs;
- }
- if (tx.hash != null) {
- (0, index_js_3.assertArgument)(result.isSigned(), "unsigned transaction cannot define '.hash'", "tx", tx);
- (0, index_js_3.assertArgument)(result.hash === tx.hash, "hash mismatch", "tx", tx);
- }
- if (tx.from != null) {
- (0, index_js_3.assertArgument)(result.isSigned(), "unsigned transaction cannot define '.from'", "tx", tx);
- (0, index_js_3.assertArgument)(result.from.toLowerCase() === (tx.from || "").toLowerCase(), "from mismatch", "tx", tx);
- }
- return result;
- }
- }
- exports.Transaction = Transaction;
- //# sourceMappingURL=transaction.js.map
|