ethereumjs-monorepo

Class: Block

Class representing a block in the Ethereum network. The BlockHeader has its own class and can be used independently, for a block it is included in the form of the Block.header property.

A block object can be created with one of the following constructor methods (separate from the Block class to allow for tree shaking):

Constructors

Constructor

new Block(header?, transactions?, uncleHeaders?, withdrawals?, opts?): Block

Defined in: block/block.ts:76

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

Parameters

BlockHeader

transactions?

TypedTransaction[] = []

uncleHeaders?

BlockHeader[] = []

withdrawals?

Withdrawal[]

opts?

BlockOptions = {}

Returns

Block

Deprecated

Use the static factory methods (see Block for an overview) to assist in creating a Block object from varying data types and options.

Properties

common

readonly common: Common

Defined in: block/block.ts:61

header

readonly header: BlockHeader

Defined in: block/block.ts:57

transactions

readonly transactions: TypedTransaction[] = []

Defined in: block/block.ts:58

uncleHeaders

readonly uncleHeaders: BlockHeader[] = []

Defined in: block/block.ts:59

withdrawals?

readonly optional withdrawals: Withdrawal[]

Defined in: block/block.ts:60

Methods

errorStr()

errorStr(): string

Defined in: block/block.ts:498

Return a compact error string representation of the object

Returns

string

genTxTrie()

genTxTrie(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: block/block.ts:161

Generates transaction trie for validation.

Returns

Promise<Uint8Array<ArrayBufferLike>>

getTransactionsValidationErrors()

getTransactionsValidationErrors(): string[]

Defined in: block/block.ts:191

Validates transaction signatures and minimum gas requirements.

Returns

string[]

an array of error strings

hash()

hash(): Uint8Array

Defined in: block/block.ts:140

Returns the hash of the block.

Returns

Uint8Array

isGenesis()

isGenesis(): boolean

Defined in: block/block.ts:147

Determines if this block is the genesis block.

Returns

boolean

raw()

raw(): BlockBytes

Defined in: block/block.ts:121

Returns an array of the raw byte arrays for this block, in order.

Returns

BlockBytes

serialize()

serialize(): Uint8Array

Defined in: block/block.ts:154

Returns the rlp encoding of the block.

Returns

Uint8Array

toExecutionPayload()

toExecutionPayload(): ExecutionPayload

Defined in: block/block.ts:464

Maps the block properties to the execution payload structure from the beacon chain, see https://github.com/ethereum/consensus-specs/blob/dev/specs/bellatrix/beacon-chain.md#ExecutionPayload

Returns

ExecutionPayload

dict with the execution payload parameters with camel case naming

toJSON()

toJSON(): JSONBlock

Defined in: block/block.ts:444

Returns the block in JSON format.

Returns

JSONBlock

transactionsAreValid()

transactionsAreValid(): boolean

Defined in: block/block.ts:241

Validates transaction signatures and minimum gas requirements.

Returns

boolean

True if all transactions are valid, false otherwise

transactionsTrieIsValid()

transactionsTrieIsValid(): Promise<boolean>

Defined in: block/block.ts:173

Validates the transaction trie by generating a trie and do a check on the root hash.

Returns

Promise<boolean>

True if the transaction trie is valid, false otherwise

uncleHashIsValid()

uncleHashIsValid(): boolean

Defined in: block/block.ts:369

Validates the uncle’s hash.

Returns

boolean

true if the uncle’s hash is valid, false otherwise.

validateBlobTransactions()

validateBlobTransactions(parentHeader): void

Defined in: block/block.ts:321

Validates that blob gas fee for each transaction is greater than or equal to the blobGasPrice for the block and that total blob gas in block is less than maximum blob gas per block

Parameters

parentHeader

BlockHeader

header of parent block

Returns

void

validateData()

validateData(onlyHeader, verifyTxs, validateBlockSize): Promise<void>

Defined in: block/block.ts:259

Validates the block data, throwing if invalid. This can be checked on the Block itself without needing access to any parent block It checks:

All transactions are valid
The transactions trie is valid
The uncle hash is valid
Block size limit (EIP-7934)

Parameters

onlyHeader

boolean = false

if only passed the header, skip validating txTrie and unclesHash (default: false)

verifyTxs

boolean = true

if set to false, will not check for transaction validation errors (default: true)

validateBlockSize

boolean = false

if set to true, will check for block size limit (EIP-7934) (default: false)

Returns

Promise<void>

validateGasLimit()

validateGasLimit(parentBlock): void

Defined in: block/block.ts:437

Validates if the block gasLimit remains in the boundaries set by the protocol. Throws if invalid

Parameters

parentBlock

Block

the parent of this Block

Returns

void

validateUncles()

validateUncles(): void

Defined in: block/block.ts:412

Consistency checks for uncles included in the block, if any.

Throws if invalid.

The rules for uncles checked are the following: Header has at most 2 uncles. Header does not count an uncle twice.

Returns

void

withdrawalsTrieIsValid()

withdrawalsTrieIsValid(): Promise<boolean>

Defined in: block/block.ts:382

Validates the withdrawal root

Returns

Promise<boolean>

true if the withdrawals trie root is valid, false otherwise