chore: some comments

cmd/utils/flags.go

@@ -34,18 +34,14 @@
 	"strings"
 	"time"
 
-	"github.com/ethereum/go-ethereum/core/txpool/bundlepool"
-	pcsclite "github.com/gballet/go-libpcsclite"
-	gopsutil "github.com/shirou/gopsutil/mem"
-	"github.com/urfave/cli/v2"
-
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/accounts/keystore"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/fdlimit"
 	"github.com/ethereum/go-ethereum/core"
 	"github.com/ethereum/go-ethereum/core/opcodeCompiler/compiler"
 	"github.com/ethereum/go-ethereum/core/rawdb"
+	"github.com/ethereum/go-ethereum/core/txpool/bundlepool"
 	"github.com/ethereum/go-ethereum/core/txpool/legacypool"
 	"github.com/ethereum/go-ethereum/core/vm"
 	"github.com/ethereum/go-ethereum/crypto"
@@ -78,6 +74,8 @@
 	"github.com/ethereum/go-ethereum/triedb"
 	"github.com/ethereum/go-ethereum/triedb/hashdb"
 	"github.com/ethereum/go-ethereum/triedb/pathdb"
+	pcsclite "github.com/gballet/go-libpcsclite"
+	gopsutil "github.com/shirou/gopsutil/mem"
 )
 
 // These are all the command line flags we support.
