ethereumjs-monorepo

@ethereumjs/tx

@ethereumjs/tx / FeeMarket1559Tx

Class: FeeMarket1559Tx

Defined in: 1559/tx.ts:43

Typed transaction with a new gas fee market mechanism

TransactionType: 2
EIP: EIP-1559

Implements

TransactionInterface<typeof FeeMarketEIP1559>

Constructors

Constructor

new FeeMarket1559Tx(txData, opts): FeeMarket1559Tx

Defined in: 1559/tx.ts:87

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 factory methods to assist in creating a Transaction object from varying data types.

Parameters

txData

FeeMarketEIP1559TxData

opts

TxOptions = {}

Returns

FeeMarket1559Tx

Properties

accessList

readonly accessList: AccessListBytes

Defined in: 1559/tx.ts:55

cache

readonly cache: TransactionCache = {}

Defined in: 1559/tx.ts:71

Implementation of

TransactionInterface.cache

chainId

readonly chainId: bigint

Defined in: 1559/tx.ts:56

common

readonly common: Common

Defined in: 1559/tx.ts:67

Implementation of

TransactionInterface.common

data

readonly data: Uint8Array

Defined in: 1559/tx.ts:53

Implementation of

TransactionInterface.data

gasLimit

readonly gasLimit: bigint

Defined in: 1559/tx.ts:51

Implementation of

TransactionInterface.gasLimit

maxFeePerGas

readonly maxFeePerGas: bigint

Defined in: 1559/tx.ts:58

maxPriorityFeePerGas

readonly maxPriorityFeePerGas: bigint

Defined in: 1559/tx.ts:57

nonce

readonly nonce: bigint

Defined in: 1559/tx.ts:50

Implementation of

TransactionInterface.nonce

r?

readonly optional r: bigint

Defined in: 1559/tx.ts:62

Implementation of

TransactionInterface.r

s?

readonly optional s: bigint

Defined in: 1559/tx.ts:63

Implementation of

TransactionInterface.s

to?

readonly optional to: Address

Defined in: 1559/tx.ts:54

Implementation of

TransactionInterface.to

txOptions

readonly txOptions: TxOptions

Defined in: 1559/tx.ts:69

Implementation of

TransactionInterface.txOptions

type

type: 2 = TransactionType.FeeMarketEIP1559

Defined in: 1559/tx.ts:47

Implementation of

TransactionInterface.type

v?

readonly optional v: bigint

Defined in: 1559/tx.ts:61

Implementation of

TransactionInterface.v

value

readonly value: bigint

Defined in: 1559/tx.ts:52

Implementation of

TransactionInterface.value

Methods

addSignature()

addSignature(v, r, s): FeeMarket1559Tx

Defined in: 1559/tx.ts:309

Adds signature values and returns a new EIP-1559 transaction instance.

Parameters

v

bigint

Recovery parameter (y-parity)

r

Signature r value

bigint Uint8Array<ArrayBufferLike>

s

Signature s value

bigint Uint8Array<ArrayBufferLike>

Returns

FeeMarket1559Tx

Newly created transaction that includes the signature

Implementation of

TransactionInterface.addSignature

errorStr()

errorStr(): string

Defined in: 1559/tx.ts:408

Return a compact error string representation of the object

Returns

string

Human-readable error summary

Implementation of

TransactionInterface.errorStr

getDataGas()

getDataGas(): bigint

Defined in: 1559/tx.ts:165

The amount of gas paid for the data in this tx

Returns

bigint

Implementation of

TransactionInterface.getDataGas

getEffectivePriorityFee()

getEffectivePriorityFee(baseFee): bigint

Defined in: 1559/tx.ts:173

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: 1559/tx.ts:271

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

Keccak hash of the unsigned transaction payload

Implementation of

TransactionInterface.getHashedMessageToSign

getIntrinsicGas()

getIntrinsicGas(): bigint

Defined in: 1559/tx.ts:191

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: 1559/tx.ts:259

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

Serialized unsigned transaction payload

Implementation of

TransactionInterface.getMessageToSign

getMessageToVerifySignature()

getMessageToVerifySignature(): Uint8Array

Defined in: 1559/tx.ts:290

Computes a sha3-256 hash which can be used to verify the signature

Returns

Uint8Array

Hash used when verifying the signature

Implementation of

TransactionInterface.getMessageToVerifySignature

getSenderAddress()

getSenderAddress(): Address

Defined in: 1559/tx.ts:377

Recovers the sender address from the signature.

Returns

Address

Sender Address

Implementation of

TransactionInterface.getSenderAddress

getSenderPublicKey()

getSenderPublicKey(): Uint8Array

Defined in: 1559/tx.ts:298

Returns the public key of the sender

Returns

Uint8Array

Sender public key

Implementation of

TransactionInterface.getSenderPublicKey

getUpfrontCost()

getUpfrontCost(baseFee): bigint

Defined in: 1559/tx.ts:181

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: 1559/tx.ts:354

Runs validation logic and returns encountered errors, if any.

Returns

string[]

Array of validation error messages.

Implementation of

TransactionInterface.getValidationErrors

hash()

hash(): Uint8Array

Defined in: 1559/tx.ts:282

Computes a sha3-256 hash of the serialized tx.

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

Returns

Uint8Array

Hash of the serialized signed transaction

Implementation of

TransactionInterface.hash

isSigned()

isSigned(): boolean

Defined in: 1559/tx.ts:395

Reports whether the transaction already contains v, r, and s.

Returns

boolean

true if signature parts are present

Implementation of

TransactionInterface.isSigned

isValid()

isValid(): boolean

Defined in: 1559/tx.ts:361

Returns

boolean

true if the transaction passes validation

Implementation of

TransactionInterface.isValid

raw()

raw(): FeeMarketEIP1559TxValuesArray

Defined in: 1559/tx.ts:216

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

Format: [chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, accessList, signatureYParity, signatureR, signatureS]

Use FeeMarket1559Tx.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 FeeMarket1559Tx.getMessageToSign.

Returns

FeeMarketEIP1559TxValuesArray

Implementation of

TransactionInterface.raw

serialize()

serialize(): Uint8Array

Defined in: 1559/tx.ts:243

Returns the serialized encoding of the EIP-1559 transaction.

Format: 0x02 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, accessList, signatureYParity, signatureR, signatureS])

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.