ox
Version:
Ethereum Standard Library
626 lines • 20.4 kB
JavaScript
import * as AccessList from './AccessList.js';
import * as Blobs from './Blobs.js';
import * as Errors from './Errors.js';
import * as Hash from './Hash.js';
import * as Hex from './Hex.js';
import * as Quantity from './internal/quantity.js';
import * as Tx from './internal/tx.js';
import * as Kzg from './Kzg.js';
import * as Rlp from './Rlp.js';
import * as Signature from './Signature.js';
import * as TransactionEnvelope from './TxEnvelope.js';
import * as TxEnvelopeEip1559 from './TxEnvelopeEip1559.js';
/** Current wire `wrapper_version` for the PeerDAS PooledTransactions wrapper. */
export const wrapperVersion = '0x01';
export const serializedType = '0x03';
export const type = 'eip4844';
/**
* Asserts a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844} is valid.
*
* @example
* ```ts twoslash
* import { TxEnvelopeEip4844, Value } from 'ox'
*
* TxEnvelopeEip4844.assert({
* blobVersionedHashes: [],
* chainId: 1,
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
* // @error: EmptyBlobVersionedHashesError: Blob versioned hashes must not be empty.
* ```
*
* @param envelope - The transaction envelope to assert.
*/
export function assert(envelope) {
const { blobVersionedHashes } = envelope;
// EIP-4844 requires at least one versioned blob hash. Treat a missing
// field as an empty list to give callers a single, descriptive error
// rather than a downstream RLP/serialization failure.
if (!blobVersionedHashes || blobVersionedHashes.length === 0)
throw new Blobs.EmptyBlobVersionedHashesError();
for (const hash of blobVersionedHashes) {
const size = Hex.size(hash);
const version = Hex.toNumber(Hex.slice(hash, 0, 1));
if (size !== 32)
throw new Blobs.InvalidVersionedHashSizeError({ hash, size });
if (version !== Kzg.versionedHashVersion)
throw new Blobs.InvalidVersionedHashVersionError({
hash,
version,
});
}
TxEnvelopeEip1559.assert(envelope);
}
/**
* Deserializes a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844} from its serialized form.
*
* @example
* ```ts twoslash
* import { TxEnvelopeEip4844 } from 'ox'
*
* const envelope = TxEnvelopeEip4844.deserialize(
* '0x03ef0182031184773594008477359400809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c0'
* )
* // @log: {
* // @log: blobVersionedHashes: [...],
* // @log: type: 'eip4844',
* // @log: nonce: 785n,
* // @log: maxFeePerGas: 2000000000n,
* // @log: gas: 1000000n,
* // @log: to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* // @log: value: 1000000000000000000n,
* // @log: }
* ```
*
* @param serialized - The serialized transaction.
* @returns Deserialized Transaction Envelope.
*/
export function deserialize(serialized) {
const transactionOrWrapperArray = Rlp.toBytes(Hex.slice(serialized, 1));
// PeerDAS (EIP-7594) PooledTransactions wrapper:
// rlp([tx_body, wrapper_version, blobs, commitments, cell_proofs])
const hasWrapper = transactionOrWrapperArray.length === 5 &&
Array.isArray(transactionOrWrapperArray[0]) &&
!Array.isArray(transactionOrWrapperArray[1]) &&
transactionOrWrapperArray[1] instanceof Uint8Array &&
transactionOrWrapperArray[1].length === 1 &&
transactionOrWrapperArray[1][0] === 0x01;
// Legacy 4-element wrapper (pre-PeerDAS) is no longer accepted.
if (!hasWrapper &&
transactionOrWrapperArray.length === 4 &&
Array.isArray(transactionOrWrapperArray[0]))
throw new LegacyBlobSidecarWrapperError({ serialized });
const transactionArray = (hasWrapper
? transactionOrWrapperArray[0]
: transactionOrWrapperArray);
let wrapperBlobs;
let wrapperCommitments;
let wrapperCellProofs;
if (hasWrapper) {
wrapperBlobs = transactionOrWrapperArray[2];
wrapperCommitments =
transactionOrWrapperArray[3];
wrapperCellProofs =
transactionOrWrapperArray[4];
}
const [chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gas, to, value, data, accessList, maxFeePerBlobGas, blobVersionedHashes, yParity, r, s,] = transactionArray;
if (!(transactionArray.length === 11 || transactionArray.length === 14))
throw new TransactionEnvelope.InvalidSerializedError({
attributes: {
chainId,
nonce,
maxPriorityFeePerGas,
maxFeePerGas,
gas,
to,
value,
data,
accessList,
maxFeePerBlobGas,
blobVersionedHashes,
...(transactionArray.length > 11
? {
yParity,
r,
s,
}
: {}),
},
serialized,
type,
});
let transaction = {
blobVersionedHashes: blobVersionedHashes.map((b) => Tx.bytesToHex(b)),
chainId: Number(Tx.bytesToBigIntOrZero(chainId)),
type,
};
const to_ = Tx.bytesToHexOrUndefined(to);
if (to_)
transaction.to = to_;
const gas_ = Tx.bytesToBigIntOrUndefined(gas);
if (gas_ !== undefined)
transaction.gas = gas_;
const data_ = Tx.bytesToHexOrUndefined(data);
if (data_)
transaction.data = data_;
if (nonce !== undefined)
transaction.nonce = Tx.bytesToBigIntOrZero(nonce);
const value_ = Tx.bytesToBigIntOrUndefined(value);
if (value_ !== undefined)
transaction.value = value_;
const maxFeePerBlobGas_ = Tx.bytesToBigIntOrUndefined(maxFeePerBlobGas);
if (maxFeePerBlobGas_ !== undefined)
transaction.maxFeePerBlobGas = maxFeePerBlobGas_;
const maxFeePerGas_ = Tx.bytesToBigIntOrUndefined(maxFeePerGas);
if (maxFeePerGas_ !== undefined)
transaction.maxFeePerGas = maxFeePerGas_;
const maxPriorityFeePerGas_ = Tx.bytesToBigIntOrUndefined(maxPriorityFeePerGas);
if (maxPriorityFeePerGas_ !== undefined)
transaction.maxPriorityFeePerGas = maxPriorityFeePerGas_;
if (accessList && accessList.length !== 0)
transaction.accessList = AccessList.fromTupleList(Tx.bytesTreeToHex(accessList));
if (hasWrapper) {
const blobs = wrapperBlobs;
const commitments = wrapperCommitments;
const cellProofs = wrapperCellProofs;
// PeerDAS cardinality: one commitment per blob, 128 cell proofs per blob,
// one versioned hash per blob.
if (blobs.length !== commitments.length ||
cellProofs.length !== blobs.length * 128 ||
blobs.length !== transaction.blobVersionedHashes.length)
throw new TransactionEnvelope.InvalidSerializedError({
attributes: {
blobs: blobs.length,
blobVersionedHashes: transaction.blobVersionedHashes.length,
cellProofs: cellProofs.length,
commitments: commitments.length,
},
serialized,
type,
});
transaction.sidecars = {
blobs: blobs.map((b) => Tx.bytesToHex(b)),
commitments: commitments.map((c) => Tx.bytesToHex(c)),
cellProofs: cellProofs.map((p) => Tx.bytesToHex(p)),
};
}
const signature = r && s && yParity
? Signature.fromTuple([
Tx.bytesToHex(yParity),
Tx.bytesToHex(r),
Tx.bytesToHex(s),
])
: undefined;
if (signature)
transaction = {
...transaction,
...signature,
};
assert(transaction);
return transaction;
}
/**
* Converts an arbitrary transaction object into an EIP-4844 Transaction Envelope.
*
* @example
* ```ts twoslash
* // @noErrors
* import { Blobs, TxEnvelopeEip4844, Value } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* chainId: 1,
* blobVersionedHashes,
* maxFeePerBlobGas: Value.fromGwei('3'),
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
* ```
*
* @example
* ### Attaching Signatures
*
* It is possible to attach a `signature` to the transaction envelope.
*
* ```ts twoslash
* // @noErrors
* import {
* Blobs,
* Secp256k1,
* TxEnvelopeEip4844,
* Value
* } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* maxFeePerBlobGas: Value.fromGwei('3'),
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
*
* const signature = Secp256k1.sign({
* payload: TxEnvelopeEip4844.getSignPayload(envelope),
* privateKey: '0x...'
* })
*
* const envelope_signed = TxEnvelopeEip4844.from(envelope, {
* // [!code focus]
* signature // [!code focus]
* }) // [!code focus]
* // @log: {
* // @log: blobVersionedHashes: [...],
* // @log: chainId: 1,
* // @log: maxFeePerBlobGas: 3000000000n,
* // @log: maxFeePerGas: 10000000000n,
* // @log: maxPriorityFeePerGas: 1000000000n,
* // @log: to: '0x0000000000000000000000000000000000000000',
* // @log: type: 'eip4844',
* // @log: value: 1000000000000000000n,
* // @log: r: 125...n,
* // @log: s: 642...n,
* // @log: yParity: 0,
* // @log: }
* ```
*
* @example
* ### From Serialized
*
* It is possible to instantiate an EIP-4844 Transaction Envelope from a {@link ox#TxEnvelopeEip4844.Serialized} value.
*
* ```ts twoslash
* import { TxEnvelopeEip4844 } from 'ox'
*
* const envelope = TxEnvelopeEip4844.from(
* '0x03f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261'
* )
* // @log: {
* // @log: blobVersionedHashes: [...],
* // @log: chainId: 1,
* // @log: maxFeePerGas: 10000000000n,
* // @log: to: '0x0000000000000000000000000000000000000000',
* // @log: type: 'eip4844',
* // @log: value: 1000000000000000000n,
* // @log: }
* ```
*
* @param envelope - The transaction object to convert.
* @param options - Options.
* @returns An EIP-4844 Transaction Envelope.
*/
export function from(envelope, options = {}) {
const { signature } = options;
const envelope_ = (typeof envelope === 'string' ? deserialize(envelope) : envelope);
assert(envelope_);
return {
...envelope_,
...(signature ? Signature.from(signature) : {}),
type: 'eip4844',
};
}
/**
* Returns the payload to sign for a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844}.
*
* @example
* The example below demonstrates how to compute the sign payload which can be used
* with ECDSA signing utilities like {@link ox#Secp256k1.(sign:function)}.
*
* ```ts twoslash
* // @noErrors
* import { Blobs, Secp256k1, TxEnvelopeEip4844 } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* nonce: 0n,
* maxFeePerGas: 1000000000n,
* gas: 21000n,
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: 1000000000000000000n
* })
*
* const payload = TxEnvelopeEip4844.getSignPayload(envelope) // [!code focus]
* // @log: '0x...'
*
* const signature = Secp256k1.sign({
* payload,
* privateKey: '0x...'
* })
* ```
*
* @param envelope - The transaction envelope to get the sign payload for.
* @returns The sign payload.
*/
export function getSignPayload(envelope) {
return hash(envelope, { presign: true });
}
/**
* Hashes a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844}. This is the "transaction hash".
*
* @example
* ```ts twoslash
* // @noErrors
* import { Blobs, TxEnvelopeEip4844 } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* nonce: 0n,
* maxFeePerGas: 1000000000n,
* gas: 21000n,
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: 1000000000000000000n
* })
*
* const hash = TxEnvelopeEip4844.hash(envelope) // [!code focus]
* ```
*
* @param envelope - The EIP-4844 Transaction Envelope to hash.
* @param options - Options.
* @returns The hash of the transaction envelope.
*/
export function hash(envelope, options = {}) {
const { presign } = options;
return Hash.keccak256(serialize({
...envelope,
// Hashing must operate on the bare type-3 envelope, never the
// PeerDAS PooledTransactions network wrapper.
sidecars: undefined,
...(presign
? {
r: undefined,
s: undefined,
yParity: undefined,
v: undefined,
}
: {}),
}));
}
/**
* Serializes a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844}.
*
* @example
* ```ts twoslash
* // @noErrors
* import { Blobs, TxEnvelopeEip4844 } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* maxFeePerGas: Value.fromGwei('10'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
*
* const serialized = TxEnvelopeEip4844.serialize(envelope) // [!code focus]
* ```
*
* @example
* ### Attaching Signatures
*
* It is possible to attach a `signature` to the serialized Transaction Envelope.
*
* ```ts twoslash
* // @noErrors
* import {
* Blobs,
* Secp256k1,
* TxEnvelopeEip4844,
* Value
* } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* maxFeePerBlobGas: Value.fromGwei('3'),
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
*
* const signature = Secp256k1.sign({
* payload: TxEnvelopeEip4844.getSignPayload(envelope),
* privateKey: '0x...'
* })
*
* const serialized = TxEnvelopeEip4844.serialize(envelope, {
* // [!code focus]
* signature // [!code focus]
* }) // [!code focus]
*
* // ... send `serialized` transaction to JSON-RPC `eth_sendRawTransaction`
* ```
*
* @param envelope - The Transaction Envelope to serialize.
* @param options - Options.
* @returns The serialized Transaction Envelope.
*/
export function serialize(envelope, options = {}) {
const { blobVersionedHashes, chainId, gas, nonce, to, value, maxFeePerBlobGas, maxFeePerGas, maxPriorityFeePerGas, accessList, data, input, } = envelope;
assert(envelope);
const accessTupleList = AccessList.toTupleList(accessList);
const signature = Signature.extract(options.signature || envelope);
const serialized = [
Hex.fromNumber(chainId),
Tx.quantityToHex(nonce),
Tx.quantityToHex(maxPriorityFeePerGas),
Tx.quantityToHex(maxFeePerGas),
Tx.quantityToHex(gas),
to ?? '0x',
Tx.quantityToHex(value),
data ?? input ?? '0x',
accessTupleList,
Tx.quantityToHex(maxFeePerBlobGas),
blobVersionedHashes ?? [],
...(signature ? Signature.toTuple(signature) : []),
];
const sidecars = options.sidecars || envelope.sidecars;
if (sidecars) {
// PeerDAS (EIP-7594) PooledTransactions wrapper:
// rlp([tx_body, wrapper_version, blobs, commitments, cell_proofs])
return Hex.concat('0x03', Rlp.fromHex([
serialized,
wrapperVersion,
sidecars.blobs,
sidecars.commitments,
sidecars.cellProofs,
]));
}
return Hex.concat('0x03', Rlp.fromHex(serialized));
}
/**
* Converts an {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844} to an {@link ox#TxEnvelopeEip4844.Rpc}.
*
* @example
* ```ts twoslash
* // @noErrors
* import {
* Blobs,
* RpcRequest,
* TxEnvelopeEip4844,
* Value
* } from 'ox'
* import { kzg } from './kzg'
*
* const blobs = Blobs.from('0xdeadbeef')
* const blobVersionedHashes = Blobs.toVersionedHashes(blobs, {
* kzg
* })
*
* const envelope = TxEnvelopeEip4844.from({
* blobVersionedHashes,
* chainId: 1,
* nonce: 0n,
* gas: 21000n,
* maxFeePerBlobGas: Value.fromGwei('20'),
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: Value.fromEther('1')
* })
*
* const envelope_rpc = TxEnvelopeEip4844.toRpc(envelope) // [!code focus]
*
* const request = RpcRequest.from({
* id: 0,
* method: 'eth_sendTransaction',
* params: [envelope_rpc]
* })
* ```
*
* @param envelope - The EIP-4844 transaction envelope to convert.
* @returns An RPC-formatted EIP-4844 transaction envelope.
*/
export function toRpc(envelope) {
const signature = Signature.extract(envelope);
return {
...envelope,
chainId: Quantity.fromNumberish(envelope.chainId),
data: envelope.data ?? envelope.input,
...(envelope.gas !== undefined
? { gas: Quantity.fromNumberish(envelope.gas) }
: {}),
...(envelope.nonce !== undefined
? { nonce: Quantity.fromNumberish(envelope.nonce) }
: {}),
...(envelope.value !== undefined
? { value: Quantity.fromNumberish(envelope.value) }
: {}),
...(envelope.maxFeePerBlobGas !== undefined
? { maxFeePerBlobGas: Quantity.fromNumberish(envelope.maxFeePerBlobGas) }
: {}),
...(envelope.maxFeePerGas !== undefined
? { maxFeePerGas: Quantity.fromNumberish(envelope.maxFeePerGas) }
: {}),
...(envelope.maxPriorityFeePerGas !== undefined
? {
maxPriorityFeePerGas: Quantity.fromNumberish(envelope.maxPriorityFeePerGas),
}
: {}),
type: '0x3',
...(signature ? Signature.toRpc(signature) : {}),
};
}
/**
* Validates a {@link ox#TxEnvelopeEip4844.TxEnvelopeEip4844}. Returns `true` if the envelope is valid, `false` otherwise.
*
* @example
* ```ts twoslash
* import { TxEnvelopeEip4844, Value } from 'ox'
*
* const valid = TxEnvelopeEip4844.assert({
* blobVersionedHashes: [],
* chainId: 1,
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1')
* })
* // @log: false
* ```
*
* @param envelope - The transaction envelope to validate.
*/
export function validate(envelope) {
try {
assert(envelope);
return true;
}
catch {
return false;
}
}
/**
* Thrown when attempting to deserialize a legacy 4-element EIP-4844 network
* wrapper. Only the PeerDAS (EIP-7594) 5-element wrapper with
* `wrapper_version = 0x01` is accepted.
*/
export class LegacyBlobSidecarWrapperError extends Errors.BaseError {
name = 'TxEnvelopeEip4844.LegacyBlobSidecarWrapperError';
constructor({ serialized }) {
super('Legacy 4-element EIP-4844 blob-sidecar network wrapper is not supported.', {
metaMessages: [
`Serialized Transaction: "${serialized}"`,
'Expected: PeerDAS 5-element wrapper `rlp([tx_body, wrapper_version=0x01, blobs, commitments, cell_proofs])`.',
],
});
}
}
//# sourceMappingURL=TxEnvelopeEip4844.js.map