@@ -95,18 +93,18 @@
 		Value:    flags.DirectoryString(node.DefaultDataDir()),
 		Category: flags.EthCategory,
 	}
 	MultiDataBaseFlag = &cli.BoolFlag{
 		Name: "multidatabase",
 		Usage: "Enable a separated state and block database, it will be created within two subdirectory called state and block, " +
 			"Users can copy this state or block directory to another directory or disk, and then create a symbolic link to the state directory under the chaindata",
 		Category: flags.EthCategory,
 	}
 	RemoteDBFlag = &cli.StringFlag{
 		Name:     "remotedb",
 		Usage:    "URL for remote database",
 		Category: flags.LoggingCategory,
 	}
 	DBEngineFlag = &cli.StringFlag{
 		Name:     "db.engine",
 		Usage:    "Backing database implementation to use ('pebble' or 'leveldb')",
 		Value:    node.DefaultConfig.DBEngine,
@@ -127,39 +125,39 @@
 		Usage:    "Directory for the keystore (default = inside the datadir)",
 		Category: flags.AccountCategory,
 	}
 	USBFlag = &cli.BoolFlag{
 		Name:     "usb",
 		Usage:    "Enable monitoring and management of USB hardware wallets",
 		Category: flags.AccountCategory,
 	}
 	SmartCardDaemonPathFlag = &cli.StringFlag{
 		Name:     "pcscdpath",
 		Usage:    "Path to the smartcard daemon (pcscd) socket file",
 		Value:    pcsclite.PCSCDSockName,
 		Category: flags.AccountCategory,
 	}
 	NetworkIdFlag = &cli.Uint64Flag{
 		Name:     "networkid",
 		Usage:    "Explicitly set network id (integer)(For testnets: use --goerli, --sepolia, --holesky instead)",
 		Value:    ethconfig.Defaults.NetworkId,
 		Category: flags.EthCategory,
 	}
 	MainnetFlag = &cli.BoolFlag{
 		Name:     "mainnet",
 		Usage:    "Ethereum mainnet",
 		Category: flags.EthCategory,
 	}
 	GoerliFlag = &cli.BoolFlag{
 		Name:     "goerli",
 		Usage:    "Görli network: pre-configured proof-of-authority test network",
 		Category: flags.EthCategory,
 	}
 	SepoliaFlag = &cli.BoolFlag{
 		Name:     "sepolia",
 		Usage:    "Sepolia network: pre-configured proof-of-work test network",
 		Category: flags.EthCategory,
 	}
 	HoleskyFlag = &cli.BoolFlag{
 		Name:     "holesky",
 		Usage:    "Holesky network: pre-configured proof-of-stake test network",
 		Category: flags.EthCategory,
@@ -579,12 +577,12 @@
 	}
 	MinerRecommitIntervalFlag = &cli.DurationFlag{
 		Name:     "miner.recommit",
-		Usage:    "Time interval to recreate the block being mined",
+		Usage:    "Time interval to recreate the block being mined", // ？？
 		Value:    ethconfig.Defaults.Miner.Recommit,
 		Category: flags.MinerCategory,
 	}
 	MinerNewPayloadTimeout = &cli.DurationFlag{
-		Name:     "miner.newpayload-timeout",
+		Name:     "miner.newpayload-timeout", // ？？
 		Usage:    "Specify the maximum time allowance for creating a new payload",
 		Value:    ethconfig.Defaults.Miner.NewPayloadTimeout,
 		Category: flags.MinerCategory,

env.log

@@ -0,0 +1,38 @@
+GO111MODULE="on"
+GOARCH="arm64"
+GOBIN=""
+GOCACHE="/Users/jiaqiwang/Library/Caches/go-build"
+GOENV="/Users/jiaqiwang/Library/Application Support/go/env"
+GOEXE=""
+GOEXPERIMENT=""
+GOFLAGS=""
+GOHOSTARCH="arm64"
+GOHOSTOS="darwin"
+GOINSECURE=""
+GOMODCACHE="/Users/jiaqiwang/go/pkg/mod"
+GONOPROXY=""
+GONOSUMDB=""
+GOOS="darwin"
+GOPATH="/Users/jiaqiwang/go"
+GOPRIVATE=""
+GOPROXY="https://goproxy.cn"
+GOROOT="/usr/local/go"
+GOSUMDB="sum.golang.org"
+GOTMPDIR=""
+GOTOOLDIR="/usr/local/go/pkg/tool/darwin_arm64"
+GOVCS=""
+GOVERSION="go1.20.4"
+GCCGO="gccgo"
+AR="ar"
+CC="clang"
+CXX="clang++"
+CGO_ENABLED="1"
+GOMOD="/Users/jiaqiwang/workspace/op-geth/go.mod"
+GOWORK=""
+CGO_CFLAGS="-O2 -g"
+CGO_CPPFLAGS=""
+CGO_CXXFLAGS="-O2 -g"
+CGO_FFLAGS="-O2 -g"
+CGO_LDFLAGS="-O2 -g"
+PKG_CONFIG="pkg-config"
+GOGCCFLAGS="-fPIC -arch arm64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/1p/80zcsvjx28jc9wmj7nj3sxyc0000gn/T/go-build214093898=/tmp/go-build -gno-record-gcc-switches -fno-common"

eth/catalyst/api.go

@@ -416,7 +416,7 @@ func (api *ConsensusAPI) forkchoiceUpdated(update engine.ForkchoiceStateV1, payl
 			BeaconRoot:   payloadAttributes.BeaconRoot,
 			NoTxPool:     payloadAttributes.NoTxPool,
 			Transactions: transactions,
-			GasLimit:     payloadAttributes.GasLimit,
+			GasLimit:     payloadAttributes.GasLimit, // 非空
 			Version:      payloadVersion,
 		}
 		id := args.Id()
@@ -443,7 +443,7 @@ func (api *ConsensusAPI) forkchoiceUpdated(update engine.ForkchoiceStateV1, payl
 			log.Error("Failed to build payload", "err", err)
 			return valid(nil), engine.InvalidPayloadAttributes.With(err)
 		}
-		api.localBlocks.put(id, payload)
+		api.localBlocks.put(id, payload) // here
 		forkchoiceUpdateAttributesTimer.UpdateSince(start)
 		log.Debug("forkchoiceUpdateAttributesTimer", "duration", common.PrettyDuration(time.Since(start)), "id", id)
 		return valid(&id), nil
@@ -609,6 +609,7 @@ func (api *ConsensusAPI) newPayload(params engine.ExecutableData, versionedHashe
 	block := api.localBlocks.getBlockByHash(params.BlockHash)
 	if block == nil {
 		var err error
+		// attributes 到 block
 		block, err = engine.ExecutableDataToBlock(params, versionedHashes, beaconRoot)
 		if err != nil {
 			log.Warn("Invalid NewPayload params", "params", params, "error", err)
@@ -679,7 +680,7 @@ func (api *ConsensusAPI) newPayload(params engine.ExecutableData, versionedHashe
 		return engine.PayloadStatusV1{Status: engine.ACCEPTED}, nil
 	}
 	log.Trace("Inserting block without sethead", "hash", block.Hash(), "number", block.Number)
-	if err := api.eth.BlockChain().InsertBlockWithoutSetHead(block); err != nil {
+	if err := api.eth.BlockChain().InsertBlockWithoutSetHead(block); err != nil { // 塞入chain
 		log.Warn("NewPayloadV1: inserting block failed", "error", err)
 
 		api.invalidLock.Lock()

go.mod

@@ -110,7 +110,6 @@ require (
 	github.com/dgraph-io/ristretto v0.0.4-0.20210318174700-74754f61e018 // indirect
 	github.com/dlclark/regexp2 v1.7.0 // indirect
 	github.com/dustin/go-humanize v1.0.0 // indirect
-	github.com/emirpasic/gods v1.18.1 // indirect
 	github.com/ferranbt/fastssz v0.0.0-20210905181407-59cf6761a7d5 // indirect
 	github.com/garslo/gogen v0.0.0-20170306192744-1d203ffc1f61 // indirect
 	github.com/getsentry/sentry-go v0.27.0 // indirect

go.sum

@@ -350,8 +350,6 @@ github.com/eknkc/amber v0.0.0-20171010120322-cdade1c07385/go.mod h1:0vRUJqYpeSZi
 github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc=
 github.com/emicklei/dot v0.11.0/go.mod h1:DeV7GvQtIw4h2u73RKBkkFdvVAz0D9fzeJrgPW6gy/s=
 github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs=
-github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
-github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ=
 github.com/envoyproxy/go-control-plane v0.6.9/go.mod h1:SBwIajubJHhxtWwsL9s8ss4safvEdbitLhGGK48rN6g=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=

miner/payload_building.go

@@ -56,7 +56,7 @@ type BuildPayloadArgs struct {
 }
 
 // Id computes an 8-byte identifier by hashing the components of the payload arguments.
-func (args *BuildPayloadArgs) Id() engine.PayloadID {
+func (args *BuildPayloadArgs) Id() engine.PayloadID { // payload计算方式
 	// Hash
 	hasher := sha256.New()
 	hasher.Write(args.Parent[:])
@@ -203,6 +203,7 @@ func (payload *Payload) WaitFull() {
 }
 
 func (payload *Payload) resolve(onlyFull bool) *engine.ExecutionPayloadEnvelope {
+	// 终止
 	payload.lock.Lock()
 	defer payload.lock.Unlock()
 
@@ -331,9 +332,9 @@ func (w *worker) buildPayload(args *BuildPayloadArgs) (*Payload, error) {
 
 	fullParams := &generateParams{
 		timestamp:   args.Timestamp,
-		forceTime:   true,
+		forceTime:   true, // 什么意思？？
 		parentHash:  args.Parent,
-		coinbase:    args.FeeRecipient,
+		coinbase:    args.FeeRecipient, //
 		random:      args.Random,
 		withdrawals: args.Withdrawals,
 		beaconRoot:  args.BeaconRoot,
@@ -349,7 +350,7 @@ func (w *worker) buildPayload(args *BuildPayloadArgs) (*Payload, error) {
 		return nil, err
 	}
 
-	//check state of parent block
+	// check state of parent block
 	_, err = w.retrieveParentState(fullParams)
 	if err != nil && strings.Contains(err.Error(), "missing trie node") {
 		log.Error("missing parent state when building block, try to fix...")
@@ -362,28 +363,28 @@ func (w *worker) buildPayload(args *BuildPayloadArgs) (*Payload, error) {
 	}
 
 	payload := newPayload(nil, args.Id())
-	// set shared interrupt
+	// set shared interrupt； 外部可以中断building
 	fullParams.interrupt = payload.interrupt
 
 	// Spin up a routine for updating the payload in background. This strategy
 	// can maximum the revenue for including transactions with highest fee.
 	go func() {
 		// Setup the timer for re-building the payload. The initial clock is kept
 		// for triggering process immediately.
-		timer := time.NewTimer(0)
+		timer := time.NewTimer(0) // 怎么使用？？
 		defer timer.Stop()
 
 		start := time.Now()
 		// Setup the timer for terminating the payload building process as determined
 		// by validateParams.
-		endTimer := time.NewTimer(blockTime)
+		endTimer := time.NewTimer(blockTime) //
 		defer endTimer.Stop()
 
 		timeout := time.Now().Add(blockTime)
 
 		stopReason := "delivery"
 		defer func() {
-			log.Info("Stopping work on payload",
+			log.Info("Stopping work on payload", // 线上grep 日志 看看
 				"id", payload.id,
 				"reason", stopReason,
 				"elapsed", common.PrettyDuration(time.Since(start)))
@@ -404,7 +405,7 @@ func (w *worker) buildPayload(args *BuildPayloadArgs) (*Payload, error) {
 			} else {
 				log.Error("Failed to build full payload", "id", payload.id, "err", r.err)
 			}
-			timer.Reset(w.recommit)
+			timer.Reset(w.recommit) // 这个是多少？？
 			return dur
 		}
 
@@ -425,7 +426,7 @@ func (w *worker) buildPayload(args *BuildPayloadArgs) (*Payload, error) {
 					stopReason = "near-timeout"
 					return
 				}
-				lastDuration = updatePayload()
+				lastDuration = updatePayload() // here
 			case <-payload.stop:
 				return
 			case <-endTimer.C:

miner/worker.go

@@ -328,7 +328,7 @@ func newWorker(config *Config, chainConfig *params.ChainConfig, engine consensus
 	worker.recommit = recommit
 
 	// Sanitize the timeout config for creating payload.
-	newpayloadTimeout := worker.config.NewPayloadTimeout
+	newpayloadTimeout := worker.config.NewPayloadTimeout // 需要看一下，650ms？？
 	if newpayloadTimeout == 0 {
 		log.Warn("Sanitizing new payload timeout to default", "provided", newpayloadTimeout, "updated", DefaultConfig.NewPayloadTimeout)
 		newpayloadTimeout = DefaultConfig.NewPayloadTimeout
@@ -674,7 +674,7 @@ func (w *worker) opLoop() {
 	defer w.wg.Done()
 	for {
 		select {
-		case req := <-w.getWorkCh:
+		case req := <-w.getWorkCh: // here
 			req.result <- w.generateWork(req.params)
 		case <-w.exitCh:
 			return
@@ -918,6 +918,7 @@ func (w *worker) applyTransaction(env *environment, tx *types.Transaction) (*typ
 	return receipt, err
 }
 
+// 怎么理解？？
 func (w *worker) commitTransactions(env *environment, plainTxs, blobTxs *transactionsByPriceAndNonce, interrupt *atomic.Int32) error {
 	gasLimit := env.header.GasLimit
 	if env.gasPool == nil {
@@ -1162,12 +1163,13 @@ func (w *worker) validateParams(genParams *generateParams) (time.Duration, error
 	}
 
 	// Sanity check the timestamp correctness
-	blockTime := int64(genParams.timestamp) - int64(parent.Time)
+	blockTime := int64(genParams.timestamp) - int64(parent.Time) // 这里是秒级别时间戳？？
 	if blockTime <= 0 && genParams.forceTime {
 		return 0, fmt.Errorf("invalid timestamp, parent %d given %d", parent.Time, genParams.timestamp)
 	}
 
 	// minimum payload build time of 1s
+	// 这里需要调整
 	if blockTime < 1 {
 		blockTime = 1
 	}
@@ -1250,12 +1252,13 @@ func (w *worker) prepareWork(genParams *generateParams) (*environment, error) {
 	// Could potentially happen if starting to mine in an odd state.
 	// Note genParams.coinbase can be different with header.Coinbase
 	// since clique algorithm can modify the coinbase field in header.
-	env, err := w.makeEnv(parent, header, genParams.coinbase)
+	env, err := w.makeEnv(parent, header, genParams.coinbase /*这个参数啥用？？*/)
 	if err != nil {
 		log.Error("Failed to create sealing context", "err", err)
 		return nil, err
 	}
 	if header.ParentBeaconRoot != nil {
+		// 含义是什么？？
 		context := core.NewEVMBlockContext(header, w.chain, nil, w.chainConfig, env.state)
 		vmenv := vm.NewEVM(context, vm.TxContext{}, env.state, w.chainConfig, vm.Config{})
 		core.ProcessBeaconBlockRoot(*header.ParentBeaconRoot, vmenv, env.state)
@@ -1290,7 +1293,7 @@ func (w *worker) fillTransactions(interrupt *atomic.Int32, env *environment) err
 		filter.BlobFee = uint256.MustFromBig(eip4844.CalcBlobFee(*env.header.ExcessBlobGas))
 	}
 	filter.OnlyPlainTxs, filter.OnlyBlobTxs = true, false
-	pendingPlainTxs := w.eth.TxPool().Pending(filter)
+	pendingPlainTxs := w.eth.TxPool().Pending(filter) // filte txs from txpool
 
 	filter.OnlyPlainTxs, filter.OnlyBlobTxs = false, true
 	pendingBlobTxs := w.eth.TxPool().Pending(filter)
@@ -1302,7 +1305,7 @@ func (w *worker) fillTransactions(interrupt *atomic.Int32, env *environment) err
 	localPlainTxs, remotePlainTxs := make(map[common.Address][]*txpool.LazyTransaction), pendingPlainTxs
 	localBlobTxs, remoteBlobTxs := make(map[common.Address][]*txpool.LazyTransaction), pendingBlobTxs
 
-	for _, account := range w.eth.TxPool().Locals() {
+	for _, account := range w.eth.TxPool().Locals() { // local pool
 		if txs := remotePlainTxs[account]; len(txs) > 0 {
 			delete(remotePlainTxs, account)
 			localPlainTxs[account] = txs
@@ -1358,6 +1361,7 @@ func (w *worker) estimateGasForTxDAG(env *environment) uint64 {
 }
 
 // generateWork generates a sealing block based on the given parameters.
+// 重要，仔细看看
 func (w *worker) generateWork(genParams *generateParams) *newPayloadResult {
 	// TODO delete after debug performance metrics
 	core.DebugInnerExecutionDuration = 0
@@ -1411,7 +1415,7 @@ func (w *worker) generateWork(genParams *generateParams) *newPayloadResult {
 		if interrupt == nil {
 			interrupt = new(atomic.Int32)
 		}
-		timer := time.AfterFunc(w.newpayloadTimeout, func() {
+		timer := time.AfterFunc(w.newpayloadTimeout /**/ /*这个参数*/, func() {
 			interrupt.Store(commitInterruptTimeout)
 		})
 		if w.config.Mev.MevEnabled {
@@ -1449,7 +1453,7 @@ func (w *worker) generateWork(genParams *generateParams) *newPayloadResult {
 			if w.chain.TxDAGEnabledWhenMine() {
 				work.state.MVStates().EnableAsyncGen()
 			}
-			err := w.fillTransactions(interrupt, work)
+			err := w.fillTransactions(interrupt /*这个很重要，外部可以中断内部的*/, work)
 			timer.Stop() // don't need timeout interruption any more
 			if errors.Is(err, errBlockInterruptedByTimeout) {
 				log.Warn("Block building is interrupted", "allowance", common.PrettyDuration(w.newpayloadTimeout), "parentHash", genParams.parentHash)