github.com/linapex/ethereum-go-chinese@v0.0.0-20190316121929-f8b7a73c3fa1/core/blockchain_insert.go

//<developer>
//    <name>linapex 曹一峰</name>
//    <email>linapex@163.com</email>
//    <wx>superexc</wx>
//    <qqgroup>128148617</qqgroup>
//    <url>https://jsq.ink</url>
//    <role>pku engineer</role>
//    <date>2019-03-16 19:16:34</date>
//</624450077649276928>


package core

import (
	"time"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/common/mclock"
	"github.com/ethereum/go-ethereum/core/types"
	"github.com/ethereum/go-ethereum/log"
)

//插件在块插入时跟踪和报告。
type insertStats struct {
	queued, processed, ignored int
	usedGas                    uint64
	lastIndex                  int
	startTime                  mclock.AbsTime
}

//statsreportlimit是导入和导出期间的时间限制，在此之后我们
//总是打印出进度。这避免了用户想知道发生了什么。
const statsReportLimit = 8 * time.Second

//如果处理了一些块，则报告将打印统计信息
//或者自上一条消息以来已经过了几秒钟。
func (st *insertStats) report(chain []*types.Block, index int, cache common.StorageSize) {
//获取批的计时
	var (
		now     = mclock.Now()
		elapsed = time.Duration(now) - time.Duration(st.startTime)
	)
//如果我们在到达的批或报告周期的最后一个块，请记录
	if index == len(chain)-1 || elapsed >= statsReportLimit {
//计算此段中的事务数
		var txs int
		for _, block := range chain[st.lastIndex : index+1] {
			txs += len(block.Transactions())
		}
		end := chain[index]

//组装日志上下文并将其发送到记录器
		context := []interface{}{
			"blocks", st.processed, "txs", txs, "mgas", float64(st.usedGas) / 1000000,
			"elapsed", common.PrettyDuration(elapsed), "mgasps", float64(st.usedGas) * 1000 / float64(elapsed),
			"number", end.Number(), "hash", end.Hash(),
		}
		if timestamp := time.Unix(end.Time().Int64(), 0); time.Since(timestamp) > time.Minute {
			context = append(context, []interface{}{"age", common.PrettyAge(timestamp)}...)
		}
		context = append(context, []interface{}{"cache", cache}...)

		if st.queued > 0 {
			context = append(context, []interface{}{"queued", st.queued}...)
		}
		if st.ignored > 0 {
			context = append(context, []interface{}{"ignored", st.ignored}...)
		}
		log.Info("Imported new chain segment", context...)

//将报告的统计数据转发到下一节
		*st = insertStats{startTime: now, lastIndex: index + 1}
	}
}

//插入器是在链导入过程中提供帮助的助手。
type insertIterator struct {
	chain     types.Blocks
	results   <-chan error
	index     int
	validator Validator
}

//newinsertiator基于给定的块创建一个新的迭代器，它是
//假定为连续链。
func newInsertIterator(chain types.Blocks, results <-chan error, validator Validator) *insertIterator {
	return &insertIterator{
		chain:     chain,
		results:   results,
		index:     -1,
		validator: validator,
	}
}

//next返回迭代器中的下一个块，以及任何可能的验证
//该块出错。当结束时，它将返回（零，零）。
func (it *insertIterator) next() (*types.Block, error) {
	if it.index+1 >= len(it.chain) {
		it.index = len(it.chain)
		return nil, nil
	}
	it.index++
	if err := <-it.results; err != nil {
		return it.chain[it.index], err
	}
	return it.chain[it.index], it.validator.ValidateBody(it.chain[it.index])
}

//current返回正在处理的当前块。
func (it *insertIterator) current() *types.Block {
	if it.index < 0 || it.index+1 >= len(it.chain) {
		return nil
	}
	return it.chain[it.index]
}

//previous返回正在处理的前一个块，或者为nil
func (it *insertIterator) previous() *types.Block {
	if it.index < 1 {
		return nil
	}
	return it.chain[it.index-1]
}

//首先返回IT中的第一个块。
func (it *insertIterator) first() *types.Block {
	return it.chain[0]
}

//remaining返回剩余块的数目。
func (it *insertIterator) remaining() int {
	return len(it.chain) - it.index
}

//processed返回已处理的块数。
func (it *insertIterator) processed() int {
	return it.index + 1
}