@ethereumjs/vm / BuilderOpts
Options for the block builder.
-
BlockOptions↳
BuilderOpts
- calcDifficultyFromHeader
- cliqueSigner
- common
- freeze
- putBlockIntoBlockchain
- setHardfork
- skipConsensusFormatValidation
• Optional calcDifficultyFromHeader: BlockHeader
If a preceding BlockHeader (usually the parent header) is given the preceding
header will be used to calculate the difficulty for this block and the calculated
difficulty takes precedence over a provided static difficulty value.
Note that this option has no effect on networks other than PoW/Ethash networks (respectively also deactivates on the Merge HF switching to PoS/Casper).
BlockOptions.calcDifficultyFromHeader
block/dist/cjs/types.d.ts:41
• Optional cliqueSigner: Uint8Array
Provide a clique signer's privateKey to seal this block. Will throw if provided on a non-PoA chain.
BlockOptions.cliqueSigner
block/dist/cjs/types.d.ts:58
• Optional common: Common
A Common object defining the chain and the hardfork a block/block header belongs to.
Object will be internally copied so that tx behavior don't incidentally change on future HF changes.
Default: Common object set to mainnet and the HF currently defined as the default
hardfork in the Common class.
Current default hardfork: merge
BlockOptions.common
block/dist/cjs/types.d.ts:22
• Optional freeze: boolean
A block object by default gets frozen along initialization. This gives you
strong additional security guarantees on the consistency of the block parameters.
It also enables block hash caching when the hash() method is called multiple times.
If you need to deactivate the block freeze - e.g. because you want to subclass block and add additional properties - it is strongly encouraged that you do the freeze yourself within your code instead.
Default: true
BlockOptions.freeze
block/dist/cjs/types.d.ts:53
• Optional putBlockIntoBlockchain: boolean
Whether to put the block into the vm's blockchain after building it. This is useful for completing a full cycle when building a block so the only next step is to build again, however it may not be desired if the block is being emulated or may be discarded as to not affect the underlying blockchain.
Default: true
• Optional setHardfork: boolean | BigIntLike
Set the hardfork either by timestamp (for HFs from Shanghai onwards) or by block number for older Hfs.
Additionally it is possible to pass in a specific TD value to support live-Merge-HF transitions. Note that this should only be needed in very rare and specific scenarios.
Default: false (HF is set to whatever default HF is set by the Common instance)
BlockOptions.setHardfork
block/dist/cjs/types.d.ts:32
• Optional skipConsensusFormatValidation: boolean
Skip consensus format validation checks on header if set. Defaults to false.
BlockOptions.skipConsensusFormatValidation
block/dist/cjs/types.d.ts:62