Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Block: low-level validation methods refactor #1954

Closed
wants to merge 10 commits into from
Closed

Block: low-level validation methods refactor #1954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9f1dad0
block: remove block and header validations
emersonmacro Jun 10, 2022
9682417
block: refactor tests for validation removals
emersonmacro Jun 11, 2022
1d67e2f
block: add TODO for test that needs to be fixed
emersonmacro Jun 11, 2022
eef8c83
blockchain: add block and header validation methods
emersonmacro Jun 11, 2022
9a19c86
blockchain: refactor tests for validation methods
emersonmacro Jun 11, 2022
72028cf
vm: update runBlock to validate block with blockchain
emersonmacro Jun 12, 2022
97198e6
client: update fullsync to validate block with blockchain
emersonmacro Jun 12, 2022
2aa8e58
blockchain: fix docstring for validateDifficulty method
emersonmacro Jun 13, 2022
d190f8f
ethash: add TODO to fix failing test
emersonmacro Jun 13, 2022
770b84e
vm: update tests after block validation refactor
emersonmacro Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 1 addition & 175 deletions packages/block/src/block.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
Capability,
} from '@ethereumjs/tx'
import { BlockHeader } from './header'
import { BlockData, BlockOptions, JsonBlock, BlockBuffer, Blockchain } from './types'
import { BlockData, BlockOptions, JsonBlock, BlockBuffer } from './types'

/**
* An object that represents the block.
Expand Down Expand Up @@ -261,24 +261,6 @@ export class Block {
return stringError ? errors : errors.length === 0
}

/**
* Performs the following consistency checks on the block:
*
* - Value checks on the header fields
* - Signature and gasLimit validation for included txs
* - Validation of the tx trie
* - Consistency checks and header validation of included uncles
*
* Throws if invalid.
*
* @param blockchain - validate against an @ethereumjs/blockchain
* @param onlyHeader - if should only validate the header (skips validating txTrie and unclesHash) (default: false)
*/
async validate(blockchain: Blockchain, onlyHeader: boolean = false): Promise<void> {
await this.header.validate(blockchain)
await this.validateUncles(blockchain)
await this.validateData(onlyHeader)
}
/**
* Validates the block data, throwing if invalid.
* This can be checked on the Block itself without needing access to any parent block
Expand Down Expand Up @@ -320,43 +302,6 @@ export class Block {
return Buffer.from(keccak256(raw)).equals(this.header.uncleHash)
}

/**
* Consistency checks and header validation for uncles included,
* in the block, if any.
*
* Throws if invalid.
*
* The rules of uncles are the following:
* Uncle Header is a valid header.
* Uncle Header is an orphan, i.e. it is not one of the headers of the canonical chain.
* Uncle Header has a parentHash which points to the canonical chain. This parentHash is within the last 7 blocks.
* Uncle Header is not already included as uncle in another block.
* Header has at most 2 uncles.
* Header does not count an uncle twice.
*
* @param blockchain - additionally validate against an @ethereumjs/blockchain instance
*/
async validateUncles(blockchain: Blockchain): Promise<void> {
if (this.isGenesis()) {
return
}

// Header has at most 2 uncles
if (this.uncleHeaders.length > 2) {
const msg = this._errorMsg('too many uncle headers')
throw new Error(msg)
}

// Header does not count an uncle twice.
const uncleHashes = this.uncleHeaders.map((header) => header.hash().toString('hex'))
if (!(new Set(uncleHashes).size === uncleHashes.length)) {
const msg = this._errorMsg('duplicate uncles')
throw new Error(msg)
}

await this._validateUncleHeaders(this.uncleHeaders, blockchain)
}

/**
* Returns the canonical difficulty for this block.
*
Expand All @@ -366,25 +311,6 @@ export class Block {
return this.header.canonicalDifficulty(parentBlock.header)
}

/**
* Checks that the block's `difficulty` matches the canonical difficulty.
*
* @param parentBlock - the parent of this `Block`
*/
validateDifficulty(parentBlock: Block): boolean {
return this.header.validateDifficulty(parentBlock.header)
}

