Block library refactoring #883
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,200 +1,222 @@ | ||
| import { BaseTrie as Trie } from 'merkle-patricia-tree' | ||
| import { rlp, keccak256, KECCAK256_RLP } from 'ethereumjs-util' | ||
| import Common from '@ethereumjs/common' | ||
| import { Transaction, TxOptions } from '@ethereumjs/tx' | ||
| import { BlockHeader } from './header' | ||
| import { BlockData, BlockOptions, JsonBlock, BlockBuffer, Blockchain } from './types' | ||
|
|
||
| /** | ||
| * An object that represents the block. | ||
| */ | ||
| export class Block { | ||
| public readonly header: BlockHeader | ||
| public readonly transactions: Transaction[] = [] | ||
| public readonly uncleHeaders: BlockHeader[] = [] | ||
| public readonly txTrie = new Trie() | ||
| public readonly _common: Common | ||
|
|
||
| public static fromBlockData(blockData: BlockData = {}, opts: BlockOptions = {}) { | ||
| const { header: headerData, transactions: txsData, uncleHeaders: uhsData } = blockData | ||
|
|
||
| const header = BlockHeader.fromHeaderData(headerData, opts) | ||
|
|
||
| // parse transactions | ||
| const transactions = [] | ||
| for (const txData of txsData || []) { | ||
| const tx = Transaction.fromTxData(txData, opts as TxOptions) | ||
| transactions.push(tx) | ||
| } | ||
|
|
||
| // parse uncle headers | ||
| const uncleHeaders = [] | ||
| for (const uhData of uhsData || []) { | ||
| const uh = BlockHeader.fromHeaderData(uhData, opts) | ||
| uncleHeaders.push(uh) | ||
| } | ||
|
|
||
| return new Block(header, transactions, uncleHeaders) | ||
| } | ||
|
|
||
| public static fromRLPSerializedBlock(serialized: Buffer, opts: BlockOptions = {}) { | ||
| const values = (rlp.decode(serialized) as any) as BlockBuffer | ||
|
|
||
| if (!Array.isArray(values)) { | ||
| throw new Error('Invalid serialized block input. Must be array') | ||
| } | ||
|
|
||
| return Block.fromValuesArray(values, opts) | ||
| } | ||
|
|
||
| public static fromValuesArray(values: BlockBuffer, opts: BlockOptions = {}) { | ||
| if (values.length > 3) { | ||
| throw new Error('invalid block. More values than expected were received') | ||
| } | ||
|
|
||
| const [headerData, txsData, uhsData] = values | ||
|
|
||
| const header = BlockHeader.fromValuesArray(headerData, opts) | ||
|
|
||
| // parse transactions | ||
| const transactions = [] | ||
| for (const txData of txsData || []) { | ||
| transactions.push(Transaction.fromValuesArray(txData, opts)) | ||
| } | ||
|
|
||
| // parse uncle headers | ||
| const uncleHeaders = [] | ||
| for (const uncleHeaderData of uhsData || []) { | ||
| uncleHeaders.push(BlockHeader.fromValuesArray(uncleHeaderData, opts)) | ||
| } | ||
|
|
||
| return new Block(header, transactions, uncleHeaders) | ||
| } | ||
|
|
||
| /** | ||
| * Alias for Block.fromBlockData() with initWithGenesisHeader set to true. | ||
| */ | ||
| public static genesis(blockData: BlockData = {}, opts: BlockOptions = {}) { | ||
| opts = { ...opts, initWithGenesisHeader: true } | ||
| return Block.fromBlockData(blockData, opts) | ||
| } | ||
|
|
||
| /** | ||
| * This constructor takes the values, validates them, assigns them and freezes the object. | ||
| * Use the static factory methods to assist in creating a Block object from varying data types and options. | ||
| */ | ||
| constructor( | ||
| header?: BlockHeader, | ||
| transactions: Transaction[] = [], | ||
| uncleHeaders: BlockHeader[] = [], | ||
| opts: BlockOptions = {}, | ||
| ) { | ||
| this.header = header || BlockHeader.fromHeaderData({}, opts) | ||
| this.transactions = transactions | ||
| this.uncleHeaders = uncleHeaders | ||
| this._common = this.header._common | ||
|
|
||
| Object.freeze(this) | ||
|
There was a problem hiding this comment. For understanding on further implications: does this So would a subsequent call (e.g. in a VM context) There was a problem hiding this comment. I'll have to give it a test, but I think the common object can still update, it just can't be set to a totally new instance (e.g. There was a problem hiding this comment. Yes I think this is the case according to here:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze |
||
| } | ||
|
|
||
| /** | ||
| * Returns a Buffer Array of the raw Buffers of this block, in order. | ||
| */ | ||
| raw(): BlockBuffer { | ||
| return [ | ||
| this.header.raw(), | ||
| this.transactions.map((tx) => tx.raw()), | ||
| this.uncleHeaders.map((uh) => uh.raw()), | ||
| ] | ||
| } | ||
|
|
||
| /** | ||
| * Produces a hash the RLP of the block. | ||
| */ | ||
| hash(): Buffer { | ||
| return this.header.hash() | ||
| } | ||
|
|
||
| /** | ||
| * Determines if this block is the genesis block. | ||
| */ | ||
| isGenesis(): boolean { | ||
| return this.header.isGenesis() | ||
| } | ||
|
|
||
| /** | ||
| * Returns the rlp encoding of the block. | ||
| */ | ||
| serialize(): Buffer { | ||
| return rlp.encode(this.raw()) | ||
| } | ||
|
|
||
| /** | ||
| * Generates transaction trie for validation. | ||
| */ | ||
| async genTxTrie(): Promise<void> { | ||
| const { transactions, txTrie } = this | ||
| for (let i = 0; i < transactions.length; i++) { | ||
| const tx = transactions[i] | ||
| const key = rlp.encode(i) | ||
| const value = tx.serialize() | ||
| await txTrie.put(key, value) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Validates the transaction trie. | ||
| */ | ||
| async validateTransactionsTrie(): Promise<boolean> { | ||
| if (this.transactions.length === 0) { | ||
| return this.header.transactionsTrie.equals(KECCAK256_RLP) | ||
| } | ||
|
|
||
| if (this.txTrie.root.equals(KECCAK256_RLP)) { | ||
| await this.genTxTrie() | ||
| } | ||
|
|
||
| return this.txTrie.root.equals(this.header.transactionsTrie) | ||
| } | ||
|
|
||
| /** | ||
| * Validates the transactions. | ||
| * | ||
| * @param stringError - If `true`, a string with the indices of the invalid txs is returned. | ||
| */ | ||
| validateTransactions(): boolean | ||
| validateTransactions(stringError: false): boolean | ||
| validateTransactions(stringError: true): string[] | ||
| validateTransactions(stringError = false) { | ||
| const errors: string[] = [] | ||
|
|
||
| this.transactions.forEach(function (tx, i) { | ||
| const errs = tx.validate(true) | ||
| if (errs.length > 0) { | ||
| errors.push(`errors at tx ${i}: ${errs.join(', ')}`) | ||
| } | ||
| }) | ||
|
|
||
| return stringError ? errors : errors.length === 0 | ||
|
There was a problem hiding this comment. Yeah, just re-read the discussion with @alcuadrado, this really makes a lot of sense to skip the |
||
| } | ||
|
|
||
| /** | ||
| * Validates the block, throwing if invalid. | ||
| * | ||
| * @param blockchain - additionally validate against a @ethereumjs/blockchain | ||
| */ | ||
| async validate(blockchain?: Blockchain): Promise<void> { | ||
| await this.header.validate(blockchain) | ||
|
|
||
| const txErrors = this.validateTransactions(true) | ||
| if (txErrors.length > 0) { | ||
| throw new Error(`invalid transactions: ${txErrors.join(' ')}`) | ||
|
|
||
| } | ||
|
|
||
| const validateTxTrie = await this.validateTransactionsTrie() | ||
| if (!validateTxTrie) { | ||
| throw new Error('invalid transaction trie') | ||
| } | ||
|
|
||
| await this.validateUncles(blockchain) | ||
|
|
||
| if (!this.validateUnclesHash()) { | ||
| throw new Error('invalid uncle hash') | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Validates the uncle's hash. | ||
| */ | ||
| validateUnclesHash(): boolean { | ||
| const raw = rlp.encode(this.uncleHeaders.map((uh) => uh.raw())) | ||
| return keccak256(raw).equals(this.header.uncleHash) | ||
| } | ||
|
|
||
| /** | ||
| * Validates the uncles that are in the block, if any. This method throws if they are invalid. | ||
| * | ||
| * @param blockchain - additionally validate against a @ethereumjs/blockchain | ||
| */ | ||
| async validateUncles(blockchain?: Blockchain): Promise<void> { | ||
| if (this.isGenesis()) { | ||
| return | ||
| } | ||
|
|
@@ -204,43 +226,31 @@ export class Block { | |
| } | ||
|
|
||
| const uncleHashes = this.uncleHeaders.map((header) => header.hash().toString('hex')) | ||
| if (!(new Set(uncleHashes).size === uncleHashes.length)) { | ||
| throw new Error('duplicate uncles') | ||
| } | ||
|
|
||
| for (const uh of this.uncleHeaders) { | ||
| await this._validateUncleHeader(uh, blockchain) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns the block in JSON format. | ||
| */ | ||
| toJSON(): JsonBlock { | ||
| return { | ||
| header: this.header.toJSON(), | ||
| transactions: this.transactions.map((tx) => tx.toJSON()), | ||
| uncleHeaders: this.uncleHeaders.map((uh) => uh.toJSON()), | ||
| } | ||
| } | ||
|
|
||
| private _validateUncleHeader(uncleHeader: BlockHeader, blockchain?: Blockchain) { | ||
| // TODO: Validate that the uncle header hasn't been included in the blockchain yet. | ||
| // This is not possible in ethereumjs-blockchain since this PR was merged: | ||
| // https://github.com/ethereumjs/ethereumjs-blockchain/pull/47 | ||
| const height = this.header.number | ||
| return uncleHeader.validate(blockchain, height) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, thought we can really keep this as simple as you proposed (or more or less), so optimally
Block.genesis(common), and everyone needing something adjusted can just use theBlock.fromBlockData()variant?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I wanted to too but in practice (in our test suite) it was helpful to accept custom overrides as well.