Merge pull request #5798 from mdehoog/bootnode

op-bootnode

.circleci/config.yml

@@ -1303,6 +1303,9 @@ workflows:
       - go-lint:
           name: op-batcher-lint
           module: op-batcher
+      - go-lint:
+          name: op-bootnode-lint
+          module: op-bootnode
       - go-lint:
           name: op-bindings-lint
           module: op-bindings
@@ -1366,6 +1369,7 @@ workflows:
       - bedrock-go-tests:
           requires:
             - op-batcher-lint
+            - op-bootnode-lint
             - op-bindings-lint
             - op-chain-ops-lint
             - op-e2e-lint

op-bootnode/bootnode/entrypoint.go

+package bootnode
+
+import (
+	"context"
+	"errors"
+	"fmt"
+
+	opnode "github.com/ethereum-optimism/optimism/op-node"
+	"github.com/ethereum-optimism/optimism/op-node/eth"
+	"github.com/ethereum-optimism/optimism/op-node/metrics"
+	"github.com/ethereum-optimism/optimism/op-node/p2p"
+	p2pcli "github.com/ethereum-optimism/optimism/op-node/p2p/cli"
+	"github.com/ethereum-optimism/optimism/op-node/rollup"
+	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	"github.com/ethereum-optimism/optimism/op-service/opio"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/log"
+	"github.com/libp2p/go-libp2p/core/peer"
+	"github.com/urfave/cli"
+)
+
+type gossipNoop struct{}
+
+func (g *gossipNoop) OnUnsafeL2Payload(_ context.Context, _ peer.ID, _ *eth.ExecutionPayload) error {
+	return nil
+}
+
+type gossipConfig struct{}
+
+func (g *gossipConfig) P2PSequencerAddress() common.Address {
+	return common.Address{}
+}
+
+type l2Chain struct{}
+
+func (l *l2Chain) PayloadByNumber(_ context.Context, _ uint64) (*eth.ExecutionPayload, error) {
+	return nil, nil
+}
+
+func Main(cliCtx *cli.Context) error {
+	log.Info("Initializing bootnode")
+	logCfg := oplog.ReadCLIConfig(cliCtx)
+	logger := oplog.NewLogger(logCfg)
+	m := metrics.NewMetrics("default")
+	ctx := context.Background()
+
+	config, err := opnode.NewRollupConfig(cliCtx)
+	if err != nil {
+		return err
+	}
+	if err = validateConfig(config); err != nil {
+		return err
+	}
+
+	p2pConfig, err := p2pcli.NewConfig(cliCtx, config.BlockTime)
+	if err != nil {
+		return fmt.Errorf("failed to load p2p config: %w", err)
+	}
+
+	p2pNode, err := p2p.NewNodeP2P(ctx, config, logger, p2pConfig, &gossipNoop{}, &l2Chain{}, &gossipConfig{}, m)
+	if err != nil || p2pNode == nil {
+		return err
+	}
+	if p2pNode.Dv5Udp() == nil {
+		return fmt.Errorf("uninitialized discovery service")
+	}
+
+	go p2pNode.DiscoveryProcess(ctx, logger, config, p2pConfig.TargetPeers())
+
+	opio.BlockOnInterrupts()
+
+	return nil
+}
+
+// validateConfig ensures the minimal config required to run a bootnode
+func validateConfig(config *rollup.Config) error {
+	if config.L2ChainID == nil || config.L2ChainID.Uint64() == 0 {
+		return errors.New("chain ID is not set")
+	}
+	if config.Genesis.L2Time <= 0 {
+		return errors.New("genesis timestamp is not set")
+	}
+	if config.BlockTime <= 0 {
+		return errors.New("block time is not set")
+	}
+	return nil
+}

op-bootnode/cmd/main.go

+package main
+
+import (
+	"os"
+
+	"github.com/ethereum-optimism/optimism/op-bootnode/bootnode"
+	"github.com/ethereum-optimism/optimism/op-bootnode/flags"
+	"github.com/ethereum/go-ethereum/log"
+	"github.com/urfave/cli"
+)
+
+func main() {
+	// Set up logger with a default INFO level in case we fail to parse flags,
+	// otherwise the final critical log won't show what the parsing error was.
+	log.Root().SetHandler(
+		log.LvlFilterHandler(
+			log.LvlInfo,
+			log.StreamHandler(os.Stdout, log.TerminalFormat(true)),
+		),
+	)
+
+	app := cli.NewApp()
+	app.Flags = flags.Flags
+	app.Name = "bootnode"
+	app.Usage = "Rollup Bootnode"
+	app.Description = "Broadcasts incoming P2P peers to each other, enabling peer bootstrapping."
+	app.Action = bootnode.Main
+
+	err := app.Run(os.Args)
+	if err != nil {
+		log.Crit("Application failed", "message", err)
+	}
+}

op-bootnode/flags/flags.go

+package flags
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/ethereum-optimism/optimism/op-node/chaincfg"
+	"github.com/ethereum-optimism/optimism/op-node/flags"
+	opservice "github.com/ethereum-optimism/optimism/op-service"
+	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	"github.com/urfave/cli"
+)
+
+const envVarPrefix = "OP_BOOTNODE"
+
+var (
+	RollupConfig = cli.StringFlag{
+		Name:   flags.RollupConfig.Name,
+		Usage:  "Rollup chain parameters",
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "ROLLUP_CONFIG"),
+	}
+	Network = cli.StringFlag{
+		Name:   flags.Network.Name,
+		Usage:  fmt.Sprintf("Predefined network selection. Available networks: %s", strings.Join(chaincfg.AvailableNetworks(), ", ")),
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "NETWORK"),
+	}
+)
+
+var Flags = []cli.Flag{
+	RollupConfig,
+	Network,
+}
+
+func init() {
+	Flags = append(Flags, oplog.CLIFlags(envVarPrefix)...)
+}