Merge pull request #4327 from mdehoog/enr-tag-key-optimism-to-chain

[RFC] Bedrock: rename "optimism" ENR key to "opstack"

op-node/p2p/discovery.go

@@ -75,7 +75,7 @@ func (conf *Config) Discovery(log log.Logger, rollupCfg *rollup.Config, tcpPort
 	} else {
 		return nil, nil, fmt.Errorf("no TCP port to put in discovery record")
 	}
-	dat := OptimismENRData{
+	dat := OpStackENRData{
 		chainID: rollupCfg.L2ChainID.Uint64(),
 		version: 0,
 	}
@@ -167,18 +167,18 @@ func enrToAddrInfo(r *enode.Node) (*peer.AddrInfo, *crypto.Secp256k1PublicKey, e
 	}, pub, nil
 }
 
-// The discovery ENRs are just key-value lists, and we filter them by records tagged with the "optimism" key,
+// The discovery ENRs are just key-value lists, and we filter them by records tagged with the "opstack" key,
 // and then check the chain ID and version.
-type OptimismENRData struct {
+type OpStackENRData struct {
 	chainID uint64
 	version uint64
 }
 
-func (o *OptimismENRData) ENRKey() string {
-	return "optimism"
+func (o *OpStackENRData) ENRKey() string {
+	return "opstack"
 }
 
-func (o *OptimismENRData) EncodeRLP(w io.Writer) error {
+func (o *OpStackENRData) EncodeRLP(w io.Writer) error {
 	out := make([]byte, 2*binary.MaxVarintLen64)
 	offset := binary.PutUvarint(out, o.chainID)
 	offset += binary.PutUvarint(out[offset:], o.version)
@@ -187,13 +187,13 @@ func (o *OptimismENRData) EncodeRLP(w io.Writer) error {
 	return rlp.Encode(w, out)
 }
 
-func (o *OptimismENRData) DecodeRLP(s *rlp.Stream) error {
+func (o *OpStackENRData) DecodeRLP(s *rlp.Stream) error {
 	b, err := s.Bytes()
 	if err != nil {
 		return fmt.Errorf("failed to decode outer ENR entry: %w", err)
 	}
 	// We don't check the byte length: the below readers are limited, and the ENR itself has size limits.
-	// Future "optimism" entries may contain additional data, and will be tagged with a newer version etc.
+	// Future "opstack" entries may contain additional data, and will be tagged with a newer version etc.
 	r := bytes.NewReader(b)
 	chainID, err := binary.ReadUvarint(r)
 	if err != nil {
@@ -208,15 +208,15 @@ func (o *OptimismENRData) DecodeRLP(s *rlp.Stream) error {
 	return nil
 }
 
-var _ enr.Entry = (*OptimismENRData)(nil)
+var _ enr.Entry = (*OpStackENRData)(nil)
 
 func FilterEnodes(log log.Logger, cfg *rollup.Config) func(node *enode.Node) bool {
 	return func(node *enode.Node) bool {
-		var dat OptimismENRData
+		var dat OpStackENRData
 		err := node.Load(&dat)
 		// if the entry does not exist, or if it is invalid, then ignore the node
 		if err != nil {
-			log.Debug("discovered node record has no optimism info", "node", node.ID(), "err", err)
+			log.Debug("discovered node record has no opstack info", "node", node.ID(), "err", err)
 			return false
 		}
 		// check chain ID matches
@@ -347,7 +347,7 @@ func (n *NodeP2P) DiscoveryProcess(ctx context.Context, log log.Logger, cfg *rol
 			log.Info("stopped peer discovery")
 			return // no ctx error, expected close
 		case found := <-randomNodesCh:
-			var dat OptimismENRData
+			var dat OpStackENRData
 			if err := found.Load(&dat); err != nil { // we already filtered on chain ID and version
 				continue
 			}
@@ -362,7 +362,7 @@ func (n *NodeP2P) DiscoveryProcess(ctx context.Context, log log.Logger, cfg *rol
 			// Tag the peer, we'd rather have the connection manager prune away old peers,
 			// or peers on different chains, or anyone we have not seen via discovery.
 			// There is no tag score decay yet, so just set it to 42.
-			n.ConnectionManager().TagPeer(info.ID, fmt.Sprintf("optimism-%d-%d", dat.chainID, dat.version), 42)
+			n.ConnectionManager().TagPeer(info.ID, fmt.Sprintf("opstack-%d-%d", dat.chainID, dat.version), 42)
 			log.Debug("discovered peer", "peer", info.ID, "nodeID", found.ID(), "addr", info.Addrs[0])
 		case <-connectTicker.C:
 			connected := n.Host().Network().Peers()

op-node/p2p/prepared.go

@@ -47,7 +47,7 @@ func (p *Prepared) Host(log log.Logger, reporter metrics.Reporter) (host.Host, e
 // Discovery creates a disc-v5 service. Returns nil, nil, nil if discovery is disabled.
 func (p *Prepared) Discovery(log log.Logger, rollupCfg *rollup.Config, tcpPort uint16) (*enode.LocalNode, *discover.UDPv5, error) {
 	if p.LocalNode != nil {
-		dat := OptimismENRData{
+		dat := OpStackENRData{
 			chainID: rollupCfg.L2ChainID.Uint64(),
 			version: 0,
 		}

specs/rollup-node-p2p.md

@@ -84,9 +84,9 @@ The Ethereum Node Record (ENR) for an Optimism rollup node must contain the foll
 - An IPv4 address (`ip` field) and/or IPv6 address (`ip6` field).
 - A TCP port (`tcp` field) representing the local libp2p listening port.
 - A UDP port (`udp` field) representing the local discv5 listening port.
-- An Optimism (`optimism` field) L2 network identifier
+- An OpStack (`opstack` field) L2 network identifier
 
-The `optimism` value is encoded as a single RLP `bytes` value, the concatenation of:
+The `opstack` value is encoded as a single RLP `bytes` value, the concatenation of:
 
 - chain ID (`unsigned varint`)
 - fork ID (`unsigned varint`)
@@ -101,7 +101,7 @@ The discovery process in Optimism is a pipeline of node records:
 2. Pull additional records with searches to random Node IDs if necessary
    (e.g. iterate [`RandomNodes()`][discv5-random-nodes] in Go implementation)
 3. Pull records from the DiscV5 module when looking for peers
-4. Check if the record contains the `optimism` entry, verify it matches the chain ID and current or future fork number
+4. Check if the record contains the `opstack` entry, verify it matches the chain ID and current or future fork number
 5. If not already connected, and not recently disconnected or put on deny-list, attempt to dial.
 
 ### LibP2P