064f37d6f6
Here we add a Go API for running tracing plugins within the main block import process. As an advanced user of geth, you can now create a Go file in eth/tracers/live/, and within that file register your custom tracer implementation. Then recompile geth and select your tracer on the command line. Hooks defined in the tracer will run whenever a block is processed. The hook system is defined in package core/tracing. It uses a struct with callbacks, instead of requiring an interface, for several reasons: - We plan to keep this API stable long-term. The core/tracing hook API does not depend on on deep geth internals. - There are a lot of hooks, and tracers will only need some of them. Using a struct allows you to implement only the hooks you want to actually use. All existing tracers in eth/tracers/native have been rewritten to use the new hook system. This change breaks compatibility with the vm.EVMLogger interface that we used to have. If you are a user of vm.EVMLogger, please migrate to core/tracing, and sorry for breaking your stuff. But we just couldn't have both the old and new tracing APIs coexist in the EVM. --------- Co-authored-by: Matthieu Vachon <matthieu.o.vachon@gmail.com> Co-authored-by: Delweng <delweng@gmail.com> Co-authored-by: Martin HS <martin@swende.se>
101 lines
2.7 KiB
Go
101 lines
2.7 KiB
Go
// Copyright 2023 The go-ethereum Authors
|
|
// This file is part of go-ethereum.
|
|
//
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// go-ethereum is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"regexp"
|
|
"sort"
|
|
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/core/rawdb"
|
|
"github.com/ethereum/go-ethereum/core/tracing"
|
|
"github.com/ethereum/go-ethereum/eth/tracers/logger"
|
|
"github.com/ethereum/go-ethereum/tests"
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
var RunFlag = &cli.StringFlag{
|
|
Name: "run",
|
|
Value: ".*",
|
|
Usage: "Run only those tests matching the regular expression.",
|
|
}
|
|
|
|
var blockTestCommand = &cli.Command{
|
|
Action: blockTestCmd,
|
|
Name: "blocktest",
|
|
Usage: "Executes the given blockchain tests",
|
|
ArgsUsage: "<file>",
|
|
Flags: []cli.Flag{RunFlag},
|
|
}
|
|
|
|
func blockTestCmd(ctx *cli.Context) error {
|
|
if len(ctx.Args().First()) == 0 {
|
|
return errors.New("path-to-test argument required")
|
|
}
|
|
|
|
var tracer *tracing.Hooks
|
|
// Configure the EVM logger
|
|
if ctx.Bool(MachineFlag.Name) {
|
|
tracer = logger.NewJSONLogger(&logger.Config{
|
|
EnableMemory: !ctx.Bool(DisableMemoryFlag.Name),
|
|
DisableStack: ctx.Bool(DisableStackFlag.Name),
|
|
DisableStorage: ctx.Bool(DisableStorageFlag.Name),
|
|
EnableReturnData: !ctx.Bool(DisableReturnDataFlag.Name),
|
|
}, os.Stderr)
|
|
}
|
|
// Load the test content from the input file
|
|
src, err := os.ReadFile(ctx.Args().First())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
var tests map[string]tests.BlockTest
|
|
if err = json.Unmarshal(src, &tests); err != nil {
|
|
return err
|
|
}
|
|
re, err := regexp.Compile(ctx.String(RunFlag.Name))
|
|
if err != nil {
|
|
return fmt.Errorf("invalid regex -%s: %v", RunFlag.Name, err)
|
|
}
|
|
|
|
// Run them in order
|
|
var keys []string
|
|
for key := range tests {
|
|
keys = append(keys, key)
|
|
}
|
|
sort.Strings(keys)
|
|
for _, name := range keys {
|
|
if !re.MatchString(name) {
|
|
continue
|
|
}
|
|
test := tests[name]
|
|
if err := test.Run(false, rawdb.HashScheme, tracer, func(res error, chain *core.BlockChain) {
|
|
if ctx.Bool(DumpFlag.Name) {
|
|
if state, _ := chain.State(); state != nil {
|
|
fmt.Println(string(state.Dump(nil)))
|
|
}
|
|
}
|
|
}); err != nil {
|
|
return fmt.Errorf("test %v: %w", name, err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|