ethereumjs-monorepo

@ethereumjs/tx


@ethereumjs/tx / Blob4844Tx

Class: Blob4844Tx

Defined in: 4844/tx.ts:51

Typed transaction with a new gas fee market mechanism for transactions that include “blobs” of data

Implements

Constructors

Constructor

new Blob4844Tx(txData, opts): Blob4844Tx

Defined in: 4844/tx.ts:98

This constructor takes the values, validates them, assigns them and freezes the object.

It is not recommended to use this constructor directly. Instead use the static constructors or factory methods to assist in creating a Transaction object from varying data types.

Parameters

txData

BlobEIP4844TxData

opts

TxOptions = {}

Returns

Blob4844Tx

Properties

accessList

readonly accessList: AccessListBytes

Defined in: 4844/tx.ts:60


blobs?

optional blobs: `0x${string}`[]

Defined in: 4844/tx.ts:74


blobVersionedHashes

blobVersionedHashes: `0x${string}`[]

Defined in: 4844/tx.ts:65


cache

readonly cache: TransactionCache = {}

Defined in: 4844/tx.ts:82

Implementation of

TransactionInterface.cache


chainId

readonly chainId: bigint

Defined in: 4844/tx.ts:61


common

readonly common: Common

Defined in: 4844/tx.ts:78

Implementation of

TransactionInterface.common


data

readonly data: Uint8Array

Defined in: 4844/tx.ts:58

Implementation of

TransactionInterface.data


gasLimit

readonly gasLimit: bigint

Defined in: 4844/tx.ts:56

Implementation of

TransactionInterface.gasLimit


kzgCommitments?

optional kzgCommitments: `0x${string}`[]

Defined in: 4844/tx.ts:75


kzgProofs?

optional kzgProofs: `0x${string}`[]

Defined in: 4844/tx.ts:76


maxFeePerBlobGas

readonly maxFeePerBlobGas: bigint

Defined in: 4844/tx.ts:64


maxFeePerGas

readonly maxFeePerGas: bigint

Defined in: 4844/tx.ts:63


maxPriorityFeePerGas

readonly maxPriorityFeePerGas: bigint

Defined in: 4844/tx.ts:62


nonce

readonly nonce: bigint

Defined in: 4844/tx.ts:55

Implementation of

TransactionInterface.nonce


r?

readonly optional r: bigint

Defined in: 4844/tx.ts:69

Implementation of

TransactionInterface.r


s?

readonly optional s: bigint

Defined in: 4844/tx.ts:70

Implementation of

TransactionInterface.s


to?

readonly optional to: Address

Defined in: 4844/tx.ts:59

Implementation of

TransactionInterface.to


txOptions

readonly txOptions: TxOptions

Defined in: 4844/tx.ts:80

Implementation of

TransactionInterface.txOptions


type

type: 3 = TransactionType.BlobEIP4844

Defined in: 4844/tx.ts:52

Implementation of

TransactionInterface.type


v?

readonly optional v: bigint

Defined in: 4844/tx.ts:68

Implementation of

TransactionInterface.v


value

readonly value: bigint

Defined in: 4844/tx.ts:57

Implementation of

TransactionInterface.value

Methods

addSignature()

addSignature(v, r, s): Blob4844Tx

Defined in: 4844/tx.ts:398

Parameters

v

bigint

r
bigint Uint8Array<ArrayBufferLike>
s
bigint Uint8Array<ArrayBufferLike>

Returns

Blob4844Tx

Implementation of

TransactionInterface.addSignature


errorStr()

errorStr(): string

Defined in: 4844/tx.ts:459

Return a compact error string representation of the object

Returns

string

Implementation of

TransactionInterface.errorStr


getDataGas()

getDataGas(): bigint

Defined in: 4844/tx.ts:242

The amount of gas paid for the data in this tx

Returns

bigint

Implementation of

TransactionInterface.getDataGas


getEffectivePriorityFee()

getEffectivePriorityFee(baseFee): bigint

Defined in: 4844/tx.ts:235

Returns the minimum of calculated priority fee (from maxFeePerGas and baseFee) and maxPriorityFeePerGas

Parameters

baseFee

bigint

Base fee retrieved from block

Returns

bigint


getHashedMessageToSign()

getHashedMessageToSign(): Uint8Array

Defined in: 4844/tx.ts:358

Returns the hashed serialized unsigned tx, which can be used to sign the transaction (e.g. for sending to a hardware wallet).

Note: in contrast to the legacy tx the raw message format is already serialized and doesn’t need to be RLP encoded any more.

Returns

Uint8Array

Implementation of

TransactionInterface.getHashedMessageToSign


getIntrinsicGas()

getIntrinsicGas(): bigint

Defined in: 4844/tx.ts:269

The minimum gas limit which the tx to have to be valid. This covers costs as the standard fee (21000 gas), the data fee (paid for each calldata byte), the optional creation fee (if the transaction creates a contract), and if relevant the gas to be paid for access lists (EIP-2930) and authority lists (EIP-7702).

Returns

bigint

Implementation of

TransactionInterface.getIntrinsicGas


getMessageToSign()

getMessageToSign(): Uint8Array

