@nomicfoundation/ethereumjs-vm
Version:
An Ethereum VM implementation
304 lines • 13.8 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.buildBlock = exports.BlockBuilder = exports.BuildStatus = void 0;
const ethereumjs_block_1 = require("@nomicfoundation/ethereumjs-block");
const ethereumjs_common_1 = require("@nomicfoundation/ethereumjs-common");
const ethereumjs_rlp_1 = require("@nomicfoundation/ethereumjs-rlp");
const ethereumjs_trie_1 = require("@nomicfoundation/ethereumjs-trie");
const ethereumjs_tx_1 = require("@nomicfoundation/ethereumjs-tx");
const ethereumjs_util_1 = require("@nomicfoundation/ethereumjs-util");
const index_js_1 = require("./bloom/index.js");
const runBlock_js_1 = require("./runBlock.js");
var BuildStatus;
(function (BuildStatus) {
BuildStatus["Reverted"] = "reverted";
BuildStatus["Build"] = "build";
BuildStatus["Pending"] = "pending";
})(BuildStatus = exports.BuildStatus || (exports.BuildStatus = {}));
class BlockBuilder {
constructor(vm, opts) {
/**
* The cumulative gas used by the transactions added to the block.
*/
this.gasUsed = ethereumjs_util_1.BIGINT_0;
/**
* The cumulative blob gas used by the blobs in a block
*/
this.blobGasUsed = ethereumjs_util_1.BIGINT_0;
/**
* Value of the block, represented by the final transaction fees
* acruing to the miner.
*/
this._minerValue = ethereumjs_util_1.BIGINT_0;
this.transactions = [];
this.transactionResults = [];
this.checkpointed = false;
this.blockStatus = { status: BuildStatus.Pending };
this.vm = vm;
this.blockOpts = { putBlockIntoBlockchain: true, ...opts.blockOpts, common: this.vm.common };
this.headerData = {
...opts.headerData,
parentHash: opts.parentBlock.hash(),
number: opts.headerData?.number ?? opts.parentBlock.header.number + ethereumjs_util_1.BIGINT_1,
gasLimit: opts.headerData?.gasLimit ?? opts.parentBlock.header.gasLimit,
timestamp: opts.headerData?.timestamp ?? Math.round(Date.now() / 1000),
};
this.withdrawals = opts.withdrawals?.map(ethereumjs_util_1.Withdrawal.fromWithdrawalData);
if (this.vm.common.isActivatedEIP(1559) === true &&
typeof this.headerData.baseFeePerGas === 'undefined') {
if (this.headerData.number === vm.common.hardforkBlock(ethereumjs_common_1.Hardfork.London)) {
this.headerData.baseFeePerGas = vm.common.param('gasConfig', 'initialBaseFee');
}
else {
this.headerData.baseFeePerGas = opts.parentBlock.header.calcNextBaseFee();
}
}
if (typeof this.headerData.gasLimit === 'undefined') {
if (this.headerData.number === vm.common.hardforkBlock(ethereumjs_common_1.Hardfork.London)) {
this.headerData.gasLimit = opts.parentBlock.header.gasLimit * ethereumjs_util_1.BIGINT_2;
}
else {
this.headerData.gasLimit = opts.parentBlock.header.gasLimit;
}
}
if (this.vm.common.isActivatedEIP(4844) === true &&
typeof this.headerData.excessBlobGas === 'undefined') {
this.headerData.excessBlobGas = opts.parentBlock.header.calcNextExcessBlobGas();
}
}
get transactionReceipts() {
return this.transactionResults.map((result) => result.receipt);
}
get minerValue() {
return this._minerValue;
}
/**
* Throws if the block has already been built or reverted.
*/
checkStatus() {
if (this.blockStatus.status === BuildStatus.Build) {
throw new Error('Block has already been built');
}
if (this.blockStatus.status === BuildStatus.Reverted) {
throw new Error('State has already been reverted');
}
}
getStatus() {
return this.blockStatus;
}
/**
* Calculates and returns the transactionsTrie for the block.
*/
async transactionsTrie() {
return ethereumjs_block_1.Block.genTransactionsTrieRoot(this.transactions, new ethereumjs_trie_1.Trie({ common: this.vm.common }));
}
/**
* Calculates and returns the logs bloom for the block.
*/
logsBloom() {
const bloom = new index_js_1.Bloom(undefined, this.vm.common);
for (const txResult of this.transactionResults) {
// Combine blooms via bitwise OR
bloom.or(txResult.bloom);
}
return bloom.bitvector;
}
/**
* Calculates and returns the receiptTrie for the block.
*/
async receiptTrie() {
if (this.transactionResults.length === 0) {
return ethereumjs_util_1.KECCAK256_RLP;
}
const receiptTrie = new ethereumjs_trie_1.Trie({ common: this.vm.common });
for (const [i, txResult] of this.transactionResults.entries()) {
const tx = this.transactions[i];
const encodedReceipt = (0, runBlock_js_1.encodeReceipt)(txResult.receipt, tx.type);
await receiptTrie.put(ethereumjs_rlp_1.RLP.encode(i), encodedReceipt);
}
return receiptTrie.root();
}
/**
* Adds the block miner reward to the coinbase account.
*/
async rewardMiner() {
const minerReward = this.vm.common.param('pow', 'minerReward');
const reward = (0, runBlock_js_1.calculateMinerReward)(minerReward, 0);
const coinbase = this.headerData.coinbase !== undefined
? new ethereumjs_util_1.Address((0, ethereumjs_util_1.toBytes)(this.headerData.coinbase))
: ethereumjs_util_1.Address.zero();
await (0, runBlock_js_1.rewardAccount)(this.vm.evm, coinbase, reward);
}
/**
* Adds the withdrawal amount to the withdrawal address
*/
async processWithdrawals() {
for (const withdrawal of this.withdrawals ?? []) {
const { address, amount } = withdrawal;
// If there is no amount to add, skip touching the account
// as per the implementation of other clients geth/nethermind
// although this should never happen as no withdrawals with 0
// amount should ever land up here.
if (amount === 0n)
continue;
// Withdrawal amount is represented in Gwei so needs to be
// converted to wei
await (0, runBlock_js_1.rewardAccount)(this.vm.evm, address, amount * ethereumjs_util_1.GWEI_TO_WEI);
}
}
/**
* Run and add a transaction to the block being built.
* Please note that this modifies the state of the VM.
* Throws if the transaction's gasLimit is greater than
* the remaining gas in the block.
*/
async addTransaction(tx, { skipHardForkValidation } = {}) {
this.checkStatus();
if (!this.checkpointed) {
await this.vm.evm.journal.checkpoint();
this.checkpointed = true;
}
// According to the Yellow Paper, a transaction's gas limit
// cannot be greater than the remaining gas in the block
const blockGasLimit = (0, ethereumjs_util_1.toType)(this.headerData.gasLimit, ethereumjs_util_1.TypeOutput.BigInt);
const blobGasLimit = this.vm.common.param('gasConfig', 'maxblobGasPerBlock');
const blobGasPerBlob = this.vm.common.param('gasConfig', 'blobGasPerBlob');
const blockGasRemaining = blockGasLimit - this.gasUsed;
if (tx.gasLimit > blockGasRemaining) {
throw new Error('tx has a higher gas limit than the remaining gas in the block');
}
let blobGasUsed = undefined;
if (tx instanceof ethereumjs_tx_1.BlobEIP4844Transaction) {
if (this.blockOpts.common?.isActivatedEIP(4844) !== true) {
throw Error('eip4844 not activated yet for adding a blob transaction');
}
const blobTx = tx;
// Guard against the case if a tx came into the pool without blobs i.e. network wrapper payload
if (blobTx.blobs === undefined) {
throw new Error('blobs missing for 4844 transaction');
}
if (this.blobGasUsed + BigInt(blobTx.numBlobs()) * blobGasPerBlob > blobGasLimit) {
throw new Error('block blob gas limit reached');
}
blobGasUsed = this.blobGasUsed;
}
const header = {
...this.headerData,
gasUsed: this.gasUsed,
// correct excessBlobGas should already part of headerData used above
blobGasUsed,
};
const blockData = { header, transactions: this.transactions };
const block = ethereumjs_block_1.Block.fromBlockData(blockData, this.blockOpts);
const result = await this.vm.runTx({ tx, block, skipHardForkValidation });
// If tx is a blob transaction, remove blobs/kzg commitments before adding to block per EIP-4844
if (tx instanceof ethereumjs_tx_1.BlobEIP4844Transaction) {
const txData = tx;
this.blobGasUsed += BigInt(txData.blobVersionedHashes.length) * blobGasPerBlob;
tx = ethereumjs_tx_1.BlobEIP4844Transaction.minimalFromNetworkWrapper(txData, {
common: this.blockOpts.common,
});
}
this.transactions.push(tx);
this.transactionResults.push(result);
this.gasUsed += result.totalGasSpent;
this._minerValue += result.minerValue;
return result;
}
/**
* Reverts the checkpoint on the StateManager to reset the state from any transactions that have been run.
*/
async revert() {
if (this.checkpointed) {
await this.vm.evm.journal.revert();
this.checkpointed = false;
}
this.blockStatus = { status: BuildStatus.Reverted };
}
/**
* This method returns the finalized block.
* It also:
* - Assigns the reward for miner (PoW)
* - Commits the checkpoint on the StateManager
* - Sets the tip of the VM's blockchain to this block
* For PoW, optionally seals the block with params `nonce` and `mixHash`,
* which is validated along with the block number and difficulty by ethash.
* For PoA, please pass `blockOption.cliqueSigner` into the buildBlock constructor,
* as the signer will be awarded the txs amount spent on gas as they are added.
*/
async build(sealOpts) {
this.checkStatus();
const blockOpts = this.blockOpts;
const consensusType = this.vm.common.consensusType();
if (consensusType === ethereumjs_common_1.ConsensusType.ProofOfWork) {
await this.rewardMiner();
}
await this.processWithdrawals();
const stateRoot = await this.vm.stateManager.getStateRoot();
const transactionsTrie = await this.transactionsTrie();
const withdrawalsRoot = this.withdrawals
? await ethereumjs_block_1.Block.genWithdrawalsTrieRoot(this.withdrawals, new ethereumjs_trie_1.Trie({ common: this.vm.common }))
: undefined;
const receiptTrie = await this.receiptTrie();
const logsBloom = this.logsBloom();
const gasUsed = this.gasUsed;
// timestamp should already be set in constructor
const timestamp = this.headerData.timestamp ?? ethereumjs_util_1.BIGINT_0;
let blobGasUsed = undefined;
if (this.vm.common.isActivatedEIP(4844) === true) {
blobGasUsed = this.blobGasUsed;
}
const headerData = {
...this.headerData,
stateRoot,
transactionsTrie,
withdrawalsRoot,
receiptTrie,
logsBloom,
gasUsed,
timestamp,
// correct excessBlobGas should already be part of headerData used above
blobGasUsed,
};
if (consensusType === ethereumjs_common_1.ConsensusType.ProofOfWork) {
headerData.nonce = sealOpts?.nonce ?? headerData.nonce;
headerData.mixHash = sealOpts?.mixHash ?? headerData.mixHash;
}
const blockData = {
header: headerData,
transactions: this.transactions,
withdrawals: this.withdrawals,
};
const block = ethereumjs_block_1.Block.fromBlockData(blockData, blockOpts);
if (this.blockOpts.putBlockIntoBlockchain === true) {
await this.vm.blockchain.putBlock(block);
}
this.blockStatus = { status: BuildStatus.Build, block };
if (this.checkpointed) {
await this.vm.evm.journal.commit();
this.checkpointed = false;
}
return block;
}
async initState() {
if (this.vm.common.isActivatedEIP(4788)) {
if (!this.checkpointed) {
await this.vm.evm.journal.checkpoint();
this.checkpointed = true;
}
const { parentBeaconBlockRoot, timestamp } = this.headerData;
// timestamp should already be set in constructor
const timestampBigInt = (0, ethereumjs_util_1.toType)(timestamp ?? 0, ethereumjs_util_1.TypeOutput.BigInt);
const parentBeaconBlockRootBuf = (0, ethereumjs_util_1.toType)(parentBeaconBlockRoot, ethereumjs_util_1.TypeOutput.Uint8Array) ?? (0, ethereumjs_util_1.zeros)(32);
await runBlock_js_1.accumulateParentBeaconBlockRoot.bind(this.vm)(parentBeaconBlockRootBuf, timestampBigInt);
}
}
}
exports.BlockBuilder = BlockBuilder;
async function buildBlock(opts) {
const blockBuilder = new BlockBuilder(this, opts);
await blockBuilder.initState();
return blockBuilder;
}
exports.buildBlock = buildBlock;
//# sourceMappingURL=buildBlock.js.map