From 11b56ace2a8211cbe4b4d5ec578e7c2a21c31da0 Mon Sep 17 00:00:00 2001 From: milesvant Date: Thu, 5 May 2022 00:22:00 -0700 Subject: [PATCH] core: fix WriteBlockAndSetHead documentation (#24818) --- core/blockchain.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/core/blockchain.go b/core/blockchain.go index c6c845350..a62e085cf 100644 --- a/core/blockchain.go +++ b/core/blockchain.go @@ -1266,7 +1266,8 @@ func (bc *BlockChain) writeBlockWithState(block *types.Block, receipts []*types. return nil } -// WriteBlockWithState writes the block and all associated state to the database. +// WriteBlockAndSetHead writes the given block and all associated state to the database, +// and applies the block as the new chain head. func (bc *BlockChain) WriteBlockAndSetHead(block *types.Block, receipts []*types.Receipt, logs []*types.Log, state *state.StateDB, emitHeadEvent bool) (status WriteStatus, err error) { if !bc.chainmu.TryLock() { return NonStatTy, errChainStopped @@ -1276,9 +1277,8 @@ func (bc *BlockChain) WriteBlockAndSetHead(block *types.Block, receipts []*types return bc.writeBlockAndSetHead(block, receipts, logs, state, emitHeadEvent) } -// writeBlockAndSetHead writes the block and all associated state to the database, -// and also it applies the given block as the new chain head. This function expects -// the chain mutex to be held. +// writeBlockAndSetHead is the internal implementation of WriteBlockAndSetHead. +// This function expects the chain mutex to be held. func (bc *BlockChain) writeBlockAndSetHead(block *types.Block, receipts []*types.Receipt, logs []*types.Log, state *state.StateDB, emitHeadEvent bool) (status WriteStatus, err error) { if err := bc.writeBlockWithState(block, receipts, logs, state); err != nil { return NonStatTy, err