Generate deterministic enode addresses (#146)

Author: ferranbt

internal/artifacts.go

@@ -26,6 +26,7 @@ import (
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/core/types"
 	ecrypto "github.com/ethereum/go-ethereum/crypto"
+	"github.com/ethereum/go-ethereum/p2p/enode"
 	"github.com/hashicorp/go-uuid"
 	"github.com/prysmaticlabs/prysm/v5/config/params"
 	"github.com/prysmaticlabs/prysm/v5/crypto/bls/common"
@@ -37,8 +38,6 @@ import (
 
 var (
 	defaultOpBlockTimeSeconds = uint64(2)
-	defaultDiscoveryPrivKey   = "a11ac89899cd86e36b6fb881ec1255b8a92a688790b7d950f8b7d8dd626671fb"
-	defaultDiscoveryEnodeID   = "3479db4d9217fb5d7a8ed4d61ac36e120b05d36c2eefb795dc42ff2e971f251a2315f5649ea1833271e020b9adc98d5db9973c7ed92d6b2f1f2223088c3d852f"
 )
 
 // minimumGenesisDelay is the minimum delay for the genesis time. This is required
@@ -246,7 +245,6 @@ func (b *ArtifactsBuilder) Build() (*Artifacts, error) {
 		"testnet/deposit_contract_block.txt":  "0",
 		"testnet/genesis_validators_root.txt": hex.EncodeToString(state.GenesisValidatorsRoot()),
 		"data_validator/":                     &lighthouseKeystore{privKeys: priv},
-		"deterministic_p2p_key.txt":           defaultDiscoveryPrivKey,
 		"scripts/query.sh":                    queryReadyCheck,
 	})
 	if err != nil {
@@ -418,6 +416,8 @@ type output struct {
 
 	homeDir string
 	lock    sync.Mutex
+
+	enodeAddrSeq *big.Int
 }
 
 func (o *output) AbsoluteDstPath() (string, error) {
@@ -696,3 +696,38 @@ func applyTemplate2(templateStr []byte, input interface{}) ([]byte, error) {
 
 	return []byte(out.String()), nil
 }
+
+type EnodeAddr struct {
+	PrivKey  *ecdsa.PrivateKey
+	Artifact string
+}
+
+func (e *EnodeAddr) ID() enode.ID {
+	return enode.PubkeyToIDV4(&e.PrivKey.PublicKey)
+}
+
+func (o *output) GetEnodeAddr() *EnodeAddr {
+	// TODO: This is a bit enshrined here
+	if o.enodeAddrSeq == nil {
+		o.enodeAddrSeq = big.NewInt(0)
+	}
+
+	// always start with 1 since 0 is not a valid private key for an enode address
+	o.enodeAddrSeq.Add(o.enodeAddrSeq, big.NewInt(1))
+	privKeyBytes := gethcommon.LeftPadBytes(o.enodeAddrSeq.Bytes(), 32)
+
+	privKey, err := ecrypto.ToECDSA(privKeyBytes)
+	if err != nil {
+		panic(fmt.Sprintf("BUG: failed to convert private key to ECDSA: %v", err))
+	}
+
+	privKeyBytesHex := hex.EncodeToString(privKeyBytes)
+
+	// write the key to an artifact file
+	fileName := fmt.Sprintf("enode-key-%d.txt", o.enodeAddrSeq.Int64())
+	if err := o.WriteFile(fileName, privKeyBytesHex); err != nil {
+		panic(fmt.Sprintf("BUG: failed to write enode key to artifact file: %v", err))
+	}
+
+	return &EnodeAddr{PrivKey: privKey, Artifact: fileName}
+}

internal/artifacts_test.go

@@ -0,0 +1,31 @@
+package internal
+
+import (
+	"os"
+	"testing"
+)
+
+func TestEnodeGeneration(t *testing.T) {
+	// Test that the enodes generated by output are deterministic
+	o1 := newTestOutput(t)
+	o2 := newTestOutput(t)
+
+	for i := 0; i < 10; i++ {
+		if o1.GetEnodeAddr().ID() != o2.GetEnodeAddr().ID() {
+			t.Fatalf("enode IDs are not the same")
+		}
+	}
+}
+
+func newTestOutput(t *testing.T) *output {
+	dir, err := os.MkdirTemp("/tmp", "test-output")
+	if err != nil {
+		t.Fatalf("failed to create temporal folder: %v", err)
+	}
+	defer os.RemoveAll(dir)
+
+	o := &output{
+		dst: dir,
+	}
+	return o
+}

internal/components.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"io"
 	"strconv"
-	"strings"
 	"time"
 )
 
@@ -112,10 +111,8 @@ func (o *OpNode) Name() string {
 }
 
 type OpGeth struct {
-	UseDeterministicP2PKey bool
-
 	// outputs
-	Enode string
+	Enode *EnodeAddr
 }
 
 func logLevelToGethVerbosity(logLevel LogLevel) string {
@@ -136,10 +133,7 @@ func logLevelToGethVerbosity(logLevel LogLevel) string {
 }
 
 func (o *OpGeth) Run(service *Service, ctx *ExContext) {
-	var nodeKeyFlag string
-	if o.UseDeterministicP2PKey {
-		nodeKeyFlag = "--nodekey /data/deterministic_p2p_key.txt "
-	}
+	o.Enode = ctx.Output.GetEnodeAddr()
 
 	service.
 		WithImage("us-docker.pkg.dev/oplabs-tools-artifacts/images/op-geth").
@@ -174,37 +168,21 @@ func (o *OpGeth) Run(service *Service, ctx *ExContext) {
 				"--gcmode archive "+
 				"--state.scheme hash "+
 				"--port "+`{{Port "rpc" 30303}} `+
-				nodeKeyFlag+
+				"--nodekey /data/p2p_key.txt "+
 				"--metrics "+
 				"--metrics.addr 0.0.0.0 "+
 				"--metrics.port "+`{{Port "metrics" 6061}}`,
 		).
 		WithVolume("data", "/data_opgeth").
 		WithArtifact("/data/l2-genesis.json", "l2-genesis.json").
 		WithArtifact("/data/jwtsecret", "jwtsecret").
-		WithArtifact("/data/deterministic_p2p_key.txt", "deterministic_p2p_key.txt")
+		WithArtifact("/data/p2p_key.txt", o.Enode.Artifact)
 }
 
 func (o *OpGeth) Name() string {
 	return "op-geth"
 }
 
-var _ ServiceReady = &OpGeth{}
-
-func (o *OpGeth) Ready(instance *instance) error {
-	enodeLine, err := instance.logs.FindLog("enode://")
-	if err != nil {
-		return err
-	}
-
-	parts := strings.Split(enodeLine, "enode://")[1]
-	enodeID := strings.Split(parts, "@")[0]
-
-	enode := fmt.Sprintf("enode://%[email protected]:%d?discport=0", enodeID, instance.service.MustGetPort("rpc").HostPort)
-	o.Enode = enode
-	return nil
-}
-
 var _ ServiceWatchdog = &OpGeth{}
 
 func (o *OpGeth) Watchdog(out io.Writer, instance *instance, ctx context.Context) error {

internal/manifest.go

@@ -37,6 +37,7 @@ type Manifest struct {
 }
 
 func NewManifest(ctx *ExContext, out *output) *Manifest {
+	ctx.Output = out
 	return &Manifest{ctx: ctx, out: out, overrides: make(map[string]string)}
 }
 
@@ -71,6 +72,11 @@ func (l *LogLevel) Unmarshal(s string) error {
 // Execution context
 type ExContext struct {
 	LogLevel LogLevel
+
+	// This dependency is not ideal. Doing it so that I do not
+	// have to modify the serviceDesc interface to give services
+	// access to the output.
+	Output *output
 }
 
 type ServiceGen interface {

internal/recipe_opstack.go

@@ -80,9 +80,7 @@ func (o *OpRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 		L1Beacon: "beacon",
 		L2Node:   elNode,
 	})
-	svcManager.AddService("op-geth", &OpGeth{
-		UseDeterministicP2PKey: o.externalBuilder != "",
-	})
+	svcManager.AddService("op-geth", &OpGeth{})
 	svcManager.AddService("op-batcher", &OpBatcher{
 		L1Node:             "el",
 		L2Node:             "op-geth",