Defined in: 4844/tx.ts:347

Returns the raw serialized unsigned tx, which can be used to sign the transaction (e.g. for sending to a hardware wallet).

Note: in contrast to the legacy tx the raw message format is already serialized and doesn’t need to be RLP encoded any more.

const serializedMessage = tx.getMessageToSign() // use this for the HW wallet input

Returns

Uint8Array

Implementation of

TransactionInterface.getMessageToSign


getMessageToVerifySignature()

getMessageToVerifySignature(): Uint8Array

Defined in: 4844/tx.ts:372

Returns

Uint8Array

Implementation of

TransactionInterface.getMessageToVerifySignature


getSenderAddress()

getSenderAddress(): Address

Defined in: 4844/tx.ts:439

Returns

Address

Implementation of

TransactionInterface.getSenderAddress


getSenderPublicKey()

getSenderPublicKey(): Uint8Array

Defined in: 4844/tx.ts:379

Returns the public key of the sender

Returns

Uint8Array

Implementation of

TransactionInterface.getSenderPublicKey


getUpfrontCost()

getUpfrontCost(baseFee): bigint

Defined in: 4844/tx.ts:250

The up front amount that an account must have for this transaction to be valid

Parameters

baseFee

bigint = BIGINT_0

The base fee of the block (will be set to 0 if not provided)

Returns

bigint

Implementation of

TransactionInterface.getUpfrontCost


getValidationErrors()

getValidationErrors(): string[]

Defined in: 4844/tx.ts:427

Returns

string[]

Implementation of

TransactionInterface.getValidationErrors


hash()

hash(): Uint8Array

Defined in: 4844/tx.ts:368

Computes a sha3-256 hash of the serialized tx.

This method can only be used for signed txs (it throws otherwise). Use Blob4844Tx.getMessageToSign to get a tx hash for the purpose of signing.

Returns

Uint8Array

Implementation of

TransactionInterface.hash


isSigned()

isSigned(): boolean

Defined in: 4844/tx.ts:447

Returns

boolean

Implementation of

TransactionInterface.isSigned


isValid()

isValid(): boolean

Defined in: 4844/tx.ts:431

Returns

boolean

Implementation of

TransactionInterface.isValid


numBlobs()

numBlobs(): number

Defined in: 4844/tx.ts:468

Returns

number

the number of blobs included with this transaction


raw()

raw(): BlobEIP4844TxValuesArray

Defined in: 4844/tx.ts:286

Returns a Uint8Array Array of the raw Bytes of the EIP-4844 transaction, in order.

Format: [chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, to, value, data, access_list, max_fee_per_data_gas, blob_versioned_hashes, y_parity, r, s]`.

Use Blob4844Tx.serialize to add a transaction to a block with createBlockFromBytesArray.

For an unsigned tx this method uses the empty Bytes values for the signature parameters v, r and s for encoding. For an EIP-155 compliant representation for external signing use Blob4844Tx.getMessageToSign.

Returns

BlobEIP4844TxValuesArray

Implementation of

TransactionInterface.raw


serialize()

serialize(): Uint8Array

Defined in: 4844/tx.ts:315

Returns the serialized encoding of the EIP-4844 transaction.

Format: 0x03 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, access_list, max_fee_per_data_gas, blob_versioned_hashes, y_parity, r, s]).

Note that in contrast to the legacy tx serialization format this is not valid RLP any more due to the raw tx type preceding and concatenated to the RLP encoding of the values.

Returns

Uint8Array

Implementation of

TransactionInterface.serialize


serializeNetworkWrapper()

serializeNetworkWrapper(): Uint8Array

Defined in: 4844/tx.ts:322

Returns

Uint8Array

the serialized form of a blob transaction in the network wrapper format (used for gossipping mempool transactions over devp2p)


sign()

sign(privateKey, extraEntropy): Blob4844Tx

Defined in: 4844/tx.ts:443

Parameters

privateKey

Uint8Array

extraEntropy
boolean Uint8Array<ArrayBufferLike>

Returns

Blob4844Tx

Implementation of

TransactionInterface.sign


supports()

supports(capability): boolean

Defined in: 4844/tx.ts:227

Checks if a tx type defining capability is active on a tx, for example the EIP-1559 fee market mechanism or the EIP-2930 access list feature.

Note that this is different from the tx type itself, so EIP-2930 access lists can very well be active on an EIP-1559 tx for example.

This method can be useful for feature checks if the tx type is unknown (e.g. when instantiated with the tx factory).

See Capabilities in the types module for a reference on all supported capabilities.

Parameters

capability

number

Returns

boolean

Implementation of

TransactionInterface.supports


toCreationAddress()

toCreationAddress(): boolean

Defined in: 4844/tx.ts:259

If the tx’s to is to the creation address

Returns

boolean

Implementation of

TransactionInterface.toCreationAddress


toJSON()

toJSON(): JSONTx

Defined in: 4844/tx.ts:383

Returns

JSONTx

Implementation of

TransactionInterface.toJSON


verifySignature()

verifySignature(): boolean

Defined in: 4844/tx.ts:435

Returns

boolean

Implementation of

TransactionInterface.verifySignature