/**
* Validates if the block gasLimit remains in the
* boundaries set by the protocol.
*
* @param parentBlock - the parent of this `Block`
*/
validateGasLimit(parentBlock: Block): boolean {
return this.header.validateGasLimit(parentBlock.header)
}

/**
* Returns the block in JSON format.
*/
Expand All @@ -396,106 +322,6 @@ export class Block {
}
}

/**
* The following rules are checked in this method:
* Uncle Header is a valid header.
* Uncle Header is an orphan, i.e. it is not one of the headers of the canonical chain.
* Uncle Header has a parentHash which points to the canonical chain. This parentHash is within the last 7 blocks.
* Uncle Header is not already included as uncle in another block.
* @param uncleHeaders - list of uncleHeaders
* @param blockchain - pointer to the blockchain
*/
private async _validateUncleHeaders(uncleHeaders: BlockHeader[], blockchain: Blockchain) {
if (uncleHeaders.length == 0) {
return
}

// Each Uncle Header is a valid header
await Promise.all(uncleHeaders.map((uh) => uh.validate(blockchain, this.header.number)))

// Check how many blocks we should get in order to validate the uncle.
// In the worst case, we get 8 blocks, in the best case, we only get 1 block.
const canonicalBlockMap: Block[] = []
let lowestUncleNumber = this.header.number

uncleHeaders.map((header) => {
if (header.number < lowestUncleNumber) {
lowestUncleNumber = header.number
}
})

// Helper variable: set hash to `true` if hash is part of the canonical chain
const canonicalChainHashes: { [key: string]: boolean } = {}

// Helper variable: set hash to `true` if uncle hash is included in any canonical block
const includedUncles: { [key: string]: boolean } = {}

// Due to the header validation check above, we know that `getBlocks` is between 1 and 8 inclusive.
const getBlocks = Number(this.header.number - lowestUncleNumber + BigInt(1))

// See Geth: https://github.com/ethereum/go-ethereum/blob/b63bffe8202d46ea10ac8c4f441c582642193ac8/consensus/ethash/consensus.go#L207
// Here we get the necessary blocks from the chain.
let parentHash = this.header.parentHash
for (let i = 0; i < getBlocks; i++) {
const parentBlock = await this._getBlockByHash(blockchain, parentHash)
if (!parentBlock) {
const msg = this._errorMsg('could not find parent block')
throw new Error(msg)
}
canonicalBlockMap.push(parentBlock)

// mark block hash as part of the canonical chain
canonicalChainHashes[parentBlock.hash().toString('hex')] = true

// for each of the uncles, mark the uncle as included
parentBlock.uncleHeaders.map((uh) => {
includedUncles[uh.hash().toString('hex')] = true
})

parentHash = parentBlock.header.parentHash
}

// Here we check:
// Uncle Header is an orphan, i.e. it is not one of the headers of the canonical chain.
// Uncle Header is not already included as uncle in another block.
// Uncle Header has a parentHash which points to the canonical chain.

uncleHeaders.map((uh) => {
const uncleHash = uh.hash().toString('hex')
const parentHash = uh.parentHash.toString('hex')

if (!canonicalChainHashes[parentHash]) {
const msg = this._errorMsg(
'The parent hash of the uncle header is not part of the canonical chain'
)
throw new Error(msg)
}

if (includedUncles[uncleHash]) {
const msg = this._errorMsg('The uncle is already included in the canonical chain')
throw new Error(msg)
}

if (canonicalChainHashes[uncleHash]) {
const msg = this._errorMsg('The uncle is a canonical block')
throw new Error(msg)
}
})
}

private async _getBlockByHash(blockchain: Blockchain, hash: Buffer): Promise<Block | undefined> {
try {
const block = await blockchain.getBlock(hash)
return block
} catch (error: any) {
if (error.type === 'NotFoundError') {
return undefined
} else {
throw error
}
}
}

/**
* Return a compact error string representation of the object
*/
Expand Down
Loading